Functions
BOOLEAN EFIAPI	ExtractSystemFirmwareImageFmpInfo (IN VOID SystemFirmwareImage, IN UINTN SystemFirmwareImageSize, OUT EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR ImageFmpInfo, OUT UINTN ImageFmpInfoSize)

BOOLEAN EFIAPI	ExtractDriverFvImage (IN VOID AuthenticatedImage, IN UINTN AuthenticatedImageSize, OUT VOID DriverFvImage, OUT UINTN DriverFvImageSize)

BOOLEAN EFIAPI	ExtractConfigImage (IN VOID AuthenticatedImage, IN UINTN AuthenticatedImageSize, OUT VOID ConfigImage, OUT UINTN ConfigImageSize)

BOOLEAN EFIAPI	ExtractSystemFirmwareImage (IN VOID AuthenticatedImage, IN UINTN AuthenticatedImageSize, OUT VOID SystemFirmwareImage, OUT UINTN SystemFirmwareImageSize)

BOOLEAN EFIAPI	ExtractAuthenticatedImage (IN VOID Image, IN UINTN ImageSize, OUT UINT32 LastAttemptStatus, OUT VOID *AuthenticatedImage, OUT UINTN AuthenticatedImageSize)

EFI_STATUS EFIAPI	CapsuleAuthenticateSystemFirmware (IN VOID Image, IN UINTN ImageSize, IN BOOLEAN ForceVersionMatch, OUT UINT32 LastAttemptVersion, OUT UINT32 LastAttemptStatus, OUT VOID AuthenticatedImage, OUT UINTN AuthenticatedImageSize)

Detailed Description

EDKII System Capsule library.

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

Function Documentation

EFI_STATUS EFIAPI CapsuleAuthenticateSystemFirmware	(	IN VOID *	Image,
		IN UINTN	ImageSize,
		IN BOOLEAN	ForceVersionMatch,
		OUT UINT32 *	LastAttemptVersion,
		OUT UINT32 *	LastAttemptStatus,
		OUT VOID **	AuthenticatedImage,
		OUT UINTN *	AuthenticatedImageSize
	)

Authenticated system firmware FMP capsule image.

Caution: This function may receive untrusted input.

Parameters

[in]	Image	The FMP capsule image, including EFI_FIRMWARE_IMAGE_AUTHENTICATION.
[in]	ImageSize	The size of FMP capsule image in bytes.
[in]	ForceVersionMatch	TRUE: The version of capsule must be as same as the version of current image. FALSE: The version of capsule must be as same as greater than the lowest supported version of current image.
[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.
[out]	AuthenticatedImage	The authenticated capsule image, excluding EFI_FIRMWARE_IMAGE_AUTHENTICATION.
[out]	AuthenticatedImageSize	The size of the authenticated capsule image in bytes.

Return values

TRUE	Authentication passes and the authenticated image is extracted.
FALSE	Authentication fails and the authenticated image is not extracted.

BOOLEAN EFIAPI ExtractAuthenticatedImage	(	IN VOID *	Image,
		IN UINTN	ImageSize,
		OUT UINT32 *	LastAttemptStatus,
		OUT VOID **	AuthenticatedImage,
		OUT UINTN *	AuthenticatedImageSize
	)

Extract the authenticated image from an FMP capsule image.

Parameters

[in]	Image	The FMP capsule image, including EFI_FIRMWARE_IMAGE_AUTHENTICATION.
[in]	ImageSize	The size of FMP capsule image in bytes.
[out]	LastAttemptStatus	The last attempt status, which will be recorded in ESRT and FMP EFI_FIRMWARE_IMAGE_DESCRIPTOR.
[out]	AuthenticatedImage	The authenticated capsule image, excluding EFI_FIRMWARE_IMAGE_AUTHENTICATION.
[out]	AuthenticatedImageSize	The size of the authenticated capsule image in bytes.

Return values

TRUE	The authenticated image is extracted.
FALSE	The authenticated image is not extracted.

BOOLEAN EFIAPI ExtractConfigImage	(	IN VOID *	AuthenticatedImage,
		IN UINTN	AuthenticatedImageSize,
		OUT VOID **	ConfigImage,
		OUT UINTN *	ConfigImageSize
	)

Extract the config image from an authenticated image.

Parameters

[in]	AuthenticatedImage	The authenticated capsule image.
[in]	AuthenticatedImageSize	The size of the authenticated capsule image in bytes.
[out]	ConfigImage	The config image.
[out]	ConfigImageSize	The size of the config image in bytes.

Return values

TRUE	The config image is extracted.
FALSE	The config image is not extracted.

BOOLEAN EFIAPI ExtractDriverFvImage	(	IN VOID *	AuthenticatedImage,
		IN UINTN	AuthenticatedImageSize,
		OUT VOID **	DriverFvImage,
		OUT UINTN *	DriverFvImageSize
	)

Extract the driver FV from an authenticated image.

Parameters

[in]	AuthenticatedImage	The authenticated capsule image.
[in]	AuthenticatedImageSize	The size of the authenticated capsule image in bytes.
[out]	DriverFvImage	The driver FV image.
[out]	DriverFvImageSize	The size of the driver FV image in bytes.

Return values

TRUE	The driver Fv is extracted.
FALSE	The driver Fv is not extracted.

BOOLEAN EFIAPI ExtractSystemFirmwareImage	(	IN VOID *	AuthenticatedImage,
		IN UINTN	AuthenticatedImageSize,
		OUT VOID **	SystemFirmwareImage,
		OUT UINTN *	SystemFirmwareImageSize
	)

Extract the System Firmware image from an authenticated image.

Parameters

[in]	AuthenticatedImage	The authenticated capsule image.
[in]	AuthenticatedImageSize	The size of the authenticated capsule image in bytes.
[out]	SystemFirmwareImage	The System Firmware image.
[out]	SystemFirmwareImageSize	The size of the System Firmware image in bytes.

Return values

TRUE	The System Firmware image is extracted.
FALSE	The System Firmware image is not extracted.

BOOLEAN EFIAPI ExtractSystemFirmwareImageFmpInfo	(	IN VOID *	SystemFirmwareImage,
		IN UINTN	SystemFirmwareImageSize,
		OUT EDKII_SYSTEM_FIRMWARE_IMAGE_DESCRIPTOR **	ImageFmpInfo,
		OUT UINTN *	ImageFmpInfoSize
	)

Extract ImageFmpInfo from system firmware.

Parameters

[in]	SystemFirmwareImage	The System Firmware image.
[in]	SystemFirmwareImageSize	The size of the System Firmware image in bytes.
[out]	ImageFmpInfo	The ImageFmpInfo.
[out]	ImageFmpInfoSize	The size of the ImageFmpInfo in bytes.

Return values

TRUE	The ImageFmpInfo is extracted.
FALSE	The ImageFmpInfo is not extracted.