linux/drivers/usb
Randy Dunlap 70445ae6c6 USB core: fix recent kernel-doc warnings
Fix new kernel-doc warnings in usb core:

Warning(drivers/usb/core/usb.c:79): No description found for parameter 'config'
Warning(drivers/usb/core/usb.c:79): No description found for parameter 'iface_num'
Warning(drivers/usb/core/usb.c:79): No description found for parameter 'alt_num'
Warning(drivers/usb/core/hcd.c:1622): No description found for parameter 'udev'

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
2009-12-23 11:34:12 -08:00
..
atm firmware_class: make request_firmware_nowait more useful 2009-12-11 11:24:52 -08:00
c67x00 usb/c67x00 endianness annotations 2008-06-04 08:06:01 -07:00
class USB: usbtmc: Use usb_clear_halt() instead of custom code. 2009-12-11 11:55:27 -08:00
core USB core: fix recent kernel-doc warnings 2009-12-23 11:34:12 -08:00
early USB: fix section mismatch in early ehci dbgp 2009-12-23 11:34:11 -08:00
gadget USB: gadget: Use ERR_PTR/IS_ERR 2009-12-23 11:34:10 -08:00
host kfifo: rename kfifo_put... into kfifo_in... and kfifo_get... into kfifo_out... 2009-12-22 14:17:56 -08:00
image USB: remove unneeded printks from microtek driver 2009-09-23 06:46:34 -07:00
misc USB: add device ID for Apple Cinema Display 23in 2007 2009-12-23 11:34:11 -08:00
mon USB: add scatter-gather support to usbmon 2009-12-11 11:55:20 -08:00
musb const: constify remaining dev_pm_ops 2009-12-15 08:53:25 -08:00
otg mfd: Rename all twl4030_i2c* 2009-12-13 21:23:33 +01:00
serial USB: serial: Extra device/vendor ID for mos7840 driver 2009-12-23 11:34:10 -08:00
storage USB: usb-storage: fix bug in fill_inquiry 2009-12-11 11:55:26 -08:00
wusbcore USB: wusb: correctly check size of security descriptor. 2009-12-11 11:55:26 -08:00
Kconfig USB: ehci: Allow EHCI to be built on OMAP3 2009-12-11 11:55:20 -08:00
Makefile USB: Fix double-linking of drivers/usb/otg when ULPI is selected 2009-12-23 11:34:10 -08:00
README USB: fix directory references in usb/README 2007-11-28 13:58:34 -08:00
usb-skeleton.c USB: skeleton: Correct use of ! and & 2009-12-11 11:55:14 -08: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.