Commit 70fb252a authored by Alan Stern's avatar Alan Stern Committed by Greg Kroah-Hartman
Browse files

USB: core: Update kerneldoc for usb_hcd_giveback_urb() 



The kerneldoc added for usb_hcd_giveback_urb() by commit 41631d36
("usb: core: Replace in_interrupt() in comments") is unclear and
incorrect.  Update the text for greater clarity and to say that URBs
for a root hub will always use a BH context for their completion.

Signed-off-by: default avatarAlan Stern <stern@rowland.harvard.edu>
Link: https://lore.kernel.org/r/41eaae05-116a-4568-940c-eeb94ab6baa0@rowland.harvard.edu


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent a381c6d6

drivers/usb/core/hcd.c

+4 −4
Original line number Diff line number Diff line
@@ -1717,10 +1717,10 @@ static void usb_giveback_urb_bh(struct work_struct *work) 
 * @urb: urb being returned to the USB device driver.

 * @status: completion status code for the URB.

 *

 * Context: atomic. The completion callback is invoked in caller's context.

 * For HCDs with HCD_BH flag set, the completion callback is invoked in BH

 * context (except for URBs submitted to the root hub which always complete in

 * caller's context).

 * Context: atomic. The completion callback is invoked either in a work queue

 * (BH) context or in the caller's context, depending on whether the HCD_BH

 * flag is set in the @hcd structure, except that URBs submitted to the

 * root hub always complete in BH context.

 *

 * This hands the URB from HCD to its USB device driver, using its

 * completion function.  The HCD has freed all per-urb resources