[PATCH 16/43] OvmfPkg/XenAcpiPlatformDxe: remove OVMF's built-in ACPI tables

["Laszlo Ersek" <lersek@redhat.com>]

Xen is an advanced hypervisor; no Xen guest can function correctly without
the hypervisor's dynamically provided ACPI tables. Remove the built-in
(fallback) tables from XenAcpiPlatformDxe -- and the OvmfXen platform.

Remove any dependencies from XenAcpiPlatformDxe that are no longer needed.

Cc: Anthony Perard <anthony.perard@citrix.com>
Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Jordan Justen <jordan.l.justen@intel.com>
Cc: Julien Grall <julien@xen.org>
Cc: Philippe Mathieu-Daudé <philmd@redhat.com>
Ref: https://bugzilla.tianocore.org/show_bug.cgi?id=2122
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
---
 OvmfPkg/OvmfXen.dsc                               |   1 -
 OvmfPkg/OvmfXen.fdf                               |   7 -
 OvmfPkg/XenAcpiPlatformDxe/XenAcpiPlatformDxe.inf |   2 -
 OvmfPkg/XenAcpiPlatformDxe/AcpiPlatform.c         | 202 --------------------
 4 files changed, 212 deletions(-)

diff --git a/OvmfPkg/OvmfXen.dsc b/OvmfPkg/OvmfXen.dsc
index 4d5171cd43c1..bcf64242d05c 100644
--- a/OvmfPkg/OvmfXen.dsc
+++ b/OvmfPkg/OvmfXen.dsc
@@ -650,13 +650,12 @@ [Components]
 
   #
   # ACPI Support
   #
   MdeModulePkg/Universal/Acpi/AcpiTableDxe/AcpiTableDxe.inf
   OvmfPkg/XenAcpiPlatformDxe/XenAcpiPlatformDxe.inf
-  OvmfPkg/AcpiTables/AcpiTables.inf
   MdeModulePkg/Universal/Acpi/S3SaveStateDxe/S3SaveStateDxe.inf
   MdeModulePkg/Universal/Acpi/BootScriptExecutorDxe/BootScriptExecutorDxe.inf
   MdeModulePkg/Universal/Acpi/BootGraphicsResourceTableDxe/BootGraphicsResourceTableDxe.inf
 
   #
   # Network Support
diff --git a/OvmfPkg/OvmfXen.fdf b/OvmfPkg/OvmfXen.fdf
index 85306245b50f..8daa000de46a 100644
--- a/OvmfPkg/OvmfXen.fdf
+++ b/OvmfPkg/OvmfXen.fdf
@@ -350,13 +350,12 @@ [FV.DXEFV]
 
 INF  MdeModulePkg/Universal/SmbiosDxe/SmbiosDxe.inf
 INF  OvmfPkg/SmbiosPlatformDxe/SmbiosPlatformDxe.inf
 
 INF  MdeModulePkg/Universal/Acpi/AcpiTableDxe/AcpiTableDxe.inf
 INF  OvmfPkg/XenAcpiPlatformDxe/XenAcpiPlatformDxe.inf
-INF  RuleOverride=ACPITABLE OvmfPkg/AcpiTables/AcpiTables.inf
 INF  MdeModulePkg/Universal/Acpi/S3SaveStateDxe/S3SaveStateDxe.inf
 INF  MdeModulePkg/Universal/Acpi/BootScriptExecutorDxe/BootScriptExecutorDxe.inf
 INF  MdeModulePkg/Universal/Acpi/BootGraphicsResourceTableDxe/BootGraphicsResourceTableDxe.inf
 
 INF  FatPkg/EnhancedFatDxe/Fat.inf
 INF  MdeModulePkg/Universal/Disk/UdfDxe/UdfDxe.inf
@@ -521,18 +520,12 @@ [Rule.Common.UEFI_APPLICATION.BINARY]
   FILE APPLICATION = $(NAMED_GUID) {
     PE32      PE32                    |.efi
     UI        STRING="$(MODULE_NAME)" Optional
     VERSION   STRING="$(INF_VERSION)" Optional BUILD_NUM=$(BUILD_NUMBER)
   }
 
-[Rule.Common.USER_DEFINED.ACPITABLE]
-  FILE FREEFORM = $(NAMED_GUID) {
-    RAW ACPI               |.acpi
-    RAW ASL                |.aml
-  }
-
 [Rule.Common.USER_DEFINED.CSM]
   FILE FREEFORM = $(NAMED_GUID) {
     RAW BIN                |.bin
   }
 
 [Rule.Common.SEC.RESET_VECTOR]
