USB: gadget: Improve kerneldoc for usb_ep_dequeue()
commit1e19a520a9258f3c7286826e7172e56bf6da86dc
authorAlan Stern <stern@rowland.harvard.edu>
Tue, 5 Feb 2019 19:33:02 +0000 (5 14:33 -0500)
committerFelipe Balbi <felipe.balbi@linux.intel.com>
Wed, 6 Feb 2019 06:37:16 +0000 (6 08:37 +0200)
tree2973ceb45f1934a5c4cf9f44df955085b9d7acf0
parent1381a5113caf764f090b912b478663275e7b999e
USB: gadget: Improve kerneldoc for usb_ep_dequeue()

Commit bf594c1070f5 ("USB: gadget: Document that certain ep operations
can be called in interrupt context") documented that usb_ep_dequeue()
may be called in a non-process context.  It follows that the routine
must not sleep or wait for events.

However, the routine's existing kerneldoc seems to imply that it will
wait until the request being cancelled has fully completed.  This is
not so, and thus the comment needs to be improved.  Misunderstanding
this point may very well have been responsible for a bug recently
uncovered in the f_fs function.

The updated comment explicitly says that the routine may return before
the request's completion handler is called.

Signed-off-by: Alan Stern <stern@rowland.harvard.edu>
CC: John Stultz <john.stultz@linaro.org>
Signed-off-by: Felipe Balbi <felipe.balbi@linux.intel.com>
drivers/usb/gadget/udc/core.c