BaseVariableFlashInfoLib.c File Reference

#include <Uefi.h>
#include <Pi/PiMultiPhase.h>
#include <Guid/VariableFlashInfo.h>
#include <Library/DebugLib.h>
#include <Library/HobLib.h>
#include <Library/VariableFlashInfoLib.h>

Go to the source code of this file.

Functions
STATIC EFI_STATUS	GetVariableFlashInfoFromHob (OUT VARIABLE_FLASH_INFO **VariableFlashInfo)
EFI_STATUS EFIAPI	GetVariableFlashNvStorageInfo (OUT EFI_PHYSICAL_ADDRESS *BaseAddress, OUT UINT64 *Length)
EFI_STATUS EFIAPI	GetVariableFlashFtwSpareInfo (OUT EFI_PHYSICAL_ADDRESS *BaseAddress, OUT UINT64 *Length)
EFI_STATUS EFIAPI	GetVariableFlashFtwWorkingInfo (OUT EFI_PHYSICAL_ADDRESS *BaseAddress, OUT UINT64 *Length)

Detailed Description

Variable Flash Information Library

Copyright (c) Microsoft Corporation

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

Definition in file BaseVariableFlashInfoLib.c.

Function Documentation

GetVariableFlashFtwSpareInfo()

EFI_STATUS EFIAPI GetVariableFlashFtwSpareInfo	(	OUT EFI_PHYSICAL_ADDRESS *	BaseAddress,
		OUT UINT64 *	Length
	)

Get the base address and size for the fault tolerant write (FTW) spare area used for UEFI variable storage.

Parameters

[out]	BaseAddress	The FTW spare base address.
[out]	Length	The FTW spare length in bytes.

Return values

EFI_SUCCESS	FTW spare information was found successfully.
EFI_INVALID_PARAMETER	A required pointer parameter is NULL.
EFI_NOT_FOUND	FTW spare information could not be found.

Definition at line 113 of file BaseVariableFlashInfoLib.c.

GetVariableFlashFtwWorkingInfo()

EFI_STATUS EFIAPI GetVariableFlashFtwWorkingInfo	(	OUT EFI_PHYSICAL_ADDRESS *	BaseAddress,
		OUT UINT64 *	Length
	)

Get the base address and size for the fault tolerant write (FTW) working area used for UEFI variable storage.

Parameters

[out]	BaseAddress	The FTW working area base address.
[out]	Length	The FTW working area length in bytes.

Return values

EFI_SUCCESS	FTW working information was found successfully.
EFI_INVALID_PARAMETER	A required pointer parameter is NULL.
EFI_NOT_FOUND	FTW working information could not be found.

Definition at line 154 of file BaseVariableFlashInfoLib.c.

GetVariableFlashInfoFromHob()

STATIC EFI_STATUS GetVariableFlashInfoFromHob

(

OUT VARIABLE_FLASH_INFO **

VariableFlashInfo

)

Get the HOB that contains variable flash information.

Parameters

[out]

VariableFlashInfo

Pointer to a pointer to set to the variable flash information structure.

Return values

EFI_SUCCESS	Variable flash information was found successfully.
EFI_INVALID_PARAMETER	The VariableFlashInfo pointer given is NULL.
EFI_NOT_FOUND	Variable flash information could not be found.

Definition at line 29 of file BaseVariableFlashInfoLib.c.

GetVariableFlashNvStorageInfo()

EFI_STATUS EFIAPI GetVariableFlashNvStorageInfo	(	OUT EFI_PHYSICAL_ADDRESS *	BaseAddress,
		OUT UINT64 *	Length
	)

Get the base address and size for the NV storage area used for UEFI variable storage.

Parameters

[out]	BaseAddress	The NV storage base address.
[out]	Length	The NV storage length in bytes.

Return values

EFI_SUCCESS	NV storage information was found successfully.
EFI_INVALID_PARAMETER	A required pointer parameter is NULL.

Definition at line 72 of file BaseVariableFlashInfoLib.c.