TianoCore EDK2 master
Loading...
Searching...
No Matches
Functions
VariableSupport.c File Reference
#include "FmpDxe.h"
#include "VariableSupport.h"

Go to the source code of this file.

Functions

VOID GenerateFmpVariableNames (IN OUT FIRMWARE_MANAGEMENT_PRIVATE_DATA *Private)
 
UINT32 GetVersionFromVariable (IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *Private)
 
UINT32 GetLowestSupportedVersionFromVariable (IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *Private)
 
UINT32 GetLastAttemptStatusFromVariable (IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *Private)
 
UINT32 GetLastAttemptVersionFromVariable (IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *Private)
 
VOID SetVersionInVariable (IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *Private, IN UINT32 Version)
 
VOID SetLowestSupportedVersionInVariable (IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *Private, IN UINT32 LowestSupportedVersion)
 
VOID SetLastAttemptStatusInVariable (IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *Private, IN UINT32 LastAttemptStatus)
 
VOID SetLastAttemptVersionInVariable (IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *Private, IN UINT32 LastAttemptVersion)
 
EFI_STATUS LockAllFmpVariables (FIRMWARE_MANAGEMENT_PRIVATE_DATA *Private)
 

Detailed Description

UEFI variable support functions for Firmware Management Protocol based firmware updates.

Copyright (c) 2016, Microsoft Corporation. All rights reserved.
Copyright (c) 2018 - 2021, Intel Corporation. All rights reserved.

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

Definition in file VariableSupport.c.

Function Documentation

◆ GenerateFmpVariableNames()

VOID GenerateFmpVariableNames ( IN OUT FIRMWARE_MANAGEMENT_PRIVATE_DATA *  Private)

Generate the names of the UEFI Variables used to store state information for a managed controller. The UEFI Variables names are a combination of a base name and an optional hardware instance value as a 16 character hex value. If the hardware instance value is 0, then the 16 character hex value is not included. These storage for the UEFI Variable names are allocated using the UEFI Boot Service AllocatePool() and the pointers are stored in the Private. The following are examples of variable names produces for hardware instance value 0 and value 0x1234567812345678.

FmpVersion FmpLsv LastAttemptStatus LastAttemptVersion FmpState

FmpVersion1234567812345678 FmpLsv1234567812345678 LastAttemptStatus1234567812345678 LastAttemptVersion1234567812345678 FmpState1234567812345678

Parameters
[in,out]PrivatePrivate context structure for the managed controller.

Definition at line 207 of file VariableSupport.c.

◆ GetLastAttemptStatusFromVariable()

UINT32 GetLastAttemptStatusFromVariable ( IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *  Private)

Returns the value used to fill in the LastAttemptStatus field of the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the GetImageInfo() service of the Firmware Management Protocol. The value is read from a UEFI variable. If the UEFI variables does not exist, then a default last attempt status value is returned.

UEFI Variable accessed: GUID = gEfiCallerIdGuid, Name = L"FmpState"

Parameters
[in]PrivatePrivate context structure for the managed controller.
Returns
The last attempt status value for the most recent capsule update.

Definition at line 422 of file VariableSupport.c.

◆ GetLastAttemptVersionFromVariable()

UINT32 GetLastAttemptVersionFromVariable ( IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *  Private)

Returns the value used to fill in the LastAttemptVersion field of the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the GetImageInfo() service of the Firmware Management Protocol. The value is read from a UEFI variable. If the UEFI variables does not exist, then a default last attempt version value is returned.

UEFI Variable accessed: GUID = gEfiCallerIdGuid, Name = L"FmpState"

Parameters
[in]PrivatePrivate context structure for the managed controller.
Returns
The last attempt version value for the most recent capsule update.

Definition at line 464 of file VariableSupport.c.

◆ GetLowestSupportedVersionFromVariable()

UINT32 GetLowestSupportedVersionFromVariable ( IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *  Private)

Returns the value used to fill in the LowestSupportedVersion field of the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the GetImageInfo() service of the Firmware Management Protocol. The value is read from a UEFI variable. If the UEFI variables does not exist, then a default lowest supported version value is returned.

UEFI Variable accessed: GUID = gEfiCallerIdGuid, Name = L"FmpState"

Parameters
[in]PrivatePrivate context structure for the managed controller.
Returns
The lowest supported version of the firmware image in the firmware device.

Definition at line 380 of file VariableSupport.c.

◆ GetVersionFromVariable()

UINT32 GetVersionFromVariable ( IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *  Private)

Returns the value used to fill in the Version field of the EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the GetImageInfo() service of the Firmware Management Protocol. The value is read from a UEFI variable. If the UEFI variables does not exist, then a default version value is returned.

UEFI Variable accessed: GUID = gEfiCallerIdGuid, Name = L"FmpState"

Parameters
[in]PrivatePrivate context structure for the managed controller.
Returns
The version of the firmware image in the firmware device.

Definition at line 337 of file VariableSupport.c.

◆ LockAllFmpVariables()

EFI_STATUS LockAllFmpVariables ( FIRMWARE_MANAGEMENT_PRIVATE_DATA *  Private)

Locks all the UEFI Variables that use gEfiCallerIdGuid of the currently executing module.

Parameters
[in]PrivatePrivate context structure for the managed controller.
Return values
EFI_SUCCESSAll UEFI variables are locked.
EFI_UNSUPPORTEDVariable Lock Protocol not found.
OtherOne of the UEFI variables could not be locked.

Definition at line 825 of file VariableSupport.c.

◆ SetLastAttemptStatusInVariable()

VOID SetLastAttemptStatusInVariable ( IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *  Private,
IN UINT32  LastAttemptStatus 
)

Saves the last attempt status value of the most recent FMP capsule update to a UEFI variable.

UEFI Variable accessed: GUID = gEfiCallerIdGuid, Name = L"FmpState"

Parameters
[in]PrivatePrivate context structure for the managed controller.
[in]LastAttemptStatusThe last attempt status of the most recent FMP capsule update.

Definition at line 638 of file VariableSupport.c.

◆ SetLastAttemptVersionInVariable()

VOID SetLastAttemptVersionInVariable ( IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *  Private,
IN UINT32  LastAttemptVersion 
)

Saves the last attempt version value of the most recent FMP capsule update to a UEFI variable.

UEFI Variable accessed: GUID = gEfiCallerIdGuid, Name = L"FmpState"

Parameters
[in]PrivatePrivate context structure for the managed controller.
[in]LastAttemptVersionThe last attempt version value of the most recent FMP capsule update.

Definition at line 706 of file VariableSupport.c.

◆ SetLowestSupportedVersionInVariable()

VOID SetLowestSupportedVersionInVariable ( IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *  Private,
IN UINT32  LowestSupportedVersion 
)

Saves the lowest supported version current of the firmware image in the firmware device to a UEFI variable.

UEFI Variable accessed: GUID = gEfiCallerIdGuid, Name = L"FmpState"

Parameters
[in]PrivatePrivate context structure for the managed controller.
[in]LowestSupportedVersionThe lowest supported version of the firmware image in the firmware device.

Definition at line 570 of file VariableSupport.c.

◆ SetVersionInVariable()

VOID SetVersionInVariable ( IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *  Private,
IN UINT32  Version 
)

Saves the version current of the firmware image in the firmware device to a UEFI variable.

UEFI Variable accessed: GUID = gEfiCallerIdGuid, Name = L"FmpState"

Parameters
[in]PrivatePrivate context structure for the managed controller.
[in]VersionThe version of the firmware image in the firmware device.

Definition at line 502 of file VariableSupport.c.