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>
80 lines
2.9 KiB
C
80 lines
2.9 KiB
C
/** @file
|
|
|
|
Copyright (c) 2019, NVIDIA CORPORATION. All rights reserved.
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Library/UefiBootManagerLib.h>
|
|
|
|
//
|
|
// Platform Boot Manager Protocol GUID value
|
|
//
|
|
#define EDKII_PLATFORM_BOOT_MANAGER_PROTOCOL_GUID \
|
|
{ \
|
|
0xaa17add4, 0x756c, 0x460d, { 0x94, 0xb8, 0x43, 0x88, 0xd7, 0xfb, 0x3e, 0x59 } \
|
|
}
|
|
|
|
//
|
|
// Protocol interface structure
|
|
//
|
|
typedef struct _EDKII_PLATFORM_BOOT_MANAGER_PROTOCOL EDKII_PLATFORM_BOOT_MANAGER_PROTOCOL;
|
|
|
|
//
|
|
// Revision The revision to which the protocol interface adheres.
|
|
// All future revisions must be backwards compatible.
|
|
// If a future version is not back wards compatible it is not the same GUID.
|
|
//
|
|
#define EDKII_PLATFORM_BOOT_MANAGER_PROTOCOL_REVISION 0x00000001
|
|
|
|
//
|
|
// Function Prototypes
|
|
//
|
|
|
|
/*
|
|
This function allows platform to refresh all boot options specific to the platform. Within
|
|
this function, platform can make modifications to the auto enumerated platform boot options
|
|
as well as NV boot options.
|
|
|
|
@param[in const] BootOptions An array of auto enumerated platform boot options.
|
|
This array will be freed by caller upon successful
|
|
exit of this function and output array would be used.
|
|
|
|
@param[in const] BootOptionsCount The number of elements in BootOptions.
|
|
|
|
@param[out] UpdatedBootOptions An array of boot options that have been customized
|
|
for the platform on top of input boot options. This
|
|
array would be allocated by REFRESH_ALL_BOOT_OPTIONS
|
|
and would be freed by caller after consuming it.
|
|
|
|
@param[out] UpdatedBootOptionsCount The number of elements in UpdatedBootOptions.
|
|
|
|
|
|
@retval EFI_SUCCESS Platform refresh to input BootOptions and
|
|
BootCount have been done.
|
|
|
|
@retval EFI_OUT_OF_RESOURCES Memory allocation failed.
|
|
|
|
@retval EFI_INVALID_PARAMETER Input is not correct.
|
|
|
|
@retval EFI_UNSUPPORTED Platform specific overrides are not supported.
|
|
*/
|
|
typedef
|
|
EFI_STATUS
|
|
(EFIAPI *PLATFORM_BOOT_MANAGER_REFRESH_ALL_BOOT_OPTIONS)(
|
|
IN CONST EFI_BOOT_MANAGER_LOAD_OPTION *BootOptions,
|
|
IN CONST UINTN BootOptionsCount,
|
|
OUT EFI_BOOT_MANAGER_LOAD_OPTION **UpdatedBootOptions,
|
|
OUT UINTN *UpdatedBootOptionsCount
|
|
);
|
|
|
|
struct _EDKII_PLATFORM_BOOT_MANAGER_PROTOCOL {
|
|
UINT64 Revision;
|
|
PLATFORM_BOOT_MANAGER_REFRESH_ALL_BOOT_OPTIONS RefreshAllBootOptions;
|
|
};
|
|
|
|
extern EFI_GUID gEdkiiPlatformBootManagerProtocolGuid;
|