[mirror_edk2.git] / QuarkSocPkg / QuarkSouthCluster / Usb / Ohci / Pei / OhcPeim.c

/** @file\r
This file contains the implementation of Usb Hc Protocol.\r
\r
Copyright (c) 2013-2015 Intel Corporation.\r
\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
\r
#include "OhcPeim.h"\r
\r
/**\r
  Submits control transfer to a target USB device.\r
\r
  @param  PeiServices            The pointer of EFI_PEI_SERVICES.\r
  @param  This                   The pointer of PEI_USB_HOST_CONTROLLER_PPI.\r
  @param  DeviceAddress          The target device address.\r
  @param  DeviceSpeed            Target device speed.\r
  @param  MaximumPacketLength    Maximum packet size the default control transfer\r
                                 endpoint is capable of sending or receiving.\r
  @param  Request                USB device request to send.\r
  @param  TransferDirection      Specifies the data direction for the data stage.\r
  @param  Data                   Data buffer to be transmitted or received from USB device.\r
  @param  DataLength             The size (in bytes) of the data buffer.\r
  @param  TimeOut                Indicates the maximum timeout, in millisecond.\r
  @param  TransferResult         Return the result of this control transfer.\r
\r
  @retval EFI_SUCCESS            Transfer was completed successfully.\r
  @retval EFI_OUT_OF_RESOURCES   The transfer failed due to lack of resources.\r
  @retval EFI_INVALID_PARAMETER  Some parameters are invalid.\r
  @retval EFI_TIMEOUT            Transfer failed due to timeout.\r
  @retval EFI_DEVICE_ERROR       Transfer failed due to host controller or device error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
OhciControlTransfer (\r
  IN  EFI_PEI_SERVICES             **PeiServices,\r
  IN  PEI_USB_HOST_CONTROLLER_PPI  *This,\r
  IN  UINT8                        DeviceAddress,\r
  IN  UINT8                        DeviceSpeed,\r
  IN  UINT8                        MaxPacketLength,\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
  OUT UINT32                       *TransferResult\r
  )\r
{\r
  USB_OHCI_HC_DEV               *Ohc;\r
  ED_DESCRIPTOR                 *Ed;\r
  TD_DESCRIPTOR                 *HeadTd;\r
  TD_DESCRIPTOR                 *SetupTd;\r
  TD_DESCRIPTOR                 *DataTd;\r
  TD_DESCRIPTOR                 *StatusTd;\r
  TD_DESCRIPTOR                 *EmptyTd;\r
  EFI_STATUS                    Status;\r
  UINT32                        DataPidDir;\r
  UINT32                        StatusPidDir;\r
  UINTN                         TimeCount;\r
  UINT32                        ErrorCode;\r
\r
  UINTN                         ActualSendLength;\r
  UINTN                         LeftLength;\r
  UINT8                         DataToggle;\r
\r
  EFI_PHYSICAL_ADDRESS          ReqMapPhyAddr = 0;\r
\r
  UINTN                         DataMapLength = 0;\r
  EFI_PHYSICAL_ADDRESS          DataMapPhyAddr = 0;\r
\r
  HeadTd = NULL;\r
  DataTd = NULL;\r
\r
  if ((TransferDirection != EfiUsbDataOut && TransferDirection != EfiUsbDataIn &&\r
       TransferDirection != EfiUsbNoData) ||\r
      Request == NULL || DataLength == NULL || TransferResult == NULL ||\r
      (TransferDirection == EfiUsbNoData && (*DataLength != 0 || Data != NULL)) ||\r
      (TransferDirection != EfiUsbNoData && (*DataLength == 0 || Data == NULL)) ||\r
      (DeviceSpeed != EFI_USB_SPEED_LOW && DeviceSpeed != EFI_USB_SPEED_FULL) ||\r
      (MaxPacketLength != 8 && MaxPacketLength != 16 &&\r
       MaxPacketLength != 32 && MaxPacketLength != 64)) {\r
    DEBUG ((EFI_D_INFO, "OhciControlTransfer: EFI_INVALID_PARAMETER\n"));\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (*DataLength > MAX_BYTES_PER_TD) {\r
    DEBUG ((EFI_D_ERROR, "OhciControlTransfer: Request data size is too large\n"));\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Ohc = PEI_RECOVERY_USB_OHC_DEV_FROM_EHCI_THIS(This);\r
\r
  if (TransferDirection == EfiUsbDataIn) {\r
    DataPidDir = TD_IN_PID;\r
    StatusPidDir = TD_OUT_PID;\r
  } else {\r
    DataPidDir = TD_OUT_PID;\r
    StatusPidDir = TD_IN_PID;\r
  }\r
\r
  OhciSetHcControl (Ohc, CONTROL_ENABLE, 0);\r
  if (OhciGetHcControl (Ohc, CONTROL_ENABLE) != 0) {\r
    MicroSecondDelay (HC_1_MILLISECOND);\r
    if (OhciGetHcControl (Ohc, CONTROL_ENABLE) != 0) {\r
      *TransferResult = EFI_USB_ERR_SYSTEM;\r
      DEBUG ((EFI_D_INFO, "OhciControlTransfer: Fail to disable CONTROL transfer\n"));\r
      return EFI_DEVICE_ERROR;\r
    }\r
  }\r
  OhciSetMemoryPointer (Ohc, HC_CONTROL_HEAD, NULL);\r
  Ed = OhciCreateED (Ohc);\r
  if (Ed == NULL) {\r
    DEBUG ((EFI_D_INFO, "OhciControlTransfer: Fail to allocate ED buffer\n"));\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  OhciSetEDField (Ed, ED_SKIP, 1);\r
  OhciSetEDField (Ed, ED_FUNC_ADD, DeviceAddress);\r
  OhciSetEDField (Ed, ED_ENDPT_NUM, 0);\r
  OhciSetEDField (Ed, ED_DIR, ED_FROM_TD_DIR);\r
  OhciSetEDField (Ed, ED_SPEED, DeviceSpeed);\r
  OhciSetEDField (Ed, ED_FORMAT | ED_HALTED | ED_DTTOGGLE, 0);\r
  OhciSetEDField (Ed, ED_MAX_PACKET, MaxPacketLength);\r
  OhciSetEDField (Ed, ED_PDATA, 0);\r
  OhciSetEDField (Ed, ED_ZERO, 0);\r
  OhciSetEDField (Ed, ED_TDHEAD_PTR, (UINT32) NULL);\r
  OhciSetEDField (Ed, ED_TDTAIL_PTR, (UINT32) NULL);\r
  OhciSetEDField (Ed, ED_NEXT_EDPTR, (UINT32) NULL);\r
  OhciAttachEDToList (Ohc, CONTROL_LIST, Ed, NULL);\r
  //\r
  // Setup Stage\r
  //\r
  if(Request != NULL) {\r
    ReqMapPhyAddr = (EFI_PHYSICAL_ADDRESS)(UINTN)Request;\r
  }\r
  SetupTd = OhciCreateTD (Ohc);\r
  if (SetupTd == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    DEBUG ((EFI_D_INFO, "OhciControlTransfer: Fail to allocate Setup TD buffer\n"));\r
    goto FREE_ED_BUFF;\r
  }\r
  HeadTd = SetupTd;\r
  OhciSetTDField (SetupTd, TD_PDATA, 0);\r
  OhciSetTDField (SetupTd, TD_BUFFER_ROUND, 1);\r
  OhciSetTDField (SetupTd, TD_DIR_PID, TD_SETUP_PID);\r
  OhciSetTDField (SetupTd, TD_DELAY_INT, TD_NO_DELAY);\r
  OhciSetTDField (SetupTd, TD_DT_TOGGLE, 2);\r
  OhciSetTDField (SetupTd, TD_ERROR_CNT, 0);\r
  OhciSetTDField (SetupTd, TD_COND_CODE, TD_TOBE_PROCESSED);\r
  OhciSetTDField (SetupTd, TD_CURR_BUFFER_PTR, (UINTN)ReqMapPhyAddr);\r
  OhciSetTDField (SetupTd, TD_NEXT_PTR, (UINT32) NULL);\r
  OhciSetTDField (SetupTd, TD_BUFFER_END_PTR, (UINTN)ReqMapPhyAddr + sizeof (EFI_USB_DEVICE_REQUEST) - 1);\r
  SetupTd->ActualSendLength = 0;\r
  SetupTd->DataBuffer = NULL;\r
  SetupTd->NextTDPointer = NULL;\r
\r
  DataMapLength = *DataLength;\r
  if ((Data != NULL) && (DataMapLength != 0)) {\r
    DataMapPhyAddr = (EFI_PHYSICAL_ADDRESS)(UINTN)Data;\r
  }\r
  //\r
  //Data Stage\r
  //\r
  LeftLength = DataMapLength;\r
  ActualSendLength = DataMapLength;\r
  DataToggle = 1;\r
  while (LeftLength > 0) {\r
    ActualSendLength = LeftLength;\r
    if (LeftLength > MaxPacketLength) {\r
      ActualSendLength = MaxPacketLength;\r
    }\r
    DataTd = OhciCreateTD (Ohc);\r
    if (DataTd == NULL) {\r
      DEBUG ((EFI_D_INFO, "OhciControlTransfer: Fail to allocate Data TD buffer\n"));\r
      Status = EFI_OUT_OF_RESOURCES;\r
      goto FREE_TD_BUFF;\r
    }\r
    OhciSetTDField (DataTd, TD_PDATA, 0);\r
    OhciSetTDField (DataTd, TD_BUFFER_ROUND, 1);\r
    OhciSetTDField (DataTd, TD_DIR_PID, DataPidDir);\r
    OhciSetTDField (DataTd, TD_DELAY_INT, TD_NO_DELAY);\r
    OhciSetTDField (DataTd, TD_DT_TOGGLE, DataToggle);\r
    OhciSetTDField (DataTd, TD_ERROR_CNT, 0);\r
    OhciSetTDField (DataTd, TD_COND_CODE, TD_TOBE_PROCESSED);\r
    OhciSetTDField (DataTd, TD_CURR_BUFFER_PTR, (UINT32) DataMapPhyAddr);\r
    OhciSetTDField (DataTd, TD_BUFFER_END_PTR, (UINT32) DataMapPhyAddr + ActualSendLength - 1);\r
    OhciSetTDField (DataTd, TD_NEXT_PTR, (UINT32) NULL);\r
    DataTd->ActualSendLength = ActualSendLength;\r
    DataTd->DataBuffer = (UINT8 *)(UINTN)DataMapPhyAddr;\r
    DataTd->NextTDPointer = 0;\r
    OhciLinkTD (HeadTd, DataTd);\r
    DataToggle ^= 1;\r
    DataMapPhyAddr += ActualSendLength;\r
    LeftLength -= ActualSendLength;\r
  }\r
  //\r
  // Status Stage\r
  //\r
  StatusTd = OhciCreateTD (Ohc);\r
  if (StatusTd == NULL) {\r
    DEBUG ((EFI_D_INFO, "OhciControlTransfer: Fail to allocate Status TD buffer\n"));\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto FREE_TD_BUFF;\r
  }\r
  OhciSetTDField (StatusTd, TD_PDATA, 0);\r
  OhciSetTDField (StatusTd, TD_BUFFER_ROUND, 1);\r
  OhciSetTDField (StatusTd, TD_DIR_PID, StatusPidDir);\r
  OhciSetTDField (StatusTd, TD_DELAY_INT, 7);\r
  OhciSetTDField (StatusTd, TD_DT_TOGGLE, 3);\r
  OhciSetTDField (StatusTd, TD_ERROR_CNT, 0);\r
  OhciSetTDField (StatusTd, TD_COND_CODE, TD_TOBE_PROCESSED);\r
  OhciSetTDField (StatusTd, TD_CURR_BUFFER_PTR, (UINT32) NULL);\r
  OhciSetTDField (StatusTd, TD_NEXT_PTR, (UINT32) NULL);\r
  OhciSetTDField (StatusTd, TD_BUFFER_END_PTR, (UINT32) NULL);\r
  StatusTd->ActualSendLength = 0;\r
  StatusTd->DataBuffer = NULL;\r
  StatusTd->NextTDPointer = NULL;\r
  OhciLinkTD (HeadTd, StatusTd);\r
  //\r
  // Empty Stage\r
  //\r
  EmptyTd = OhciCreateTD (Ohc);\r
  if (EmptyTd == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    DEBUG ((EFI_D_INFO, "OhciControlTransfer: Fail to allocate Empty TD buffer\n"));\r
    goto FREE_TD_BUFF;\r
  }\r
  OhciSetTDField (EmptyTd, TD_PDATA, 0);\r
  OhciSetTDField (EmptyTd, TD_BUFFER_ROUND, 0);\r
  OhciSetTDField (EmptyTd, TD_DIR_PID, 0);\r
  OhciSetTDField (EmptyTd, TD_DELAY_INT, 0);\r
  //OhciSetTDField (EmptyTd, TD_DT_TOGGLE, CurrentToggle);\r
  EmptyTd->Word0.DataToggle = 0;\r
  OhciSetTDField (EmptyTd, TD_ERROR_CNT, 0);\r
  OhciSetTDField (EmptyTd, TD_COND_CODE, 0);\r
  OhciSetTDField (EmptyTd, TD_CURR_BUFFER_PTR, 0);\r
  OhciSetTDField (EmptyTd, TD_BUFFER_END_PTR, 0);\r
  OhciSetTDField (EmptyTd, TD_NEXT_PTR, 0);\r
  EmptyTd->ActualSendLength = 0;\r
  EmptyTd->DataBuffer = NULL;\r
  EmptyTd->NextTDPointer = NULL;\r
  OhciLinkTD (HeadTd, EmptyTd);\r
  Ed->TdTailPointer = EmptyTd;\r
  OhciAttachTDListToED (Ed, HeadTd);\r
  //\r
  OhciSetEDField (Ed, ED_SKIP, 0);\r
  MicroSecondDelay (20 * HC_1_MILLISECOND);\r
  OhciSetHcCommandStatus (Ohc, CONTROL_LIST_FILLED, 1);\r
  OhciSetHcControl (Ohc, CONTROL_ENABLE, 1);\r
  MicroSecondDelay (20 * HC_1_MILLISECOND);\r
  if (OhciGetHcControl (Ohc, CONTROL_ENABLE) != 1) {\r
  MicroSecondDelay (HC_1_MILLISECOND);\r
    if (OhciGetHcControl (Ohc, CONTROL_ENABLE) != 1) {\r
      *TransferResult = EFI_USB_ERR_SYSTEM;\r
      Status = EFI_DEVICE_ERROR;\r
      DEBUG ((EFI_D_INFO, "OhciControlTransfer: Fail to enable CONTROL transfer\n"));\r
      goto FREE_TD_BUFF;\r
    }\r
  }\r
\r
  TimeCount = 0;\r
  Status = CheckIfDone (Ohc, CONTROL_LIST, Ed, HeadTd, &ErrorCode);\r
\r
  while (Status == EFI_NOT_READY && TimeCount <= TimeOut) {\r
    MicroSecondDelay (HC_1_MILLISECOND);\r
    TimeCount++;\r
    Status = CheckIfDone (Ohc, CONTROL_LIST, Ed, HeadTd, &ErrorCode);\r
  }\r
  //\r
  *TransferResult = ConvertErrorCode (ErrorCode);\r
\r
  if (ErrorCode != TD_NO_ERROR) {\r
    if (ErrorCode == TD_TOBE_PROCESSED) {\r
      DEBUG ((EFI_D_INFO, "Control pipe timeout, > %d mS\r\n", TimeOut));\r
    } else {\r
      DEBUG ((EFI_D_INFO, "Control pipe broken\r\n"));\r
    }\r
\r
    *DataLength = 0;\r
  }\r
\r
  OhciSetHcControl (Ohc, CONTROL_ENABLE, 0);\r
  if (OhciGetHcControl (Ohc, CONTROL_ENABLE) != 0) {\r
  MicroSecondDelay (HC_1_MILLISECOND);\r
    if (OhciGetHcControl (Ohc, CONTROL_ENABLE) != 0) {\r
      *TransferResult = EFI_USB_ERR_SYSTEM;\r
      DEBUG ((EFI_D_INFO, "OhciControlTransfer: Cannot disable CONTROL_ENABLE transfer\n"));\r
      goto FREE_TD_BUFF;\r
    }\r
  }\r
\r
FREE_TD_BUFF:\r
  while (HeadTd) {\r
    DataTd = HeadTd;\r
    HeadTd = HeadTd->NextTDPointer;\r
    UsbHcFreeMem(Ohc->MemPool, DataTd, sizeof(TD_DESCRIPTOR));\r
  }\r
\r
FREE_ED_BUFF:\r
  UsbHcFreeMem(Ohc->MemPool, Ed, sizeof(ED_DESCRIPTOR));\r
\r
  return Status;\r
}\r
\r
/**\r
  Submits bulk transfer to a bulk endpoint of a USB device.\r
\r
  @param  PeiServices           The pointer of EFI_PEI_SERVICES.\r
  @param  This                  The pointer of PEI_USB_HOST_CONTROLLER_PPI.\r
  @param  DeviceAddress         Target device address.\r
  @param  EndPointAddress       Endpoint number and its direction in bit 7.\r
  @param  MaxiPacketLength      Maximum packet size the endpoint is capable of\r
                                sending or receiving.\r
  @param  Data                  A pointers to the buffers of data to transmit\r
                                from or receive into.\r
  @param  DataLength            The lenght of the data buffer.\r
  @param  DataToggle            On input, the initial data toggle for the transfer;\r
                                On output, it is updated to to next data toggle to use of\r
                                the subsequent bulk transfer.\r
  @param  TimeOut               Indicates the maximum time, in millisecond, which the\r
                                transfer is allowed to complete.\r
  @param  TransferResult        A pointer to the detailed result information of the\r
                                bulk transfer.\r
\r
  @retval EFI_SUCCESS           The transfer was completed successfully.\r
  @retval EFI_OUT_OF_RESOURCES  The transfer failed due to lack of resource.\r
  @retval EFI_INVALID_PARAMETER Parameters are invalid.\r
  @retval EFI_TIMEOUT           The transfer failed due to timeout.\r
  @retval EFI_DEVICE_ERROR      The transfer failed due to host controller error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
OhciBulkTransfer (\r
  IN EFI_PEI_SERVICES             **PeiServices,\r
  IN PEI_USB_HOST_CONTROLLER_PPI  *This,\r
  IN  UINT8                       DeviceAddress,\r
  IN  UINT8                       EndPointAddress,\r
  IN  UINT8                       MaxPacketLength,\r
  IN  OUT VOID                    *Data,\r
  IN  OUT UINTN                   *DataLength,\r
  IN  OUT UINT8                   *DataToggle,\r
  IN  UINTN                       TimeOut,\r
  OUT UINT32                      *TransferResult\r
  )\r
{\r
  USB_OHCI_HC_DEV                *Ohc;\r
  ED_DESCRIPTOR                  *Ed;\r
  UINT32                         DataPidDir;\r
  TD_DESCRIPTOR                  *HeadTd;\r
  TD_DESCRIPTOR                  *DataTd;\r
  TD_DESCRIPTOR                  *EmptyTd;\r
  EFI_STATUS                     Status;\r
  UINT8                          EndPointNum;\r
  UINTN                          TimeCount;\r
  UINT32                         ErrorCode;\r
\r
  UINT8                          CurrentToggle;\r
  UINTN                          MapLength;\r
  EFI_PHYSICAL_ADDRESS           MapPyhAddr;\r
  UINTN                          LeftLength;\r
  UINTN                          ActualSendLength;\r
  BOOLEAN                        FirstTD;\r
\r
  MapLength = 0;\r
  MapPyhAddr = 0;\r
  LeftLength = 0;\r
  Status = EFI_SUCCESS;\r
\r
  if (Data == NULL || DataLength == NULL || DataToggle == NULL || TransferResult == NULL ||\r
      *DataLength == 0 || (*DataToggle != 0 && *DataToggle != 1) ||\r
      (MaxPacketLength != 8 && MaxPacketLength != 16 &&\r
       MaxPacketLength != 32 && MaxPacketLength != 64)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Ohc = PEI_RECOVERY_USB_OHC_DEV_FROM_EHCI_THIS (This);\r
\r
  if ((EndPointAddress & 0x80) != 0) {\r
    DataPidDir = TD_IN_PID;\r
  } else {\r
    DataPidDir = TD_OUT_PID;\r
  }\r
\r
  EndPointNum = (EndPointAddress & 0xF);\r
\r
  OhciSetHcControl (Ohc, BULK_ENABLE, 0);\r
  if (OhciGetHcControl (Ohc, BULK_ENABLE) != 0) {\r
    MicroSecondDelay (HC_1_MILLISECOND);\r
    if (OhciGetHcControl (Ohc, BULK_ENABLE) != 0) {\r
      *TransferResult = EFI_USB_ERR_SYSTEM;\r
      return EFI_DEVICE_ERROR;\r
    }\r
  }\r
\r
  OhciSetMemoryPointer (Ohc, HC_BULK_HEAD, NULL);\r
\r
  Ed = OhciCreateED (Ohc);\r
  if (Ed == NULL) {\r
    DEBUG ((EFI_D_INFO, "OhcBulkTransfer: Fail to allocate ED buffer\r\n"));\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  OhciSetEDField (Ed, ED_SKIP, 1);\r
  OhciSetEDField (Ed, ED_FUNC_ADD, DeviceAddress);\r
  OhciSetEDField (Ed, ED_ENDPT_NUM, EndPointNum);\r
  OhciSetEDField (Ed, ED_DIR, ED_FROM_TD_DIR);\r
  OhciSetEDField (Ed, ED_SPEED, HI_SPEED);\r
  OhciSetEDField (Ed, ED_FORMAT | ED_HALTED | ED_DTTOGGLE, 0);\r
  OhciSetEDField (Ed, ED_MAX_PACKET, MaxPacketLength);\r
  OhciSetEDField (Ed, ED_PDATA, 0);\r
  OhciSetEDField (Ed, ED_ZERO, 0);\r
  OhciSetEDField (Ed, ED_TDHEAD_PTR, (UINT32) NULL);\r
  OhciSetEDField (Ed, ED_TDTAIL_PTR, (UINT32) NULL);\r
  OhciSetEDField (Ed, ED_NEXT_EDPTR, (UINT32) NULL);\r
  OhciAttachEDToList (Ohc, BULK_LIST, Ed, NULL);\r
\r
  if(Data != NULL) {\r
    MapLength = *DataLength;\r
    MapPyhAddr = (EFI_PHYSICAL_ADDRESS)(UINTN)Data;\r
  }\r
  //\r
  //Data Stage\r
  //\r
  LeftLength = MapLength;\r
  ActualSendLength = MapLength;\r
  CurrentToggle = *DataToggle;\r
  HeadTd = NULL;\r
  FirstTD = TRUE;\r
  while (LeftLength > 0) {\r
    ActualSendLength = LeftLength;\r
    if (LeftLength > MaxPacketLength) {\r
      ActualSendLength = MaxPacketLength;\r
    }\r
    DataTd = OhciCreateTD (Ohc);\r
    if (DataTd == NULL) {\r
      DEBUG ((EFI_D_INFO, "OhcBulkTransfer: Fail to allocate Data TD buffer\r\n"));\r
      Status = EFI_OUT_OF_RESOURCES;\r
      goto FREE_TD_BUFF;\r
    }\r
    OhciSetTDField (DataTd, TD_PDATA, 0);\r
    OhciSetTDField (DataTd, TD_BUFFER_ROUND, 1);\r
    OhciSetTDField (DataTd, TD_DIR_PID, DataPidDir);\r
    OhciSetTDField (DataTd, TD_DELAY_INT, TD_NO_DELAY);\r
    OhciSetTDField (DataTd, TD_DT_TOGGLE, CurrentToggle);\r
    OhciSetTDField (DataTd, TD_ERROR_CNT, 0);\r
    OhciSetTDField (DataTd, TD_COND_CODE, TD_TOBE_PROCESSED);\r
    OhciSetTDField (DataTd, TD_CURR_BUFFER_PTR, (UINT32) MapPyhAddr);\r
    OhciSetTDField (DataTd, TD_BUFFER_END_PTR, (UINT32) MapPyhAddr + ActualSendLength - 1);\r
    OhciSetTDField (DataTd, TD_NEXT_PTR, (UINT32) NULL);\r
    DataTd->ActualSendLength = ActualSendLength;\r
    DataTd->DataBuffer = (UINT8 *)(UINTN)MapPyhAddr;\r
    DataTd->NextTDPointer = 0;\r
    if (FirstTD) {\r
      HeadTd = DataTd;\r
      FirstTD = FALSE;\r
    } else {\r
      OhciLinkTD (HeadTd, DataTd);\r
    }\r
    CurrentToggle ^= 1;\r
    MapPyhAddr += ActualSendLength;\r
    LeftLength -= ActualSendLength;\r
  }\r
  //\r
  // Empty Stage\r
  //\r
  EmptyTd = OhciCreateTD (Ohc);\r
  if (EmptyTd == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
      DEBUG ((EFI_D_INFO, "OhcBulkTransfer: Fail to allocate Empty TD buffer\r\n"));\r
    goto FREE_TD_BUFF;\r
  }\r
  OhciSetTDField (EmptyTd, TD_PDATA, 0);\r
  OhciSetTDField (EmptyTd, TD_BUFFER_ROUND, 0);\r
  OhciSetTDField (EmptyTd, TD_DIR_PID, 0);\r
  OhciSetTDField (EmptyTd, TD_DELAY_INT, 0);\r
  //OhciSetTDField (EmptyTd, TD_DT_TOGGLE, CurrentToggle);\r
  EmptyTd->Word0.DataToggle = 0;\r
  OhciSetTDField (EmptyTd, TD_ERROR_CNT, 0);\r
  OhciSetTDField (EmptyTd, TD_COND_CODE, 0);\r
  OhciSetTDField (EmptyTd, TD_CURR_BUFFER_PTR, 0);\r
  OhciSetTDField (EmptyTd, TD_BUFFER_END_PTR, 0);\r
  OhciSetTDField (EmptyTd, TD_NEXT_PTR, 0);\r
  EmptyTd->ActualSendLength = 0;\r
  EmptyTd->DataBuffer = NULL;\r
  EmptyTd->NextTDPointer = NULL;\r
  OhciLinkTD (HeadTd, EmptyTd);\r
  Ed->TdTailPointer = EmptyTd;\r
  OhciAttachTDListToED (Ed, HeadTd);\r
\r
  OhciSetEDField (Ed, ED_SKIP, 0);\r
  OhciSetHcCommandStatus (Ohc, BULK_LIST_FILLED, 1);\r
  OhciSetHcControl (Ohc, BULK_ENABLE, 1);\r
  if (OhciGetHcControl (Ohc, BULK_ENABLE) != 1) {\r
    MicroSecondDelay (HC_1_MILLISECOND);\r
    if (OhciGetHcControl (Ohc, BULK_ENABLE) != 1) {\r
      *TransferResult = EFI_USB_ERR_SYSTEM;\r
      goto FREE_TD_BUFF;\r
    }\r
  }\r
\r
  TimeCount = 0;\r
  Status = CheckIfDone (Ohc, BULK_LIST, Ed, HeadTd, &ErrorCode);\r
\r
  while (Status == EFI_NOT_READY && TimeCount <= TimeOut) {\r
    MicroSecondDelay (HC_1_MILLISECOND);\r
    TimeCount++;\r
    Status = CheckIfDone (Ohc, BULK_LIST, Ed, HeadTd, &ErrorCode);\r
  }\r
\r
  *TransferResult = ConvertErrorCode (ErrorCode);\r
\r
  if (ErrorCode != TD_NO_ERROR) {\r
    if (ErrorCode == TD_TOBE_PROCESSED) {\r
      DEBUG ((EFI_D_INFO, "Bulk pipe timeout, > %d mS\r\n", TimeOut));\r
    } else {\r
      DEBUG ((EFI_D_INFO, "Bulk pipe broken\r\n"));\r
    }\r
    *DataLength = 0;\r
  }\r
    *DataToggle = (UINT8) OhciGetEDField (Ed, ED_DTTOGGLE);\r
\r
FREE_TD_BUFF:\r
  while (HeadTd) {\r
    DataTd = HeadTd;\r
    HeadTd = HeadTd->NextTDPointer;\r
    UsbHcFreeMem(Ohc->MemPool, DataTd, sizeof(TD_DESCRIPTOR));\r
  }\r
  UsbHcFreeMem(Ohc->MemPool, Ed, sizeof(ED_DESCRIPTOR));\r
\r
  return Status;\r
}\r
/**\r
  Retrieves the number of root hub ports.\r
\r
  @param[in]  PeiServices       The pointer to the PEI Services Table.\r
  @param[in]  This              The pointer to this instance of the\r
                                PEI_USB_HOST_CONTROLLER_PPI.\r
  @param[out] NumOfPorts        The pointer to the number of the root hub ports.\r
\r
  @retval EFI_SUCCESS           The port number was retrieved successfully.\r
  @retval EFI_INVALID_PARAMETER PortNumber is NULL.\r
\r
**/\r
\r
EFI_STATUS\r
EFIAPI\r
OhciGetRootHubNumOfPorts (\r
  IN EFI_PEI_SERVICES             **PeiServices,\r
  IN PEI_USB_HOST_CONTROLLER_PPI  *This,\r
  OUT UINT8                       *NumOfPorts\r
  )\r
{\r
  USB_OHCI_HC_DEV                *Ohc;\r
  if (NumOfPorts == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  Ohc = PEI_RECOVERY_USB_OHC_DEV_FROM_EHCI_THIS (This);\r
  *NumOfPorts = (UINT8)OhciGetRootHubDescriptor(Ohc, RH_NUM_DS_PORTS);\r
\r
  return EFI_SUCCESS;\r
}\r
/**\r
  Retrieves the current status of a USB root hub port.\r
\r
  @param  PeiServices            The pointer of EFI_PEI_SERVICES.\r
  @param  This                   The pointer of PEI_USB_HOST_CONTROLLER_PPI.\r
  @param  PortNumber             The root hub port to retrieve the state from.\r
  @param  PortStatus             Variable to receive the port state.\r
\r
  @retval EFI_SUCCESS            The status of the USB root hub port specified.\r
                                 by PortNumber was returned in PortStatus.\r
  @retval EFI_INVALID_PARAMETER  PortNumber is invalid.\r
\r
**/\r
\r
EFI_STATUS\r
EFIAPI\r
OhciGetRootHubPortStatus (\r
  IN  EFI_PEI_SERVICES             **PeiServices,\r
  IN  PEI_USB_HOST_CONTROLLER_PPI  *This,\r
  IN  UINT8                        PortNumber,\r
  OUT EFI_USB_PORT_STATUS          *PortStatus\r
  )\r
{\r
  USB_OHCI_HC_DEV  *Ohc;\r
  UINT8            NumOfPorts;\r
\r
  Ohc = PEI_RECOVERY_USB_OHC_DEV_FROM_EHCI_THIS (This);\r
\r
  OhciGetRootHubNumOfPorts (PeiServices, This, &NumOfPorts);\r
  if (PortNumber >= NumOfPorts) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  PortStatus->PortStatus = 0;\r
  PortStatus->PortChangeStatus = 0;\r
\r
  if (OhciReadRootHubPortStatus (Ohc,PortNumber, RH_CURR_CONNECT_STAT)) {\r
    PortStatus->PortStatus |= USB_PORT_STAT_CONNECTION;\r
  }\r
  if (OhciReadRootHubPortStatus (Ohc,PortNumber, RH_PORT_ENABLE_STAT)) {\r
    PortStatus->PortStatus |= USB_PORT_STAT_ENABLE;\r
  }\r
  if (OhciReadRootHubPortStatus (Ohc,PortNumber, RH_PORT_SUSPEND_STAT)) {\r
    PortStatus->PortStatus |= USB_PORT_STAT_SUSPEND;\r
  }\r
  if (OhciReadRootHubPortStatus (Ohc,PortNumber, RH_PORT_OC_INDICATOR)) {\r
    PortStatus->PortStatus |= USB_PORT_STAT_OVERCURRENT;\r
  }\r
  if (OhciReadRootHubPortStatus (Ohc,PortNumber, RH_PORT_RESET_STAT)) {\r
    PortStatus->PortStatus |= USB_PORT_STAT_RESET;\r
  }\r
  if (OhciReadRootHubPortStatus (Ohc,PortNumber, RH_PORT_POWER_STAT)) {\r
    PortStatus->PortStatus |= USB_PORT_STAT_POWER;\r
  }\r
  if (OhciReadRootHubPortStatus (Ohc,PortNumber, RH_LSDEVICE_ATTACHED)) {\r
    PortStatus->PortStatus |= USB_PORT_STAT_LOW_SPEED;\r
  }\r
  if (OhciReadRootHubPortStatus (Ohc, PortNumber, RH_PORT_ENABLE_STAT_CHANGE)) {\r
    PortStatus->PortChangeStatus |= USB_PORT_STAT_C_ENABLE;\r
  }\r
  if (OhciReadRootHubPortStatus (Ohc, PortNumber, RH_CONNECT_STATUS_CHANGE)) {\r
    PortStatus->PortChangeStatus |= USB_PORT_STAT_C_CONNECTION;\r
  }\r
  if (OhciReadRootHubPortStatus (Ohc, PortNumber, RH_PORT_SUSPEND_STAT_CHANGE)) {\r
    PortStatus->PortChangeStatus |= USB_PORT_STAT_C_SUSPEND;\r
  }\r
  if (OhciReadRootHubPortStatus (Ohc, PortNumber, RH_OC_INDICATOR_CHANGE)) {\r
    PortStatus->PortChangeStatus |= USB_PORT_STAT_C_OVERCURRENT;\r
  }\r
  if (OhciReadRootHubPortStatus (Ohc, PortNumber, RH_PORT_RESET_STAT_CHANGE)) {\r
    PortStatus->PortChangeStatus |= USB_PORT_STAT_C_RESET;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
/**\r
  Sets a feature for the specified root hub port.\r
\r
  @param  PeiServices           The pointer of EFI_PEI_SERVICES\r
  @param  This                  The pointer of PEI_USB_HOST_CONTROLLER_PPI\r
  @param  PortNumber            Root hub port to set.\r
  @param  PortFeature           Feature to set.\r
\r
  @retval EFI_SUCCESS            The feature specified by PortFeature was set.\r
  @retval EFI_INVALID_PARAMETER  PortNumber is invalid or PortFeature is invalid.\r
  @retval EFI_TIMEOUT            The time out occurred.\r
\r
**/\r
\r
EFI_STATUS\r
EFIAPI\r
OhciSetRootHubPortFeature (\r
  IN EFI_PEI_SERVICES             **PeiServices,\r
  IN PEI_USB_HOST_CONTROLLER_PPI  *This,\r
  IN UINT8                        PortNumber,\r
  IN EFI_USB_PORT_FEATURE         PortFeature\r
  )\r
{\r
  USB_OHCI_HC_DEV         *Ohc;\r
  EFI_STATUS              Status;\r
  UINT8                   NumOfPorts;\r
  UINTN                   RetryTimes;\r
\r
  OhciGetRootHubNumOfPorts (PeiServices, This, &NumOfPorts);\r
  if (PortNumber >= NumOfPorts) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Ohc = PEI_RECOVERY_USB_OHC_DEV_FROM_EHCI_THIS (This);\r
\r
  Status = EFI_SUCCESS;\r
\r
\r
  switch (PortFeature) {\r
    case EfiUsbPortPower:\r
      Status = OhciSetRootHubPortStatus (Ohc, PortNumber, RH_SET_PORT_POWER);\r
\r
      //\r
      // Verify the state\r
      //\r
      RetryTimes = 0;\r
      do {\r
        MicroSecondDelay (HC_1_MILLISECOND);\r
        RetryTimes++;\r
      } while (OhciReadRootHubPortStatus (Ohc, PortNumber, RH_PORT_POWER_STAT) == 0 &&\r
               RetryTimes < MAX_RETRY_TIMES);\r
\r
      if (RetryTimes >= MAX_RETRY_TIMES) {\r
        return EFI_DEVICE_ERROR;\r
      }\r
      break;\r
\r
    case EfiUsbPortReset:\r
      Status = OhciSetRootHubPortStatus (Ohc, PortNumber, RH_SET_PORT_RESET);\r
\r
      //\r
      // Verify the state\r
      //\r
      RetryTimes = 0;\r
      do {\r
        MicroSecondDelay (HC_1_MILLISECOND);\r
        RetryTimes++;\r
      } while ((OhciReadRootHubPortStatus (Ohc, PortNumber, RH_PORT_RESET_STAT_CHANGE) == 0 ||\r
                OhciReadRootHubPortStatus (Ohc, PortNumber, RH_PORT_RESET_STAT) == 1) &&\r
               RetryTimes < MAX_RETRY_TIMES);\r
\r
      if (RetryTimes >= MAX_RETRY_TIMES) {\r
        return EFI_DEVICE_ERROR;\r
      }\r
\r
      OhciSetRootHubPortStatus (Ohc, PortNumber, RH_PORT_RESET_STAT_CHANGE);\r
      break;\r
\r
    case EfiUsbPortEnable:\r
      Status = OhciSetRootHubPortStatus (Ohc, PortNumber, RH_SET_PORT_ENABLE);\r
\r
      //\r
      // Verify the state\r
      //\r
      RetryTimes = 0;\r
      do {\r
        MicroSecondDelay (HC_1_MILLISECOND);;\r
        RetryTimes++;\r
      } while (OhciReadRootHubPortStatus (Ohc, PortNumber, RH_PORT_ENABLE_STAT) == 0 &&\r
               RetryTimes < MAX_RETRY_TIMES);\r
\r
      if (RetryTimes >= MAX_RETRY_TIMES) {\r
        return EFI_DEVICE_ERROR;\r
      }\r
      break;\r
\r
\r
    case EfiUsbPortSuspend:\r
      Status = OhciSetRootHubPortStatus (Ohc, PortNumber, RH_SET_PORT_SUSPEND);\r
\r
      //\r
      // Verify the state\r
      //\r
      RetryTimes = 0;\r
      do {\r
        MicroSecondDelay (HC_1_MILLISECOND);;\r
        RetryTimes++;\r
      } while (OhciReadRootHubPortStatus (Ohc, PortNumber, RH_PORT_SUSPEND_STAT) == 0 &&\r
               RetryTimes < MAX_RETRY_TIMES);\r
\r
      if (RetryTimes >= MAX_RETRY_TIMES) {\r
        return EFI_DEVICE_ERROR;\r
      }\r
      break;\r
\r
    default:\r
      return EFI_INVALID_PARAMETER;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Clears a feature for the specified root hub port.\r
\r
  @param  PeiServices           The pointer of EFI_PEI_SERVICES.\r
  @param  This                  The pointer of PEI_USB_HOST_CONTROLLER_PPI.\r
  @param  PortNumber            Specifies the root hub port whose feature\r
                                is requested to be cleared.\r
  @param  PortFeature           Indicates the feature selector associated with the\r
                                feature clear request.\r
\r
  @retval EFI_SUCCESS            The feature specified by PortFeature was cleared\r
                                 for the USB root hub port specified by PortNumber.\r
  @retval EFI_INVALID_PARAMETER  PortNumber is invalid or PortFeature is invalid.\r
\r
**/\r
\r
EFI_STATUS\r
EFIAPI\r
OhciClearRootHubPortFeature (\r
  IN EFI_PEI_SERVICES             **PeiServices,\r
  IN PEI_USB_HOST_CONTROLLER_PPI  *This,\r
  IN UINT8                        PortNumber,\r
  IN EFI_USB_PORT_FEATURE         PortFeature\r
  )\r
{\r
  USB_OHCI_HC_DEV         *Ohc;\r
  EFI_STATUS              Status;\r
  UINT8                   NumOfPorts;\r
  UINTN                   RetryTimes;\r
\r
\r
  OhciGetRootHubNumOfPorts (PeiServices, This, &NumOfPorts);\r
  if (PortNumber >= NumOfPorts) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Ohc = PEI_RECOVERY_USB_OHC_DEV_FROM_EHCI_THIS (This);\r
\r
  Status = EFI_SUCCESS;\r
\r
  switch (PortFeature) {\r
    case EfiUsbPortEnable:\r
      Status = OhciSetRootHubPortStatus (Ohc, PortNumber, RH_CLEAR_PORT_ENABLE);\r
\r
      //\r
      // Verify the state\r
      //\r
      RetryTimes = 0;\r
      do {\r
        MicroSecondDelay (HC_1_MILLISECOND);\r
        RetryTimes++;\r
      } while (OhciReadRootHubPortStatus (Ohc, PortNumber, RH_PORT_ENABLE_STAT) == 1 &&\r
               RetryTimes < MAX_RETRY_TIMES);\r
\r
      if (RetryTimes >= MAX_RETRY_TIMES) {\r
        return EFI_DEVICE_ERROR;\r
      }\r
      break;\r
\r
    case EfiUsbPortSuspend:\r
      Status = OhciSetRootHubPortStatus (Ohc, PortNumber, RH_CLEAR_SUSPEND_STATUS);\r
\r
      //\r
      // Verify the state\r
      //\r
      RetryTimes = 0;\r
      do {\r
        MicroSecondDelay (HC_1_MILLISECOND);\r
        RetryTimes++;\r
      } while (OhciReadRootHubPortStatus (Ohc, PortNumber, RH_PORT_SUSPEND_STAT) == 1 &&\r
               RetryTimes < MAX_RETRY_TIMES);\r
\r
      if (RetryTimes >= MAX_RETRY_TIMES) {\r
        return EFI_DEVICE_ERROR;\r
      }\r
      break;\r
\r
    case EfiUsbPortReset:\r
      break;\r
\r
    case EfiUsbPortPower:\r
      Status = OhciSetRootHubPortStatus (Ohc, PortNumber, RH_CLEAR_PORT_POWER);\r
\r
      //\r
      // Verify the state\r
      //\r
      RetryTimes = 0;\r
      do {\r
        MicroSecondDelay (HC_1_MILLISECOND);\r
        RetryTimes++;\r
      } while (OhciReadRootHubPortStatus (Ohc, PortNumber, RH_PORT_POWER_STAT) == 1 &&\r
               RetryTimes < MAX_RETRY_TIMES);\r
\r
      if (RetryTimes >= MAX_RETRY_TIMES) {\r
        return EFI_DEVICE_ERROR;\r
      }\r
      break;\r
\r
    case EfiUsbPortConnectChange:\r
      Status = OhciSetRootHubPortStatus (Ohc, PortNumber, RH_CONNECT_STATUS_CHANGE);\r
\r
      //\r
      // Verify the state\r
      //\r
      RetryTimes = 0;\r
      do {\r
        MicroSecondDelay (HC_1_MILLISECOND);\r
        RetryTimes++;\r
      } while (OhciReadRootHubPortStatus (Ohc, PortNumber, RH_CONNECT_STATUS_CHANGE) == 1 &&\r
               RetryTimes < MAX_RETRY_TIMES);\r
\r
      if (RetryTimes >= MAX_RETRY_TIMES) {\r
        return EFI_DEVICE_ERROR;\r
      }\r
      break;\r
\r
    case EfiUsbPortResetChange:\r
      Status = OhciSetRootHubPortStatus (Ohc, PortNumber, RH_PORT_RESET_STAT_CHANGE);\r
\r
      //\r
      // Verify the state\r
      //\r
      RetryTimes = 0;\r
      do {\r
        MicroSecondDelay (HC_1_MILLISECOND);\r
        RetryTimes++;\r
      } while (OhciReadRootHubPortStatus (Ohc, PortNumber, RH_PORT_RESET_STAT_CHANGE) == 1 &&\r
               RetryTimes < MAX_RETRY_TIMES);\r
\r
      if (RetryTimes >= MAX_RETRY_TIMES) {\r
        return EFI_DEVICE_ERROR;\r
      }\r
      break;\r
\r
\r
    case EfiUsbPortEnableChange:\r
      Status = OhciSetRootHubPortStatus (Ohc, PortNumber, RH_PORT_ENABLE_STAT_CHANGE);\r
\r
      //\r
      // Verify the state\r
      //\r
      RetryTimes = 0;\r
      do {\r
        MicroSecondDelay (HC_1_MILLISECOND);\r
        RetryTimes++;\r
      } while (OhciReadRootHubPortStatus (Ohc, PortNumber, RH_PORT_ENABLE_STAT_CHANGE) == 1 &&\r
               RetryTimes < MAX_RETRY_TIMES);\r
\r
      if (RetryTimes >= MAX_RETRY_TIMES) {\r
        return EFI_DEVICE_ERROR;\r
      }\r
      break;\r
\r
    case EfiUsbPortSuspendChange:\r
      Status = OhciSetRootHubPortStatus (Ohc, PortNumber, RH_PORT_SUSPEND_STAT_CHANGE);\r
\r
      //\r
      // Verify the state\r
      //\r
      RetryTimes = 0;\r
      do {\r
        MicroSecondDelay (HC_1_MILLISECOND);\r
        RetryTimes++;\r
      } while (OhciReadRootHubPortStatus (Ohc, PortNumber, RH_PORT_SUSPEND_STAT_CHANGE) == 1 &&\r
               RetryTimes < MAX_RETRY_TIMES);\r
\r
      if (RetryTimes >= MAX_RETRY_TIMES) {\r
        return EFI_DEVICE_ERROR;\r
      }\r
      break;\r
\r
    case EfiUsbPortOverCurrentChange:\r
      Status = OhciSetRootHubPortStatus (Ohc, PortNumber, RH_OC_INDICATOR_CHANGE);\r
\r
      //\r
      // Verify the state\r
      //\r
      RetryTimes = 0;\r
      do {\r
        MicroSecondDelay (HC_1_MILLISECOND);\r
        RetryTimes++;\r
      } while (OhciReadRootHubPortStatus (Ohc, PortNumber, RH_OC_INDICATOR_CHANGE) == 1 &&\r
               RetryTimes < MAX_RETRY_TIMES);\r
\r
      if (RetryTimes >= MAX_RETRY_TIMES) {\r
        return EFI_DEVICE_ERROR;\r
      }\r
      break;\r
\r
    default:\r
      return EFI_INVALID_PARAMETER;\r
  }\r
\r
  return Status;\r
}\r
/**\r
  Provides software reset for the USB host controller.\r
\r
  @param  This                  This EFI_USB_HC_PROTOCOL instance.\r
  @param  Attributes            A bit mask of the reset operation to perform.\r
\r
  @retval EFI_SUCCESS           The reset operation succeeded.\r
  @retval EFI_INVALID_PARAMETER Attributes is not valid.\r
  @retval EFI_UNSUPPOURTED      The type of reset specified by Attributes is\r
                                not currently supported by the host controller.\r
  @retval EFI_DEVICE_ERROR      Host controller isn't halted to reset.\r
\r
**/\r
EFI_STATUS\r
InitializeUsbHC (\r
  IN EFI_PEI_SERVICES           **PeiServices,\r
  IN USB_OHCI_HC_DEV            *Ohc,\r
  IN UINT16                     Attributes\r
  )\r
{\r
  EFI_STATUS              Status;\r
  UINT8                   Index;\r
  UINT8                   NumOfPorts;\r
  UINT32                  PowerOnGoodTime;\r
  UINT32                  Data32;\r
  BOOLEAN                 Flag = FALSE;\r
\r
  if ((Attributes & ~(EFI_USB_HC_RESET_GLOBAL | EFI_USB_HC_RESET_HOST_CONTROLLER)) != 0) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  Status = EFI_SUCCESS;\r
\r
  if ((Attributes & EFI_USB_HC_RESET_HOST_CONTROLLER) != 0) {\r
    MicroSecondDelay (50 * HC_1_MILLISECOND);\r
    Status = OhciSetHcCommandStatus (Ohc, HC_RESET, HC_RESET);\r
    if (EFI_ERROR (Status)) {\r
      return EFI_DEVICE_ERROR;\r
    }\r
    MicroSecondDelay (50 * HC_1_MILLISECOND);\r
    //\r
    // Wait for host controller reset.\r
    //\r
    PowerOnGoodTime = 50;\r
    do {\r
      MicroSecondDelay (HC_1_MILLISECOND);\r
      Data32 = OhciGetOperationalReg (Ohc, HC_COMMAND_STATUS );\r
      if ((Data32 & HC_RESET) == 0) {\r
        Flag = TRUE;\r
        break;\r
      }\r
    }while(PowerOnGoodTime--);\r
    if (!Flag){\r
      return EFI_DEVICE_ERROR;\r
    }\r
  }\r
\r
  OhciSetFrameInterval (Ohc, FRAME_INTERVAL, 0x2edf);\r
  if ((Attributes &  EFI_USB_HC_RESET_GLOBAL) != 0) {\r
    Status = OhciSetHcControl (Ohc, HC_FUNCTIONAL_STATE, HC_STATE_RESET);\r
    if (EFI_ERROR (Status)) {\r
      return EFI_DEVICE_ERROR;\r
    }\r
    MicroSecondDelay (50 * HC_1_MILLISECOND);\r
  }\r
  //\r
  // Initialize host controller operational registers\r
  //\r
  OhciSetFrameInterval (Ohc, FS_LARGEST_DATA_PACKET, 0x2778);\r
  OhciSetFrameInterval (Ohc, FRAME_INTERVAL, 0x2edf);\r
  OhciSetPeriodicStart (Ohc, 0x2a2f);\r
  OhciSetHcControl (Ohc, CONTROL_BULK_RATIO, 0x0);\r
  OhciSetHcCommandStatus (Ohc, CONTROL_LIST_FILLED | BULK_LIST_FILLED, 0);\r
  OhciSetRootHubDescriptor (Ohc, RH_PSWITCH_MODE, 0);\r
  OhciSetRootHubDescriptor (Ohc, RH_NO_PSWITCH | RH_NOC_PROT, 1);\r
  //OhciSetRootHubDescriptor (Hc, RH_PSWITCH_MODE | RH_NO_PSWITCH, 0);\r
  //OhciSetRootHubDescriptor (Hc, RH_PSWITCH_MODE | RH_NOC_PROT, 1);\r
\r
  OhciSetRootHubDescriptor (Ohc, RH_DEV_REMOVABLE, 0);\r
  OhciSetRootHubDescriptor (Ohc, RH_PORT_PWR_CTRL_MASK, 0xffff);\r
  OhciSetRootHubStatus (Ohc, RH_LOCAL_PSTAT_CHANGE);\r
  OhciSetRootHubPortStatus (Ohc, 0, RH_SET_PORT_POWER);\r
  OhciGetRootHubNumOfPorts (PeiServices, &Ohc->UsbHostControllerPpi, &NumOfPorts);\r
  for (Index = 0; Index < NumOfPorts; Index++) {\r
    if (!EFI_ERROR (OhciSetRootHubPortFeature (PeiServices, &Ohc->UsbHostControllerPpi, Index, EfiUsbPortReset))) {\r
      MicroSecondDelay (200 * HC_1_MILLISECOND);\r
      OhciClearRootHubPortFeature (PeiServices, &Ohc->UsbHostControllerPpi, Index, EfiUsbPortReset);\r
      MicroSecondDelay (HC_1_MILLISECOND);\r
      OhciSetRootHubPortFeature (PeiServices, &Ohc->UsbHostControllerPpi, Index, EfiUsbPortEnable);\r
      MicroSecondDelay (HC_1_MILLISECOND);\r
    }\r
  }\r
\r
  Ohc->MemPool = UsbHcInitMemPool(TRUE, 0);\r
  if(Ohc->MemPool == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  OhciSetMemoryPointer (Ohc, HC_CONTROL_HEAD, NULL);\r
  OhciSetMemoryPointer (Ohc, HC_BULK_HEAD, NULL);\r
  OhciSetHcControl (Ohc, CONTROL_ENABLE | BULK_ENABLE, 1);\r
  OhciSetHcControl (Ohc, HC_FUNCTIONAL_STATE, HC_STATE_OPERATIONAL);\r
  MicroSecondDelay (50 * HC_1_MILLISECOND);\r
  //\r
  // Wait till first SOF occurs, and then clear it\r
  //\r
  while (OhciGetHcInterruptStatus (Ohc, START_OF_FRAME) == 0);\r
  OhciClearInterruptStatus (Ohc, START_OF_FRAME);\r
  MicroSecondDelay (HC_1_MILLISECOND);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Submits control transfer to a target USB device.\r
\r
  Calls underlying OhciControlTransfer to do work. This wrapper routine required\r
  on Quark so that USB DMA transfers do not cause an IMR violation.\r
\r
  @param  PeiServices            The pointer of EFI_PEI_SERVICES.\r
  @param  This                   The pointer of PEI_USB_HOST_CONTROLLER_PPI.\r
  @param  DeviceAddress          The target device address.\r
  @param  DeviceSpeed            Target device speed.\r
  @param  MaximumPacketLength    Maximum packet size the default control transfer\r
                                 endpoint is capable of sending or receiving.\r
  @param  Request                USB device request to send.\r
  @param  TransferDirection      Specifies the data direction for the data stage.\r
  @param  Data                   Data buffer to be transmitted or received from USB device.\r
  @param  DataLength             The size (in bytes) of the data buffer.\r
  @param  TimeOut                Indicates the maximum timeout, in millisecond.\r
  @param  TransferResult         Return the result of this control transfer.\r
\r
  @retval EFI_SUCCESS            Transfer was completed successfully.\r
  @retval EFI_OUT_OF_RESOURCES   The transfer failed due to lack of resources.\r
  @retval EFI_INVALID_PARAMETER  Some parameters are invalid.\r
  @retval EFI_TIMEOUT            Transfer failed due to timeout.\r
  @retval EFI_DEVICE_ERROR       Transfer failed due to host controller or device error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RedirectOhciControlTransfer (\r
  IN  EFI_PEI_SERVICES             **PeiServices,\r
  IN  PEI_USB_HOST_CONTROLLER_PPI  *This,\r
  IN  UINT8                        DeviceAddress,\r
  IN  UINT8                        DeviceSpeed,\r
  IN  UINT8                        MaxPacketLength,\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
  OUT UINT32                       *TransferResult\r
  )\r
{\r
  EFI_STATUS              Status;\r
  EFI_USB_DEVICE_REQUEST  *NewRequest;\r
  VOID                    *NewData;\r
  UINT8                   *Alloc;\r
\r
  //\r
  // Allocate memory external to IMR protected region for transfer data.\r
  //\r
  Status = PeiServicesAllocatePool (\r
                             sizeof(EFI_USB_DEVICE_REQUEST) + *DataLength,\r
                             (VOID **) &Alloc\r
                             );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Setup pointers to transfer buffers.\r
  //\r
  NewRequest = (EFI_USB_DEVICE_REQUEST *) Alloc;\r
  Alloc += sizeof(EFI_USB_DEVICE_REQUEST);\r
  NewData = (VOID *) Alloc;\r
\r
  //\r
  // Copy callers request packet into transfer request packet.\r
  //\r
  if (Request != NULL) {\r
    CopyMem (NewRequest,Request,sizeof(EFI_USB_DEVICE_REQUEST));\r
  } else {\r
    NewRequest = NULL;\r
  }\r
  //\r
  // Copy callers data into transfer data buffer.\r
  //\r
  if (Data != NULL) {\r
    if (DataLength > 0) {\r
      CopyMem (NewData,Data,*DataLength);\r
    }\r
  } else {\r
    NewData = NULL;\r
  }\r
\r
  //\r
  // Call underlying OhciControlTransfer to do work.\r
  //\r
  Status = OhciControlTransfer (\r
             PeiServices,\r
             This,\r
             DeviceAddress,\r
             DeviceSpeed,\r
             MaxPacketLength,\r
             NewRequest,\r
             TransferDirection,\r
             NewData,\r
             DataLength,\r
             TimeOut,\r
             TransferResult\r
             );\r
\r
  //\r
  // Copy transfer buffer back into callers buffer.\r
  //\r
  if (Data != NULL && *DataLength > 0) {\r
    CopyMem (Data, NewData, *DataLength);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Submits bulk transfer to a bulk endpoint of a USB device.\r
\r
  Calls underlying OhciBulkTransfer to do work. This wrapper routine required\r
  on Quark so that USB DMA transfers do not cause an IMR violation.\r
\r
  @param  PeiServices           The pointer of EFI_PEI_SERVICES.\r
  @param  This                  The pointer of PEI_USB_HOST_CONTROLLER_PPI.\r
  @param  DeviceAddress         Target device address.\r
  @param  EndPointAddress       Endpoint number and its direction in bit 7.\r
  @param  MaxiPacketLength      Maximum packet size the endpoint is capable of\r
                                sending or receiving.\r
  @param  Data                  A pointers to the buffers of data to transmit\r
                                from or receive into.\r
  @param  DataLength            The lenght of the data buffer.\r
  @param  DataToggle            On input, the initial data toggle for the transfer;\r
                                On output, it is updated to to next data toggle to use of\r
                                the subsequent bulk transfer.\r
  @param  TimeOut               Indicates the maximum time, in millisecond, which the\r
                                transfer is allowed to complete.\r
  @param  TransferResult        A pointer to the detailed result information of the\r
                                bulk transfer.\r
\r
  @retval EFI_SUCCESS           The transfer was completed successfully.\r
  @retval EFI_OUT_OF_RESOURCES  The transfer failed due to lack of resource.\r
  @retval EFI_INVALID_PARAMETER Parameters are invalid.\r
  @retval EFI_TIMEOUT           The transfer failed due to timeout.\r
  @retval EFI_DEVICE_ERROR      The transfer failed due to host controller error.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
RedirectOhciBulkTransfer (\r
  IN EFI_PEI_SERVICES             **PeiServices,\r
  IN PEI_USB_HOST_CONTROLLER_PPI  *This,\r
  IN  UINT8                       DeviceAddress,\r
  IN  UINT8                       EndPointAddress,\r
  IN  UINT8                       MaxPacketLength,\r
  IN  OUT VOID                    *Data,\r
  IN  OUT UINTN                   *DataLength,\r
  IN  OUT UINT8                   *DataToggle,\r
  IN  UINTN                       TimeOut,\r
  OUT UINT32                      *TransferResult\r
  )\r
{\r
  EFI_STATUS              Status;\r
  UINT8                   *NewData;\r
\r
  //\r
  // Allocate memory external to IMR protected region for transfer data.\r
  //\r
  Status = PeiServicesAllocatePool (\r
                             *DataLength,\r
                             (VOID **) &NewData\r
                             );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Copy callers data into transfer buffer.\r
  //\r
  if (Data != NULL) {\r
    if (DataLength > 0) {\r
      CopyMem (NewData,Data,*DataLength);\r
    }\r
  } else {\r
    NewData = NULL;\r
  }\r
\r
  //\r
  // Call underlying OhciBulkTransfer to do work.\r
  //\r
  Status = OhciBulkTransfer (\r
             PeiServices,\r
             This,\r
             DeviceAddress,\r
             EndPointAddress,\r
             MaxPacketLength,\r
             NewData,\r
             DataLength,\r
             DataToggle,\r
             TimeOut,\r
             TransferResult\r
             );\r
\r
  //\r
  // Copy transfer buffer back into callers buffer.\r
  //\r
  if (Data != NULL && *DataLength > 0) {\r
    CopyMem (Data, NewData, *DataLength);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  @param  FileHandle  Handle of the file being invoked.\r
  @param  PeiServices Describes the list of possible PEI Services.\r
\r
  @retval EFI_SUCCESS            PPI successfully installed.\r
\r
**/\r
EFI_STATUS\r
OhcPeimEntry (\r
  IN EFI_PEI_FILE_HANDLE        FileHandle,\r
  IN CONST EFI_PEI_SERVICES     **PeiServices\r
  )\r
{\r
\r
  PEI_USB_CONTROLLER_PPI  *ChipSetUsbControllerPpi;\r
  EFI_STATUS              Status;\r
  UINT8                   Index;\r
  UINTN                   ControllerType;\r
  UINTN                   BaseAddress;\r
  UINTN                   MemPages;\r
  USB_OHCI_HC_DEV         *Ohc;\r
  EFI_PHYSICAL_ADDRESS    TempPtr;\r
\r
\r
  //\r
  // Shadow this PEIM to run from memory\r
  //\r
  if (!EFI_ERROR (PeiServicesRegisterForShadow (FileHandle))) {\r
    return EFI_SUCCESS;\r
  }\r
  Status = PeiServicesLocatePpi (\r
             &gPeiUsbControllerPpiGuid,\r
             0,\r
             NULL,\r
             (VOID **) &ChipSetUsbControllerPpi\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  Index = 0;\r
  while (TRUE) {\r
    Status = ChipSetUsbControllerPpi->GetUsbController (\r
                                        (EFI_PEI_SERVICES **) PeiServices,\r
                                        ChipSetUsbControllerPpi,\r
                                        Index,\r
                                        &ControllerType,\r
                                        &BaseAddress\r
                                        );\r
    //\r
    // When status is error, meant no controller is found\r
    //\r
    if (EFI_ERROR (Status)) {\r
      break;\r
    }\r
    //\r
    // This PEIM is for OHC type controller.\r
    //\r
    if (ControllerType != PEI_OHCI_CONTROLLER) {\r
      Index++;\r
      continue;\r
    }\r
\r
    MemPages = sizeof (USB_OHCI_HC_DEV) / PAGESIZE + 1;\r
    Status = PeiServicesAllocatePages (\r
               EfiBootServicesCode,\r
               MemPages,\r
               &TempPtr\r
               );\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((EFI_D_INFO, "OhcPeimEntry: Fail to allocate buffer for the %dth OHCI ControllerPpi\n", Index));\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
    ZeroMem((VOID *)(UINTN)TempPtr, MemPages*PAGESIZE);\r
    Ohc = (USB_OHCI_HC_DEV *) ((UINTN) TempPtr);\r
\r
    Ohc->Signature = USB_OHCI_HC_DEV_SIGNATURE;\r
\r
    Ohc->UsbHostControllerBaseAddress = (UINT32) BaseAddress;\r
\r
    //\r
    // Initialize Uhc's hardware\r
    //\r
    Status = InitializeUsbHC (\r
               (EFI_PEI_SERVICES **)PeiServices,\r
               Ohc,\r
               EFI_USB_HC_RESET_GLOBAL\r
               );\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((EFI_D_INFO, "OhcPeimEntry: Fail to init %dth OHCI ControllerPpi\n", Index));\r
      return Status;\r
    }\r
    //\r
    // Control & Bulk transfer services are accessed via their Redirect\r
    // routine versions on Quark so that USB DMA transfers do not cause an\r
    // IMR violation.\r
    //\r
    Ohc->UsbHostControllerPpi.ControlTransfer          = RedirectOhciControlTransfer;\r
    Ohc->UsbHostControllerPpi.BulkTransfer             = RedirectOhciBulkTransfer;\r
    Ohc->UsbHostControllerPpi.GetRootHubPortNumber     = OhciGetRootHubNumOfPorts;\r
    Ohc->UsbHostControllerPpi.GetRootHubPortStatus     = OhciGetRootHubPortStatus;\r
    Ohc->UsbHostControllerPpi.SetRootHubPortFeature    = OhciSetRootHubPortFeature;\r
    Ohc->UsbHostControllerPpi.ClearRootHubPortFeature  = OhciClearRootHubPortFeature;\r
\r
    Ohc->PpiDescriptor.Flags = (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST);\r
    Ohc->PpiDescriptor.Guid  = &gPeiUsbHostControllerPpiGuid;\r
    Ohc->PpiDescriptor.Ppi   = &Ohc->UsbHostControllerPpi;\r
\r
    Status = PeiServicesInstallPpi (&Ohc->PpiDescriptor);\r
    if (EFI_ERROR (Status)) {\r
      Index++;\r
      continue;\r
    }\r
    Index++;\r
  }\r
  return EFI_SUCCESS;\r
}\r
\r