You've already forked edk2-upstream
mirror of
https://github.com/Dasharo/edk2-upstream.git
synced 2026-03-06 15:03:57 -08:00
8472271dae
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>
92 lines
1.9 KiB
C
92 lines
1.9 KiB
C
/** @file
|
|
Header file for AcpiView
|
|
|
|
Copyright (c) 2016 - 2020, ARM Limited. All rights reserved.
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
/**
|
|
A macro to define the max file name length
|
|
**/
|
|
#define MAX_FILE_NAME_LEN 128
|
|
|
|
/**
|
|
Offset to the RSDP revision from the start of the RSDP
|
|
**/
|
|
#define RSDP_REVISION_OFFSET 15
|
|
|
|
/**
|
|
Offset to the RSDP length from the start of the RSDP
|
|
**/
|
|
#define RSDP_LENGTH_OFFSET 20
|
|
|
|
/**
|
|
This function resets the ACPI table error counter to Zero.
|
|
**/
|
|
VOID
|
|
ResetErrorCount (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
This function returns the ACPI table error count.
|
|
|
|
@retval Returns the count of errors detected in the ACPI tables.
|
|
**/
|
|
UINT32
|
|
GetErrorCount (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
This function resets the ACPI table warning counter to Zero.
|
|
**/
|
|
VOID
|
|
ResetWarningCount (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
This function returns the ACPI table warning count.
|
|
|
|
@retval Returns the count of warning detected in the ACPI tables.
|
|
**/
|
|
UINT32
|
|
GetWarningCount (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
This function processes the table reporting options for the ACPI table.
|
|
|
|
@param [in] Signature The ACPI table Signature.
|
|
@param [in] TablePtr Pointer to the ACPI table data.
|
|
@param [in] Length The length of the ACPI table.
|
|
|
|
@retval Returns TRUE if the ACPI table should be traced.
|
|
**/
|
|
BOOLEAN
|
|
ProcessTableReportOptions (
|
|
IN CONST UINT32 Signature,
|
|
IN CONST UINT8 *TablePtr,
|
|
IN CONST UINT32 Length
|
|
);
|
|
|
|
/**
|
|
This function iterates the configuration table entries in the
|
|
system table, retrieves the RSDP pointer and starts parsing the ACPI tables.
|
|
|
|
@param [in] SystemTable Pointer to the EFI system table.
|
|
|
|
@retval EFI_NOT_FOUND The RSDP pointer was not found.
|
|
@retval EFI_UNSUPPORTED The RSDP version was less than 2.
|
|
@retval EFI_SUCCESS The command was successful.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
AcpiView (
|
|
IN EFI_SYSTEM_TABLE *SystemTable
|
|
);
|