mirror of
https://github.com/Dasharo/edk2-upstream.git
synced 2026-06-13 19:16:19 -07:00
Michael Kubackiandmergify[bot]
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>
50 lines
1.2 KiB
C
50 lines
1.2 KiB
C
/** @file
|
|
ATA ATAPI Policy protocol is produced by platform and consumed by AtaAtapiPassThruDxe
|
|
driver.
|
|
|
|
Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#define EDKII_ATA_ATAPI_POLICY_PROTOCOL_GUID \
|
|
{ \
|
|
0xe59cd769, 0x5083, 0x4f26,{ 0x90, 0x94, 0x6c, 0x91, 0x9f, 0x91, 0x6c, 0x4e } \
|
|
}
|
|
|
|
typedef struct {
|
|
///
|
|
/// Protocol version.
|
|
///
|
|
UINT32 Version;
|
|
|
|
///
|
|
/// 0: Disable Power-up in Standby;
|
|
/// 1: Enable Power-up in Standby;
|
|
/// others: Since PUIS setting is non-volatile, platform can use other value than 0/1 to keep hardware PUIS setting.
|
|
///
|
|
UINT8 PuisEnable;
|
|
|
|
///
|
|
/// 0: Disable Device Sleep;
|
|
/// 1: Enable Device Sleep;
|
|
/// others: Ignored.
|
|
///
|
|
UINT8 DeviceSleepEnable;
|
|
|
|
///
|
|
/// 0: Disable Aggressive Device Sleep;
|
|
/// 1: Enable Aggressive Device Sleep;
|
|
/// others: Ignored.
|
|
///
|
|
UINT8 AggressiveDeviceSleepEnable;
|
|
|
|
UINT8 Reserved;
|
|
} EDKII_ATA_ATAPI_POLICY_PROTOCOL;
|
|
|
|
#define EDKII_ATA_ATAPI_POLICY_VERSION 0x00010000
|
|
|
|
extern EFI_GUID gEdkiiAtaAtapiPolicyProtocolGuid;
|