Commit 8913dc0b authored by Paul Zimmerman's avatar Paul Zimmerman Committed by Felipe Balbi

usb: gadget: document a usb_ep_dequeue() requirement

Document the requirement that the request be dequeued and its
completion routine called before usb_ep_dequeue() returns. Also
fix some capitalization issues in the existing text.
Signed-off-by: default avatarPaul Zimmerman <paulz@synopsys.com>
Acked-by: default avatarAlan Stern <stern@rowland.harvard.edu>
Signed-off-by: default avatarFelipe Balbi <balbi@ti.com>
parent 84d1b78a
...@@ -345,12 +345,13 @@ static inline int usb_ep_queue(struct usb_ep *ep, ...@@ -345,12 +345,13 @@ static inline int usb_ep_queue(struct usb_ep *ep,
* @ep:the endpoint associated with the request * @ep:the endpoint associated with the request
* @req:the request being canceled * @req:the request being canceled
* *
* if the request is still active on the endpoint, it is dequeued and its * If the request is still active on the endpoint, it is dequeued and its
* completion routine is called (with status -ECONNRESET); else a negative * completion routine is called (with status -ECONNRESET); else a negative
* error code is returned. * error code is returned. This is guaranteed to happen before the call to
* usb_ep_dequeue() returns.
* *
* note that some hardware can't clear out write fifos (to unlink the request * Note that some hardware can't clear out write fifos (to unlink the request
* at the head of the queue) except as part of disconnecting from usb. such * at the head of the queue) except as part of disconnecting from usb. Such
* restrictions prevent drivers from supporting configuration changes, * restrictions prevent drivers from supporting configuration changes,
* even to configuration zero (a "chapter 9" requirement). * even to configuration zero (a "chapter 9" requirement).
*/ */
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment