usb: ehci-hcd: Add IAA handshake for removing async QH
authorYe Li <ye.li@nxp.com>
Tue, 9 Mar 2021 03:26:57 +0000 (19:26 -0800)
committerMarek Vasut <marex@denx.de>
Thu, 22 Apr 2021 19:09:57 +0000 (21:09 +0200)
commite1769da17ed339bc937d30c49176bc3664b261af
treec792e4dc0d7c14c17154f7dd9f29cfe7580cec32
parent275a4490fd2f30df76f2aa07efa0f595fef4d46f
usb: ehci-hcd: Add IAA handshake for removing async QH

According to EHCI spec, software needs to do handshake with HC for
safely removing QH from async list. This handshake is implemented by
setting IAAD (Interrupt on Async Advance Doorbell) bit in USB_USBCMD
register and poll the IAA (Interrupt on Async Advance bit) in the
USB_USBSTS to ensure the HC has released all on-chip state that may
potentially reference one of the data structures just removed.

Current codes only check active status of the last QTD, but this can't
ensure the QH is released from HC. We can meet unrecoverable
"EHCI timed out on TD" errors when running UEFI SCT tests on USB disk.
The USB_ASYNCLISTADDR register is changed to a invalid address when the
issue happens. It is fixed after adding the IAA handshake.

Steps to reproduce the issue:
1. Build the UEFI SCT from https://github.com/tianocore/edk2-test
2. Build the EDK2 UEFI Shell from https://github.com/tianocore/edk2
3. Copy SCT files and Shell.efi to USB disk FAT partition
4. Load the Shell.efi from USB FAT, and run bootefi to execute it
5. After booting into Shell, enter the SCT directory and run "sct -a"
   to execute all tests.
6. Tests run about 1 hour and stop with many EHCI timeout errors like
   EHCI timed out on TD - token=0x801f8c80

Signed-off-by: Ye Li <ye.li@nxp.com>
drivers/usb/host/ehci-hcd.c
drivers/usb/host/ehci.h