mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
7a934d0bef
Replace traditional `#ifndef`/`#define`/`#endif` include guards with
`#pragma` once.
`#pragma once` is a widely supported preprocessor directive that
prevents header files from being included multiple times. It is
supported by all toolchains used to build edk2: GCC, Clang/LLVM, and
MSVC.
Compared to macro-based include guards, `#pragma once`:
- Eliminates the risk of macro name collisions or copy/paste errors
where two headers inadvertently use the same guard macro.
- Eliminate inconsistency in the way include guard macros are named
(e.g., some files use `__FILE_H__`, others use `FILE_H_`, etc.).
- Reduces boilerplate (three lines replaced by one).
- Avoids polluting the macro namespace with guard symbols.
- Can improve build times as the preprocessor can skip re-opening the
file entirely, rather than re-reading it to find the matching
`#endif` ("multiple-include optimization").
- Note that some compilers may already optimize traditional include
guards, by recognzining the idiomatic pattern.
This change is made acknowledging that overall portability of the
code will technically be reduced, as `#pragma once` is not part of the
C/C++ standards.
However, this is considered acceptable given:
1. edk2 already defines a subset of supported compilers in
BaseTools/Conf/tools_def.template, all of which have supported
`#pragma once` for over two decades.
2. There have been concerns raised to the project about inconsistent
include guard naming and potential macro collisions.
Approximate compiler support dates:
- MSVC: Supported since Visual C++ 4.2 (1996)
- GCC: Supported since 3.4 (2004)
(http://gnu.ist.utl.pt/software/gcc/gcc-3.4/changes.html)
- Clang (LLVM based): Since initial release in 2007
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
88 lines
5.3 KiB
C
88 lines
5.3 KiB
C
/** @file
|
|
This file defines the structure for the PCI Root Bridges.
|
|
|
|
Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
@par Revision Reference:
|
|
- Universal Payload Specification 0.75 (https://universalpayload.github.io/documentation/)
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <UniversalPayload/UniversalPayload.h>
|
|
|
|
#pragma pack(1)
|
|
|
|
//
|
|
// (Base > Limit) indicates an aperture is not available.
|
|
//
|
|
typedef struct {
|
|
//
|
|
// Base and Limit are the device address instead of host address when
|
|
// Translation is not zero
|
|
//
|
|
UINT64 Base;
|
|
UINT64 Limit;
|
|
//
|
|
// According to UEFI 2.7, Device Address = Host Address + Translation,
|
|
// so Translation = Device Address - Host Address.
|
|
// On platforms where Translation is not zero, the subtraction is probably to
|
|
// be performed with UINT64 wrap-around semantics, for we may translate an
|
|
// above-4G host address into a below-4G device address for legacy PCIe device
|
|
// compatibility.
|
|
//
|
|
// NOTE: The alignment of Translation is required to be larger than any BAR
|
|
// alignment in the same root bridge, so that the same alignment can be
|
|
// applied to both device address and host address, which simplifies the
|
|
// situation and makes the current resource allocation code in generic PCI
|
|
// host bridge driver still work.
|
|
//
|
|
UINT64 Translation;
|
|
} UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE_APERTURE;
|
|
|
|
///
|
|
/// Payload PCI Root Bridge Information HOB
|
|
///
|
|
typedef struct {
|
|
UINT32 Segment; ///< Segment number.
|
|
UINT64 Supports; ///< Supported attributes.
|
|
///< Refer to EFI_PCI_ATTRIBUTE_xxx used by GetAttributes()
|
|
///< and SetAttributes() in EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
|
|
UINT64 Attributes; ///< Initial attributes.
|
|
///< Refer to EFI_PCI_ATTRIBUTE_xxx used by GetAttributes()
|
|
///< and SetAttributes() in EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.
|
|
BOOLEAN DmaAbove4G; ///< DMA above 4GB memory.
|
|
///< Set to TRUE when root bridge supports DMA above 4GB memory.
|
|
BOOLEAN NoExtendedConfigSpace; ///< When FALSE, the root bridge supports
|
|
///< Extended (4096-byte) Configuration Space.
|
|
///< When TRUE, the root bridge supports
|
|
///< 256-byte Configuration Space only.
|
|
UINT64 AllocationAttributes; ///< Allocation attributes.
|
|
///< Refer to EFI_PCI_HOST_BRIDGE_COMBINE_MEM_PMEM and
|
|
///< EFI_PCI_HOST_BRIDGE_MEM64_DECODE used by GetAllocAttributes()
|
|
///< in EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL.
|
|
UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE_APERTURE Bus; ///< Bus aperture which can be used by the root bridge.
|
|
UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE_APERTURE Io; ///< IO aperture which can be used by the root bridge.
|
|
UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE_APERTURE Mem; ///< MMIO aperture below 4GB which can be used by the root bridge.
|
|
UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE_APERTURE MemAbove4G; ///< MMIO aperture above 4GB which can be used by the root bridge.
|
|
UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE_APERTURE PMem; ///< Prefetchable MMIO aperture below 4GB which can be used by the root bridge.
|
|
UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE_APERTURE PMemAbove4G; ///< Prefetchable MMIO aperture above 4GB which can be used by the root bridge.
|
|
UINT32 HID; ///< PnP hardware ID of the root bridge. This value must match the corresponding
|
|
///< _HID in the ACPI name space.
|
|
UINT32 UID; ///< Unique ID that is required by ACPI if two devices have the same _HID.
|
|
///< This value must also match the corresponding _UID/_HID pair in the ACPI name space.
|
|
} UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE;
|
|
|
|
typedef struct {
|
|
UNIVERSAL_PAYLOAD_GENERIC_HEADER Header;
|
|
BOOLEAN ResourceAssigned;
|
|
UINT8 Count;
|
|
UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGE RootBridge[0];
|
|
} UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGES;
|
|
|
|
#pragma pack()
|
|
|
|
#define UNIVERSAL_PAYLOAD_PCI_ROOT_BRIDGES_REVISION 1
|
|
|
|
extern GUID gUniversalPayloadPciRootBridgeInfoGuid;
|