MdeModulePkg: Apply uncrustify changes

[mirror_edk2.git] / MdeModulePkg / Bus / Sd / SdBlockIoPei / SdHci.c

/** @file\r
\r
  Copyright (c) 2015 - 2017, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "SdBlockIoPei.h"\r
\r
/**\r
  Read/Write specified SD host controller mmio register.\r
\r
  @param[in]      Address      The address of the mmio register to be read/written.\r
  @param[in]      Read         A boolean to indicate it's read or write operation.\r
  @param[in]      Count        The width of the mmio register in bytes.\r
                               Must be 1, 2 , 4 or 8 bytes.\r
  @param[in, out] Data         For read operations, the destination buffer to store\r
                               the results. For write operations, the source buffer\r
                               to write data from. The caller is responsible for\r
                               having ownership of the data buffer and ensuring its\r
                               size not less than Count bytes.\r
\r
  @retval EFI_INVALID_PARAMETER The Address or the Data or the Count is not valid.\r
  @retval EFI_SUCCESS           The read/write operation succeeds.\r
  @retval Others                The read/write operation fails.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SdPeimHcRwMmio (\r
  IN     UINTN    Address,\r
  IN     BOOLEAN  Read,\r
  IN     UINT8    Count,\r
  IN OUT VOID     *Data\r
  )\r
{\r
  if ((Address == 0) || (Data == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if ((Count != 1) && (Count != 2) && (Count != 4) && (Count != 8)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  switch (Count) {\r
    case 1:\r
      if (Read) {\r
        *(UINT8 *)Data = MmioRead8 (Address);\r
      } else {\r
        MmioWrite8 (Address, *(UINT8 *)Data);\r
      }\r
\r
      break;\r
    case 2:\r
      if (Read) {\r
        *(UINT16 *)Data = MmioRead16 (Address);\r
      } else {\r
        MmioWrite16 (Address, *(UINT16 *)Data);\r
      }\r
\r
      break;\r
    case 4:\r
      if (Read) {\r
        *(UINT32 *)Data = MmioRead32 (Address);\r
      } else {\r
        MmioWrite32 (Address, *(UINT32 *)Data);\r
      }\r
\r
      break;\r
    case 8:\r
      if (Read) {\r
        *(UINT64 *)Data = MmioRead64 (Address);\r
      } else {\r
        MmioWrite64 (Address, *(UINT64 *)Data);\r
      }\r
\r
      break;\r
    default:\r
      ASSERT (FALSE);\r
      return EFI_INVALID_PARAMETER;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Do OR operation with the value of the specified SD host controller mmio register.\r
\r
  @param[in] Address           The address of the mmio register to be read/written.\r
  @param[in] Count             The width of the mmio register in bytes.\r
                               Must be 1, 2 , 4 or 8 bytes.\r
  @param[in] OrData            The pointer to the data used to do OR operation.\r
                               The caller is responsible for having ownership of\r
                               the data buffer and ensuring its size not less than\r
                               Count bytes.\r
\r
  @retval EFI_INVALID_PARAMETER The Address or the OrData or the Count is not valid.\r
  @retval EFI_SUCCESS           The OR operation succeeds.\r
  @retval Others                The OR operation fails.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SdPeimHcOrMmio (\r
  IN  UINTN  Address,\r
  IN  UINT8  Count,\r
  IN  VOID   *OrData\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINT64      Data;\r
  UINT64      Or;\r
\r
  Status = SdPeimHcRwMmio (Address, TRUE, Count, &Data);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (Count == 1) {\r
    Or = *(UINT8 *)OrData;\r
  } else if (Count == 2) {\r
    Or = *(UINT16 *)OrData;\r
  } else if (Count == 4) {\r
    Or = *(UINT32 *)OrData;\r
  } else if (Count == 8) {\r
    Or = *(UINT64 *)OrData;\r
  } else {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Data  |= Or;\r
  Status = SdPeimHcRwMmio (Address, FALSE, Count, &Data);\r
\r
  return Status;\r
}\r
\r
/**\r
  Do AND operation with the value of the specified SD host controller mmio register.\r
\r
  @param[in] Address           The address of the mmio register to be read/written.\r
  @param[in] Count             The width of the mmio register in bytes.\r
                               Must be 1, 2 , 4 or 8 bytes.\r
  @param[in] AndData           The pointer to the data used to do AND operation.\r
                               The caller is responsible for having ownership of\r
                               the data buffer and ensuring its size not less than\r
                               Count bytes.\r
\r
  @retval EFI_INVALID_PARAMETER The Address or the AndData or the Count is not valid.\r
  @retval EFI_SUCCESS           The AND operation succeeds.\r
  @retval Others                The AND operation fails.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SdPeimHcAndMmio (\r
  IN  UINTN  Address,\r
  IN  UINT8  Count,\r
  IN  VOID   *AndData\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINT64      Data;\r
  UINT64      And;\r
\r
  Status = SdPeimHcRwMmio (Address, TRUE, Count, &Data);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (Count == 1) {\r
    And = *(UINT8 *)AndData;\r
  } else if (Count == 2) {\r
    And = *(UINT16 *)AndData;\r
  } else if (Count == 4) {\r
    And = *(UINT32 *)AndData;\r
  } else if (Count == 8) {\r
    And = *(UINT64 *)AndData;\r
  } else {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Data  &= And;\r
  Status = SdPeimHcRwMmio (Address, FALSE, Count, &Data);\r
\r
  return Status;\r
}\r
\r
/**\r
  Wait for the value of the specified MMIO register set to the test value.\r
\r
  @param[in]  Address       The address of the mmio register to be checked.\r
  @param[in]  Count         The width of the mmio register in bytes.\r
                            Must be 1, 2, 4 or 8 bytes.\r
  @param[in]  MaskValue     The mask value of memory.\r
  @param[in]  TestValue     The test value of memory.\r
\r
  @retval EFI_NOT_READY     The MMIO register hasn't set to the expected value.\r
  @retval EFI_SUCCESS       The MMIO register has expected value.\r
  @retval Others            The MMIO operation fails.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SdPeimHcCheckMmioSet (\r
  IN  UINTN   Address,\r
  IN  UINT8   Count,\r
  IN  UINT64  MaskValue,\r
  IN  UINT64  TestValue\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINT64      Value;\r
\r
  //\r
  // Access PCI MMIO space to see if the value is the tested one.\r
  //\r
  Value  = 0;\r
  Status = SdPeimHcRwMmio (Address, TRUE, Count, &Value);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Value &= MaskValue;\r
\r
  if (Value == TestValue) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  return EFI_NOT_READY;\r
}\r
\r
/**\r
  Wait for the value of the specified MMIO register set to the test value.\r
\r
  @param[in]  Address       The address of the mmio register to wait.\r
  @param[in]  Count         The width of the mmio register in bytes.\r
                            Must be 1, 2, 4 or 8 bytes.\r
  @param[in]  MaskValue     The mask value of memory.\r
  @param[in]  TestValue     The test value of memory.\r
  @param[in]  Timeout       The time out value for wait memory set, uses 1\r
                            microsecond as a unit.\r
\r
  @retval EFI_TIMEOUT       The MMIO register hasn't expected value in timeout\r
                            range.\r
  @retval EFI_SUCCESS       The MMIO register has expected value.\r
  @retval Others            The MMIO operation fails.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SdPeimHcWaitMmioSet (\r
  IN  UINTN   Address,\r
  IN  UINT8   Count,\r
  IN  UINT64  MaskValue,\r
  IN  UINT64  TestValue,\r
  IN  UINT64  Timeout\r
  )\r
{\r
  EFI_STATUS  Status;\r
  BOOLEAN     InfiniteWait;\r
\r
  if (Timeout == 0) {\r
    InfiniteWait = TRUE;\r
  } else {\r
    InfiniteWait = FALSE;\r
  }\r
\r
  while (InfiniteWait || (Timeout > 0)) {\r
    Status = SdPeimHcCheckMmioSet (\r
               Address,\r
               Count,\r
               MaskValue,\r
               TestValue\r
               );\r
    if (Status != EFI_NOT_READY) {\r
      return Status;\r
    }\r
\r
    //\r
    // Stall for 1 microsecond.\r
    //\r
    MicroSecondDelay (1);\r
\r
    Timeout--;\r
  }\r
\r
  return EFI_TIMEOUT;\r
}\r
\r
/**\r
  Software reset the specified SD host controller and enable all interrupts.\r
\r
  @param[in] Bar            The mmio base address of the slot to be accessed.\r
\r
  @retval EFI_SUCCESS       The software reset executes successfully.\r
  @retval Others            The software reset fails.\r
\r
**/\r
EFI_STATUS\r
SdPeimHcReset (\r
  IN UINTN  Bar\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINT8       SwReset;\r
\r
  SwReset = 0xFF;\r
  Status  = SdPeimHcRwMmio (Bar + SD_HC_SW_RST, FALSE, sizeof (SwReset), &SwReset);\r
\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "SdPeimHcReset: write full 1 fails: %r\n", Status));\r
    return Status;\r
  }\r
\r
  Status = SdPeimHcWaitMmioSet (\r
             Bar + SD_HC_SW_RST,\r
             sizeof (SwReset),\r
             0xFF,\r
             0x00,\r
             SD_TIMEOUT\r
             );\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_INFO, "SdPeimHcReset: reset done with %r\n", Status));\r
    return Status;\r
  }\r
\r
  //\r
  // Enable all interrupt after reset all.\r
  //\r
  Status = SdPeimHcEnableInterrupt (Bar);\r
