[mirror_edk2.git] / EdkModulePkg / Bus / Pci / Ehci / Dxe / Ehci.c

/*++\r
\r
Copyright (c) 2006, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
Module Name:\r
\r
    Ehci.c\r
\r
Abstract:\r
\r
\r
Revision History\r
--*/\r
\r
\r
#include "Ehci.h"\r
\r
\r
GLOBAL_REMOVE_IF_UNREFERENCED UINTN    gEHCDebugLevel  = EFI_D_ERROR;\r
GLOBAL_REMOVE_IF_UNREFERENCED UINTN    gEHCErrorLevel  = EFI_D_ERROR;\r
\r
\r
//\r
// Ehci Driver Global Variables\r
//\r
EFI_DRIVER_BINDING_PROTOCOL gEhciDriverBinding = {\r
  EhciDriverBindingSupported,\r
  EhciDriverBindingStart,\r
  EhciDriverBindingStop,\r
  0xa,\r
  NULL,\r
  NULL\r
};\r
\r
\r
EFI_STATUS\r
EFIAPI\r
EhciDriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
  IN EFI_HANDLE                  Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL    *RemainingDevicePath\r
  )\r
/*++\r
\r
  Routine Description:\r
\r
    Test to see if this driver supports ControllerHandle. Any ControllerHandle\r
    that has Usb2HcProtocol installed will be supported.\r
\r
  Arguments:\r
\r
    This                - Protocol instance pointer.\r
    Controlle           - Handle of device to test\r
    RemainingDevicePath - Not used\r
\r
  Returns:\r
\r
    EFI_SUCCESS       This driver supports this device.\r
    EFI_UNSUPPORTED   This driver does not support this device.\r
\r
--*/\r
{\r
  EFI_STATUS          Status;\r
  EFI_PCI_IO_PROTOCOL *PciIo;\r
  USB_CLASSC          UsbClassCReg;\r
\r
\r
  //\r
  // Test whether there is PCI IO Protocol attached on the controller handle.\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiPciIoProtocolGuid,\r
                  (VOID **) &PciIo,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    goto exit;\r
  }\r
\r
  Status = PciIo->Pci.Read (\r
                        PciIo,\r
                        EfiPciIoWidthUint8,\r
                        CLASSC,\r
                        sizeof (USB_CLASSC) / sizeof (UINT8),\r
                        &UsbClassCReg\r
                        );\r
  if (EFI_ERROR (Status)) {\r
    gBS->CloseProtocol (\r
          Controller,\r
          &gEfiPciIoProtocolGuid,\r
          This->DriverBindingHandle,\r
          Controller\r
          );\r
    Status = EFI_UNSUPPORTED;\r
    goto exit;\r
  }\r
\r
  //\r
  // Test whether the controller belongs to Ehci type\r
  //\r
  if ((UsbClassCReg.BaseCode != PCI_CLASS_SERIAL) ||\r
      (UsbClassCReg.SubClassCode != PCI_CLASS_SERIAL_USB) ||\r
      (UsbClassCReg.PI != PCI_CLASSC_PI_EHCI)\r
      ) {\r
\r
    gBS->CloseProtocol (\r
           Controller,\r
           &gEfiPciIoProtocolGuid,\r
           This->DriverBindingHandle,\r
           Controller\r
           );\r
\r
    Status = EFI_UNSUPPORTED;\r
    goto exit;\r
  }\r
\r
  gBS->CloseProtocol (\r
         Controller,\r
         &gEfiPciIoProtocolGuid,\r
         This->DriverBindingHandle,\r
         Controller\r
         );\r
\r
exit:\r
  return Status;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
EhciDriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
  IN EFI_HANDLE                  Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL    *RemainingDevicePath\r
  )\r
/*++\r
\r
  Routine Description:\r
\r
    Starting the Usb EHCI Driver\r
\r
  Arguments:\r
\r
    This                - Protocol instance pointer.\r
    Controller          - Handle of device to test\r
    RemainingDevicePath - Not used\r
\r
  Returns:\r
\r
    EFI_SUCCESS           supports this device.\r
    EFI_UNSUPPORTED       do not support this device.\r
    EFI_DEVICE_ERROR      cannot be started due to device Error\r
    EFI_OUT_OF_RESOURCES  cannot allocate resources\r
\r
--*/\r
{\r
  EFI_STATUS            Status;\r
  USB2_HC_DEV           *HcDev;\r
  EFI_PCI_IO_PROTOCOL   *PciIo;\r
  UINT8                 MaxSpeed;\r
  UINT8                 PortNumber;\r
  UINT8                 Is64BitCapable;\r
  UINT64                Supports;\r
\r
  //\r
  // Open the PciIo Protocol\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiPciIoProtocolGuid,\r
                  (VOID **) &PciIo,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto exit;\r
  }\r
\r
  //\r
  // Enable the USB Host Controller\r
  //\r
  Status = PciIo->Attributes (\r
                    PciIo,\r
                    EfiPciIoAttributeOperationSupported,\r
                    0,\r
                    &Supports\r
                    );\r
  if (!EFI_ERROR (Status)) {\r
    Supports &= EFI_PCI_DEVICE_ENABLE;\r
    Status = PciIo->Attributes (\r
                      PciIo,\r
                      EfiPciIoAttributeOperationEnable,\r
                      Supports,\r
                      NULL\r
                      );\r
  }\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto close_pciio_protocol;\r
  }\r
\r
  //\r
  // Allocate memory for EHC private data structure\r
  //\r
  HcDev = AllocateZeroPool (sizeof (USB2_HC_DEV));\r
  if (NULL == HcDev) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto close_pciio_protocol;\r
  }\r
\r
  //\r
  // Init EFI_USB2_HC_PROTOCOL interface and private data structure\r
  //\r
  HcDev->Usb2Hc.GetCapability             = EhciGetCapability;\r
  HcDev->Usb2Hc.Reset                     = EhciReset;\r
  HcDev->Usb2Hc.GetState                  = EhciGetState;\r
  HcDev->Usb2Hc.SetState                  = EhciSetState;\r
  HcDev->Usb2Hc.ControlTransfer           = EhciControlTransfer;\r
  HcDev->Usb2Hc.BulkTransfer              = EhciBulkTransfer;\r
  HcDev->Usb2Hc.AsyncInterruptTransfer    = EhciAsyncInterruptTransfer;\r
  HcDev->Usb2Hc.SyncInterruptTransfer     = EhciSyncInterruptTransfer;\r
  HcDev->Usb2Hc.IsochronousTransfer       = EhciIsochronousTransfer;\r
  HcDev->Usb2Hc.AsyncIsochronousTransfer  = EhciAsyncIsochronousTransfer;\r
  HcDev->Usb2Hc.GetRootHubPortStatus      = EhciGetRootHubPortStatus;\r
  HcDev->Usb2Hc.SetRootHubPortFeature     = EhciSetRootHubPortFeature;\r
  HcDev->Usb2Hc.ClearRootHubPortFeature   = EhciClearRootHubPortFeature;\r
  HcDev->Usb2Hc.MajorRevision             = 0x1;\r
  HcDev->Usb2Hc.MinorRevision             = 0x1;\r
\r
  HcDev->AsyncRequestList                 = NULL;\r
  HcDev->ControllerNameTable              = NULL;\r
  HcDev->Signature                        = USB2_HC_DEV_SIGNATURE;\r
  HcDev->PciIo = PciIo;\r
\r
  //\r
  // Install USB2_HC_PROTOCOL\r
  //\r
  Status = gBS->InstallProtocolInterface (\r
                  &Controller,\r
                  &gEfiUsb2HcProtocolGuid,\r
                  EFI_NATIVE_INTERFACE,\r
                  &HcDev->Usb2Hc\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto free_pool;\r
  }\r
\r
  //\r
  // Get Capability Register Length\r
  //\r
  Status = GetCapabilityLen (HcDev);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto uninstall_usb2hc_protocol;\r
  }\r
\r
  ClearLegacySupport (HcDev);\r
  HostReset (HcDev);\r
\r
  DEBUG_CODE (\r
   DumpEHCIPortsStatus (HcDev);\r
  );\r
\r
  //\r
  // Create and Init Perodic Frame List\r
  //\r
  Status = EhciGetCapability (\r
             &HcDev->Usb2Hc,\r
             &MaxSpeed,\r
             &PortNumber,\r
             &Is64BitCapable\r
             );\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto uninstall_usb2hc_protocol;\r
  }\r
  HcDev->Is64BitCapable = Is64BitCapable;\r
\r
  //\r
  // Create and Init Perodic Frame List\r
  //\r
  Status = InitialPeriodicFrameList (\r
             HcDev,\r
             EHCI_MAX_FRAME_LIST_LENGTH\r
             );\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto uninstall_usb2hc_protocol;\r
  }\r
\r
  //\r
  // Init memory pool management\r
  //\r
  Status = InitialMemoryManagement (HcDev);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto deinit_perodic_frame_list;\r
  }\r
\r
  Status = CreateNULLQH (HcDev);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto deinit_perodic_frame_list;\r
  }\r
  //\r
  // Create AsyncRequest Polling Timer\r
  //\r
  Status = CreatePollingTimer (HcDev, (EFI_EVENT_NOTIFY) AsyncRequestMoniter);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto deinit_null_qh;\r
  }\r
\r
  //\r
  // Default Maxximum Interrupt Interval is 8,\r
  // it means that 8 micro frame = 1ms\r
  //\r
\r
  //\r
  // Start the Host Controller\r
  //\r
  if (IsEhcHalted (HcDev)) {\r
    Status = StartScheduleExecution (HcDev);\r
    if (EFI_ERROR (Status)) {\r
      Status = EFI_DEVICE_ERROR;\r
      goto deinit_timer;\r
    }\r
  }\r
\r
  //\r
  // Set all ports routing to EHC\r
  //\r
  Status = SetPortRoutingEhc (HcDev);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto deinit_timer;\r
  }\r
\r
  //\r
  // Component name protocol\r
  //\r
  Status = AddUnicodeString (\r
             "eng",\r
             gEhciComponentName.SupportedLanguages,\r
             &HcDev->ControllerNameTable,\r
             L"Usb Enhanced Host Controller"\r
             );\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto deinit_timer;\r
  }\r
\r
  goto exit;\r
\r
  //\r
  // Error handle process\r
  //\r
deinit_timer:\r
  DestoryPollingTimer (HcDev);\r
