You've already forked slimbootloader
mirror of
https://github.com/Dasharo/slimbootloader.git
synced 2026-03-06 15:26:20 -08:00
bdfaac2396
- According to the Intel 64 and IA-32 Architectures Software Developer's Manual, Volume 3A, Section 10.11.1 titled "Microcode Update", the microcode header does not include an SVN (Security Version Number) field. Additionally, the subsequent section does not reference the SVN either, it only mentions the update revision. - Added check to ensure UpdateRevision is not lower than the minimum required version. - If UpdateRevision is lower, an error is logged and appropriate action is taken. - This prevents unauthorized rollback to older, potentially insecure versions of microcode. Signed-off-by: costel-ignat <costel.ignat@intel.com>
372 lines
10 KiB
C
372 lines
10 KiB
C
/** @file
|
|
The header file for internal firmware update definitions.
|
|
|
|
Copyright (c) 2020 - 2021, Intel Corporation. All rights reserved.<BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
|
|
#ifndef __INTERNAL_FIRMWARE_UPDATE_LIB_H__
|
|
#define __INTERNAL_FIRMWARE_UPDATE_LIB_H__
|
|
|
|
#include <Uefi/UefiBaseType.h>
|
|
#include <Library/ResetSystemLib.h>
|
|
|
|
///
|
|
/// Structure to describe microcode header
|
|
///
|
|
typedef struct {
|
|
UINT32 HeaderVersion; ///< Version number of the update header.
|
|
UINT32 UpdateRevision; ///< Unique version number for the update.
|
|
UINT32 Date; ///< Date of the update creation.
|
|
UINT32 ProcessorId; ///< Signature of the processor that requires this update.
|
|
UINT32 Checksum; ///< Checksum of update data and header.
|
|
UINT32 LoaderRevision; ///< Version number of the microcode loader program.
|
|
UINT32 ProcessorFlags; ///< Lower 4 bits denoting platform type information.
|
|
UINT32 DataSize; ///< Size of encoded data in bytes.
|
|
UINT32 TotalSize; ///< Total size of microcode update in bytes.
|
|
UINT8 Reserved[12]; ///< Reserved bits.
|
|
} CPU_MICROCODE_HEADER;
|
|
|
|
#define PAD_BYTE 0xFF
|
|
|
|
/**
|
|
Update a region block.
|
|
|
|
This is the acture function to update boot meia. It will erase boot device,
|
|
write new data to boot device, and verify the written data.
|
|
|
|
@param[in] Address The boot media address to be update.
|
|
@param[in] Buffer The source buffer to write to the boot media.
|
|
@param[in] Length The length of data to write to boot media.
|
|
|
|
@retval EFI_SUCCESS Update successfully.
|
|
@retval others Error happening when updating.
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
UpdateRegionBlock (
|
|
IN UINT64 Address,
|
|
IN VOID *Buffer,
|
|
IN UINT32 Length
|
|
);
|
|
|
|
/**
|
|
Update a boot region.
|
|
|
|
This function also output the update process info.
|
|
|
|
@param[in] UpdateRegion The detail information for this region to update.
|
|
@param[in] WrittenSize The data size has been written before this region.
|
|
@param[in] TotalSize The total size need to write for the partition.
|
|
|
|
@retval EFI_SUCCESS Update this boot region successfully.
|
|
@retval others Error happening when updating boot region.
|
|
**/
|
|
EFI_STATUS
|
|
UpdateBootRegion (
|
|
IN FIRMWARE_UPDATE_REGION *UpdateRegion,
|
|
IN UINT32 WrittenSize,
|
|
IN UINT32 TotalSize
|
|
);
|
|
|
|
/**
|
|
Update all the regions in this boot partition.
|
|
|
|
@param[in] UpdatePartition The detail information for this update.
|
|
|
|
@retval EFI_SUCCESS Update this boot partition successfully.
|
|
@retval others Error happening when updating boot partition.
|
|
**/
|
|
EFI_STATUS
|
|
UpdateBootPartition (
|
|
IN FIRMWARE_UPDATE_PARTITION *UpdatePartition
|
|
);
|
|
|
|
/**
|
|
Verify the firmware version to make sure it is no less than current firmware version.
|
|
|
|
@param[in] ImageHdr Pointer to the fw mgmt capsule image header
|
|
@param[in] FwPolicy Firmware update policy.
|
|
|
|
@retval EFI_SUCCESS The operation completed successfully.
|
|
@retval others There is error happening.
|
|
**/
|
|
EFI_STATUS
|
|
VerifyFwVersion (
|
|
IN EFI_FW_MGMT_CAP_IMAGE_HEADER *ImageHdr,
|
|
IN FIRMWARE_UPDATE_POLICY FwPolicy
|
|
);
|
|
|
|
/**
|
|
Verify uCode internal structure
|
|
|
|
@param[in] ImageHdr Pointer to the fw mgmt capsule image header
|
|
|
|
@retval EFI_SUCCESS The operation completed successfully.
|
|
@retval others There is error happening.
|
|
**/
|
|
EFI_STATUS
|
|
VerifyUcodeStruct (
|
|
IN EFI_FW_MGMT_CAP_IMAGE_HEADER *ImageHdr
|
|
);
|
|
|
|
/**
|
|
Verify the firmware internal structure.
|
|
|
|
@param[in] ImageHdr Pointer to the fw mgmt capsule image header
|
|
|
|
@retval EFI_SUCCESS The operation completed successfully.
|
|
@retval others There is error happening.
|
|
**/
|
|
EFI_STATUS
|
|
VerifyFwStruct (
|
|
IN EFI_FW_MGMT_CAP_IMAGE_HEADER *ImageHdr
|
|
);
|
|
|
|
/**
|
|
Set state machine flag in flash.
|
|
|
|
This function will set state machine flag in the bootloader reserved region
|
|
First byte in the booloader reserved region is state machine flag.
|
|
|
|
@param[in] StateMachine State machine flag byte.
|
|
|
|
@retval EFI_SUCCESS State machine flag set.
|
|
@retval others Error while setting state machine flag.
|
|
**/
|
|
EFI_STATUS
|
|
SetStateMachineFlag (
|
|
IN UINT8 StateMachine
|
|
);
|
|
|
|
/**
|
|
This function will enforce firmware update policy.
|
|
|
|
Firmware update policy
|
|
|
|
----------------------------------------------------------
|
|
| SM | TS | Operation |
|
|
----------------------------------------------------------
|
|
| 7F | 0 | Set SM to 7E, Set TS and reboot |
|
|
| 7F | 1 | Set SM to 7D, clear TS and reboot |
|
|
| 7E | 0 | Set TS and reboot |
|
|
| 7E | 1 | Set SM to 7C, clear TS and reboot |
|
|
| 7D | 0 | Set SM to 7C, reboot |
|
|
| 7D | 1 | clear TS and reboot |
|
|
| 7C | 0 | Clear IBB signal, reboot |
|
|
| 7C | 1 | Clear IBB signal, reboot |
|
|
----------------------------------------------------------
|
|
|
|
@param[in] ContainsRedundant Whether the capsule contains a redundant update.
|
|
@param[out] FwPolicy Pointer to Firmware update policy.
|
|
|
|
@retval EFI_SUCCESS The operation completed successfully.
|
|
@retval others There is error happening.
|
|
**/
|
|
EFI_STATUS
|
|
EnforceFwUpdatePolicy (
|
|
IN BOOLEAN ContainsRedundant,
|
|
OUT FIRMWARE_UPDATE_POLICY *FwPolicy
|
|
);
|
|
|
|
/**
|
|
This function will enforce firmware update policy after
|
|
partition update is successful.
|
|
|
|
After update firmware update policy
|
|
|
|
@param[in] FwPolicy Firmware update policy.
|
|
|
|
@retval EFI_SUCCESS The operation completed successfully.
|
|
@retval others There is error happening.
|
|
**/
|
|
EFI_STATUS
|
|
AfterUpdateEnforceFwUpdatePolicy (
|
|
IN FIRMWARE_UPDATE_POLICY FwPolicy
|
|
);
|
|
|
|
/**
|
|
Perform full BIOS region update.
|
|
|
|
@param[in] ImageHdr Pointer to fw mgmt capsule Image header
|
|
|
|
@retval EFI_SUCCESS Update successful.
|
|
@retval other error occurred during firmware update
|
|
**/
|
|
EFI_STATUS
|
|
UpdateFullBiosRegion (
|
|
IN EFI_FW_MGMT_CAP_IMAGE_HEADER *ImageHdr
|
|
);
|
|
|
|
/**
|
|
Perform system Firmware update.
|
|
|
|
This function will update SBL or Configuration data alone.
|
|
|
|
@param[in] ImageHdr Pointer to fw mgmt capsule Image header
|
|
@param[in] FwPolicy Fw update policy
|
|
|
|
@retval EFI_SUCCESS Update successful.
|
|
@retval other error occurred during firmware update
|
|
**/
|
|
EFI_STATUS
|
|
UpdateSystemFirmware (
|
|
IN EFI_FW_MGMT_CAP_IMAGE_HEADER *ImageHdr,
|
|
IN FIRMWARE_UPDATE_POLICY FwPolicy
|
|
);
|
|
|
|
/**
|
|
Perform Slim Bootloader component update.
|
|
|
|
This function will try to locate component in the flash map,
|
|
if found, will update the component.
|
|
|
|
@param[in] ImageHdr Pointer to fw mgmt capsule Image header
|
|
@param[in] FwPolicy Fw update policy
|
|
|
|
@retval EFI_SUCCESS Update successful.
|
|
@retval other error occurred during firmware update
|
|
**/
|
|
EFI_STATUS
|
|
UpdateSblComponent (
|
|
IN EFI_FW_MGMT_CAP_IMAGE_HEADER *ImageHdr,
|
|
IN FIRMWARE_UPDATE_POLICY FwPolicy
|
|
);
|
|
|
|
|
|
/**
|
|
Main routine for Command updates.
|
|
|
|
This function has the logic to perform CMD update.
|
|
|
|
@param[in] CapImageHdr The pointer to the firmware update capsule image
|
|
|
|
@retval EFI_SUCCESS Update successful
|
|
@retval other error status from the update routine
|
|
**/
|
|
EFI_STATUS
|
|
FwCmdUpdateProcess (
|
|
EFI_FW_MGMT_CAP_IMAGE_HEADER *CapImageHdr
|
|
);
|
|
|
|
/**
|
|
Perform Config data svn check
|
|
|
|
This function will perform svn checks for cfgdata in flash and
|
|
config data in capsule.
|
|
|
|
@param[in] ImageHdr Pointer to fw mgmt capsule Image header
|
|
@param[in] FwPolicy Firmware update policy
|
|
@param[out] SvnStatus Svn compare status
|
|
|
|
@retval EFI_SUCCESS SVN check successful
|
|
@retval other error occurred during firmware update
|
|
**/
|
|
EFI_STATUS
|
|
CheckSblConfigDataSvn (
|
|
IN EFI_FW_MGMT_CAP_IMAGE_HEADER *ImageHdr,
|
|
IN FIRMWARE_UPDATE_POLICY FwPolicy,
|
|
OUT UINT8 *SvnStatus
|
|
);
|
|
|
|
/**
|
|
Perform ACM svn check
|
|
|
|
This function will perform svn checks for ACM in flash and
|
|
ACM in capsule.
|
|
|
|
@param[in] ImageHdr Pointer to fw mgmt capsule Image header
|
|
|
|
@retval EFI_SUCCESS SVN check successful.
|
|
@retval other error occurred during firmware update
|
|
**/
|
|
EFI_STATUS
|
|
CheckAcmSvn (
|
|
IN EFI_FW_MGMT_CAP_IMAGE_HEADER *ImageHdr
|
|
);
|
|
|
|
/**
|
|
Perform UCODE revision check
|
|
|
|
This function will perform revision checks for UCODE in flash and
|
|
UCODE in capsule.
|
|
|
|
@param[in] ImageHdr Pointer to fw mgmt capsule Image header
|
|
|
|
@retval EFI_SUCCESS revision check successful.
|
|
@retval other error occurred during firmware update
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
CheckUCodeVersion (
|
|
IN EFI_FW_MGMT_CAP_IMAGE_HEADER *ImageHdr
|
|
);
|
|
|
|
/**
|
|
Read the value of FW_UPDATE_STATUS.CsmeNeedReset
|
|
|
|
The CsmeNeedReset flag is used to ensure CSME update
|
|
has taken effect before processing CMDI payload.
|
|
This is specific to prevent {OEMKEYREVOCATION} command
|
|
failure for the case that CSME payload contains OEM KM
|
|
with key revocation extension.
|
|
|
|
@retval Value Value of FW_UPDATE_STATUS.CsmeNeedReset
|
|
**/
|
|
UINT8
|
|
ReadCsmeNeedResetFlag (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Write the value to FW_UPDATE_STATUS.CsmeNeedReset
|
|
|
|
@param[in] Value Value to be written to FW_UPDATE_STATUS.CsmeNeedReset
|
|
|
|
@retval EFI_SUCCESS Write operation is successful
|
|
@retval EFI_INVALID_PARAMETER Invalid parameter
|
|
@retval EFI_DEVICE_ERROR Write operation failed
|
|
**/
|
|
EFI_STATUS
|
|
WriteCsmeNeedResetFlag (
|
|
IN UINT8 Value
|
|
);
|
|
|
|
/**
|
|
Reboot platform.
|
|
|
|
@param[in] ResetType Cold, Warm or Shutdown
|
|
|
|
**/
|
|
VOID
|
|
Reboot (
|
|
IN EFI_RESET_TYPE ResetType
|
|
);
|
|
|
|
/**
|
|
Retrieve the SBL rom image offset within BIOS region.
|
|
|
|
@retval The SBL rom image offset within BIOS region
|
|
**/
|
|
UINT32
|
|
GetRomImageOffsetInBiosRegion (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Check if component provided is part of a redundant region (either top
|
|
swap or redundant).
|
|
|
|
@param[in] Signature The signature of the component
|
|
|
|
@retval TRUE The component is part of a redundant region
|
|
@retval FALSE The component is part of a nonredundant region
|
|
**/
|
|
BOOLEAN
|
|
IsRedundantComponent (
|
|
IN UINT64 Signature
|
|
);
|
|
|
|
#endif
|