\r
  return Status;\r
}\r
\r
/**\r
  Set all interrupt status bits in Normal and Error Interrupt Status Enable\r
  register.\r
\r
  @param[in] Bar            The mmio base address of the slot to be accessed.\r
\r
  @retval EFI_SUCCESS       The operation executes successfully.\r
  @retval Others            The operation fails.\r
\r
**/\r
EFI_STATUS\r
SdPeimHcEnableInterrupt (\r
  IN UINTN  Bar\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINT16      IntStatus;\r
\r
  //\r
  // Enable all bits in Error Interrupt Status Enable Register\r
  //\r
  IntStatus = 0xFFFF;\r
  Status    = SdPeimHcRwMmio (Bar + SD_HC_ERR_INT_STS_EN, FALSE, sizeof (IntStatus), &IntStatus);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Enable all bits in Normal Interrupt Status Enable Register\r
  //\r
  IntStatus = 0xFFFF;\r
  Status    = SdPeimHcRwMmio (Bar + SD_HC_NOR_INT_STS_EN, FALSE, sizeof (IntStatus), &IntStatus);\r
\r
  return Status;\r
}\r
\r
/**\r
  Get the capability data from the specified slot.\r
\r
  @param[in]  Bar             The mmio base address of the slot to be accessed.\r
  @param[out] Capability      The buffer to store the capability data.\r
\r
  @retval EFI_SUCCESS         The operation executes successfully.\r
  @retval Others              The operation fails.\r
\r
**/\r
EFI_STATUS\r
SdPeimHcGetCapability (\r
  IN     UINTN        Bar,\r
  OUT SD_HC_SLOT_CAP  *Capability\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINT64      Cap;\r
\r
  Status = SdPeimHcRwMmio (Bar + SD_HC_CAP, TRUE, sizeof (Cap), &Cap);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  CopyMem (Capability, &Cap, sizeof (Cap));\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Detect whether there is a SD card attached at the specified SD host controller\r
  slot.\r
\r
  Refer to SD Host Controller Simplified spec 3.0 Section 3.1 for details.\r
\r
  @param[in]  Bar           The mmio base address of the slot to be accessed.\r
\r
  @retval EFI_SUCCESS       There is a SD card attached.\r
  @retval EFI_NO_MEDIA      There is not a SD card attached.\r
  @retval Others            The detection fails.\r
\r
**/\r
EFI_STATUS\r
SdPeimHcCardDetect (\r
  IN UINTN  Bar\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINT16      Data;\r
  UINT32      PresentState;\r
\r
  //\r
  // Check Normal Interrupt Status Register\r
  //\r
  Status = SdPeimHcRwMmio (Bar + SD_HC_NOR_INT_STS, TRUE, sizeof (Data), &Data);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if ((Data & (BIT6 | BIT7)) != 0) {\r
    //\r
    // Clear BIT6 and BIT7 by writing 1 to these two bits if set.\r
    //\r
    Data  &= BIT6 | BIT7;\r
    Status = SdPeimHcRwMmio (Bar + SD_HC_NOR_INT_STS, FALSE, sizeof (Data), &Data);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  }\r
\r
  //\r
  // Check Present State Register to see if there is a card presented.\r
  //\r
  Status = SdPeimHcRwMmio (Bar + SD_HC_PRESENT_STATE, TRUE, sizeof (PresentState), &PresentState);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if ((PresentState & BIT16) != 0) {\r
    return EFI_SUCCESS;\r
  } else {\r
    return EFI_NO_MEDIA;\r
  }\r
}\r
\r
/**\r
  Stop SD card clock.\r
\r
  Refer to SD Host Controller Simplified spec 3.0 Section 3.2.2 for details.\r
\r
  @param[in]  Bar           The mmio base address of the slot to be accessed.\r
\r
  @retval EFI_SUCCESS       Succeed to stop SD clock.\r
  @retval Others            Fail to stop SD clock.\r
\r
**/\r
EFI_STATUS\r
SdPeimHcStopClock (\r
  IN UINTN  Bar\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINT32      PresentState;\r
  UINT16      ClockCtrl;\r
\r
  //\r
  // Ensure no SD transactions are occurring on the SD Bus by\r
  // waiting for Command Inhibit (DAT) and Command Inhibit (CMD)\r
  // in the Present State register to be 0.\r
  //\r
  Status = SdPeimHcWaitMmioSet (\r
             Bar + SD_HC_PRESENT_STATE,\r
             sizeof (PresentState),\r
             BIT0 | BIT1,\r
             0,\r
             SD_TIMEOUT\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Set SD Clock Enable in the Clock Control register to 0\r
  //\r
  ClockCtrl = (UINT16) ~BIT2;\r
  Status    = SdPeimHcAndMmio (Bar + SD_HC_CLOCK_CTRL, sizeof (ClockCtrl), &ClockCtrl);\r
\r
  return Status;\r
}\r
\r
/**\r
  SD card clock supply.\r
\r
  Refer to SD Host Controller Simplified spec 3.0 Section 3.2.1 for details.\r
\r
  @param[in] Bar            The mmio base address of the slot to be accessed.\r
  @param[in] ClockFreq      The max clock frequency to be set. The unit is KHz.\r
\r
  @retval EFI_SUCCESS       The clock is supplied successfully.\r
  @retval Others            The clock isn't supplied successfully.\r
\r
**/\r
EFI_STATUS\r
SdPeimHcClockSupply (\r
  IN UINTN   Bar,\r
  IN UINT64  ClockFreq\r
  )\r
{\r
  EFI_STATUS      Status;\r
  SD_HC_SLOT_CAP  Capability;\r
  UINT32          BaseClkFreq;\r
  UINT32          SettingFreq;\r
  UINT32          Divisor;\r
  UINT32          Remainder;\r
  UINT16          ControllerVer;\r
  UINT16          ClockCtrl;\r
\r
  //\r
  // Calculate a divisor for SD clock frequency\r
  //\r
  Status = SdPeimHcGetCapability (Bar, &Capability);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  ASSERT (Capability.BaseClkFreq != 0);\r
\r
  BaseClkFreq = Capability.BaseClkFreq;\r
\r
  if (ClockFreq == 0) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (ClockFreq > (BaseClkFreq * 1000)) {\r
    ClockFreq = BaseClkFreq * 1000;\r
  }\r
\r
  //\r
  // Calculate the divisor of base frequency.\r
  //\r
  Divisor     = 0;\r
  SettingFreq = BaseClkFreq * 1000;\r
  while (ClockFreq < SettingFreq) {\r
    Divisor++;\r
\r
    SettingFreq = (BaseClkFreq * 1000) / (2 * Divisor);\r
    Remainder   = (BaseClkFreq * 1000) % (2 * Divisor);\r
    if ((ClockFreq == SettingFreq) && (Remainder == 0)) {\r
      break;\r
    }\r
\r
    if ((ClockFreq == SettingFreq) && (Remainder != 0)) {\r
      SettingFreq++;\r
    }\r
  }\r
\r
  DEBUG ((DEBUG_INFO, "BaseClkFreq %dMHz Divisor %d ClockFreq %dKhz\n", BaseClkFreq, Divisor, ClockFreq));\r
\r
  Status = SdPeimHcRwMmio (Bar + SD_HC_CTRL_VER, TRUE, sizeof (ControllerVer), &ControllerVer);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Set SDCLK Frequency Select and Internal Clock Enable fields in Clock Control register.\r
  //\r
  if ((ControllerVer & 0xFF) == 2) {\r
    ASSERT (Divisor <= 0x3FF);\r
    ClockCtrl = ((Divisor & 0xFF) << 8) | ((Divisor & 0x300) >> 2);\r
  } else if (((ControllerVer & 0xFF) == 0) || ((ControllerVer & 0xFF) == 1)) {\r
    //\r
    // Only the most significant bit can be used as divisor.\r
    //\r
    if (((Divisor - 1) & Divisor) != 0) {\r
      Divisor = 1 << (HighBitSet32 (Divisor) + 1);\r
    }\r
\r
    ASSERT (Divisor <= 0x80);\r
    ClockCtrl = (Divisor & 0xFF) << 8;\r
  } else {\r
    DEBUG ((DEBUG_ERROR, "Unknown SD Host Controller Spec version [0x%x]!!!\n", ControllerVer));\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Stop bus clock at first\r
  //\r
  Status = SdPeimHcStopClock (Bar);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Supply clock frequency with specified divisor\r
  //\r
  ClockCtrl |= BIT0;\r
  Status     = SdPeimHcRwMmio (Bar + SD_HC_CLOCK_CTRL, FALSE, sizeof (ClockCtrl), &ClockCtrl);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "Set SDCLK Frequency Select and Internal Clock Enable fields fails\n"));\r
    return Status;\r
  }\r
\r
  //\r
  // Wait Internal Clock Stable in the Clock Control register to be 1\r
  //\r
  Status = SdPeimHcWaitMmioSet (\r
             Bar + SD_HC_CLOCK_CTRL,\r
             sizeof (ClockCtrl),\r
             BIT1,\r
             BIT1,\r
             SD_TIMEOUT\r
             );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Set SD Clock Enable in the Clock Control register to 1\r
  //\r
  ClockCtrl = BIT2;\r
  Status    = SdPeimHcOrMmio (Bar + SD_HC_CLOCK_CTRL, sizeof (ClockCtrl), &ClockCtrl);\r
\r
  return Status;\r
}\r
\r
/**\r
  SD bus power control.\r
\r
  Refer to SD Host Controller Simplified spec 3.0 Section 3.3 for details.\r
\r
  @param[in] Bar            The mmio base address of the slot to be accessed.\r
  @param[in] PowerCtrl      The value setting to the power control register.\r
\r
  @retval TRUE              There is a SD card attached.\r
  @retval FALSE             There is no a SD card attached.\r
\r
**/\r
EFI_STATUS\r
SdPeimHcPowerControl (\r
  IN UINTN  Bar,\r
  IN UINT8  PowerCtrl\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // Clr SD Bus Power\r
  //\r
  PowerCtrl &= (UINT8) ~BIT0;\r
  Status     = SdPeimHcRwMmio (Bar + SD_HC_POWER_CTRL, FALSE, sizeof (PowerCtrl), &PowerCtrl);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Set SD Bus Voltage Select and SD Bus Power fields in Power Control Register\r
  //\r
  PowerCtrl |= BIT0;\r
  Status     = SdPeimHcRwMmio (Bar + SD_HC_POWER_CTRL, FALSE, sizeof (PowerCtrl), &PowerCtrl);\r
\r
  return Status;\r
}\r
\r
/**\r
  Set the SD bus width.\r
\r
  Refer to SD Host Controller Simplified spec 3.0 Section 3.4 for details.\r
\r
  @param[in] Bar            The mmio base address of the slot to be accessed.\r
  @param[in] BusWidth       The bus width used by the SD device, it must be 1, 4 or 8.\r
\r
  @retval EFI_SUCCESS       The bus width is set successfully.\r
  @retval Others            The bus width isn't set successfully.\r
\r
**/\r
EFI_STATUS\r
SdPeimHcSetBusWidth (\r
  IN UINTN   Bar,\r
  IN UINT16  BusWidth\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINT8       HostCtrl1;\r
\r
  if (BusWidth == 1) {\r
    HostCtrl1 = (UINT8) ~(BIT5 | BIT1);\r
    Status    = SdPeimHcAndMmio (Bar + SD_HC_HOST_CTRL1, sizeof (HostCtrl1), &HostCtrl1);\r
  } else if (BusWidth == 4) {\r
    Status = SdPeimHcRwMmio (Bar + SD_HC_HOST_CTRL1, TRUE, sizeof (HostCtrl1), &HostCtrl1);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    HostCtrl1 |= BIT1;\r
    HostCtrl1 &= (UINT8) ~BIT5;\r
    Status     = SdPeimHcRwMmio (Bar + SD_HC_HOST_CTRL1, FALSE, sizeof (HostCtrl1), &HostCtrl1);\r
  } else if (BusWidth == 8) {\r
    Status = SdPeimHcRwMmio (Bar + SD_HC_HOST_CTRL1, TRUE, sizeof (HostCtrl1), &HostCtrl1);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    HostCtrl1 &= (UINT8) ~BIT1;\r
    HostCtrl1 |= BIT5;\r
    Status     = SdPeimHcRwMmio (Bar + SD_HC_HOST_CTRL1, FALSE, sizeof (HostCtrl1), &HostCtrl1);\r
  } else {\r
    ASSERT (FALSE);\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Supply SD card with lowest clock frequency at initialization.\r
\r
  @param[in] Bar            The mmio base address of the slot to be accessed.\r
\r
  @retval EFI_SUCCESS       The clock is supplied successfully.\r
  @retval Others            The clock isn't supplied successfully.\r
\r
**/\r
EFI_STATUS\r
SdPeimHcInitClockFreq (\r
  IN UINTN  Bar\r
  )\r
{\r
  EFI_STATUS      Status;\r
  SD_HC_SLOT_CAP  Capability;\r
  UINT32          InitFreq;\r
\r
  //\r
  // Calculate a divisor for SD clock frequency\r
  //\r
  Status = SdPeimHcGetCapability (Bar, &Capability);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (Capability.BaseClkFreq == 0) {\r
    //\r
    // Don't support get Base Clock Frequency information via another method\r
    //\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Supply 400KHz clock frequency at initialization phase.\r
  //\r
  InitFreq = 400;\r
  Status   = SdPeimHcClockSupply (Bar, InitFreq);\r
  return Status;\r
}\r
\r
/**\r
  Supply SD card with maximum voltage at initialization.\r
\r
  Refer to SD Host Controller Simplified spec 3.0 Section 3.3 for details.\r
\r
  @param[in] Bar            The mmio base address of the slot to be accessed.\r
\r
  @retval EFI_SUCCESS       The voltage is supplied successfully.\r
  @retval Others            The voltage isn't supplied successfully.\r
\r
**/\r
EFI_STATUS\r
SdPeimHcInitPowerVoltage (\r
  IN UINTN  Bar\r
  )\r
{\r
  EFI_STATUS      Status;\r
  SD_HC_SLOT_CAP  Capability;\r
  UINT8           MaxVoltage;\r
  UINT8           HostCtrl2;\r
\r
  //\r
  // Get the support voltage of the Host Controller\r
  //\r
  Status = SdPeimHcGetCapability (Bar, &Capability);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Calculate supported maximum voltage according to SD Bus Voltage Select\r
  //\r
  if (Capability.Voltage33 != 0) {\r
    //\r
    // Support 3.3V\r
    //\r
    MaxVoltage = 0x0E;\r
  } else if (Capability.Voltage30 != 0) {\r
    //\r
    // Support 3.0V\r
    //\r
    MaxVoltage = 0x0C;\r
  } else if (Capability.Voltage18 != 0) {\r
    //\r
    // Support 1.8V\r
    //\r
    MaxVoltage = 0x0A;\r
    HostCtrl2  = BIT3;\r
    Status     = SdPeimHcOrMmio (Bar + SD_HC_HOST_CTRL2, sizeof (HostCtrl2), &HostCtrl2);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    MicroSecondDelay (5000);\r
  } else {\r
    ASSERT (FALSE);\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  //\r
  // Set SD Bus Voltage Select and SD Bus Power fields in Power Control Register\r
  //\r
  Status = SdPeimHcPowerControl (Bar, MaxVoltage);\r
\r
  return Status;\r
}\r
\r
/**\r
  Initialize the Timeout Control register with most conservative value at initialization.\r
\r
  Refer to SD Host Controller Simplified spec 3.0 Section 2.2.15 for details.\r
\r
  @param[in] Bar            The mmio base address of the slot to be accessed.\r
\r
  @retval EFI_SUCCESS       The timeout control register is configured successfully.\r
  @retval Others            The timeout control register isn't configured successfully.\r
\r
**/\r
EFI_STATUS\r
SdPeimHcInitTimeoutCtrl (\r
  IN UINTN  Bar\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINT8       Timeout;\r
\r
  Timeout = 0x0E;\r
  Status  = SdPeimHcRwMmio (Bar + SD_HC_TIMEOUT_CTRL, FALSE, sizeof (Timeout), &Timeout);\r
\r
  return Status;\r
}\r
\r
/**\r
  Initial SD host controller with lowest clock frequency, max power and max timeout value\r
  at initialization.\r
\r
  @param[in] Bar            The mmio base address of the slot to be accessed.\r
\r
  @retval EFI_SUCCESS       The host controller is initialized successfully.\r
  @retval Others            The host controller isn't initialized successfully.\r
\r
**/\r
EFI_STATUS\r
SdPeimHcInitHost (\r
  IN UINTN  Bar\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  Status = SdPeimHcInitClockFreq (Bar);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = SdPeimHcInitPowerVoltage (Bar);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = SdPeimHcInitTimeoutCtrl (Bar);\r
  return Status;\r
}\r
\r
/**\r
  Turn on/off LED.\r
\r
  @param[in] Bar            The mmio base address of the slot to be accessed.\r
  @param[in] On             The boolean to turn on/off LED.\r
\r
  @retval EFI_SUCCESS       The LED is turned on/off successfully.\r
  @retval Others            The LED isn't turned on/off successfully.\r
\r
**/\r
EFI_STATUS\r
SdPeimHcLedOnOff (\r
  IN UINTN    Bar,\r
  IN BOOLEAN  On\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINT8       HostCtrl1;\r
\r
  if (On) {\r
    HostCtrl1 = BIT0;\r
    Status    = SdPeimHcOrMmio (Bar + SD_HC_HOST_CTRL1, sizeof (HostCtrl1), &HostCtrl1);\r
  } else {\r
    HostCtrl1 = (UINT8) ~BIT0;\r
    Status    = SdPeimHcAndMmio (Bar + SD_HC_HOST_CTRL1, sizeof (HostCtrl1), &HostCtrl1);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Build ADMA descriptor table for transfer.\r
\r
  Refer to SD Host Controller Simplified spec 3.0 Section 1.13 for details.\r
\r
  @param[in] Trb            The pointer to the SD_TRB instance.\r
\r
  @retval EFI_SUCCESS       The ADMA descriptor table is created successfully.\r
  @retval Others            The ADMA descriptor table isn't created successfully.\r
\r
**/\r
EFI_STATUS\r
BuildAdmaDescTable (\r
  IN SD_TRB  *Trb\r
  )\r
{\r
  EFI_PHYSICAL_ADDRESS  Data;\r
  UINT64                DataLen;\r
  UINT64                Entries;\r
  UINT32                Index;\r
  UINT64                Remaining;\r
  UINT32                Address;\r
\r
  Data    = Trb->DataPhy;\r
  DataLen = Trb->DataLen;\r
  //\r
  // Only support 32bit ADMA Descriptor Table\r
  //\r
  if ((Data >= 0x100000000ul) || ((Data + DataLen) > 0x100000000ul)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Address field shall be set on 32-bit boundary (Lower 2-bit is always set to 0)\r
  // for 32-bit address descriptor table.\r
  //\r
  if ((Data & (BIT0 | BIT1)) != 0) {\r
    DEBUG ((DEBUG_INFO, "The buffer [0x%x] to construct ADMA desc is not aligned to 4 bytes boundary!\n", Data));\r
  }\r
\r
  Entries = DivU64x32 ((DataLen + ADMA_MAX_DATA_PER_LINE - 1), ADMA_MAX_DATA_PER_LINE);\r
\r
  Trb->AdmaDescSize = (UINTN)MultU64x32 (Entries, sizeof (SD_HC_ADMA_DESC_LINE));\r
  Trb->AdmaDesc     = SdPeimAllocateMem (Trb->Slot->Private->Pool, Trb->AdmaDescSize);\r
  if (Trb->AdmaDesc == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Remaining = DataLen;\r
  Address   = (UINT32)Data;\r
  for (Index = 0; Index < Entries; Index++) {\r
    if (Remaining <= ADMA_MAX_DATA_PER_LINE) {\r
      Trb->AdmaDesc[Index].Valid   = 1;\r
      Trb->AdmaDesc[Index].Act     = 2;\r
      Trb->AdmaDesc[Index].Length  = (UINT16)Remaining;\r
      Trb->AdmaDesc[Index].Address = Address;\r
      break;\r
    } else {\r
      Trb->AdmaDesc[Index].Valid   = 1;\r
      Trb->AdmaDesc[Index].Act     = 2;\r
      Trb->AdmaDesc[Index].Length  = 0;\r
      Trb->AdmaDesc[Index].Address = Address;\r
    }\r
\r
    Remaining -= ADMA_MAX_DATA_PER_LINE;\r
    Address   += ADMA_MAX_DATA_PER_LINE;\r
  }\r
\r
  //\r
  // Set the last descriptor line as end of descriptor table\r
  //\r
  Trb->AdmaDesc[Index].End = 1;\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Create a new TRB for the SD cmd request.\r
\r
  @param[in] Slot           The slot number of the SD card to send the command to.\r
  @param[in] Packet         A pointer to the SD command data structure.\r
\r
  @return Created Trb or NULL.\r
\r
**/\r
SD_TRB *\r
SdPeimCreateTrb (\r
  IN SD_PEIM_HC_SLOT    *Slot,\r
  IN SD_COMMAND_PACKET  *Packet\r
  )\r
{\r
  SD_TRB                 *Trb;\r
  EFI_STATUS             Status;\r
  SD_HC_SLOT_CAP         Capability;\r
  EDKII_IOMMU_OPERATION  MapOp;\r
  UINTN                  MapLength;\r
\r
  //\r
  // Calculate a divisor for SD clock frequency\r
  //\r
  Status = SdPeimHcGetCapability (Slot->SdHcBase, &Capability);\r
  if (EFI_ERROR (Status)) {\r
    return NULL;\r
  }\r
\r
  Trb = AllocateZeroPool (sizeof (SD_TRB));\r
  if (Trb == NULL) {\r
    return NULL;\r
  }\r
\r
  Trb->Slot      = Slot;\r
  Trb->BlockSize = 0x200;\r
  Trb->Packet    = Packet;\r
  Trb->Timeout   = Packet->Timeout;\r
\r
  if ((Packet->InTransferLength != 0) && (Packet->InDataBuffer != NULL)) {\r
    Trb->Data    = Packet->InDataBuffer;\r
    Trb->DataLen = Packet->InTransferLength;\r
    Trb->Read    = TRUE;\r
  } else if ((Packet->OutTransferLength != 0) && (Packet->OutDataBuffer != NULL)) {\r
    Trb->Data    = Packet->OutDataBuffer;\r
    Trb->DataLen = Packet->OutTransferLength;\r
    Trb->Read    = FALSE;\r
  } else if ((Packet->InTransferLength == 0) && (Packet->OutTransferLength == 0)) {\r
    Trb->Data    = NULL;\r
    Trb->DataLen = 0;\r
  } else {\r
    goto Error;\r
  }\r
\r
  if ((Trb->DataLen != 0) && (Trb->DataLen < Trb->BlockSize)) {\r
    Trb->BlockSize = (UINT16)Trb->DataLen;\r
  }\r
\r
  if (Packet->SdCmdBlk->CommandIndex == SD_SEND_TUNING_BLOCK) {\r
    Trb->Mode = SdPioMode;\r
  } else {\r
    if (Trb->Read) {\r
      MapOp = EdkiiIoMmuOperationBusMasterWrite;\r
    } else {\r
      MapOp = EdkiiIoMmuOperationBusMasterRead;\r
    }\r
\r
    if (Trb->DataLen != 0) {\r
      MapLength = Trb->DataLen;\r
      Status    = IoMmuMap (MapOp, Trb->Data, &MapLength, &Trb->DataPhy, &Trb->DataMap);\r
\r
      if (EFI_ERROR (Status) || (MapLength != Trb->DataLen)) {\r
        DEBUG ((DEBUG_ERROR, "SdPeimCreateTrb: Fail to map data buffer.\n"));\r
        goto Error;\r
      }\r
    }\r
\r
    if (Trb->DataLen == 0) {\r
      Trb->Mode = SdNoData;\r
    } else if (Capability.Adma2 != 0) {\r
      Trb->Mode = SdAdmaMode;\r
      Status    = BuildAdmaDescTable (Trb);\r
      if (EFI_ERROR (Status)) {\r
        goto Error;\r
      }\r
    } else if (Capability.Sdma != 0) {\r
      Trb->Mode = SdSdmaMode;\r
    } else {\r
      Trb->Mode = SdPioMode;\r
    }\r
  }\r
\r
  return Trb;\r
\r
Error:\r
  SdPeimFreeTrb (Trb);\r
  return NULL;\r
}\r
\r
/**\r
  Free the resource used by the TRB.\r
\r
  @param[in] Trb        The pointer to the SD_TRB instance.\r
\r
**/\r
VOID\r
SdPeimFreeTrb (\r
  IN SD_TRB  *Trb\r
  )\r
{\r
  if ((Trb != NULL) && (Trb->DataMap != NULL)) {\r
    IoMmuUnmap (Trb->DataMap);\r
  }\r
\r
  if ((Trb != NULL) && (Trb->AdmaDesc != NULL)) {\r
    SdPeimFreeMem (Trb->Slot->Private->Pool, Trb->AdmaDesc, Trb->AdmaDescSize);\r
  }\r
\r
  if (Trb != NULL) {\r
    FreePool (Trb);\r
  }\r
\r
  return;\r
}\r
\r
/**\r
  Check if the env is ready for execute specified TRB.\r
\r
  @param[in] Bar            The mmio base address of the slot to be accessed.\r
  @param[in] Trb            The pointer to the SD_TRB instance.\r
\r
  @retval EFI_SUCCESS       The env is ready for TRB execution.\r
  @retval EFI_NOT_READY     The env is not ready for TRB execution.\r
  @retval Others            Some erros happen.\r
\r
**/\r
EFI_STATUS\r
SdPeimCheckTrbEnv (\r
  IN UINTN   Bar,\r
  IN SD_TRB  *Trb\r
  )\r
{\r
  EFI_STATUS         Status;\r
  SD_COMMAND_PACKET  *Packet;\r
  UINT32             PresentState;\r
\r
  Packet = Trb->Packet;\r
\r
  if ((Packet->SdCmdBlk->CommandType == SdCommandTypeAdtc) ||\r
      (Packet->SdCmdBlk->ResponseType == SdResponseTypeR1b) ||\r
      (Packet->SdCmdBlk->ResponseType == SdResponseTypeR5b))\r
  {\r
    //\r
    // Wait Command Inhibit (CMD) and Command Inhibit (DAT) in\r
    // the Present State register to be 0\r
    //\r
    PresentState = BIT0 | BIT1;\r
  } else {\r
    //\r
    // Wait Command Inhibit (CMD) in the Present State register\r
    // to be 0\r
    //\r
    PresentState = BIT0;\r
  }\r
\r
  Status = SdPeimHcCheckMmioSet (\r
             Bar + SD_HC_PRESENT_STATE,\r
             sizeof (PresentState),\r
             PresentState,\r
             0\r
             );\r
\r
  return Status;\r
}\r
\r
/**\r
  Wait for the env to be ready for execute specified TRB.\r
\r
  @param[in] Bar            The mmio base address of the slot to be accessed.\r
  @param[in] Trb            The pointer to the SD_TRB instance.\r
\r
  @retval EFI_SUCCESS       The env is ready for TRB execution.\r
  @retval EFI_TIMEOUT       The env is not ready for TRB execution in time.\r
  @retval Others            Some erros happen.\r
\r
**/\r
EFI_STATUS\r
SdPeimWaitTrbEnv (\r
  IN UINTN   Bar,\r
  IN SD_TRB  *Trb\r
  )\r
{\r
  EFI_STATUS         Status;\r
  SD_COMMAND_PACKET  *Packet;\r
  UINT64             Timeout;\r
  BOOLEAN            InfiniteWait;\r
\r
  //\r
  // Wait Command Complete Interrupt Status bit in Normal Interrupt Status Register\r
  //\r
  Packet  = Trb->Packet;\r
  Timeout = Packet->Timeout;\r
  if (Timeout == 0) {\r
    InfiniteWait = TRUE;\r
  } else {\r
    InfiniteWait = FALSE;\r
  }\r
\r
  while (InfiniteWait || (Timeout > 0)) {\r
    //\r
    // Check Trb execution result by reading Normal Interrupt Status register.\r
    //\r
    Status = SdPeimCheckTrbEnv (Bar, Trb);\r
    if (Status != EFI_NOT_READY) {\r
      return Status;\r
    }\r
\r
    //\r
    // Stall for 1 microsecond.\r
    //\r
    MicroSecondDelay (1);\r
\r
    Timeout--;\r
  }\r
\r
  return EFI_TIMEOUT;\r
}\r
\r
/**\r
  Execute the specified TRB.\r
\r
  @param[in] Bar            The mmio base address of the slot to be accessed.\r
  @param[in] Trb            The pointer to the SD_TRB instance.\r
\r
  @retval EFI_SUCCESS       The TRB is sent to host controller successfully.\r
  @retval Others            Some erros happen when sending this request to the host controller.\r
\r
**/\r
EFI_STATUS\r
SdPeimExecTrb (\r
  IN UINTN   Bar,\r
  IN SD_TRB  *Trb\r
  )\r
{\r
  EFI_STATUS         Status;\r
  SD_COMMAND_PACKET  *Packet;\r
  UINT16             Cmd;\r
  UINT16             IntStatus;\r
  UINT32             Argument;\r
  UINT16             BlkCount;\r
  UINT16             BlkSize;\r
  UINT16             TransMode;\r
  UINT8              HostCtrl1;\r
  UINT32             SdmaAddr;\r
  UINT64             AdmaAddr;\r
\r
  Packet = Trb->Packet;\r
  //\r
  // Clear all bits in Error Interrupt Status Register\r
  //\r
  IntStatus = 0xFFFF;\r
  Status    = SdPeimHcRwMmio (Bar + SD_HC_ERR_INT_STS, FALSE, sizeof (IntStatus), &IntStatus);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Clear all bits in Normal Interrupt Status Register\r
  //\r
  IntStatus = 0xFFFF;\r
  Status    = SdPeimHcRwMmio (Bar + SD_HC_NOR_INT_STS, FALSE, sizeof (IntStatus), &IntStatus);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Set Host Control 1 register DMA Select field\r
  //\r
  if (Trb->Mode == SdAdmaMode) {\r
    HostCtrl1 = BIT4;\r
    Status    = SdPeimHcOrMmio (Bar + SD_HC_HOST_CTRL1, sizeof (HostCtrl1), &HostCtrl1);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  }\r
\r
  SdPeimHcLedOnOff (Bar, TRUE);\r
\r
  if (Trb->Mode == SdSdmaMode) {\r
    if ((UINT64)(UINTN)Trb->DataPhy >= 0x100000000ul) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    SdmaAddr = (UINT32)(UINTN)Trb->DataPhy;\r
    Status   = SdPeimHcRwMmio (Bar + SD_HC_SDMA_ADDR, FALSE, sizeof (SdmaAddr), &SdmaAddr);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  } else if (Trb->Mode == SdAdmaMode) {\r
    AdmaAddr = (UINT64)(UINTN)Trb->AdmaDesc;\r
    Status   = SdPeimHcRwMmio (Bar + SD_HC_ADMA_SYS_ADDR, FALSE, sizeof (AdmaAddr), &AdmaAddr);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  }\r
\r
  BlkSize = Trb->BlockSize;\r
  if (Trb->Mode == SdSdmaMode) {\r
    //\r
    // Set SDMA boundary to be 512K bytes.\r
    //\r
    BlkSize |= 0x7000;\r
  }\r
\r
  Status = SdPeimHcRwMmio (Bar + SD_HC_BLK_SIZE, FALSE, sizeof (BlkSize), &BlkSize);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  BlkCount = 0;\r
  if (Trb->Mode != SdNoData) {\r
    //\r
    // Calculate Block Count.\r
    //\r
    BlkCount = (UINT16)(Trb->DataLen / Trb->BlockSize);\r
  }\r
\r
  Status = SdPeimHcRwMmio (Bar + SD_HC_BLK_COUNT, FALSE, sizeof (BlkCount), &BlkCount);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Argument = Packet->SdCmdBlk->CommandArgument;\r
  Status   = SdPeimHcRwMmio (Bar + SD_HC_ARG1, FALSE, sizeof (Argument), &Argument);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  TransMode = 0;\r
  if (Trb->Mode != SdNoData) {\r
    if (Trb->Mode != SdPioMode) {\r
      TransMode |= BIT0;\r
    }\r
\r
    if (Trb->Read) {\r
      TransMode |= BIT4;\r
    }\r
\r
    if (BlkCount > 1) {\r
      TransMode |= BIT5 | BIT1;\r
    }\r
\r
    //\r
    // SD memory card needs to use AUTO CMD12 feature.\r
    //\r
    if (BlkCount > 1) {\r
      TransMode |= BIT2;\r
    }\r
  }\r
\r
  Status = SdPeimHcRwMmio (Bar + SD_HC_TRANS_MOD, FALSE, sizeof (TransMode), &TransMode);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Cmd = (UINT16)LShiftU64 (Packet->SdCmdBlk->CommandIndex, 8);\r
  if (Packet->SdCmdBlk->CommandType == SdCommandTypeAdtc) {\r
    Cmd |= BIT5;\r
  }\r
\r
  //\r
  // Convert ResponseType to value\r
  //\r
  if (Packet->SdCmdBlk->CommandType != SdCommandTypeBc) {\r
    switch (Packet->SdCmdBlk->ResponseType) {\r
      case SdResponseTypeR1:\r
      case SdResponseTypeR5:\r
      case SdResponseTypeR6:\r
      case SdResponseTypeR7:\r
        Cmd |= (BIT1 | BIT3 | BIT4);\r
        break;\r
      case SdResponseTypeR2:\r
        Cmd |= (BIT0 | BIT3);\r
        break;\r
      case SdResponseTypeR3:\r
      case SdResponseTypeR4:\r
        Cmd |= BIT1;\r
        break;\r
      case SdResponseTypeR1b:\r
      case SdResponseTypeR5b:\r
        Cmd |= (BIT0 | BIT1 | BIT3 | BIT4);\r
        break;\r
      default:\r
        ASSERT (FALSE);\r
        break;\r
    }\r
  }\r
\r
  //\r
  // Execute cmd\r
  //\r
  Status = SdPeimHcRwMmio (Bar + SD_HC_COMMAND, FALSE, sizeof (Cmd), &Cmd);\r
  return Status;\r
}\r
\r
/**\r
  Check the TRB execution result.\r
\r
  @param[in] Bar            The mmio base address of the slot to be accessed.\r
  @param[in] Trb            The pointer to the SD_TRB instance.\r
\r
  @retval EFI_SUCCESS       The TRB is executed successfully.\r
  @retval EFI_NOT_READY     The TRB is not completed for execution.\r
  @retval Others            Some erros happen when executing this request.\r
\r
**/\r
EFI_STATUS\r
SdPeimCheckTrbResult (\r
  IN UINTN   Bar,\r
  IN SD_TRB  *Trb\r
  )\r
{\r
  EFI_STATUS         Status;\r
  SD_COMMAND_PACKET  *Packet;\r
  UINT16             IntStatus;\r
  UINT32             Response[4];\r
  UINT32             SdmaAddr;\r
  UINT8              Index;\r
  UINT8              SwReset;\r
  UINT32             PioLength;\r
\r
  SwReset = 0;\r
  Packet  = Trb->Packet;\r
  //\r
  // Check Trb execution result by reading Normal Interrupt Status register.\r
  //\r
  Status = SdPeimHcRwMmio (\r
             Bar + SD_HC_NOR_INT_STS,\r
             TRUE,\r
             sizeof (IntStatus),\r
             &IntStatus\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
\r
  //\r
  // Check Transfer Complete bit is set or not.\r
  //\r
  if ((IntStatus & BIT1) == BIT1) {\r
    if ((IntStatus & BIT15) == BIT15) {\r
      //\r
      // Read Error Interrupt Status register to check if the error is\r
      // Data Timeout Error.\r
      // If yes, treat it as success as Transfer Complete has higher\r
      // priority than Data Timeout Error.\r
      //\r
      Status = SdPeimHcRwMmio (\r
                 Bar + SD_HC_ERR_INT_STS,\r
                 TRUE,\r
                 sizeof (IntStatus),\r
                 &IntStatus\r
                 );\r
      if (!EFI_ERROR (Status)) {\r
        if ((IntStatus & BIT4) == BIT4) {\r
          Status = EFI_SUCCESS;\r
        } else {\r
          Status = EFI_DEVICE_ERROR;\r
        }\r
      }\r
    }\r
\r
    goto Done;\r
  }\r
\r
  //\r
  // Check if there is a error happened during cmd execution.\r
  // If yes, then do error recovery procedure to follow SD Host Controller\r
  // Simplified Spec 3.0 section 3.10.1.\r
  //\r
  if ((IntStatus & BIT15) == BIT15) {\r
    Status = SdPeimHcRwMmio (\r
               Bar + SD_HC_ERR_INT_STS,\r
               TRUE,\r
               sizeof (IntStatus),\r
               &IntStatus\r
               );\r
    if (EFI_ERROR (Status)) {\r
      goto Done;\r
    }\r
\r
    if ((IntStatus & 0x0F) != 0) {\r
      SwReset |= BIT1;\r
    }\r
\r
    if ((IntStatus & 0xF0) != 0) {\r
      SwReset |= BIT2;\r
    }\r
\r
    Status = SdPeimHcRwMmio (\r
               Bar + SD_HC_SW_RST,\r
               FALSE,\r
               sizeof (SwReset),\r
               &SwReset\r
               );\r
    if (EFI_ERROR (Status)) {\r
      goto Done;\r
    }\r
\r
    Status = SdPeimHcWaitMmioSet (\r
               Bar + SD_HC_SW_RST,\r
               sizeof (SwReset),\r
               0xFF,\r
               0,\r
               SD_TIMEOUT\r
               );\r
    if (EFI_ERROR (Status)) {\r
      goto Done;\r
    }\r
\r
    Status = EFI_DEVICE_ERROR;\r
    goto Done;\r
  }\r
\r
  //\r
  // Check if DMA interrupt is signalled for the SDMA transfer.\r
  //\r
  if ((Trb->Mode == SdSdmaMode) && ((IntStatus & BIT3) == BIT3)) {\r
    //\r
    // Clear DMA interrupt bit.\r
    //\r
    IntStatus = BIT3;\r
    Status    = SdPeimHcRwMmio (\r
                  Bar + SD_HC_NOR_INT_STS,\r
                  FALSE,\r
                  sizeof (IntStatus),\r
                  &IntStatus\r
                  );\r
    if (EFI_ERROR (Status)) {\r
      goto Done;\r
    }\r
\r
    //\r
    // Update SDMA Address register.\r
    //\r
    SdmaAddr = SD_SDMA_ROUND_UP ((UINT32)(UINTN)Trb->DataPhy, SD_SDMA_BOUNDARY);\r
    Status   = SdPeimHcRwMmio (\r
                 Bar + SD_HC_SDMA_ADDR,\r
                 FALSE,\r
                 sizeof (UINT32),\r
                 &SdmaAddr\r
                 );\r
    if (EFI_ERROR (Status)) {\r
      goto Done;\r
    }\r
\r
    Trb->DataPhy = (UINT32)(UINTN)SdmaAddr;\r
  }\r
\r
  if ((Packet->SdCmdBlk->CommandType != SdCommandTypeAdtc) &&\r
      (Packet->SdCmdBlk->ResponseType != SdResponseTypeR1b) &&\r
      (Packet->SdCmdBlk->ResponseType != SdResponseTypeR5b))\r
  {\r
    if ((IntStatus & BIT0) == BIT0) {\r
      Status = EFI_SUCCESS;\r
      goto Done;\r
    }\r
  }\r
\r
  if (Packet->SdCmdBlk->CommandIndex == SD_SEND_TUNING_BLOCK) {\r
    //\r
    // When performing tuning procedure (Execute Tuning is set to 1) through PIO mode,\r
    // wait Buffer Read Ready bit of Normal Interrupt Status Register to be 1.\r
    // Refer to SD Host Controller Simplified Specification 3.0 figure 2-29 for details.\r
    //\r
    if ((IntStatus & BIT5) == BIT5) {\r
      //\r
      // Clear Buffer Read Ready interrupt at first.\r
      //\r
      IntStatus = BIT5;\r
      SdPeimHcRwMmio (Bar + SD_HC_NOR_INT_STS, FALSE, sizeof (IntStatus), &IntStatus);\r
      //\r
      // Read data out from Buffer Port register\r
      //\r
      for (PioLength = 0; PioLength < Trb->DataLen; PioLength += 4) {\r
        SdPeimHcRwMmio (Bar + SD_HC_BUF_DAT_PORT, TRUE, 4, (UINT8 *)Trb->Data + PioLength);\r
      }\r
\r
      Status = EFI_SUCCESS;\r
      goto Done;\r
    }\r
  }\r
\r
  Status = EFI_NOT_READY;\r
Done:\r
  //\r
  // Get response data when the cmd is executed successfully.\r
  //\r
  if (!EFI_ERROR (Status)) {\r
    if (Packet->SdCmdBlk->CommandType != SdCommandTypeBc) {\r
      for (Index = 0; Index < 4; Index++) {\r
        Status = SdPeimHcRwMmio (\r
                   Bar + SD_HC_RESPONSE + Index * 4,\r
                   TRUE,\r
                   sizeof (UINT32),\r
                   &Response[Index]\r
                   );\r
        if (EFI_ERROR (Status)) {\r
          SdPeimHcLedOnOff (Bar, FALSE);\r
          return Status;\r
        }\r
      }\r
\r
      CopyMem (Packet->SdStatusBlk, Response, sizeof (Response));\r
    }\r
  }\r
\r
  if (Status != EFI_NOT_READY) {\r
    SdPeimHcLedOnOff (Bar, FALSE);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Wait for the TRB execution result.\r
\r
  @param[in] Bar            The mmio base address of the slot to be accessed.\r
  @param[in] Trb            The pointer to the SD_TRB instance.\r
\r
  @retval EFI_SUCCESS       The TRB is executed successfully.\r
  @retval Others            Some erros happen when executing this request.\r
\r
**/\r
EFI_STATUS\r
SdPeimWaitTrbResult (\r
  IN UINTN   Bar,\r
  IN SD_TRB  *Trb\r
  )\r
{\r
  EFI_STATUS         Status;\r
  SD_COMMAND_PACKET  *Packet;\r
  UINT64             Timeout;\r
  BOOLEAN            InfiniteWait;\r
\r
  Packet = Trb->Packet;\r
  //\r
  // Wait Command Complete Interrupt Status bit in Normal Interrupt Status Register\r
  //\r
  Timeout = Packet->Timeout;\r
  if (Timeout == 0) {\r
    InfiniteWait = TRUE;\r
  } else {\r
    InfiniteWait = FALSE;\r
  }\r
\r
  while (InfiniteWait || (Timeout > 0)) {\r
    //\r
    // Check Trb execution result by reading Normal Interrupt Status register.\r
    //\r
    Status = SdPeimCheckTrbResult (Bar, Trb);\r
    if (Status != EFI_NOT_READY) {\r
      return Status;\r
    }\r
\r
    //\r
    // Stall for 1 microsecond.\r
    //\r
    MicroSecondDelay (1);\r
\r
    Timeout--;\r
  }\r
\r
  return EFI_TIMEOUT;\r
}\r
\r
/**\r
  Sends SD command to an SD card that is attached to the SD controller.\r
\r
  If Packet is successfully sent to the SD card, then EFI_SUCCESS is returned.\r
\r
  If a device error occurs while sending the Packet, then EFI_DEVICE_ERROR is returned.\r
\r
  If Slot is not in a valid range for the SD controller, then EFI_INVALID_PARAMETER\r
  is returned.\r
\r
  If Packet defines a data command but both InDataBuffer and OutDataBuffer are NULL,\r
  EFI_INVALID_PARAMETER is returned.\r
\r
  @param[in]     Slot           The slot number of the Sd card to send the command to.\r
  @param[in,out] Packet         A pointer to the SD command data structure.\r
\r
  @retval EFI_SUCCESS           The SD Command Packet was sent by the host.\r
  @retval EFI_DEVICE_ERROR      A device error occurred while attempting to send the SD\r
                                command Packet.\r
  @retval EFI_INVALID_PARAMETER Packet, Slot, or the contents of the Packet is invalid.\r
  @retval EFI_INVALID_PARAMETER Packet defines a data command but both InDataBuffer and\r
                                OutDataBuffer are NULL.\r
  @retval EFI_NO_MEDIA          SD Device not present in the Slot.\r
  @retval EFI_UNSUPPORTED       The command described by the SD Command Packet is not\r
                                supported by the host controller.\r
  @retval EFI_BAD_BUFFER_SIZE   The InTransferLength or OutTransferLength exceeds the\r
                                limit supported by SD card ( i.e. if the number of bytes\r
                                exceed the Last LBA).\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SdPeimExecCmd (\r
  IN     SD_PEIM_HC_SLOT    *Slot,\r
  IN OUT SD_COMMAND_PACKET  *Packet\r
  )\r
{\r
  EFI_STATUS  Status;\r
  SD_TRB      *Trb;\r
\r
  if (Packet == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if ((Packet->SdCmdBlk == NULL) || (Packet->SdStatusBlk == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if ((Packet->OutDataBuffer == NULL) && (Packet->OutTransferLength != 0)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if ((Packet->InDataBuffer == NULL) && (Packet->InTransferLength != 0)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Trb = SdPeimCreateTrb (Slot, Packet);\r
  if (Trb == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Status = SdPeimWaitTrbEnv (Slot->SdHcBase, Trb);\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
\r
  Status = SdPeimExecTrb (Slot->SdHcBase, Trb);\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
\r
  Status = SdPeimWaitTrbResult (Slot->SdHcBase, Trb);\r
  if (EFI_ERROR (Status)) {\r
    goto Done;\r
  }\r
\r
Done:\r
  SdPeimFreeTrb (Trb);\r
\r
  return Status;\r
}\r
\r
/**\r
  Send command GO_IDLE_STATE to the device to make it go to Idle State.\r
\r
  Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.\r
\r
  @param[in] Slot           The slot number of the SD card to send the command to.\r
\r
  @retval EFI_SUCCESS       The SD device is reset correctly.\r
  @retval Others            The device reset fails.\r
\r
**/\r
EFI_STATUS\r
SdPeimReset (\r
  IN SD_PEIM_HC_SLOT  *Slot\r
  )\r
{\r
  SD_COMMAND_BLOCK   SdCmdBlk;\r
  SD_STATUS_BLOCK    SdStatusBlk;\r
  SD_COMMAND_PACKET  Packet;\r
  EFI_STATUS         Status;\r
\r
  ZeroMem (&SdCmdBlk, sizeof (SdCmdBlk));\r
  ZeroMem (&SdStatusBlk, sizeof (SdStatusBlk));\r
  ZeroMem (&Packet, sizeof (Packet));\r
\r
  Packet.SdCmdBlk    = &SdCmdBlk;\r
  Packet.SdStatusBlk = &SdStatusBlk;\r
  Packet.Timeout     = SD_TIMEOUT;\r
\r
  SdCmdBlk.CommandIndex    = SD_GO_IDLE_STATE;\r
  SdCmdBlk.CommandType     = SdCommandTypeBc;\r
  SdCmdBlk.ResponseType    = 0;\r
  SdCmdBlk.CommandArgument = 0;\r
\r
  Status = SdPeimExecCmd (Slot, &Packet);\r
\r
  return Status;\r
}\r
\r
/**\r
  Send command SEND_IF_COND to the device to inquiry the SD Memory Card interface\r
  condition.\r
\r
  Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.\r
\r
  @param[in] Slot           The slot number of the SD card to send the command to.\r
  @param[in] SupplyVoltage  The supplied voltage by the host.\r
  @param[in] CheckPattern   The check pattern to be sent to the device.\r
\r
  @retval EFI_SUCCESS       The operation is done correctly.\r
  @retval Others            The operation fails.\r
\r
**/\r
EFI_STATUS\r
SdPeimVoltageCheck (\r
  IN SD_PEIM_HC_SLOT  *Slot,\r
  IN UINT8            SupplyVoltage,\r
  IN UINT8            CheckPattern\r
  )\r
{\r
  SD_COMMAND_BLOCK   SdCmdBlk;\r
  SD_STATUS_BLOCK    SdStatusBlk;\r
  SD_COMMAND_PACKET  Packet;\r
  EFI_STATUS         Status;\r
\r
  ZeroMem (&SdCmdBlk, sizeof (SdCmdBlk));\r
  ZeroMem (&SdStatusBlk, sizeof (SdStatusBlk));\r
  ZeroMem (&Packet, sizeof (Packet));\r
\r
  Packet.SdCmdBlk    = &SdCmdBlk;\r
  Packet.SdStatusBlk = &SdStatusBlk;\r
  Packet.Timeout     = SD_TIMEOUT;\r
\r
  SdCmdBlk.CommandIndex    = SD_SEND_IF_COND;\r
  SdCmdBlk.CommandType     = SdCommandTypeBcr;\r
  SdCmdBlk.ResponseType    = SdResponseTypeR7;\r
  SdCmdBlk.CommandArgument = (SupplyVoltage << 8) | CheckPattern;\r
\r
  Status = SdPeimExecCmd (Slot, &Packet);\r
  if (!EFI_ERROR (Status)) {\r
    if (SdStatusBlk.Resp0 != SdCmdBlk.CommandArgument) {\r
      return EFI_DEVICE_ERROR;\r
    }\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Send command SDIO_SEND_OP_COND to the device to see whether it is SDIO device.\r
\r
  Refer to SDIO Simplified Spec 3 Section 3.2 for details.\r
\r
  @param[in] Slot           The slot number of the SD card to send the command to.\r
  @param[in] VoltageWindow  The supply voltage window.\r
  @param[in] S18r           The boolean to show if it should switch to 1.8v.\r
\r
  @retval EFI_SUCCESS       The operation is done correctly.\r
  @retval Others            The operation fails.\r
\r
**/\r
EFI_STATUS\r
SdioSendOpCond (\r
  IN SD_PEIM_HC_SLOT  *Slot,\r
  IN UINT32           VoltageWindow,\r
  IN BOOLEAN          S18r\r
  )\r
{\r
  SD_COMMAND_BLOCK   SdCmdBlk;\r
  SD_STATUS_BLOCK    SdStatusBlk;\r
  SD_COMMAND_PACKET  Packet;\r
  EFI_STATUS         Status;\r
  UINT32             Switch;\r
\r
  ZeroMem (&SdCmdBlk, sizeof (SdCmdBlk));\r
  ZeroMem (&SdStatusBlk, sizeof (SdStatusBlk));\r
  ZeroMem (&Packet, sizeof (Packet));\r
\r
  Packet.SdCmdBlk    = &SdCmdBlk;\r
  Packet.SdStatusBlk = &SdStatusBlk;\r
  Packet.Timeout     = SD_TIMEOUT;\r
\r
  SdCmdBlk.CommandIndex = SDIO_SEND_OP_COND;\r
  SdCmdBlk.CommandType  = SdCommandTypeBcr;\r
  SdCmdBlk.ResponseType = SdResponseTypeR4;\r
\r
  Switch = S18r ? BIT24 : 0;\r
\r
  SdCmdBlk.CommandArgument = (VoltageWindow & 0xFFFFFF) | Switch;\r
\r
  Status = SdPeimExecCmd (Slot, &Packet);\r
\r
  return Status;\r
}\r
\r
/**\r
  Send command SD_SEND_OP_COND to the device to see whether it is SDIO device.\r
\r
  Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.\r
\r
  @param[in]  Slot           The slot number of the SD card to send the command to.\r
  @param[in]  Rca            The relative device address of addressed device.\r
  @param[in]  VoltageWindow  The supply voltage window.\r
  @param[in]  S18r           The boolean to show if it should switch to 1.8v.\r
  @param[in]  Xpc            The boolean to show if it should provide 0.36w power control.\r
  @param[in]  Hcs            The boolean to show if it support host capacity info.\r
  @param[out] Ocr            The buffer to store returned OCR register value.\r
\r
\r
  @retval EFI_SUCCESS       The operation is done correctly.\r
  @retval Others            The operation fails.\r
\r
**/\r
EFI_STATUS\r
SdPeimSendOpCond (\r
  IN     SD_PEIM_HC_SLOT  *Slot,\r
  IN     UINT16           Rca,\r
  IN     UINT32           VoltageWindow,\r
  IN     BOOLEAN          S18r,\r
  IN     BOOLEAN          Xpc,\r
  IN     BOOLEAN          Hcs,\r
  OUT UINT32              *Ocr\r
  )\r
{\r
  SD_COMMAND_BLOCK   SdCmdBlk;\r
  SD_STATUS_BLOCK    SdStatusBlk;\r
  SD_COMMAND_PACKET  Packet;\r
  EFI_STATUS         Status;\r
  UINT32             Switch;\r
  UINT32             MaxPower;\r
  UINT32             HostCapacity;\r
\r
  ZeroMem (&SdCmdBlk, sizeof (SdCmdBlk));\r
  ZeroMem (&SdStatusBlk, sizeof (SdStatusBlk));\r
  ZeroMem (&Packet, sizeof (Packet));\r
\r
  Packet.SdCmdBlk    = &SdCmdBlk;\r
  Packet.SdStatusBlk = &SdStatusBlk;\r
  Packet.Timeout     = SD_TIMEOUT;\r
\r
  SdCmdBlk.CommandIndex    = SD_APP_CMD;\r
  SdCmdBlk.CommandType     = SdCommandTypeAc;\r
  SdCmdBlk.ResponseType    = SdResponseTypeR1;\r
  SdCmdBlk.CommandArgument = (UINT32)Rca << 16;\r
\r
  Status = SdPeimExecCmd (Slot, &Packet);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  SdCmdBlk.CommandIndex = SD_SEND_OP_COND;\r
  SdCmdBlk.CommandType  = SdCommandTypeBcr;\r
  SdCmdBlk.ResponseType = SdResponseTypeR3;\r
\r
  Switch                   = S18r ? BIT24 : 0;\r
  MaxPower                 = Xpc ? BIT28 : 0;\r
  HostCapacity             = Hcs ? BIT30 : 0;\r
  SdCmdBlk.CommandArgument = (VoltageWindow & 0xFFFFFF) | Switch | MaxPower | HostCapacity;\r
\r
  Status = SdPeimExecCmd (Slot, &Packet);\r
  if (!EFI_ERROR (Status)) {\r
    //\r
    // For details, refer to SD Host Controller Simplified Spec 3.0 Table 2-12.\r
    //\r
    *Ocr = SdStatusBlk.Resp0;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Broadcast command ALL_SEND_CID to the bus to ask all the SD devices to send the\r
  data of their CID registers.\r
\r
  Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.\r
\r
  @param[in] Slot           The slot number of the SD card to send the command to.\r
\r
  @retval EFI_SUCCESS       The operation is done correctly.\r
  @retval Others            The operation fails.\r
\r
**/\r
EFI_STATUS\r
SdPeimAllSendCid (\r
  IN SD_PEIM_HC_SLOT  *Slot\r
  )\r
{\r
  SD_COMMAND_BLOCK   SdCmdBlk;\r
  SD_STATUS_BLOCK    SdStatusBlk;\r
  SD_COMMAND_PACKET  Packet;\r
  EFI_STATUS         Status;\r
\r
  ZeroMem (&SdCmdBlk, sizeof (SdCmdBlk));\r
  ZeroMem (&SdStatusBlk, sizeof (SdStatusBlk));\r
  ZeroMem (&Packet, sizeof (Packet));\r
\r
  Packet.SdCmdBlk    = &SdCmdBlk;\r
  Packet.SdStatusBlk = &SdStatusBlk;\r
  Packet.Timeout     = SD_TIMEOUT;\r
\r
  SdCmdBlk.CommandIndex    = SD_ALL_SEND_CID;\r
  SdCmdBlk.CommandType     = SdCommandTypeBcr;\r
  SdCmdBlk.ResponseType    = SdResponseTypeR2;\r
  SdCmdBlk.CommandArgument = 0;\r
\r
  Status = SdPeimExecCmd (Slot, &Packet);\r
\r
  return Status;\r
}\r
\r
/**\r
  Send command SET_RELATIVE_ADDR to the SD device to assign a Relative device\r
  Address (RCA).\r
\r
  Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.\r
\r
  @param[in]  Slot          The slot number of the SD card to send the command to.\r
  @param[out] Rca           The relative device address to be assigned.\r
\r
  @retval EFI_SUCCESS       The operation is done correctly.\r
  @retval Others            The operation fails.\r
\r
**/\r
EFI_STATUS\r
SdPeimSetRca (\r
  IN     SD_PEIM_HC_SLOT  *Slot,\r
  OUT UINT16              *Rca\r
  )\r
{\r
  SD_COMMAND_BLOCK   SdCmdBlk;\r
  SD_STATUS_BLOCK    SdStatusBlk;\r
  SD_COMMAND_PACKET  Packet;\r
  EFI_STATUS         Status;\r
\r
  ZeroMem (&SdCmdBlk, sizeof (SdCmdBlk));\r
  ZeroMem (&SdStatusBlk, sizeof (SdStatusBlk));\r
  ZeroMem (&Packet, sizeof (Packet));\r
\r
  Packet.SdCmdBlk    = &SdCmdBlk;\r
  Packet.SdStatusBlk = &SdStatusBlk;\r
  Packet.Timeout     = SD_TIMEOUT;\r
\r
  SdCmdBlk.CommandIndex = SD_SET_RELATIVE_ADDR;\r
  SdCmdBlk.CommandType  = SdCommandTypeBcr;\r
  SdCmdBlk.ResponseType = SdResponseTypeR6;\r
\r
  Status = SdPeimExecCmd (Slot, &Packet);\r
  if (!EFI_ERROR (Status)) {\r
    *Rca = (UINT16)(SdStatusBlk.Resp0 >> 16);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Send command SEND_CSD to the SD device to get the data of the CSD register.\r
\r
  Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.\r
\r
  @param[in]  Slot          The slot number of the SD card to send the command to.\r
  @param[in]  Rca           The relative device address of selected device.\r
  @param[out] Csd           The buffer to store the content of the CSD register.\r
                            Note the caller should ignore the lowest byte of this\r
                            buffer as the content of this byte is meaningless even\r
                            if the operation succeeds.\r
\r
  @retval EFI_SUCCESS       The operation is done correctly.\r
  @retval Others            The operation fails.\r
\r
**/\r
EFI_STATUS\r
SdPeimGetCsd (\r
  IN     SD_PEIM_HC_SLOT  *Slot,\r
  IN     UINT16           Rca,\r
  OUT SD_CSD              *Csd\r
  )\r
{\r
  SD_COMMAND_BLOCK   SdCmdBlk;\r
  SD_STATUS_BLOCK    SdStatusBlk;\r
  SD_COMMAND_PACKET  Packet;\r
  EFI_STATUS         Status;\r
\r
  ZeroMem (&SdCmdBlk, sizeof (SdCmdBlk));\r
  ZeroMem (&SdStatusBlk, sizeof (SdStatusBlk));\r
  ZeroMem (&Packet, sizeof (Packet));\r
\r
  Packet.SdCmdBlk    = &SdCmdBlk;\r
  Packet.SdStatusBlk = &SdStatusBlk;\r
  Packet.Timeout     = SD_TIMEOUT;\r
\r
  SdCmdBlk.CommandIndex    = SD_SEND_CSD;\r
  SdCmdBlk.CommandType     = SdCommandTypeAc;\r
  SdCmdBlk.ResponseType    = SdResponseTypeR2;\r
  SdCmdBlk.CommandArgument = (UINT32)Rca << 16;\r
\r
  Status = SdPeimExecCmd (Slot, &Packet);\r
  if (!EFI_ERROR (Status)) {\r
    //\r
    // For details, refer to SD Host Controller Simplified Spec 3.0 Table 2-12.\r
    //\r
    CopyMem (((UINT8 *)Csd) + 1, &SdStatusBlk.Resp0, sizeof (SD_CSD) - 1);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Send command SELECT_DESELECT_CARD to the SD device to select/deselect it.\r
\r
  Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.\r
\r
  @param[in]  Slot          The slot number of the SD card to send the command to.\r
  @param[in]  Rca           The relative device address of selected device.\r
\r
  @retval EFI_SUCCESS       The operation is done correctly.\r
  @retval Others            The operation fails.\r
\r
**/\r
EFI_STATUS\r
SdPeimSelect (\r
  IN SD_PEIM_HC_SLOT  *Slot,\r
  IN UINT16           Rca\r
  )\r
{\r
  SD_COMMAND_BLOCK   SdCmdBlk;\r
  SD_STATUS_BLOCK    SdStatusBlk;\r
  SD_COMMAND_PACKET  Packet;\r
  EFI_STATUS         Status;\r
\r
  ZeroMem (&SdCmdBlk, sizeof (SdCmdBlk));\r
  ZeroMem (&SdStatusBlk, sizeof (SdStatusBlk));\r
  ZeroMem (&Packet, sizeof (Packet));\r
\r
  Packet.SdCmdBlk    = &SdCmdBlk;\r
  Packet.SdStatusBlk = &SdStatusBlk;\r
  Packet.Timeout     = SD_TIMEOUT;\r
\r
  SdCmdBlk.CommandIndex    = SD_SELECT_DESELECT_CARD;\r
  SdCmdBlk.CommandType     = SdCommandTypeAc;\r
  SdCmdBlk.ResponseType    = SdResponseTypeR1b;\r
  SdCmdBlk.CommandArgument = (UINT32)Rca << 16;\r
\r
  Status = SdPeimExecCmd (Slot, &Packet);\r
\r
  return Status;\r
}\r
\r
/**\r
  Send command VOLTAGE_SWITCH to the SD device to switch the voltage of the device.\r
\r
  Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.\r
\r
  @param[in]  Slot          The slot number of the SD card to send the command to.\r
\r
  @retval EFI_SUCCESS       The operation is done correctly.\r
  @retval Others            The operation fails.\r
\r
**/\r
EFI_STATUS\r
SdPeimVoltageSwitch (\r
  IN SD_PEIM_HC_SLOT  *Slot\r
  )\r
{\r
  SD_COMMAND_BLOCK   SdCmdBlk;\r
  SD_STATUS_BLOCK    SdStatusBlk;\r
  SD_COMMAND_PACKET  Packet;\r
  EFI_STATUS         Status;\r
\r
  ZeroMem (&SdCmdBlk, sizeof (SdCmdBlk));\r
  ZeroMem (&SdStatusBlk, sizeof (SdStatusBlk));\r
  ZeroMem (&Packet, sizeof (Packet));\r
\r
  Packet.SdCmdBlk    = &SdCmdBlk;\r
  Packet.SdStatusBlk = &SdStatusBlk;\r
  Packet.Timeout     = SD_TIMEOUT;\r
\r
  SdCmdBlk.CommandIndex    = SD_VOLTAGE_SWITCH;\r
  SdCmdBlk.CommandType     = SdCommandTypeAc;\r
  SdCmdBlk.ResponseType    = SdResponseTypeR1;\r
  SdCmdBlk.CommandArgument = 0;\r
\r
  Status = SdPeimExecCmd (Slot, &Packet);\r
\r
  return Status;\r
}\r
\r
/**\r
  Send command SET_BUS_WIDTH to the SD device to set the bus width.\r
\r
  Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.\r
\r
  @param[in] Slot           The slot number of the SD card to send the command to.\r
  @param[in] Rca            The relative device address of addressed device.\r
  @param[in] BusWidth       The bus width to be set, it could be 1 or 4.\r
\r
  @retval EFI_SUCCESS       The operation is done correctly.\r
  @retval Others            The operation fails.\r
\r
**/\r
EFI_STATUS\r
SdPeimSetBusWidth (\r
  IN SD_PEIM_HC_SLOT  *Slot,\r
  IN UINT16           Rca,\r
  IN UINT8            BusWidth\r
  )\r
{\r
  SD_COMMAND_BLOCK   SdCmdBlk;\r
  SD_STATUS_BLOCK    SdStatusBlk;\r
  SD_COMMAND_PACKET  Packet;\r
  EFI_STATUS         Status;\r
  UINT8              Value;\r
\r
  ZeroMem (&SdCmdBlk, sizeof (SdCmdBlk));\r
  ZeroMem (&SdStatusBlk, sizeof (SdStatusBlk));\r
  ZeroMem (&Packet, sizeof (Packet));\r
\r
  Packet.SdCmdBlk    = &SdCmdBlk;\r
  Packet.SdStatusBlk = &SdStatusBlk;\r
  Packet.Timeout     = SD_TIMEOUT;\r
\r
  SdCmdBlk.CommandIndex    = SD_APP_CMD;\r
  SdCmdBlk.CommandType     = SdCommandTypeAc;\r
  SdCmdBlk.ResponseType    = SdResponseTypeR1;\r
  SdCmdBlk.CommandArgument = (UINT32)Rca << 16;\r
\r
  Status = SdPeimExecCmd (Slot, &Packet);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  SdCmdBlk.CommandIndex = SD_SET_BUS_WIDTH;\r
  SdCmdBlk.CommandType  = SdCommandTypeAc;\r
  SdCmdBlk.ResponseType = SdResponseTypeR1;\r
\r
  if (BusWidth == 1) {\r
    Value = 0;\r
  } else if (BusWidth == 4) {\r
    Value = 2;\r
  } else {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  SdCmdBlk.CommandArgument = Value & 0x3;\r
\r
  Status = SdPeimExecCmd (Slot, &Packet);\r
\r
  return Status;\r
}\r
\r
/**\r
  Send command SWITCH_FUNC to the SD device to check switchable function or switch card function.\r
\r
  Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.\r
\r
  @param[in]  Slot          The slot number of the SD card to send the command to.\r
  @param[in]  AccessMode    The value for access mode group.\r
  @param[in]  CommandSystem The value for command set group.\r
  @param[in]  DriveStrength The value for drive length group.\r
  @param[in]  PowerLimit    The value for power limit group.\r
  @param[in]  Mode          Switch or check function.\r
  @param[out] SwitchResp    The return switch function status.\r
\r
  @retval EFI_SUCCESS       The operation is done correctly.\r
  @retval Others            The operation fails.\r
\r
**/\r
EFI_STATUS\r
SdPeimSwitch (\r
  IN     SD_PEIM_HC_SLOT  *Slot,\r
  IN     UINT8            AccessMode,\r
  IN     UINT8            CommandSystem,\r
  IN     UINT8            DriveStrength,\r
  IN     UINT8            PowerLimit,\r
  IN     BOOLEAN          Mode,\r
  OUT UINT8               *SwitchResp\r
  )\r
{\r
  SD_COMMAND_BLOCK   SdCmdBlk;\r
  SD_STATUS_BLOCK    SdStatusBlk;\r
  SD_COMMAND_PACKET  Packet;\r
  EFI_STATUS         Status;\r
  UINT32             ModeValue;\r
\r
  ZeroMem (&SdCmdBlk, sizeof (SdCmdBlk));\r
  ZeroMem (&SdStatusBlk, sizeof (SdStatusBlk));\r
  ZeroMem (&Packet, sizeof (Packet));\r
\r
  Packet.SdCmdBlk    = &SdCmdBlk;\r
  Packet.SdStatusBlk = &SdStatusBlk;\r
  Packet.Timeout     = SD_TIMEOUT;\r
\r
  SdCmdBlk.CommandIndex = SD_SWITCH_FUNC;\r
  SdCmdBlk.CommandType  = SdCommandTypeAdtc;\r
  SdCmdBlk.ResponseType = SdResponseTypeR1;\r
\r
  ModeValue                = Mode ? BIT31 : 0;\r
  SdCmdBlk.CommandArgument = (AccessMode & 0xF) | ((PowerLimit & 0xF) << 4) | \\r
                             ((DriveStrength & 0xF) << 8) | ((DriveStrength & 0xF) << 12) | \\r
                             ModeValue;\r
  Packet.InDataBuffer     = SwitchResp;\r
  Packet.InTransferLength = 64;\r
\r
  Status = SdPeimExecCmd (Slot, &Packet);\r
\r
  return Status;\r
}\r
\r
/**\r
  Send command SEND_STATUS to the addressed SD device to get its status register.\r
\r
  Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.\r
\r
  @param[in]  Slot          The slot number of the SD card to send the command to.\r
  @param[in]  Rca           The relative device address of addressed device.\r
  @param[out] DevStatus     The returned device status.\r
\r
  @retval EFI_SUCCESS       The operation is done correctly.\r
  @retval Others            The operation fails.\r
\r
**/\r
EFI_STATUS\r
SdPeimSendStatus (\r
  IN     SD_PEIM_HC_SLOT  *Slot,\r
  IN     UINT16           Rca,\r
  OUT UINT32              *DevStatus\r
  )\r
{\r
  SD_COMMAND_BLOCK   SdCmdBlk;\r
  SD_STATUS_BLOCK    SdStatusBlk;\r
  SD_COMMAND_PACKET  Packet;\r
  EFI_STATUS         Status;\r
\r
  ZeroMem (&SdCmdBlk, sizeof (SdCmdBlk));\r
  ZeroMem (&SdStatusBlk, sizeof (SdStatusBlk));\r
  ZeroMem (&Packet, sizeof (Packet));\r
\r
  Packet.SdCmdBlk    = &SdCmdBlk;\r
  Packet.SdStatusBlk = &SdStatusBlk;\r
  Packet.Timeout     = SD_TIMEOUT;\r
\r
  SdCmdBlk.CommandIndex    = SD_SEND_STATUS;\r
  SdCmdBlk.CommandType     = SdCommandTypeAc;\r
  SdCmdBlk.ResponseType    = SdResponseTypeR1;\r
  SdCmdBlk.CommandArgument = (UINT32)Rca << 16;\r
\r
  Status = SdPeimExecCmd (Slot, &Packet);\r
  if (!EFI_ERROR (Status)) {\r
    *DevStatus = SdStatusBlk.Resp0;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Send command READ_SINGLE_BLOCK/WRITE_SINGLE_BLOCK to the addressed SD device\r
  to read/write the specified number of blocks.\r
\r
  Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.\r
\r
  @param[in] Slot           The slot number of the SD card to send the command to.\r
  @param[in] Lba            The logical block address of starting access.\r
  @param[in] BlockSize      The block size of specified SD device partition.\r
  @param[in] Buffer         The pointer to the transfer buffer.\r
  @param[in] BufferSize     The size of transfer buffer.\r
  @param[in] IsRead         Boolean to show the operation direction.\r
\r
  @retval EFI_SUCCESS       The operation is done correctly.\r
  @retval Others            The operation fails.\r
\r
**/\r
EFI_STATUS\r
SdPeimRwSingleBlock (\r
  IN SD_PEIM_HC_SLOT  *Slot,\r
  IN EFI_LBA          Lba,\r
  IN UINT32           BlockSize,\r
  IN VOID             *Buffer,\r
  IN UINTN            BufferSize,\r
  IN BOOLEAN          IsRead\r
  )\r
{\r
  SD_COMMAND_BLOCK   SdCmdBlk;\r
  SD_STATUS_BLOCK    SdStatusBlk;\r
  SD_COMMAND_PACKET  Packet;\r
  EFI_STATUS         Status;\r
\r
  ZeroMem (&SdCmdBlk, sizeof (SdCmdBlk));\r
  ZeroMem (&SdStatusBlk, sizeof (SdStatusBlk));\r
  ZeroMem (&Packet, sizeof (Packet));\r
\r
  Packet.SdCmdBlk    = &SdCmdBlk;\r
  Packet.SdStatusBlk = &SdStatusBlk;\r
  //\r
  // Calculate timeout value through the below formula.\r
  // Timeout = (transfer size) / (2MB/s).\r
  // Taking 2MB/s as divisor is because it's the lowest\r
  // transfer speed of class 2.\r
  //\r
  Packet.Timeout = (BufferSize / (2 * 1024 * 1024) + 1) * 1000 * 1000;\r
\r
  if (IsRead) {\r
    Packet.InDataBuffer     = Buffer;\r
    Packet.InTransferLength = (UINT32)BufferSize;\r
\r
    SdCmdBlk.CommandIndex = SD_READ_SINGLE_BLOCK;\r
    SdCmdBlk.CommandType  = SdCommandTypeAdtc;\r
    SdCmdBlk.ResponseType = SdResponseTypeR1;\r
  } else {\r
    Packet.OutDataBuffer     = Buffer;\r
    Packet.OutTransferLength = (UINT32)BufferSize;\r
\r
    SdCmdBlk.CommandIndex = SD_WRITE_SINGLE_BLOCK;\r
    SdCmdBlk.CommandType  = SdCommandTypeAdtc;\r
    SdCmdBlk.ResponseType = SdResponseTypeR1;\r
  }\r
\r
  if (Slot->SectorAddressing) {\r
    SdCmdBlk.CommandArgument = (UINT32)Lba;\r
  } else {\r
    SdCmdBlk.CommandArgument = (UINT32)MultU64x32 (Lba, BlockSize);\r
  }\r
\r
  Status = SdPeimExecCmd (Slot, &Packet);\r
\r
  return Status;\r
}\r
\r
/**\r
  Send command READ_MULTIPLE_BLOCK/WRITE_MULTIPLE_BLOCK to the addressed SD device\r
  to read/write the specified number of blocks.\r
\r
  Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.\r
\r
  @param[in] Slot           The slot number of the SD card to send the command to.\r
  @param[in] Lba            The logical block address of starting access.\r
  @param[in] BlockSize      The block size of specified SD device partition.\r
  @param[in] Buffer         The pointer to the transfer buffer.\r
  @param[in] BufferSize     The size of transfer buffer.\r
  @param[in] IsRead         Boolean to show the operation direction.\r
\r
  @retval EFI_SUCCESS       The operation is done correctly.\r
  @retval Others            The operation fails.\r
\r
**/\r
EFI_STATUS\r
SdPeimRwMultiBlocks (\r
  IN SD_PEIM_HC_SLOT  *Slot,\r
  IN EFI_LBA          Lba,\r
  IN UINT32           BlockSize,\r
  IN VOID             *Buffer,\r
  IN UINTN            BufferSize,\r
  IN BOOLEAN          IsRead\r
  )\r
{\r
  SD_COMMAND_BLOCK   SdCmdBlk;\r
  SD_STATUS_BLOCK    SdStatusBlk;\r
  SD_COMMAND_PACKET  Packet;\r
  EFI_STATUS         Status;\r
\r
  ZeroMem (&SdCmdBlk, sizeof (SdCmdBlk));\r
  ZeroMem (&SdStatusBlk, sizeof (SdStatusBlk));\r
  ZeroMem (&Packet, sizeof (Packet));\r
\r
  Packet.SdCmdBlk    = &SdCmdBlk;\r
  Packet.SdStatusBlk = &SdStatusBlk;\r
  //\r
  // Calculate timeout value through the below formula.\r
  // Timeout = (transfer size) / (2MB/s).\r
  // Taking 2MB/s as divisor is because it's the lowest\r
  // transfer speed of class 2.\r
  //\r
  Packet.Timeout = (BufferSize / (2 * 1024 * 1024) + 1) * 1000 * 1000;\r
\r
  if (IsRead) {\r
    Packet.InDataBuffer     = Buffer;\r
    Packet.InTransferLength = (UINT32)BufferSize;\r
\r
    SdCmdBlk.CommandIndex = SD_READ_MULTIPLE_BLOCK;\r
    SdCmdBlk.CommandType  = SdCommandTypeAdtc;\r
    SdCmdBlk.ResponseType = SdResponseTypeR1;\r
  } else {\r
    Packet.OutDataBuffer     = Buffer;\r
    Packet.OutTransferLength = (UINT32)BufferSize;\r
\r
    SdCmdBlk.CommandIndex = SD_WRITE_MULTIPLE_BLOCK;\r
    SdCmdBlk.CommandType  = SdCommandTypeAdtc;\r
    SdCmdBlk.ResponseType = SdResponseTypeR1;\r
  }\r
\r
  if (Slot->SectorAddressing) {\r
    SdCmdBlk.CommandArgument = (UINT32)Lba;\r
  } else {\r
    SdCmdBlk.CommandArgument = (UINT32)MultU64x32 (Lba, BlockSize);\r
  }\r
\r
  Status = SdPeimExecCmd (Slot, &Packet);\r
\r
  return Status;\r
}\r
\r
/**\r
  Send command SEND_TUNING_BLOCK to the SD device for SDR104/SDR50 optimal sampling point\r
  detection.\r
\r
  It may be sent up to 40 times until the host finishes the tuning procedure.\r
\r
  Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 for details.\r
\r
  @param[in] Slot           The slot number of the SD card to send the command to.\r
\r
  @retval EFI_SUCCESS       The operation is done correctly.\r
  @retval Others            The operation fails.\r
\r
**/\r
EFI_STATUS\r
SdPeimSendTuningBlk (\r
  IN SD_PEIM_HC_SLOT  *Slot\r
  )\r
{\r
  SD_COMMAND_BLOCK   SdCmdBlk;\r
  SD_STATUS_BLOCK    SdStatusBlk;\r
  SD_COMMAND_PACKET  Packet;\r
  EFI_STATUS         Status;\r
  UINT8              TuningBlock[64];\r
\r
  ZeroMem (&SdCmdBlk, sizeof (SdCmdBlk));\r
  ZeroMem (&SdStatusBlk, sizeof (SdStatusBlk));\r
  ZeroMem (&Packet, sizeof (Packet));\r
\r
  Packet.SdCmdBlk    = &SdCmdBlk;\r
  Packet.SdStatusBlk = &SdStatusBlk;\r
  Packet.Timeout     = SD_TIMEOUT;\r
\r
  SdCmdBlk.CommandIndex    = SD_SEND_TUNING_BLOCK;\r
  SdCmdBlk.CommandType     = SdCommandTypeAdtc;\r
  SdCmdBlk.ResponseType    = SdResponseTypeR1;\r
  SdCmdBlk.CommandArgument = 0;\r
\r
  Packet.InDataBuffer     = TuningBlock;\r
  Packet.InTransferLength = sizeof (TuningBlock);\r
\r
  Status = SdPeimExecCmd (Slot, &Packet);\r
\r
  return Status;\r
}\r
\r
/**\r
  Tuning the sampling point of SDR104 or SDR50 bus speed mode.\r
\r
  Command SD_SEND_TUNING_BLOCK may be sent up to 40 times until the host finishes the\r
  tuning procedure.\r
\r
  Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 and SD Host Controller\r
  Simplified Spec 3.0 Figure 2-29 for details.\r
\r
  @param[in] Slot           The slot number of the SD card to send the command to.\r
\r
  @retval EFI_SUCCESS       The operation is done correctly.\r
  @retval Others            The operation fails.\r
\r
**/\r
EFI_STATUS\r
SdPeimTuningClock (\r
  IN SD_PEIM_HC_SLOT  *Slot\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINT8       HostCtrl2;\r
  UINT8       Retry;\r
\r
  //\r
  // Notify the host that the sampling clock tuning procedure starts.\r
  //\r
  HostCtrl2 = BIT6;\r
  Status    = SdPeimHcOrMmio (Slot->SdHcBase + SD_HC_HOST_CTRL2, sizeof (HostCtrl2), &HostCtrl2);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Ask the device to send a sequence of tuning blocks till the tuning procedure is done.\r
  //\r
  Retry = 0;\r
  do {\r
    Status = SdPeimSendTuningBlk (Slot);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    Status = SdPeimHcRwMmio (Slot->SdHcBase + SD_HC_HOST_CTRL2, TRUE, sizeof (HostCtrl2), &HostCtrl2);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
\r
    if ((HostCtrl2 & (BIT6 | BIT7)) == 0) {\r
      break;\r
    }\r
\r
    if ((HostCtrl2 & (BIT6 | BIT7)) == BIT7) {\r
      return EFI_SUCCESS;\r
    }\r
  } while (++Retry < 40);\r
\r
  DEBUG ((DEBUG_ERROR, "SdPeimTuningClock: Send tuning block fails at %d times with HostCtrl2 %02x\n", Retry, HostCtrl2));\r
  //\r
  // Abort the tuning procedure and reset the tuning circuit.\r
  //\r
  HostCtrl2 = (UINT8) ~(BIT6 | BIT7);\r
  Status    = SdPeimHcAndMmio (Slot->SdHcBase + SD_HC_HOST_CTRL2, sizeof (HostCtrl2), &HostCtrl2);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  return EFI_DEVICE_ERROR;\r
}\r
\r
/**\r
  Switch the bus width to specified width.\r
\r
  Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 and\r
  SD Host Controller Simplified Spec 3.0 section Figure 3-7 for details.\r
\r
  @param[in] Slot           The slot number of the SD card to send the command to.\r
  @param[in] Rca            The relative device address to be assigned.\r
  @param[in] BusWidth       The bus width to be set, it could be 4 or 8.\r
\r
  @retval EFI_SUCCESS       The operation is done correctly.\r
  @retval Others            The operation fails.\r
\r
**/\r
EFI_STATUS\r
SdPeimSwitchBusWidth (\r
  IN SD_PEIM_HC_SLOT  *Slot,\r
  IN UINT16           Rca,\r
  IN UINT8            BusWidth\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINT32      DevStatus;\r
\r
  Status = SdPeimSetBusWidth (Slot, Rca, BusWidth);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = SdPeimSendStatus (Slot, Rca, &DevStatus);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Check the switch operation is really successful or not.\r
  //\r
  if ((DevStatus >> 16) != 0) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  Status = SdPeimHcSetBusWidth (Slot->SdHcBase, BusWidth);\r
\r
  return Status;\r
}\r
\r
/**\r
  Switch the high speed timing according to request.\r
\r
  Refer to SD Physical Layer Simplified Spec 4.1 Section 4.7 and\r
  SD Host Controller Simplified Spec 3.0 section Figure 2-29 for details.\r
\r
  @param[in] Slot           The slot number of the SD card to send the command to.\r
  @param[in] Rca            The relative device address to be assigned.\r
  @param[in] S18a           The boolean to show if it's a UHS-I SD card.\r
\r
  @retval EFI_SUCCESS       The operation is done correctly.\r
  @retval Others            The operation fails.\r
\r
**/\r
EFI_STATUS\r
SdPeimSetBusMode (\r
  IN SD_PEIM_HC_SLOT  *Slot,\r
  IN UINT16           Rca,\r
  IN BOOLEAN          S18a\r
  )\r
{\r
  EFI_STATUS      Status;\r
  SD_HC_SLOT_CAP  Capability;\r
  UINT32          ClockFreq;\r
  UINT8           BusWidth;\r
  UINT8           AccessMode;\r
  UINT8           HostCtrl1;\r
  UINT8           HostCtrl2;\r
  UINT8           SwitchResp[64];\r
\r
  Status = SdPeimGetCsd (Slot, Rca, &Slot->Csd);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "SdPeimSetBusMode: SdPeimGetCsd fails with %r\n", Status));\r
    return Status;\r
  }\r
\r
  Status = SdPeimHcGetCapability (Slot->SdHcBase, &Capability);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = SdPeimSelect (Slot, Rca);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "SdPeimSetBusMode: SdPeimSelect fails with %r\n", Status));\r
    return Status;\r
  }\r
\r
  BusWidth = 4;\r
  Status   = SdPeimSwitchBusWidth (Slot, Rca, BusWidth);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "SdPeimSetBusMode: SdPeimSwitchBusWidth fails with %r\n", Status));\r
    return Status;\r
  }\r
\r
  //\r
  // Get the supported bus speed from SWITCH cmd return data group #1.\r
  //\r
  ZeroMem (SwitchResp, sizeof (SwitchResp));\r
  Status = SdPeimSwitch (Slot, 0xF, 0xF, 0xF, 0xF, FALSE, SwitchResp);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Calculate supported bus speed/bus width/clock frequency by host and device capability.\r
  //\r
  ClockFreq = 0;\r
  if (S18a && (Capability.Sdr104 != 0) && ((SwitchResp[13] & BIT3) != 0)) {\r
    ClockFreq  = 208;\r
    AccessMode = 3;\r
  } else if (S18a && (Capability.Sdr50 != 0) && ((SwitchResp[13] & BIT2) != 0)) {\r
    ClockFreq  = 100;\r
    AccessMode = 2;\r
  } else if (S18a && (Capability.Ddr50 != 0) && ((SwitchResp[13] & BIT4) != 0)) {\r
    ClockFreq  = 50;\r
    AccessMode = 4;\r
  } else if ((SwitchResp[13] & BIT1) != 0) {\r
    ClockFreq  = 50;\r
    AccessMode = 1;\r
  } else {\r
    ClockFreq  = 25;\r
    AccessMode = 0;\r
  }\r
\r
  DEBUG ((DEBUG_INFO, "SdPeimSetBusMode: AccessMode %d ClockFreq %d BusWidth %d\n", AccessMode, ClockFreq, BusWidth));\r
\r
  Status = SdPeimSwitch (Slot, AccessMode, 0xF, 0xF, 0xF, TRUE, SwitchResp);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "SdPeimSetBusMode: SdPeimSwitch fails with %r\n", Status));\r
    return Status;\r
  }\r
\r
  if ((SwitchResp[16] & 0xF) != AccessMode) {\r
    DEBUG ((DEBUG_ERROR, "SdPeimSetBusMode: SdPeimSwitch to AccessMode %d ClockFreq %d BusWidth %d fails! The Switch response is 0x%1x\n", AccessMode, ClockFreq, BusWidth, SwitchResp[16] & 0xF));\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  //\r
  // Set to High Speed timing\r
  //\r
  if (AccessMode == 1) {\r
    HostCtrl1 = BIT2;\r
    Status    = SdPeimHcOrMmio (Slot->SdHcBase + SD_HC_HOST_CTRL1, sizeof (HostCtrl1), &HostCtrl1);\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  }\r
\r
  HostCtrl2 = (UINT8) ~0x7;\r
  Status    = SdPeimHcAndMmio (Slot->SdHcBase + SD_HC_HOST_CTRL2, sizeof (HostCtrl2), &HostCtrl2);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  HostCtrl2 = AccessMode;\r
  Status    = SdPeimHcOrMmio (Slot->SdHcBase + SD_HC_HOST_CTRL2, sizeof (HostCtrl2), &HostCtrl2);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = SdPeimHcClockSupply (Slot->SdHcBase, ClockFreq * 1000);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "SdPeimSetBusMode: SdPeimHcClockSupply %r\n", Status));\r
    return Status;\r
  }\r
\r
  if ((AccessMode == 3) || ((AccessMode == 2) && (Capability.TuningSDR50 != 0))) {\r
    Status = SdPeimTuningClock (Slot);\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((DEBUG_ERROR, "SdPeimSetBusMode: SdPeimTuningClock fails with %r\n", Status));\r
      return Status;\r
    }\r
  }\r
\r
  DEBUG ((DEBUG_INFO, "SdPeimSetBusMode: SdPeimSetBusMode %r\n", Status));\r
\r
  return Status;\r
}\r
\r
/**\r
  Execute SD device identification procedure.\r
\r
  Refer to SD Physical Layer Simplified Spec 4.1 Section 3.6 for details.\r
\r
  @param[in] Slot           The slot number of the SD card to send the command to.\r
\r
  @retval EFI_SUCCESS       There is a SD card.\r
  @retval Others            There is not a SD card.\r
\r
**/\r
EFI_STATUS\r
SdPeimIdentification (\r
  IN SD_PEIM_HC_SLOT  *Slot\r
  )\r
{\r
  EFI_STATUS      Status;\r
  UINT32          Ocr;\r
  UINT16          Rca;\r
  BOOLEAN         Xpc;\r
  BOOLEAN         S18r;\r
  UINT64          MaxCurrent;\r
  UINT64          Current;\r
  UINT16          ControllerVer;\r
  UINT8           PowerCtrl;\r
  UINT32          PresentState;\r
  UINT8           HostCtrl2;\r
  SD_HC_SLOT_CAP  Capability;\r
  UINTN           Retry;\r
\r
  //\r
  // 1. Send Cmd0 to the device\r
  //\r
  Status = SdPeimReset (Slot);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "SdPeimIdentification: Executing Cmd0 fails with %r\n", Status));\r
    return Status;\r
  }\r
\r
  //\r
  // 2. Send Cmd8 to the device\r
  //\r
  Status = SdPeimVoltageCheck (Slot, 0x1, 0xFF);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "SdPeimIdentification: Executing Cmd8 fails with %r\n", Status));\r
    return Status;\r
  }\r
\r
  //\r
  // 3. Send SDIO Cmd5 to the device to the SDIO device OCR register.\r
  //\r
  Status = SdioSendOpCond (Slot, 0, FALSE);\r
  if (!EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "SdPeimIdentification: Found SDIO device, ignore it as we don't support\n"));\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  //\r
  // 4. Send Acmd41 with voltage window 0 to the device\r
  //\r
  Status = SdPeimSendOpCond (Slot, 0, 0, FALSE, FALSE, FALSE, &Ocr);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "SdPeimIdentification: Executing SdPeimSendOpCond fails with %r\n", Status));\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  Status = SdPeimHcGetCapability (Slot->SdHcBase, &Capability);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = SdPeimHcRwMmio (Slot->SdHcBase + SD_HC_MAX_CURRENT_CAP, TRUE, sizeof (Current), &Current);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (Capability.Voltage33 != 0) {\r
    //\r
    // Support 3.3V\r
    //\r
    MaxCurrent = ((UINT32)Current & 0xFF) * 4;\r
  } else if (Capability.Voltage30 != 0) {\r
    //\r
    // Support 3.0V\r
    //\r
    MaxCurrent = (((UINT32)Current >> 8) & 0xFF) * 4;\r
  } else if (Capability.Voltage18 != 0) {\r
    //\r
    // Support 1.8V\r
    //\r
    MaxCurrent = (((UINT32)Current >> 16) & 0xFF) * 4;\r
  } else {\r
    ASSERT (FALSE);\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  if (MaxCurrent >= 150) {\r
    Xpc = TRUE;\r
  } else {\r
    Xpc = FALSE;\r
  }\r
\r
  Status = SdPeimHcRwMmio (Slot->SdHcBase + SD_HC_CTRL_VER, TRUE, sizeof (ControllerVer), &ControllerVer);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if ((ControllerVer & 0xFF) == 2) {\r
    S18r = TRUE;\r
  } else if (((ControllerVer & 0xFF) == 0) || ((ControllerVer & 0xFF) == 1)) {\r
    S18r = FALSE;\r
  } else {\r
    ASSERT (FALSE);\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // 5. Repeatly send Acmd41 with supply voltage window to the device.\r
  //    Note here we only support the cards complied with SD physical\r
  //    layer simplified spec version 2.0 and version 3.0 and above.\r
  //\r
  Ocr   = 0;\r
  Retry = 0;\r
  do {\r
    Status = SdPeimSendOpCond (Slot, 0, Ocr, S18r, Xpc, TRUE, &Ocr);\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((DEBUG_ERROR, "SdPeimIdentification: SdPeimSendOpCond fails with %r Ocr %x, S18r %x, Xpc %x\n", Status, Ocr, S18r, Xpc));\r
      return EFI_DEVICE_ERROR;\r
    }\r
\r
    if (Retry++ == 100) {\r
      DEBUG ((DEBUG_ERROR, "SdPeimIdentification: SdPeimSendOpCond fails too many times\n"));\r
      return EFI_DEVICE_ERROR;\r
    }\r
\r
    MicroSecondDelay (10 * 1000);\r
  } while ((Ocr & BIT31) == 0);\r
\r
  //\r
  // 6. If the S18a bit is set and the Host Controller supports 1.8V signaling\r
  //    (One of support bits is set to 1: SDR50, SDR104 or DDR50 in the\r
  //    Capabilities register), switch its voltage to 1.8V.\r
  //\r
  if (((Capability.Sdr50 != 0) ||\r
       (Capability.Sdr104 != 0) ||\r
       (Capability.Ddr50 != 0)) &&\r
      ((Ocr & BIT24) != 0))\r
  {\r
    Status = SdPeimVoltageSwitch (Slot);\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((DEBUG_ERROR, "SdPeimIdentification: Executing SdPeimVoltageSwitch fails with %r\n", Status));\r
      Status = EFI_DEVICE_ERROR;\r
      goto Error;\r
    } else {\r
      Status = SdPeimHcStopClock (Slot->SdHcBase);\r
      if (EFI_ERROR (Status)) {\r
        Status = EFI_DEVICE_ERROR;\r
        goto Error;\r
      }\r
\r
      SdPeimHcRwMmio (Slot->SdHcBase + SD_HC_PRESENT_STATE, TRUE, sizeof (PresentState), &PresentState);\r
      if (((PresentState >> 20) & 0xF) != 0) {\r
        DEBUG ((DEBUG_ERROR, "SdPeimIdentification: SwitchVoltage fails with PresentState = 0x%x\n", PresentState));\r
        Status = EFI_DEVICE_ERROR;\r
        goto Error;\r
      }\r
\r
      HostCtrl2 = BIT3;\r
      SdPeimHcOrMmio (Slot->SdHcBase + SD_HC_HOST_CTRL2, sizeof (HostCtrl2), &HostCtrl2);\r
\r
      MicroSecondDelay (5000);\r
\r
      SdPeimHcRwMmio (Slot->SdHcBase + SD_HC_HOST_CTRL2, TRUE, sizeof (HostCtrl2), &HostCtrl2);\r
      if ((HostCtrl2 & BIT3) == 0) {\r
        DEBUG ((DEBUG_ERROR, "SdPeimIdentification: SwitchVoltage fails with HostCtrl2 = 0x%x\n", HostCtrl2));\r
        Status = EFI_DEVICE_ERROR;\r
        goto Error;\r
      }\r
\r
      SdPeimHcInitClockFreq (Slot->SdHcBase);\r
\r
      MicroSecondDelay (1000);\r
\r
      SdPeimHcRwMmio (Slot->SdHcBase + SD_HC_PRESENT_STATE, TRUE, sizeof (PresentState), &PresentState);\r
      if (((PresentState >> 20) & 0xF) != 0xF) {\r
        DEBUG ((DEBUG_ERROR, "SdPeimIdentification: SwitchVoltage fails with PresentState = 0x%x, It should be 0xF\n", PresentState));\r
        Status = EFI_DEVICE_ERROR;\r
        goto Error;\r
      }\r
    }\r
\r
    DEBUG ((DEBUG_INFO, "SdPeimIdentification: Switch to 1.8v signal voltage success\n"));\r
  }\r
\r
  Status = SdPeimAllSendCid (Slot);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "SdPeimIdentification: Executing SdPeimAllSendCid fails with %r\n", Status));\r
    return Status;\r
  }\r
\r
  Status = SdPeimSetRca (Slot, &Rca);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "SdPeimIdentification: Executing SdPeimSetRca fails with %r\n", Status));\r
    return Status;\r
  }\r
\r
  //\r
  // Enter Data Tranfer Mode.\r
  //\r
  DEBUG ((DEBUG_INFO, "Found a SD device at slot [%d]\n", Slot));\r
\r
  Status = SdPeimSetBusMode (Slot, Rca, ((Ocr & BIT24) != 0));\r
\r
  return Status;\r
\r
Error:\r
  //\r
  // Set SD Bus Power = 0\r
  //\r
  PowerCtrl = (UINT8) ~BIT0;\r
  Status    = SdPeimHcAndMmio (Slot->SdHcBase + SD_HC_POWER_CTRL, sizeof (PowerCtrl), &PowerCtrl);\r
  return EFI_DEVICE_ERROR;\r
}\r