linux/drivers/usb
Soeren Moch 85ecd0322b USB: EHCI: fix bug in iTD/siTD DMA pool allocation
[Description written by Alan Stern]

Soeren tracked down a very difficult bug in ehci-hcd's DMA pool
management of iTD and siTD structures.  Some background: ehci-hcd
gives each isochronous endpoint its own set of active and free itd's
(or sitd's for full-speed devices).  When a new itd is needed, it is
taken from the head of the free list, if possible.  However, itd's
must not be used twice in a single frame because the hardware
continues to access the data structure for the entire duration of a
frame.  Therefore if the itd at the head of the free list has its
"frame" member equal to the current value of ehci->now_frame, it
cannot be reused and instead a new itd is allocated from the DMA pool.
The entries on the free list are not released back to the pool until
the endpoint is no longer in use.

The bug arises from the fact that sometimes an itd can be moved back
onto the free list before itd->frame has been set properly.  In
Soeren's case, this happened because ehci-hcd can allocate one more
itd than it actually needs for an URB; the extra itd may or may not be
required depending on how the transfer aligns with a frame boundary.
For example, an URB with 8 isochronous packets will cause two itd's to
be allocated.  If the URB is scheduled to start in microframe 3 of
frame N then it will require both itds: one for microframes 3 - 7 of
frame N and one for microframes 0 - 2 of frame N+1.  But if the URB
had been scheduled to start in microframe 0 then it would require only
the first itd, which could cover microframes 0 - 7 of frame N.  The
second itd would be returned to the end of the free list.

The itd allocation routine initializes the entire structure to 0, so
the extra itd ends up on the free list with itd->frame set to 0
instead of a meaningful value.  After a while the itd reaches the head
of the list, and occasionally this happens when ehci->now_frame is
equal to 0.  Then, even though it would be okay to reuse this itd, the
driver thinks it must get another itd from the DMA pool.

For as long as the isochronous endpoint remains in use, this flaw in
the mechanism causes more and more itd's to be taken slowly from the
DMA pool.  Since none are released back, the pool eventually becomes
exhausted.

This reuslts in memory allocation failures, which typically show up
during a long-running audio stream.  Video might suffer the same
effect.

The fix is very simple.  To prevent allocations from the pool when
they aren't needed, make sure that itd's sent back to the free list
prematurely have itd->frame set to an invalid value which can never be
equal to ehci->now_frame.

This should be applied to -stable kernels going back to 3.6.

Signed-off-by: Soeren Moch <smoch@web.de>
Signed-off-by: Alan Stern <stern@rowland.harvard.edu>
Cc: stable <stable@vger.kernel.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2013-03-25 13:59:04 -07:00
..
atm Merge branch 'for-3.7' of git://git.kernel.org/pub/scm/linux/kernel/git/tj/wq 2012-10-02 09:54:49 -07:00
c67x00 usb: c67x00 RetryCnt value in c67x00 TD should be 3 2013-03-07 12:31:37 +08:00
chipidea usb: chipidea: register debugging sysfs on our device 2013-03-04 09:33:25 +02:00
class USB: cdc-acm: fix device unregistration 2013-03-21 15:59:01 -07:00
core USB: xhci: correctly enable interrupts 2013-03-15 12:07:53 -07:00
dwc3 usb: dwc3: ep0: fix sparc64 build 2013-03-08 09:42:50 +02:00
early fix build of EHCI debug port code when USB_CHIPIDEA but !USB_EHCI_HCD 2012-11-02 10:13:33 -07:00
gadget usb: fixes for v3.9-rc4 2013-03-21 08:40:22 -07:00
host USB: EHCI: fix bug in iTD/siTD DMA pool allocation 2013-03-25 13:59:04 -07:00
image USB: mdc800.c: remove dbg() usage 2012-05-01 21:33:50 -07:00
misc USB: altsetting overrides for usbtest 2013-01-31 10:09:19 +01:00
mon mm: kill vma flag VM_RESERVED and mm->reserved_vm counter 2012-10-09 16:22:19 +09:00
musb usb: fixes for v3.9-rc4 2013-03-21 08:40:22 -07:00
otg usb: otg: use try_module_get in all usb_get_phy functions and add missing module_put 2013-03-04 09:33:30 +02:00
phy usb: phy: omap-control-usb: Convert to devm_ioremap_resource() 2013-03-04 13:08:53 +02:00
renesas_usbhs USB patches for 3.9-rc1 2013-02-21 12:20:00 -08:00
serial USB: ti_usb_3410_5052: fix use-after-free in TIOCMIWAIT 2013-03-21 15:59:05 -07:00
storage usb-storage: add unusual_devs entry for Samsung YP-Z3 mp3 player 2013-03-15 12:07:53 -07:00
wusbcore USB: wusbcore/wa-xfer: error handling fixes in setup_segs() 2013-02-06 11:38:14 -08:00
Kconfig USB: select USB_ARCH_HAS_EHCI for MXS 2013-01-11 16:01:06 -08:00
Makefile usb: Makefile: fix drivers/usb/phy/ Makefile entry 2013-03-07 12:29:09 +08:00
README
usb-common.c
usb-skeleton.c USB: usb-skeleton.c: fix compilation error and restored kref_put on fail in skel_open 2012-10-24 14:40:50 -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.