mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
86047d4742
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>
134 lines
2.6 KiB
C
134 lines
2.6 KiB
C
/** @file
|
|
|
|
Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
/**
|
|
Get system memory resource descriptor by owner.
|
|
|
|
@param[in] OwnerGuid resource owner guid
|
|
**/
|
|
EFI_HOB_RESOURCE_DESCRIPTOR *
|
|
EFIAPI
|
|
FspGetResourceDescriptorByOwner (
|
|
IN EFI_GUID *OwnerGuid
|
|
);
|
|
|
|
/**
|
|
Get system memory from HOB.
|
|
|
|
@param[in,out] LowMemoryLength less than 4G memory length
|
|
@param[in,out] HighMemoryLength greater than 4G memory length
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
FspGetSystemMemorySize (
|
|
IN OUT UINT64 *LowMemoryLength,
|
|
IN OUT UINT64 *HighMemoryLength
|
|
);
|
|
|
|
/**
|
|
Set a new stack frame for the continuation function.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
FspSetNewStackFrame (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
This function transfer control back to BootLoader after FspSiliconInit.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
FspSiliconInitDone (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
This function returns control to BootLoader after MemoryInitApi.
|
|
|
|
@param[in,out] HobListPtr The address of HobList pointer.
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
FspMemoryInitDone (
|
|
IN OUT VOID **HobListPtr
|
|
);
|
|
|
|
/**
|
|
This function returns control to BootLoader after TempRamExitApi.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
FspTempRamExitDone (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
This function handle NotifyPhase API call from the BootLoader.
|
|
It gives control back to the BootLoader after it is handled. If the
|
|
Notification code is a ReadyToBoot event, this function will return
|
|
and FSP continues the remaining execution until it reaches the DxeIpl.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
FspWaitForNotify (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
This function transfer control back to BootLoader after FspSiliconInit.
|
|
|
|
@param[in] Status return status for the FspSiliconInit.
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
FspSiliconInitDone2 (
|
|
IN EFI_STATUS Status
|
|
);
|
|
|
|
/**
|
|
This function returns control to BootLoader after MemoryInitApi.
|
|
|
|
@param[in] Status return status for the MemoryInitApi.
|
|
@param[in,out] HobListPtr The address of HobList pointer.
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
FspMemoryInitDone2 (
|
|
IN EFI_STATUS Status,
|
|
IN OUT VOID **HobListPtr
|
|
);
|
|
|
|
/**
|
|
This function returns control to BootLoader after TempRamExitApi.
|
|
|
|
@param[in] Status return status for the TempRamExitApi.
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
FspTempRamExitDone2 (
|
|
IN EFI_STATUS Status
|
|
);
|
|
|
|
/**
|
|
Calculate TemporaryRam Size using Base address.
|
|
|
|
@param[in] TemporaryRamBase the address of target memory
|
|
@param[out] TemporaryRamSize the size of target memory
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
ReadTemporaryRamSize (
|
|
IN UINT32 TemporaryRamBase,
|
|
OUT UINT32 *TemporaryRamSize
|
|
);
|