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>
63 lines
2 KiB
C
63 lines
2 KiB
C
/** @file
|
|
SmmLockBox guid header file.
|
|
|
|
Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#define EFI_SMM_LOCK_BOX_COMMUNICATION_GUID \
|
|
{0x2a3cfebd, 0x27e8, 0x4d0a, {0x8b, 0x79, 0xd6, 0x88, 0xc2, 0xa3, 0xe1, 0xc0}}
|
|
|
|
//
|
|
// Below data structure is used for communication between PEI/DXE to SMM.
|
|
//
|
|
|
|
#define EFI_SMM_LOCK_BOX_COMMAND_SAVE 0x1
|
|
#define EFI_SMM_LOCK_BOX_COMMAND_UPDATE 0x2
|
|
#define EFI_SMM_LOCK_BOX_COMMAND_RESTORE 0x3
|
|
#define EFI_SMM_LOCK_BOX_COMMAND_SET_ATTRIBUTES 0x4
|
|
#define EFI_SMM_LOCK_BOX_COMMAND_RESTORE_ALL_IN_PLACE 0x5
|
|
|
|
typedef struct {
|
|
UINT32 Command;
|
|
UINT32 DataLength;
|
|
UINT64 ReturnStatus;
|
|
} EFI_SMM_LOCK_BOX_PARAMETER_HEADER;
|
|
|
|
typedef struct {
|
|
EFI_SMM_LOCK_BOX_PARAMETER_HEADER Header;
|
|
GUID Guid;
|
|
PHYSICAL_ADDRESS Buffer;
|
|
UINT64 Length;
|
|
} EFI_SMM_LOCK_BOX_PARAMETER_SAVE;
|
|
|
|
typedef struct {
|
|
EFI_SMM_LOCK_BOX_PARAMETER_HEADER Header;
|
|
GUID Guid;
|
|
UINT64 Offset;
|
|
PHYSICAL_ADDRESS Buffer;
|
|
UINT64 Length;
|
|
} EFI_SMM_LOCK_BOX_PARAMETER_UPDATE;
|
|
|
|
typedef struct {
|
|
EFI_SMM_LOCK_BOX_PARAMETER_HEADER Header;
|
|
GUID Guid;
|
|
PHYSICAL_ADDRESS Buffer;
|
|
UINT64 Length;
|
|
} EFI_SMM_LOCK_BOX_PARAMETER_RESTORE;
|
|
|
|
typedef struct {
|
|
EFI_SMM_LOCK_BOX_PARAMETER_HEADER Header;
|
|
GUID Guid;
|
|
UINT64 Attributes;
|
|
} EFI_SMM_LOCK_BOX_PARAMETER_SET_ATTRIBUTES;
|
|
|
|
typedef struct {
|
|
EFI_SMM_LOCK_BOX_PARAMETER_HEADER Header;
|
|
} EFI_SMM_LOCK_BOX_PARAMETER_RESTORE_ALL_IN_PLACE;
|
|
|
|
extern EFI_GUID gEfiSmmLockBoxCommunicationGuid;
|