#include <Uefi/UefiBaseType.h>

Functions
VOID EFIAPI	SecureBootHook (IN CHAR16 VariableName, IN EFI_GUID VendorGuid)

EFI_STATUS	MorLockInit (VOID)

VOID	MorLockInitAtEndOfDxe (VOID)

EFI_STATUS	SetVariableCheckHandlerMor (IN CHAR16 VariableName, IN EFI_GUID VendorGuid, IN UINT32 Attributes, IN UINTN DataSize, IN VOID *Data)

VOID	VariableSpeculationBarrier (VOID)

VOID	VariableNotifySmmReady (VOID)

VOID	VariableNotifySmmWriteReady (VOID)

EFI_STATUS EFIAPI	MmVariableServiceInitialize (VOID)

BOOLEAN	VariableSmmIsPrimaryBufferValid (IN EFI_PHYSICAL_ADDRESS Buffer, IN UINT64 Length)

BOOLEAN	VariableSmmIsNonPrimaryBufferValid (IN EFI_PHYSICAL_ADDRESS Buffer, IN UINT64 Length)

BOOLEAN	VariableIsMorVariableLegitimate (VOID)

Detailed Description

Polymorphic functions that are called from both the privileged driver (i.e., the DXE_SMM variable module) and the non-privileged drivers (i.e., one or both of the DXE_RUNTIME variable modules).

Each of these functions has two implementations, appropriate for privileged vs. non-privileged driver code.

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

Definition in file PrivilegePolymorphic.h.

Function Documentation

◆ MmVariableServiceInitialize()

EFI_STATUS EFIAPI MmVariableServiceInitialize ( VOID )

Variable Driver main entry point. The Variable driver places the 4 EFI runtime services in the EFI System Table and installs arch protocols for variable read and write services being available. It also registers a notification function for an EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE event.

Return values

EFI_SUCCESS Variable service successfully initialized.

Register SMM variable SMI handler

Definition at line 1151 of file VariableSmm.c.

◆ MorLockInit()

EFI_STATUS MorLockInit ( VOID )

Initialization for MOR Control Lock.

Return values

EFI_SUCCESS MorLock initialization success.

Returns: Others Some error occurs.

Definition at line 65 of file TcgMorLockDxe.c.

◆ MorLockInitAtEndOfDxe()

VOID MorLockInitAtEndOfDxe ( VOID )

Delayed initialization for MOR Control Lock at EndOfDxe.

This function performs any operations queued by MorLockInit().

Definition at line 109 of file TcgMorLockDxe.c.

◆ SecureBootHook()

VOID EFIAPI SecureBootHook	(	IN CHAR16 *	VariableName,
		IN EFI_GUID *	VendorGuid
	)

SecureBoot Hook for auth variable update.

Parameters

[in]	VariableName	Name of Variable to be found.
[in]	VendorGuid	Variable vendor GUID.

SecureBoot Hook for SetVariable.

Parameters

[in]	VariableName	Name of Variable to be found.
[in]	VendorGuid	Variable vendor GUID.

Definition at line 236 of file Measurement.c.

◆ SetVariableCheckHandlerMor()

EFI_STATUS SetVariableCheckHandlerMor	(	IN CHAR16 *	VariableName,
		IN EFI_GUID *	VendorGuid,
		IN UINT32	Attributes,
		IN UINTN	DataSize,
		IN VOID *	Data
	)

This service is an MOR/MorLock checker handler for the SetVariable().

Parameters

[in]	VariableName	the name of the vendor's variable, as a Null-Terminated Unicode String
[in]	VendorGuid	Unify identifier for vendor.
[in]	Attributes	Attributes bitmask to set for the variable.
[in]	DataSize	The size in bytes of Data-Buffer.
[in]	Data	Point to the content of the variable.

Return values

EFI_SUCCESS	The MOR/MorLock check pass, and Variable driver can store the variable data.
EFI_INVALID_PARAMETER	The MOR/MorLock data or data size or attributes is not allowed for MOR variable.
EFI_ACCESS_DENIED	The MOR/MorLock is locked.
EFI_ALREADY_STARTED	The MorLock variable is handled inside this function. Variable driver can just return EFI_SUCCESS.

This service is a checker handler for the UEFI Runtime Service SetVariable()

Parameters

