mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
9326c0eb0a
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>
66 lines
2.4 KiB
C
66 lines
2.4 KiB
C
/** @file
|
|
The variable data structures are related to EDKII-specific
|
|
implementation of UEFI authenticated variables.
|
|
AuthenticatedVariableFormat.h defines variable data headers
|
|
and variable storage region headers that has been moved to
|
|
VariableFormat.h.
|
|
|
|
Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Guid/VariableFormat.h>
|
|
|
|
#define EFI_SECURE_BOOT_ENABLE_DISABLE \
|
|
{ 0xf0a30bc7, 0xaf08, 0x4556, { 0x99, 0xc4, 0x0, 0x10, 0x9, 0xc9, 0x3a, 0x44 } }
|
|
|
|
extern EFI_GUID gEfiSecureBootEnableDisableGuid;
|
|
extern EFI_GUID gEfiCertDbGuid;
|
|
extern EFI_GUID gEfiCustomModeEnableGuid;
|
|
extern EFI_GUID gEfiVendorKeysNvGuid;
|
|
|
|
///
|
|
/// "SecureBootEnable" variable for the Secure Boot feature enable/disable.
|
|
/// This variable is used for allowing a physically present user to disable
|
|
/// Secure Boot via firmware setup without the possession of PKpriv.
|
|
///
|
|
/// GUID: gEfiSecureBootEnableDisableGuid
|
|
///
|
|
/// Format: UINT8
|
|
///
|
|
#define EFI_SECURE_BOOT_ENABLE_NAME L"SecureBootEnable"
|
|
#define SECURE_BOOT_ENABLE 1
|
|
#define SECURE_BOOT_DISABLE 0
|
|
|
|
///
|
|
/// "CustomMode" variable for two Secure Boot modes feature: "Custom" and "Standard".
|
|
/// Standard Secure Boot mode is the default mode as UEFI Spec's description.
|
|
/// Custom Secure Boot mode allows for more flexibility as specified in the following:
|
|
/// Can enroll or delete PK without existing PK's private key.
|
|
/// Can enroll or delete KEK without existing PK's private key.
|
|
/// Can enroll or delete signature from DB/DBX without KEK's private key.
|
|
///
|
|
/// GUID: gEfiCustomModeEnableGuid
|
|
///
|
|
/// Format: UINT8
|
|
///
|
|
#define EFI_CUSTOM_MODE_NAME L"CustomMode"
|
|
#define CUSTOM_SECURE_BOOT_MODE 1
|
|
#define STANDARD_SECURE_BOOT_MODE 0
|
|
|
|
///
|
|
/// "VendorKeysNv" variable to record the out of band secure boot keys modification.
|
|
/// This variable is a read-only NV variable that indicates whether someone other than
|
|
/// the platform vendor has used a mechanism not defined by the UEFI Specification to
|
|
/// transition the system to setup mode or to update secure boot keys.
|
|
///
|
|
/// GUID: gEfiVendorKeysNvGuid
|
|
///
|
|
/// Format: UINT8
|
|
///
|
|
#define EFI_VENDOR_KEYS_NV_VARIABLE_NAME L"VendorKeysNv"
|
|
#define VENDOR_KEYS_VALID 1
|
|
#define VENDOR_KEYS_MODIFIED 0
|