MdeModulePkg Xhci: Also RecoverHaltedEndpoint for BABBLE_ERROR

[mirror_edk2.git] / MdeModulePkg / Bus / Pci / XhciPei / XhcPeim.c

diff --git a/MdeModulePkg/Bus/Pci/XhciPei/XhcPeim.c b/MdeModulePkg/Bus/Pci/XhciPei/XhcPeim.c
index 72e86caeb0e98da60f20e28cf90673dfde124842..38f0d2184cff71e3ec7739c9e8e7d7ed910c5c07 100644 (file)
--- a/MdeModulePkg/Bus/Pci/XhciPei/XhcPeim.c
+++ b/MdeModulePkg/Bus/Pci/XhciPei/XhcPeim.c
@@ -2,7 +2,7 @@
 PEIM to produce gPeiUsb2HostControllerPpiGuid based on gPeiUsbControllerPpiGuid\r
 which is used to enable recovery function from USB Drivers.\r
 \r
-Copyright (c) 2014, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2014 - 2017, Intel Corporation. All rights reserved.<BR>\r
 \r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions\r
@@ -161,7 +161,7 @@ XhcPeiClearOpRegBit (
   @param  Offset        The offset of the operational register.\r
   @param  Bit           The bit mask of the register to wait for.\r
   @param  WaitToSet     Wait the bit to set or clear.\r
-  @param  Timeout       The time to wait before abort (in microsecond, us).\r
+  @param  Timeout       The time to wait before abort (in millisecond, ms).\r
 \r
   @retval EFI_SUCCESS   The bit successfully changed by host controller.\r
   @retval EFI_TIMEOUT   The time out occurred.\r
@@ -176,14 +176,14 @@ XhcPeiWaitOpRegBit (
   IN UINT32             Timeout\r
   )\r
 {\r
-  UINT32                Index;\r
+  UINT64                Index;\r
 \r
-  for (Index = 0; Index < Timeout / XHC_POLL_DELAY + 1; Index++) {\r
+  for (Index = 0; Index < Timeout * XHC_1_MILLISECOND; Index++) {\r
     if (XHC_REG_BIT_IS_SET (Xhc, Offset, Bit) == WaitToSet) {\r
       return EFI_SUCCESS;\r
     }\r
 \r
-    MicroSecondDelay (XHC_POLL_DELAY);\r
+    MicroSecondDelay (XHC_1_MICROSECOND);\r
   }\r
 \r
   return EFI_TIMEOUT;\r
@@ -381,7 +381,7 @@ XhcPeiIsSysError (
   Reset the host controller.\r
 \r
   @param  Xhc           The XHCI device.\r
-  @param  Timeout       Time to wait before abort (in microsecond, us).\r
+  @param  Timeout       Time to wait before abort (in millisecond, ms).\r
 \r
   @retval EFI_TIMEOUT   The transfer failed due to time out.\r
   @retval Others        Failed to reset the host.\r
@@ -407,6 +407,12 @@ XhcPeiResetHC (
   }\r
 \r
   XhcPeiSetOpRegBit (Xhc, XHC_USBCMD_OFFSET, XHC_USBCMD_RESET);\r
+  //\r
+  // Some XHCI host controllers require to have extra 1ms delay before accessing any MMIO register during reset.\r
+  // Otherwise there may have the timeout case happened.\r
+  // The below is a workaround to solve such problem.\r
+  //\r
+  MicroSecondDelay (1000);\r
   Status = XhcPeiWaitOpRegBit (Xhc, XHC_USBCMD_OFFSET, XHC_USBCMD_RESET, FALSE, Timeout);\r
 ON_EXIT:\r
   DEBUG ((EFI_D_INFO, "XhcPeiResetHC: %r\n", Status));\r
@@ -648,17 +654,28 @@ XhcPeiControlTransfer (
   *TransferResult = Urb->Result;\r
   *DataLength     = Urb->Completed;\r
 \r
-  if (*TransferResult == EFI_USB_NOERROR) {\r
-    Status = EFI_SUCCESS;\r
-  } else if (*TransferResult == EFI_USB_ERR_STALL) {\r
-    RecoveryStatus = XhcPeiRecoverHaltedEndpoint(Xhc, Urb);\r
-    if (EFI_ERROR (RecoveryStatus)) {\r
-      DEBUG ((EFI_D_ERROR, "XhcPeiControlTransfer: XhcPeiRecoverHaltedEndpoint failed\n"));\r
+  if (Status == EFI_TIMEOUT) {\r
+    //\r
+    // The transfer timed out. Abort the transfer by dequeueing of the TD.\r
+    //\r
+    RecoveryStatus = XhcPeiDequeueTrbFromEndpoint(Xhc, Urb);\r
+    if (EFI_ERROR(RecoveryStatus)) {\r
+      DEBUG((EFI_D_ERROR, "XhcPeiControlTransfer: XhcPeiDequeueTrbFromEndpoint failed\n"));\r
     }\r
-    Status = EFI_DEVICE_ERROR;\r
     goto FREE_URB;\r
   } else {\r
-    goto FREE_URB;\r
+    if (*TransferResult == EFI_USB_NOERROR) {\r
+      Status = EFI_SUCCESS;\r
+    } else if ((*TransferResult == EFI_USB_ERR_STALL) || (*TransferResult == EFI_USB_ERR_BABBLE)) {\r
+      RecoveryStatus = XhcPeiRecoverHaltedEndpoint(Xhc, Urb);\r
+      if (EFI_ERROR (RecoveryStatus)) {\r
+        DEBUG ((EFI_D_ERROR, "XhcPeiControlTransfer: XhcPeiRecoverHaltedEndpoint failed\n"));\r
+      }\r
+      Status = EFI_DEVICE_ERROR;\r
+      goto FREE_URB;\r
+    } else {\r
+      goto FREE_URB;\r
+    }\r
   }\r
 \r
   //\r
@@ -676,7 +693,7 @@ XhcPeiControlTransfer (
       // Store a copy of device scriptor as hub device need this info to configure endpoint.\r
       //\r
       CopyMem (&Xhc->UsbDevContext[SlotId].DevDesc, Data, *DataLength);\r
-      if (Xhc->UsbDevContext[SlotId].DevDesc.BcdUSB == 0x0300) {\r
+      if (Xhc->UsbDevContext[SlotId].DevDesc.BcdUSB >= 0x0300) {\r
         //\r
         // If it's a usb3.0 device, then its max packet size is a 2^n.\r
         //\r
@@ -960,14 +977,24 @@ XhcPeiBulkTransfer (
   *TransferResult = Urb->Result;\r
   *DataLength     = Urb->Completed;\r
 \r
-  if (*TransferResult == EFI_USB_NOERROR) {\r
-    Status = EFI_SUCCESS;\r
-  } else if (*TransferResult == EFI_USB_ERR_STALL) {\r
-    RecoveryStatus = XhcPeiRecoverHaltedEndpoint(Xhc, Urb);\r
-    if (EFI_ERROR (RecoveryStatus)) {\r
-      DEBUG ((EFI_D_ERROR, "XhcPeiBulkTransfer: XhcPeiRecoverHaltedEndpoint failed\n"));\r
+  if (Status == EFI_TIMEOUT) {\r
+    //\r
+    // The transfer timed out. Abort the transfer by dequeueing of the TD.\r
+    //\r
+    RecoveryStatus = XhcPeiDequeueTrbFromEndpoint(Xhc, Urb);\r
+    if (EFI_ERROR(RecoveryStatus)) {\r
+      DEBUG((EFI_D_ERROR, "XhcPeiBulkTransfer: XhcPeiDequeueTrbFromEndpoint failed\n"));\r
+    }\r
+  } else {\r
+    if (*TransferResult == EFI_USB_NOERROR) {\r
+      Status = EFI_SUCCESS;\r
+    } else if ((*TransferResult == EFI_USB_ERR_STALL) || (*TransferResult == EFI_USB_ERR_BABBLE)) {\r
+      RecoveryStatus = XhcPeiRecoverHaltedEndpoint(Xhc, Urb);\r
+      if (EFI_ERROR (RecoveryStatus)) {\r
+        DEBUG ((EFI_D_ERROR, "XhcPeiBulkTransfer: XhcPeiRecoverHaltedEndpoint failed\n"));\r
+      }\r
+      Status = EFI_DEVICE_ERROR;\r
     }\r
-    Status = EFI_DEVICE_ERROR;\r
   }\r
 \r
   XhcPeiFreeUrb (Xhc, Urb);\r