mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
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>
88 lines
2.3 KiB
C
88 lines
2.3 KiB
C
/** @file
|
|
Header file for SbbrValidator.c
|
|
|
|
Copyright (c) 2020, ARM Limited. All rights reserved.
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
@par Glossary:
|
|
- Sbbr or SBBR - Server Base Boot Requirements
|
|
- Sbsa or SBSA - Server Base System Architecture
|
|
|
|
@par Reference(s):
|
|
- Arm Server Base Boot Requirements 1.2, September 2019
|
|
- Arm Server Base Boot Requirements 1.1, May 2018
|
|
- Arm Server Base Boot Requirements 1.0, March 2016
|
|
- Arm Server Base System Architecture 6.0
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <IndustryStandard/Acpi.h>
|
|
|
|
/**
|
|
Arm SBBR specification versions.
|
|
**/
|
|
typedef enum {
|
|
ArmSbbrVersion_1_0 = 0,
|
|
ArmSbbrVersion_1_1 = 1,
|
|
ArmSbbrVersion_1_2 = 2,
|
|
ArmSbbrVersionMax = 3
|
|
} ARM_SBBR_VERSION;
|
|
|
|
/**
|
|
The ACPI table instance counter.
|
|
**/
|
|
typedef struct AcpiTableCounter {
|
|
CONST UINT32 Signature; /// ACPI table signature
|
|
UINT32 Count; /// Instance count
|
|
} ACPI_TABLE_COUNTER;
|
|
|
|
/**
|
|
ACPI table SBBR requirements.
|
|
**/
|
|
typedef struct AcpiSbbrReq {
|
|
CONST UINT32 *Tables; /// List of required tables
|
|
CONST UINT32 TableCount; /// Number of elements in Tables
|
|
} ACPI_SBBR_REQ;
|
|
|
|
/**
|
|
Reset the platform ACPI table instance count for all SBBR-mandatory tables.
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
ArmSbbrResetTableCounts (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Increment instance count for SBBR-mandatory ACPI table with the given
|
|
signature.
|
|
|
|
@param [in] Signature ACPI table signature.
|
|
|
|
@retval TRUE Count incremented successfully.
|
|
@retval FALSE Table with the input signature not found.
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
ArmSbbrIncrementTableCount (
|
|
UINT32 Signature
|
|
);
|
|
|
|
/**
|
|
Validate that all ACPI tables required by the given SBBR specification
|
|
version are installed on the platform.
|
|
|
|
@param [in] Version SBBR spec version to validate against.
|
|
|
|
@retval EFI_SUCCESS All required tables are present.
|
|
@retval EFI_INVALID_PARAMETER Invalid SBBR version.
|
|
@retval EFI_NOT_FOUND One or more mandatory tables are missing.
|
|
@retval EFI_UNSUPPORTED Mandatory ACPI table does not have its
|
|
instance count tracked.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
ArmSbbrReqsValidate (
|
|
ARM_SBBR_VERSION Version
|
|
);
|