OvmfPkg/AcpiPlatformDxe: Return error if installing NotifyProtocol failed

[mirror_edk2.git] / OvmfPkg / AcpiPlatformDxe / CloudHvAcpi.c

/** @file\r
  OVMF ACPI Cloud Hypervisor support\r
\r
  Copyright (c) 2021, Intel Corporation. All rights reserved.\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <IndustryStandard/Acpi.h>                        // EFI_ACPI_DESCRIPTION_HEADER\r
#include <IndustryStandard/CloudHv.h>                     // CLOUDHV_RSDP_ADDRESS\r
#include <IndustryStandard/Xen/arch-x86/hvm/start_info.h> // hvm_start_info\r
#include <Library/BaseLib.h>                              // CpuDeadLoop()\r
#include <Library/DebugLib.h>                             // DEBUG()\r
#include <Library/PcdLib.h>                               // PcdGet32()\r
#include <Library/HobLib.h>                               // GetFirstGuidHob(), GetNextGuidHob()\r
#include <Library/UefiBootServicesTableLib.h>             // gBS\r
#include <Protocol/AcpiSystemDescriptionTable.h>\r
#include <Protocol/AcpiTable.h>\r
\r
#include "AcpiPlatform.h"\r
\r
EFI_STATUS\r
EFIAPI\r
InstallCloudHvTablesTdx (\r
  IN   EFI_ACPI_TABLE_PROTOCOL  *AcpiProtocol\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       TableHandle;\r
  EFI_HANDLE  ChAcpiHandle;\r
\r
  EFI_PEI_HOB_POINTERS         Hob;\r
  EFI_ACPI_DESCRIPTION_HEADER  *CurrentTable;\r
  EFI_ACPI_DESCRIPTION_HEADER  *DsdtTable;\r
\r
  DsdtTable   = NULL;\r
  TableHandle = 0;\r
\r
  Hob.Guid = (EFI_HOB_GUID_TYPE *)GetFirstGuidHob (&gUefiOvmfPkgTdxAcpiHobGuid);\r
\r
  while (Hob.Guid != NULL) {\r
    CurrentTable = (EFI_ACPI_DESCRIPTION_HEADER *)(&Hob.Guid->Name + 1);\r
    if (!AsciiStrnCmp ((CHAR8 *)&CurrentTable->Signature, "DSDT", 4)) {\r
      DsdtTable = CurrentTable;\r
    } else {\r
      //\r
      // Install the tables\r
      //\r
      Status = AcpiProtocol->InstallAcpiTable (\r
                               AcpiProtocol,\r
                               CurrentTable,\r
                               CurrentTable->Length,\r
                               &TableHandle\r
                               );\r
      for (UINTN i = 0; i < CurrentTable->Length; i++) {\r
        DEBUG ((DEBUG_INFO, " %x", *((UINT8 *)CurrentTable + i)));\r
      }\r
\r
      DEBUG ((DEBUG_INFO, "\n"));\r
    }\r
\r
    Hob.Raw  = GET_NEXT_HOB (Hob.Raw);\r
    Hob.Guid = (EFI_HOB_GUID_TYPE *)GetNextGuidHob (&gUefiOvmfPkgTdxAcpiHobGuid, Hob.Raw);\r
  }\r
\r
  //\r
  // Install DSDT table. If we reached this point without finding the DSDT,\r
  // then we're out of sync with the hypervisor, and cannot continue.\r
  //\r
  if (DsdtTable == NULL) {\r
    DEBUG ((DEBUG_INFO, "%a: no DSDT found\n", __FUNCTION__));\r
    ASSERT (FALSE);\r
  }\r
\r
  Status = AcpiProtocol->InstallAcpiTable (\r
                           AcpiProtocol,\r
                           DsdtTable,\r
                           DsdtTable->Length,\r
                           &TableHandle\r
                           );\r
  if (EFI_ERROR (Status)) {\r
    ASSERT_EFI_ERROR (Status);\r
    return Status;\r
  }\r
\r
  //\r
  // Install a protocol to notify that the ACPI table provided by CH is\r
  // ready.\r
  //\r
  ChAcpiHandle = NULL;\r
  Status       = gBS->InstallProtocolInterface (\r
                        &ChAcpiHandle,\r
                        &gQemuAcpiTableNotifyProtocolGuid,\r
                        EFI_NATIVE_INTERFACE,\r
                        NULL\r
                        );\r
  if (EFI_ERROR (Status)) {\r
    ASSERT_EFI_ERROR (Status);\r
    return Status;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
// Get the ACPI tables from EBDA start\r
EFI_STATUS\r
EFIAPI\r
InstallCloudHvTables (\r
  IN   EFI_ACPI_TABLE_PROTOCOL  *AcpiProtocol\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       TableHandle;\r
\r
  EFI_ACPI_DESCRIPTION_HEADER                   *Xsdt;\r
  VOID                                          *CurrentTableEntry;\r
  UINTN                                         CurrentTablePointer;\r
  EFI_ACPI_DESCRIPTION_HEADER                   *CurrentTable;\r
  UINTN                                         Index;\r
  UINTN                                         NumberOfTableEntries;\r
  EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE     *Fadt2Table;\r
  EFI_ACPI_DESCRIPTION_HEADER                   *DsdtTable;\r
  EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER  *AcpiRsdpStructurePtr;\r
  UINT32                                        *PVHResetVectorData;\r
  struct hvm_start_info                         *pvh_start_info;\r
\r
  Fadt2Table           = NULL;\r
  DsdtTable            = NULL;\r
  TableHandle          = 0;\r
  NumberOfTableEntries = 0;\r
  AcpiRsdpStructurePtr = NULL;\r
  PVHResetVectorData   = NULL;\r
  pvh_start_info       = NULL;\r
\r
  PVHResetVectorData = (VOID *)(UINTN)PcdGet32 (PcdXenPvhStartOfDayStructPtr);\r
  if (PVHResetVectorData == 0) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  pvh_start_info       = (struct hvm_start_info *)(UINTN)PVHResetVectorData[0];\r
  AcpiRsdpStructurePtr = (EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER *)(UINTN)pvh_start_info->rsdp_paddr;\r
\r
  // If XSDT table is found, just install its tables.\r
  // Otherwise, try to find and install the RSDT tables.\r
  //\r
  if (AcpiRsdpStructurePtr->XsdtAddress) {\r
    //\r
    // Retrieve the addresses of XSDT and\r
    // calculate the number of its table entries.\r
    //\r
    Xsdt = (EFI_ACPI_DESCRIPTION_HEADER *)(UINTN)\r
           AcpiRsdpStructurePtr->XsdtAddress;\r
    NumberOfTableEntries = (Xsdt->Length -\r
                            sizeof (EFI_ACPI_DESCRIPTION_HEADER)) /\r
                           sizeof (UINT64);\r
\r
    //\r
    // Install ACPI tables found in XSDT.\r
    //\r
    for (Index = 0; Index < NumberOfTableEntries; Index++) {\r
      //\r
      // Get the table entry from XSDT\r
      //\r
      CurrentTableEntry = (VOID *)((UINT8 *)Xsdt +\r
                                   sizeof (EFI_ACPI_DESCRIPTION_HEADER) +\r
                                   Index * sizeof (UINT64));\r
      CurrentTablePointer = (UINTN)*(UINT64 *)CurrentTableEntry;\r
      CurrentTable        = (EFI_ACPI_DESCRIPTION_HEADER *)CurrentTablePointer;\r
\r
      //\r
      // Install the XSDT tables\r
      //\r
      Status = AcpiProtocol->InstallAcpiTable (\r
                               AcpiProtocol,\r
                               CurrentTable,\r
                               CurrentTable->Length,\r
                               &TableHandle\r
                               );\r
\r
      if (EFI_ERROR (Status)) {\r
        ASSERT_EFI_ERROR (Status);\r
        return Status;\r
      }\r
\r
      //\r
      // Get the X-DSDT table address from the table FADT\r
      //\r
      if (!AsciiStrnCmp ((CHAR8 *)&CurrentTable->Signature, "FACP", 4)) {\r
        Fadt2Table = (EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE *)\r
                     (UINTN)CurrentTablePointer;\r
        DsdtTable = (EFI_ACPI_DESCRIPTION_HEADER *)(UINTN)Fadt2Table->XDsdt;\r
      }\r
    }\r
  } else {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // Install DSDT table. If we reached this point without finding the DSDT,\r
  // then we're out of sync with the hypervisor, and cannot continue.\r
  //\r
  if (DsdtTable == NULL) {\r
    DEBUG ((DEBUG_ERROR, "%a: no DSDT found\n", __FUNCTION__));\r
    ASSERT (FALSE);\r
    CpuDeadLoop ();\r
  }\r
\r
  Status = AcpiProtocol->InstallAcpiTable (\r
                           AcpiProtocol,\r
                           DsdtTable,\r
                           DsdtTable->Length,\r
                           &TableHandle\r
                           );\r
  if (EFI_ERROR (Status)) {\r
    ASSERT_EFI_ERROR (Status);\r
    return Status;\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r