CapsuleOnDiskLoadPei.c File Reference

#include <Uefi.h>
#include <PiPei.h>
#include <Ppi/MasterBootMode.h>
#include <Ppi/FirmwareVolumeInfo.h>
#include <Ppi/ReadOnlyVariable2.h>
#include <Ppi/Capsule.h>
#include <Ppi/CapsuleOnDisk.h>
#include <Ppi/DeviceRecoveryModule.h>
#include <Guid/FirmwareFileSystem2.h>
#include <Library/DebugLib.h>
#include <Library/PeimEntryPoint.h>
#include <Library/PeiServicesLib.h>
#include <Library/HobLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/PcdLib.h>
#include <Library/CapsuleLib.h>
#include <Library/ReportStatusCodeLib.h>

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	LoadCapsuleOnDisk (IN EFI_PEI_SERVICES **PeiServices, IN EDKII_PEI_CAPSULE_ON_DISK_PPI *This)
EFI_STATUS EFIAPI	InitializeCapsuleOnDiskLoad (IN EFI_PEI_FILE_HANDLE FileHandle, IN CONST EFI_PEI_SERVICES **PeiServices)

Detailed Description

Recovery module.

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

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

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

Definition in file CapsuleOnDiskLoadPei.c.

Function Documentation

InitializeCapsuleOnDiskLoad()

EFI_STATUS EFIAPI InitializeCapsuleOnDiskLoad	(	IN EFI_PEI_FILE_HANDLE	FileHandle,
		IN CONST EFI_PEI_SERVICES **	PeiServices
	)

Recovery module entrypoint

Parameters

[in]	FileHandle	Handle of the file being invoked.
[in]	PeiServices	Describes the list of possible PEI Services.

Returns

EFI_SUCCESS Recovery module is initialized.

Definition at line 271 of file CapsuleOnDiskLoadPei.c.

LoadCapsuleOnDisk()

EFI_STATUS EFIAPI LoadCapsuleOnDisk	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN EDKII_PEI_CAPSULE_ON_DISK_PPI *	This
	)

Loads a DXE capsule from some media into memory and updates the HOB table with the DXE firmware volume information.

Parameters

[in]	PeiServices	General-purpose services that are available to every PEIM.
[in]	This	Indicates the EFI_PEI_RECOVERY_MODULE_PPI instance.

Return values

EFI_SUCCESS	The capsule was loaded correctly.
EFI_DEVICE_ERROR	A device error occurred.
EFI_NOT_FOUND	A recovery DXE capsule cannot be found.

Definition at line 339 of file CapsuleOnDiskLoadPei.c.