mirror of
https://github.com/tianocore/edk2
synced 2026-08-27 00:23:19 -04:00
2ff7f990d1
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>
117 lines
4.1 KiB
C
117 lines
4.1 KiB
C
/** @file
|
|
Public include file for Microcode library.
|
|
|
|
Copyright (c) 2021, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#pragma once
|
|
|
|
#include <Register/Intel/Microcode.h>
|
|
#include <Ppi/ShadowMicrocode.h>
|
|
|
|
/**
|
|
Get microcode update signature of currently loaded microcode update.
|
|
|
|
@return Microcode signature.
|
|
**/
|
|
UINT32
|
|
EFIAPI
|
|
GetProcessorMicrocodeSignature (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Get the processor signature and platform ID for current processor.
|
|
|
|
@param MicrocodeCpuId Return the processor signature and platform ID.
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
GetProcessorMicrocodeCpuId (
|
|
EDKII_PEI_MICROCODE_CPU_ID *MicrocodeCpuId
|
|
);
|
|
|
|
/**
|
|
Return the total size of the microcode entry.
|
|
|
|
Logic follows pseudo code in SDM as below:
|
|
|
|
N = 512
|
|
If (Update.DataSize != 00000000H)
|
|
N = Update.TotalSize / 4
|
|
|
|
If Microcode is NULL, then ASSERT.
|
|
|
|
@param Microcode Pointer to the microcode entry.
|
|
|
|
@return The microcode total size.
|
|
**/
|
|
UINT32
|
|
EFIAPI
|
|
GetMicrocodeLength (
|
|
IN CPU_MICROCODE_HEADER *Microcode
|
|
);
|
|
|
|
/**
|
|
Load the microcode to the processor.
|
|
|
|
If Microcode is NULL, then ASSERT.
|
|
|
|
@param Microcode Pointer to the microcode entry.
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
LoadMicrocode (
|
|
IN CPU_MICROCODE_HEADER *Microcode
|
|
);
|
|
|
|
/**
|
|
Detect whether specified processor can find matching microcode patch and load it.
|
|
|
|
Microcode format is as below:
|
|
+----------------------------------------+-------------------------------------------------+
|
|
| CPU_MICROCODE_HEADER | |
|
|
+----------------------------------------+ V
|
|
| Update Data | CPU_MICROCODE_HEADER.Checksum
|
|
+----------------------------------------+-------+ ^
|
|
| CPU_MICROCODE_EXTENDED_TABLE_HEADER | | |
|
|
+----------------------------------------+ V |
|
|
| CPU_MICROCODE_EXTENDED_TABLE[0] | CPU_MICROCODE_EXTENDED_TABLE_HEADER.Checksum |
|
|
| CPU_MICROCODE_EXTENDED_TABLE[1] | ^ |
|
|
| ... | | |
|
|
+----------------------------------------+-------+-----------------------------------------+
|
|
|
|
There may by multiple CPU_MICROCODE_EXTENDED_TABLE in this format.
|
|
The count of CPU_MICROCODE_EXTENDED_TABLE is indicated by ExtendedSignatureCount
|
|
of CPU_MICROCODE_EXTENDED_TABLE_HEADER structure.
|
|
|
|
If Microcode is NULL, then ASSERT.
|
|
|
|
@param Microcode Pointer to a microcode entry.
|
|
@param MicrocodeLength The total length of the microcode entry.
|
|
@param MinimumRevision The microcode whose revision <= MinimumRevision is treated as invalid.
|
|
Caller can supply value get from GetProcessorMicrocodeSignature() to check
|
|
whether the microcode is newer than loaded one.
|
|
Caller can supply 0 to treat any revision (except 0) microcode as valid.
|
|
@param MicrocodeCpuIds Pointer to an array of processor signature and platform ID that represents
|
|
a set of processors.
|
|
Caller can supply zero-element array to skip the processor signature and
|
|
platform ID check.
|
|
@param MicrocodeCpuIdCount The number of elements in MicrocodeCpuIds.
|
|
@param VerifyChecksum FALSE to skip all the checksum verifications.
|
|
|
|
@retval TRUE The microcode is valid.
|
|
@retval FALSE The microcode is invalid.
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
IsValidMicrocode (
|
|
IN CPU_MICROCODE_HEADER *Microcode,
|
|
IN UINTN MicrocodeLength,
|
|
IN UINT32 MinimumRevision,
|
|
IN EDKII_PEI_MICROCODE_CPU_ID *MicrocodeCpuIds,
|
|
IN UINTN MicrocodeCpuIdCount,
|
|
IN BOOLEAN VerifyChecksum
|
|
);
|