MdeModulePkg: Replace BSD License with BSD+Patent License

[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
\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  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
\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
/**\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
  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
  EFI_STATUS                            Status;\r
  EFI_BOOT_MODE                         BootMode;\r
  EDKII_ATA_AHCI_HOST_CONTROLLER_PPI    *AhciHcPpi;\r
  UINT8                                 Controller;\r
  UINTN                                 MmioBase;\r
  UINTN                                 DevicePathLength;\r
  EFI_DEVICE_PATH_PROTOCOL              *DevicePath;\r
  UINT32                                PortBitMap;\r
  PEI_AHCI_CONTROLLER_PRIVATE_DATA      *Private;\r
  UINT8                                 NumberOfPorts;\r
\r
  DEBUG ((DEBUG_INFO, "%a: Enters.\n", __FUNCTION__));\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
  // Locate the ATA AHCI host controller PPI.\r
  //\r
  Status = PeiServicesLocatePpi (\r
             &gEdkiiPeiAtaAhciHostControllerPpiGuid,\r
             0,\r
             NULL,\r
             (VOID **) &AhciHcPpi\r
             );\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "%a: Failed to locate AtaAhciHostControllerPpi.\n", __FUNCTION__));\r
    return EFI_UNSUPPORTED;\r
  }\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, "%a: Fail to allocate get the device path for Controller %d.\n",\r
        __FUNCTION__, Controller\r
        ));\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, "%a: The device path is invalid for Controller %d.\n",\r
        __FUNCTION__, Controller\r
        ));\r
      Controller++;\r
      continue;\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
        //\r
        // No ports need to be enumerated for this controller.\r
        //\r
        Controller++;\r
        continue;\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, "%a: Fail to allocate private data for Controller %d.\n",\r
        __FUNCTION__, Controller\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
      DEBUG ((\r
        DEBUG_ERROR,\r
        "%a: Controller initialization fail for Controller %d with Status - %r.\n",\r
        __FUNCTION__,\r
        Controller,\r
        Status\r
        ));\r
      Controller++;\r
      continue;\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
    if (Private->TrustComputingDevices != 0) {\r
      DEBUG ((\r
        DEBUG_INFO,\r
        "%a: Security Security Command PPI will be produced for Controller %d.\n",\r
        __FUNCTION__, Controller\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
    DEBUG ((\r
      DEBUG_INFO, "%a: Controller %d has been successfully initialized.\n",\r
      __FUNCTION__, Controller\r
      ));\r
    Controller++;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r