[mirror_edk2.git] / MdeModulePkg / Bus / Ata / AhciPei / AhciPei.c

/** @file\r
  The AhciPei driver is used to manage ATA hard disk device working under AHCI\r
  mode at PEI phase.\r
\r
  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "AhciPei.h"\r
#include <Ppi/PciDevice.h>\r
#include <Library/DevicePathLib.h>\r
#include <IndustryStandard/Pci.h>\r
\r
EFI_PEI_PPI_DESCRIPTOR  mAhciAtaPassThruPpiListTemplate = {\r
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEdkiiPeiAtaPassThruPpiGuid,\r
  NULL\r
};\r
\r
EFI_PEI_PPI_DESCRIPTOR  mAhciBlkIoPpiListTemplate = {\r
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEfiPeiVirtualBlockIoPpiGuid,\r
  NULL\r
};\r
\r
EFI_PEI_PPI_DESCRIPTOR  mAhciBlkIo2PpiListTemplate = {\r
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEfiPeiVirtualBlockIo2PpiGuid,\r
  NULL\r
};\r
\r
EFI_PEI_PPI_DESCRIPTOR  mAhciStorageSecurityPpiListTemplate = {\r
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEdkiiPeiStorageSecurityCommandPpiGuid,\r
  NULL\r
};\r
\r
EFI_PEI_NOTIFY_DESCRIPTOR  mAhciEndOfPeiNotifyListTemplate = {\r
  (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEfiEndOfPeiSignalPpiGuid,\r
  AhciPeimEndOfPei\r
};\r
\r
EFI_PEI_NOTIFY_DESCRIPTOR  mAtaAhciHostControllerNotify = {\r
  (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEdkiiPeiAtaAhciHostControllerPpiGuid,\r
  AtaAhciHostControllerPpiInstallationCallback\r
};\r
\r
EFI_PEI_NOTIFY_DESCRIPTOR  mPciDevicePpiNotify = {\r
  (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEdkiiPeiPciDevicePpiGuid,\r
  AtaAhciPciDevicePpiInstallationCallback\r
};\r
\r
/**\r
  Free the DMA resources allocated by an ATA AHCI controller.\r
\r
  @param[in] Private    A pointer to the PEI_AHCI_CONTROLLER_PRIVATE_DATA data\r
                        structure.\r
\r
**/\r
VOID\r
AhciFreeDmaResource (\r
  IN PEI_AHCI_CONTROLLER_PRIVATE_DATA  *Private\r
  )\r
{\r
  EFI_AHCI_REGISTERS  *AhciRegisters;\r
\r
  ASSERT (Private != NULL);\r
\r
  AhciRegisters = &Private->AhciRegisters;\r
\r
  if (AhciRegisters->AhciRFisMap != NULL) {\r
    IoMmuFreeBuffer (\r
      EFI_SIZE_TO_PAGES (AhciRegisters->MaxRFisSize),\r
      AhciRegisters->AhciRFis,\r
      AhciRegisters->AhciRFisMap\r
      );\r
  }\r
\r
  if (AhciRegisters->AhciCmdListMap != NULL) {\r
    IoMmuFreeBuffer (\r
      EFI_SIZE_TO_PAGES (AhciRegisters->MaxCmdListSize),\r
      AhciRegisters->AhciCmdList,\r
      AhciRegisters->AhciCmdListMap\r
      );\r
  }\r
\r
  if (AhciRegisters->AhciCmdTableMap != NULL) {\r
    IoMmuFreeBuffer (\r
      EFI_SIZE_TO_PAGES (AhciRegisters->MaxCmdTableSize),\r
      AhciRegisters->AhciCmdTable,\r
      AhciRegisters->AhciCmdTableMap\r
      );\r
  }\r
}\r
\r
/**\r
  One notified function to cleanup the allocated DMA buffers at EndOfPei.\r
\r
  @param[in] PeiServices         Pointer to PEI Services Table.\r
  @param[in] NotifyDescriptor    Pointer to the descriptor for the Notification\r
                                 event that caused this function to execute.\r
  @param[in] Ppi                 Pointer to the PPI data associated with this function.\r
\r
  @retval EFI_SUCCESS    The function completes successfully\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AhciPeimEndOfPei (\r
  IN EFI_PEI_SERVICES           **PeiServices,\r
  IN EFI_PEI_NOTIFY_DESCRIPTOR  *NotifyDescriptor,\r
  IN VOID                       *Ppi\r
  )\r
{\r
  PEI_AHCI_CONTROLLER_PRIVATE_DATA  *Private;\r
\r
  Private = GET_AHCI_PEIM_HC_PRIVATE_DATA_FROM_THIS_NOTIFY (NotifyDescriptor);\r
  AhciFreeDmaResource (Private);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Initialize and install PrivateData PPIs.\r
\r
  @param[in] MmioBase            MMIO base address of specific AHCI controller\r
  @param[in] DevicePath          A pointer to the EFI_DEVICE_PATH_PROTOCOL\r
                                 structure.\r
  @param[in] DevicePathLength    Length of the device path.\r
\r
  @retval EFI_SUCCESS  AHCI controller initialized and PPIs installed\r
  @retval others       Failed to initialize AHCI controller\r
**/\r
EFI_STATUS\r
AtaAhciInitPrivateData (\r
  IN UINTN                     MmioBase,\r
  IN EFI_DEVICE_PATH_PROTOCOL  *DevicePath,\r
  IN UINTN                     DevicePathLength\r
  )\r
{\r
  EFI_STATUS                        Status;\r
  UINT32                            PortBitMap;\r
  UINT8                             NumberOfPorts;\r
  PEI_AHCI_CONTROLLER_PRIVATE_DATA  *Private;\r
  EFI_BOOT_MODE                     BootMode;\r
\r
  DEBUG ((DEBUG_INFO, "Initializing private data for ATA\n"));\r
\r
  //\r
  // Get the current boot mode.\r
  //\r
  Status = PeiServicesGetBootMode (&BootMode);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "%a: Fail to get the current boot mode.\n", __FUNCTION__));\r
    return Status;\r
  }\r
