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>
56 lines
1.9 KiB
C
56 lines
1.9 KiB
C
/** @file
|
|
This file defines:
|
|
* the capsule vendor GUID for capsule variables and the HOB.
|
|
* the capsule variable name.
|
|
* the capsule GUID HOB data structure.
|
|
The capsule HOB and variable can be used to store the capsule image start address and length.
|
|
They are used by EDKII implementation of capsule update across a system reset.
|
|
|
|
@par Note: EDKII implementation of capsule updating has discarded this capsule GUID HOB data
|
|
structure and used one UEFI Capsule HOB (defined in PI Specification 1.2) instead.
|
|
|
|
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
///
|
|
/// This guid is used as a variable GUID for the capsule variable
|
|
/// if the capsule pointer is passed through reset via a variable.
|
|
///
|
|
/// This guid is also used as a hob GUID for the capsule data
|
|
/// when the capsule pointer is passed from PEI phase to DXE phase.
|
|
///
|
|
#define EFI_CAPSULE_VENDOR_GUID \
|
|
{ 0x711C703F, 0xC285, 0x4B10, { 0xA3, 0xB0, 0x36, 0xEC, 0xBD, 0x3C, 0x8B, 0xE2 } }
|
|
|
|
///
|
|
/// Name of capsule variable.
|
|
///
|
|
#define EFI_CAPSULE_VARIABLE_NAME L"CapsuleUpdateData"
|
|
|
|
///
|
|
/// The data structure of the capsule guid hob entry.
|
|
/// Note: EDKII implementation has discarded this structure and used
|
|
/// UEFI_CAPSULE_HOB instead.
|
|
///
|
|
typedef struct {
|
|
EFI_PHYSICAL_ADDRESS BaseAddress; ///< Capsule data start address.
|
|
UINT32 Length; ///< Length of capsule data.
|
|
} CAPSULE_HOB_INFO;
|
|
|
|
//
|
|
// The variable describes the long mode buffer used by IA32 Capsule PEIM
|
|
// to call X64 CapsuleCoalesce code to handle >4GB capsule blocks.
|
|
//
|
|
#define EFI_CAPSULE_LONG_MODE_BUFFER_NAME L"CapsuleLongModeBuffer"
|
|
|
|
typedef struct {
|
|
EFI_PHYSICAL_ADDRESS PageTableAddress;
|
|
EFI_PHYSICAL_ADDRESS StackBaseAddress;
|
|
UINT64 StackSize;
|
|
} EFI_CAPSULE_LONG_MODE_BUFFER;
|
|
|
|
extern EFI_GUID gEfiCapsuleVendorGuid;
|