diff options
| author | Paul Zimmerman <Paul.Zimmerman@synopsys.com> | 2014-08-21 20:28:20 +0000 |
|---|---|---|
| committer | Felipe Balbi <balbi@ti.com> | 2014-08-21 16:13:52 -0500 |
| commit | 8913dc0bb913ac3dc83ed5c10bac2f4e55431981 (patch) | |
| tree | d443733cf97cd74c52a1de4a2d0c72a8b33d9d7f /include/linux/usb/gadget.h | |
| parent | 84d1b78af9b35d706de2d1c115b9194bcaaa97b0 (diff) | |
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: Paul Zimmerman <paulz@synopsys.com>
Acked-by: Alan Stern <stern@rowland.harvard.edu>
Signed-off-by: Felipe Balbi <balbi@ti.com>
Diffstat (limited to 'include/linux/usb/gadget.h')
| -rw-r--r-- | include/linux/usb/gadget.h | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/include/linux/usb/gadget.h b/include/linux/usb/gadget.h index c3a61853cd13..c540557b564b 100644 --- a/include/linux/usb/gadget.h +++ b/include/linux/usb/gadget.h @@ -345,12 +345,13 @@ static inline int usb_ep_queue(struct usb_ep *ep, * @ep:the endpoint associated with the request * @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 - * 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 - * at the head of the queue) except as part of disconnecting from usb. such + * 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 * restrictions prevent drivers from supporting configuration changes, * even to configuration zero (a "chapter 9" requirement). */ |