deinit_null_qh:\r
  DestroyNULLQH(HcDev);\r
  DeinitialMemoryManagement (HcDev);\r
deinit_perodic_frame_list:\r
  DeinitialPeriodicFrameList (HcDev);\r
uninstall_usb2hc_protocol:\r
  gBS->UninstallProtocolInterface (\r
         Controller,\r
         &gEfiUsb2HcProtocolGuid,\r
         &HcDev->Usb2Hc\r
         );\r
free_pool:\r
  gBS->FreePool (HcDev);\r
close_pciio_protocol:\r
  gBS->CloseProtocol (\r
         Controller,\r
         &gEfiPciIoProtocolGuid,\r
         This->DriverBindingHandle,\r
         Controller\r
         );\r
\r
exit:\r
  return Status;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
EhciDriverBindingStop (\r
  IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
  IN EFI_HANDLE                  Controller,\r
  IN UINTN                       NumberOfChildren,\r
  IN EFI_HANDLE                  *ChildHandleBuffer\r
  )\r
/*++\r
\r
  Routine Description:\r
\r
    Stop this driver on ControllerHandle. Support stoping any child handles\r
    created by this driver.\r
\r
  Arguments:\r
\r
    This              - Protocol instance pointer.\r
    Controller        - Handle of device to stop driver on\r
    NumberOfChildren  - Number of Children in the ChildHandleBuffer\r
    ChildHandleBuffer - List of handles for the children we need to stop.\r
\r
  Returns:\r
\r
    EFI_SUCCESS         Success\r
    EFI_DEVICE_ERROR    Fail\r
--*/\r
{\r
  EFI_STATUS            Status;\r
  EFI_USB2_HC_PROTOCOL  *Usb2Hc;\r
  USB2_HC_DEV           *HcDev;\r
  UINT64                Supports;\r
\r
  //\r
  // Test whether the Controller handler passed in is a valid\r
  // Usb controller handle that should be supported, if not,\r
  // return the error status directly\r
  //\r
  Status = gBS->OpenProtocol (\r
                  Controller,\r
                  &gEfiUsb2HcProtocolGuid,\r
                  (VOID **) &Usb2Hc,\r
                  This->DriverBindingHandle,\r
                  Controller,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  HcDev = USB2_HC_DEV_FROM_THIS (Usb2Hc);\r
\r
  //\r
  // free all the controller related memory and uninstall UHCI Protocol.\r
  //\r
  Status = gBS->UninstallProtocolInterface (\r
                  Controller,\r
                  &gEfiUsb2HcProtocolGuid,\r
                  Usb2Hc\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  //\r
  // Set Host Controller state as halt\r
  //\r
  Status = Usb2Hc->SetState (\r
                     Usb2Hc,\r
                     EfiUsbHcStateHalt\r
                     );\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  //\r
  // Stop AsyncRequest Polling Timer\r
  //\r
  Status = StopPollingTimer (HcDev);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  //\r
  // Destroy Asynchronous Request Event\r
  //\r
  DestoryPollingTimer (HcDev);\r
\r
  //\r
  // Destroy Perodic Frame List\r
  //\r
  DeinitialPeriodicFrameList (HcDev);\r
\r
  //\r
  // Destroy NULLQH\r
  //\r
  DestroyNULLQH (HcDev);\r
\r
  //\r
  // Deinit Ehci pool memory management\r
  //\r
  DeinitialMemoryManagement (HcDev);\r
\r
  //\r
  // Denint Unicode String Table\r
  //\r
  FreeUnicodeStringTable (HcDev->ControllerNameTable);\r
\r
  //\r
  // Disable the USB Host Controller\r
  //\r
  Status = HcDev->PciIo->Attributes (\r
                           HcDev->PciIo,\r
                           EfiPciIoAttributeOperationSupported,\r
                           0,\r
                           &Supports\r
                           );\r
  if (!EFI_ERROR (Status)) {\r
    Supports &= EFI_PCI_DEVICE_ENABLE;\r
    Status = HcDev->PciIo->Attributes (\r
                             HcDev->PciIo,\r
                             EfiPciIoAttributeOperationDisable,\r
                             Supports,\r
                             NULL\r
                             );\r
  }\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  gBS->FreePool (HcDev);\r
\r
  gBS->CloseProtocol (\r
        Controller,\r
        &gEfiPciIoProtocolGuid,\r
        This->DriverBindingHandle,\r
        Controller\r
        );\r
\r
exit:\r
  return Status;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
EhciGetCapability (\r
  IN  EFI_USB2_HC_PROTOCOL *This,\r
  OUT UINT8                *MaxSpeed,\r
  OUT UINT8                *PortNumber,\r
  OUT UINT8                *Is64BitCapable\r
  )\r
/*++\r
\r
  Routine Description:\r
\r
    Retrieves the capablility of root hub ports.\r
\r
  Arguments:\r
\r
    This            - A pointer to the EFI_USB_HC_PROTOCOL instance.\r
    MaxSpeed        - A pointer to the number of the host controller.\r
    PortNumber      - A pointer to the number of the root hub ports.\r
    Is64BitCapable  - A pointer to the flag for whether controller supports\r
                      64-bit memory addressing.\r
\r
  Returns:\r
\r
    EFI_SUCCESS            host controller capability were retrieved successfully.\r
    EFI_INVALID_PARAMETER  MaxSpeed or PortNumber or Is64BitCapable is NULL.\r
    EFI_DEVICE_ERROR       An error was encountered while attempting to retrieve the capabilities.\r
\r
--*/\r
{\r
  EFI_STATUS  Status;\r
  USB2_HC_DEV *HcDev;\r
  UINT32      HcStructParamsAddr;\r
  UINT32      HcStructParamsReg;\r
  UINT32      HcCapParamsAddr;\r
  UINT32      HcCapParamsReg;\r
\r
  if (MaxSpeed == NULL || PortNumber == NULL || Is64BitCapable == NULL) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  HcStructParamsAddr  = HCSPARAMS;\r
  HcCapParamsAddr     = HCCPARAMS;\r
  HcDev               = USB2_HC_DEV_FROM_THIS (This);\r
\r
  Status = ReadEhcCapabiltiyReg (\r
             HcDev,\r
             HcStructParamsAddr,\r
             &HcStructParamsReg\r
             );\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  Status = ReadEhcCapabiltiyReg (\r
             HcDev,\r
             HcCapParamsAddr,\r
             &HcCapParamsReg\r
             );\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  *MaxSpeed       = EFI_USB_SPEED_HIGH;\r
  *PortNumber     = (UINT8) (HcStructParamsReg & HCSP_NPORTS);\r
  *Is64BitCapable = (UINT8) (HcCapParamsReg & HCCP_64BIT);\r
\r
exit:\r
  return Status;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
EhciReset (\r
  IN EFI_USB2_HC_PROTOCOL *This,\r
  IN UINT16               Attributes\r
  )\r
/*++\r
\r
  Routine Description:\r
\r
    Provides software reset for the USB host controller.\r
\r
  Arguments:\r
\r
  This        - A pointer to the EFI_USB2_HC_PROTOCOL instance.\r
  Attributes  - A bit mask of the reset operation to perform.\r
                See below for a list of the supported bit mask values.\r
\r
  #define EFI_USB_HC_RESET_GLOBAL  0x0001\r
  #define EFI_USB_HC_RESET_HOST_CONTROLLER  0x0002\r
  #define EFI_USB_HC_RESET_GLOBAL_WITH_DEBUG  0x0004\r
  #define EFI_USB_HC_RESET_HOST_WITH_DEBUG  0x0008\r
\r
  EFI_USB_HC_RESET_GLOBAL\r
        If this bit is set, a global reset signal will be sent to the USB bus.\r
        This resets all of the USB bus logic, including the USB host\r
        controller hardware and all the devices attached on the USB bus.\r
  EFI_USB_HC_RESET_HOST_CONTROLLER\r
        If this bit is set, the USB host controller hardware will be reset.\r
        No reset signal will be sent to the USB bus.\r
  EFI_USB_HC_RESET_GLOBAL_WITH_DEBUG\r
        If this bit is set, a global reset signal will be sent to the USB bus.\r
        This resets all of the USB bus logic, including the USB host\r
        controller hardware and all the devices attached on the USB bus.\r
        If this is an EHCI controller and the debug port has configured, then\r
        this is will still reset the host controller.\r
  EFI_USB_HC_RESET_HOST_WITH_DEBUG\r
        If this bit is set, the USB host controller hardware will be reset.\r
        If this is an EHCI controller and the debug port has been configured,\r
        then this will still reset the host controller.\r
\r
  Returns:\r
\r
    EFI_SUCCESS\r
        The reset operation succeeded.\r
    EFI_INVALID_PARAMETER\r
        Attributes is not valid.\r
    EFI_UNSUPPOURTED\r
        The type of reset specified by Attributes is not currently supported by\r
        the host controller hardware.\r
    EFI_ACCESS_DENIED\r
        Reset operation is rejected due to the debug port being configured and\r
        active; only EFI_USB_HC_RESET_GLOBAL_WITH_DEBUG or\r
        EFI_USB_HC_RESET_HOST_WITH_DEBUG reset Atrributes can be used to\r
        perform reset operation for this host controller.\r
    EFI_DEVICE_ERROR\r
        An error was encountered while attempting to perform\r
        the reset operation.\r
\r
--*/\r
{\r
  EFI_STATUS        Status;\r
  USB2_HC_DEV       *HcDev;\r
  UINTN             FrameIndex;\r
  FRAME_LIST_ENTRY  *FrameEntryPtr;\r
\r
  HcDev = USB2_HC_DEV_FROM_THIS (This);\r
\r
  switch (Attributes) {\r
\r
  case EFI_USB_HC_RESET_GLOBAL:\r
\r
    //\r
    // Same behavior as Host Controller Reset\r
    //\r
\r
  case EFI_USB_HC_RESET_HOST_CONTROLLER:\r
  	\r
    //\r
    // Host Controller must be Halt when Reset it\r
    //\r
    if (IsEhcHalted (HcDev)) {\r
      Status = ResetEhc (HcDev);\r
      if (EFI_ERROR (Status)) {\r
        Status = EFI_DEVICE_ERROR;\r
        goto exit;\r
      }\r
      //\r
      // Set to zero by Host Controller when reset process completes\r
      //\r
      Status = WaitForEhcReset (HcDev, EHCI_GENERIC_TIMEOUT);\r
      if (EFI_ERROR (Status)) {\r
        Status = EFI_TIMEOUT;\r
        goto exit;\r
      }\r
    } else {\r
      Status = EFI_DEVICE_ERROR;\r
      goto exit;\r
    }\r
\r
    //\r
    // only asynchronous interrupt transfers are always alive on the bus, need to cleanup\r
    //\r
    CleanUpAllAsyncRequestTransfer (HcDev);\r
    Status = ClearEhcAllStatus (HcDev);\r
    if (EFI_ERROR (Status)) {\r
      Status = EFI_DEVICE_ERROR;\r
      goto exit;\r
    }\r
\r
    //\r
    // Set appropriate 4G Segment Selector\r
    //\r
    Status = SetCtrlDataStructSeg (HcDev);\r
    if (EFI_ERROR (Status)) {\r
      Status = EFI_DEVICE_ERROR;\r
      goto exit;\r
    }\r
\r
    //\r
    // Init Perodic List Base Addr and Frame List\r
    //\r
    Status = SetFrameListBaseAddr (\r
               HcDev,\r
               (UINT32)GET_0B_TO_31B (HcDev->PeriodicFrameListBuffer)\r
               );\r
    if (EFI_ERROR (Status)) {\r
      Status = EFI_DEVICE_ERROR;\r
      goto exit;\r
    }\r
    FrameEntryPtr = (FRAME_LIST_ENTRY *) HcDev->PeriodicFrameListBuffer;\r
    for (FrameIndex = 0; FrameIndex < HcDev->PeriodicFrameListLength; FrameIndex++) {\r
      FrameEntryPtr->LinkTerminate = TRUE;\r
      FrameEntryPtr++;\r
    }\r
\r
    //\r
    // Start the Host Controller\r
    //\r
    if (IsEhcHalted (HcDev)) {\r
      Status = StartScheduleExecution (HcDev);\r
      if (EFI_ERROR (Status)) {\r
        Status = EFI_DEVICE_ERROR;\r
        goto exit;\r
      }\r
    }\r
\r
    //\r
    // Set all ports routing to EHC\r
    //\r
    Status = SetPortRoutingEhc (HcDev);\r
    if (EFI_ERROR (Status)) {\r
      Status = EFI_DEVICE_ERROR;\r
      goto exit;\r
    }\r
    break;\r
\r
  case EFI_USB_HC_RESET_GLOBAL_WITH_DEBUG:\r
  	\r
    Status = EFI_UNSUPPORTED;\r
    break;\r
\r
  case EFI_USB_HC_RESET_HOST_WITH_DEBUG:\r
  	\r
    Status = EFI_UNSUPPORTED;\r
    break;\r
\r
  default:\r
    Status = EFI_INVALID_PARAMETER;\r
  }\r
\r
exit:\r
  return Status;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
EhciGetState (\r
  IN  EFI_USB2_HC_PROTOCOL *This,\r
  OUT EFI_USB_HC_STATE     *State\r
  )\r
/*++\r
\r
  Routine Description:\r
\r
    Retrieves current state of the USB host controller.\r
\r
  Arguments:\r
\r
    This      A pointer to the EFI_USB2_HC_PROTOCOL instance.\r
    State     A pointer to the EFI_USB_HC_STATE data structure that\r
              indicates current state of the USB host controller.\r
              Type EFI_USB_HC_STATE is defined below.\r
\r
    typedef enum {\r
      EfiUsbHcStateHalt,\r
      EfiUsbHcStateOperational,\r
      EfiUsbHcStateSuspend,\r
      EfiUsbHcStateMaximum\r
    } EFI_USB_HC_STATE;\r
\r
  Returns:\r
\r
    EFI_SUCCESS\r
            The state information of the host controller was returned in State.\r
    EFI_INVALID_PARAMETER\r
            State is NULL.\r
    EFI_DEVICE_ERROR\r
            An error was encountered while attempting to retrieve the\r
            host controller's current state.\r
--*/\r
{\r
  EFI_STATUS  Status;\r
  USB2_HC_DEV *HcDev;\r
  UINT32      UsbStatusAddr;\r
  UINT32      UsbStatusReg;\r
\r
  if (State == NULL) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  UsbStatusAddr = USBSTS;\r
  HcDev         = USB2_HC_DEV_FROM_THIS (This);\r
\r
  Status = ReadEhcOperationalReg (\r
             HcDev,\r
             UsbStatusAddr,\r
             &UsbStatusReg\r
             );\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  if (UsbStatusReg & USBSTS_HCH) {\r
    *State = EfiUsbHcStateHalt;\r
  } else {\r
    *State = EfiUsbHcStateOperational;\r
  }\r
\r
exit:\r
  return Status;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
EhciSetState (\r
  IN EFI_USB2_HC_PROTOCOL *This,\r
  IN EFI_USB_HC_STATE     State\r
  )\r
/*++\r
\r
  Routine Description:\r
\r
    Sets the USB host controller to a specific state.\r
\r
  Arguments:\r
\r
    This     - A pointer to the EFI_USB2_HC_PROTOCOL instance.\r
    State    - Indicates the state of the host controller that will be set.\r
\r
  Returns:\r
\r
    EFI_SUCCESS\r
          The USB host controller was successfully placed in the state\r
          specified by State.\r
    EFI_INVALID_PARAMETER\r
          State is invalid.\r
    EFI_DEVICE_ERROR\r
          Failed to set the state specified by State due to device error.\r
\r
--*/\r
{\r
  EFI_STATUS        Status;\r
  USB2_HC_DEV       *HcDev;\r
  UINT32            UsbCommandAddr;\r
  UINT32            UsbCommandReg;\r
  EFI_USB_HC_STATE  CurrentState;\r
\r
  UsbCommandAddr  = USBCMD;\r
  HcDev           = USB2_HC_DEV_FROM_THIS (This);\r
\r
  Status          = EhciGetState (This, &CurrentState);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  switch (State) {\r
\r
  case EfiUsbHcStateHalt:\r
\r
    if (EfiUsbHcStateHalt == CurrentState) {\r
      Status = EFI_SUCCESS;\r
      goto exit;\r
    } else if (EfiUsbHcStateOperational == CurrentState) {\r
      Status = ReadEhcOperationalReg (\r
                 HcDev,\r
                 UsbCommandAddr,\r
                 &UsbCommandReg\r
                 );\r
      if (EFI_ERROR (Status)) {\r
        Status = EFI_DEVICE_ERROR;\r
        goto exit;\r
      }\r
\r
      UsbCommandReg &= ~USBCMD_RS;\r
      Status = WriteEhcOperationalReg (\r
                 HcDev,\r
                 UsbCommandAddr,\r
                 UsbCommandReg\r
                 );\r
      if (EFI_ERROR (Status)) {\r
        Status = EFI_DEVICE_ERROR;\r
        goto exit;\r
      }\r
      //\r
      // Ensure the HC is in halt status after send the stop command\r
      //\r
      Status = WaitForEhcHalt (HcDev, EHCI_GENERIC_TIMEOUT);\r
      if (EFI_ERROR (Status)) {\r
        Status = EFI_TIMEOUT;\r
        goto exit;\r
      }\r
    }\r
    break;\r
\r
  case EfiUsbHcStateOperational:\r
  	\r
    if (IsEhcSysError (HcDev)) {\r
      Status = EFI_DEVICE_ERROR;\r
      goto exit;\r
    }\r
    if (EfiUsbHcStateOperational == CurrentState) {\r
      Status = EFI_SUCCESS;\r
      goto exit;\r
    } else if (EfiUsbHcStateHalt == CurrentState) {\r
      //\r
      // Set Host Controller Run\r
      //\r
      Status = ReadEhcOperationalReg (\r
                 HcDev,\r
                 UsbCommandAddr,\r
                 &UsbCommandReg\r
                 );\r
      if (EFI_ERROR (Status)) {\r
        return EFI_DEVICE_ERROR;\r
      }\r
\r
      UsbCommandReg |= USBCMD_RS;\r
      Status = WriteEhcOperationalReg (\r
                 HcDev,\r
                 UsbCommandAddr,\r
                 UsbCommandReg\r
                 );\r
      if (EFI_ERROR (Status)) {\r
        Status = EFI_DEVICE_ERROR;\r
        goto exit;\r
      }\r
    }\r
    break;\r
\r
  case EfiUsbHcStateSuspend:\r
  	\r
    Status = EFI_UNSUPPORTED;\r
    break;\r
\r
  default:\r
  	\r
    Status = EFI_INVALID_PARAMETER;\r
  }\r
\r
exit:\r
  return Status;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
EhciGetRootHubPortStatus (\r
  IN  EFI_USB2_HC_PROTOCOL *This,\r
  IN  UINT8                PortNumber,\r
  OUT EFI_USB_PORT_STATUS  *PortStatus\r
  )\r
/*++\r
\r
  Routine Description:\r
\r
    Retrieves the current status of a USB root hub port.\r
\r
  Arguments:\r
\r
    This        - A pointer to the EFI_USB2_HC_PROTOCOL.\r
    PortNumber  - Specifies the root hub port from which the status\r
                  is to be retrieved.  This value is zero-based. For example,\r
                  if a root hub has two ports, then the first port is numbered 0,\r
                  and the second port is numbered 1.\r
    PortStatus  - A pointer to the current port status bits and\r
                  port status change bits.\r
\r
  Returns:\r
\r
    EFI_SUCCESS           The status of the USB root hub port specified\r
                          by PortNumber was returned in PortStatus.\r
    EFI_INVALID_PARAMETER PortNumber is invalid.\r
    EFI_DEVICE_ERROR      Can't read register\r
\r
--*/\r
{\r
  EFI_STATUS  Status;\r
  USB2_HC_DEV *HcDev;\r
  UINT32      PortStatusControlAddr;\r
  UINT32      PortStatusControlReg;\r
  UINT8       MaxSpeed;\r
  UINT8       TotalPortNumber;\r
  UINT8       Is64BitCapable;\r
\r
  if (PortStatus == NULL) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  EhciGetCapability (\r
    This,\r
    &MaxSpeed,\r
    &TotalPortNumber,\r
    &Is64BitCapable\r
    );\r
\r
  if (PortNumber >= TotalPortNumber) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  HcDev                 = USB2_HC_DEV_FROM_THIS (This);\r
  PortStatusControlAddr = (UINT32) (PORTSC + (4 * PortNumber));\r
\r
  //\r
  // Clear port status\r
  //\r
  PortStatus->PortStatus        = 0;\r
  PortStatus->PortChangeStatus  = 0;\r
\r
  Status = ReadEhcOperationalReg (\r
             HcDev,\r
             PortStatusControlAddr,\r
             &PortStatusControlReg\r
             );\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  //\r
  //    Fill Port Status bits\r
  //\r
\r
  //\r
  // Current Connect Status\r
  //\r
  if (PORTSC_CCS & PortStatusControlReg) {\r
    PortStatus->PortStatus |= USB_PORT_STAT_CONNECTION;\r
  }\r
  //\r
  // Port Enabled/Disabled\r
  //\r
  if (PORTSC_PED & PortStatusControlReg) {\r
    PortStatus->PortStatus |= USB_PORT_STAT_ENABLE;\r
  }\r
  //\r
  // Port Suspend\r
  //\r
  if (PORTSC_SUSP & PortStatusControlReg) {\r
    PortStatus->PortStatus |= USB_PORT_STAT_SUSPEND;\r
  }\r
  //\r
  // Over-current Active\r
  //\r
  if (PORTSC_OCA & PortStatusControlReg) {\r
    PortStatus->PortStatus |= USB_PORT_STAT_OVERCURRENT;\r
  }\r
  //\r
  // Port Reset\r
  //\r
  if (PORTSC_PR & PortStatusControlReg) {\r
    PortStatus->PortStatus |= USB_PORT_STAT_RESET;\r
  }\r
  //\r
  // Port Power\r
  //\r
  if (PORTSC_PP & PortStatusControlReg) {\r
    PortStatus->PortStatus |= USB_PORT_STAT_POWER;\r
  }\r
  //\r
  // Port Owner\r
  //\r
  if (PORTSC_PO & PortStatusControlReg) {\r
    PortStatus->PortStatus |= USB_PORT_STAT_OWNER;\r
  }\r
  //\r
  // Identify device speed\r
  //\r
  if (PORTSC_LS_KSTATE & PortStatusControlReg) {\r
    //\r
    // Low Speed Device Attached\r
    //\r
    PortStatus->PortStatus |= USB_PORT_STAT_LOW_SPEED;\r
  } else {\r
    //\r
    // Not Low Speed Device Attached\r
    //\r
    if ((PORTSC_CCS & PortStatusControlReg) && (PORTSC_CSC & PortStatusControlReg)) {\r
      HcDev->DeviceSpeed[PortNumber] = (UINT16) (IsHighSpeedDevice (This, PortNumber) ? USB_PORT_STAT_HIGH_SPEED : 0);\r
    }\r
    PortStatus->PortStatus = (UINT16) (PortStatus->PortStatus | HcDev->DeviceSpeed[PortNumber]);\r
  }\r
  //\r
  // Fill Port Status Change bits\r
  //\r
  //\r
  // Connect Status Change\r
  //\r
  if (PORTSC_CSC & PortStatusControlReg) {\r
    PortStatus->PortChangeStatus |= USB_PORT_STAT_C_CONNECTION;\r
  }\r
  //\r
  // Port Enabled/Disabled Change\r
  //\r
  if (PORTSC_PEDC & PortStatusControlReg) {\r
    PortStatus->PortChangeStatus |= USB_PORT_STAT_C_ENABLE;\r
  }\r
  //\r
  // Port Over Current Change\r
  //\r
  if (PORTSC_OCC & PortStatusControlReg) {\r
    PortStatus->PortChangeStatus |= USB_PORT_STAT_C_OVERCURRENT;\r
  }\r
\r
exit:\r
  return Status;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
EhciSetRootHubPortFeature (\r
  IN  EFI_USB2_HC_PROTOCOL     *This,\r
  IN  UINT8                    PortNumber,\r
  IN  EFI_USB_PORT_FEATURE     PortFeature\r
  )\r
/*++\r
\r
  Routine Description:\r
\r
    Sets a feature for the specified root hub port.\r
\r
  Arguments:\r
\r
    This        - A pointer to the EFI_USB2_HC_PROTOCOL.\r
    PortNumber  - Specifies the root hub port whose feature\r
                  is requested to be set.\r
    PortFeature - Indicates the feature selector associated\r
                  with the feature set request.\r
\r
  Returns:\r
\r
    EFI_SUCCESS\r
        The feature specified by PortFeature was set for the\r
        USB root hub port specified by PortNumber.\r
    EFI_INVALID_PARAMETER\r
        PortNumber is invalid or PortFeature is invalid.\r
    EFI_DEVICE_ERROR\r
        Can't read register\r
\r
--*/\r
{\r
  EFI_STATUS  Status;\r
  USB2_HC_DEV *HcDev;\r
  UINT32      PortStatusControlAddr;\r
  UINT32      PortStatusControlReg;\r
  UINT8       MaxSpeed;\r
  UINT8       TotalPortNumber;\r
  UINT8       Is64BitCapable;\r
\r
  EhciGetCapability (\r
    This,\r
    &MaxSpeed,\r
    &TotalPortNumber,\r
    &Is64BitCapable\r
    );\r
\r
  if (PortNumber >= TotalPortNumber) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  HcDev                 = USB2_HC_DEV_FROM_THIS (This);\r
  PortStatusControlAddr = (UINT32) (PORTSC + (4 * PortNumber));\r
\r
  Status = ReadEhcOperationalReg (\r
             HcDev,\r
             PortStatusControlAddr,\r
             &PortStatusControlReg\r
             );\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  switch (PortFeature) {\r
\r
  case EfiUsbPortEnable:\r
\r
    //\r
    // Sofeware can't set this bit, Port can only be enable by the Host Controller\r
    // as a part of the reset and enable\r
    //\r
    PortStatusControlReg &= 0xffffffd5;\r
    PortStatusControlReg |= PORTSC_PED;\r
    break;\r
\r
  case EfiUsbPortSuspend:\r
\r
    PortStatusControlReg &= 0xffffffd5;\r
    PortStatusControlReg |= PORTSC_SUSP;\r
    break;\r
\r
  case EfiUsbPortReset:\r
\r
    //\r
    // Make sure Host Controller not halt before reset it\r
    //\r
    if (IsEhcHalted (HcDev)) {\r
      Status = StartScheduleExecution (HcDev);\r
      if (EFI_ERROR (Status)) {\r
        Status = EFI_DEVICE_ERROR;\r
        goto exit;\r
      }\r
      Status = WaitForEhcNotHalt (HcDev, EHCI_GENERIC_TIMEOUT);\r
      if (EFI_ERROR (Status)) {\r
        DEBUG ((gEHCDebugLevel, "EHCI: WaitForEhcNotHalt TimeOut\n"));\r
        Status = EFI_DEVICE_ERROR;\r
        goto exit;\r
      }\r
    }\r
    PortStatusControlReg &= 0xffffffd5;\r
    PortStatusControlReg |= PORTSC_PR;\r
    //\r
    // Set one to PortReset bit must also set zero to PortEnable bit\r
    //\r
    PortStatusControlReg &= ~PORTSC_PED;\r
    break;\r
\r
  case EfiUsbPortPower:\r
\r
    //\r
    // No support, no operation\r
    //\r
    goto exit;\r
\r
  case EfiUsbPortOwner:\r
\r
    PortStatusControlReg &= 0xffffffd5;\r
    PortStatusControlReg |= PORTSC_PO;\r
    break;\r
\r
  default:\r
  	\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  Status = WriteEhcOperationalReg (\r
             HcDev,\r
             PortStatusControlAddr,\r
             PortStatusControlReg\r
             );\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
  }\r
\r
exit:\r
  return Status;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
EhciClearRootHubPortFeature (\r
  IN  EFI_USB2_HC_PROTOCOL     *This,\r
  IN  UINT8                    PortNumber,\r
  IN  EFI_USB_PORT_FEATURE     PortFeature\r
  )\r
/*++\r
\r
  Routine Description:\r
\r
    Clears a feature for the specified root hub port.\r
\r
  Arguments:\r
\r
    This        - A pointer to the EFI_USB2_HC_PROTOCOL instance.\r
    PortNumber  - Specifies the root hub port whose feature\r
                  is requested to be cleared.\r
    PortFeature - Indicates the feature selector associated with the\r
                  feature clear request.\r
\r
  Returns:\r
\r
    EFI_SUCCESS\r
        The feature specified by PortFeature was cleared for the\r
        USB root hub port specified by PortNumber.\r
    EFI_INVALID_PARAMETER\r
        PortNumber is invalid or PortFeature is invalid.\r
    EFI_DEVICE_ERROR\r
        Can't read register\r
\r
--*/\r
{\r
  EFI_STATUS  Status;\r
  USB2_HC_DEV *HcDev;\r
  UINT32      PortStatusControlAddr;\r
  UINT32      PortStatusControlReg;\r
  UINT8       MaxSpeed;\r
  UINT8       TotalPortNumber;\r
  UINT8       Is64BitCapable;\r
\r
  EhciGetCapability (\r
    This,\r
    &MaxSpeed,\r
    &TotalPortNumber,\r
    &Is64BitCapable\r
    );\r
\r
  if (PortNumber >= TotalPortNumber) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  HcDev                 = USB2_HC_DEV_FROM_THIS (This);\r
  PortStatusControlAddr = (UINT32) (PORTSC + (4 * PortNumber));\r
\r
  Status = ReadEhcOperationalReg (\r
             HcDev,\r
             PortStatusControlAddr,\r
             &PortStatusControlReg\r
             );\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  switch (PortFeature) {\r
\r
  case EfiUsbPortEnable:\r
\r
    //\r
    // Clear PORT_ENABLE feature means disable port.\r
    //\r
    PortStatusControlReg &= 0xffffffd5;\r
    PortStatusControlReg &= ~PORTSC_PED;\r
    break;\r
\r
  case EfiUsbPortSuspend:\r
\r
    //\r
    // A write of zero to this bit is ignored by the host controller.\r
    // The host controller will unconditionally set this bit to a zero when:\r
    //   1. software sets the Forct Port Resume bit to a zero from a one.\r
    //   2. software sets the Port Reset bit to a one frome a zero.\r
    //\r
    PortStatusControlReg &= 0xffffffd5;\r
    PortStatusControlReg &= ~PORTSC_FPR;\r
    break;\r
\r
  case EfiUsbPortReset:\r
\r
    //\r
    // Clear PORT_RESET means clear the reset signal.\r
    //\r
    PortStatusControlReg &= 0xffffffd5;\r
    PortStatusControlReg &= ~PORTSC_PR;\r
    break;\r
\r
  case EfiUsbPortPower:\r
\r
    //\r
    // No support, no operation\r
    //\r
    goto exit;\r
\r
  case EfiUsbPortOwner:\r
\r
    //\r
    // Clear port owner means this port owned by EHC\r
    //\r
    PortStatusControlReg &= 0xffffffd5;\r
    PortStatusControlReg &= ~PORTSC_PO;\r
    break;\r
\r
  case EfiUsbPortConnectChange:\r
\r
    //\r
    // Clear connect status change\r
    //\r
    PortStatusControlReg &= 0xffffffd5;\r
    PortStatusControlReg |= PORTSC_CSC;\r
    break;\r
\r
  case EfiUsbPortEnableChange:\r
\r
    //\r
    // Clear enable status change\r
    //\r
    PortStatusControlReg &= 0xffffffd5;\r
    PortStatusControlReg |= PORTSC_PEDC;\r
    break;\r
\r
  case EfiUsbPortSuspendChange:\r
\r
    //\r
    // No related bit, no operation\r
    //\r
    goto exit;\r
\r
  case EfiUsbPortOverCurrentChange:\r
\r
    //\r
    // Clear PortOverCurrent change\r
    //\r
    PortStatusControlReg &= 0xffffffd5;\r
    PortStatusControlReg |= PORTSC_OCC;\r
    break;\r
\r
  case EfiUsbPortResetChange:\r
\r
    //\r
    // No related bit, no operation\r
    //\r
    goto exit;\r
\r
  default:\r
  	\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  Status = WriteEhcOperationalReg (\r
             HcDev,\r
             PortStatusControlAddr,\r
             PortStatusControlReg\r
             );\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
exit:\r
  return Status;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
EhciControlTransfer (\r
  IN  EFI_USB2_HC_PROTOCOL                 *This,\r
  IN  UINT8                                DeviceAddress,\r
  IN  UINT8                                DeviceSpeed,\r
  IN  UINTN                                MaximumPacketLength,\r
  IN  EFI_USB_DEVICE_REQUEST               *Request,\r
  IN  EFI_USB_DATA_DIRECTION               TransferDirection,\r
  IN  OUT VOID                             *Data,\r
  IN  OUT UINTN                            *DataLength,\r
  IN  UINTN                                TimeOut,\r
  IN  EFI_USB2_HC_TRANSACTION_TRANSLATOR   *Translator,\r
  OUT UINT32                               *TransferResult\r
  )\r
/*++\r
\r
  Routine Description:\r
\r
    Submits control transfer to a target USB device.\r
\r
  Arguments:\r
\r
    This            - A pointer to the EFI_USB2_HC_PROTOCOL instance.\r
    DeviceAddress   - Represents the address of the target device on the USB,\r
                      which is assigned during USB enumeration.\r
    DeviceSpeed     - Indicates target device speed.\r
    MaximumPacketLength - Indicates the maximum packet size that the\r
                         default control transfer endpoint is capable of\r
                         sending or receiving.\r
    Request         - A pointer to the USB device request that will be sent\r
                      to the USB device.\r
    TransferDirection - Specifies the data direction for the transfer.\r
                        There are three values available, DataIn, DataOut\r
                        and NoData.\r
    Data            - A pointer to the buffer of data that will be transmitted\r
                      to USB device or received from USB device.\r
    DataLength      - Indicates the size, in bytes, of the data buffer\r
                      specified by Data.\r
    TimeOut         - Indicates the maximum time, in microseconds,\r
                      which the transfer is allowed to complete.\r
    Translator      - A pointr to the transaction translator data.\r
    TransferResult  - A pointer to the detailed result information generated\r
                      by this control transfer.\r
\r
  Returns:\r
\r
    EFI_SUCCESS\r
        The control transfer was completed successfully.\r
    EFI_OUT_OF_RESOURCES\r
        The control transfer could not be completed due to a lack of resources.\r
    EFI_INVALID_PARAMETER\r
        Some parameters are invalid.\r
    EFI_TIMEOUT\r
        The control transfer failed due to timeout.\r
    EFI_DEVICE_ERROR\r
        The control transfer failed due to host controller or device error.\r
        Caller should check TranferResult for detailed error information.\r
\r
--*/\r
{\r
  EFI_STATUS      Status;\r
  USB2_HC_DEV     *HcDev;\r
  UINT8           PktId;\r
  EHCI_QH_ENTITY  *QhPtr;\r
  EHCI_QTD_ENTITY *ControlQtdsPtr;\r
  UINT8           *DataCursor;\r
  VOID            *DataMap;\r
  UINT8           *RequestCursor;\r
  VOID            *RequestMap;\r
\r
  QhPtr           = NULL;\r
  ControlQtdsPtr  = NULL;\r
  DataCursor      = NULL;\r
  DataMap         = NULL;\r
  RequestCursor   = NULL;\r
  RequestMap      = NULL;\r
  HcDev           = USB2_HC_DEV_FROM_THIS (This);\r
\r
  //\r
  // Parameters Checking\r
  //\r
  if (TransferDirection != EfiUsbDataIn &&\r
  	TransferDirection != EfiUsbDataOut &&\r
  	TransferDirection != EfiUsbNoData\r
  	) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  if (EfiUsbNoData == TransferDirection) {\r
    if (NULL != Data || 0 != *DataLength) {\r
      Status = EFI_INVALID_PARAMETER;\r
      goto exit;\r
    }\r
  } else {\r
    if (NULL == Data || 0 == *DataLength) {\r
      Status = EFI_INVALID_PARAMETER;\r
      goto exit;\r
    }\r
  }\r
\r
  if (Request == NULL || TransferResult == NULL) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  if (EFI_USB_SPEED_LOW == DeviceSpeed) {\r
    if (MaximumPacketLength != 8) {\r
      Status = EFI_INVALID_PARAMETER;\r
      goto exit;\r
    }\r
  } else if (MaximumPacketLength != 8 &&\r
           MaximumPacketLength != 16 &&\r
           MaximumPacketLength != 32 &&\r
           MaximumPacketLength != 64\r
          ) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  //\r
  // If errors exist that cause host controller halt,\r
  // then return EFI_DEVICE_ERROR.\r
  //\r
  if (IsEhcHalted (HcDev) || IsEhcSysError (HcDev)) {\r
    ClearEhcAllStatus (HcDev);\r
    *TransferResult = EFI_USB_ERR_SYSTEM;\r
    Status          = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  //\r
  // Map the Request for bus master access.\r
  // BusMasterRead means cpu write\r
  //\r
  Status = MapRequestBuffer (\r
             HcDev,\r
             Request,\r
             &RequestCursor,\r
             &RequestMap\r
             );\r
  if (EFI_ERROR (Status)) {\r
    *TransferResult = EFI_USB_ERR_SYSTEM;\r
    Status          = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  //\r
  // Map the source data buffer for bus master access.\r
  //\r
  Status = MapDataBuffer (\r
             HcDev,\r
             TransferDirection,\r
             Data,\r
             DataLength,\r
             &PktId,\r
             &DataCursor,\r
             &DataMap\r
             );\r
  if (EFI_ERROR (Status)) {\r
    *TransferResult = EFI_USB_ERR_SYSTEM;\r
    Status          = EFI_DEVICE_ERROR;\r
    goto unmap_request;\r
  }\r
\r
  //\r
  // Create and init control Qh\r
  //\r
  Status = CreateControlQh (\r
             HcDev,\r
             DeviceAddress,\r
             DeviceSpeed,\r
             MaximumPacketLength,\r
             Translator,\r
             &QhPtr\r
             );\r
  if (EFI_ERROR (Status)) {\r
    *TransferResult = EFI_USB_ERR_SYSTEM;\r
    Status          = EFI_OUT_OF_RESOURCES;\r
    goto unmap_data;\r
  }\r
\r
  //\r
  // Create and init control Qtds\r
  //\r
  Status = CreateControlQtds (\r
             HcDev,\r
             PktId,\r
             RequestCursor,\r
             DataCursor,\r
             *DataLength,\r
             Translator,\r
             &ControlQtdsPtr\r
             );\r
  if (EFI_ERROR (Status)) {\r
    *TransferResult = EFI_USB_ERR_SYSTEM;\r
    Status          = EFI_OUT_OF_RESOURCES;\r
    goto destory_qh;\r
  }\r
\r
  //\r
  // Link Qtds to Qh\r
  //\r
  LinkQtdToQh (QhPtr, ControlQtdsPtr);\r
\r
  ClearEhcAllStatus (HcDev);\r
\r
  //\r
  // Link Qh and Qtds to Async Schedule List\r
  //\r
  Status = LinkQhToAsyncList (HcDev, QhPtr);\r
  if (EFI_ERROR (Status)) {\r
    *TransferResult = EFI_USB_ERR_SYSTEM;\r
    Status          = EFI_DEVICE_ERROR;\r
    goto destory_qtds;\r
  }\r
\r
  //\r
  // Poll Qh-Qtds execution and get result.\r
  // detail status is returned\r
  //\r
  Status = ExecuteTransfer (\r
             HcDev,\r
             TRUE,\r
             QhPtr,\r
             DataLength,\r
             0,\r
             TimeOut,\r
             TransferResult\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto destory_qtds;\r
  }\r
\r
  //\r
  // If has errors that cause host controller halt,\r
  // then return EFI_DEVICE_ERROR directly.\r
  //\r
  if (IsEhcHalted (HcDev) || IsEhcSysError (HcDev)) {\r
    *TransferResult |= EFI_USB_ERR_SYSTEM;\r
  }\r
\r
  ClearEhcAllStatus (HcDev);\r
\r
destory_qtds:\r
  UnlinkQhFromAsyncList (HcDev, QhPtr);\r
  DestoryQtds (HcDev, ControlQtdsPtr);\r
destory_qh:\r
  DestoryQh (HcDev, QhPtr);\r
unmap_data:\r
  HcDev->PciIo->Unmap (HcDev->PciIo, DataMap);\r
unmap_request:\r
  HcDev->PciIo->Unmap (HcDev->PciIo, RequestMap);\r
exit:\r
  HcDev->PciIo->Flush (HcDev->PciIo);\r
  return Status;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
EhciBulkTransfer (\r
  IN  EFI_USB2_HC_PROTOCOL                *This,\r
  IN  UINT8                               DeviceAddress,\r
  IN  UINT8                               EndPointAddress,\r
  IN  UINT8                               DeviceSpeed,\r
  IN  UINTN                               MaximumPacketLength,\r
  IN  UINT8                               DataBuffersNumber,\r
  IN  OUT VOID                            *Data[EFI_USB_MAX_BULK_BUFFER_NUM],\r
  IN  OUT UINTN                           *DataLength,\r
  IN  OUT UINT8                           *DataToggle,\r
  IN  UINTN                               TimeOut,\r
  IN  EFI_USB2_HC_TRANSACTION_TRANSLATOR  *Translator,\r
  OUT UINT32                              *TransferResult\r
  )\r
/*++\r
\r
  Routine Description:\r
\r
    Submits bulk transfer to a bulk endpoint of a USB device.\r
\r
  Arguments:\r
\r
    This              - A pointer to the EFI_USB2_HC_PROTOCOL instance.\r
    DeviceAddress     - Represents the address of the target device on the USB,\r
                        which is assigned during USB enumeration.\r
    EndPointAddress   - The combination of an endpoint number and an\r
                        endpoint direction of the target USB device.\r
                        Each endpoint address supports data transfer in\r
                        one direction except the control endpoint\r
                        (whose default endpoint address is 0).\r
                        It is the caller's responsibility to make sure that\r
                        the EndPointAddress represents a bulk endpoint.\r
    DeviceSpeed       - Indicates device speed. The supported values are EFI_USB_SPEED_FULL\r
                        and EFI_USB_SPEED_HIGH.\r
    MaximumPacketLength - Indicates the maximum packet size the target endpoint\r
                          is capable of sending or receiving.\r
    DataBuffersNumber - Number of data buffers prepared for the transfer.\r
    Data              - Array of pointers to the buffers of data that will be transmitted\r
                        to USB device or received from USB device.\r
    DataLength        - When input, indicates the size, in bytes, of the data buffer\r
                        specified by Data. When output, indicates the actually\r
                        transferred data size.\r
    DataToggle        - A pointer to the data toggle value. On input, it indicates\r
                        the initial data toggle value the bulk transfer should adopt;\r
                        on output, it is updated to indicate the data toggle value\r
                        of the subsequent bulk transfer.\r
    Translator        - A pointr to the transaction translator data.\r
    TimeOut           - Indicates the maximum time, in microseconds, which the\r
                        transfer is allowed to complete.\r
    TransferResult    - A pointer to the detailed result information of the\r
                        bulk transfer.\r
\r
  Returns:\r
\r
    EFI_SUCCESS\r
        The bulk transfer was completed successfully.\r
    EFI_OUT_OF_RESOURCES\r
        The bulk transfer could not be submitted due to lack of resource.\r
    EFI_INVALID_PARAMETER\r
        Some parameters are invalid.\r
    EFI_TIMEOUT\r
        The bulk transfer failed due to timeout.\r
    EFI_DEVICE_ERROR\r
        The bulk transfer failed due to host controller or device error.\r
        Caller should check TranferResult for detailed error information.\r
\r
--*/\r
{\r
  EFI_STATUS              Status;\r
  USB2_HC_DEV             *HcDev;\r
  UINT8                   PktId;\r
  EHCI_QH_ENTITY          *QhPtr;\r
  EHCI_QTD_ENTITY         *BulkQtdsPtr;\r
  UINT8                   *DataCursor;\r
  VOID                    *DataMap;\r
  EFI_USB_DATA_DIRECTION  TransferDirection;\r
\r
  QhPtr       = NULL;\r
  BulkQtdsPtr = NULL;\r
  DataCursor  = NULL;\r
  DataMap     = NULL;\r
  HcDev       = USB2_HC_DEV_FROM_THIS (This);\r
\r
  //\r
  // Parameters Checking\r
  //\r
  if (NULL == DataLength ||\r
  	NULL == Data ||\r
  	NULL == Data[0] ||\r
  	NULL == TransferResult\r
  	) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  if (*DataLength == 0) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  if (1 != *DataToggle && 0 != *DataToggle) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  if (EFI_USB_SPEED_LOW == DeviceSpeed) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  if (EFI_USB_SPEED_FULL == DeviceSpeed) {\r
    if (MaximumPacketLength > 64) {\r
      Status = EFI_INVALID_PARAMETER;\r
      goto exit;\r
    }\r
  }\r
\r
  if (EFI_USB_SPEED_HIGH == DeviceSpeed) {\r
    if (MaximumPacketLength > 512) {\r
      Status = EFI_INVALID_PARAMETER;\r
      goto exit;\r
    }\r
  }\r
\r
  //\r
  // if has errors that cause host controller halt,\r
  // then return EFI_DEVICE_ERROR directly.\r
  //\r
  if (IsEhcHalted (HcDev) || IsEhcSysError (HcDev)) {\r
    ClearEhcAllStatus (HcDev);\r
    *TransferResult = EFI_USB_ERR_SYSTEM;\r
    Status          = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  Status = ClearEhcAllStatus (HcDev);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  //\r
  // construct QH and TD data structures,\r
  // and link them together\r
  //\r
  if (EndPointAddress & 0x80) {\r
    TransferDirection = EfiUsbDataIn;\r
  } else {\r
    TransferDirection = EfiUsbDataOut;\r
  }\r
\r
  Status = MapDataBuffer (\r
             HcDev,\r
             TransferDirection,\r
             Data[0],\r
             DataLength,\r
             &PktId,\r
             &DataCursor,\r
             &DataMap\r
             );\r
  if (EFI_ERROR (Status)) {\r
    *TransferResult = EFI_USB_ERR_SYSTEM;\r
    Status          = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  //\r
  // Create and init Bulk Qh\r
  //\r
  Status = CreateBulkQh (\r
             HcDev,\r
             DeviceAddress,\r
             EndPointAddress,\r
             DeviceSpeed,\r
             *DataToggle,\r
             MaximumPacketLength,\r
             Translator,\r
             &QhPtr\r
             );\r
  if (EFI_ERROR (Status)) {\r
    *TransferResult = EFI_USB_ERR_SYSTEM;\r
    Status          = EFI_OUT_OF_RESOURCES;\r
    goto unmap_data;\r
  }\r
\r
  //\r
  // Create and init Bulk Qtds\r
  //\r
  Status = CreateBulkOrInterruptQtds (\r
             HcDev,\r
             PktId,\r
             DataCursor,\r
             *DataLength,\r
             Translator,\r
             &BulkQtdsPtr\r
             );\r
  if (EFI_ERROR (Status)) {\r
    *TransferResult = EFI_USB_ERR_SYSTEM;\r
    Status          = EFI_OUT_OF_RESOURCES;\r
    goto destory_qh;\r
  }\r
\r
  //\r
  // Link Qtds to Qh\r
  //\r
  LinkQtdToQh (QhPtr, BulkQtdsPtr);\r
\r
  ClearEhcAllStatus (HcDev);\r
\r
  //\r
  // Link Qh and qtds to Async Schedule List\r
  //\r
  Status = LinkQhToAsyncList (HcDev, QhPtr);\r
  if (EFI_ERROR (Status)) {\r
    *TransferResult = EFI_USB_ERR_SYSTEM;\r
    Status          = EFI_DEVICE_ERROR;\r
    goto destory_qtds;\r
  }\r
\r
  //\r
  // Poll QH-TDs execution and get result.\r
  // detail status is returned\r
  //\r
  Status = ExecuteTransfer (\r
             HcDev,\r
             FALSE,\r
             QhPtr,\r
             DataLength,\r
             DataToggle,\r
             TimeOut,\r
             TransferResult\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto destory_qtds;\r
  }\r
\r
  //\r
  // if has errors that cause host controller halt,\r
  // then return EFI_DEVICE_ERROR directly.\r
  //\r
  if (IsEhcHalted (HcDev) || IsEhcSysError (HcDev)) {\r
    *TransferResult |= EFI_USB_ERR_SYSTEM;\r
  }\r
\r
  ClearEhcAllStatus (HcDev);\r
\r
destory_qtds:\r
  UnlinkQhFromAsyncList (HcDev, QhPtr);\r
  DestoryQtds (HcDev, BulkQtdsPtr);\r
destory_qh:\r
  DestoryQh (HcDev, QhPtr);\r
unmap_data:\r
  HcDev->PciIo->Unmap (HcDev->PciIo, DataMap);\r
exit:\r
  HcDev->PciIo->Flush (HcDev->PciIo);\r
  return Status;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
EhciAsyncInterruptTransfer (\r
  IN  EFI_USB2_HC_PROTOCOL                  * This,\r
  IN  UINT8                                 DeviceAddress,\r
  IN  UINT8                                 EndPointAddress,\r
  IN  UINT8                                 DeviceSpeed,\r
  IN  UINTN                                 MaximumPacketLength,\r
  IN  BOOLEAN                               IsNewTransfer,\r
  IN  OUT UINT8                             *DataToggle,\r
  IN  UINTN                                 PollingInterval,\r
  IN  UINTN                                 DataLength,\r
  IN  EFI_USB2_HC_TRANSACTION_TRANSLATOR    * Translator,\r
  IN  EFI_ASYNC_USB_TRANSFER_CALLBACK       CallBackFunction,\r
  IN  VOID                                  *Context OPTIONAL\r
  )\r
/*++\r
\r
  Routine Description:\r
\r
    Submits an asynchronous interrupt transfer to an\r
    interrupt endpoint of a USB device.\r
    Translator parameter doesn't exist in UEFI2.0 spec, but it will be updated\r
    in the following specification version.\r
\r
  Arguments:\r
\r
    This            - A pointer to the EFI_USB2_HC_PROTOCOL instance.\r
    DeviceAddress   - Represents the address of the target device on the USB,\r
                      which is assigned during USB enumeration.\r
    EndPointAddress - The combination of an endpoint number and an endpoint\r
                      direction of the target USB device. Each endpoint address\r
                      supports data transfer in one direction except the\r
                      control endpoint (whose default endpoint address is 0).\r
                      It is the caller's responsibility to make sure that\r
                      the EndPointAddress represents an interrupt endpoint.\r
    DeviceSpeed     - Indicates device speed.\r
    MaximumPacketLength  - Indicates the maximum packet size the target endpoint\r
                           is capable of sending or receiving.\r
    IsNewTransfer   - If TRUE, an asynchronous interrupt pipe is built between\r
                      the host and the target interrupt endpoint.\r
                      If FALSE, the specified asynchronous interrupt pipe\r
                      is canceled.\r
    DataToggle      - A pointer to the data toggle value.  On input, it is valid\r
                      when IsNewTransfer is TRUE, and it indicates the initial\r
                      data toggle value the asynchronous interrupt transfer\r
                      should adopt.\r
                      On output, it is valid when IsNewTransfer is FALSE,\r
                      and it is updated to indicate the data toggle value of\r
                      the subsequent asynchronous interrupt transfer.\r
    PollingInterval - Indicates the interval, in milliseconds, that the\r
                      asynchronous interrupt transfer is polled.\r
                      This parameter is required when IsNewTransfer is TRUE.\r
    DataLength      - Indicates the length of data to be received at the\r
                      rate specified by PollingInterval from the target\r
                      asynchronous interrupt endpoint.  This parameter\r
                      is only required when IsNewTransfer is TRUE.\r
    Translator      - A pointr to the transaction translator data.\r
    CallBackFunction  - The Callback function.This function is called at the\r
                        rate specified by PollingInterval.This parameter is\r
                        only required when IsNewTransfer is TRUE.\r
    Context         - The context that is passed to the CallBackFunction.\r
                    - This is an optional parameter and may be NULL.\r
\r
  Returns:\r
\r
    EFI_SUCCESS\r
        The asynchronous interrupt transfer request has been successfully\r
        submitted or canceled.\r
    EFI_INVALID_PARAMETER\r
        Some parameters are invalid.\r
    EFI_OUT_OF_RESOURCES\r
        The request could not be completed due to a lack of resources.\r
    EFI_DEVICE_ERROR\r
        Can't read register\r
\r
--*/\r
{\r
  EFI_STATUS          Status;\r
  USB2_HC_DEV         *HcDev;\r
  UINT8               PktId;\r
  EHCI_QH_ENTITY      *QhPtr;\r
  EHCI_QTD_ENTITY     *InterruptQtdsPtr;\r
  UINT8               *DataPtr;\r
  UINT8               *DataCursor;\r
  VOID                *DataMap;\r
  UINTN               MappedLength;\r
  EHCI_ASYNC_REQUEST  *AsyncRequestPtr;\r
  EFI_TPL             OldTpl;\r
\r
  QhPtr             = NULL;\r
  InterruptQtdsPtr  = NULL;\r
  DataPtr           = NULL;\r
  DataCursor        = NULL;\r
  DataMap           = NULL;\r
  AsyncRequestPtr   = NULL;\r
  HcDev             = USB2_HC_DEV_FROM_THIS (This);\r
\r
  //\r
  // Parameters Checking\r
  //\r
  if (!IsDataInTransfer (EndPointAddress)) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  if (IsNewTransfer) {\r
    if (0 == DataLength) {\r
      Status = EFI_INVALID_PARAMETER;\r
      goto exit;\r
    }\r
\r
    if (*DataToggle != 1 && *DataToggle != 0) {\r
      Status = EFI_INVALID_PARAMETER;\r
      goto exit;\r
    }\r
\r
    if (PollingInterval > 255 || PollingInterval < 1) {\r
      Status = EFI_INVALID_PARAMETER;\r
      goto exit;\r
    }\r
  }\r
\r
  //\r
  // if has errors that cause host controller halt,\r
  // then return EFI_DEVICE_ERROR directly.\r
  //\r
  if (IsEhcHalted (HcDev) || IsEhcSysError (HcDev)) {\r
    ClearEhcAllStatus (HcDev);\r
    Status = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  Status = ClearEhcAllStatus (HcDev);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  //\r
  // Delete Async interrupt transfer request\r
  //\r
  if (!IsNewTransfer) {\r
\r
    OldTpl = gBS->RaiseTPL (EFI_TPL_NOTIFY);\r
\r
    Status = DeleteAsyncRequestTransfer (\r
               HcDev,\r
               DeviceAddress,\r
               EndPointAddress,\r
               DataToggle\r
               );\r
\r
    gBS->RestoreTPL (OldTpl);\r
\r
    goto exit;\r
  }\r
\r
  Status = EhciAllocatePool (\r
  	         HcDev,\r
  	         (UINT8 **) &AsyncRequestPtr,\r
  	         sizeof (EHCI_ASYNC_REQUEST)\r
  	         );\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto exit;\r
  }\r
\r
  Status = EhciAllocatePool (HcDev, &DataPtr, DataLength);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto free_request;\r
  }\r
\r
  MappedLength = DataLength;\r
  Status = MapDataBuffer (\r
             HcDev,\r
             EfiUsbDataIn,\r
             DataPtr,\r
             &MappedLength,\r
             &PktId,\r
             &DataCursor,\r
             &DataMap\r
             );\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto free_data;\r
  }\r
\r
  //\r
  // Create and init Interrupt Qh\r
  //\r
  Status = CreateInterruptQh (\r
             HcDev,\r
             DeviceAddress,\r
             EndPointAddress,\r
             DeviceSpeed,\r
             *DataToggle,\r
             MaximumPacketLength,\r
             PollingInterval,\r
             Translator,\r
             &QhPtr\r
             );\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto unmap_data;\r
  }\r
\r
  //\r
  // Create and init Interrupt Qtds\r
  //\r
  Status = CreateBulkOrInterruptQtds (\r
             HcDev,\r
             PktId,\r
             DataCursor,\r
             MappedLength,\r
             Translator,\r
             &InterruptQtdsPtr\r
             );\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto destory_qh;\r
  }\r
\r
  //\r
  // Link Qtds to Qh\r
  //\r
  LinkQtdToQh (QhPtr, InterruptQtdsPtr);\r
\r
  //\r
  // Init AsyncRequest Entry\r
  //\r
  AsyncRequestPtr->Context      = Context;\r
  AsyncRequestPtr->CallBackFunc = CallBackFunction;\r
  AsyncRequestPtr->TransferType = ASYNC_INTERRUPT_TRANSFER;\r
  AsyncRequestPtr->QhPtr        = QhPtr;\r
  AsyncRequestPtr->Prev         = NULL;\r
  AsyncRequestPtr->Next         = NULL;\r
\r
  if (NULL == HcDev->AsyncRequestList) {\r
    Status = StartPollingTimer (HcDev);\r
    if (EFI_ERROR (Status)) {\r
      Status = EFI_DEVICE_ERROR;\r
      CleanUpAllAsyncRequestTransfer (HcDev);\r
      goto exit;\r
    }\r
  }\r
\r
  //\r
  // Link Entry to AsyncRequest List\r
  //\r
  LinkToAsyncReqeust (HcDev, AsyncRequestPtr);\r
\r
  ClearEhcAllStatus (HcDev);\r
\r
  Status = DisablePeriodicSchedule (HcDev);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  Status = WaitForPeriodicScheduleDisable (HcDev, EHCI_GENERIC_TIMEOUT);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_TIMEOUT;\r
    goto exit;\r
  }\r
\r
  //\r
  // Link Qh and Qtds to Periodic Schedule List\r
  //\r
  LinkQhToPeriodicList (HcDev, QhPtr);\r
\r
  Status = EnablePeriodicSchedule (HcDev);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  Status = WaitForPeriodicScheduleEnable (HcDev, EHCI_GENERIC_TIMEOUT);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_TIMEOUT;\r
    goto exit;\r
  }\r
\r
  if (IsEhcHalted (HcDev)) {\r
    Status = StartScheduleExecution (HcDev);\r
    if (EFI_ERROR (Status)) {\r
      Status = EFI_DEVICE_ERROR;\r
      goto exit;\r
    }\r
  }\r
\r
  HcDev->PciIo->Flush (HcDev->PciIo);\r
  goto exit;\r
\r
destory_qh:\r
  DestoryQh (HcDev, QhPtr);\r
free_data:\r
  EhciFreePool (HcDev, DataPtr, DataLength);\r
free_request:\r
  EhciFreePool (\r
  	HcDev,\r
  	(UINT8 *) AsyncRequestPtr,\r
  	sizeof (EHCI_ASYNC_REQUEST)\r
  	);\r
unmap_data:\r
  HcDev->PciIo->Unmap (HcDev->PciIo, DataMap);\r
exit:\r
  return Status;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
EhciSyncInterruptTransfer (\r
  IN  EFI_USB2_HC_PROTOCOL                  *This,\r
  IN  UINT8                                 DeviceAddress,\r
  IN  UINT8                                 EndPointAddress,\r
  IN  UINT8                                 DeviceSpeed,\r
  IN  UINTN                                 MaximumPacketLength,\r
  IN  OUT VOID                              *Data,\r
  IN  OUT UINTN                             *DataLength,\r
  IN  OUT UINT8                             *DataToggle,\r
  IN  UINTN                                 TimeOut,\r
  IN  EFI_USB2_HC_TRANSACTION_TRANSLATOR    *Translator,\r
  OUT UINT32                                *TransferResult\r
  )\r
/*++\r
\r
  Routine Description:\r
\r
    Submits synchronous interrupt transfer to an interrupt endpoint\r
    of a USB device.\r
    Translator parameter doesn't exist in UEFI2.0 spec, but it will be updated\r
    in the following specification version.\r
\r
  Arguments:\r
\r
    This            - A pointer to the EFI_USB2_HC_PROTOCOL instance.\r
    DeviceAddress   - Represents the address of the target device on the USB,\r
                      which is assigned during USB enumeration.\r
    EndPointAddress - The combination of an endpoint number and an endpoint\r
                      direction of the target USB device. Each endpoint\r
                      address supports data transfer in one direction\r
                      except the control endpoint (whose default\r
                      endpoint address is 0). It is the caller's responsibility\r
                      to make sure that the EndPointAddress represents\r
                      an interrupt endpoint.\r
    DeviceSpeed     - Indicates device speed.\r
    MaximumPacketLength - Indicates the maximum packet size the target endpoint\r
                          is capable of sending or receiving.\r
    Data            - A pointer to the buffer of data that will be transmitted\r
                      to USB device or received from USB device.\r
    DataLength      - On input, the size, in bytes, of the data buffer specified\r
                      by Data. On output, the number of bytes transferred.\r
    DataToggle      - A pointer to the data toggle value. On input, it indicates\r
                      the initial data toggle value the synchronous interrupt\r
                      transfer should adopt;\r
                      on output, it is updated to indicate the data toggle value\r
                      of the subsequent synchronous interrupt transfer.\r
    TimeOut         - Indicates the maximum time, in microseconds, which the\r
                      transfer is allowed to complete.\r
    Translator      - A pointr to the transaction translator data.\r
    TransferResult  - A pointer to the detailed result information from\r
                      the synchronous interrupt transfer.\r
\r
  Returns:\r
\r
    EFI_SUCCESS\r
        The synchronous interrupt transfer was completed successfully.\r
    EFI_OUT_OF_RESOURCES\r
        The synchronous interrupt transfer could not be submitted due\r
        to lack of resource.\r
    EFI_INVALID_PARAMETER\r
        Some parameters are invalid.\r
    EFI_TIMEOUT\r
        The synchronous interrupt transfer failed due to timeout.\r
    EFI_DEVICE_ERROR\r
        The synchronous interrupt transfer failed due to host controller\r
        or device error. Caller should check TranferResult for detailed\r
        error information.\r
\r
--*/\r
{\r
  EFI_STATUS      Status;\r
  USB2_HC_DEV     *HcDev;\r
  UINT8           PktId;\r
  EHCI_QH_ENTITY  *QhPtr;\r
  EHCI_QTD_ENTITY *InterruptQtdsPtr;\r
  UINT8           *DataCursor;\r
  VOID            *DataMap;\r
\r
  QhPtr             = NULL;\r
  InterruptQtdsPtr  = NULL;\r
  DataCursor        = NULL;\r
  DataMap           = NULL;\r
  HcDev             = USB2_HC_DEV_FROM_THIS (This);\r
\r
  //\r
  // Parameters Checking\r
  //\r
  if (DataLength == NULL ||\r
  	Data == NULL ||\r
  	TransferResult == NULL\r
  	) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  if (!IsDataInTransfer (EndPointAddress)) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  if (0 == *DataLength) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  if (*DataToggle != 1 && *DataToggle != 0) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  if (EFI_USB_SPEED_LOW == DeviceSpeed && 8 != MaximumPacketLength) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  if (EFI_USB_SPEED_FULL == DeviceSpeed && MaximumPacketLength > 64) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  if (EFI_USB_SPEED_HIGH == DeviceSpeed && MaximumPacketLength > 3072) {\r
    Status = EFI_INVALID_PARAMETER;\r
    goto exit;\r
  }\r
\r
  //\r
  // if has errors that cause host controller halt,\r
  // then return EFI_DEVICE_ERROR directly.\r
  //\r
  if (IsEhcHalted (HcDev) || IsEhcSysError (HcDev)) {\r
    ClearEhcAllStatus (HcDev);\r
    *TransferResult = EFI_USB_ERR_SYSTEM;\r
    Status          = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  Status = ClearEhcAllStatus (HcDev);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  Status = MapDataBuffer (\r
             HcDev,\r
             EfiUsbDataIn,\r
             Data,\r
             DataLength,\r
             &PktId,\r
             &DataCursor,\r
             &DataMap\r
             );\r
  if (EFI_ERROR (Status)) {\r
    *TransferResult = EFI_USB_ERR_SYSTEM;\r
    Status          = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  //\r
  // Create and init Interrupt Qh\r
  //\r
  Status = CreateInterruptQh (\r
             HcDev,\r
             DeviceAddress,\r
             EndPointAddress,\r
             DeviceSpeed,\r
             *DataToggle,\r
             MaximumPacketLength,\r
             0,\r
             Translator,\r
             &QhPtr\r
             );\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto unmap_data;\r
  }\r
\r
  //\r
  // Create and init Interrupt Qtds\r
  //\r
  Status = CreateBulkOrInterruptQtds (\r
             HcDev,\r
             PktId,\r
             DataCursor,\r
             *DataLength,\r
             Translator,\r
             &InterruptQtdsPtr\r
             );\r
  if (EFI_ERROR (Status)) {\r
    *TransferResult = EFI_USB_ERR_SYSTEM;\r
    Status          = EFI_OUT_OF_RESOURCES;\r
    goto destory_qh;\r
  }\r
\r
  //\r
  // Link Qtds to Qh\r
  //\r
  LinkQtdToQh (QhPtr, InterruptQtdsPtr);\r
\r
  ClearEhcAllStatus (HcDev);\r
\r
  Status = DisablePeriodicSchedule (HcDev);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  Status = WaitForPeriodicScheduleDisable (HcDev, EHCI_GENERIC_TIMEOUT);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_TIMEOUT;\r
    goto exit;\r
  }\r
\r
  //\r
  // Link Qh and Qtds to Periodic Schedule List\r
  //\r
  LinkQhToPeriodicList (HcDev, QhPtr);\r
\r
  Status = EnablePeriodicSchedule (HcDev);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_DEVICE_ERROR;\r
    goto exit;\r
  }\r
\r
  Status = WaitForPeriodicScheduleEnable (HcDev, EHCI_GENERIC_TIMEOUT);\r
  if (EFI_ERROR (Status)) {\r
    Status = EFI_TIMEOUT;\r
    goto exit;\r
  }\r
\r
  if (IsEhcHalted (HcDev)) {\r
    Status = StartScheduleExecution (HcDev);\r
    if (EFI_ERROR (Status)) {\r
      Status = EFI_DEVICE_ERROR;\r
      goto exit;\r
    }\r
  }\r
\r
  //\r
  // Poll QH-TDs execution and get result.\r
  // detail status is returned\r
  //\r
  Status = ExecuteTransfer (\r
             HcDev,\r
             FALSE,\r
             QhPtr,\r
             DataLength,\r
             DataToggle,\r
             TimeOut,\r
             TransferResult\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto destory_qtds;\r
  }\r
\r
  //\r
  // if has errors that cause host controller halt,\r
  // then return EFI_DEVICE_ERROR directly.\r
  //\r
  if (IsEhcHalted (HcDev) || IsEhcSysError (HcDev)) {\r
    *TransferResult |= EFI_USB_ERR_SYSTEM;\r
  }\r
\r
  ClearEhcAllStatus (HcDev);\r
\r
destory_qtds:\r
  UnlinkQhFromPeriodicList (HcDev, QhPtr, 0);\r
  DestoryQtds (HcDev, InterruptQtdsPtr);\r
destory_qh:\r
  DestoryQh (HcDev, QhPtr);\r
unmap_data:\r
  HcDev->PciIo->Unmap (HcDev->PciIo, DataMap);\r
exit:\r
  HcDev->PciIo->Flush (HcDev->PciIo);\r
  return Status;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
EhciIsochronousTransfer (\r
  IN  EFI_USB2_HC_PROTOCOL                  *This,\r
  IN  UINT8                                 DeviceAddress,\r
  IN  UINT8                                 EndPointAddress,\r
  IN  UINT8                                 DeviceSpeed,\r
  IN  UINTN                                 MaximumPacketLength,\r
  IN  UINT8                                 DataBuffersNumber,\r
  IN  OUT VOID                              *Data[EFI_USB_MAX_ISO_BUFFER_NUM],\r
  IN  UINTN                                 DataLength,\r
  IN  EFI_USB2_HC_TRANSACTION_TRANSLATOR    *Translator,\r
  OUT UINT32                                *TransferResult\r
  )\r
/*++\r
\r
  Routine Description:\r
\r
    Submits isochronous transfer to a target USB device.\r
\r
  Arguments:\r
\r
    This             - A pointer to the EFI_USB2_HC_PROTOCOL instance.\r
    DeviceAddress    - Represents the address of the target device on the USB,\r
                       which is assigned during USB enumeration.\r
    EndPointAddress  - End point address\r
    DeviceSpeed      - Indicates device speed.\r
    MaximumPacketLength    - Indicates the maximum packet size that the\r
                             default control transfer endpoint is capable of\r
                             sending or receiving.\r
    DataBuffersNumber - Number of data buffers prepared for the transfer.\r
    Data              - Array of pointers to the buffers of data that will be\r
                        transmitted to USB device or received from USB device.\r
    DataLength        - Indicates the size, in bytes, of the data buffer\r
                        specified by Data.\r
    Translator        - A pointr to the transaction translator data.\r
    TransferResult    - A pointer to the detailed result information generated\r
                        by this control transfer.\r
\r
  Returns:\r
\r
    EFI_UNSUPPORTED\r
\r
--*/\r
{\r
  return EFI_UNSUPPORTED;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
EhciAsyncIsochronousTransfer (\r
  IN  EFI_USB2_HC_PROTOCOL                *This,\r
  IN  UINT8                               DeviceAddress,\r
  IN  UINT8                               EndPointAddress,\r
  IN  UINT8                               DeviceSpeed,\r
  IN  UINTN                               MaximumPacketLength,\r
  IN  UINT8                               DataBuffersNumber,\r
  IN  OUT VOID                            *Data[EFI_USB_MAX_ISO_BUFFER_NUM],\r
  IN  UINTN                               DataLength,\r
  IN  EFI_USB2_HC_TRANSACTION_TRANSLATOR  *Translator,\r
  IN  EFI_ASYNC_USB_TRANSFER_CALLBACK     IsochronousCallBack,\r
  IN  VOID                                *Context\r
  )\r
/*++\r
\r
  Routine Description:\r
\r
    Submits Async isochronous transfer to a target USB device.\r
\r
  Arguments:\r
\r
    This                - A pointer to the EFI_USB2_HC_PROTOCOL instance.\r
    DeviceAddress       - Represents the address of the target device on the USB,\r
                          which is assigned during USB enumeration.\r
    EndPointAddress     - End point address\r
    DeviceSpeed         - Indicates device speed.\r
    MaximumPacketLength - Indicates the maximum packet size that the\r
                          default control transfer endpoint is capable of\r
                          sending or receiving.\r
    DataBuffersNumber   - Number of data buffers prepared for the transfer.\r
    Data                - Array of pointers to the buffers of data that will be transmitted\r
                          to USB device or received from USB device.\r
    Translator          - A pointr to the transaction translator data.\r
    IsochronousCallBack - When the transfer complete, the call back function will be called\r
    Context             - Pass to the call back function as parameter\r
\r
  Returns:\r
\r
    EFI_UNSUPPORTED\r
\r
--*/\r
{\r
  return EFI_UNSUPPORTED;\r
}\r