\r
  //\r
  // Check validity of the device path of the ATA AHCI controller.\r
  //\r
  Status = AhciIsHcDevicePathValid (DevicePath, DevicePathLength);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((\r
      DEBUG_ERROR,\r
      "%a: The device path is invalid.\n",\r
      __FUNCTION__\r
      ));\r
    return Status;\r
  }\r
\r
  //\r
  // For S3 resume performance consideration, not all ports on an ATA AHCI\r
  // controller will be enumerated/initialized. The driver consumes the\r
  // content within S3StorageDeviceInitList LockBox to get the ports that\r
  // will be enumerated/initialized during S3 resume.\r
  //\r
  if (BootMode == BOOT_ON_S3_RESUME) {\r
    NumberOfPorts = AhciS3GetEumeratePorts (DevicePath, DevicePathLength, &PortBitMap);\r
    if (NumberOfPorts == 0) {\r
      return EFI_SUCCESS;\r
    }\r
  } else {\r
    PortBitMap = MAX_UINT32;\r
  }\r
\r
  //\r
  // Memory allocation for controller private data.\r
  //\r
  Private = AllocateZeroPool (sizeof (PEI_AHCI_CONTROLLER_PRIVATE_DATA));\r
  if (Private == NULL) {\r
    DEBUG ((\r
      DEBUG_ERROR,\r
      "%a: Fail to allocate private data.\n",\r
      __FUNCTION__\r
      ));\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  //\r
  // Initialize controller private data.\r
  //\r
  Private->Signature        = AHCI_PEI_CONTROLLER_PRIVATE_DATA_SIGNATURE;\r
  Private->MmioBase         = MmioBase;\r
  Private->DevicePathLength = DevicePathLength;\r
  Private->DevicePath       = DevicePath;\r
  Private->PortBitMap       = PortBitMap;\r
  InitializeListHead (&Private->DeviceList);\r
\r
  Status = AhciModeInitialization (Private);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Private->AtaPassThruMode.Attributes = EFI_ATA_PASS_THRU_ATTRIBUTES_PHYSICAL |\r
                                        EFI_ATA_PASS_THRU_ATTRIBUTES_LOGICAL;\r
  Private->AtaPassThruMode.IoAlign      = sizeof (UINTN);\r
  Private->AtaPassThruPpi.Revision      = EDKII_PEI_ATA_PASS_THRU_PPI_REVISION;\r
  Private->AtaPassThruPpi.Mode          = &Private->AtaPassThruMode;\r
  Private->AtaPassThruPpi.PassThru      = AhciAtaPassThruPassThru;\r
  Private->AtaPassThruPpi.GetNextPort   = AhciAtaPassThruGetNextPort;\r
  Private->AtaPassThruPpi.GetNextDevice = AhciAtaPassThruGetNextDevice;\r
  Private->AtaPassThruPpi.GetDevicePath = AhciAtaPassThruGetDevicePath;\r
  CopyMem (\r
    &Private->AtaPassThruPpiList,\r
    &mAhciAtaPassThruPpiListTemplate,\r
    sizeof (EFI_PEI_PPI_DESCRIPTOR)\r
    );\r
  Private->AtaPassThruPpiList.Ppi = &Private->AtaPassThruPpi;\r
  PeiServicesInstallPpi (&Private->AtaPassThruPpiList);\r
\r
  Private->BlkIoPpi.GetNumberOfBlockDevices = AhciBlockIoGetDeviceNo;\r
  Private->BlkIoPpi.GetBlockDeviceMediaInfo = AhciBlockIoGetMediaInfo;\r
  Private->BlkIoPpi.ReadBlocks              = AhciBlockIoReadBlocks;\r
  CopyMem (\r
    &Private->BlkIoPpiList,\r
    &mAhciBlkIoPpiListTemplate,\r
    sizeof (EFI_PEI_PPI_DESCRIPTOR)\r
    );\r
  Private->BlkIoPpiList.Ppi = &Private->BlkIoPpi;\r
  PeiServicesInstallPpi (&Private->BlkIoPpiList);\r
\r
  Private->BlkIo2Ppi.Revision                = EFI_PEI_RECOVERY_BLOCK_IO2_PPI_REVISION;\r
  Private->BlkIo2Ppi.GetNumberOfBlockDevices = AhciBlockIoGetDeviceNo2;\r
  Private->BlkIo2Ppi.GetBlockDeviceMediaInfo = AhciBlockIoGetMediaInfo2;\r
  Private->BlkIo2Ppi.ReadBlocks              = AhciBlockIoReadBlocks2;\r
  CopyMem (\r
    &Private->BlkIo2PpiList,\r
    &mAhciBlkIo2PpiListTemplate,\r
    sizeof (EFI_PEI_PPI_DESCRIPTOR)\r
    );\r
  Private->BlkIo2PpiList.Ppi = &Private->BlkIo2Ppi;\r
  PeiServicesInstallPpi (&Private->BlkIo2PpiList);\r
\r
  if (Private->TrustComputingDevices != 0) {\r
    DEBUG ((\r
      DEBUG_INFO,\r
      "%a: Security Security Command PPI will be produced.\n",\r
      __FUNCTION__\r
      ));\r
    Private->StorageSecurityPpi.Revision           = EDKII_STORAGE_SECURITY_PPI_REVISION;\r
    Private->StorageSecurityPpi.GetNumberofDevices = AhciStorageSecurityGetDeviceNo;\r
    Private->StorageSecurityPpi.GetDevicePath      = AhciStorageSecurityGetDevicePath;\r
    Private->StorageSecurityPpi.ReceiveData        = AhciStorageSecurityReceiveData;\r
    Private->StorageSecurityPpi.SendData           = AhciStorageSecuritySendData;\r
    CopyMem (\r
      &Private->StorageSecurityPpiList,\r
      &mAhciStorageSecurityPpiListTemplate,\r
      sizeof (EFI_PEI_PPI_DESCRIPTOR)\r
      );\r
    Private->StorageSecurityPpiList.Ppi = &Private->StorageSecurityPpi;\r
    PeiServicesInstallPpi (&Private->StorageSecurityPpiList);\r
  }\r
\r
  CopyMem (\r
    &Private->EndOfPeiNotifyList,\r
    &mAhciEndOfPeiNotifyListTemplate,\r
    sizeof (EFI_PEI_NOTIFY_DESCRIPTOR)\r
    );\r
  PeiServicesNotifyPpi (&Private->EndOfPeiNotifyList);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Initialize AHCI controller from EDKII_ATA_AHCI_HOST_CONTROLLER_PPI instance.\r
\r
  @param[in] AhciHcPpi  Pointer to the AHCI Host Controller PPI instance.\r
\r
  @retval EFI_SUCCESS   PPI successfully installed.\r
**/\r
EFI_STATUS\r
AtaAhciInitPrivateDataFromHostControllerPpi (\r
  IN EDKII_ATA_AHCI_HOST_CONTROLLER_PPI  *AhciHcPpi\r
  )\r
{\r
  UINT8                     Controller;\r
  UINTN                     MmioBase;\r
  UINTN                     DevicePathLength;\r
  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
  EFI_STATUS                Status;\r
\r
  Controller = 0;\r
  MmioBase   = 0;\r
  while (TRUE) {\r
    Status = AhciHcPpi->GetAhciHcMmioBar (\r
                          AhciHcPpi,\r
                          Controller,\r
                          &MmioBase\r
                          );\r
    //\r
    // When status is error, meant no controller is found.\r
    //\r
    if (EFI_ERROR (Status)) {\r
      break;\r
    }\r
\r
    Status = AhciHcPpi->GetAhciHcDevicePath (\r
                          AhciHcPpi,\r
                          Controller,\r
                          &DevicePathLength,\r
                          &DevicePath\r
                          );\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((\r
        DEBUG_ERROR,\r
        "%a: Fail to allocate get the device path for Controller %d.\n",\r
        __FUNCTION__,\r
        Controller\r
        ));\r
      return Status;\r
    }\r
\r
    Status = AtaAhciInitPrivateData (MmioBase, DevicePath, DevicePathLength);\r
    if (EFI_ERROR (Status)) {\r
      DEBUG ((\r
        DEBUG_ERROR,\r
        "%a: Controller initialization fail for Controller %d with Status - %r.\n",\r
        __FUNCTION__,\r
        Controller,\r
        Status\r
        ));\r
    } else {\r
      DEBUG ((\r
        DEBUG_INFO,\r
        "%a: Controller %d has been successfully initialized.\n",\r
        __FUNCTION__,\r
        Controller\r
        ));\r
    }\r
\r
    Controller++;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Callback for EDKII_ATA_AHCI_HOST_CONTROLLER_PPI installation.\r
\r
  @param[in] PeiServices         Pointer to PEI Services Table.\r
  @param[in] NotifyDescriptor    Pointer to the descriptor for the Notification\r
                                 event that caused this function to execute.\r
  @param[in] Ppi                 Pointer to the PPI data associated with this function.\r
\r
  @retval EFI_SUCCESS            The function completes successfully\r
  @retval Others                 Cannot initialize AHCI controller from given EDKII_ATA_AHCI_HOST_CONTROLLER_PPI\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AtaAhciHostControllerPpiInstallationCallback (\r
  IN EFI_PEI_SERVICES           **PeiServices,\r
  IN EFI_PEI_NOTIFY_DESCRIPTOR  *NotifyDescriptor,\r
  IN VOID                       *Ppi\r
  )\r
{\r
  EDKII_ATA_AHCI_HOST_CONTROLLER_PPI  *AhciHcPpi;\r
\r
  if (Ppi == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  AhciHcPpi = (EDKII_ATA_AHCI_HOST_CONTROLLER_PPI *)Ppi;\r
\r
  return AtaAhciInitPrivateDataFromHostControllerPpi (AhciHcPpi);\r
}\r
\r
/**\r
  Initialize AHCI controller from fiven PCI_DEVICE_PPI.\r
\r
  @param[in] PciDevice  Pointer to the PCI Device PPI instance.\r
\r
  @retval EFI_SUCCESS      The function completes successfully\r
  @retval Others           Cannot initialize AHCI controller for given device\r
**/\r
EFI_STATUS\r
AtaAhciInitPrivateDataFromPciDevice (\r
  EDKII_PCI_DEVICE_PPI  *PciDevice\r
  )\r
{\r
  EFI_STATUS                Status;\r
  PCI_TYPE00                PciData;\r
  UINTN                     MmioBase;\r
  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
  UINTN                     DevicePathLength;\r
  UINT64                    EnabledPciAttributes;\r
\r
  //\r
  // Now further check the PCI header: Base Class (offset 0x0B) and\r
  // Sub Class (offset 0x0A). This controller should be an SATA controller\r
  //\r
  Status = PciDevice->PciIo.Pci.Read (\r
                                  &PciDevice->PciIo,\r
                                  EfiPciIoWidthUint8,\r
                                  PCI_CLASSCODE_OFFSET,\r
                                  sizeof (PciData.Hdr.ClassCode),\r
                                  PciData.Hdr.ClassCode\r
                                  );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  if (!IS_PCI_IDE (&PciData) && !IS_PCI_SATADPA (&PciData)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  Status = PciDevice->PciIo.Attributes (\r
                              &PciDevice->PciIo,\r
                              EfiPciIoAttributeOperationSupported,\r
                              0,\r
                              &EnabledPciAttributes\r
                              );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_UNSUPPORTED;\r
  } else {\r
    EnabledPciAttributes &= (UINT64)EFI_PCI_DEVICE_ENABLE;\r
    Status                = PciDevice->PciIo.Attributes (\r
                                               &PciDevice->PciIo,\r
                                               EfiPciIoAttributeOperationEnable,\r
                                               EnabledPciAttributes,\r
                                               NULL\r
                                               );\r
    if (EFI_ERROR (Status)) {\r
      return EFI_UNSUPPORTED;\r
    }\r
  }\r
\r
  Status = PciDevice->PciIo.Pci.Read (\r
                                  &PciDevice->PciIo,\r
                                  EfiPciIoWidthUint32,\r
                                  0x24,\r
                                  sizeof (UINTN),\r
                                  &MmioBase\r
                                  );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  DevicePathLength = GetDevicePathSize (PciDevice->DevicePath);\r
  DevicePath       = PciDevice->DevicePath;\r
\r
  Status = AtaAhciInitPrivateData (MmioBase, DevicePath, DevicePathLength);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((\r
      DEBUG_INFO,\r
      "%a: Failed to init controller, with Status - %r\n",\r
      __FUNCTION__,\r
      Status\r
      ));\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Callback for EDKII_PCI_DEVICE_PPI installation.\r
\r
  @param[in] PeiServices         Pointer to PEI Services Table.\r
  @param[in] NotifyDescriptor    Pointer to the descriptor for the Notification\r
                                 event that caused this function to execute.\r
  @param[in] Ppi                 Pointer to the PPI data associated with this function.\r
\r
  @retval EFI_SUCCESS            The function completes successfully\r
  @retval Others                 Cannot initialize AHCI controller from given PCI_DEVICE_PPI\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AtaAhciPciDevicePpiInstallationCallback (\r
  IN EFI_PEI_SERVICES           **PeiServices,\r
  IN EFI_PEI_NOTIFY_DESCRIPTOR  *NotifyDescriptor,\r
  IN VOID                       *Ppi\r
  )\r
{\r
  EDKII_PCI_DEVICE_PPI  *PciDevice;\r
\r
  PciDevice = (EDKII_PCI_DEVICE_PPI *)Ppi;\r
\r
  return AtaAhciInitPrivateDataFromPciDevice (PciDevice);\r
}\r
\r
/**\r
  Entry point of the PEIM.\r
\r
  @param[in] FileHandle     Handle of the file being invoked.\r
  @param[in] PeiServices    Describes the list of possible PEI Services.\r
\r
  @retval EFI_SUCCESS    PPI successfully installed.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
AtaAhciPeimEntry (\r
  IN EFI_PEI_FILE_HANDLE     FileHandle,\r
  IN CONST EFI_PEI_SERVICES  **PeiServices\r
  )\r
{\r
  DEBUG ((DEBUG_INFO, "%a: Enters.\n", __FUNCTION__));\r
\r
  PeiServicesNotifyPpi (&mAtaAhciHostControllerNotify);\r
\r
  PeiServicesNotifyPpi (&mPciDevicePpiNotify);\r
\r
  return EFI_SUCCESS;\r
}\r
Commit	Line	Data
87bc3f19 HW	1	/** @file\r
	2	The AhciPei driver is used to manage ATA hard disk device working under AHCI\r
	3	mode at PEI phase.\r
	4	\r
	5	Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r
	6	\r
9d510e61	7	SPDX-License-Identifier: BSD-2-Clause-Patent\r
87bc3f19 HW	8	\r
	9	**/\r
	10	\r
	11	#include "AhciPei.h"\r
a8f59e2e CM	12	#include <Ppi/PciDevice.h>\r
	13	#include <Library/DevicePathLib.h>\r
	14	#include <IndustryStandard/Pci.h>\r
87bc3f19 HW	15	\r
	16	EFI_PEI_PPI_DESCRIPTOR mAhciAtaPassThruPpiListTemplate = {\r
	17	(EFI_PEI_PPI_DESCRIPTOR_PPI \| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
	18	&gEdkiiPeiAtaPassThruPpiGuid,\r
	19	NULL\r
	20	};\r
	21	\r
b2b8e872 HW	22	EFI_PEI_PPI_DESCRIPTOR mAhciBlkIoPpiListTemplate = {\r
	23	(EFI_PEI_PPI_DESCRIPTOR_PPI \| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
	24	&gEfiPeiVirtualBlockIoPpiGuid,\r
	25	NULL\r
	26	};\r
	27	\r
	28	EFI_PEI_PPI_DESCRIPTOR mAhciBlkIo2PpiListTemplate = {\r
	29	(EFI_PEI_PPI_DESCRIPTOR_PPI \| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
	30	&gEfiPeiVirtualBlockIo2PpiGuid,\r
	31	NULL\r
	32	};\r
	33	\r
87bc3f19 HW	34	EFI_PEI_PPI_DESCRIPTOR mAhciStorageSecurityPpiListTemplate = {\r
	35	(EFI_PEI_PPI_DESCRIPTOR_PPI \| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
	36	&gEdkiiPeiStorageSecurityCommandPpiGuid,\r
	37	NULL\r
	38	};\r
	39	\r
	40	EFI_PEI_NOTIFY_DESCRIPTOR mAhciEndOfPeiNotifyListTemplate = {\r
	41	(EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK \| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
	42	&gEfiEndOfPeiSignalPpiGuid,\r
	43	AhciPeimEndOfPei\r
	44	};\r
	45	\r
a8f59e2e CM	46	EFI_PEI_NOTIFY_DESCRIPTOR mAtaAhciHostControllerNotify = {\r
	47	(EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK \| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
	48	&gEdkiiPeiAtaAhciHostControllerPpiGuid,\r
	49	AtaAhciHostControllerPpiInstallationCallback\r
	50	};\r
	51	\r
	52	EFI_PEI_NOTIFY_DESCRIPTOR mPciDevicePpiNotify = {\r
	53	(EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK \| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
	54	&gEdkiiPeiPciDevicePpiGuid,\r
	55	AtaAhciPciDevicePpiInstallationCallback\r
	56	};\r
	57	\r
87bc3f19 HW	58	/**\r
	59	Free the DMA resources allocated by an ATA AHCI controller.\r
	60	\r
	61	@param[in] Private A pointer to the PEI_AHCI_CONTROLLER_PRIVATE_DATA data\r
	62	structure.\r
	63	\r
	64	**/\r
	65	VOID\r
	66	AhciFreeDmaResource (\r
1436aea4	67	IN PEI_AHCI_CONTROLLER_PRIVATE_DATA *Private\r
87bc3f19 HW	68	)\r
87bc3f19 HW	69	{\r
1436aea4	70	EFI_AHCI_REGISTERS *AhciRegisters;\r
87bc3f19 HW	71	\r
	72	ASSERT (Private != NULL);\r
	73	\r
	74	AhciRegisters = &Private->AhciRegisters;\r
	75	\r
	76	if (AhciRegisters->AhciRFisMap != NULL) {\r
	77	IoMmuFreeBuffer (\r
1436aea4 MK	78	EFI_SIZE_TO_PAGES (AhciRegisters->MaxRFisSize),\r
	79	AhciRegisters->AhciRFis,\r
	80	AhciRegisters->AhciRFisMap\r
	81	);\r
87bc3f19 HW	82	}\r
	83	\r
	84	if (AhciRegisters->AhciCmdListMap != NULL) {\r
	85	IoMmuFreeBuffer (\r
1436aea4 MK	86	EFI_SIZE_TO_PAGES (AhciRegisters->MaxCmdListSize),\r
	87	AhciRegisters->AhciCmdList,\r
	88	AhciRegisters->AhciCmdListMap\r
	89	);\r
87bc3f19 HW	90	}\r
	91	\r
	92	if (AhciRegisters->AhciCmdTableMap != NULL) {\r
	93	IoMmuFreeBuffer (\r
	94	EFI_SIZE_TO_PAGES (AhciRegisters->MaxCmdTableSize),\r
	95	AhciRegisters->AhciCmdTable,\r
	96	AhciRegisters->AhciCmdTableMap\r
	97	);\r
	98	}\r
87bc3f19 HW	99	}\r
	100	\r
	101	/**\r
	102	One notified function to cleanup the allocated DMA buffers at EndOfPei.\r
	103	\r
	104	@param[in] PeiServices Pointer to PEI Services Table.\r
	105	@param[in] NotifyDescriptor Pointer to the descriptor for the Notification\r
	106	event that caused this function to execute.\r
	107	@param[in] Ppi Pointer to the PPI data associated with this function.\r
	108	\r
	109	@retval EFI_SUCCESS The function completes successfully\r
	110	\r
	111	**/\r
	112	EFI_STATUS\r
	113	EFIAPI\r
	114	AhciPeimEndOfPei (\r
	115	IN EFI_PEI_SERVICES **PeiServices,\r
	116	IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor,\r
	117	IN VOID *Ppi\r
	118	)\r
	119	{\r
1436aea4	120	PEI_AHCI_CONTROLLER_PRIVATE_DATA *Private;\r
87bc3f19 HW	121	\r
	122	Private = GET_AHCI_PEIM_HC_PRIVATE_DATA_FROM_THIS_NOTIFY (NotifyDescriptor);\r
	123	AhciFreeDmaResource (Private);\r
	124	\r
	125	return EFI_SUCCESS;\r
	126	}\r
	127	\r
	128	/**\r
a8f59e2e	129	Initialize and install PrivateData PPIs.\r
87bc3f19	130	\r
a8f59e2e CM	131	@param[in] MmioBase MMIO base address of specific AHCI controller\r
	132	@param[in] DevicePath A pointer to the EFI_DEVICE_PATH_PROTOCOL\r
	133	structure.\r
	134	@param[in] DevicePathLength Length of the device path.\r
87bc3f19	135	\r
a8f59e2e CM	136	@retval EFI_SUCCESS AHCI controller initialized and PPIs installed\r
a8f59e2e CM	137	@retval others Failed to initialize AHCI controller\r
87bc3f19 HW	138	**/\r
87bc3f19 HW	139	EFI_STATUS\r
a8f59e2e CM	140	AtaAhciInitPrivateData (\r
	141	IN UINTN MmioBase,\r
	142	IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
	143	IN UINTN DevicePathLength\r
87bc3f19 HW	144	)\r
87bc3f19 HW	145	{\r
a8f59e2e CM	146	EFI_STATUS Status;\r
	147	UINT32 PortBitMap;\r
	148	UINT8 NumberOfPorts;\r
	149	PEI_AHCI_CONTROLLER_PRIVATE_DATA *Private;\r
	150	EFI_BOOT_MODE BootMode;\r
87bc3f19	151	\r
a8f59e2e	152	DEBUG ((DEBUG_INFO, "Initializing private data for ATA\n"));\r
87bc3f19 HW	153	\r
	154	//\r
	155	// Get the current boot mode.\r
	156	//\r
	157	Status = PeiServicesGetBootMode (&BootMode);\r
	158	if (EFI_ERROR (Status)) {\r
	159	DEBUG ((DEBUG_ERROR, "%a: Fail to get the current boot mode.\n", __FUNCTION__));\r
	160	return Status;\r
	161	}\r
	162	\r
	163	//\r
a8f59e2e	164	// Check validity of the device path of the ATA AHCI controller.\r
87bc3f19	165	//\r
a8f59e2e	166	Status = AhciIsHcDevicePathValid (DevicePath, DevicePathLength);\r
87bc3f19	167	if (EFI_ERROR (Status)) {\r
a8f59e2e CM	168	DEBUG ((\r
	169	DEBUG_ERROR,\r
	170	"%a: The device path is invalid.\n",\r
	171	__FUNCTION__\r
	172	));\r
	173	return Status;\r
	174	}\r
	175	\r
	176	//\r
	177	// For S3 resume performance consideration, not all ports on an ATA AHCI\r
	178	// controller will be enumerated/initialized. The driver consumes the\r
	179	// content within S3StorageDeviceInitList LockBox to get the ports that\r
	180	// will be enumerated/initialized during S3 resume.\r
	181	//\r
	182	if (BootMode == BOOT_ON_S3_RESUME) {\r
	183	NumberOfPorts = AhciS3GetEumeratePorts (DevicePath, DevicePathLength, &PortBitMap);\r
	184	if (NumberOfPorts == 0) {\r
	185	return EFI_SUCCESS;\r
	186	}\r
	187	} else {\r
	188	PortBitMap = MAX_UINT32;\r
87bc3f19 HW	189	}\r
87bc3f19 HW	190	\r
a8f59e2e CM	191	//\r
	192	// Memory allocation for controller private data.\r
	193	//\r
	194	Private = AllocateZeroPool (sizeof (PEI_AHCI_CONTROLLER_PRIVATE_DATA));\r
	195	if (Private == NULL) {\r
	196	DEBUG ((\r
	197	DEBUG_ERROR,\r
	198	"%a: Fail to allocate private data.\n",\r
	199	__FUNCTION__\r
	200	));\r
	201	return EFI_OUT_OF_RESOURCES;\r
	202	}\r
	203	\r
	204	//\r
	205	// Initialize controller private data.\r
	206	//\r
	207	Private->Signature = AHCI_PEI_CONTROLLER_PRIVATE_DATA_SIGNATURE;\r
	208	Private->MmioBase = MmioBase;\r
	209	Private->DevicePathLength = DevicePathLength;\r
	210	Private->DevicePath = DevicePath;\r
	211	Private->PortBitMap = PortBitMap;\r
	212	InitializeListHead (&Private->DeviceList);\r
	213	\r
	214	Status = AhciModeInitialization (Private);\r
	215	if (EFI_ERROR (Status)) {\r
	216	return Status;\r
	217	}\r
	218	\r
	219	Private->AtaPassThruMode.Attributes = EFI_ATA_PASS_THRU_ATTRIBUTES_PHYSICAL \|\r
	220	EFI_ATA_PASS_THRU_ATTRIBUTES_LOGICAL;\r
	221	Private->AtaPassThruMode.IoAlign = sizeof (UINTN);\r
	222	Private->AtaPassThruPpi.Revision = EDKII_PEI_ATA_PASS_THRU_PPI_REVISION;\r
	223	Private->AtaPassThruPpi.Mode = &Private->AtaPassThruMode;\r
	224	Private->AtaPassThruPpi.PassThru = AhciAtaPassThruPassThru;\r
	225	Private->AtaPassThruPpi.GetNextPort = AhciAtaPassThruGetNextPort;\r
	226	Private->AtaPassThruPpi.GetNextDevice = AhciAtaPassThruGetNextDevice;\r
	227	Private->AtaPassThruPpi.GetDevicePath = AhciAtaPassThruGetDevicePath;\r
	228	CopyMem (\r
	229	&Private->AtaPassThruPpiList,\r
	230	&mAhciAtaPassThruPpiListTemplate,\r
	231	sizeof (EFI_PEI_PPI_DESCRIPTOR)\r
	232	);\r
	233	Private->AtaPassThruPpiList.Ppi = &Private->AtaPassThruPpi;\r
	234	PeiServicesInstallPpi (&Private->AtaPassThruPpiList);\r
	235	\r
	236	Private->BlkIoPpi.GetNumberOfBlockDevices = AhciBlockIoGetDeviceNo;\r
	237	Private->BlkIoPpi.GetBlockDeviceMediaInfo = AhciBlockIoGetMediaInfo;\r
	238	Private->BlkIoPpi.ReadBlocks = AhciBlockIoReadBlocks;\r
	239	CopyMem (\r
	240	&Private->BlkIoPpiList,\r
	241	&mAhciBlkIoPpiListTemplate,\r
	242	sizeof (EFI_PEI_PPI_DESCRIPTOR)\r
	243	);\r
	244	Private->BlkIoPpiList.Ppi = &Private->BlkIoPpi;\r
	245	PeiServicesInstallPpi (&Private->BlkIoPpiList);\r
	246	\r
	247	Private->BlkIo2Ppi.Revision = EFI_PEI_RECOVERY_BLOCK_IO2_PPI_REVISION;\r
	248	Private->BlkIo2Ppi.GetNumberOfBlockDevices = AhciBlockIoGetDeviceNo2;\r
	249	Private->BlkIo2Ppi.GetBlockDeviceMediaInfo = AhciBlockIoGetMediaInfo2;\r
	250	Private->BlkIo2Ppi.ReadBlocks = AhciBlockIoReadBlocks2;\r
	251	CopyMem (\r
	252	&Private->BlkIo2PpiList,\r
	253	&mAhciBlkIo2PpiListTemplate,\r
	254	sizeof (EFI_PEI_PPI_DESCRIPTOR)\r
255	);\r
256	Private->BlkIo2PpiList.Ppi = &Private->BlkIo2Ppi;\r
257	PeiServicesInstallPpi (&Private->BlkIo2PpiList);\r
258	\r
259	if (Private->TrustComputingDevices != 0) {\r
260	DEBUG ((\r
261	DEBUG_INFO,\r
262	"%a: Security Security Command PPI will be produced.\n",\r
263	__FUNCTION__\r
264	));\r
265	Private->StorageSecurityPpi.Revision = EDKII_STORAGE_SECURITY_PPI_REVISION;\r
266	Private->StorageSecurityPpi.GetNumberofDevices = AhciStorageSecurityGetDeviceNo;\r
267	Private->StorageSecurityPpi.GetDevicePath = AhciStorageSecurityGetDevicePath;\r
268	Private->StorageSecurityPpi.ReceiveData = AhciStorageSecurityReceiveData;\r
269	Private->StorageSecurityPpi.SendData = AhciStorageSecuritySendData;\r
270	CopyMem (\r
271	&Private->StorageSecurityPpiList,\r
272	&mAhciStorageSecurityPpiListTemplate,\r
273	sizeof (EFI_PEI_PPI_DESCRIPTOR)\r
274	);\r
275	Private->StorageSecurityPpiList.Ppi = &Private->StorageSecurityPpi;\r
276	PeiServicesInstallPpi (&Private->StorageSecurityPpiList);\r
277	}\r
278	\r
279	CopyMem (\r
280	&Private->EndOfPeiNotifyList,\r
281	&mAhciEndOfPeiNotifyListTemplate,\r
282	sizeof (EFI_PEI_NOTIFY_DESCRIPTOR)\r
283	);\r
284	PeiServicesNotifyPpi (&Private->EndOfPeiNotifyList);\r
285	\r
286	return EFI_SUCCESS;\r
287	}\r
288	\r
289	/**\r
290	Initialize AHCI controller from EDKII_ATA_AHCI_HOST_CONTROLLER_PPI instance.\r
291	\r
292	@param[in] AhciHcPpi Pointer to the AHCI Host Controller PPI instance.\r
293	\r
294	@retval EFI_SUCCESS PPI successfully installed.\r
295	**/\r
296	EFI_STATUS\r
297	AtaAhciInitPrivateDataFromHostControllerPpi (\r
298	IN EDKII_ATA_AHCI_HOST_CONTROLLER_PPI *AhciHcPpi\r
299	)\r
300	{\r
301	UINT8 Controller;\r
302	UINTN MmioBase;\r
303	UINTN DevicePathLength;\r
304	EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
305	EFI_STATUS Status;\r
306	\r
87bc3f19 HW	307	Controller = 0;\r
	308	MmioBase = 0;\r
	309	while (TRUE) {\r
	310	Status = AhciHcPpi->GetAhciHcMmioBar (\r
	311	AhciHcPpi,\r
	312	Controller,\r
	313	&MmioBase\r
	314	);\r
	315	//\r
	316	// When status is error, meant no controller is found.\r
	317	//\r
	318	if (EFI_ERROR (Status)) {\r
	319	break;\r
	320	}\r
	321	\r
	322	Status = AhciHcPpi->GetAhciHcDevicePath (\r
	323	AhciHcPpi,\r
	324	Controller,\r
	325	&DevicePathLength,\r
	326	&DevicePath\r
	327	);\r
	328	if (EFI_ERROR (Status)) {\r
	329	DEBUG ((\r
1436aea4 MK	330	DEBUG_ERROR,\r
	331	"%a: Fail to allocate get the device path for Controller %d.\n",\r
	332	__FUNCTION__,\r
	333	Controller\r
87bc3f19 HW	334	));\r
	335	return Status;\r
	336	}\r
	337	\r
a8f59e2e	338	Status = AtaAhciInitPrivateData (MmioBase, DevicePath, DevicePathLength);\r
87bc3f19 HW	339	if (EFI_ERROR (Status)) {\r
87bc3f19 HW	340	DEBUG ((\r
1436aea4	341	DEBUG_ERROR,\r
a8f59e2e	342	"%a: Controller initialization fail for Controller %d with Status - %r.\n",\r
1436aea4	343	__FUNCTION__,\r
a8f59e2e CM	344	Controller,\r
a8f59e2e CM	345	Status\r
87bc3f19	346	));\r
87bc3f19	347	} else {\r
87bc3f19	348	DEBUG ((\r
a8f59e2e CM	349	DEBUG_INFO,\r
a8f59e2e CM	350	"%a: Controller %d has been successfully initialized.\n",\r
1436aea4 MK	351	__FUNCTION__,\r
1436aea4 MK	352	Controller\r
87bc3f19	353	));\r
87bc3f19 HW	354	}\r
87bc3f19 HW	355	\r
a8f59e2e CM	356	Controller++;\r
a8f59e2e CM	357	}\r
87bc3f19	358	\r
a8f59e2e CM	359	return EFI_SUCCESS;\r
a8f59e2e CM	360	}\r
87bc3f19	361	\r
a8f59e2e CM	362	/**\r
a8f59e2e CM	363	Callback for EDKII_ATA_AHCI_HOST_CONTROLLER_PPI installation.\r
b2b8e872	364	\r
a8f59e2e CM	365	@param[in] PeiServices Pointer to PEI Services Table.\r
	366	@param[in] NotifyDescriptor Pointer to the descriptor for the Notification\r
	367	event that caused this function to execute.\r
	368	@param[in] Ppi Pointer to the PPI data associated with this function.\r
b2b8e872	369	\r
a8f59e2e CM	370	@retval EFI_SUCCESS The function completes successfully\r
	371	@retval Others Cannot initialize AHCI controller from given EDKII_ATA_AHCI_HOST_CONTROLLER_PPI\r
	372	\r
	373	**/\r
	374	EFI_STATUS\r
	375	EFIAPI\r
	376	AtaAhciHostControllerPpiInstallationCallback (\r
	377	IN EFI_PEI_SERVICES **PeiServices,\r
	378	IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor,\r
	379	IN VOID *Ppi\r
	380	)\r
	381	{\r
	382	EDKII_ATA_AHCI_HOST_CONTROLLER_PPI *AhciHcPpi;\r
	383	\r
	384	if (Ppi == NULL) {\r
	385	return EFI_INVALID_PARAMETER;\r
	386	}\r
	387	\r
	388	AhciHcPpi = (EDKII_ATA_AHCI_HOST_CONTROLLER_PPI *)Ppi;\r
	389	\r
	390	return AtaAhciInitPrivateDataFromHostControllerPpi (AhciHcPpi);\r
	391	}\r
	392	\r
	393	/**\r
	394	Initialize AHCI controller from fiven PCI_DEVICE_PPI.\r
	395	\r
	396	@param[in] PciDevice Pointer to the PCI Device PPI instance.\r
	397	\r
	398	@retval EFI_SUCCESS The function completes successfully\r
	399	@retval Others Cannot initialize AHCI controller for given device\r
	400	**/\r
	401	EFI_STATUS\r
	402	AtaAhciInitPrivateDataFromPciDevice (\r
	403	EDKII_PCI_DEVICE_PPI *PciDevice\r
	404	)\r
	405	{\r
	406	EFI_STATUS Status;\r
	407	PCI_TYPE00 PciData;\r
	408	UINTN MmioBase;\r
	409	EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
	410	UINTN DevicePathLength;\r
	411	UINT64 EnabledPciAttributes;\r
	412	\r
	413	//\r
	414	// Now further check the PCI header: Base Class (offset 0x0B) and\r
	415	// Sub Class (offset 0x0A). This controller should be an SATA controller\r
	416	//\r
	417	Status = PciDevice->PciIo.Pci.Read (\r
	418	&PciDevice->PciIo,\r
	419	EfiPciIoWidthUint8,\r
	420	PCI_CLASSCODE_OFFSET,\r
	421	sizeof (PciData.Hdr.ClassCode),\r
	422	PciData.Hdr.ClassCode\r
	423	);\r
	424	if (EFI_ERROR (Status)) {\r
	425	return EFI_UNSUPPORTED;\r
	426	}\r
	427	\r
	428	if (!IS_PCI_IDE (&PciData) && !IS_PCI_SATADPA (&PciData)) {\r
	429	return EFI_UNSUPPORTED;\r
	430	}\r
	431	\r
	432	Status = PciDevice->PciIo.Attributes (\r
	433	&PciDevice->PciIo,\r
434	EfiPciIoAttributeOperationSupported,\r
435	0,\r
436	&EnabledPciAttributes\r
437	);\r
438	if (EFI_ERROR (Status)) {\r
439	return EFI_UNSUPPORTED;\r
440	} else {\r
441	EnabledPciAttributes &= (UINT64)EFI_PCI_DEVICE_ENABLE;\r
442	Status = PciDevice->PciIo.Attributes (\r
443	&PciDevice->PciIo,\r
444	EfiPciIoAttributeOperationEnable,\r
445	EnabledPciAttributes,\r
446	NULL\r
447	);\r
448	if (EFI_ERROR (Status)) {\r
449	return EFI_UNSUPPORTED;\r
87bc3f19	450	}\r
a8f59e2e	451	}\r
87bc3f19	452	\r
a8f59e2e CM	453	Status = PciDevice->PciIo.Pci.Read (\r
	454	&PciDevice->PciIo,\r
	455	EfiPciIoWidthUint32,\r
	456	0x24,\r
	457	sizeof (UINTN),\r
	458	&MmioBase\r
	459	);\r
	460	if (EFI_ERROR (Status)) {\r
	461	return EFI_UNSUPPORTED;\r
	462	}\r
	463	\r
	464	DevicePathLength = GetDevicePathSize (PciDevice->DevicePath);\r
	465	DevicePath = PciDevice->DevicePath;\r
87bc3f19	466	\r
a8f59e2e CM	467	Status = AtaAhciInitPrivateData (MmioBase, DevicePath, DevicePathLength);\r
a8f59e2e CM	468	if (EFI_ERROR (Status)) {\r
87bc3f19	469	DEBUG ((\r
1436aea4	470	DEBUG_INFO,\r
a8f59e2e	471	"%a: Failed to init controller, with Status - %r\n",\r
1436aea4	472	__FUNCTION__,\r
a8f59e2e	473	Status\r
87bc3f19	474	));\r
87bc3f19 HW	475	}\r
	476	\r
	477	return EFI_SUCCESS;\r
	478	}\r
a8f59e2e CM	479	\r
	480	/**\r
	481	Callback for EDKII_PCI_DEVICE_PPI installation.\r
	482	\r
	483	@param[in] PeiServices Pointer to PEI Services Table.\r
	484	@param[in] NotifyDescriptor Pointer to the descriptor for the Notification\r
	485	event that caused this function to execute.\r
	486	@param[in] Ppi Pointer to the PPI data associated with this function.\r
	487	\r
	488	@retval EFI_SUCCESS The function completes successfully\r
	489	@retval Others Cannot initialize AHCI controller from given PCI_DEVICE_PPI\r
	490	\r
	491	**/\r
	492	EFI_STATUS\r
	493	EFIAPI\r
	494	AtaAhciPciDevicePpiInstallationCallback (\r
	495	IN EFI_PEI_SERVICES **PeiServices,\r
	496	IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor,\r
	497	IN VOID *Ppi\r
	498	)\r
	499	{\r
	500	EDKII_PCI_DEVICE_PPI *PciDevice;\r
	501	\r
	502	PciDevice = (EDKII_PCI_DEVICE_PPI *)Ppi;\r
	503	\r
	504	return AtaAhciInitPrivateDataFromPciDevice (PciDevice);\r
	505	}\r
	506	\r
	507	/**\r
	508	Entry point of the PEIM.\r
	509	\r
	510	@param[in] FileHandle Handle of the file being invoked.\r
	511	@param[in] PeiServices Describes the list of possible PEI Services.\r
	512	\r
	513	@retval EFI_SUCCESS PPI successfully installed.\r
	514	\r
	515	**/\r
	516	EFI_STATUS\r
	517	EFIAPI\r
	518	AtaAhciPeimEntry (\r
	519	IN EFI_PEI_FILE_HANDLE FileHandle,\r
	520	IN CONST EFI_PEI_SERVICES **PeiServices\r
	521	)\r
	522	{\r
	523	DEBUG ((DEBUG_INFO, "%a: Enters.\n", __FUNCTION__));\r
	524	\r
	525	PeiServicesNotifyPpi (&mAtaAhciHostControllerNotify);\r
	526	\r
	527	PeiServicesNotifyPpi (&mPciDevicePpiNotify);\r
	528	\r
	529	return EFI_SUCCESS;\r
	530	}\r