OvmfPkg/AcpiPlatformDxe: consolidate #includes and [LibraryClasses]

- #include only such public headers in "AcpiPlatform.h" that are required
  by the function declarations and type definitions introduced in
  "AcpiPlatform.h". Don't use "AcpiPlatform.h" as a convenience #include
  file.

- In every file, list every necessary public #include individually, with
  an example identifier that's actually consumed.

- Remove unnecessary lib classes, add unlisted lib classes.

- Remove unnecessary #include directives, add unlisted #include
  directives.

Cc: Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Jordan Justen <jordan.l.justen@intel.com>
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>
Message-Id: <20210526201446.12554-11-lersek@redhat.com>
Reviewed-by: Ard Biesheuvel <ardb@kernel.org>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>

10 files changed, 41 insertions, 33 deletions

diff --git a/OvmfPkg/AcpiPlatformDxe/AcpiPlatform.c b/OvmfPkg/AcpiPlatformDxe/AcpiPlatform.c
index f872d91aea..efbbfab89d 100644
--- a/OvmfPkg/AcpiPlatformDxe/AcpiPlatform.c
+++ b/OvmfPkg/AcpiPlatformDxe/AcpiPlatform.c
@@ -6,6 +6,11 @@
 

 **/

 

+#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"

 

 EFI_STATUS

diff --git a/OvmfPkg/AcpiPlatformDxe/AcpiPlatform.h b/OvmfPkg/AcpiPlatformDxe/AcpiPlatform.h
index 511a30782f..d98b79baab 100644
--- a/OvmfPkg/AcpiPlatformDxe/AcpiPlatform.h
+++ b/OvmfPkg/AcpiPlatformDxe/AcpiPlatform.h
@@ -9,16 +9,8 @@
 #ifndef ACPI_PLATFORM_H_

 #define ACPI_PLATFORM_H_

 

-#include <IndustryStandard/Acpi.h>

-#include <Library/BaseLib.h>

-#include <Library/DebugLib.h>

-#include <Library/PcdLib.h>

-#include <Library/UefiBootServicesTableLib.h>

-#include <Library/XenPlatformLib.h>

-#include <PiDxe.h>

-#include <Protocol/AcpiTable.h>

-#include <Protocol/FirmwareVolume2.h>

-#include <Protocol/PciIo.h>

+#include <Protocol/AcpiTable.h> // EFI_ACPI_TABLE_PROTOCOL

