mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
c61d1c2753
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>
93 lines
2.2 KiB
C
93 lines
2.2 KiB
C
/** @file
|
|
|
|
Copyright (c) 2011-2013, ARM Limited. All rights reserved.
|
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
//
|
|
// The package level header files this module uses
|
|
//
|
|
#include <PiPei.h>
|
|
//
|
|
// The protocols, PPI and GUID definitions for this module
|
|
//
|
|
#include <Ppi/MasterBootMode.h>
|
|
#include <Ppi/BootInRecoveryMode.h>
|
|
|
|
#include <Library/ArmLib.h>
|
|
|
|
/**
|
|
Return the current Boot Mode
|
|
|
|
This function returns the boot reason on the platform
|
|
|
|
@return Return the current Boot Mode of the platform
|
|
|
|
**/
|
|
EFI_BOOT_MODE
|
|
ArmPlatformGetBootMode (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
First platform specific function to be called in the PEI phase
|
|
|
|
This function is actually the first function called by the PrePi
|
|
or PrePeiCore modules. It allows to retrieve arguments passed to
|
|
the UEFI firmware through the CPU registers.
|
|
|
|
This function might be written into assembler as no stack are set
|
|
when the function is invoked.
|
|
|
|
**/
|
|
VOID
|
|
ArmPlatformPeiBootAction (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Initialize controllers that must setup in the normal world
|
|
|
|
This function is called by the ArmPlatformPkg/PrePi or ArmPlatformPkg/PlatformPei
|
|
in the PEI phase.
|
|
|
|
**/
|
|
RETURN_STATUS
|
|
ArmPlatformInitialize (
|
|
IN UINTN MpId
|
|
);
|
|
|
|
/**
|
|
Return the Virtual Memory Map of your platform
|
|
|
|
This Virtual Memory Map is used by MemoryInitPei Module to initialize the MMU on your platform.
|
|
|
|
@param[out] VirtualMemoryMap Array of ARM_MEMORY_REGION_DESCRIPTOR describing a Physical-to-
|
|
Virtual Memory mapping. This array must be ended by a zero-filled
|
|
entry
|
|
|
|
**/
|
|
VOID
|
|
ArmPlatformGetVirtualMemoryMap (
|
|
OUT ARM_MEMORY_REGION_DESCRIPTOR **VirtualMemoryMap
|
|
);
|
|
|
|
/**
|
|
Return the Platform specific PPIs
|
|
|
|
This function exposes the Platform Specific PPIs. They can be used by any PrePi modules or passed
|
|
to the PeiCore by PrePeiCore.
|
|
|
|
@param[out] PpiListSize Size in Bytes of the Platform PPI List
|
|
@param[out] PpiList Platform PPI List
|
|
|
|
**/
|
|
VOID
|
|
ArmPlatformGetPlatformPpiList (
|
|
OUT UINTN *PpiListSize,
|
|
OUT EFI_PEI_PPI_DESCRIPTOR **PpiList
|
|
);
|