README 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. To understand all the Linux-USB framework, you'll use these resources:
  2. * This source code. This is necessarily an evolving work, and
  3. includes kerneldoc that should help you get a current overview.
  4. ("make pdfdocs", and then look at "usb.pdf" for host side and
  5. "gadget.pdf" for peripheral side.) Also, Documentation/usb has
  6. more information.
  7. * The USB 2.0 specification (from www.usb.org), with supplements
  8. such as those for USB OTG and the various device classes.
  9. The USB specification has a good overview chapter, and USB
  10. peripherals conform to the widely known "Chapter 9".
  11. * Chip specifications for USB controllers. Examples include
  12. host controllers (on PCs, servers, and more); peripheral
  13. controllers (in devices with Linux firmware, like printers or
  14. cell phones); and hard-wired peripherals like Ethernet adapters.
  15. * Specifications for other protocols implemented by USB peripheral
  16. functions. Some are vendor-specific; others are vendor-neutral
  17. but just standardized outside of the www.usb.org team.
  18. Here is a list of what each subdirectory here is, and what is contained in
  19. them.
  20. core/ - This is for the core USB host code, including the
  21. usbfs files and the hub class driver ("hub_wq").
  22. host/ - This is for USB host controller drivers. This
  23. includes UHCI, OHCI, EHCI, and others that might
  24. be used with more specialized "embedded" systems.
  25. gadget/ - This is for USB peripheral controller drivers and
  26. the various gadget drivers which talk to them.
  27. Individual USB driver directories. A new driver should be added to the
  28. first subdirectory in the list below that it fits into.
  29. image/ - This is for still image drivers, like scanners or
  30. digital cameras.
  31. ../input/ - This is for any driver that uses the input subsystem,
  32. like keyboard, mice, touchscreens, tablets, etc.
  33. ../media/ - This is for multimedia drivers, like video cameras,
  34. radios, and any other drivers that talk to the v4l
  35. subsystem.
  36. ../net/ - This is for network drivers.
  37. serial/ - This is for USB to serial drivers.
  38. storage/ - This is for USB mass-storage drivers.
  39. class/ - This is for all USB device drivers that do not fit
  40. into any of the above categories, and work for a range
  41. of USB Class specified devices.
  42. misc/ - This is for all USB device drivers that do not fit
  43. into any of the above categories.