Messages in this thread Patch in this message | | | Subject | Re: [PATCH] USB and Driver Core patches for 2.6.10 | Date | Fri, 7 Jan 2005 21:47:44 -0800 | From | Greg KH <> |
| |
ChangeSet 1.1938.446.9, 2004/12/15 15:11:26-08:00, david-b@pacbell.net
[PATCH] USB: update drivers/usb/README
This just adds a bit more info to drivers/usb/README, mostly just pointing to where documentation is to be found (including current kerneldoc).
Signed-off-by: David Brownell <dbrownell@users.sourceforge.net> Signed-off-by: Greg Kroah-Hartman <greg@kroah.com>
drivers/usb/README | 33 ++++++++++++++++++++++++++++----- 1 files changed, 28 insertions(+), 5 deletions(-)
diff -Nru a/drivers/usb/README b/drivers/usb/README --- a/drivers/usb/README 2005-01-07 15:50:23 -08:00 +++ b/drivers/usb/README 2005-01-07 15:50:23 -08:00 @@ -1,14 +1,37 @@ +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. + usbfs files and the hub class driver ("khubd"). -host/ - This is for all of the USB host drivers. This - includes UHCI, OHCI, EHCI, and any others that might - be created in the future. +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 all of the USB device controller drivers. +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 - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
| |