mirror of
https://github.com/Dasharo/edk2-upstream.git
synced 2026-06-13 19:16:19 -07:00
Michael Kubackiandmergify[bot]
8472271dae
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>
56 lines
1.6 KiB
C
56 lines
1.6 KiB
C
/** @file
|
|
Header file for Pci shell Debug1 function.
|
|
|
|
Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
|
|
Copyright (c) 2005 - 2017, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
typedef enum {
|
|
PciDevice,
|
|
PciP2pBridge,
|
|
PciCardBusBridge,
|
|
PciUndefined
|
|
} PCI_HEADER_TYPE;
|
|
|
|
#define INDEX_OF(Field) ((UINT8 *) (Field) - (UINT8 *) mConfigSpace)
|
|
|
|
#define IS_PCIE_ENDPOINT(DevicePortType) \
|
|
((DevicePortType) == PCIE_DEVICE_PORT_TYPE_PCIE_ENDPOINT || \
|
|
(DevicePortType) == PCIE_DEVICE_PORT_TYPE_LEGACY_PCIE_ENDPOINT || \
|
|
(DevicePortType) == PCIE_DEVICE_PORT_TYPE_ROOT_COMPLEX_INTEGRATED_ENDPOINT)
|
|
|
|
#define IS_PCIE_SWITCH(DevicePortType) \
|
|
((DevicePortType == PCIE_DEVICE_PORT_TYPE_UPSTREAM_PORT) || \
|
|
(DevicePortType == PCIE_DEVICE_PORT_TYPE_DOWNSTREAM_PORT))
|
|
|
|
#pragma pack(1)
|
|
//
|
|
// Data region after PCI configuration header(for cardbus bridge)
|
|
//
|
|
typedef struct {
|
|
UINT16 SubVendorId; // Subsystem Vendor ID
|
|
UINT16 SubSystemId; // Subsystem ID
|
|
UINT32 LegacyBase; // Optional 16-Bit PC Card Legacy
|
|
// Mode Base Address
|
|
//
|
|
UINT32 Data[46];
|
|
} PCI_CARDBUS_DATA;
|
|
|
|
typedef union {
|
|
PCI_DEVICE_HEADER_TYPE_REGION Device;
|
|
PCI_BRIDGE_CONTROL_REGISTER Bridge;
|
|
PCI_CARDBUS_CONTROL_REGISTER CardBus;
|
|
} NON_COMMON_UNION;
|
|
|
|
typedef struct {
|
|
PCI_DEVICE_INDEPENDENT_REGION Common;
|
|
NON_COMMON_UNION NonCommon;
|
|
UINT32 Data[48];
|
|
} PCI_CONFIG_SPACE;
|
|
|
|
#pragma pack()
|