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>
91 lines
1.8 KiB
C
91 lines
1.8 KiB
C
/** @file
|
|
Provide FSP wrapper API related function.
|
|
|
|
Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <FspEas.h>
|
|
|
|
/**
|
|
Find FSP header pointer.
|
|
|
|
@param[in] FlashFvFspBase Flash address of FSP FV.
|
|
|
|
@return FSP header pointer.
|
|
**/
|
|
FSP_INFO_HEADER *
|
|
EFIAPI
|
|
FspFindFspHeader (
|
|
IN EFI_PHYSICAL_ADDRESS FlashFvFspBase
|
|
);
|
|
|
|
/**
|
|
Call FSP API - FspNotifyPhase.
|
|
|
|
@param[in] NotifyPhaseParams Address pointer to the NOTIFY_PHASE_PARAMS structure.
|
|
|
|
@return EFI status returned by FspNotifyPhase API.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
CallFspNotifyPhase (
|
|
IN NOTIFY_PHASE_PARAMS *NotifyPhaseParams
|
|
);
|
|
|
|
/**
|
|
Call FSP API - FspMemoryInit.
|
|
|
|
@param[in] FspmUpdDataPtr Pointer to the FSPM_UPD data structure.
|
|
@param[out] HobListPtr Pointer to receive the address of the HOB list.
|
|
|
|
@return EFI status returned by FspMemoryInit API.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
CallFspMemoryInit (
|
|
IN VOID *FspmUpdDataPtr,
|
|
OUT VOID **HobListPtr
|
|
);
|
|
|
|
/**
|
|
Call FSP API - TempRamExit.
|
|
|
|
@param[in] TempRamExitParam Address pointer to the TempRamExit parameters structure.
|
|
|
|
@return EFI status returned by TempRamExit API.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
CallTempRamExit (
|
|
IN VOID *TempRamExitParam
|
|
);
|
|
|
|
/**
|
|
Call FSP API - FspSiliconInit.
|
|
|
|
@param[in] FspsUpdDataPtr Pointer to the FSPS_UPD data structure.
|
|
|
|
@return EFI status returned by FspSiliconInit API.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
CallFspSiliconInit (
|
|
IN VOID *FspsUpdDataPtr
|
|
);
|
|
|
|
/**
|
|
Call FSP API - FspSmmInit.
|
|
|
|
@param[in] FspiUpdDataPtr Pointer to the FSPI_UPD data structure.
|
|
|
|
@return EFI status returned by FspSmmInit API.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
CallFspSmmInit (
|
|
IN VOID *FspiUpdDataPtr
|
|
);
|