MdeModulePkg[all]  0.98
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Macros | Functions
CapsuleLib.h File Reference

Macros

#define COD_RELOCATION_INFO_VAR_NAME   L"CodRelocationInfo"
 

Functions

EFI_STATUS EFIAPI SupportCapsuleImage (IN EFI_CAPSULE_HEADER *CapsuleHeader)
 
EFI_STATUS EFIAPI ProcessCapsuleImage (IN EFI_CAPSULE_HEADER *CapsuleHeader)
 
EFI_STATUS EFIAPI ProcessCapsules (VOID)
 
BOOLEAN EFIAPI CoDCheckCapsuleOnDiskFlag (VOID)
 
EFI_STATUS EFIAPI CoDClearCapsuleOnDiskFlag (VOID)
 
EFI_STATUS EFIAPI CoDRelocateCapsule (UINTN MaxRetry)
 
EFI_STATUS EFIAPI CoDRemoveTempFile (UINTN MaxRetry)
 

Detailed Description

This library class defines a set of interfaces for how to process capsule image updates.

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

Macro Definition Documentation

#define COD_RELOCATION_INFO_VAR_NAME   L"CodRelocationInfo"

Function Documentation

BOOLEAN EFIAPI CoDCheckCapsuleOnDiskFlag ( VOID  )

This routine is called to check if CapsuleOnDisk flag in OsIndications Variable is enabled.

Return values
TRUEFlag is enabled
FALSEFlag is not enabled
EFI_STATUS EFIAPI CoDClearCapsuleOnDiskFlag ( VOID  )

This routine is called to clear CapsuleOnDisk flags including OsIndications and BootNext variable.

Return values
EFI_SUCCESSAll Capsule On Disk flags are cleared
EFI_STATUS EFIAPI CoDRelocateCapsule ( UINTN  MaxRetry)

Relocate Capsule on Disk from EFI system partition.

Two solution to deliver Capsule On Disk: Solution A: If PcdCapsuleInRamSupport is enabled, relocate Capsule On Disk to memory and call UpdateCapsule(). Solution B: If PcdCapsuleInRamSupport is disabled, relocate Capsule On Disk to a platform-specific NV storage device with BlockIo protocol.

Device enumeration like USB costs time, user can input MaxRetry to tell function to retry. Function will stall 100ms between each retry.

Side Effects: Capsule Delivery Supported Flag in OsIndication variable and BootNext variable will be cleared. Solution B: Content corruption. Block IO write directly touches low level write. Orignal partitions, file systems of the relocation device will be corrupted.

Parameters
[in]MaxRetryMax Connection Retry. Stall 100ms between each connection try to ensure devices like USB can get enumerated. Input 0 means no retry.
Return values
EFI_SUCCESSCapsule on Disk images are successfully relocated.
EFI_STATUS EFIAPI CoDRemoveTempFile ( UINTN  MaxRetry)

Remove the temp file from the root of EFI System Partition. Device enumeration like USB costs time, user can input MaxRetry to tell function to retry. Function will stall 100ms between each retry.

Parameters
[in]MaxRetryMax Connection Retry. Stall 100ms between each connection try to ensure devices like USB can get enumerated. Input 0 means no retry.
Return values
EFI_SUCCESSRemove the temp file successfully.
EFI_STATUS EFIAPI ProcessCapsuleImage ( IN EFI_CAPSULE_HEADER *  CapsuleHeader)

The firmware-specific implementation processes the capsule image if it recognized the format of this capsule image.

Caution: This function may receive untrusted input.

Parameters
CapsuleHeaderPointer to the UEFI capsule image to be processed.
Return values
EFI_SUCESSCapsule Image processed successfully.
EFI_UNSUPPORTEDCapsule image is not supported by the firmware.
EFI_STATUS EFIAPI ProcessCapsules ( VOID  )

This routine is called to process capsules.

Caution: This function may receive untrusted input.

The capsules reported in EFI_HOB_UEFI_CAPSULE are processed. If there is no EFI_HOB_UEFI_CAPSULE, this routine does nothing.

This routine should be called twice in BDS. 1) The first call must be before EndOfDxe. The system capsules is processed. If device capsule FMP protocols are exposted at this time and device FMP capsule has zero EmbeddedDriverCount, the device capsules are processed. Each individual capsule result is recorded in capsule record variable. System may reset in this function, if reset is required by capsule and all capsules are processed. If not all capsules are processed, reset will be defered to second call.

2) The second call must be after EndOfDxe and after ConnectAll, so that all device capsule FMP protocols are exposed. The system capsules are skipped. If the device capsules are NOT processed in first call, they are processed here. Each individual capsule result is recorded in capsule record variable. System may reset in this function, if reset is required by capsule processed in first call and second call.

Return values
EFI_SUCCESSThere is no error when processing capsules.
EFI_OUT_OF_RESOURCESNo enough resource to process capsules.
EFI_STATUS EFIAPI SupportCapsuleImage ( IN EFI_CAPSULE_HEADER *  CapsuleHeader)

The firmware checks whether the capsule image is supported by the CapsuleGuid in CapsuleHeader or if there is other specific information in the capsule image.

Caution: This function may receive untrusted input.

Parameters
CapsuleHeaderPointer to the UEFI capsule image to be checked.
Return values
EFI_SUCESSInput capsule is supported by firmware.
EFI_UNSUPPORTEDInput capsule is not supported by the firmware.