Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

usb_ep_queue(9) [centos man page]

USB_EP_QUEUE(9) 					      Kernel Mode Gadget API						   USB_EP_QUEUE(9)

usb_ep_queue - queues (submits) an I/O request to an endpoint. SYNOPSIS
int usb_ep_queue(struct usb_ep * ep, struct usb_request * req, gfp_t gfp_flags); ARGUMENTS
ep the endpoint associated with the request req the request being submitted gfp_flags GFP_* flags to use in case the lower level driver couldn't pre-allocate all necessary memory with the request. DESCRIPTION
This tells the device controller to perform the specified request through that endpoint (reading or writing a buffer). When the request completes, including being canceled by usb_ep_dequeue, the request's completion routine is called to return the request to the driver. Any endpoint (except control endpoints like ep0) may have more than one transfer request queued; they complete in FIFO order. Once a gadget driver submits a request, that request may not be examined or modified until it is given back to that driver through the completion callback. Each request is turned into one or more packets. The controller driver never merges adjacent requests into the same packet. OUT transfers will sometimes use data that's already buffered in the hardware. Drivers can rely on the fact that the first byte of the request's buffer always corresponds to the first byte of some USB packet, for both IN and OUT transfers. Bulk endpoints can queue any amount of data; the transfer is packetized automatically. The last packet will be short if the request doesn't fill it out completely. Zero length packets (ZLPs) should be avoided in portable protocols since not all usb hardware can successfully handle zero length packets. (ZLPs may be explicitly written, and may be implicitly written if the request 'zero' flag is set.) Bulk endpoints may also be used for interrupt transfers; but the reverse is not true, and some endpoints won't support every interrupt transfer. (Such as 768 byte packets.) Interrupt-only endpoints are less functional than bulk endpoints, for example by not supporting queueing or not handling buffers that are larger than the endpoint's maxpacket size. They may also treat data toggle differently. Control endpoints ... after getting a setup callback, the driver queues one response (even if it would be zero length). That enables the status ack, after transferring data as specified in the response. Setup functions may return negative error codes to generate protocol stalls. (Note that some USB device controllers disallow protocol stall responses in some cases.) When control responses are deferred (the response is written after the setup callback returns), then usb_ep_set_halt may be used on ep0 to trigger protocol stalls. Depending on the controller, it may not be possible to trigger a status-stage protocol stall when the data stage is over, that is, from within the response's completion routine. For periodic endpoints, like interrupt or isochronous ones, the usb host arranges to poll once per interval, and the gadget driver usually will have queued some data to transfer at that time. Returns zero, or a negative error code. Endpoints that are not enabled report errors; errors will also be reported when the usb peripheral is disconnected. AUTHOR
David Brownell <> Author. COPYRIGHT
Kernel Hackers Manual 3.10 June 2014 USB_EP_QUEUE(9)

Check Out this Related Man Page

USB_EP(9) Kernel Mode Gadget API STRUCT USB_EP(9) NAME
struct_usb_ep - device side representation of USB endpoint SYNOPSIS
struct usb_ep { void * driver_data; const char * name; const struct usb_ep_ops * ops; struct list_head ep_list; unsigned maxpacket:16; unsigned max_streams:16; unsigned mult:2; unsigned maxburst:5; u8 address; const struct usb_endpoint_descriptor * desc; const struct usb_ss_ep_comp_descriptor * comp_desc; }; MEMBERS
driver_data for use by the gadget driver. name identifier for the endpoint, such as "ep-a" or "ep9in-bulk" ops Function pointers used to access hardware-specific operations. ep_list the gadget's ep_list holds all of its endpoints maxpacket The maximum packet size used on this endpoint. The initial value can sometimes be reduced (hardware allowing), according to the endpoint descriptor used to configure the endpoint. max_streams The maximum number of streams supported by this EP (0 - 16, actual number is 2^n) mult multiplier, 'mult' value for SS Isoc EPs maxburst the maximum number of bursts supported by this EP (for usb3) address used to identify the endpoint when finding descriptor that matches connection speed desc endpoint descriptor. This pointer is set before the endpoint is enabled and remains valid until the endpoint is disabled. comp_desc In case of SuperSpeed support, this is the endpoint companion descriptor that is used to configure the endpoint DESCRIPTION
the bus controller driver lists all the general purpose endpoints in gadget->ep_list. the control endpoint (gadget->ep0) is not in that list, and is accessed only in response to a driver setup callback. AUTHOR
David Brownell <> Author. COPYRIGHT
Kernel Hackers Manual 3.10 June 2014 STRUCT USB_EP(9)
Man Page

Featured Tech Videos