linux/drivers/usb
Alan Stern 1e19a520a9 USB: gadget: Improve kerneldoc for usb_ep_dequeue()
Commit bf594c1070 ("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>
2019-02-06 08:37:16 +02:00
..
atm
c67x00
chipidea usb: chipidea: fix static checker warning for NULL pointer 2019-01-18 09:35:33 +01:00
class usb: cdc-acm: send ZLP for Telit 3G Intel based modems 2019-01-07 17:23:29 +01:00
common usb: roles: Add a description for the class to Kconfig 2018-12-17 14:07:59 +01:00
core USB: leds: fix regression in usbport led trigger 2019-01-18 09:55:05 +01:00
dwc2 usb: dwc2: gadget: Fix Remote Wakeup interrupt bit clearing 2019-01-17 15:56:53 +02:00
dwc3 usb: dwc3: debug: purge usage of strcat 2019-02-05 09:00:14 +02:00
early drivers: usb: early: clean up indentation, remove extraneous tabs 2018-11-23 16:13:14 +01:00
gadget USB: gadget: Improve kerneldoc for usb_ep_dequeue() 2019-02-06 08:37:16 +02:00
host USB: EHCI: ehci-mv: add MODULE_DEVICE_TABLE 2019-01-18 10:07:05 +01:00
image scsi: flip the default on use_clustering 2018-12-18 23:13:12 -05:00
isp1760 usb: isp1760: remove redundant variable 'selector' 2018-07-13 15:41:56 +02:00
misc Merge 4.20-rc6 into usb-next 2018-12-10 10:19:08 +01:00
mon USB: mon: use ktime_get_real_ts64 instead of getnstimeofday64 2018-06-25 21:58:26 +08:00
mtu3 usb: mtu3: fix dbginfo in qmu_tx_zlp_error_handler 2018-12-07 07:58:28 +02:00
musb usb: musb: dsps: fix runtime pm for peripheral mode 2018-12-18 15:46:31 +01:00
phy usb: phy: ab8500: silence some uninitialized variable warnings 2018-10-18 19:44:39 +02:00
renesas_usbhs usb: renesas_usbhs: replace udelay() with usleep_range() 2019-01-28 12:51:29 +02:00
roles usb: roles: Add a description for the class to Kconfig 2018-12-17 14:07:59 +01:00
serial USB: serial: keyspan_usa: add proper SPDX lines for .h files 2019-01-18 11:09:32 +01:00
storage USB: storage: add quirk for SMI SM3350 2019-01-07 17:23:30 +01:00
typec USB/PHY patches for 4.21-rc1 2018-12-28 20:30:00 -08:00
usbip USB: usbip: delete README file 2019-01-18 09:35:33 +01:00
wusbcore crypto: drop mask=CRYPTO_ALG_ASYNC from 'cipher' tfm allocations 2018-11-20 14:26:55 +08:00
Kconfig usb: roles: Add a description for the class to Kconfig 2018-12-17 14:07:59 +01:00
Makefile
README
usb-skeleton.c usb: usb-skeleton: use irqsave() in USB's complete callback 2018-06-28 19:36:06 +09:00

To understand all the Linux-USB framework, you'll use these resources:

    * This source code.  This is necessarily an evolving work, and
      includes kerneldoc that should help you get a current overview.
      ("make pdfdocs", and then look at "usb.pdf" for host side and
      "gadget.pdf" for peripheral side.)  Also, Documentation/usb has
      more information.

    * The USB 2.0 specification (from www.usb.org), with supplements
      such as those for USB OTG and the various device classes.
      The USB specification has a good overview chapter, and USB
      peripherals conform to the widely known "Chapter 9".

    * Chip specifications for USB controllers.  Examples include
      host controllers (on PCs, servers, and more); peripheral
      controllers (in devices with Linux firmware, like printers or
      cell phones); and hard-wired peripherals like Ethernet adapters.

    * Specifications for other protocols implemented by USB peripheral
      functions.  Some are vendor-specific; others are vendor-neutral
      but just standardized outside of the www.usb.org team.

Here is a list of what each subdirectory here is, and what is contained in
them.

core/		- This is for the core USB host code, including the
		  usbfs files and the hub class driver ("hub_wq").

host/		- This is for USB host controller drivers.  This
		  includes UHCI, OHCI, EHCI, and others that might
		  be used with more specialized "embedded" systems.

gadget/		- This is for USB peripheral controller drivers and
		  the various gadget drivers which talk to them.


Individual USB driver directories.  A new driver should be added to the
first subdirectory in the list below that it fits into.

image/		- This is for still image drivers, like scanners or
		  digital cameras.
../input/	- This is for any driver that uses the input subsystem,
		  like keyboard, mice, touchscreens, tablets, etc.
../media/	- This is for multimedia drivers, like video cameras,
		  radios, and any other drivers that talk to the v4l
		  subsystem.
../net/		- This is for network drivers.
serial/		- This is for USB to serial drivers.
storage/	- This is for USB mass-storage drivers.
class/		- This is for all USB device drivers that do not fit
		  into any of the above categories, and work for a range
		  of USB Class specified devices. 
misc/		- This is for all USB device drivers that do not fit
		  into any of the above categories.