linux/drivers/usb
Alan Stern 8835f66573 [PATCH] USB: USB API documentation modification
In response to complaints about excessive latency in the uhci-hcd driver
I'm planning to convert it to a top-half/bottom-half design.  It turns out
that to do this, the USB API has to be modified slightly since the driver
will not be able to meet one of the guarantees in the current API.  This
patch changes some kerneldoc, specifying the weaker guarantee.

Signed-off-by: Alan Stern <stern@rowland.harvard.edu>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2005-04-18 17:39:30 -07:00
..
atm Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
class Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
core [PATCH] USB: USB API documentation modification 2005-04-18 17:39:30 -07:00
gadget [PATCH] USB: fix up remaining pm_message_t usages 2005-04-18 17:39:24 -07:00
host [PATCH] USB: OHCI on Compaq Aramada 7400 2005-04-18 17:39:30 -07:00
image [PATCH] kill old EH constants 2005-04-16 20:14:52 -05:00
input [PATCH] usb suspend updates (interface suspend) 2005-04-18 17:39:22 -07:00
media Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
misc [PATCH] USB: new SIS device id 2005-04-18 17:39:28 -07:00
mon Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
net [PATCH] USB: usbnet and zaurus zl-5600 2005-04-18 17:39:29 -07:00
serial [PATCH] USB: usb/digi_acceleport: correct wait-queue state 2005-04-18 17:39:25 -07:00
storage [PATCH] USB Storage unusual_dev.h 07c4:a10b Datafab Systems, Inc. 2005-04-18 17:39:28 -07:00
Kconfig Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
Makefile Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
README Linux-2.6.12-rc2 2005-04-16 15:20:36 -07:00
usb-skeleton.c Linux-2.6.12-rc2 2005-04-16 15:20:36 -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.