You've already forked edk2-upstream
mirror of
https://github.com/Dasharo/edk2-upstream.git
synced 2026-03-06 15:03:57 -08: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>
66 lines
2.0 KiB
C
66 lines
2.0 KiB
C
/** @file
|
|
Variable Flash Information Library
|
|
|
|
Copyright (c) Microsoft Corporation<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
/**
|
|
Get the base address and size for the NV storage area used for UEFI variable storage.
|
|
|
|
@param[out] BaseAddress The NV storage base address.
|
|
@param[out] Length The NV storage length in bytes.
|
|
|
|
@retval EFI_SUCCESS NV storage information was found successfully.
|
|
@retval EFI_INVALID_PARAMETER A required pointer parameter is NULL.
|
|
@retval EFI_NOT_FOUND NV storage information could not be found.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
GetVariableFlashNvStorageInfo (
|
|
OUT EFI_PHYSICAL_ADDRESS *BaseAddress,
|
|
OUT UINT64 *Length
|
|
);
|
|
|
|
/**
|
|
Get the base address and size for the fault tolerant write (FTW) spare
|
|
area used for UEFI variable storage.
|
|
|
|
@param[out] BaseAddress The FTW spare base address.
|
|
@param[out] Length The FTW spare length in bytes.
|
|
|
|
@retval EFI_SUCCESS FTW spare information was found successfully.
|
|
@retval EFI_INVALID_PARAMETER A required pointer parameter is NULL.
|
|
@retval EFI_NOT_FOUND FTW spare information could not be found.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
GetVariableFlashFtwSpareInfo (
|
|
OUT EFI_PHYSICAL_ADDRESS *BaseAddress,
|
|
OUT UINT64 *Length
|
|
);
|
|
|
|
/**
|
|
Get the base address and size for the fault tolerant write (FTW) working
|
|
area used for UEFI variable storage.
|
|
|
|
@param[out] BaseAddress The FTW working area base address.
|
|
@param[out] Length The FTW working area length in bytes.
|
|
|
|
@retval EFI_SUCCESS FTW working information was found successfully.
|
|
@retval EFI_INVALID_PARAMETER A required pointer parameter is NULL.
|
|
@retval EFI_NOT_FOUND FTW working information could not be found.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
GetVariableFlashFtwWorkingInfo (
|
|
OUT EFI_PHYSICAL_ADDRESS *BaseAddress,
|
|
OUT UINT64 *Length
|
|
);
|