diff --git a/OvmfPkg/XenAcpiPlatformDxe/XenAcpiPlatformDxe.inf b/OvmfPkg/XenAcpiPlatformDxe/XenAcpiPlatformDxe.inf
index ca8e7e55f788..db9b6e093de4 100644
--- a/OvmfPkg/XenAcpiPlatformDxe/XenAcpiPlatformDxe.inf
+++ b/OvmfPkg/XenAcpiPlatformDxe/XenAcpiPlatformDxe.inf
@@ -39,17 +39,15 @@ [LibraryClasses]
   UefiBootServicesTableLib
   UefiDriverEntryPoint
   XenPlatformLib
 
 [Protocols]
   gEfiAcpiTableProtocolGuid                     # PROTOCOL ALWAYS_CONSUMED
-  gEfiFirmwareVolume2ProtocolGuid               # PROTOCOL SOMETIMES_CONSUMED
 
 [Guids]
   gRootBridgesConnectedEventGroupGuid
 
 [Pcd]
-  gEfiMdeModulePkgTokenSpaceGuid.PcdAcpiTableStorageFile
   gEfiMdeModulePkgTokenSpaceGuid.PcdPciDisableBusEnumeration
 
 [Depex]
   gEfiAcpiTableProtocolGuid
diff --git a/OvmfPkg/XenAcpiPlatformDxe/AcpiPlatform.c b/OvmfPkg/XenAcpiPlatformDxe/AcpiPlatform.c
index daf2bf3f458a..60576f3cc6d6 100644
--- a/OvmfPkg/XenAcpiPlatformDxe/AcpiPlatform.c
+++ b/OvmfPkg/XenAcpiPlatformDxe/AcpiPlatform.c
@@ -4,214 +4,16 @@
   Copyright (C) 2021, Red Hat, Inc.
   Copyright (c) 2008 - 2012, Intel Corporation. All rights reserved.<BR>
   SPDX-License-Identifier: BSD-2-Clause-Patent
 
 **/
 
-#include <Library/DebugLib.h>                 // ASSERT_EFI_ERROR()
-#include <Library/UefiBootServicesTableLib.h> // gBS
 #include <Library/XenPlatformLib.h>           // XenDetected()
-#include <Protocol/FirmwareVolume2.h>         // gEfiFirmwareVolume2Protocol...
 
 #include "AcpiPlatform.h"
 
