개요

• 솔라나라에 설명된 어플리케이션에 대해 맨 페이지를 찾아 출력한다.
• MAN 페이지에 대한 설명은 윈디하나의 솔라나라: MAN 페이지을 참고하자.
• svcadm(8)을 검색하려면 섹션에서 8 을 선택하고, 맨 페이지 이름에 svcadm을 입력하고 검색을 누른다.

usb_pipe_set_private(9f)

usb_pipe_set_private(9F)       Kernel Functions       usb_pipe_set_private(9F)



NAME
       usb_pipe_set_private,  usb_pipe_get_private  -  USB  user-defined  pipe
       data-field facility

SYNOPSIS
       #include <sys/usb/usba.h>

       int usb_pipe_set_private(usb_pipe_handle_t pipe_handle, usb_opaque_t data);


       usb_opaque_t usb_pipe_get_private (usb_pipe_handle_t pipe_handle);

INTERFACE LEVEL
       Solaris DDI specific (Solaris DDI)

PARAMETERS
       For usb_pipe_set_private():

       pipe_handle    Pipe handle into which user-defined data is placed.


       data           Data to store in the pipe handle.



       For usb_pipe_get_private():

       pipe_handle    Pipe handle from which user-defined data is retrieved.


DESCRIPTION
       The usb_set_driver_private() function initializes the user-private data
       field of the pipe referred to by pipe_handle, using data. The user-pri‐
       vate data field is used to store any data the client desires and is not
       used in any way by the USBA or OS framework. Client drivers often store
       their soft-state here for convenient retrieval by their  callback  han‐
       dlers.


       The  usb_get_driver_private()  function retrieves the user-private data
       stored via usb_set_driver_private(),  from  the  pipe  referred  to  by
       pipe_handle.

RETURN VALUES
       For usb_pipe_set_private():

       USB_SUCCESS         Private  data  has been successfully stored in pipe
                           handle.


       USB_INVALID_PIPE    pipe_handle argument is NULL or invalid.

                           Pipe is closing or closed.


       USB_INVALID_PERM    The pipe_handle argument refers to the default con‐
                           trol pipe.



       For usb_pipe_get_private():


       On success: usb_opaque_t pointer to data being retrieved.


       On  failure:  NULL.  Fails  if pipe handle is NULL or invalid. Fails if
       pipe handle is to a pipe which is closing or closed.

CONTEXT
       May be called from user, kernel or interrupt context.

EXAMPLES
             usb_pipe_handle_t pipe;

             /* Some driver defined datatype. */
             xxx_data_t *data = kmem_zalloc(...);

             usb_pipe_set_private(pipe, data);

             ----

             xxx_data_t *xxx_data_ptr = (xxx_data_t *)usb_pipe_get_private(pipe);



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       tab() box; cw(2.75i) |cw(2.75i) lw(2.75i) |lw(2.75i) ATTRIBUTE  TYPEAT‐
       TRIBUTE  VALUE  _  ArchitecturePCI-based systems _ Interface Stability‐
       Committed _ Availabilitysystem/io/usb


SEE ALSO
       attributes(7), usb_alloc_request(9F), usb_pipe_open(9F)



Oracle Solaris 11.4               5 Jan 2004          usb_pipe_set_private(9F)