#include "SystemFirmwareDxe.h"

Functions
EFI_STATUS	ParseUpdateDataFile (IN UINT8 DataBuffer, IN UINTN BufferSize, IN OUT CONFIG_HEADER ConfigHeader, IN OUT UPDATE_CONFIG_DATA **UpdateArray)

EFI_STATUS	PerformUpdate (IN VOID SystemFirmwareImage, IN UINTN SystemFirmwareImageSize, IN UPDATE_CONFIG_DATA ConfigData, OUT UINT32 LastAttemptVersion, OUT UINT32 LastAttemptStatus, IN EFI_FIRMWARE_MANAGEMENT_UPDATE_IMAGE_PROGRESS Progress, IN UINTN StartPercentage, IN UINTN EndPercentage)

EFI_STATUS	UpdateImage (IN VOID SystemFirmwareImage, IN UINTN SystemFirmwareImageSize, IN VOID ConfigImage, IN UINTN ConfigImageSize, OUT UINT32 LastAttemptVersion, OUT UINT32 LastAttemptStatus, IN EFI_FIRMWARE_MANAGEMENT_UPDATE_IMAGE_PROGRESS Progress)

EFI_STATUS	SystemFirmwareAuthenticatedUpdate (IN VOID Image, IN UINTN ImageSize, OUT UINT32 LastAttemptVersion, OUT UINT32 *LastAttemptStatus, IN EFI_FIRMWARE_MANAGEMENT_UPDATE_IMAGE_PROGRESS Progress)

EFI_STATUS EFIAPI	GetVariableHook (IN CHAR16 VariableName, IN EFI_GUID VendorGuid, OUT UINT32 Attributes OPTIONAL, IN OUT UINTN DataSize, OUT VOID *Data)

EFI_STATUS EFIAPI	GetNextVariableNameHook (IN OUT UINTN VariableNameSize, IN OUT CHAR16 VariableName, IN OUT EFI_GUID *VendorGuid)

EFI_STATUS EFIAPI	SetVariableHook (IN CHAR16 VariableName, IN EFI_GUID VendorGuid, IN UINT32 Attributes, IN UINTN DataSize, IN VOID *Data)

EFI_STATUS EFIAPI	QueryVariableInfoHook (IN UINT32 Attributes, OUT UINT64 MaximumVariableStorageSize, OUT UINT64 RemainingVariableStorageSize, OUT UINT64 *MaximumVariableSize)

EFI_STATUS EFIAPI	FmpSetImage (IN EFI_FIRMWARE_MANAGEMENT_PROTOCOL This, IN UINT8 ImageIndex, IN CONST VOID Image, IN UINTN ImageSize, IN CONST VOID VendorCode, IN EFI_FIRMWARE_MANAGEMENT_UPDATE_IMAGE_PROGRESS Progress, OUT CHAR16 *AbortReason)

EFI_FIRMWARE_IMAGE_DESCRIPTOR *	GetFmpImageDescriptors (IN EFI_HANDLE Handle, IN EFI_GUID ProtocolGuid, OUT UINT8 FmpImageInfoCount, OUT UINTN *DescriptorSize)

EFI_HANDLE *	FindMatchingFmpHandles (IN EFI_GUID ProtocolGuid, OUT UINTN HandleCount)

EFI_STATUS	UninstallMatchingSystemFmpProtocols (VOID)