-/**
-  Locate the first instance of a protocol.  If the protocol requested is an
-  FV protocol, then it will return the first FV that contains the ACPI table
-  storage file.
-
-  @param  Instance      Return pointer to the first instance of the protocol
-
-  @return EFI_SUCCESS           The function completed successfully.
-  @return EFI_NOT_FOUND         The protocol could not be located.
-  @return EFI_OUT_OF_RESOURCES  There are not enough resources to find the protocol.
-
-**/
-EFI_STATUS
-LocateFvInstanceWithTables (
-  OUT EFI_FIRMWARE_VOLUME2_PROTOCOL **Instance
-  )
-{
-  EFI_STATUS                    Status;
-  EFI_HANDLE                    *HandleBuffer;
-  UINTN                         NumberOfHandles;
-  EFI_FV_FILETYPE               FileType;
-  UINT32                        FvStatus;
-  EFI_FV_FILE_ATTRIBUTES        Attributes;
-  UINTN                         Size;
-  UINTN                         Index;
-  EFI_FIRMWARE_VOLUME2_PROTOCOL *FvInstance;
-
-  FvStatus = 0;
-
-  //
-  // Locate protocol.
-  //
-  Status = gBS->LocateHandleBuffer (
-                   ByProtocol,
-                   &gEfiFirmwareVolume2ProtocolGuid,
-                   NULL,
-                   &NumberOfHandles,
-                   &HandleBuffer
-                   );
-  if (EFI_ERROR (Status)) {
-    //
-    // Defined errors at this time are not found and out of resources.
-    //
-    return Status;
-  }
-
-  //
-  // Looking for FV with ACPI storage file
-  //
-  for (Index = 0; Index < NumberOfHandles; Index++) {
-    //
-    // Get the protocol on this handle
-    // This should not fail because of LocateHandleBuffer
-    //
-    Status = gBS->HandleProtocol (
-                     HandleBuffer[Index],
-                     &gEfiFirmwareVolume2ProtocolGuid,
-                     (VOID**) &FvInstance
-                     );
-    ASSERT_EFI_ERROR (Status);
-
-    //
-    // See if it has the ACPI storage file
-    //
-    Status = FvInstance->ReadFile (
-                           FvInstance,
-                           (EFI_GUID*)PcdGetPtr (PcdAcpiTableStorageFile),
-                           NULL,
-                           &Size,
-                           &FileType,
-                           &Attributes,
-                           &FvStatus
-                           );
-
-    //
-    // If we found it, then we are done
-    //
-    if (Status == EFI_SUCCESS) {
-      *Instance = FvInstance;
-      break;
-    }
-  }
-
-  //
-  // Our exit status is determined by the success of the previous operations
-  // If the protocol was found, Instance already points to it.
-  //
-
-  //
-  // Free any allocated buffers
-  //
-  gBS->FreePool (HandleBuffer);
-
-  return Status;
-}
-
-
-/**
-  Find ACPI tables in an FV and install them.
-
-  This is now a fall-back path. Normally, we will search for tables provided
-  by the VMM first.
-
-  If that fails, we use this function to load the ACPI tables from an FV. The
-  sources for the FV based tables is located under OvmfPkg/AcpiTables.
-
-  @param  AcpiTable     Protocol instance pointer
-
-**/
-EFI_STATUS
-EFIAPI
-InstallOvmfFvTables (
-  IN  EFI_ACPI_TABLE_PROTOCOL     *AcpiTable
-  )
-{
-  EFI_STATUS                           Status;
-  EFI_FIRMWARE_VOLUME2_PROTOCOL        *FwVol;
-  INTN                                 Instance;
-  EFI_ACPI_COMMON_HEADER               *CurrentTable;
-  UINTN                                TableHandle;
-  UINT32                               FvStatus;
-  UINTN                                TableSize;
-  UINTN                                Size;
-
-  Instance     = 0;
-  CurrentTable = NULL;
-  TableHandle  = 0;
-
-  //
-  // set FwVol (and use an ASSERT() below) to suppress incorrect
-  // compiler/analyzer warnings
-  //
-  FwVol = NULL;
-  //
-  // Locate the firmware volume protocol
-  //
-  Status = LocateFvInstanceWithTables (&FwVol);
-  if (EFI_ERROR (Status)) {
-    return EFI_ABORTED;
-  }
-  ASSERT (FwVol != NULL);
-
-  //
-  // Read tables from the storage file.
-  //
-  while (Status == EFI_SUCCESS) {
-
-    Status = FwVol->ReadSection (
-                      FwVol,
-                      (EFI_GUID*)PcdGetPtr (PcdAcpiTableStorageFile),
-                      EFI_SECTION_RAW,
-                      Instance,
-                      (VOID**) &CurrentTable,
-                      &Size,
-                      &FvStatus
-                      );
-    if (!EFI_ERROR (Status)) {
-      //
-      // Add the table
-      //
-      TableHandle = 0;
-
-      TableSize = ((EFI_ACPI_DESCRIPTION_HEADER *) CurrentTable)->Length;
-      ASSERT (Size >= TableSize);
-
-      //
-      // Install ACPI table
-      //
-      Status = AcpiTable->InstallAcpiTable (
-                            AcpiTable,
-                            CurrentTable,
-                            TableSize,
-                            &TableHandle
-                            );
-
-      //
-      // Free memory allocated by ReadSection
-      //
-      gBS->FreePool (CurrentTable);
-
-      if (EFI_ERROR (Status)) {
-        return EFI_ABORTED;
-      }
-
-      //
-      // Increment the instance
-      //
-      Instance++;
-      CurrentTable = NULL;
-    }
-  }
-
-  return EFI_SUCCESS;
-}
-
 /**
   Effective entrypoint of Acpi Platform driver.
 
   @param  ImageHandle
   @param  SystemTable
 
@@ -231,13 +33,9 @@ InstallAcpiTables (
   if (XenDetected ()) {
     Status = InstallXenTables (AcpiTable);
   } else {
     Status = EFI_UNSUPPORTED;
   }
 
-  if (EFI_ERROR (Status)) {
-    Status = InstallOvmfFvTables (AcpiTable);
-  }
-
   return Status;
 }
 
-- 
2.19.1.3.g30247aa5d201