[mirror_edk2.git] / MdeModulePkg / Bus / Ata / AtaAtapiPassThru / AhciMode.c

/** @file\r
  The file for AHCI mode of ATA host controller.\r
\r
  Copyright (c) 2010 - 2020, Intel Corporation. All rights reserved.<BR>\r
  (C) Copyright 2015 Hewlett Packard Enterprise Development LP<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "AtaAtapiPassThru.h"\r
\r
/**\r
  Read AHCI Operation register.\r
\r
  @param  PciIo        The PCI IO protocol instance.\r
  @param  Offset       The operation register offset.\r
\r
  @return The register content read.\r
\r
**/\r
UINT32\r
EFIAPI\r
AhciReadReg (\r
  IN EFI_PCI_IO_PROTOCOL  *PciIo,\r
  IN  UINT32              Offset\r
  )\r
{\r
  UINT32                  Data;\r
\r
  ASSERT (PciIo != NULL);\r
\r
  Data = 0;\r
\r
  PciIo->Mem.Read (\r
               PciIo,\r
               EfiPciIoWidthUint32,\r
               EFI_AHCI_BAR_INDEX,\r
               (UINT64) Offset,\r
               1,\r
               &Data\r
               );\r
\r
  return Data;\r
}\r
\r
/**\r
  Write AHCI Operation register.\r
\r
  @param  PciIo        The PCI IO protocol instance.\r
  @param  Offset       The operation register offset.\r
  @param  Data         The data used to write down.\r
\r
**/\r
VOID\r
EFIAPI\r
AhciWriteReg (\r
  IN EFI_PCI_IO_PROTOCOL  *PciIo,\r
  IN UINT32               Offset,\r
  IN UINT32               Data\r
  )\r
{\r
  ASSERT (PciIo != NULL);\r
\r
  PciIo->Mem.Write (\r
               PciIo,\r
               EfiPciIoWidthUint32,\r
               EFI_AHCI_BAR_INDEX,\r
               (UINT64) Offset,\r
               1,\r
               &Data\r
               );\r
\r
  return ;\r
}\r
\r
/**\r
  Do AND operation with the value of AHCI Operation register.\r
\r
  @param  PciIo        The PCI IO protocol instance.\r
  @param  Offset       The operation register offset.\r
  @param  AndData      The data used to do AND operation.\r
\r
**/\r
VOID\r
EFIAPI\r
AhciAndReg (\r
  IN EFI_PCI_IO_PROTOCOL  *PciIo,\r
  IN UINT32               Offset,\r
  IN UINT32               AndData\r
  )\r
{\r
  UINT32 Data;\r
\r
  ASSERT (PciIo != NULL);\r
\r
  Data  = AhciReadReg (PciIo, Offset);\r
\r
  Data &= AndData;\r
\r
  AhciWriteReg (PciIo, Offset, Data);\r
}\r
\r
/**\r
  Do OR operation with the value of AHCI Operation register.\r
\r
  @param  PciIo        The PCI IO protocol instance.\r
  @param  Offset       The operation register offset.\r
  @param  OrData       The data used to do OR operation.\r
\r
**/\r
VOID\r
EFIAPI\r
AhciOrReg (\r
  IN EFI_PCI_IO_PROTOCOL  *PciIo,\r
  IN UINT32               Offset,\r
  IN UINT32               OrData\r
  )\r
{\r
  UINT32 Data;\r
\r
  ASSERT (PciIo != NULL);\r
\r
  Data  = AhciReadReg (PciIo, Offset);\r
\r
  Data |= OrData;\r
\r
  AhciWriteReg (PciIo, Offset, Data);\r
}\r
\r
/**\r
  Wait for the value of the specified MMIO register set to the test value.\r
\r
  @param  PciIo             The PCI IO protocol instance.\r
  @param  Offset            The MMIO address to test.\r
  @param  MaskValue         The mask value of memory.\r
  @param  TestValue         The test value of memory.\r
  @param  Timeout           The time out value for wait memory set, uses 100ns as a unit.\r
\r
  @retval EFI_TIMEOUT       The MMIO setting is time out.\r
  @retval EFI_SUCCESS       The MMIO is correct set.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AhciWaitMmioSet (\r
  IN  EFI_PCI_IO_PROTOCOL       *PciIo,\r
  IN  UINTN                     Offset,\r
  IN  UINT32                    MaskValue,\r
  IN  UINT32                    TestValue,\r
  IN  UINT64                    Timeout\r
  )\r
{\r
  UINT32     Value;\r
  UINT64     Delay;\r
  BOOLEAN    InfiniteWait;\r
\r
  if (Timeout == 0) {\r
    InfiniteWait = TRUE;\r
  } else {\r
    InfiniteWait = FALSE;\r
  }\r
\r
  Delay = DivU64x32 (Timeout, 1000) + 1;\r
\r
  do {\r
    //\r
    // Access PCI MMIO space to see if the value is the tested one.\r
    //\r
    Value = AhciReadReg (PciIo, (UINT32) Offset) & MaskValue;\r
\r
    if (Value == TestValue) {\r
      return EFI_SUCCESS;\r
    }\r
\r
    //\r
    // Stall for 100 microseconds.\r
    //\r
    MicroSecondDelay (100);\r
\r
    Delay--;\r
\r
  } while (InfiniteWait || (Delay > 0));\r
\r
  return EFI_TIMEOUT;\r
}\r
\r
/**\r
  Wait for the value of the specified system memory set to the test value.\r
\r
  @param  Address           The system memory address to test.\r
  @param  MaskValue         The mask value of memory.\r
  @param  TestValue         The test value of memory.\r
  @param  Timeout           The time out value for wait memory set, uses 100ns as a unit.\r
\r
  @retval EFI_TIMEOUT       The system memory setting is time out.\r
  @retval EFI_SUCCESS       The system memory is correct set.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AhciWaitMemSet (\r
  IN  EFI_PHYSICAL_ADDRESS      Address,\r
  IN  UINT32                    MaskValue,\r
  IN  UINT32                    TestValue,\r
  IN  UINT64                    Timeout\r
  )\r
{\r
  UINT32     Value;\r
  UINT64     Delay;\r
  BOOLEAN    InfiniteWait;\r
\r
  if (Timeout == 0) {\r
    InfiniteWait = TRUE;\r
  } else {\r
    InfiniteWait = FALSE;\r
  }\r
\r
  Delay =  DivU64x32 (Timeout, 1000) + 1;\r
\r
  do {\r
    //\r
    // Access system memory to see if the value is the tested one.\r
    //\r
    // The system memory pointed by Address will be updated by the\r
    // SATA Host Controller, "volatile" is introduced to prevent\r
    // compiler from optimizing the access to the memory address\r
    // to only read once.\r
    //\r
    Value  = *(volatile UINT32 *) (UINTN) Address;\r
    Value &= MaskValue;\r
\r
    if (Value == TestValue) {\r
      return EFI_SUCCESS;\r
    }\r
\r
    //\r
    // Stall for 100 microseconds.\r
    //\r
    MicroSecondDelay (100);\r
\r
    Delay--;\r
\r
  } while (InfiniteWait || (Delay > 0));\r
\r
  return EFI_TIMEOUT;\r
}\r
\r
/**\r
  Check the memory status to the test value.\r
\r
  @param[in] Address    The memory address to test.\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 memory is not set.\r
  @retval EFI_SUCCESS       The memory is correct set.\r
**/\r
EFI_STATUS\r
EFIAPI\r
AhciCheckMemSet (\r
  IN     UINTN                     Address,\r
  IN     UINT32                    MaskValue,\r
  IN     UINT32                    TestValue\r
  )\r
{\r
  UINT32     Value;\r
\r
  Value  = *(volatile UINT32 *) Address;\r
  Value &= MaskValue;\r
\r
  if (Value == TestValue) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  return EFI_NOT_READY;\r
}\r
\r
\r
/**\r
\r
  Clear the port interrupt and error status. It will also clear\r
  HBA interrupt status.\r
\r
  @param      PciIo          The PCI IO protocol instance.\r
  @param      Port           The number of port.\r
\r
**/\r
VOID\r
EFIAPI\r
AhciClearPortStatus (\r
  IN  EFI_PCI_IO_PROTOCOL    *PciIo,\r
  IN  UINT8                  Port\r
  )\r
{\r
  UINT32 Offset;\r
\r
  //\r
  // Clear any error status\r
  //\r
  Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_SERR;\r
  AhciWriteReg (PciIo, Offset, AhciReadReg (PciIo, Offset));\r
\r
  //\r
  // Clear any port interrupt status\r
  //\r
  Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_IS;\r
  AhciWriteReg (PciIo, Offset, AhciReadReg (PciIo, Offset));\r
\r
  //\r
  // Clear any HBA interrupt status\r
  //\r
  AhciWriteReg (PciIo, EFI_AHCI_IS_OFFSET, AhciReadReg (PciIo, EFI_AHCI_IS_OFFSET));\r
}\r
\r
/**\r
  This function is used to dump the Status Registers and if there is ERR bit set\r
  in the Status Register, the Error Register's value is also be dumped.\r
\r
  @param  PciIo            The PCI IO protocol instance.\r
  @param  AhciRegisters    The pointer to the EFI_AHCI_REGISTERS.\r
  @param  Port             The number of port.\r
  @param  AtaStatusBlock   A pointer to EFI_ATA_STATUS_BLOCK data structure.\r
\r
**/\r
VOID\r
EFIAPI\r
AhciDumpPortStatus (\r
  IN     EFI_PCI_IO_PROTOCOL        *PciIo,\r
  IN     EFI_AHCI_REGISTERS         *AhciRegisters,\r
  IN     UINT8                      Port,\r
  IN OUT EFI_ATA_STATUS_BLOCK       *AtaStatusBlock\r
  )\r
{\r
  UINTN                Offset;\r
  UINT32               Data;\r
  UINTN                FisBaseAddr;\r
  EFI_STATUS           Status;\r
\r
  ASSERT (PciIo != NULL);\r
\r
  if (AtaStatusBlock != NULL) {\r
    ZeroMem (AtaStatusBlock, sizeof (EFI_ATA_STATUS_BLOCK));\r
\r
    FisBaseAddr = (UINTN)AhciRegisters->AhciRFis + Port * sizeof (EFI_AHCI_RECEIVED_FIS);\r
    Offset      = FisBaseAddr + EFI_AHCI_D2H_FIS_OFFSET;\r
\r
    Status = AhciCheckMemSet (Offset, EFI_AHCI_FIS_TYPE_MASK, EFI_AHCI_FIS_REGISTER_D2H);\r
    if (!EFI_ERROR (Status)) {\r
      //\r
      // If D2H FIS is received, update StatusBlock with its content.\r
      //\r
      CopyMem (AtaStatusBlock, (UINT8 *)Offset, sizeof (EFI_ATA_STATUS_BLOCK));\r
    } else {\r
      //\r
      // If D2H FIS is not received, only update Status & Error field through PxTFD\r
      // as there is no other way to get the content of the Shadow Register Block.\r
      //\r
      Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_TFD;\r
      Data   = AhciReadReg (PciIo, (UINT32)Offset);\r
\r
      AtaStatusBlock->AtaStatus  = (UINT8)Data;\r
      if ((AtaStatusBlock->AtaStatus & BIT0) != 0) {\r
        AtaStatusBlock->AtaError = (UINT8)(Data >> 8);\r
      }\r
    }\r
  }\r
}\r
\r
\r
/**\r
  Enable the FIS running for giving port.\r
\r
  @param      PciIo          The PCI IO protocol instance.\r
  @param      Port           The number of port.\r
  @param      Timeout        The timeout value of enabling FIS, uses 100ns as a unit.\r
\r
  @retval EFI_DEVICE_ERROR   The FIS enable setting fails.\r
  @retval EFI_TIMEOUT        The FIS enable setting is time out.\r
  @retval EFI_SUCCESS        The FIS enable successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AhciEnableFisReceive (\r
  IN  EFI_PCI_IO_PROTOCOL       *PciIo,\r
  IN  UINT8                     Port,\r
  IN  UINT64                    Timeout\r
  )\r
{\r
  UINT32 Offset;\r
\r
  Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_CMD;\r
  AhciOrReg (PciIo, Offset, EFI_AHCI_PORT_CMD_FRE);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Disable the FIS running for giving port.\r
\r
  @param      PciIo          The PCI IO protocol instance.\r
  @param      Port           The number of port.\r
  @param      Timeout        The timeout value of disabling FIS, uses 100ns as a unit.\r
\r
  @retval EFI_DEVICE_ERROR   The FIS disable setting fails.\r
  @retval EFI_TIMEOUT        The FIS disable setting is time out.\r
  @retval EFI_UNSUPPORTED    The port is in running state.\r
  @retval EFI_SUCCESS        The FIS disable successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AhciDisableFisReceive (\r
  IN  EFI_PCI_IO_PROTOCOL       *PciIo,\r
  IN  UINT8                     Port,\r
  IN  UINT64                    Timeout\r
  )\r
{\r
  UINT32 Offset;\r
  UINT32 Data;\r
\r
  Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_CMD;\r
  Data   = AhciReadReg (PciIo, Offset);\r
\r
  //\r
  // Before disabling Fis receive, the DMA engine of the port should NOT be in running status.\r
  //\r
  if ((Data & (EFI_AHCI_PORT_CMD_ST | EFI_AHCI_PORT_CMD_CR)) != 0) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Check if the Fis receive DMA engine for the port is running.\r
  //\r
  if ((Data & EFI_AHCI_PORT_CMD_FR) != EFI_AHCI_PORT_CMD_FR) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  AhciAndReg (PciIo, Offset, (UINT32)~(EFI_AHCI_PORT_CMD_FRE));\r
\r
  return AhciWaitMmioSet (\r
           PciIo,\r
           Offset,\r
           EFI_AHCI_PORT_CMD_FR,\r
           0,\r
           Timeout\r
           );\r
}\r
\r
\r
\r
/**\r
  Build the command list, command table and prepare the fis receiver.\r
\r
  @param    PciIo                 The PCI IO protocol instance.\r
  @param    AhciRegisters         The pointer to the EFI_AHCI_REGISTERS.\r
  @param    Port                  The number of port.\r
  @param    PortMultiplier        The timeout value of stop.\r
  @param    CommandFis            The control fis will be used for the transfer.\r
  @param    CommandList           The command list will be used for the transfer.\r
  @param    AtapiCommand          The atapi command will be used for the transfer.\r
  @param    AtapiCommandLength    The length of the atapi command.\r
  @param    CommandSlotNumber     The command slot will be used for the transfer.\r
  @param    DataPhysicalAddr      The pointer to the data buffer pci bus master address.\r
  @param    DataLength            The data count to be transferred.\r
\r
**/\r
VOID\r
EFIAPI\r
AhciBuildCommand (\r
  IN     EFI_PCI_IO_PROTOCOL        *PciIo,\r
  IN     EFI_AHCI_REGISTERS         *AhciRegisters,\r
  IN     UINT8                      Port,\r
  IN     UINT8                      PortMultiplier,\r
  IN     EFI_AHCI_COMMAND_FIS       *CommandFis,\r
  IN     EFI_AHCI_COMMAND_LIST      *CommandList,\r
  IN     EFI_AHCI_ATAPI_COMMAND     *AtapiCommand OPTIONAL,\r
  IN     UINT8                      AtapiCommandLength,\r
  IN     UINT8                      CommandSlotNumber,\r
  IN OUT VOID                       *DataPhysicalAddr,\r
  IN     UINT32                     DataLength\r
  )\r
{\r
  UINT64     BaseAddr;\r
  UINT32     PrdtNumber;\r
  UINT32     PrdtIndex;\r
  UINTN      RemainedData;\r
  UINTN      MemAddr;\r
  DATA_64    Data64;\r
  UINT32     Offset;\r
\r
  //\r
  // Filling the PRDT\r
  //\r
  PrdtNumber = (UINT32)DivU64x32 (((UINT64)DataLength + EFI_AHCI_MAX_DATA_PER_PRDT - 1), EFI_AHCI_MAX_DATA_PER_PRDT);\r
\r
  //\r
  // According to AHCI 1.3 spec, a PRDT entry can point to a maximum 4MB data block.\r
  // It also limits that the maximum amount of the PRDT entry in the command table\r
  // is 65535.\r
  //\r
  ASSERT (PrdtNumber <= 65535);\r
\r
  Data64.Uint64 = (UINTN) (AhciRegisters->AhciRFis) + sizeof (EFI_AHCI_RECEIVED_FIS) * Port;\r
\r
  BaseAddr = Data64.Uint64;\r
\r
  ZeroMem ((VOID *)((UINTN) BaseAddr), sizeof (EFI_AHCI_RECEIVED_FIS));\r
\r
  ZeroMem (AhciRegisters->AhciCommandTable, sizeof (EFI_AHCI_COMMAND_TABLE));\r
\r
  CommandFis->AhciCFisPmNum = PortMultiplier;\r
\r
  CopyMem (&AhciRegisters->AhciCommandTable->CommandFis, CommandFis, sizeof (EFI_AHCI_COMMAND_FIS));\r
\r
  Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_CMD;\r
  if (AtapiCommand != NULL) {\r
    CopyMem (\r
      &AhciRegisters->AhciCommandTable->AtapiCmd,\r
      AtapiCommand,\r
      AtapiCommandLength\r
      );\r
\r
    CommandList->AhciCmdA = 1;\r
    CommandList->AhciCmdP = 1;\r
\r
    AhciOrReg (PciIo, Offset, (EFI_AHCI_PORT_CMD_DLAE | EFI_AHCI_PORT_CMD_ATAPI));\r
  } else {\r
    AhciAndReg (PciIo, Offset, (UINT32)~(EFI_AHCI_PORT_CMD_DLAE | EFI_AHCI_PORT_CMD_ATAPI));\r
  }\r
\r
  RemainedData = (UINTN) DataLength;\r
  MemAddr      = (UINTN) DataPhysicalAddr;\r
  CommandList->AhciCmdPrdtl = PrdtNumber;\r
\r
  for (PrdtIndex = 0; PrdtIndex < PrdtNumber; PrdtIndex++) {\r
    if (RemainedData < EFI_AHCI_MAX_DATA_PER_PRDT) {\r
      AhciRegisters->AhciCommandTable->PrdtTable[PrdtIndex].AhciPrdtDbc = (UINT32)RemainedData - 1;\r
    } else {\r
      AhciRegisters->AhciCommandTable->PrdtTable[PrdtIndex].AhciPrdtDbc = EFI_AHCI_MAX_DATA_PER_PRDT - 1;\r
    }\r
\r
    Data64.Uint64 = (UINT64)MemAddr;\r
    AhciRegisters->AhciCommandTable->PrdtTable[PrdtIndex].AhciPrdtDba  = Data64.Uint32.Lower32;\r
    AhciRegisters->AhciCommandTable->PrdtTable[PrdtIndex].AhciPrdtDbau = Data64.Uint32.Upper32;\r
    RemainedData -= EFI_AHCI_MAX_DATA_PER_PRDT;\r
    MemAddr      += EFI_AHCI_MAX_DATA_PER_PRDT;\r
  }\r
\r
  //\r
  // Set the last PRDT to Interrupt On Complete\r
  //\r
  if (PrdtNumber > 0) {\r
    AhciRegisters->AhciCommandTable->PrdtTable[PrdtNumber - 1].AhciPrdtIoc = 1;\r
  }\r
\r
  CopyMem (\r
    (VOID *) ((UINTN) AhciRegisters->AhciCmdList + (UINTN) CommandSlotNumber * sizeof (EFI_AHCI_COMMAND_LIST)),\r
    CommandList,\r
    sizeof (EFI_AHCI_COMMAND_LIST)\r
    );\r
\r
  Data64.Uint64 = (UINT64)(UINTN) AhciRegisters->AhciCommandTablePciAddr;\r
  AhciRegisters->AhciCmdList[CommandSlotNumber].AhciCmdCtba  = Data64.Uint32.Lower32;\r
  AhciRegisters->AhciCmdList[CommandSlotNumber].AhciCmdCtbau = Data64.Uint32.Upper32;\r
  AhciRegisters->AhciCmdList[CommandSlotNumber].AhciCmdPmp   = PortMultiplier;\r
\r
}\r
\r
/**\r
  Build a command FIS.\r
\r
  @param  CmdFis            A pointer to the EFI_AHCI_COMMAND_FIS data structure.\r
  @param  AtaCommandBlock   A pointer to the AhciBuildCommandFis data structure.\r
\r
**/\r
VOID\r
EFIAPI\r
AhciBuildCommandFis (\r
  IN OUT EFI_AHCI_COMMAND_FIS    *CmdFis,\r
  IN     EFI_ATA_COMMAND_BLOCK   *AtaCommandBlock\r
  )\r
{\r
  ZeroMem (CmdFis, sizeof (EFI_AHCI_COMMAND_FIS));\r
\r
  CmdFis->AhciCFisType = EFI_AHCI_FIS_REGISTER_H2D;\r
  //\r
  // Indicator it's a command\r
  //\r
  CmdFis->AhciCFisCmdInd      = 0x1;\r
  CmdFis->AhciCFisCmd         = AtaCommandBlock->AtaCommand;\r
\r
  CmdFis->AhciCFisFeature     = AtaCommandBlock->AtaFeatures;\r
  CmdFis->AhciCFisFeatureExp  = AtaCommandBlock->AtaFeaturesExp;\r
\r
  CmdFis->AhciCFisSecNum      = AtaCommandBlock->AtaSectorNumber;\r
  CmdFis->AhciCFisSecNumExp   = AtaCommandBlock->AtaSectorNumberExp;\r
\r
  CmdFis->AhciCFisClyLow      = AtaCommandBlock->AtaCylinderLow;\r
  CmdFis->AhciCFisClyLowExp   = AtaCommandBlock->AtaCylinderLowExp;\r
\r
  CmdFis->AhciCFisClyHigh     = AtaCommandBlock->AtaCylinderHigh;\r
  CmdFis->AhciCFisClyHighExp  = AtaCommandBlock->AtaCylinderHighExp;\r
\r
  CmdFis->AhciCFisSecCount    = AtaCommandBlock->AtaSectorCount;\r
  CmdFis->AhciCFisSecCountExp = AtaCommandBlock->AtaSectorCountExp;\r
\r
  CmdFis->AhciCFisDevHead     = (UINT8) (AtaCommandBlock->AtaDeviceHead | 0xE0);\r
}\r
\r
/**\r
  Wait until SATA device reports it is ready for operation.\r
\r
  @param[in] PciIo    Pointer to AHCI controller PciIo.\r
  @param[in] Port     SATA port index on which to reset.\r
\r
  @retval EFI_SUCCESS  Device ready for operation.\r
  @retval EFI_TIMEOUT  Device failed to get ready within required period.\r
**/\r
EFI_STATUS\r
AhciWaitDeviceReady (\r
  IN EFI_PCI_IO_PROTOCOL  *PciIo,\r
  IN UINT8                Port\r
   )\r
{\r
  UINT32      PhyDetectDelay;\r
  UINT32      Data;\r
  UINT32      Offset;\r
\r
  //\r
  // According to SATA1.0a spec section 5.2, we need to wait for PxTFD.BSY and PxTFD.DRQ\r
  // and PxTFD.ERR to be zero. The maximum wait time is 16s which is defined at ATA spec.\r
  //\r
  PhyDetectDelay = 16 * 1000;\r
  do {\r
    Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_SERR;\r
    if (AhciReadReg(PciIo, Offset) != 0) {\r
      AhciWriteReg (PciIo, Offset, AhciReadReg(PciIo, Offset));\r
    }\r
    Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_TFD;\r
\r
    Data = AhciReadReg (PciIo, Offset) & EFI_AHCI_PORT_TFD_MASK;\r
    if (Data == 0) {\r
      break;\r
    }\r
\r
    MicroSecondDelay (1000);\r
    PhyDetectDelay--;\r
  } while (PhyDetectDelay > 0);\r
\r
  if (PhyDetectDelay == 0) {\r
    DEBUG ((DEBUG_ERROR, "Port %d Device not ready (TFD=0x%X)\n", Port, Data));\r
    return EFI_TIMEOUT;\r
  } else {\r
    return EFI_SUCCESS;\r
  }\r
}\r
\r
\r
/**\r
  Reset the SATA port. Algorithm follows AHCI spec 1.3.1 section 10.4.2\r
\r
  @param[in] PciIo    Pointer to AHCI controller PciIo.\r
  @param[in] Port     SATA port index on which to reset.\r
\r
  @retval EFI_SUCCESS  Port reset.\r
  @retval Others       Failed to reset the port.\r
**/\r
EFI_STATUS\r
AhciResetPort (\r
  IN EFI_PCI_IO_PROTOCOL  *PciIo,\r
  IN UINT8                Port\r
  )\r
{\r
  UINT32      Offset;\r
  EFI_STATUS  Status;\r
\r
  Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_SCTL;\r
  AhciOrReg (PciIo, Offset, EFI_AHCI_PORT_SCTL_DET_INIT);\r
  //\r
  // SW is required to keep DET set to 0x1 at least for 1 milisecond to ensure that\r
  // at least one COMRESET signal is sent.\r
  //\r
  MicroSecondDelay(1000);\r
  AhciAndReg (PciIo, Offset, ~(UINT32)EFI_AHCI_PORT_SSTS_DET_MASK);\r
\r
  Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_SSTS;\r
  Status = AhciWaitMmioSet (PciIo, Offset, EFI_AHCI_PORT_SSTS_DET_MASK, EFI_AHCI_PORT_SSTS_DET_PCE, ATA_ATAPI_TIMEOUT);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  return AhciWaitDeviceReady (PciIo, Port);\r
}\r
\r
/**\r
  Recovers the SATA port from error condition.\r
  This function implements algorithm described in\r
  AHCI spec 1.3.1 section 6.2.2\r
\r
  @param[in] PciIo    Pointer to AHCI controller PciIo.\r
  @param[in] Port     SATA port index on which to check.\r
\r
  @retval EFI_SUCCESS  Port recovered.\r
  @retval Others       Failed to recover port.\r
**/\r
EFI_STATUS\r
AhciRecoverPortError (\r
  IN EFI_PCI_IO_PROTOCOL  *PciIo,\r
  IN UINT8                Port\r
  )\r
{\r
  UINT32      Offset;\r
  UINT32      PortInterrupt;\r
  UINT32      PortTfd;\r
  EFI_STATUS  Status;\r
\r
  Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_IS;\r
  PortInterrupt = AhciReadReg (PciIo, Offset);\r
  if ((PortInterrupt & EFI_AHCI_PORT_IS_FATAL_ERROR_MASK) == 0) {\r
    //\r
    // No fatal error detected. Exit with success as port should still be operational.\r
    // No need to clear IS as it will be cleared when the next command starts.\r
    //\r
    return EFI_SUCCESS;\r
  }\r
\r
  Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_CMD;\r
  AhciAndReg (PciIo, Offset, ~(UINT32)EFI_AHCI_PORT_CMD_ST);\r
\r
  Status = AhciWaitMmioSet (PciIo, Offset, EFI_AHCI_PORT_CMD_CR, 0, ATA_ATAPI_TIMEOUT);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "Ahci port %d is in hung state, aborting recovery\n", Port));\r
    return Status;\r
  }\r
