[PATCH 28/43] OvmfPkg/PciHostBridgeLib: consolidate #includes and INF file sections #includes


Laszlo Ersek
 

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

- Place all public #includes first, all module-private #includes second.
Separate them with a single empty line. Keep each section sorted in
itself.

- Sort all sections in the INF file, except [Defines].

- Add unlisted lib classes.

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

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/Library/PciHostBridgeLib/PciHostBridgeLib.inf | 7 +++---
OvmfPkg/Library/PciHostBridgeLib/PciHostBridgeLib.c | 22 +++++++-----------
OvmfPkg/Library/PciHostBridgeLib/XenSupport.c | 24 +++++++++-----------
3 files changed, 23 insertions(+), 30 deletions(-)

diff --git a/OvmfPkg/Library/PciHostBridgeLib/PciHostBridgeLib.inf b/OvmfPkg/Library/PciHostBridgeLib/PciHostBridgeLib.inf
index 4610a0c1490b..622780888472 100644
--- a/OvmfPkg/Library/PciHostBridgeLib/PciHostBridgeLib.inf
+++ b/OvmfPkg/Library/PciHostBridgeLib/PciHostBridgeLib.inf
@@ -22,32 +22,33 @@ [Defines]
# tools.
#
# VALID_ARCHITECTURES = IA32 X64 EBC
#

[Sources]
+ PciHostBridge.h
PciHostBridgeLib.c
XenSupport.c
- PciHostBridge.h

[Packages]
MdeModulePkg/MdeModulePkg.dec
MdePkg/MdePkg.dec
OvmfPkg/OvmfPkg.dec

[LibraryClasses]
+ BaseLib
BaseMemoryLib
DebugLib
MemoryAllocationLib
PcdLib
PciHostBridgeUtilityLib
PciLib

[Pcd]
+ gEfiMdeModulePkgTokenSpaceGuid.PcdPciDisableBusEnumeration
+ gUefiOvmfPkgTokenSpaceGuid.PcdOvmfHostBridgePciDevId
gUefiOvmfPkgTokenSpaceGuid.PcdPciIoBase
gUefiOvmfPkgTokenSpaceGuid.PcdPciIoSize
gUefiOvmfPkgTokenSpaceGuid.PcdPciMmio32Base
gUefiOvmfPkgTokenSpaceGuid.PcdPciMmio32Size
gUefiOvmfPkgTokenSpaceGuid.PcdPciMmio64Base
gUefiOvmfPkgTokenSpaceGuid.PcdPciMmio64Size
- gUefiOvmfPkgTokenSpaceGuid.PcdOvmfHostBridgePciDevId
- gEfiMdeModulePkgTokenSpaceGuid.PcdPciDisableBusEnumeration
diff --git a/OvmfPkg/Library/PciHostBridgeLib/PciHostBridgeLib.c b/OvmfPkg/Library/PciHostBridgeLib/PciHostBridgeLib.c
index 7d9fb0fb293a..6db91fb7e20c 100644
--- a/OvmfPkg/Library/PciHostBridgeLib/PciHostBridgeLib.c
+++ b/OvmfPkg/Library/PciHostBridgeLib/PciHostBridgeLib.c
@@ -4,29 +4,23 @@
Copyright (C) 2016, Red Hat, Inc.
Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>

SPDX-License-Identifier: BSD-2-Clause-Patent

**/
-#include <PiDxe.h>
+#include <IndustryStandard/Pci.h> // PCI_MAX_BUS
+#include <IndustryStandard/Q35MchIch9.h> // INTEL_Q35_MCH_DEVIC...
+#include <Library/BaseMemoryLib.h> // ZeroMem()
+#include <Library/PcdLib.h> // PcdGet64()
+#include <Library/PciHostBridgeLib.h> // PCI_ROOT_BRIDGE_APE...
+#include <Library/PciHostBridgeUtilityLib.h> // PciHostBridgeUtilit...
+#include <Protocol/PciHostBridgeResourceAllocation.h> // EFI_PCI_HOST_BRIDGE...
+#include <Protocol/PciRootBridgeIo.h> // EFI_PCI_ATTRIBUTE_I...