VariableName	the name of the vendor's variable, as a Null-Terminated Unicode String
VendorGuid	Unify identifier for vendor.
Attributes	Point to memory location to return the attributes of variable. If the point is NULL, the parameter would be ignored.
DataSize	The size in bytes of Data-Buffer.
Data	Point to the content of the variable.

Return values

EFI_SUCCESS	The firmware has successfully stored the variable and its data as defined by the Attributes.
EFI_INVALID_PARAMETER	An invalid combination of attribute bits was supplied, or the DataSize exceeds the maximum allowed.
EFI_INVALID_PARAMETER	VariableName is an empty Unicode string.
EFI_OUT_OF_RESOURCES	Not enough storage is available to hold the variable and its data.
EFI_DEVICE_ERROR	The variable could not be saved due to a hardware failure.
EFI_WRITE_PROTECTED	The variable in question is read-only.
EFI_WRITE_PROTECTED	The variable in question cannot be deleted.
EFI_SECURITY_VIOLATION	The variable could not be written due to EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set but the AuthInfo does NOT pass the validation check carried out by the firmware.
EFI_NOT_FOUND	The variable trying to be updated or deleted was not found.

Definition at line 44 of file TcgMorLockDxe.c.

◆ VariableIsMorVariableLegitimate()

BOOLEAN VariableIsMorVariableLegitimate ( VOID )

Whether the MOR variable is legitimate or not.

Return values

TRUE	MOR Variable is legitimate.
FALSE	MOR Variable in not legitimate.

Whether the TCG or TCG2 protocols are installed in the UEFI protocol database. This information is used by the MorLock code to infer whether an existing MOR variable is legitimate or not.

Return values

TRUE	Either the TCG or TCG2 protocol is installed in the UEFI protocol database. MOR variable is legitimate.
FALSE	Neither the TCG nor the TCG2 protocol is installed in the UEFI protocol database. MOR variable is not legitimate.

Definition at line 111 of file VariableStandaloneMm.c.

◆ VariableNotifySmmReady()

VOID VariableNotifySmmReady ( VOID )

Notify the system that the SMM variable driver is ready.

Definition at line 58 of file VariableStandaloneMm.c.

◆ VariableNotifySmmWriteReady()

VOID VariableNotifySmmWriteReady ( VOID )

Notify the system that the SMM variable write driver is ready.

Definition at line 68 of file VariableStandaloneMm.c.

◆ VariableSmmIsNonPrimaryBufferValid()

BOOLEAN VariableSmmIsNonPrimaryBufferValid	(	IN EFI_PHYSICAL_ADDRESS	Buffer,
		IN UINT64	Length
	)

This function checks if the buffer is valid per processor architecture and does not overlap with SMRAM.

Parameters

Buffer	The buffer start address to be checked.
Length	The buffer length to be checked.

Return values

TRUE	This buffer is valid per processor architecture and does not overlap with SMRAM.
FALSE	This buffer is not valid per processor architecture or overlaps with SMRAM.

Definition at line 46 of file VariableStandaloneMm.c.

◆ VariableSmmIsPrimaryBufferValid()

BOOLEAN VariableSmmIsPrimaryBufferValid	(	IN EFI_PHYSICAL_ADDRESS	Buffer,
		IN UINT64	Length
	)

This function checks if the Primary Buffer (CommBuffer) is valid.

Parameters

Buffer	The buffer start address to be checked.
Length	The buffer length to be checked.

Return values

TRUE	This buffer is valid.
FALSE	This buffer is not valid.

Definition at line 25 of file VariableStandaloneMm.c.

◆ VariableSpeculationBarrier()

VOID VariableSpeculationBarrier ( VOID )

This service is consumed by the variable modules to place a barrier to stop speculative execution.

Ensures that no later instruction will execute speculatively, until all prior instructions have completed.

Definition at line 20 of file SpeculationBarrierDxe.c.

Functions

Detailed Description

Function Documentation

◆ MmVariableServiceInitialize()

◆ MorLockInit()

◆ MorLockInitAtEndOfDxe()

◆ SecureBootHook()

◆ SetVariableCheckHandlerMor()

◆ VariableIsMorVariableLegitimate()

◆ VariableNotifySmmReady()

◆ VariableNotifySmmWriteReady()

◆ VariableSmmIsNonPrimaryBufferValid()

◆ VariableSmmIsPrimaryBufferValid()

◆ VariableSpeculationBarrier()