#include "FatLitePeim.h"

Functions
EFI_STATUS EFIAPI	BlockIoNotifyEntry (IN EFI_PEI_SERVICES *PeiServices, IN EFI_PEI_NOTIFY_DESCRIPTOR NotifyDescriptor, IN VOID *Ppi)

EFI_STATUS	UpdateBlocksAndVolumes (IN OUT PEI_FAT_PRIVATE_DATA *PrivateData, IN BOOLEAN BlockIo2)

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

EFI_STATUS EFIAPI	GetNumberRecoveryCapsules (IN EFI_PEI_SERVICES *PeiServices, IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI This, OUT UINTN *NumberRecoveryCapsules)

EFI_STATUS EFIAPI	GetRecoveryCapsuleInfo (IN EFI_PEI_SERVICES *PeiServices, IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI This, IN UINTN CapsuleInstance, OUT UINTN Size, OUT EFI_GUID CapsuleType)

EFI_STATUS EFIAPI	LoadRecoveryCapsule (IN EFI_PEI_SERVICES *PeiServices, IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI This, IN UINTN CapsuleInstance, OUT VOID *Buffer)

EFI_STATUS	FindRecoveryFile (IN PEI_FAT_PRIVATE_DATA PrivateData, IN UINTN VolumeIndex, IN CHAR16 FileName, OUT PEI_FILE_HANDLE *Handle)

Variables
PEI_FAT_PRIVATE_DATA *	mPrivateData = NULL

Detailed Description

FAT recovery PEIM entry point, Ppi Functions and FAT Api functions.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file FatLiteApi.c.

Function Documentation

◆ BlockIoNotifyEntry()

EFI_STATUS EFIAPI BlockIoNotifyEntry	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN EFI_PEI_NOTIFY_DESCRIPTOR *	NotifyDescriptor,
		IN VOID *	Ppi
	)

BlockIo installation notification function. Find out all the current BlockIO PPIs in the system and add them into private data. Assume there is

Parameters

PeiServices	General purpose services available to every PEIM.
NotifyDescriptor	The typedef structure of the notification descriptor. Not used in this function.
Ppi	The typedef structure of the PPI descriptor. Not used in this function.

Return values

EFI_SUCCESS The function completed successfully.

Definition at line 214 of file FatLiteApi.c.

◆ FatPeimEntry()

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

Installs the Device Recovery Module PPI, Initialize BlockIo Ppi installation notification

Parameters

FileHandle	Handle of the file being invoked. Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().
PeiServices	Describes the list of possible PEI Services.

Return values

EFI_SUCCESS	The entry point was executed successfully.
EFI_OUT_OF_RESOURCES	There is no enough memory to complete the operations.

Definition at line 245 of file FatLiteApi.c.

◆ FindRecoveryFile()

EFI_STATUS FindRecoveryFile	(	IN PEI_FAT_PRIVATE_DATA *	PrivateData,
		IN UINTN	VolumeIndex,
		IN CHAR16 *	FileName,
		OUT PEI_FILE_HANDLE *	Handle
	)

Finds the recovery file on a FAT volume. This function finds the recovery file named FileName on a specified FAT volume and returns its FileHandle pointer.

Parameters

PrivateData	Global memory map for accessing global variables.
VolumeIndex	The index of the volume.
FileName	The recovery file name to find.
Handle	The output file handle.

Return values

EFI_DEVICE_ERROR	Some error occurred when operating the FAT volume.
EFI_NOT_FOUND	The recovery file was not found.
EFI_SUCCESS	The recovery file was successfully found on the FAT volume.

Definition at line 615 of file FatLiteApi.c.

◆ GetNumberRecoveryCapsules()

EFI_STATUS EFIAPI GetNumberRecoveryCapsules	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *	This,
		OUT UINTN *	NumberRecoveryCapsules
	)

Returns the number of DXE capsules residing on the device.

This function searches for DXE capsules from the associated device and returns the number and maximum size in bytes of the capsules discovered. Entry 1 is assumed to be the highest load priority and entry N is assumed to be the lowest priority.

Parameters

[in]	PeiServices	General-purpose services that are available to every PEIM
[in]	This	Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
[out]	NumberRecoveryCapsules	Pointer to a caller-allocated UINTN. On output, *NumberRecoveryCapsules contains the number of recovery capsule images available for retrieval from this PEIM instance.

Return values

EFI_SUCCESS	One or more capsules were discovered.
EFI_DEVICE_ERROR	A device error occurred.
EFI_NOT_FOUND	A recovery DXE capsule cannot be found.

Definition at line 350 of file FatLiteApi.c.

◆ GetRecoveryCapsuleInfo()

EFI_STATUS EFIAPI GetRecoveryCapsuleInfo	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *	This,
		IN UINTN	CapsuleInstance,
		OUT UINTN *	Size,
		OUT EFI_GUID *	CapsuleType
	)

Returns the size and type of the requested recovery capsule.

This function gets the size and type of the capsule specified by CapsuleInstance.

Parameters

[in]	PeiServices	General-purpose services that are available to every PEIM
[in]	This	Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
[in]	CapsuleInstance	Specifies for which capsule instance to retrieve the information. This parameter must be between one and the value returned by GetNumberRecoveryCapsules() in NumberRecoveryCapsules.
[out]	Size	A pointer to a caller-allocated UINTN in which the size of the requested recovery module is returned.
[out]	CapsuleType	A pointer to a caller-allocated EFI_GUID in which the type of the requested recovery capsule is returned. The semantic meaning of the value returned is defined by the implementation.

Return values

EFI_SUCCESS	One or more capsules were discovered.
EFI_DEVICE_ERROR	A device error occurred.
EFI_NOT_FOUND	A recovery DXE capsule cannot be found.

Definition at line 413 of file FatLiteApi.c.

◆ LoadRecoveryCapsule()

EFI_STATUS EFIAPI LoadRecoveryCapsule	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI *	This,
		IN UINTN	CapsuleInstance,
		OUT VOID *	Buffer
	)

Loads a DXE capsule from some media into memory.

This function, by whatever mechanism, retrieves a DXE capsule from some device and loads it into memory. Note that the published interface is device neutral.

Parameters

[in]	PeiServices	General-purpose services that are available to every PEIM
[in]	This	Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
[in]	CapsuleInstance	Specifies which capsule instance to retrieve.
[out]	Buffer	Specifies a caller-allocated buffer in which the requested recovery capsule will be returned.

Return values

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

Definition at line 542 of file FatLiteApi.c.

◆ UpdateBlocksAndVolumes()

EFI_STATUS UpdateBlocksAndVolumes	(	IN OUT PEI_FAT_PRIVATE_DATA *	PrivateData,
		IN BOOLEAN	BlockIo2
	)

Discover all the block I/O devices to find the FAT volume.

Parameters

PrivateData	Global memory map for accessing global variables.
BlockIo2	Boolean to show whether using BlockIo2 or BlockIo

Return values

EFI_SUCCESS The function completed successfully.

Definition at line 47 of file FatLiteApi.c.

Variable Documentation

◆ mPrivateData

PEI_FAT_PRIVATE_DATA* mPrivateData = NULL

Definition at line 12 of file FatLiteApi.c.

Functions

Variables

Detailed Description

Function Documentation

◆ BlockIoNotifyEntry()

◆ FatPeimEntry()

◆ FindRecoveryFile()

◆ GetNumberRecoveryCapsules()

◆ GetRecoveryCapsuleInfo()

◆ LoadRecoveryCapsule()

◆ UpdateBlocksAndVolumes()

Variable Documentation

◆ mPrivateData