-#include <IndustryStandard/Pci.h>
-#include <IndustryStandard/Q35MchIch9.h>
-
-#include <Protocol/PciHostBridgeResourceAllocation.h>
-#include <Protocol/PciRootBridgeIo.h>
-
-#include <Library/BaseMemoryLib.h>
-#include <Library/DebugLib.h>
-#include <Library/MemoryAllocationLib.h>
-#include <Library/PcdLib.h>
-#include <Library/PciHostBridgeLib.h>
-#include <Library/PciHostBridgeUtilityLib.h>
#include "PciHostBridge.h"

-
STATIC PCI_ROOT_BRIDGE_APERTURE mNonExistAperture = { MAX_UINT64, 0 };


/**
Return all the root bridge instances in an array.

diff --git a/OvmfPkg/Library/PciHostBridgeLib/XenSupport.c b/OvmfPkg/Library/PciHostBridgeLib/XenSupport.c
index 9ef39f01821b..07c498dd0ea2 100644
--- a/OvmfPkg/Library/PciHostBridgeLib/XenSupport.c
+++ b/OvmfPkg/Library/PciHostBridgeLib/XenSupport.c
@@ -3,27 +3,25 @@

Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>

SPDX-License-Identifier: BSD-2-Clause-Patent

**/
-#include <PiDxe.h>

-#include <IndustryStandard/Pci.h>
-#include <IndustryStandard/Q35MchIch9.h>
+#include <IndustryStandard/Pci.h> // EFI_PCI_COMMAND_IO_SPACE
+#include <IndustryStandard/Q35MchIch9.h> // INTEL_Q35_MCH_DEVICE_ID
+#include <Library/BaseLib.h> // DisableInterrupts()
+#include <Library/BaseMemoryLib.h> // ZeroMem()
+#include <Library/DebugLib.h> // ASSERT()
+#include <Library/MemoryAllocationLib.h> // ReallocatePool()
+#include <Library/PcdLib.h> // PcdGet16()
+#include <Library/PciHostBridgeLib.h> // PCI_ROOT_BRIDGE_APERTURE
+#include <Library/PciHostBridgeUtilityLib.h> // PciHostBridgeUtilityInitRoot...
+#include <Library/PciLib.h> // PciRead32()
+#include <Protocol/PciRootBridgeIo.h> // EFI_PCI_ATTRIBUTE_ISA_IO

-#include <Protocol/PciHostBridgeResourceAllocation.h>
-#include <Protocol/PciRootBridgeIo.h>
-
-#include <Library/BaseMemoryLib.h>
-#include <Library/DebugLib.h>
-#include <Library/MemoryAllocationLib.h>
-#include <Library/PcdLib.h>
-#include <Library/PciHostBridgeLib.h>
-#include <Library/PciHostBridgeUtilityLib.h>
-#include <Library/PciLib.h>
#include "PciHostBridge.h"

STATIC
VOID
PcatPciRootBridgeBarExisted (
IN UINTN Address,
--
2.19.1.3.g30247aa5d201


Philippe Mathieu-Daudé
 

On 5/26/21 10:14 PM, Laszlo Ersek wrote:
- In every C file, list every necessary public #include individually, with
an example identifier that's actually consumed.

- Place all public #includes first, all module-private #includes second.
Separate them with a single empty line. Keep each section sorted in
itself.

- Sort all sections in the INF file, except [Defines].

- Add unlisted lib classes.

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

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/Library/PciHostBridgeLib/PciHostBridgeLib.inf | 7 +++---
OvmfPkg/Library/PciHostBridgeLib/PciHostBridgeLib.c | 22 +++++++-----------
OvmfPkg/Library/PciHostBridgeLib/XenSupport.c | 24 +++++++++-----------
3 files changed, 23 insertions(+), 30 deletions(-)
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>