linux/drivers/usb
Sarah Sharp 3b3db02641 xhci: Add infrastructure for host-specific LPM policies.
The choice of U1 and U2 timeouts for USB 3.0 Link Power Management (LPM)
is highly host controller specific.  Here are a few examples of why it's
host specific:

 1. Setting the U1/U2 timeout too short may cause the link to go into
    U1/U2 in between service intervals, which some hosts may tolerate,
    and some may not.

 2. The host controller has to modify its bus schedule in order to take
    into account the Maximum Exit Latency (MEL) to bring all the links
    from the host to the device into U0.  If the MEL is too big, and it
    takes too long to bring the links into an active state, the host
    controller may not be able to service periodic endpoints in time.

 3. Host controllers may also have scheduling limitations that force
    them to disable U1 or U2 if a USB device is behind too many tiers of
    hubs.

We could take an educated guess at what U1/U2 timeouts may work for a
particular host controller.  However, that would result in a binary
search on every new configuration or alt setting installation, with
multiple failed Evaluate Context commands.  Worse, the host may blindly
accept the timeouts and just fail to update its schedule for U1/U2 exit
latencies, which could result in randomly delayed periodic transfers.

Since we don't want to cause jitter in periodic transfers, or delay
config/alt setting changes too much, lay down a framework that xHCI
vendors can extend in order to add their own U1/U2 timeout policies.

To extend the framework, they will need to:

 - Modify the PCI init code to add a new xhci->quirk for their host, and
   set the XHCI_LPM_SUPPORT quirk flag.
 - Add their own vendor-specific hooks, like the ones that will be added
   in xhci_call_host_update_timeout_for_endpoint() and
   xhci_check_tier_policy()
 - Make the LPM enable/disable methods call those functions based on the
   xhci->quirk for their host.

An example will be provided for the Intel xHCI host controller in the
next patch.

Signed-off-by: Sarah Sharp <sarah.a.sharp@linux.intel.com>
2012-05-18 15:42:03 -07:00
..
atm USB: xusbatm.c: remove dbg() usage 2012-05-01 21:33:30 -07:00
c67x00 usb: convert drivers/usb/* to use module_platform_driver() 2011-11-28 06:48:32 +09:00
chipidea usb: chipidea: remove zero check of hw_ep_max 2012-05-15 08:43:40 -07:00
class USB: cdc-wdm: remove from device list on disconnect 2012-05-11 15:19:22 -07:00
core USB: Disable USB 3.0 LPM in critical sections. 2012-05-18 15:41:59 -07:00
dwc3 usb: dwc3: Fix the dwc3 dependency 2012-05-11 15:17:31 -07:00
early USB: EHCI: Support controllers with big endian capability regs 2011-05-03 11:43:21 -07:00
gadget usb: gadget: at91_udc: fix endpoint descriptor dereference 2012-05-16 05:29:20 -07:00
host xhci: Add infrastructure for host-specific LPM policies. 2012-05-18 15:42:03 -07:00
image USB: mdc800.c: remove dbg() usage 2012-05-01 21:33:50 -07:00
misc USB: yurex.c: remove dbg() usage 2012-05-01 21:34:11 -07:00
mon usb: Add export.h for EXPORT_SYMBOL/THIS_MODULE where needed 2011-10-31 19:31:25 -04:00
musb usb: musb: cppi: add missing include to fix compilation 2012-05-14 12:45:45 -07:00
otg USB: gpio_vbus: avoid consecutive vbus_session calls with the same "is_active" 2012-05-14 09:02:23 -07:00
phy USB: Add driver for NXP ISP1301 USB transceiver 2012-05-01 13:33:02 -04:00
renesas_usbhs usb: renesas_usbhs: gadget: add support for set_selfpowered 2012-05-04 15:53:05 +03:00
serial Revert "USB: serial: sierra: put reset_resume callback back." 2012-05-16 08:39:56 -07:00
storage USB: storage: fixed keyword related space issues. 2012-05-17 09:48:29 -07:00
wusbcore uwb & wusb: fix kconfig error 2012-01-26 11:22:42 -08:00
Kconfig usb: move ci13xxx and related code to drivers/usb/chipidea 2012-05-11 16:45:30 -07:00
Makefile usb: move ci13xxx and related code to drivers/usb/chipidea 2012-05-11 16:45:30 -07:00
README
usb-common.c usb: Provide usb_speed_string() function 2011-09-18 01:29:04 -07:00
usb-skeleton.c USB: usb-skeleton.c: remove err() usage 2012-04-27 11:24:45 -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.