mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
648ea00a19
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>
89 lines
2 KiB
C
89 lines
2 KiB
C
/** @file
|
|
Provide FSP wrapper platform related function.
|
|
|
|
Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
/**
|
|
This function overrides the default configurations in the FSP-M UPD data region.
|
|
|
|
@param[in,out] FspUpdRgnPtr A pointer to the UPD data region data structure.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
UpdateFspmUpdData (
|
|
IN OUT VOID *FspUpdRgnPtr
|
|
);
|
|
|
|
/**
|
|
This function overrides the default configurations in the FSP-S UPD data region.
|
|
|
|
@param[in,out] FspUpdRgnPtr A pointer to the UPD data region data structure.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
UpdateFspsUpdData (
|
|
IN OUT VOID *FspUpdRgnPtr
|
|
);
|
|
|
|
/**
|
|
Update TempRamExit parameter.
|
|
|
|
@note At this point, memory is ready, PeiServices are available to use.
|
|
|
|
@return TempRamExit parameter.
|
|
**/
|
|
VOID *
|
|
EFIAPI
|
|
UpdateTempRamExitParam (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Get S3 PEI memory information.
|
|
|
|
@note At this point, memory is ready, and PeiServices are available to use.
|
|
Platform can get some data from SMRAM directly.
|
|
|
|
@param[out] S3PeiMemSize PEI memory size to be installed in S3 phase.
|
|
@param[out] S3PeiMemBase PEI memory base to be installed in S3 phase.
|
|
|
|
@return If S3 PEI memory information is got successfully.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
GetS3MemoryInfo (
|
|
OUT UINT64 *S3PeiMemSize,
|
|
OUT EFI_PHYSICAL_ADDRESS *S3PeiMemBase
|
|
);
|
|
|
|
/**
|
|
Perform platform related reset in FSP wrapper.
|
|
|
|
This function will reset the system with requested ResetType.
|
|
|
|
@param[in] FspStatusResetType The type of reset the platform has to perform.
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
CallFspWrapperResetSystem (
|
|
IN EFI_STATUS FspStatusResetType
|
|
);
|
|
|
|
/**
|
|
This function overrides the default configurations in the FSP-I UPD data region.
|
|
|
|
@param[in,out] FspUpdRgnPtr A pointer to the UPD data region data structure.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
UpdateFspiUpdData (
|
|
IN OUT VOID *FspUpdRgnPtr
|
|
);
|