\r
  //\r
  // If TFD.BSY or TFD.DRQ is still set it means that drive is hung and software has\r
  // to reset it before sending any additional commands.\r
  //\r
  Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_TFD;\r
  PortTfd = AhciReadReg (PciIo, Offset);\r
  if ((PortTfd & (EFI_AHCI_PORT_TFD_BSY | EFI_AHCI_PORT_TFD_DRQ)) != 0) {\r
    Status = AhciResetPort (PciIo, Port);\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((DEBUG_ERROR, "Failed to reset the port %d\n", Port));\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Checks if specified FIS has been received.\r
\r
  @param[in] PciIo    Pointer to AHCI controller PciIo.\r
  @param[in] Port     SATA port index on which to check.\r
  @param[in] FisType  FIS type for which to check.\r
\r
  @retval EFI_SUCCESS       FIS received.\r
  @retval EFI_NOT_READY     FIS not received yet.\r
  @retval EFI_DEVICE_ERROR  AHCI controller reported an error on port.\r
**/\r
EFI_STATUS\r
AhciCheckFisReceived (\r
  IN EFI_PCI_IO_PROTOCOL  *PciIo,\r
  IN UINT8                Port,\r
  IN SATA_FIS_TYPE        FisType\r
  )\r
{\r
  UINT32      Offset;\r
  UINT32      PortInterrupt;\r
  UINT32      PortTfd;\r
\r
  Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_IS;\r
  PortInterrupt = AhciReadReg (PciIo, Offset);\r
  if ((PortInterrupt & EFI_AHCI_PORT_IS_ERROR_MASK) != 0) {\r
    DEBUG ((DEBUG_ERROR, "AHCI: Error interrupt reported PxIS: %X\n", PortInterrupt));\r
    return EFI_DEVICE_ERROR;\r
  }\r
  //\r
  // For PIO setup FIS - According to SATA 2.6 spec section 11.7, D2h FIS means an error encountered.\r
  // But Qemu and Marvel 9230 sata controller may just receive a D2h FIS from device\r
  // after the transaction is finished successfully.\r
  // To get better device compatibilities, we further check if the PxTFD's ERR bit is set.\r
  // By this way, we can know if there is a real error happened.\r
  //\r
  if (((FisType == SataFisD2H) && ((PortInterrupt & EFI_AHCI_PORT_IS_DHRS) != 0)) ||\r
      ((FisType == SataFisPioSetup) && (PortInterrupt & (EFI_AHCI_PORT_IS_PSS | EFI_AHCI_PORT_IS_DHRS)) != 0) ||\r
      ((FisType == SataFisDmaSetup) && (PortInterrupt & (EFI_AHCI_PORT_IS_DSS | EFI_AHCI_PORT_IS_DHRS)) != 0)) {\r
    Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_TFD;\r
    PortTfd = AhciReadReg (PciIo, (UINT32) Offset);\r
    if ((PortTfd & EFI_AHCI_PORT_TFD_ERR) != 0) {\r
      return EFI_DEVICE_ERROR;\r
    } else {\r
      return EFI_SUCCESS;\r
    }\r
  }\r
\r
  return EFI_NOT_READY;\r
}\r
\r
/**\r
  Waits until specified FIS has been received.\r
\r
  @param[in] PciIo    Pointer to AHCI controller PciIo.\r
  @param[in] Port     SATA port index on which to check.\r
  @param[in] Timeout  Time after which function should stop polling.\r
  @param[in] FisType  FIS type for which to check.\r
\r
  @retval EFI_SUCCESS       FIS received.\r
  @retval EFI_TIMEOUT       FIS failed to arrive within a specified time period.\r
  @retval EFI_DEVICE_ERROR  AHCI controller reported an error on port.\r
**/\r
EFI_STATUS\r
AhciWaitUntilFisReceived (\r
  IN EFI_PCI_IO_PROTOCOL  *PciIo,\r
  IN UINT8                Port,\r
  IN UINT64               Timeout,\r
  IN SATA_FIS_TYPE        FisType\r
  )\r
{\r
  EFI_STATUS  Status;\r
  BOOLEAN     InfiniteWait;\r
  UINT64      Delay;\r
\r
  Delay =  DivU64x32 (Timeout, 1000) + 1;\r
  if (Timeout == 0) {\r
    InfiniteWait = TRUE;\r
  } else {\r
    InfiniteWait = FALSE;\r
  }\r
\r
  do {\r
    Status = AhciCheckFisReceived (PciIo, Port, FisType);\r
    if (Status != EFI_NOT_READY) {\r
      return Status;\r
    }\r
    //\r
    // Stall for 100 microseconds.\r
    //\r
    MicroSecondDelay (100);\r
    Delay--;\r
  } while (InfiniteWait || (Delay > 0));\r
\r
  return EFI_TIMEOUT;\r
}\r
\r
/**\r
  Start a PIO data transfer on specific port.\r
\r
  @param[in]       PciIo               The PCI IO protocol instance.\r
  @param[in]       AhciRegisters       The pointer to the EFI_AHCI_REGISTERS.\r
  @param[in]       Port                The number of port.\r
  @param[in]       PortMultiplier      The timeout value of stop.\r
  @param[in]       AtapiCommand        The atapi command will be used for the\r
                                       transfer.\r
  @param[in]       AtapiCommandLength  The length of the atapi command.\r
  @param[in]       Read                The transfer direction.\r
  @param[in]       AtaCommandBlock     The EFI_ATA_COMMAND_BLOCK data.\r
  @param[in, out]  AtaStatusBlock      The EFI_ATA_STATUS_BLOCK data.\r
  @param[in, out]  MemoryAddr          The pointer to the data buffer.\r
  @param[in]       DataCount           The data count to be transferred.\r
  @param[in]       Timeout             The timeout value of non data transfer, uses 100ns as a unit.\r
  @param[in]       Task                Optional. Pointer to the ATA_NONBLOCK_TASK\r
                                       used by non-blocking mode.\r
\r
  @retval EFI_DEVICE_ERROR    The PIO data transfer abort with error occurs.\r
  @retval EFI_TIMEOUT         The operation is time out.\r
  @retval EFI_UNSUPPORTED     The device is not ready for transfer.\r
  @retval EFI_SUCCESS         The PIO data transfer executes successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AhciPioTransfer (\r
  IN     EFI_PCI_IO_PROTOCOL        *PciIo,\r
  IN     EFI_AHCI_REGISTERS         *AhciRegisters,\r
  IN     UINT8                      Port,\r
  IN     UINT8                      PortMultiplier,\r
  IN     EFI_AHCI_ATAPI_COMMAND     *AtapiCommand OPTIONAL,\r
  IN     UINT8                      AtapiCommandLength,\r
  IN     BOOLEAN                    Read,\r
  IN     EFI_ATA_COMMAND_BLOCK      *AtaCommandBlock,\r
  IN OUT EFI_ATA_STATUS_BLOCK       *AtaStatusBlock,\r
  IN OUT VOID                       *MemoryAddr,\r
  IN     UINT32                     DataCount,\r
  IN     UINT64                     Timeout,\r
  IN     ATA_NONBLOCK_TASK          *Task\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  EFI_PHYSICAL_ADDRESS          PhyAddr;\r
  VOID                          *Map;\r
  UINTN                         MapLength;\r
  EFI_PCI_IO_PROTOCOL_OPERATION Flag;\r
  EFI_AHCI_COMMAND_FIS          CFis;\r
  EFI_AHCI_COMMAND_LIST         CmdList;\r
  UINT32                        PrdCount;\r
\r
  if (Read) {\r
    Flag = EfiPciIoOperationBusMasterWrite;\r
  } else {\r
    Flag = EfiPciIoOperationBusMasterRead;\r
  }\r
\r
  //\r
  // construct command list and command table with pci bus address\r
  //\r
  MapLength = DataCount;\r
  Status = PciIo->Map (\r
                    PciIo,\r
                    Flag,\r
                    MemoryAddr,\r
                    &MapLength,\r
                    &PhyAddr,\r
                    &Map\r
                    );\r
\r
  if (EFI_ERROR (Status) || (DataCount != MapLength)) {\r
    return EFI_BAD_BUFFER_SIZE;\r
  }\r
\r
  //\r
  // Package read needed\r
  //\r
  AhciBuildCommandFis (&CFis, AtaCommandBlock);\r
\r
  ZeroMem (&CmdList, sizeof (EFI_AHCI_COMMAND_LIST));\r
\r
  CmdList.AhciCmdCfl = EFI_AHCI_FIS_REGISTER_H2D_LENGTH / 4;\r
  CmdList.AhciCmdW   = Read ? 0 : 1;\r
\r
  AhciBuildCommand (\r
    PciIo,\r
    AhciRegisters,\r
    Port,\r
    PortMultiplier,\r
    &CFis,\r
    &CmdList,\r
    AtapiCommand,\r
    AtapiCommandLength,\r
    0,\r
    (VOID *)(UINTN)PhyAddr,\r
    DataCount\r
    );\r
\r
  Status = AhciStartCommand (\r
             PciIo,\r
             Port,\r
             0,\r
             Timeout\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto Exit;\r
  }\r
\r
  if (Read && (AtapiCommand == 0)) {\r
    Status = AhciWaitUntilFisReceived (PciIo, Port, Timeout, SataFisPioSetup);\r
    if (Status == EFI_SUCCESS) {\r
      PrdCount = *(volatile UINT32 *) (&(AhciRegisters->AhciCmdList[0].AhciCmdPrdbc));\r
      if (PrdCount == DataCount) {\r
        Status = EFI_SUCCESS;\r
      } else {\r
        Status = EFI_DEVICE_ERROR;\r
      }\r
    }\r
  } else {\r
    Status = AhciWaitUntilFisReceived (PciIo, Port, Timeout, SataFisD2H);\r
  }\r
\r
  if (Status == EFI_DEVICE_ERROR) {\r
    AhciRecoverPortError (PciIo, Port);\r
  }\r
\r
Exit:\r
  AhciStopCommand (\r
    PciIo,\r
    Port,\r
    Timeout\r
    );\r
\r
  AhciDisableFisReceive (\r
    PciIo,\r
    Port,\r
    Timeout\r
    );\r
\r
  PciIo->Unmap (\r
    PciIo,\r
    Map\r
    );\r
\r
  AhciDumpPortStatus (PciIo, AhciRegisters, Port, AtaStatusBlock);\r
\r
  return Status;\r
}\r
\r
/**\r
  Start a DMA data transfer on specific port\r
\r
  @param[in]       Instance            The ATA_ATAPI_PASS_THRU_INSTANCE protocol instance.\r
  @param[in]       AhciRegisters       The pointer to the EFI_AHCI_REGISTERS.\r
  @param[in]       Port                The number of port.\r
  @param[in]       PortMultiplier      The timeout value of stop.\r
  @param[in]       AtapiCommand        The atapi command will be used for the\r
                                       transfer.\r
  @param[in]       AtapiCommandLength  The length of the atapi command.\r
  @param[in]       Read                The transfer direction.\r
  @param[in]       AtaCommandBlock     The EFI_ATA_COMMAND_BLOCK data.\r
  @param[in, out]  AtaStatusBlock      The EFI_ATA_STATUS_BLOCK data.\r
  @param[in, out]  MemoryAddr          The pointer to the data buffer.\r
  @param[in]       DataCount           The data count to be transferred.\r
  @param[in]       Timeout             The timeout value of non data transfer, uses 100ns as a unit.\r
  @param[in]       Task                Optional. Pointer to the ATA_NONBLOCK_TASK\r
                                       used by non-blocking mode.\r
\r
  @retval EFI_DEVICE_ERROR    The DMA data transfer abort with error occurs.\r
  @retval EFI_TIMEOUT         The operation is time out.\r
  @retval EFI_UNSUPPORTED     The device is not ready for transfer.\r
  @retval EFI_SUCCESS         The DMA data transfer executes successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AhciDmaTransfer (\r
  IN     ATA_ATAPI_PASS_THRU_INSTANCE *Instance,\r
  IN     EFI_AHCI_REGISTERS         *AhciRegisters,\r
  IN     UINT8                      Port,\r
  IN     UINT8                      PortMultiplier,\r
  IN     EFI_AHCI_ATAPI_COMMAND     *AtapiCommand OPTIONAL,\r
  IN     UINT8                      AtapiCommandLength,\r
  IN     BOOLEAN                    Read,\r
  IN     EFI_ATA_COMMAND_BLOCK      *AtaCommandBlock,\r
  IN OUT EFI_ATA_STATUS_BLOCK       *AtaStatusBlock,\r
  IN OUT VOID                       *MemoryAddr,\r
  IN     UINT32                     DataCount,\r
  IN     UINT64                     Timeout,\r
  IN     ATA_NONBLOCK_TASK          *Task\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  EFI_PHYSICAL_ADDRESS          PhyAddr;\r
  VOID                          *Map;\r
  UINTN                         MapLength;\r
  EFI_PCI_IO_PROTOCOL_OPERATION Flag;\r
  EFI_AHCI_COMMAND_FIS          CFis;\r
  EFI_AHCI_COMMAND_LIST         CmdList;\r
\r
  EFI_PCI_IO_PROTOCOL           *PciIo;\r
  EFI_TPL                       OldTpl;\r
\r
  Map   = NULL;\r
  PciIo = Instance->PciIo;\r
\r
  if (PciIo == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Before starting the Blocking BlockIO operation, push to finish all non-blocking\r
  // BlockIO tasks.\r
  // Delay 100us to simulate the blocking time out checking.\r
  //\r
  OldTpl = gBS->RaiseTPL (TPL_NOTIFY);\r
  while ((Task == NULL) && (!IsListEmpty (&Instance->NonBlockingTaskList))) {\r
    AsyncNonBlockingTransferRoutine (NULL, Instance);\r
    //\r
    // Stall for 100us.\r
    //\r
    MicroSecondDelay (100);\r
  }\r
  gBS->RestoreTPL (OldTpl);\r
\r
  if ((Task == NULL) || ((Task != NULL) && (!Task->IsStart))) {\r
    //\r
    // Mark the Task to indicate that it has been started.\r
    //\r
    if (Task != NULL) {\r
      Task->IsStart      = TRUE;\r
    }\r
    if (Read) {\r
      Flag = EfiPciIoOperationBusMasterWrite;\r
    } else {\r
      Flag = EfiPciIoOperationBusMasterRead;\r
    }\r
\r
    //\r
    // Construct command list and command table with pci bus address.\r
    //\r
    MapLength = DataCount;\r
    Status = PciIo->Map (\r
                      PciIo,\r
                      Flag,\r
                      MemoryAddr,\r
                      &MapLength,\r
                      &PhyAddr,\r
                      &Map\r
                      );\r
\r
    if (EFI_ERROR (Status) || (DataCount != MapLength)) {\r
      return EFI_BAD_BUFFER_SIZE;\r
    }\r
\r
    if (Task != NULL) {\r
      Task->Map = Map;\r
    }\r
    //\r
    // Package read needed\r
    //\r
    AhciBuildCommandFis (&CFis, AtaCommandBlock);\r
\r
    ZeroMem (&CmdList, sizeof (EFI_AHCI_COMMAND_LIST));\r
\r
    CmdList.AhciCmdCfl = EFI_AHCI_FIS_REGISTER_H2D_LENGTH / 4;\r
    CmdList.AhciCmdW   = Read ? 0 : 1;\r
\r
    AhciBuildCommand (\r
      PciIo,\r
      AhciRegisters,\r
      Port,\r
      PortMultiplier,\r
      &CFis,\r
      &CmdList,\r
      AtapiCommand,\r
      AtapiCommandLength,\r
      0,\r
      (VOID *)(UINTN)PhyAddr,\r
      DataCount\r
      );\r
\r
    Status = AhciStartCommand (\r
               PciIo,\r
               Port,\r
               0,\r
               Timeout\r
               );\r
    if (EFI_ERROR (Status)) {\r
      goto Exit;\r
    }\r
  }\r
\r
  if (Task != NULL) {\r
    Status = AhciCheckFisReceived (PciIo, Port, SataFisD2H);\r
    if (Status == EFI_NOT_READY) {\r
      if (!Task->InfiniteWait && Task->RetryTimes == 0) {\r
        Status = EFI_TIMEOUT;\r
      } else {\r
        Task->RetryTimes--;\r
      }\r
    }\r
  } else {\r
    Status = AhciWaitUntilFisReceived (PciIo, Port, Timeout, SataFisD2H);\r
  }\r
\r
  if (Status == EFI_DEVICE_ERROR) {\r
    AhciRecoverPortError (PciIo, Port);\r
  }\r
\r
Exit:\r
  //\r
  // For Blocking mode, the command should be stopped, the Fis should be disabled\r
  // and the PciIo should be unmapped.\r
  // For non-blocking mode, only when a error is happened (if the return status is\r
  // EFI_NOT_READY that means the command doesn't finished, try again.), first do the\r
  // context cleanup, then set the packet's Asb status.\r
  //\r
  if (Task == NULL ||\r
      ((Task != NULL) && (Status != EFI_NOT_READY))\r
     ) {\r
    AhciStopCommand (\r
      PciIo,\r
      Port,\r
      Timeout\r
      );\r
\r
    AhciDisableFisReceive (\r
      PciIo,\r
      Port,\r
      Timeout\r
      );\r
\r
    PciIo->Unmap (\r
             PciIo,\r
             (Task != NULL) ? Task->Map : Map\r
             );\r
\r
    if (Task != NULL) {\r
      Task->Packet->Asb->AtaStatus = 0x01;\r
    }\r
  }\r
\r
  AhciDumpPortStatus (PciIo, AhciRegisters, Port, AtaStatusBlock);\r
  return Status;\r
}\r
\r
/**\r
  Start a non data transfer on specific port.\r
\r
  @param[in]       PciIo               The PCI IO protocol instance.\r
  @param[in]       AhciRegisters       The pointer to the EFI_AHCI_REGISTERS.\r
  @param[in]       Port                The number of port.\r
  @param[in]       PortMultiplier      The timeout value of stop.\r
  @param[in]       AtapiCommand        The atapi command will be used for the\r
                                       transfer.\r
  @param[in]       AtapiCommandLength  The length of the atapi command.\r
  @param[in]       AtaCommandBlock     The EFI_ATA_COMMAND_BLOCK data.\r
  @param[in, out]  AtaStatusBlock      The EFI_ATA_STATUS_BLOCK data.\r
  @param[in]       Timeout             The timeout value of non data transfer, uses 100ns as a unit.\r
  @param[in]       Task                Optional. Pointer to the ATA_NONBLOCK_TASK\r
                                       used by non-blocking mode.\r
\r
  @retval EFI_DEVICE_ERROR    The non data transfer abort with error occurs.\r
  @retval EFI_TIMEOUT         The operation is time out.\r
  @retval EFI_UNSUPPORTED     The device is not ready for transfer.\r
  @retval EFI_SUCCESS         The non data transfer executes successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AhciNonDataTransfer (\r
  IN     EFI_PCI_IO_PROTOCOL           *PciIo,\r
  IN     EFI_AHCI_REGISTERS            *AhciRegisters,\r
  IN     UINT8                         Port,\r
  IN     UINT8                         PortMultiplier,\r
  IN     EFI_AHCI_ATAPI_COMMAND        *AtapiCommand OPTIONAL,\r
  IN     UINT8                         AtapiCommandLength,\r
  IN     EFI_ATA_COMMAND_BLOCK         *AtaCommandBlock,\r
  IN OUT EFI_ATA_STATUS_BLOCK          *AtaStatusBlock,\r
  IN     UINT64                        Timeout,\r
  IN     ATA_NONBLOCK_TASK             *Task\r
  )\r
{\r
  EFI_STATUS                   Status;\r
  EFI_AHCI_COMMAND_FIS         CFis;\r
  EFI_AHCI_COMMAND_LIST        CmdList;\r
\r
  //\r
  // Package read needed\r
  //\r
  AhciBuildCommandFis (&CFis, AtaCommandBlock);\r
\r
  ZeroMem (&CmdList, sizeof (EFI_AHCI_COMMAND_LIST));\r
\r
  CmdList.AhciCmdCfl = EFI_AHCI_FIS_REGISTER_H2D_LENGTH / 4;\r
\r
  AhciBuildCommand (\r
    PciIo,\r
    AhciRegisters,\r
    Port,\r
    PortMultiplier,\r
    &CFis,\r
    &CmdList,\r
    AtapiCommand,\r
    AtapiCommandLength,\r
    0,\r
    NULL,\r
    0\r
    );\r
\r
  Status = AhciStartCommand (\r
             PciIo,\r
             Port,\r
             0,\r
             Timeout\r
             );\r
  if (EFI_ERROR (Status)) {\r
    goto Exit;\r
  }\r
\r
  Status = AhciWaitUntilFisReceived (PciIo, Port, Timeout, SataFisD2H);\r
  if (Status == EFI_DEVICE_ERROR) {\r
    AhciRecoverPortError (PciIo, Port);\r
  }\r
\r
Exit:\r
  AhciStopCommand (\r
    PciIo,\r
    Port,\r
    Timeout\r
    );\r
\r
  AhciDisableFisReceive (\r
    PciIo,\r
    Port,\r
    Timeout\r
    );\r
\r
  AhciDumpPortStatus (PciIo, AhciRegisters, Port, AtaStatusBlock);\r
\r
  return Status;\r
}\r
\r
/**\r
  Stop command running for giving port\r
\r
  @param  PciIo              The PCI IO protocol instance.\r
  @param  Port               The number of port.\r
  @param  Timeout            The timeout value of stop, uses 100ns as a unit.\r
\r
  @retval EFI_DEVICE_ERROR   The command stop unsuccessfully.\r
  @retval EFI_TIMEOUT        The operation is time out.\r
  @retval EFI_SUCCESS        The command stop successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AhciStopCommand (\r
  IN  EFI_PCI_IO_PROTOCOL       *PciIo,\r
  IN  UINT8                     Port,\r
  IN  UINT64                    Timeout\r
  )\r
{\r
  UINT32 Offset;\r
  UINT32 Data;\r
\r
  Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_CMD;\r
  Data   = AhciReadReg (PciIo, Offset);\r
\r
  if ((Data & (EFI_AHCI_PORT_CMD_ST |  EFI_AHCI_PORT_CMD_CR)) == 0) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  if ((Data & EFI_AHCI_PORT_CMD_ST) != 0) {\r
    AhciAndReg (PciIo, Offset, (UINT32)~(EFI_AHCI_PORT_CMD_ST));\r
  }\r
\r
  return AhciWaitMmioSet (\r
           PciIo,\r
           Offset,\r
           EFI_AHCI_PORT_CMD_CR,\r
           0,\r
           Timeout\r
           );\r
}\r
\r
/**\r
  Start command for give slot on specific port.\r
\r
  @param  PciIo              The PCI IO protocol instance.\r
  @param  Port               The number of port.\r
  @param  CommandSlot        The number of Command Slot.\r
  @param  Timeout            The timeout value of start, uses 100ns as a unit.\r
\r
  @retval EFI_DEVICE_ERROR   The command start unsuccessfully.\r
  @retval EFI_TIMEOUT        The operation is time out.\r
  @retval EFI_SUCCESS        The command start successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AhciStartCommand (\r
  IN  EFI_PCI_IO_PROTOCOL       *PciIo,\r
  IN  UINT8                     Port,\r
  IN  UINT8                     CommandSlot,\r
  IN  UINT64                    Timeout\r
  )\r
{\r
  UINT32     CmdSlotBit;\r
  EFI_STATUS Status;\r
  UINT32     PortStatus;\r
  UINT32     StartCmd;\r
  UINT32     PortTfd;\r
  UINT32     Offset;\r
  UINT32     Capability;\r
\r
  //\r
  // Collect AHCI controller information\r
  //\r
  Capability = AhciReadReg(PciIo, EFI_AHCI_CAPABILITY_OFFSET);\r
\r
  CmdSlotBit = (UINT32) (1 << CommandSlot);\r
\r
  AhciClearPortStatus (\r
    PciIo,\r
    Port\r
    );\r
\r
  Status = AhciEnableFisReceive (\r
             PciIo,\r
             Port,\r
             Timeout\r
             );\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_CMD;\r
  PortStatus = AhciReadReg (PciIo, Offset);\r
\r
  StartCmd = 0;\r
  if ((PortStatus & EFI_AHCI_PORT_CMD_ALPE) != 0) {\r
    StartCmd = AhciReadReg (PciIo, Offset);\r
    StartCmd &= ~EFI_AHCI_PORT_CMD_ICC_MASK;\r
    StartCmd |= EFI_AHCI_PORT_CMD_ACTIVE;\r
  }\r
\r
  Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_TFD;\r
  PortTfd = AhciReadReg (PciIo, Offset);\r
\r
  if ((PortTfd & (EFI_AHCI_PORT_TFD_BSY | EFI_AHCI_PORT_TFD_DRQ)) != 0) {\r
    if ((Capability & BIT24) != 0) {\r
      Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_CMD;\r
      AhciOrReg (PciIo, Offset, EFI_AHCI_PORT_CMD_CLO);\r
\r
      AhciWaitMmioSet (\r
        PciIo,\r
        Offset,\r
        EFI_AHCI_PORT_CMD_CLO,\r
        0,\r
        Timeout\r
        );\r
    }\r
  }\r
\r
  Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_CMD;\r
  AhciOrReg (PciIo, Offset, EFI_AHCI_PORT_CMD_ST | StartCmd);\r
\r
  //\r
  // Setting the command\r
  //\r
  Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_CI;\r
  AhciAndReg (PciIo, Offset, 0);\r
  AhciOrReg (PciIo, Offset, CmdSlotBit);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Do AHCI HBA reset.\r
\r
  @param  PciIo              The PCI IO protocol instance.\r
  @param  Timeout            The timeout value of reset, uses 100ns as a unit.\r
\r
  @retval EFI_DEVICE_ERROR   AHCI controller is failed to complete hardware reset.\r
  @retval EFI_TIMEOUT        The reset operation is time out.\r
  @retval EFI_SUCCESS        AHCI controller is reset successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AhciReset (\r
  IN  EFI_PCI_IO_PROTOCOL       *PciIo,\r
  IN  UINT64                    Timeout\r
  )\r
{\r
  UINT64                 Delay;\r
  UINT32                 Value;\r
\r
  //\r
  // Make sure that GHC.AE bit is set before accessing any AHCI registers.\r
  //\r
  Value = AhciReadReg(PciIo, EFI_AHCI_GHC_OFFSET);\r
\r
  if ((Value & EFI_AHCI_GHC_ENABLE) == 0) {\r
    AhciOrReg (PciIo, EFI_AHCI_GHC_OFFSET, EFI_AHCI_GHC_ENABLE);\r
  }\r
\r
  AhciOrReg (PciIo, EFI_AHCI_GHC_OFFSET, EFI_AHCI_GHC_RESET);\r
\r
  Delay = DivU64x32(Timeout, 1000) + 1;\r
\r
  do {\r
    Value = AhciReadReg(PciIo, EFI_AHCI_GHC_OFFSET);\r
\r
    if ((Value & EFI_AHCI_GHC_RESET) == 0) {\r
      break;\r
    }\r
\r
    //\r
    // Stall for 100 microseconds.\r
    //\r
    MicroSecondDelay(100);\r
\r
    Delay--;\r
  } while (Delay > 0);\r
\r
  if (Delay == 0) {\r
    return EFI_TIMEOUT;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Send SMART Return Status command to check if the execution of SMART cmd is successful or not.\r
\r
  @param  PciIo               The PCI IO protocol instance.\r
  @param  AhciRegisters       The pointer to the EFI_AHCI_REGISTERS.\r
  @param  Port                The number of port.\r
  @param  PortMultiplier      The port multiplier port number.\r
  @param  AtaStatusBlock      A pointer to EFI_ATA_STATUS_BLOCK data structure.\r
\r
  @retval EFI_SUCCESS     Successfully get the return status of S.M.A.R.T command execution.\r
  @retval Others          Fail to get return status data.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AhciAtaSmartReturnStatusCheck (\r
  IN EFI_PCI_IO_PROTOCOL         *PciIo,\r
  IN EFI_AHCI_REGISTERS          *AhciRegisters,\r
  IN UINT8                       Port,\r
  IN UINT8                       PortMultiplier,\r
  IN OUT EFI_ATA_STATUS_BLOCK    *AtaStatusBlock\r
  )\r
{\r
  EFI_STATUS              Status;\r
  EFI_ATA_COMMAND_BLOCK   AtaCommandBlock;\r
  UINT8                   LBAMid;\r
  UINT8                   LBAHigh;\r
  UINTN                   FisBaseAddr;\r
  UINT32                  Value;\r
\r
  ZeroMem (&AtaCommandBlock, sizeof (EFI_ATA_COMMAND_BLOCK));\r
\r
  AtaCommandBlock.AtaCommand      = ATA_CMD_SMART;\r
  AtaCommandBlock.AtaFeatures     = ATA_SMART_RETURN_STATUS;\r
  AtaCommandBlock.AtaCylinderLow  = ATA_CONSTANT_4F;\r
  AtaCommandBlock.AtaCylinderHigh = ATA_CONSTANT_C2;\r
\r
  //\r
  // Send S.M.A.R.T Read Return Status command to device\r
  //\r
  Status = AhciNonDataTransfer (\r
             PciIo,\r
             AhciRegisters,\r
             (UINT8)Port,\r
             (UINT8)PortMultiplier,\r
             NULL,\r
             0,\r
             &AtaCommandBlock,\r
             AtaStatusBlock,\r
             ATA_ATAPI_TIMEOUT,\r
             NULL\r
             );\r
\r
  if (EFI_ERROR (Status)) {\r
    REPORT_STATUS_CODE (\r
      EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
      (EFI_IO_BUS_ATA_ATAPI | EFI_IOB_ATA_BUS_SMART_DISABLED)\r
      );\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  REPORT_STATUS_CODE (\r
    EFI_PROGRESS_CODE,\r
    (EFI_IO_BUS_ATA_ATAPI | EFI_IOB_ATA_BUS_SMART_ENABLE)\r
    );\r
\r
  FisBaseAddr = (UINTN)AhciRegisters->AhciRFis + Port * sizeof (EFI_AHCI_RECEIVED_FIS);\r
\r
  Value = *(UINT32 *) (FisBaseAddr + EFI_AHCI_D2H_FIS_OFFSET);\r
\r
  if ((Value & EFI_AHCI_FIS_TYPE_MASK) == EFI_AHCI_FIS_REGISTER_D2H) {\r
    LBAMid  = ((UINT8 *)(UINTN)(FisBaseAddr + EFI_AHCI_D2H_FIS_OFFSET))[5];\r
    LBAHigh = ((UINT8 *)(UINTN)(FisBaseAddr + EFI_AHCI_D2H_FIS_OFFSET))[6];\r
\r
    if ((LBAMid == 0x4f) && (LBAHigh == 0xc2)) {\r
      //\r
      // The threshold exceeded condition is not detected by the device\r
      //\r
      DEBUG ((EFI_D_INFO, "The S.M.A.R.T threshold exceeded condition is not detected\n"));\r
      REPORT_STATUS_CODE (\r
            EFI_PROGRESS_CODE,\r
            (EFI_IO_BUS_ATA_ATAPI | EFI_IOB_ATA_BUS_SMART_UNDERTHRESHOLD)\r
            );\r
    } else if ((LBAMid == 0xf4) && (LBAHigh == 0x2c)) {\r
      //\r
      // The threshold exceeded condition is detected by the device\r
      //\r
      DEBUG ((EFI_D_INFO, "The S.M.A.R.T threshold exceeded condition is detected\n"));\r
      REPORT_STATUS_CODE (\r
           EFI_PROGRESS_CODE,\r
           (EFI_IO_BUS_ATA_ATAPI | EFI_IOB_ATA_BUS_SMART_OVERTHRESHOLD)\r
           );\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Enable SMART command of the disk if supported.\r
\r
  @param  PciIo               The PCI IO protocol instance.\r
  @param  AhciRegisters       The pointer to the EFI_AHCI_REGISTERS.\r
  @param  Port                The number of port.\r
  @param  PortMultiplier      The port multiplier port number.\r
  @param  IdentifyData        A pointer to data buffer which is used to contain IDENTIFY data.\r
  @param  AtaStatusBlock      A pointer to EFI_ATA_STATUS_BLOCK data structure.\r
\r
**/\r
VOID\r
EFIAPI\r
AhciAtaSmartSupport (\r
  IN EFI_PCI_IO_PROTOCOL           *PciIo,\r
  IN EFI_AHCI_REGISTERS            *AhciRegisters,\r
  IN UINT8                         Port,\r
  IN UINT8                         PortMultiplier,\r
  IN EFI_IDENTIFY_DATA             *IdentifyData,\r
  IN OUT EFI_ATA_STATUS_BLOCK      *AtaStatusBlock\r
  )\r
{\r
  EFI_STATUS               Status;\r
  EFI_ATA_COMMAND_BLOCK    AtaCommandBlock;\r
\r
  //\r
  // Detect if the device supports S.M.A.R.T.\r
  //\r
  if ((IdentifyData->AtaData.command_set_supported_82 & 0x0001) != 0x0001) {\r
    //\r
    // S.M.A.R.T is not supported by the device\r
    //\r
    DEBUG ((EFI_D_INFO, "S.M.A.R.T feature is not supported at port [%d] PortMultiplier [%d]!\n",\r
            Port, PortMultiplier));\r
    REPORT_STATUS_CODE (\r
      EFI_ERROR_CODE | EFI_ERROR_MINOR,\r
      (EFI_IO_BUS_ATA_ATAPI | EFI_IOB_ATA_BUS_SMART_NOTSUPPORTED)\r
      );\r
  } else {\r
    //\r
    // Check if the feature is enabled. If not, then enable S.M.A.R.T.\r
    //\r
    if ((IdentifyData->AtaData.command_set_feature_enb_85 & 0x0001) != 0x0001) {\r
\r
      REPORT_STATUS_CODE (\r
        EFI_PROGRESS_CODE,\r
        (EFI_IO_BUS_ATA_ATAPI | EFI_IOB_ATA_BUS_SMART_DISABLE)\r
        );\r
\r
      ZeroMem (&AtaCommandBlock, sizeof (EFI_ATA_COMMAND_BLOCK));\r
\r
      AtaCommandBlock.AtaCommand      = ATA_CMD_SMART;\r
      AtaCommandBlock.AtaFeatures     = ATA_SMART_ENABLE_OPERATION;\r
      AtaCommandBlock.AtaCylinderLow  = ATA_CONSTANT_4F;\r
      AtaCommandBlock.AtaCylinderHigh = ATA_CONSTANT_C2;\r
\r
      //\r
      // Send S.M.A.R.T Enable command to device\r
      //\r
      Status = AhciNonDataTransfer (\r
                 PciIo,\r
                 AhciRegisters,\r
                 (UINT8)Port,\r
                 (UINT8)PortMultiplier,\r
                 NULL,\r
                 0,\r
                 &AtaCommandBlock,\r
                 AtaStatusBlock,\r
                 ATA_ATAPI_TIMEOUT,\r
                 NULL\r
                 );\r
\r
\r
      if (!EFI_ERROR (Status)) {\r
        //\r
        // Send S.M.A.R.T AutoSave command to device\r
        //\r
        ZeroMem (&AtaCommandBlock, sizeof (EFI_ATA_COMMAND_BLOCK));\r
\r
        AtaCommandBlock.AtaCommand      = ATA_CMD_SMART;\r
        AtaCommandBlock.AtaFeatures     = 0xD2;\r
        AtaCommandBlock.AtaSectorCount  = 0xF1;\r
        AtaCommandBlock.AtaCylinderLow  = ATA_CONSTANT_4F;\r
        AtaCommandBlock.AtaCylinderHigh = ATA_CONSTANT_C2;\r
\r
        Status = AhciNonDataTransfer (\r
                   PciIo,\r
                   AhciRegisters,\r
                   (UINT8)Port,\r
                   (UINT8)PortMultiplier,\r
                   NULL,\r
                   0,\r
                   &AtaCommandBlock,\r
                   AtaStatusBlock,\r
                   ATA_ATAPI_TIMEOUT,\r
                   NULL\r
                   );\r
\r
        if (!EFI_ERROR (Status)) {\r
          Status = AhciAtaSmartReturnStatusCheck (\r
                     PciIo,\r
                     AhciRegisters,\r
                     (UINT8)Port,\r
                     (UINT8)PortMultiplier,\r
                     AtaStatusBlock\r
                     );\r
        }\r
      }\r
    }\r
    DEBUG ((EFI_D_INFO, "Enabled S.M.A.R.T feature at port [%d] PortMultiplier [%d]!\n",\r
            Port, PortMultiplier));\r
  }\r
\r
  return ;\r
}\r
\r
/**\r
  Send Buffer cmd to specific device.\r
\r
  @param  PciIo               The PCI IO protocol instance.\r
  @param  AhciRegisters       The pointer to the EFI_AHCI_REGISTERS.\r
  @param  Port                The number of port.\r
  @param  PortMultiplier      The port multiplier port number.\r
  @param  Buffer              The data buffer to store IDENTIFY PACKET data.\r
\r
  @retval EFI_DEVICE_ERROR    The cmd abort with error occurs.\r
  @retval EFI_TIMEOUT         The operation is time out.\r
  @retval EFI_UNSUPPORTED     The device is not ready for executing.\r
  @retval EFI_SUCCESS         The cmd executes successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AhciIdentify (\r
  IN EFI_PCI_IO_PROTOCOL      *PciIo,\r
  IN EFI_AHCI_REGISTERS       *AhciRegisters,\r
  IN UINT8                    Port,\r
  IN UINT8                    PortMultiplier,\r
  IN OUT EFI_IDENTIFY_DATA    *Buffer\r
  )\r
{\r
  EFI_STATUS                   Status;\r
  EFI_ATA_COMMAND_BLOCK        AtaCommandBlock;\r
  EFI_ATA_STATUS_BLOCK         AtaStatusBlock;\r
\r
  if (PciIo == NULL || AhciRegisters == NULL || Buffer == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ZeroMem (&AtaCommandBlock, sizeof (EFI_ATA_COMMAND_BLOCK));\r
  ZeroMem (&AtaStatusBlock, sizeof (EFI_ATA_STATUS_BLOCK));\r
\r
  AtaCommandBlock.AtaCommand     = ATA_CMD_IDENTIFY_DRIVE;\r
  AtaCommandBlock.AtaSectorCount = 1;\r
\r
  Status = AhciPioTransfer (\r
             PciIo,\r
             AhciRegisters,\r
             Port,\r
             PortMultiplier,\r
             NULL,\r
             0,\r
             TRUE,\r
             &AtaCommandBlock,\r
             &AtaStatusBlock,\r
             Buffer,\r
             sizeof (EFI_IDENTIFY_DATA),\r
             ATA_ATAPI_TIMEOUT,\r
             NULL\r
             );\r
\r
  return Status;\r
}\r
\r
/**\r
  Send Buffer cmd to specific device.\r
\r
  @param  PciIo               The PCI IO protocol instance.\r
  @param  AhciRegisters       The pointer to the EFI_AHCI_REGISTERS.\r
  @param  Port                The number of port.\r
  @param  PortMultiplier      The port multiplier port number.\r
  @param  Buffer              The data buffer to store IDENTIFY PACKET data.\r
\r
  @retval EFI_DEVICE_ERROR    The cmd abort with error occurs.\r
  @retval EFI_TIMEOUT         The operation is time out.\r
  @retval EFI_UNSUPPORTED     The device is not ready for executing.\r
  @retval EFI_SUCCESS         The cmd executes successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AhciIdentifyPacket (\r
  IN EFI_PCI_IO_PROTOCOL      *PciIo,\r
  IN EFI_AHCI_REGISTERS       *AhciRegisters,\r
  IN UINT8                    Port,\r
  IN UINT8                    PortMultiplier,\r
  IN OUT EFI_IDENTIFY_DATA    *Buffer\r
  )\r
{\r
  EFI_STATUS                   Status;\r
  EFI_ATA_COMMAND_BLOCK        AtaCommandBlock;\r
  EFI_ATA_STATUS_BLOCK         AtaStatusBlock;\r
\r
  if (PciIo == NULL || AhciRegisters == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ZeroMem (&AtaCommandBlock, sizeof (EFI_ATA_COMMAND_BLOCK));\r
  ZeroMem (&AtaStatusBlock, sizeof (EFI_ATA_STATUS_BLOCK));\r
\r
  AtaCommandBlock.AtaCommand     = ATA_CMD_IDENTIFY_DEVICE;\r
  AtaCommandBlock.AtaSectorCount = 1;\r
\r
  Status = AhciPioTransfer (\r
             PciIo,\r
             AhciRegisters,\r
             Port,\r
             PortMultiplier,\r
             NULL,\r
             0,\r
             TRUE,\r
             &AtaCommandBlock,\r
             &AtaStatusBlock,\r
             Buffer,\r
             sizeof (EFI_IDENTIFY_DATA),\r
             ATA_ATAPI_TIMEOUT,\r
             NULL\r
             );\r
\r
  return Status;\r
}\r
\r
/**\r
  Send SET FEATURE cmd on specific device.\r
\r
  @param  PciIo               The PCI IO protocol instance.\r
  @param  AhciRegisters       The pointer to the EFI_AHCI_REGISTERS.\r
  @param  Port                The number of port.\r
  @param  PortMultiplier      The port multiplier port number.\r
  @param  Feature             The data to send Feature register.\r
  @param  FeatureSpecificData The specific data for SET FEATURE cmd.\r
  @param  Timeout             The timeout value of SET FEATURE cmd, uses 100ns as a unit.\r
\r
  @retval EFI_DEVICE_ERROR    The cmd abort with error occurs.\r
  @retval EFI_TIMEOUT         The operation is time out.\r
  @retval EFI_UNSUPPORTED     The device is not ready for executing.\r
  @retval EFI_SUCCESS         The cmd executes successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AhciDeviceSetFeature (\r
  IN EFI_PCI_IO_PROTOCOL    *PciIo,\r
  IN EFI_AHCI_REGISTERS     *AhciRegisters,\r
  IN UINT8                  Port,\r
  IN UINT8                  PortMultiplier,\r
  IN UINT16                 Feature,\r
  IN UINT32                 FeatureSpecificData,\r
  IN UINT64                 Timeout\r
  )\r
{\r
  EFI_STATUS               Status;\r
  EFI_ATA_COMMAND_BLOCK    AtaCommandBlock;\r
  EFI_ATA_STATUS_BLOCK     AtaStatusBlock;\r
\r
  ZeroMem (&AtaCommandBlock, sizeof (EFI_ATA_COMMAND_BLOCK));\r
  ZeroMem (&AtaStatusBlock, sizeof (EFI_ATA_STATUS_BLOCK));\r
\r
  AtaCommandBlock.AtaCommand      = ATA_CMD_SET_FEATURES;\r
  AtaCommandBlock.AtaFeatures     = (UINT8) Feature;\r
  AtaCommandBlock.AtaFeaturesExp  = (UINT8) (Feature >> 8);\r
  AtaCommandBlock.AtaSectorCount  = (UINT8) FeatureSpecificData;\r
  AtaCommandBlock.AtaSectorNumber = (UINT8) (FeatureSpecificData >> 8);\r
  AtaCommandBlock.AtaCylinderLow  = (UINT8) (FeatureSpecificData >> 16);\r
  AtaCommandBlock.AtaCylinderHigh = (UINT8) (FeatureSpecificData >> 24);\r
\r
  Status = AhciNonDataTransfer (\r
             PciIo,\r
             AhciRegisters,\r
             (UINT8)Port,\r
             (UINT8)PortMultiplier,\r
             NULL,\r
             0,\r
             &AtaCommandBlock,\r
             &AtaStatusBlock,\r
             Timeout,\r
             NULL\r
             );\r
\r
  return Status;\r
}\r
\r
/**\r
  This function is used to send out ATAPI commands conforms to the Packet Command\r
  with PIO Protocol.\r
\r
  @param PciIo              The PCI IO protocol instance.\r
  @param AhciRegisters      The pointer to the EFI_AHCI_REGISTERS.\r
  @param Port               The number of port.\r
  @param PortMultiplier     The number of port multiplier.\r
  @param Packet             A pointer to EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET structure.\r
\r
  @retval EFI_SUCCESS       send out the ATAPI packet command successfully\r
                            and device sends data successfully.\r
  @retval EFI_DEVICE_ERROR  the device failed to send data.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AhciPacketCommandExecute (\r
  IN  EFI_PCI_IO_PROTOCOL                           *PciIo,\r
  IN  EFI_AHCI_REGISTERS                            *AhciRegisters,\r
  IN  UINT8                                         Port,\r
  IN  UINT8                                         PortMultiplier,\r
  IN  EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET    *Packet\r
  )\r
{\r
  EFI_STATUS                   Status;\r
  VOID                         *Buffer;\r
  UINT32                       Length;\r
  EFI_ATA_COMMAND_BLOCK        AtaCommandBlock;\r
  EFI_ATA_STATUS_BLOCK         AtaStatusBlock;\r
  BOOLEAN                      Read;\r
\r
  if (Packet == NULL || Packet->Cdb == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ZeroMem (&AtaCommandBlock, sizeof (EFI_ATA_COMMAND_BLOCK));\r
  ZeroMem (&AtaStatusBlock, sizeof (EFI_ATA_STATUS_BLOCK));\r
  AtaCommandBlock.AtaCommand      = ATA_CMD_PACKET;\r
  //\r
  // No OVL; No DMA\r
  //\r
  AtaCommandBlock.AtaFeatures     = 0x00;\r
  //\r
  // set the transfersize to ATAPI_MAX_BYTE_COUNT to let the device\r
  // determine how many data should be transferred.\r
  //\r
  AtaCommandBlock.AtaCylinderLow  = (UINT8) (ATAPI_MAX_BYTE_COUNT & 0x00ff);\r
  AtaCommandBlock.AtaCylinderHigh = (UINT8) (ATAPI_MAX_BYTE_COUNT >> 8);\r
\r
  if (Packet->DataDirection == EFI_EXT_SCSI_DATA_DIRECTION_READ) {\r
    Buffer = Packet->InDataBuffer;\r
    Length = Packet->InTransferLength;\r
    Read = TRUE;\r
  } else {\r
    Buffer = Packet->OutDataBuffer;\r
    Length = Packet->OutTransferLength;\r
    Read = FALSE;\r
  }\r
\r
  if (Length == 0) {\r
    Status = AhciNonDataTransfer (\r
               PciIo,\r
               AhciRegisters,\r
               Port,\r
               PortMultiplier,\r
               Packet->Cdb,\r
               Packet->CdbLength,\r
               &AtaCommandBlock,\r
               &AtaStatusBlock,\r
               Packet->Timeout,\r
               NULL\r
               );\r
  } else {\r
    Status = AhciPioTransfer (\r
               PciIo,\r
               AhciRegisters,\r
               Port,\r
               PortMultiplier,\r
               Packet->Cdb,\r
               Packet->CdbLength,\r
               Read,\r
               &AtaCommandBlock,\r
               &AtaStatusBlock,\r
               Buffer,\r
               Length,\r
               Packet->Timeout,\r
               NULL\r
               );\r
  }\r
  return Status;\r
}\r
\r
/**\r
  Allocate transfer-related data struct which is used at AHCI mode.\r
\r
  @param  PciIo                 The PCI IO protocol instance.\r
  @param  AhciRegisters         The pointer to the EFI_AHCI_REGISTERS.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AhciCreateTransferDescriptor (\r
  IN     EFI_PCI_IO_PROTOCOL    *PciIo,\r
  IN OUT EFI_AHCI_REGISTERS     *AhciRegisters\r
  )\r
{\r
  EFI_STATUS            Status;\r
  UINTN                 Bytes;\r
  VOID                  *Buffer;\r
\r
  UINT32                Capability;\r
  UINT32                PortImplementBitMap;\r
  UINT8                 MaxPortNumber;\r
  UINT8                 MaxCommandSlotNumber;\r
  BOOLEAN               Support64Bit;\r
  UINT64                MaxReceiveFisSize;\r
  UINT64                MaxCommandListSize;\r
  UINT64                MaxCommandTableSize;\r
  EFI_PHYSICAL_ADDRESS  AhciRFisPciAddr;\r
  EFI_PHYSICAL_ADDRESS  AhciCmdListPciAddr;\r
  EFI_PHYSICAL_ADDRESS  AhciCommandTablePciAddr;\r
\r
  Buffer = NULL;\r
  //\r
  // Collect AHCI controller information\r
  //\r
  Capability           = AhciReadReg(PciIo, EFI_AHCI_CAPABILITY_OFFSET);\r
  //\r
  // Get the number of command slots per port supported by this HBA.\r
  //\r
  MaxCommandSlotNumber = (UINT8) (((Capability & 0x1F00) >> 8) + 1);\r
  Support64Bit         = (BOOLEAN) (((Capability & BIT31) != 0) ? TRUE : FALSE);\r
\r
  PortImplementBitMap  = AhciReadReg(PciIo, EFI_AHCI_PI_OFFSET);\r
  //\r
  // Get the highest bit of implemented ports which decides how many bytes are allocated for received FIS.\r
  //\r
  MaxPortNumber        = (UINT8)(UINTN)(HighBitSet32(PortImplementBitMap) + 1);\r
  if (MaxPortNumber == 0) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  MaxReceiveFisSize    = MaxPortNumber * sizeof (EFI_AHCI_RECEIVED_FIS);\r
  Status = PciIo->AllocateBuffer (\r
                    PciIo,\r
                    AllocateAnyPages,\r
                    EfiBootServicesData,\r
                    EFI_SIZE_TO_PAGES ((UINTN) MaxReceiveFisSize),\r
                    &Buffer,\r
                    0\r
                    );\r
\r
  if (EFI_ERROR (Status)) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  ZeroMem (Buffer, (UINTN)MaxReceiveFisSize);\r
\r
  AhciRegisters->AhciRFis          = Buffer;\r
  AhciRegisters->MaxReceiveFisSize = MaxReceiveFisSize;\r
  Bytes  = (UINTN)MaxReceiveFisSize;\r
\r
  Status = PciIo->Map (\r
                    PciIo,\r
                    EfiPciIoOperationBusMasterCommonBuffer,\r
                    Buffer,\r
                    &Bytes,\r
                    &AhciRFisPciAddr,\r
                    &AhciRegisters->MapRFis\r
                    );\r
\r
  if (EFI_ERROR (Status) || (Bytes != MaxReceiveFisSize)) {\r
    //\r
    // Map error or unable to map the whole RFis buffer into a contiguous region.\r
    //\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Error6;\r
  }\r
\r
  if ((!Support64Bit) && (AhciRFisPciAddr > 0x100000000ULL)) {\r
    //\r
    // The AHCI HBA doesn't support 64bit addressing, so should not get a >4G pci bus master address.\r
    //\r
    Status = EFI_DEVICE_ERROR;\r
    goto Error5;\r
  }\r
  AhciRegisters->AhciRFisPciAddr = (EFI_AHCI_RECEIVED_FIS *)(UINTN)AhciRFisPciAddr;\r
\r
  //\r
  // Allocate memory for command list\r
  // Note that the implementation is a single task model which only use a command list for all ports.\r
  //\r
  Buffer = NULL;\r
  MaxCommandListSize = MaxCommandSlotNumber * sizeof (EFI_AHCI_COMMAND_LIST);\r
  Status = PciIo->AllocateBuffer (\r
                    PciIo,\r
                    AllocateAnyPages,\r
                    EfiBootServicesData,\r
                    EFI_SIZE_TO_PAGES ((UINTN) MaxCommandListSize),\r
                    &Buffer,\r
                    0\r
                    );\r
\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Free mapped resource.\r
    //\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Error5;\r
  }\r
\r
  ZeroMem (Buffer, (UINTN)MaxCommandListSize);\r
\r
  AhciRegisters->AhciCmdList        = Buffer;\r
  AhciRegisters->MaxCommandListSize = MaxCommandListSize;\r
  Bytes  = (UINTN)MaxCommandListSize;\r
\r
  Status = PciIo->Map (\r
                    PciIo,\r
                    EfiPciIoOperationBusMasterCommonBuffer,\r
                    Buffer,\r
                    &Bytes,\r
                    &AhciCmdListPciAddr,\r
                    &AhciRegisters->MapCmdList\r
                    );\r
\r
  if (EFI_ERROR (Status) || (Bytes != MaxCommandListSize)) {\r
    //\r
    // Map error or unable to map the whole cmd list buffer into a contiguous region.\r
    //\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Error4;\r
  }\r
\r
  if ((!Support64Bit) && (AhciCmdListPciAddr > 0x100000000ULL)) {\r
    //\r
    // The AHCI HBA doesn't support 64bit addressing, so should not get a >4G pci bus master address.\r
    //\r
    Status = EFI_DEVICE_ERROR;\r
    goto Error3;\r
  }\r
  AhciRegisters->AhciCmdListPciAddr = (EFI_AHCI_COMMAND_LIST *)(UINTN)AhciCmdListPciAddr;\r
\r
  //\r
  // Allocate memory for command table\r
  // According to AHCI 1.3 spec, a PRD table can contain maximum 65535 entries.\r
  //\r
  Buffer = NULL;\r
  MaxCommandTableSize = sizeof (EFI_AHCI_COMMAND_TABLE);\r
\r
  Status = PciIo->AllocateBuffer (\r
                    PciIo,\r
                    AllocateAnyPages,\r
                    EfiBootServicesData,\r
                    EFI_SIZE_TO_PAGES ((UINTN) MaxCommandTableSize),\r
                    &Buffer,\r
                    0\r
                    );\r
\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Free mapped resource.\r
    //\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Error3;\r
  }\r
\r
  ZeroMem (Buffer, (UINTN)MaxCommandTableSize);\r
\r
  AhciRegisters->AhciCommandTable    = Buffer;\r
  AhciRegisters->MaxCommandTableSize = MaxCommandTableSize;\r
  Bytes  = (UINTN)MaxCommandTableSize;\r
\r
  Status = PciIo->Map (\r
                    PciIo,\r
                    EfiPciIoOperationBusMasterCommonBuffer,\r
                    Buffer,\r
                    &Bytes,\r
                    &AhciCommandTablePciAddr,\r
                    &AhciRegisters->MapCommandTable\r
                    );\r
\r
  if (EFI_ERROR (Status) || (Bytes != MaxCommandTableSize)) {\r
    //\r
    // Map error or unable to map the whole cmd list buffer into a contiguous region.\r
    //\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Error2;\r
  }\r
\r
  if ((!Support64Bit) && (AhciCommandTablePciAddr > 0x100000000ULL)) {\r
    //\r
    // The AHCI HBA doesn't support 64bit addressing, so should not get a >4G pci bus master address.\r
    //\r
    Status = EFI_DEVICE_ERROR;\r
    goto Error1;\r
  }\r
  AhciRegisters->AhciCommandTablePciAddr = (EFI_AHCI_COMMAND_TABLE *)(UINTN)AhciCommandTablePciAddr;\r
\r
  return EFI_SUCCESS;\r
  //\r
  // Map error or unable to map the whole CmdList buffer into a contiguous region.\r
  //\r
Error1:\r
  PciIo->Unmap (\r
           PciIo,\r
           AhciRegisters->MapCommandTable\r
           );\r
Error2:\r
  PciIo->FreeBuffer (\r
           PciIo,\r
           EFI_SIZE_TO_PAGES ((UINTN) MaxCommandTableSize),\r
           AhciRegisters->AhciCommandTable\r
           );\r
Error3:\r
  PciIo->Unmap (\r
           PciIo,\r
           AhciRegisters->MapCmdList\r
           );\r
Error4:\r
  PciIo->FreeBuffer (\r
           PciIo,\r
           EFI_SIZE_TO_PAGES ((UINTN) MaxCommandListSize),\r
           AhciRegisters->AhciCmdList\r
           );\r
Error5:\r
  PciIo->Unmap (\r
           PciIo,\r
           AhciRegisters->MapRFis\r
           );\r
Error6:\r
  PciIo->FreeBuffer (\r
           PciIo,\r
           EFI_SIZE_TO_PAGES ((UINTN) MaxReceiveFisSize),\r
           AhciRegisters->AhciRFis\r
           );\r
\r
  return Status;\r
}\r
\r
/**\r
  Read logs from SATA device.\r
\r
  @param  PciIo               The PCI IO protocol instance.\r
  @param  AhciRegisters       The pointer to the EFI_AHCI_REGISTERS.\r
  @param  Port                The number of port.\r
  @param  PortMultiplier      The multiplier of port.\r
  @param  Buffer              The data buffer to store SATA logs.\r
  @param  LogNumber           The address of the log.\r
  @param  PageNumber          The page number of the log.\r
\r
  @retval EFI_INVALID_PARAMETER  PciIo, AhciRegisters or Buffer is NULL.\r
  @retval others                 Return status of AhciPioTransfer().\r
**/\r
EFI_STATUS\r
AhciReadLogExt (\r
  IN EFI_PCI_IO_PROTOCOL       *PciIo,\r
  IN EFI_AHCI_REGISTERS        *AhciRegisters,\r
  IN UINT8                     Port,\r
  IN UINT8                     PortMultiplier,\r
  IN OUT UINT8                 *Buffer,\r
  IN UINT8                     LogNumber,\r
  IN UINT8                     PageNumber\r
  )\r
{\r
  EFI_ATA_COMMAND_BLOCK        AtaCommandBlock;\r
  EFI_ATA_STATUS_BLOCK         AtaStatusBlock;\r
\r
  if (PciIo == NULL || AhciRegisters == NULL || Buffer == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  ///\r
  /// Read log from device\r
  ///\r
  ZeroMem (&AtaCommandBlock, sizeof (EFI_ATA_COMMAND_BLOCK));\r
  ZeroMem (&AtaStatusBlock, sizeof (EFI_ATA_STATUS_BLOCK));\r
  ZeroMem (Buffer, 512);\r
\r
  AtaCommandBlock.AtaCommand      = ATA_CMD_READ_LOG_EXT;\r
  AtaCommandBlock.AtaSectorCount  = 1;\r
  AtaCommandBlock.AtaSectorNumber = LogNumber;\r
  AtaCommandBlock.AtaCylinderLow  = PageNumber;\r
\r
  return AhciPioTransfer (\r
           PciIo,\r
           AhciRegisters,\r
           Port,\r
           PortMultiplier,\r
           NULL,\r
           0,\r
           TRUE,\r
           &AtaCommandBlock,\r
           &AtaStatusBlock,\r
           Buffer,\r
           512,\r
           ATA_ATAPI_TIMEOUT,\r
           NULL\r
           );\r
}\r
\r
/**\r
  Enable DEVSLP of the disk if supported.\r
\r
  @param  PciIo               The PCI IO protocol instance.\r
  @param  AhciRegisters       The pointer to the EFI_AHCI_REGISTERS.\r
  @param  Port                The number of port.\r
  @param  PortMultiplier      The multiplier of port.\r
  @param  IdentifyData        A pointer to data buffer which is used to contain IDENTIFY data.\r
\r
  @retval EFI_SUCCESS         The DEVSLP is enabled per policy successfully.\r
  @retval EFI_UNSUPPORTED     The DEVSLP isn't supported by the controller/device and policy requires to enable it.\r
**/\r
EFI_STATUS\r
AhciEnableDevSlp (\r
  IN EFI_PCI_IO_PROTOCOL           *PciIo,\r
  IN EFI_AHCI_REGISTERS            *AhciRegisters,\r
  IN UINT8                         Port,\r
  IN UINT8                         PortMultiplier,\r
  IN EFI_IDENTIFY_DATA             *IdentifyData\r
  )\r
{\r
  EFI_STATUS               Status;\r
  UINT32                   Offset;\r
  UINT32                   Capability2;\r
  UINT8                    LogData[512];\r
  DEVSLP_TIMING_VARIABLES  DevSlpTiming;\r
  UINT32                   PortCmd;\r
  UINT32                   PortDevSlp;\r
\r
  if (mAtaAtapiPolicy->DeviceSleepEnable != 1) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // Do not enable DevSlp if DevSlp is not supported.\r
  //\r
  Capability2 = AhciReadReg (PciIo, AHCI_CAPABILITY2_OFFSET);\r
  DEBUG ((DEBUG_INFO, "AHCI CAPABILITY2 = %08x\n", Capability2));\r
  if ((Capability2 & AHCI_CAP2_SDS) == 0) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Do not enable DevSlp if DevSlp is not present\r
  // Do not enable DevSlp if Hot Plug or Mechanical Presence Switch is supported\r
  //\r
  Offset     = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH;\r
  PortCmd    = AhciReadReg (PciIo, Offset + EFI_AHCI_PORT_CMD);\r
  PortDevSlp = AhciReadReg (PciIo, Offset + AHCI_PORT_DEVSLP);\r
  DEBUG ((DEBUG_INFO, "Port CMD/DEVSLP = %08x / %08x\n", PortCmd, PortDevSlp));\r
  if (((PortDevSlp & AHCI_PORT_DEVSLP_DSP) == 0) ||\r
      ((PortCmd & (EFI_AHCI_PORT_CMD_HPCP | EFI_AHCI_PORT_CMD_MPSP)) != 0)\r
     ) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Do not enable DevSlp if the device doesn't support DevSlp\r
  //\r
  DEBUG ((DEBUG_INFO, "IDENTIFY DEVICE: [77] = %04x, [78] = %04x, [79] = %04x\n",\r
          IdentifyData->AtaData.reserved_77,\r
          IdentifyData->AtaData.serial_ata_features_supported, IdentifyData->AtaData.serial_ata_features_enabled));\r
  if ((IdentifyData->AtaData.serial_ata_features_supported & BIT8) == 0) {\r
    DEBUG ((DEBUG_INFO, "DevSlp feature is not supported for device at port [%d] PortMultiplier [%d]!\n",\r
            Port, PortMultiplier));\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Enable DevSlp when it is not enabled.\r
  //\r
  if ((IdentifyData->AtaData.serial_ata_features_enabled & BIT8) != 0) {\r
    Status = AhciDeviceSetFeature (\r
      PciIo, AhciRegisters, Port, 0, ATA_SUB_CMD_ENABLE_SATA_FEATURE, 0x09, ATA_ATAPI_TIMEOUT\r
    );\r
    DEBUG ((DEBUG_INFO, "DevSlp set feature for device at port [%d] PortMultiplier [%d] - %r\n",\r
            Port, PortMultiplier, Status));\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  }\r
\r
  Status = AhciReadLogExt(PciIo, AhciRegisters, Port, PortMultiplier, LogData, 0x30, 0x08);\r
\r
  //\r
  // Clear PxCMD.ST and PxDEVSLP.ADSE before updating PxDEVSLP.DITO and PxDEVSLP.MDAT.\r
  //\r
  AhciWriteReg (PciIo, Offset + EFI_AHCI_PORT_CMD, PortCmd & ~EFI_AHCI_PORT_CMD_ST);\r
  PortDevSlp &= ~AHCI_PORT_DEVSLP_ADSE;\r
  AhciWriteReg (PciIo, Offset + AHCI_PORT_DEVSLP, PortDevSlp);\r
\r
  //\r
  // Set PxDEVSLP.DETO and PxDEVSLP.MDAT to 0.\r
  //\r
  PortDevSlp &= ~AHCI_PORT_DEVSLP_DETO_MASK;\r
  PortDevSlp &= ~AHCI_PORT_DEVSLP_MDAT_MASK;\r
  AhciWriteReg (PciIo, Offset + AHCI_PORT_DEVSLP, PortDevSlp);\r
  DEBUG ((DEBUG_INFO, "Read Log Ext at port [%d] PortMultiplier [%d] - %r\n", Port, PortMultiplier, Status));\r
  if (EFI_ERROR (Status)) {\r
    //\r
    // Assume DEVSLP TIMING VARIABLES is not supported if the Identify Device Data log (30h, 8) fails\r
    //\r
    ZeroMem (&DevSlpTiming, sizeof (DevSlpTiming));\r
  } else {\r
    CopyMem (&DevSlpTiming, &LogData[48], sizeof (DevSlpTiming));\r
    DEBUG ((DEBUG_INFO, "DevSlpTiming: Supported(%d), Deto(%d), Madt(%d)\n",\r
            DevSlpTiming.Supported, DevSlpTiming.Deto, DevSlpTiming.Madt));\r
  }\r
\r
  //\r
  // Use 20ms as default DETO when DEVSLP TIMING VARIABLES is not supported or the DETO is 0.\r
  //\r
  if ((DevSlpTiming.Supported == 0) || (DevSlpTiming.Deto == 0)) {\r
    DevSlpTiming.Deto = 20;\r
  }\r
\r
  //\r
  // Use 10ms as default MADT when DEVSLP TIMING VARIABLES is not supported or the MADT is 0.\r
  //\r
  if ((DevSlpTiming.Supported == 0) || (DevSlpTiming.Madt == 0)) {\r
    DevSlpTiming.Madt = 10;\r
  }\r
\r
  PortDevSlp |= DevSlpTiming.Deto << 2;\r
  PortDevSlp |= DevSlpTiming.Madt << 10;\r
  AhciOrReg (PciIo, Offset + AHCI_PORT_DEVSLP, PortDevSlp);\r
\r
  if (mAtaAtapiPolicy->AggressiveDeviceSleepEnable == 1) {\r
    if ((Capability2 & AHCI_CAP2_SADM) != 0) {\r
      PortDevSlp &= ~AHCI_PORT_DEVSLP_DITO_MASK;\r
      PortDevSlp |= (625 << 15);\r
      AhciWriteReg (PciIo, Offset + AHCI_PORT_DEVSLP, PortDevSlp);\r
\r
      PortDevSlp |= AHCI_PORT_DEVSLP_ADSE;\r
      AhciWriteReg (PciIo, Offset + AHCI_PORT_DEVSLP, PortDevSlp);\r
    }\r
  }\r
\r
\r
  AhciWriteReg (PciIo, Offset + EFI_AHCI_PORT_CMD, PortCmd);\r
\r
  DEBUG ((DEBUG_INFO, "Enabled DevSlp feature at port [%d] PortMultiplier [%d], Port CMD/DEVSLP = %08x / %08x\n",\r
          Port, PortMultiplier, PortCmd, PortDevSlp));\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Spin-up disk if IDD was incomplete or PUIS feature is enabled\r
\r
  @param  PciIo               The PCI IO protocol instance.\r
  @param  AhciRegisters       The pointer to the EFI_AHCI_REGISTERS.\r
  @param  Port                The number of port.\r
  @param  PortMultiplier      The multiplier of port.\r
  @param  IdentifyData        A pointer to data buffer which is used to contain IDENTIFY data.\r
\r
**/\r
EFI_STATUS\r
AhciSpinUpDisk (\r
  IN EFI_PCI_IO_PROTOCOL           *PciIo,\r
  IN EFI_AHCI_REGISTERS            *AhciRegisters,\r
  IN UINT8                         Port,\r
  IN UINT8                         PortMultiplier,\r
  IN OUT EFI_IDENTIFY_DATA         *IdentifyData\r
  )\r
{\r
  EFI_STATUS               Status;\r
  EFI_ATA_COMMAND_BLOCK    AtaCommandBlock;\r
  EFI_ATA_STATUS_BLOCK     AtaStatusBlock;\r
  UINT8                    Buffer[512];\r
\r
  if (IdentifyData->AtaData.specific_config == ATA_SPINUP_CFG_REQUIRED_IDD_INCOMPLETE) {\r
    //\r
    // Use SET_FEATURE subcommand to spin up the device.\r
    //\r
    Status = AhciDeviceSetFeature (\r
               PciIo, AhciRegisters, Port, PortMultiplier,\r
               ATA_SUB_CMD_PUIS_SET_DEVICE_SPINUP, 0x00, ATA_SPINUP_TIMEOUT\r
               );\r
    DEBUG ((DEBUG_INFO, "CMD_PUIS_SET_DEVICE_SPINUP for device at port [%d] PortMultiplier [%d] - %r!\n",\r
            Port, PortMultiplier, Status));\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  } else {\r
    ASSERT (IdentifyData->AtaData.specific_config == ATA_SPINUP_CFG_NOT_REQUIRED_IDD_INCOMPLETE);\r
\r
    //\r
    // Use READ_SECTORS to spin up the device if SpinUp SET FEATURE subcommand is not supported\r
    //\r
    ZeroMem (&AtaCommandBlock, sizeof (EFI_ATA_COMMAND_BLOCK));\r
    ZeroMem (&AtaStatusBlock, sizeof (EFI_ATA_STATUS_BLOCK));\r
    //\r
    // Perform READ SECTORS PIO Data-In command to Read LBA 0\r
    //\r
    AtaCommandBlock.AtaCommand      = ATA_CMD_READ_SECTORS;\r
    AtaCommandBlock.AtaSectorCount  = 0x1;\r
\r
    Status = AhciPioTransfer (\r
               PciIo,\r
               AhciRegisters,\r
               Port,\r
               PortMultiplier,\r
               NULL,\r
               0,\r
               TRUE,\r
               &AtaCommandBlock,\r
               &AtaStatusBlock,\r
               &Buffer,\r
               sizeof (Buffer),\r
               ATA_SPINUP_TIMEOUT,\r
               NULL\r
               );\r
    DEBUG ((DEBUG_INFO, "Read LBA 0 for device at port [%d] PortMultiplier [%d] - %r!\n",\r
            Port, PortMultiplier, Status));\r
    if (EFI_ERROR (Status)) {\r
      return Status;\r
    }\r
  }\r
\r
  //\r
  // Read the complete IDENTIFY DEVICE data.\r
  //\r
  ZeroMem (IdentifyData, sizeof (*IdentifyData));\r
  Status = AhciIdentify (PciIo, AhciRegisters, Port, PortMultiplier, IdentifyData);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "Read IDD failed for device at port [%d] PortMultiplier [%d] - %r!\n",\r
            Port, PortMultiplier, Status));\r
    return Status;\r
  }\r
\r
  DEBUG ((DEBUG_INFO, "IDENTIFY DEVICE: [0] = %016x, [2] = %016x, [83] = %016x, [86] = %016x\n",\r
          IdentifyData->AtaData.config, IdentifyData->AtaData.specific_config,\r
          IdentifyData->AtaData.command_set_supported_83, IdentifyData->AtaData.command_set_feature_enb_86));\r
  //\r
  // Check if IDD is incomplete\r
  //\r
  if ((IdentifyData->AtaData.config & BIT2) != 0) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Enable/disable/skip PUIS of the disk according to policy.\r
\r
  @param  PciIo               The PCI IO protocol instance.\r
  @param  AhciRegisters       The pointer to the EFI_AHCI_REGISTERS.\r
  @param  Port                The number of port.\r
  @param  PortMultiplier      The multiplier of port.\r
\r
**/\r
EFI_STATUS\r
AhciPuisEnable (\r
  IN EFI_PCI_IO_PROTOCOL           *PciIo,\r
  IN EFI_AHCI_REGISTERS            *AhciRegisters,\r
  IN UINT8                         Port,\r
  IN UINT8                         PortMultiplier\r
  )\r
{\r
  EFI_STATUS                       Status;\r
\r
  Status = EFI_SUCCESS;\r
  if (mAtaAtapiPolicy->PuisEnable == 0) {\r
    Status = AhciDeviceSetFeature (PciIo, AhciRegisters, Port, PortMultiplier, ATA_SUB_CMD_DISABLE_PUIS, 0x00, ATA_ATAPI_TIMEOUT);\r
  } else if (mAtaAtapiPolicy->PuisEnable == 1) {\r
    Status = AhciDeviceSetFeature (PciIo, AhciRegisters, Port, PortMultiplier, ATA_SUB_CMD_ENABLE_PUIS, 0x00, ATA_ATAPI_TIMEOUT);\r
  }\r
  DEBUG ((DEBUG_INFO, "%a PUIS feature at port [%d] PortMultiplier [%d] - %r!\n",\r
    (mAtaAtapiPolicy->PuisEnable == 0) ? "Disable" : (\r
    (mAtaAtapiPolicy->PuisEnable == 1) ? "Enable" : "Skip"\r
      ), Port, PortMultiplier, Status));\r
  return Status;\r
}\r
\r
/**\r
  Initialize ATA host controller at AHCI mode.\r
\r
  The function is designed to initialize ATA host controller.\r
\r
  @param[in]  Instance          A pointer to the ATA_ATAPI_PASS_THRU_INSTANCE instance.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AhciModeInitialization (\r
  IN  ATA_ATAPI_PASS_THRU_INSTANCE    *Instance\r
  )\r
{\r
  EFI_STATUS                       Status;\r
  EFI_PCI_IO_PROTOCOL              *PciIo;\r
  EFI_IDE_CONTROLLER_INIT_PROTOCOL *IdeInit;\r
  UINT32                           Capability;\r
  UINT8                            MaxPortNumber;\r
  UINT32                           PortImplementBitMap;\r
\r
  EFI_AHCI_REGISTERS               *AhciRegisters;\r
\r
  UINT8                            Port;\r
  DATA_64                          Data64;\r
  UINT32                           Offset;\r
  UINT32                           Data;\r
  EFI_IDENTIFY_DATA                Buffer;\r
  EFI_ATA_DEVICE_TYPE              DeviceType;\r
  EFI_ATA_COLLECTIVE_MODE          *SupportedModes;\r
  EFI_ATA_TRANSFER_MODE            TransferMode;\r
  UINT32                           PhyDetectDelay;\r
  UINT32                           Value;\r
\r
  if (Instance == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  PciIo   = Instance->PciIo;\r
  IdeInit = Instance->IdeControllerInit;\r
\r
  Status = AhciReset (PciIo, EFI_AHCI_BUS_RESET_TIMEOUT);\r
\r
  if (EFI_ERROR (Status)) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  //\r
  // Collect AHCI controller information\r
  //\r
  Capability = AhciReadReg (PciIo, EFI_AHCI_CAPABILITY_OFFSET);\r
\r
  //\r
  // Make sure that GHC.AE bit is set before accessing any AHCI registers.\r
  //\r
  Value = AhciReadReg(PciIo, EFI_AHCI_GHC_OFFSET);\r
\r
  if ((Value & EFI_AHCI_GHC_ENABLE) == 0) {\r
    AhciOrReg (PciIo, EFI_AHCI_GHC_OFFSET, EFI_AHCI_GHC_ENABLE);\r
  }\r
\r
  //\r
  // Enable 64-bit DMA support in the PCI layer if this controller\r
  // supports it.\r
  //\r
  if ((Capability & EFI_AHCI_CAP_S64A) != 0) {\r
    Status = PciIo->Attributes (\r
                      PciIo,\r
                      EfiPciIoAttributeOperationEnable,\r
                      EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE,\r
                      NULL\r
                      );\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((EFI_D_WARN,\r
        "AhciModeInitialization: failed to enable 64-bit DMA on 64-bit capable controller (%r)\n",\r
        Status));\r
    }\r
  }\r
\r
  //\r
  // Get the number of command slots per port supported by this HBA.\r
  //\r
  MaxPortNumber        = (UINT8) ((Capability & 0x1F) + 1);\r
\r
  //\r
  // Get the bit map of those ports exposed by this HBA.\r
  // It indicates which ports that the HBA supports are available for software to use.\r
  //\r
  PortImplementBitMap  = AhciReadReg(PciIo, EFI_AHCI_PI_OFFSET);\r
\r
  AhciRegisters = &Instance->AhciRegisters;\r
  Status = AhciCreateTransferDescriptor (PciIo, AhciRegisters);\r
\r
  if (EFI_ERROR (Status)) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  for (Port = 0; Port < EFI_AHCI_MAX_PORTS; Port ++) {\r
    if ((PortImplementBitMap & (((UINT32)BIT0) << Port)) != 0) {\r
      //\r
      // According to AHCI spec, MaxPortNumber should be equal or greater than the number of implemented ports.\r
      //\r
      if ((MaxPortNumber--) == 0) {\r
        //\r
        // Should never be here.\r
        //\r
        ASSERT (FALSE);\r
        return EFI_SUCCESS;\r
      }\r
\r
      IdeInit->NotifyPhase (IdeInit, EfiIdeBeforeChannelEnumeration, Port);\r
\r
      //\r
      // Initialize FIS Base Address Register and Command List Base Address Register for use.\r
      //\r
      Data64.Uint64 = (UINTN) (AhciRegisters->AhciRFisPciAddr) + sizeof (EFI_AHCI_RECEIVED_FIS) * Port;\r
      Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_FB;\r
      AhciWriteReg (PciIo, Offset, Data64.Uint32.Lower32);\r
      Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_FBU;\r
      AhciWriteReg (PciIo, Offset, Data64.Uint32.Upper32);\r
\r
      Data64.Uint64 = (UINTN) (AhciRegisters->AhciCmdListPciAddr);\r
      Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_CLB;\r
      AhciWriteReg (PciIo, Offset, Data64.Uint32.Lower32);\r
      Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_CLBU;\r
      AhciWriteReg (PciIo, Offset, Data64.Uint32.Upper32);\r
\r
      Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_CMD;\r
      Data = AhciReadReg (PciIo, Offset);\r
      if ((Data & EFI_AHCI_PORT_CMD_CPD) != 0) {\r
        AhciOrReg (PciIo, Offset, EFI_AHCI_PORT_CMD_POD);\r
      }\r
\r
      if ((Capability & EFI_AHCI_CAP_SSS) != 0) {\r
        AhciOrReg (PciIo, Offset, EFI_AHCI_PORT_CMD_SUD);\r
      }\r
\r
      //\r
      // Disable aggressive power management.\r
      //\r
      Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_SCTL;\r
      AhciOrReg (PciIo, Offset, EFI_AHCI_PORT_SCTL_IPM_INIT);\r
      //\r
      // Disable the reporting of the corresponding interrupt to system software.\r
      //\r
      Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_IE;\r
      AhciAndReg (PciIo, Offset, 0);\r
\r
      //\r
      // Now inform the IDE Controller Init Module.\r
      //\r
      IdeInit->NotifyPhase (IdeInit, EfiIdeBusBeforeDevicePresenceDetection, Port);\r
\r
      //\r
      // Enable FIS Receive DMA engine for the first D2H FIS.\r
      //\r
      Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_CMD;\r
      AhciOrReg (PciIo, Offset, EFI_AHCI_PORT_CMD_FRE);\r
\r
      //\r
      // Wait for the Phy to detect the presence of a device.\r
      //\r
      PhyDetectDelay = EFI_AHCI_BUS_PHY_DETECT_TIMEOUT;\r
      Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_SSTS;\r
      do {\r
        Data = AhciReadReg (PciIo, Offset) & EFI_AHCI_PORT_SSTS_DET_MASK;\r
        if ((Data == EFI_AHCI_PORT_SSTS_DET_PCE) || (Data == EFI_AHCI_PORT_SSTS_DET)) {\r
          break;\r
        }\r
\r
        MicroSecondDelay (1000);\r
        PhyDetectDelay--;\r
      } while (PhyDetectDelay > 0);\r
\r
      if (PhyDetectDelay == 0) {\r
        //\r
        // No device detected at this port.\r
        // Clear PxCMD.SUD for those ports at which there are no device present.\r
        //\r
        Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_CMD;\r
        AhciAndReg (PciIo, Offset, (UINT32) ~(EFI_AHCI_PORT_CMD_SUD));\r
        continue;\r
      }\r
\r
      Status = AhciWaitDeviceReady (PciIo, Port);\r
      if (EFI_ERROR (Status)) {\r
        continue;\r
      }\r
\r
      //\r
      // When the first D2H register FIS is received, the content of PxSIG register is updated.\r
      //\r
      Offset = EFI_AHCI_PORT_START + Port * EFI_AHCI_PORT_REG_WIDTH + EFI_AHCI_PORT_SIG;\r
      Status = AhciWaitMmioSet (\r
                 PciIo,\r
                 Offset,\r
                 0x0000FFFF,\r
                 0x00000101,\r
                 EFI_TIMER_PERIOD_SECONDS(16)\r
                 );\r
      if (EFI_ERROR (Status)) {\r
        continue;\r
      }\r
\r
      Data = AhciReadReg (PciIo, Offset);\r
      if ((Data & EFI_AHCI_ATAPI_SIG_MASK) == EFI_AHCI_ATAPI_DEVICE_SIG) {\r
        Status = AhciIdentifyPacket (PciIo, AhciRegisters, Port, 0, &Buffer);\r
\r
        if (EFI_ERROR (Status)) {\r
          continue;\r
        }\r
\r
        DeviceType = EfiIdeCdrom;\r
      } else if ((Data & EFI_AHCI_ATAPI_SIG_MASK) == EFI_AHCI_ATA_DEVICE_SIG) {\r
        Status = AhciIdentify (PciIo, AhciRegisters, Port, 0, &Buffer);\r
\r
        if (EFI_ERROR (Status)) {\r
          REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_PERIPHERAL_FIXED_MEDIA | EFI_P_EC_NOT_DETECTED));\r
          continue;\r
        }\r
\r
        DEBUG ((\r
          DEBUG_INFO, "IDENTIFY DEVICE: [0] = %016x, [2] = %016x, [83] = %016x, [86] = %016x\n",\r
          Buffer.AtaData.config, Buffer.AtaData.specific_config,\r
          Buffer.AtaData.command_set_supported_83, Buffer.AtaData.command_set_feature_enb_86\r
          ));\r
        if ((Buffer.AtaData.config & BIT2) != 0) {\r
          //\r
          // SpinUp disk if device reported incomplete IDENTIFY DEVICE.\r
          //\r
          Status = AhciSpinUpDisk (\r
                     PciIo,\r
                     AhciRegisters,\r
                     Port,\r
                     0,\r
                     &Buffer\r
                     );\r
          if (EFI_ERROR (Status)) {\r
            DEBUG ((DEBUG_ERROR, "Spin up standby device failed - %r\n", Status));\r
            continue;\r
          }\r
        }\r
\r
        DeviceType = EfiIdeHarddisk;\r
      } else {\r
        continue;\r
      }\r
      DEBUG ((DEBUG_INFO, "port [%d] port multitplier [%d] has a [%a]\n",\r
              Port, 0, DeviceType == EfiIdeCdrom ? "cdrom" : "harddisk"));\r
\r
      //\r
      // If the device is a hard disk, then try to enable S.M.A.R.T feature\r
      //\r
      if ((DeviceType == EfiIdeHarddisk) && PcdGetBool (PcdAtaSmartEnable)) {\r
        AhciAtaSmartSupport (\r
          PciIo,\r
          AhciRegisters,\r
          Port,\r
          0,\r
          &Buffer,\r
          NULL\r
          );\r
      }\r
\r
      //\r
      // Submit identify data to IDE controller init driver\r
      //\r
      IdeInit->SubmitData (IdeInit, Port, 0, &Buffer);\r
\r
      //\r
      // Now start to config ide device parameter and transfer mode.\r
      //\r
      Status = IdeInit->CalculateMode (\r
                          IdeInit,\r
                          Port,\r
                          0,\r
                          &SupportedModes\r
                          );\r
      if (EFI_ERROR (Status)) {\r
        DEBUG ((EFI_D_ERROR, "Calculate Mode Fail, Status = %r\n", Status));\r
        continue;\r
      }\r
\r
      //\r
      // Set best supported PIO mode on this IDE device\r
      //\r
      if (SupportedModes->PioMode.Mode <= EfiAtaPioMode2) {\r
        TransferMode.ModeCategory = EFI_ATA_MODE_DEFAULT_PIO;\r
      } else {\r
        TransferMode.ModeCategory = EFI_ATA_MODE_FLOW_PIO;\r
      }\r
\r
      TransferMode.ModeNumber = (UINT8) (SupportedModes->PioMode.Mode);\r
\r
      //\r
      // Set supported DMA mode on this IDE device. Note that UDMA & MDMA can't\r
      // be set together. Only one DMA mode can be set to a device. If setting\r
      // DMA mode operation fails, we can continue moving on because we only use\r
      // PIO mode at boot time. DMA modes are used by certain kind of OS booting\r
      //\r
      if (SupportedModes->UdmaMode.Valid) {\r
        TransferMode.ModeCategory = EFI_ATA_MODE_UDMA;\r
        TransferMode.ModeNumber = (UINT8) (SupportedModes->UdmaMode.Mode);\r
      } else if (SupportedModes->MultiWordDmaMode.Valid) {\r
        TransferMode.ModeCategory = EFI_ATA_MODE_MDMA;\r
        TransferMode.ModeNumber = (UINT8) SupportedModes->MultiWordDmaMode.Mode;\r
      }\r
\r
      Status = AhciDeviceSetFeature (PciIo, AhciRegisters, Port, 0, 0x03, (UINT32)(*(UINT8 *)&TransferMode), ATA_ATAPI_TIMEOUT);\r
      if (EFI_ERROR (Status)) {\r
        DEBUG ((EFI_D_ERROR, "Set transfer Mode Fail, Status = %r\n", Status));\r
        continue;\r
      }\r
\r
      //\r
      // Found a ATA or ATAPI device, add it into the device list.\r
      //\r
      CreateNewDeviceInfo (Instance, Port, 0xFFFF, DeviceType, &Buffer);\r
      if (DeviceType == EfiIdeHarddisk) {\r
        REPORT_STATUS_CODE (EFI_PROGRESS_CODE, (EFI_PERIPHERAL_FIXED_MEDIA | EFI_P_PC_ENABLE));\r
        AhciEnableDevSlp (\r
          PciIo,\r
          AhciRegisters,\r
          Port,\r
          0,\r
          &Buffer\r
          );\r
      }\r
\r
      //\r
      // Enable/disable PUIS according to policy setting if PUIS is capable (Word[83].BIT5 is set).\r
      //\r
      if ((Buffer.AtaData.command_set_supported_83 & BIT5) != 0) {\r
        Status = AhciPuisEnable (\r
                   PciIo,\r
                   AhciRegisters,\r
                   Port,\r
                   0\r
                   );\r
        if (EFI_ERROR (Status)) {\r
          DEBUG ((DEBUG_ERROR, "PUIS enable/disable failed, Status = %r\n", Status));\r
          continue;\r
        }\r
      }\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r