mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
86047d4742
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>
38 lines
1.3 KiB
C
38 lines
1.3 KiB
C
/** @file
|
|
Intel FSP status code definition
|
|
|
|
Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
//
|
|
// FSP API - 4 BITS
|
|
//
|
|
#define FSP_STATUS_CODE_TEMP_RAM_INIT 0xF000
|
|
#define FSP_STATUS_CODE_MEMORY_INIT 0xD000
|
|
#define FSP_STATUS_CODE_TEMP_RAM_EXIT 0xB000
|
|
#define FSP_STATUS_CODE_SILICON_INIT 0x9000
|
|
#define FSP_STATUS_CODE_FSPSMM_INIT 0x7000
|
|
#define FSP_STATUS_CODE_POST_PCIE_ENUM_NOTIFICATION 0x6000
|
|
#define FSP_STATUS_CODE_READY_TO_BOOT_NOTIFICATION 0x4000
|
|
#define FSP_STATUS_CODE_END_OF_FIRMWARE_NOTIFICATION 0x2000
|
|
|
|
//
|
|
// MODULE - 4 BITS
|
|
//
|
|
#define FSP_STATUS_CODE_GFX_PEIM 0x0700
|
|
#define FSP_STATUS_CODE_COMMON_CODE 0x0800
|
|
#define FSP_STATUS_CODE_SILICON_COMMON_CODE 0x0900
|
|
#define FSP_STATUS_CODE_SYSTEM_AGENT 0x0A00
|
|
#define FSP_STATUS_CODE_PCH 0x0B00
|
|
#define FSP_STATUS_CODE_CPU 0x0C00
|
|
#define FSP_STATUS_CODE_MRC 0x0D00
|
|
#define FSP_STATUS_CODE_ME_BIOS 0x0E00
|
|
//
|
|
// Individual Codes - 1 BYTE
|
|
//
|
|
#define FSP_STATUS_CODE_API_ENTRY 0x0000
|
|
#define FSP_STATUS_CODE_API_EXIT 0x007F
|