mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
7835e5802a
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>
137 lines
4.6 KiB
C
137 lines
4.6 KiB
C
/** @file
|
|
Provides services to send progress/error codes to a POST card.
|
|
|
|
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#define POST_CODE_PROPERTY_POST_CODE_ENABLED 0x00000008
|
|
#define POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED 0x00000010
|
|
|
|
/**
|
|
Sends a 32-bit value to a POST card.
|
|
|
|
Sends the 32-bit value specified by Value to a POST card, and returns Value.
|
|
Some implementations of this library function may perform I/O operations
|
|
directly to a POST card device. Other implementations may send Value to
|
|
ReportStatusCode(), and the status code reporting mechanism will eventually
|
|
display the 32-bit value on the status reporting device.
|
|
|
|
PostCode() must actively prevent recursion. If PostCode() is called while
|
|
processing another Post Code Library function, then
|
|
PostCode() must return Value immediately.
|
|
|
|
@param Value The 32-bit value to write to the POST card.
|
|
|
|
@return The 32-bit value to write to the POST card.
|
|
|
|
**/
|
|
UINT32
|
|
EFIAPI
|
|
PostCode (
|
|
IN UINT32 Value
|
|
);
|
|
|
|
/**
|
|
Sends a 32-bit value to a POST and associated ASCII string.
|
|
|
|
Sends the 32-bit value specified by Value to a POST card, and returns Value.
|
|
If Description is not NULL, then the ASCII string specified by Description is
|
|
also passed to the handler that displays the POST card value. Some
|
|
implementations of this library function may perform I/O operations directly
|
|
to a POST card device. Other implementations may send Value to ReportStatusCode(),
|
|
and the status code reporting mechanism will eventually display the 32-bit
|
|
value on the status reporting device.
|
|
|
|
PostCodeWithDescription()must actively prevent recursion. If
|
|
PostCodeWithDescription() is called while processing another any other Post
|
|
Code Library function, then PostCodeWithDescription() must return Value
|
|
immediately.
|
|
|
|
@param Value The 32-bit value to write to the POST card.
|
|
@param Description Pointer to an ASCII string that is a description of the
|
|
POST code value. This is an optional parameter that may
|
|
be NULL.
|
|
|
|
@return The 32-bit value to write to the POST card.
|
|
|
|
**/
|
|
UINT32
|
|
EFIAPI
|
|
PostCodeWithDescription (
|
|
IN UINT32 Value,
|
|
IN CONST CHAR8 *Description OPTIONAL
|
|
);
|
|
|
|
/**
|
|
Returns TRUE if POST Codes are enabled.
|
|
|
|
This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_ENABLED
|
|
bit of PcdPostCodePropertyMask is set. Otherwise FALSE is returned.
|
|
|
|
@retval TRUE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of
|
|
PcdPostCodePropertyMask is set.
|
|
@retval FALSE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of
|
|
PcdPostCodePropertyMask is clear.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
PostCodeEnabled (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Returns TRUE if POST code descriptions are enabled.
|
|
|
|
This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED
|
|
bit of PcdPostCodePropertyMask is set. Otherwise FALSE is returned.
|
|
|
|
@retval TRUE The POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of
|
|
PcdPostCodePropertyMask is set.
|
|
@retval FALSE The POST_CODE_PROPERTY_POST_CODE_DESCRIPTION_ENABLED bit of
|
|
PcdPostCodePropertyMask is clear.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
PostCodeDescriptionEnabled (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Sends a 32-bit value to a POST card.
|
|
|
|
If POST codes are enabled in PcdPostCodePropertyMask, then call PostCode()
|
|
passing in Value. Value is returned.
|
|
|
|
@param Value The 32-bit value to write to the POST card.
|
|
|
|
@return Value The 32-bit value to write to the POST card.
|
|
|
|
**/
|
|
#define POST_CODE(Value) PostCodeEnabled() ? PostCode(Value) : Value
|
|
|
|
/**
|
|
Sends a 32-bit value to a POST and associated ASCII string.
|
|
|
|
If POST codes and POST code descriptions are enabled in
|
|
PcdPostCodePropertyMask, then call PostCodeWithDescription() passing in
|
|
Value and Description. If only POST codes are enabled, then call PostCode()
|
|
passing in Value. Value is returned.
|
|
|
|
@param Value The 32-bit value to write to the POST card.
|
|
@param Description Pointer to an ASCII string that is a description of the
|
|
POST code value.
|
|
|
|
@return Value The 32-bit value to write to the POST card.
|
|
**/
|
|
#define POST_CODE_WITH_DESCRIPTION(Value, Description) \
|
|
PostCodeEnabled() ? \
|
|
(PostCodeDescriptionEnabled() ? \
|
|
PostCodeWithDescription(Value,Description) : \
|
|
PostCode(Value)) : \
|
|
Value
|