usb_interrupt_msg(9) [suse man page]

USB_INTERRUPT_MSG(9)						   USB Core APIs					      USB_INTERRUPT_MSG(9)

NAME

       usb_interrupt_msg - Builds an interrupt urb, sends it off and waits for completion

SYNOPSIS

       int usb_interrupt_msg(struct usb_device * usb_dev, unsigned int pipe, void * data, int len, int * actual_length, int timeout);

ARGUMENTS

       usb_dev
	   pointer to the usb device to send the message to

       pipe
	   endpoint "pipe" to send the message to

       data
	   pointer to the data to send

       len
	   length in bytes of the data to send

       actual_length
	   pointer to a location to put the actual length transferred in bytes

       timeout
	   time in msecs to wait for the message to complete before timing out (if 0 the wait is forever)

CONTEXT

       !in_interrupt ()

DESCRIPTION

       This function sends a simple interrupt message to a specified endpoint and waits for the message to complete, or timeout.

       If successful, it returns 0, otherwise a negative error number. The number of actual bytes transferred will be stored in the actual_length
       paramater.

       Don't use this function from within an interrupt context, like a bottom half handler. If you need an asynchronous message, or need to send
       a message from within interrupt context, use usb_submit_urb If a thread in your driver uses this call, make sure your disconnect method can
       wait for it to complete. Since you don't have a handle on the URB used, you can't cancel the request.

COPYRIGHT

Kernel Hackers Manual 2.6.					     July 2010						      USB_INTERRUPT_MSG(9)

USB_SG_INIT(9)							   USB Core APIs						    USB_SG_INIT(9)

NAME

       usb_sg_init - initializes scatterlist-based bulk/interrupt I/O request

SYNOPSIS

       int usb_sg_init(struct usb_sg_request * io, struct usb_device * dev, unsigned pipe, unsigned period, struct scatterlist * sg, int nents,
		       size_t length, gfp_t mem_flags);

ARGUMENTS

       io
	   request block being initialized. until usb_sg_wait returns, treat this as a pointer to an opaque block of memory,

       dev
	   the usb device that will send or receive the data

       pipe
	   endpoint "pipe" used to transfer the data

       period
	   polling rate for interrupt endpoints, in frames or (for high speed endpoints) microframes; ignored for bulk

       sg
	   scatterlist entries

       nents
	   how many entries in the scatterlist

       length
	   how many bytes to send from the scatterlist, or zero to send every byte identified in the list.

       mem_flags
	   SLAB_* flags affecting memory allocations in this call

DESCRIPTION

       Returns zero for success, else a negative errno value. This initializes a scatter/gather request, allocating resources such as I/O mappings
       and urb memory (except maybe memory used by USB controller drivers).

       The request must be issued using usb_sg_wait, which waits for the I/O to complete (or to be canceled) and then cleans up all resources
       allocated by usb_sg_init.

       The request may be canceled with usb_sg_cancel, either before or after usb_sg_wait is called.

COPYRIGHT

Kernel Hackers Manual 2.6.					     July 2010							    USB_SG_INIT(9)