+#include <Protocol/PciIo.h>     // EFI_PCI_IO_PROTOCOL

 

 typedef struct {

   EFI_PCI_IO_PROTOCOL *PciIo;

diff --git a/OvmfPkg/AcpiPlatformDxe/AcpiPlatformDxe.inf b/OvmfPkg/AcpiPlatformDxe/AcpiPlatformDxe.inf
index 3daeb2ee42..77607298cb 100644
--- a/OvmfPkg/AcpiPlatformDxe/AcpiPlatformDxe.inf
+++ b/OvmfPkg/AcpiPlatformDxe/AcpiPlatformDxe.inf
@@ -48,7 +48,6 @@
   QemuFwCfgS3Lib

   UefiBootServicesTableLib

   UefiDriverEntryPoint

-  UefiLib

   XenPlatformLib

 

 [Protocols]

diff --git a/OvmfPkg/AcpiPlatformDxe/BootScript.c b/OvmfPkg/AcpiPlatformDxe/BootScript.c
index 7b1b9586da..f2d1089e91 100644
--- a/OvmfPkg/AcpiPlatformDxe/BootScript.c
+++ b/OvmfPkg/AcpiPlatformDxe/BootScript.c
@@ -7,9 +7,10 @@
   SPDX-License-Identifier: BSD-2-Clause-Patent

 **/

 

-#include <Library/MemoryAllocationLib.h>

-#include <Library/QemuFwCfgLib.h>

-#include <Library/QemuFwCfgS3Lib.h>

+#include <Library/BaseLib.h>             // CpuDeadLoop()

+#include <Library/DebugLib.h>            // DEBUG()

+#include <Library/MemoryAllocationLib.h> // AllocatePool()

+#include <Library/QemuFwCfgS3Lib.h>      // QemuFwCfgS3ScriptSkipBytes()

 

 #include "AcpiPlatform.h"

 

diff --git a/OvmfPkg/AcpiPlatformDxe/EntryPoint.c b/OvmfPkg/AcpiPlatformDxe/EntryPoint.c
index fb07ed8537..bb5fe82c18 100644
--- a/OvmfPkg/AcpiPlatformDxe/EntryPoint.c
+++ b/OvmfPkg/AcpiPlatformDxe/EntryPoint.c
@@ -7,7 +7,11 @@
   SPDX-License-Identifier: BSD-2-Clause-Patent

 **/

 

-#include <Guid/RootBridgesConnectedEventGroup.h>

+#include <Guid/RootBridgesConnectedEventGroup.h> // gRootBridgesConnectedEve...

+#include <Library/DebugLib.h>                    // DEBUG()

+#include <Library/PcdLib.h>                      // PcdGetBool()

+#include <Library/UefiBootServicesTableLib.h>    // gBS

+#include <Protocol/AcpiTable.h>                  // EFI_ACPI_TABLE_PROTOCOL

 

 #include "AcpiPlatform.h"

 

diff --git a/OvmfPkg/AcpiPlatformDxe/PciDecoding.c b/OvmfPkg/AcpiPlatformDxe/PciDecoding.c
index 73894106c9..6ba4c936ad 100644
--- a/OvmfPkg/AcpiPlatformDxe/PciDecoding.c
+++ b/OvmfPkg/AcpiPlatformDxe/PciDecoding.c
@@ -7,7 +7,9 @@
   SPDX-License-Identifier: BSD-2-Clause-Patent

 **/

 

-#include <Library/MemoryAllocationLib.h>

+#include <Library/DebugLib.h>                  // DEBUG()

+#include <Library/MemoryAllocationLib.h>       // AllocatePool()

+#include <Library/UefiBootServicesTableLib.h>  // gBS

 

 #include "AcpiPlatform.h"

 

diff --git a/OvmfPkg/AcpiPlatformDxe/Qemu.c b/OvmfPkg/AcpiPlatformDxe/Qemu.c
index bed3b16159..bdcc46b718 100644
--- a/OvmfPkg/AcpiPlatformDxe/Qemu.c
+++ b/OvmfPkg/AcpiPlatformDxe/Qemu.c
@@ -9,13 +9,13 @@
 

 **/

 

-#include <IndustryStandard/Acpi.h>

-#include <Library/BaseMemoryLib.h>

-#include <Library/DxeServicesTableLib.h>

-#include <Library/MemoryAllocationLib.h>

-#include <Library/OrderedCollectionLib.h>

-#include <Library/PcdLib.h>

-#include <Library/QemuFwCfgLib.h>

+#include <IndustryStandard/Acpi.h>        // EFI_ACPI_1_0_IO_APIC_STRUCTURE

+#include <Library/BaseMemoryLib.h>        // CopyMem()

+#include <Library/DebugLib.h>             // DEBUG()

+#include <Library/DxeServicesTableLib.h>  // gDS

+#include <Library/MemoryAllocationLib.h>  // AllocatePool()

+#include <Library/PcdLib.h>               // PcdGet16()

+#include <Library/QemuFwCfgLib.h>         // QemuFwCfgIsAvailable()

 

 #include "AcpiPlatform.h"

 

diff --git a/OvmfPkg/AcpiPlatformDxe/QemuFwCfgAcpi.c b/OvmfPkg/AcpiPlatformDxe/QemuFwCfgAcpi.c
index 621e69410d..df800b1492 100644
--- a/OvmfPkg/AcpiPlatformDxe/QemuFwCfgAcpi.c
+++ b/OvmfPkg/AcpiPlatformDxe/QemuFwCfgAcpi.c
@@ -8,15 +8,16 @@
 

 **/

 

-#include <IndustryStandard/Acpi.h>

-#include <IndustryStandard/QemuLoader.h>

-#include <Library/BaseMemoryLib.h>

-#include <Library/DxeServicesTableLib.h>

-#include <Library/MemoryAllocationLib.h>

-#include <Library/OrderedCollectionLib.h>

-#include <Library/PcdLib.h>

-#include <Library/QemuFwCfgLib.h>

-#include <Library/QemuFwCfgS3Lib.h>

+#include <IndustryStandard/Acpi.h>            // EFI_ACPI_DESCRIPTION_HEADER

+#include <IndustryStandard/QemuLoader.h>      // QEMU_LOADER_FNAME_SIZE

+#include <Library/BaseLib.h>                  // AsciiStrCmp()

+#include <Library/BaseMemoryLib.h>            // CopyMem()

+#include <Library/DebugLib.h>                 // DEBUG()

+#include <Library/MemoryAllocationLib.h>      // AllocatePool()

+#include <Library/OrderedCollectionLib.h>     // OrderedCollectionMin()

+#include <Library/QemuFwCfgLib.h>             // QemuFwCfgFindFile()

+#include <Library/QemuFwCfgS3Lib.h>           // QemuFwCfgS3Enabled()

+#include <Library/UefiBootServicesTableLib.h> // gBS

 

 #include "AcpiPlatform.h"

 

diff --git a/OvmfPkg/AcpiPlatformDxe/QemuFwCfgAcpiPlatformDxe.inf b/OvmfPkg/AcpiPlatformDxe/QemuFwCfgAcpiPlatformDxe.inf
index 48c8269a8b..dac25d1505 100644
--- a/OvmfPkg/AcpiPlatformDxe/QemuFwCfgAcpiPlatformDxe.inf
+++ b/OvmfPkg/AcpiPlatformDxe/QemuFwCfgAcpiPlatformDxe.inf
@@ -35,9 +35,11 @@
 

 [LibraryClasses]

   BaseLib

+  BaseMemoryLib

   DebugLib

   MemoryAllocationLib

   OrderedCollectionLib

+  PcdLib

   QemuFwCfgLib

   QemuFwCfgS3Lib

   UefiBootServicesTableLib

diff --git a/OvmfPkg/AcpiPlatformDxe/Xen.c b/OvmfPkg/AcpiPlatformDxe/Xen.c
index 1d69989042..be2c5d6958 100644
--- a/OvmfPkg/AcpiPlatformDxe/Xen.c
+++ b/OvmfPkg/AcpiPlatformDxe/Xen.c
@@ -8,7 +8,9 @@
 

 **/

 

-#include <Library/BaseLib.h>

+#include <Library/BaseLib.h>        // CpuDeadLoop()

+#include <Library/DebugLib.h>       // DEBUG()

+#include <Library/XenPlatformLib.h> // XenGetInfoHOB()

 

 #include "AcpiPlatform.h"