linux/drivers/usb
David Brownell a082b5c788 USB: ehci: qh/qtd cleanup comments
Provide better comments about qh_completions() and QTD handling.
That code can be *VERY* confusing, since it's evolved over a few
years to cope with both hardware races and silicon quirks.

Remove two unlikely() annotations that match the GCC defaults
(and are thus pointless); add an "else" to highlight code flow.

This patch doesn't change driver behavior.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2008-04-24 21:16:50 -07:00
..
atm USB: usbatm: convert heavy init dances to kthread API 2008-04-24 21:16:34 -07:00
class USB: increase cdc-acm write throughput 2008-04-24 21:16:44 -07:00
core USB: log an error message when USB enumeration fails 2008-04-24 21:16:50 -07:00
gadget USB: at91_udc can prefetch data 2008-04-24 21:16:49 -07:00
host USB: ehci: qh/qtd cleanup comments 2008-04-24 21:16:50 -07:00
image usb: replace remaining __PRETTY_FUNCTION__ occurrences 2008-04-24 21:16:48 -07:00
misc USB: Remove EXPERIMENTAL designation from USB misc/ Kconfig entries 2008-04-24 21:16:43 -07:00
mon usbmon: restore mmap 2008-04-24 21:16:43 -07:00
serial USB: Remove superfluous "depends on USB_SERIAL" from Kconfig. 2008-04-24 21:16:50 -07:00
storage USB: usb-storage: use adaptive DMA mask 2008-04-24 21:16:46 -07:00
Kconfig USB: add support for SuperH OHCI 2008-02-01 14:35:03 -08:00
Makefile USB: always visit drivers/usb/misc/ 2007-10-12 14:55:26 -07:00
README USB: fix directory references in usb/README 2007-11-28 13:58:34 -08:00
usb-skeleton.c USB: usb-skeleton leaking locks on open 2007-10-12 14:55:26 -07: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 ("khubd").

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.