kernel-hacking-2024-linux-s.../drivers/usb
David Brownell fbf54dd320 USB: usb/dma doc updates
This patch updates some of the documentation about DMA buffer management
for USB, and ways to avoid extra copying.  Our understanding of the issues
has improved over time.

 - Most drivers should *avoid* the dma-coherent allocators.  There are
   a few exceptions (like the HID driver).

 - Some methods are currently commented out; it seems folk writing
   USB drivers aren't doing performance tuning at that level yet.

 - Just avoid highmem; there's no good way to pass an "I can do highmem
   DMA" capability through a driver stack.  This is easy, everything
   already avoids highmem.  But it'd be nice if x86_32 systems with much
   physical memory could use it directly with network adapters and mass
   storage devices.  (Patch, anyone?)

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2007-07-12 16:34:42 -07:00
..
atm USB: cxacru: Cleanup sysfs attribute code 2007-07-12 16:29:45 -07:00
class USB: usblp: add dynamic URBs, fix races 2007-07-12 16:34:39 -07:00
core USB: usb/dma doc updates 2007-07-12 16:34:42 -07:00
gadget USB: Don't resume root hub if the controller is suspended 2007-07-12 16:34:39 -07:00
host USB: Don't resume root hub if the controller is suspended 2007-07-12 16:34:39 -07:00
image header cleaning: don't include smp_lock.h when not used 2007-05-08 11:15:07 -07:00
misc USB: Support Blackberry Pearl with berry_charge 2007-07-12 16:34:40 -07:00
mon usbmon: Add class for binary interface 2007-07-12 16:29:47 -07:00
serial USB: io_*: remove bogus termios no change checks 2007-07-12 16:34:41 -07:00
storage USB: drivers/usb/storage/unusual_devs.h whitespace cleanup 2007-07-12 16:34:41 -07:00
Kconfig USB: fix gregkh-usb-usb-use-menuconfig-objects 2007-07-12 16:34:40 -07:00
Makefile USB: remove Makefile reference to obsolete OHCI_AT91 2007-07-12 16:34:41 -07:00
README
usb-skeleton.c USB: usb-skeleton: use anchors in pre/post reset 2007-07-12 16:34:37 -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.