ArmVirtPkg: Install Acpi tables for Cloud Hypervisor

[mirror_edk2.git] / ArmVirtPkg / CloudHvAcpiPlatformDxe / CloudHvAcpi.c

/** @file\r
  Install Acpi tables for Cloud Hypervisor\r
\r
  Copyright (c) 2021, Arm Limited. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
**/\r
\r
#include <Library/BaseLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <IndustryStandard/Acpi63.h>\r
#include <Protocol/AcpiTable.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/DebugLib.h>\r
\r
/**\r
   Find Acpi table Protocol and return it\r
\r
   @return AcpiTable  Protocol, which is used to handle Acpi Table, on SUCCESS or NULL on FAILURE.\r
\r
**/\r
STATIC\r
EFI_ACPI_TABLE_PROTOCOL *\r
FindAcpiTableProtocol (\r
  VOID\r
  )\r
{\r
  EFI_STATUS              Status;\r
  EFI_ACPI_TABLE_PROTOCOL *AcpiTable;\r
\r
  Status = gBS->LocateProtocol (\r
                  &gEfiAcpiTableProtocolGuid,\r
                  NULL,\r
                  (VOID**)&AcpiTable\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
  return AcpiTable;\r
}\r
\r
/** Install Acpi tables for Cloud Hypervisor\r
\r
  @param [in]  AcpiProtocol  Acpi Protocol which is used to install Acpi tables\r
\r
  @return EFI_SUCCESS            The table was successfully inserted.\r
  @return EFI_INVALID_PARAMETER  Either AcpiProtocol, AcpiTablePtr or DsdtPtr is NULL\r
                                 and the size field embedded in the ACPI table pointed\r
                                 by AcpiTablePtr or DsdtPtr are not in sync.\r
  @return EFI_OUT_OF_RESOURCES   Insufficient resources exist to complete the request.\r
  @return EFI_NOT_FOUND          DSDT table not found.\r
**/\r
EFI_STATUS\r
EFIAPI\r
InstallCloudHvAcpiTables (\r
  IN     EFI_ACPI_TABLE_PROTOCOL       *AcpiProtocol\r
  )\r
{\r
  UINTN          InstalledKey;\r
  UINTN          TableSize;\r
  UINTN          AcpiTableLength;\r
  UINT64         RsdpPtr;\r
  UINT64         XsdtPtr;\r
  UINT64         TableOffset;\r
  UINT64         AcpiTablePtr;\r
  UINT64         *DsdtPtr;\r
  EFI_STATUS     Status;\r
\r
  if (AcpiProtocol == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  RsdpPtr = PcdGet64 (PcdCloudHvAcpiRsdpBaseAddress);\r
  XsdtPtr = ((EFI_ACPI_6_3_ROOT_SYSTEM_DESCRIPTION_POINTER *)RsdpPtr)->XsdtAddress;\r
  AcpiTableLength = ((EFI_ACPI_COMMON_HEADER *)XsdtPtr)->Length;\r
  TableOffset = sizeof (EFI_ACPI_DESCRIPTION_HEADER);\r
  DsdtPtr = NULL;\r
\r
  while (TableOffset < AcpiTableLength) {\r
    AcpiTablePtr = *(UINT64 *)(XsdtPtr + TableOffset);\r
    TableSize = ((EFI_ACPI_COMMON_HEADER *)AcpiTablePtr)->Length;\r
\r
    //\r
    // Install ACPI tables from XSDT\r
    //\r
    Status = AcpiProtocol->InstallAcpiTable (\r
                             AcpiProtocol,\r
                             (VOID *)AcpiTablePtr,\r
                             TableSize,\r
                             &InstalledKey\r
                             );\r
    if (EFI_ERROR (Status)) {\r
        return Status;\r
    }\r
\r
    //\r
    // Get DSDT from FADT\r
    //\r
    if ((DsdtPtr == NULL) &&\r
        (EFI_ACPI_6_3_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE ==\r
         ((EFI_ACPI_COMMON_HEADER *)AcpiTablePtr)->Signature)) {\r
      DsdtPtr = (UINT64 *)((EFI_ACPI_6_3_FIXED_ACPI_DESCRIPTION_TABLE *)AcpiTablePtr)->XDsdt;\r
    }\r
\r
    TableOffset += sizeof (UINT64);\r
  } // while\r
\r
  if (DsdtPtr == NULL) {\r
    DEBUG ((DEBUG_ERROR, "%a: no DSDT found\n", __FUNCTION__));\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // Install DSDT table\r
  //\r
  TableSize = ((EFI_ACPI_COMMON_HEADER *)DsdtPtr)->Length;\r
  Status = AcpiProtocol->InstallAcpiTable (\r
                           AcpiProtocol,\r
                           DsdtPtr,\r
                           TableSize,\r
                           &InstalledKey\r
                           );\r
\r
  return Status;\r
}\r
\r
/** Entry point for Cloud Hypervisor Platform Dxe\r
\r
  @param [in]  ImageHandle  Handle for this image.\r
  @param [in]  SystemTable  Pointer to the EFI system table.\r
\r
  @return EFI_SUCCESS            The table was successfully inserted.\r
  @return EFI_INVALID_PARAMETER  Either AcpiProtocol, AcpiTablePtr or DsdtPtr is NULL\r
                                 and the size field embedded in the ACPI table pointed to\r
                                 by AcpiTablePtr or DsdtPtr are not in sync.\r
  @return EFI_OUT_OF_RESOURCES   Insufficient resources exist to complete the request.\r
  @return EFI_NOT_FOUND          DSDT table not found\r
**/\r
EFI_STATUS\r
EFIAPI\r
CloudHvAcpiPlatformEntryPoint (\r
  IN EFI_HANDLE         ImageHandle,\r
  IN EFI_SYSTEM_TABLE   *SystemTable\r
  )\r
{\r
  EFI_STATUS                         Status;\r
\r
  Status = InstallCloudHvAcpiTables (FindAcpiTableProtocol ());\r
\r
  if (EFI_ERROR (Status)) {\r
     DEBUG ((\r
       DEBUG_ERROR,\r
       "%a: Fail to install Acpi table: %r\n",\r
       __FUNCTION__,\r
       Status\r
       ));\r
     CpuDeadLoop ();\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r