EFI_STATUS EFIAPI	SystemFirmwareUpdateMainDxe (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables
SYSTEM_FMP_PRIVATE_DATA *	mSystemFmpPrivate = NULL

EFI_GUID	mCurrentImageTypeId

BOOLEAN	mNvRamUpdated = FALSE

Detailed Description

SetImage instance to update system firmware.

Caution: This module requires additional review when modified. This module will have external input - capsule image. This external input must be validated carefully to avoid security issue like buffer overflow, integer overflow.

FmpSetImage() will receive untrusted input and do basic validation.

Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file SystemFirmwareUpdateDxe.c.

Function Documentation

◆ FindMatchingFmpHandles()

EFI_HANDLE * FindMatchingFmpHandles	(	IN EFI_GUID *	ProtocolGuid,
		OUT UINTN *	HandleCount
	)

Search for handles with an FMP protocol whose EFI_FIRMWARE_IMAGE_DESCRIPTOR ImageTypeId matches the ImageTypeId produced by this module.

Parameters

[in]	ProtocolGuid	Pointer to the GUID of the protocol to search.
[out]	HandleCount	Pointer to the number of returned handles.

Returns: NULL No matching handles found.; !NULL Pointer to a buffer of handles allocated using AllocatePool(). Caller must free buffer with FreePool().

Definition at line 650 of file SystemFirmwareUpdateDxe.c.

◆ FmpSetImage()

EFI_STATUS EFIAPI FmpSetImage	(	IN EFI_FIRMWARE_MANAGEMENT_PROTOCOL *	This,
		IN UINT8	ImageIndex,
		IN CONST VOID *	Image,
		IN UINTN	ImageSize,
		IN CONST VOID *	VendorCode,
		IN EFI_FIRMWARE_MANAGEMENT_UPDATE_IMAGE_PROGRESS	Progress,
		OUT CHAR16 **	AbortReason
	)

Updates the firmware image of the device.

This function updates the hardware with the new firmware image. This function returns EFI_UNSUPPORTED if the firmware image is not updatable. If the firmware image is updatable, the function should perform the following minimal validations before proceeding to do the firmware image update.

Validate the image authentication if image has attribute IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED. The function returns EFI_SECURITY_VIOLATION if the validation fails.
Validate the image is a supported image for this device. The function returns EFI_ABORTED if the image is unsupported. The function can optionally provide more detailed information on why the image is not a supported image.
Validate the data from VendorCode if not null. Image validation must be performed before VendorCode data validation. VendorCode data is ignored or considered invalid if image validation failed. The function returns EFI_ABORTED if the data is invalid.

VendorCode enables vendor to implement vendor-specific firmware image update policy. Null if the caller did not specify the policy or use the default policy. As an example, vendor can implement a policy to allow an option to force a firmware image update when the abort reason is due to the new firmware image version is older than the current firmware image version or bad image checksum. Sensitive operations such as those wiping the entire firmware image and render the device to be non-functional should be encoded in the image itself rather than passed with the VendorCode. AbortReason enables vendor to have the option to provide a more detailed description of the abort reason to the caller.

Parameters

[in]	This	A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance.
[in]	ImageIndex	A unique number identifying the firmware image(s) within the device. The number is between 1 and DescriptorCount.
[in]	Image	Points to the new image.
[in]	ImageSize	Size of the new image in bytes.
[in]	VendorCode	This enables vendor to implement vendor-specific firmware image update policy. Null indicates the caller did not specify the policy or use the default policy.
[in]	Progress	A function used by the driver to report the progress of the firmware update.
[out]	AbortReason	A pointer to a pointer to a null-terminated string providing more details for the aborted operation. The buffer is allocated by this function with AllocatePool(), and it is the caller's responsibility to free it with a call to FreePool().

Return values

EFI_SUCCESS	The device was successfully updated with the new image.
EFI_ABORTED	The operation is aborted.
EFI_INVALID_PARAMETER	The Image was NULL.
EFI_UNSUPPORTED	The operation is not supported.
EFI_SECURITY_VIOLATION	The operation could not be performed due to an authentication failure.

Definition at line 470 of file SystemFirmwareUpdateDxe.c.

◆ GetFmpImageDescriptors()

EFI_FIRMWARE_IMAGE_DESCRIPTOR * GetFmpImageDescriptors	(	IN EFI_HANDLE	Handle,
		IN EFI_GUID *	ProtocolGuid,
		OUT UINT8 *	FmpImageInfoCount,
		OUT UINTN *	DescriptorSize
	)

Get the set of EFI_FIRMWARE_IMAGE_DESCRIPTOR structures from an FMP Protocol.

Parameters

[in]	Handle	Handle with an FMP Protocol or a System FMP Protocol.
[in]	ProtocolGuid	Pointer to the FMP Protocol GUID or System FMP Protocol GUID.
[out]	FmpImageInfoCount	Pointer to the number of EFI_FIRMWARE_IMAGE_DESCRIPTOR structures.
[out]	DescriptorSize	Pointer to the size, in bytes, of each EFI_FIRMWARE_IMAGE_DESCRIPTOR structure.

Returns: NULL No EFI_FIRMWARE_IMAGE_DESCRIPTOR structures found.; !NULL Pointer to a buffer of EFI_FIRMWARE_IMAGE_DESCRIPTOR structures allocated using AllocatePool(). Caller must free buffer with FreePool().

Definition at line 547 of file SystemFirmwareUpdateDxe.c.

◆ GetNextVariableNameHook()

EFI_STATUS EFIAPI GetNextVariableNameHook	(	IN OUT UINTN *	VariableNameSize,
		IN OUT CHAR16 *	VariableName,
		IN OUT EFI_GUID *	VendorGuid
	)

This code Finds the Next available variable.

Parameters

[in,out]	VariableNameSize	Size of the variable name.
[in,out]	VariableName	Pointer to variable name.
[in,out]	VendorGuid	Variable Vendor Guid.

Returns: EFI_INVALID_PARAMETER Invalid parameter.; EFI_SUCCESS Find the specified variable.; EFI_NOT_FOUND Not found.; EFI_BUFFER_TO_SMALL DataSize is too small for the result.

Definition at line 351 of file SystemFirmwareUpdateDxe.c.

◆ GetVariableHook()

EFI_STATUS EFIAPI GetVariableHook	(	IN CHAR16 *	VariableName,
		IN EFI_GUID *	VendorGuid,
		OUT UINT32 *Attributes	OPTIONAL,
		IN OUT UINTN *	DataSize,
		OUT VOID *	Data
	)

This code finds variable in storage blocks (Volatile or Non-Volatile).

Parameters

[in]	VariableName	Name of Variable to be found.
[in]	VendorGuid	Variable vendor GUID.
[out]	Attributes	Attribute value of the variable found.
[in,out]	DataSize	Size of Data found. If size is less than the data, this value contains the required size.
[out]	Data	Data pointer.

Returns: EFI_INVALID_PARAMETER Invalid parameter.; EFI_SUCCESS Find the specified variable.; EFI_NOT_FOUND Not found.; EFI_BUFFER_TO_SMALL DataSize is too small for the result.

Definition at line 323 of file SystemFirmwareUpdateDxe.c.

◆ ParseUpdateDataFile()

EFI_STATUS ParseUpdateDataFile	(	IN UINT8 *	DataBuffer,
		IN UINTN	BufferSize,
		IN OUT CONFIG_HEADER *	ConfigHeader,
		IN OUT UPDATE_CONFIG_DATA **	UpdateArray
	)

Parse Config data file to get the updated data array.

Parameters

[in]	DataBuffer	Config raw file buffer.
[in]	BufferSize	Size of raw buffer.
[in,out]	ConfigHeader	Pointer to the config header.
[in,out]	UpdateArray	Pointer to the config of update data.

Return values

EFI_NOT_FOUND	No config data is found.
EFI_OUT_OF_RESOURCES	No enough memory is allocated.
EFI_SUCCESS	Parse the config file successfully.

Definition at line 31 of file ParseConfigProfile.c.

◆ PerformUpdate()

EFI_STATUS PerformUpdate	(	IN VOID *	SystemFirmwareImage,
		IN UINTN	SystemFirmwareImageSize,
		IN UPDATE_CONFIG_DATA *	ConfigData,
		OUT UINT32 *	LastAttemptVersion,
		OUT UINT32 *	LastAttemptStatus,
		IN EFI_FIRMWARE_MANAGEMENT_UPDATE_IMAGE_PROGRESS	Progress,
		IN UINTN	StartPercentage,
		IN UINTN	EndPercentage
	)

Update System Firmware image component.

Parameters

[in]	SystemFirmwareImage	Points to the System Firmware image.
[in]	SystemFirmwareImageSize	The length of the System Firmware image in bytes.
[in]	ConfigData	Points to the component configuration structure.
[out]	LastAttemptVersion	The last attempt version, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.
[out]	LastAttemptStatus	The last attempt status, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.
[in]	Progress	A function used by the driver to report the progress of the firmware update.
[in]	StartPercentage	The start completion percentage value that may be used to report progress during the flash write operation.
[in]	EndPercentage	The end completion percentage value that may be used to report progress during the flash write operation.

Return values

EFI_SUCCESS	The System Firmware image is updated.
EFI_WRITE_PROTECTED	The flash device is read only.

Definition at line 64 of file SystemFirmwareUpdateDxe.c.

◆ QueryVariableInfoHook()

EFI_STATUS EFIAPI QueryVariableInfoHook	(	IN UINT32	Attributes,
		OUT UINT64 *	MaximumVariableStorageSize,
		OUT UINT64 *	RemainingVariableStorageSize,
		OUT UINT64 *	MaximumVariableSize
	)

This code returns information about the EFI variables.

Parameters

[in]	Attributes	Attributes bitmask to specify the type of variables on which to return information.
[out]	MaximumVariableStorageSize	Pointer to the maximum size of the storage space available for the EFI variables associated with the attributes specified.
[out]	RemainingVariableStorageSize	Pointer to the remaining size of the storage space available for EFI variables associated with the attributes specified.
[out]	MaximumVariableSize	Pointer to the maximum size of an individual EFI variables associated with the attributes specified.

Returns: EFI_SUCCESS Query successfully.

Definition at line 411 of file SystemFirmwareUpdateDxe.c.

◆ SetVariableHook()

EFI_STATUS EFIAPI SetVariableHook	(	IN CHAR16 *	VariableName,
		IN EFI_GUID *	VendorGuid,
		IN UINT32	Attributes,
		IN UINTN	DataSize,
		IN VOID *	Data
	)

This code sets variable in storage blocks (Volatile or Non-Volatile).

Parameters

[in]	VariableName	Name of Variable to be found.
[in]	VendorGuid	Variable vendor GUID.
[in]	Attributes	Attribute value of the variable found
[in]	DataSize	Size of Data found. If size is less than the data, this value contains the required size.
[in]	Data	Data pointer.

Returns: EFI_INVALID_PARAMETER Invalid parameter.; EFI_SUCCESS Set successfully.; EFI_OUT_OF_RESOURCES Resource not enough to set variable.; EFI_NOT_FOUND Not found.; EFI_WRITE_PROTECTED Variable is read-only.

Definition at line 381 of file SystemFirmwareUpdateDxe.c.

◆ SystemFirmwareAuthenticatedUpdate()

EFI_STATUS SystemFirmwareAuthenticatedUpdate	(	IN VOID *	Image,
		IN UINTN	ImageSize,
		OUT UINT32 *	LastAttemptVersion,
		OUT UINT32 *	LastAttemptStatus,
		IN EFI_FIRMWARE_MANAGEMENT_UPDATE_IMAGE_PROGRESS	Progress
	)

Authenticate and update System Firmware image.

Caution: This function may receive untrusted input.

Parameters

[in]	Image	The EDKII system FMP capsule image.
[in]	ImageSize	The size of the EDKII system FMP capsule image in bytes.
[out]	LastAttemptVersion	The last attempt version, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.
[out]	LastAttemptStatus	The last attempt status, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.
[in]	Progress	A function used by the driver to report the progress of the firmware update.

Return values

EFI_SUCCESS	EDKII system FMP capsule passes authentication and the System Firmware image is updated.
EFI_SECURITY_VIOLATION	EDKII system FMP capsule fails authentication and the System Firmware image is not updated.
EFI_WRITE_PROTECTED	The flash device is read only.

Definition at line 260 of file SystemFirmwareUpdateDxe.c.

◆ SystemFirmwareUpdateMainDxe()

EFI_STATUS EFIAPI SystemFirmwareUpdateMainDxe	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

System FMP module entrypoint

Parameters

[in]	ImageHandle	The firmware allocated handle for the EFI image.
[in]	SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS	System FMP module is initialized.
EFI_OUT_OF_RESOURCES	There are not enough resources avaulable to initialize this module.
Other	System FMP Protocols could not be uninstalled.
Other	System FMP Protocol could not be installed.
Other	FMP Protocol could not be installed.

Definition at line 811 of file SystemFirmwareUpdateDxe.c.

◆ UninstallMatchingSystemFmpProtocols()

EFI_STATUS UninstallMatchingSystemFmpProtocols ( VOID )

Uninstall System FMP Protocol instances that may have been installed by SystemFirmwareUpdateDxe drivers dispatches by other capsules.

Return values

EFI_SUCCESS All System FMP Protocols found were uninstalled.

Returns: Other One or more System FMP Protocols could not be uninstalled.

Definition at line 746 of file SystemFirmwareUpdateDxe.c.

◆ UpdateImage()

EFI_STATUS UpdateImage	(	IN VOID *	SystemFirmwareImage,
		IN UINTN	SystemFirmwareImageSize,
		IN VOID *	ConfigImage,
		IN UINTN	ConfigImageSize,
		OUT UINT32 *	LastAttemptVersion,
		OUT UINT32 *	LastAttemptStatus,
		IN EFI_FIRMWARE_MANAGEMENT_UPDATE_IMAGE_PROGRESS	Progress
	)

Update System Firmware image.

Parameters

[in]	SystemFirmwareImage	Points to the System Firmware image.
[in]	SystemFirmwareImageSize	The length of the System Firmware image in bytes.
[in]	ConfigImage	Points to the config file image.
[in]	ConfigImageSize	The length of the config file image in bytes.
[out]	LastAttemptVersion	The last attempt version, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.
[out]	LastAttemptStatus	The last attempt status, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.
[in]	Progress	A function used by the driver to report the progress of the firmware update.

Return values

EFI_SUCCESS	The System Firmware image is updated.
EFI_WRITE_PROTECTED	The flash device is read only.

Definition at line 126 of file SystemFirmwareUpdateDxe.c.

Variable Documentation

◆ mCurrentImageTypeId

EFI_GUID mCurrentImageTypeId

Definition at line 23 of file SystemFirmwareUpdateDxe.c.

◆ mNvRamUpdated

BOOLEAN mNvRamUpdated = FALSE

Definition at line 25 of file SystemFirmwareUpdateDxe.c.

◆ mSystemFmpPrivate

SYSTEM_FMP_PRIVATE_DATA* mSystemFmpPrivate = NULL

Definition at line 21 of file SystemFirmwareUpdateDxe.c.

Functions

Variables

Detailed Description

Function Documentation

◆ FindMatchingFmpHandles()

◆ FmpSetImage()

◆ GetFmpImageDescriptors()

◆ GetNextVariableNameHook()

◆ GetVariableHook()

◆ ParseUpdateDataFile()

◆ PerformUpdate()

◆ QueryVariableInfoHook()

◆ SetVariableHook()

◆ SystemFirmwareAuthenticatedUpdate()

◆ SystemFirmwareUpdateMainDxe()

◆ UninstallMatchingSystemFmpProtocols()

◆ UpdateImage()

Variable Documentation

◆ mCurrentImageTypeId

◆ mNvRamUpdated

◆ mSystemFmpPrivate