#include "UnitTestPeiServicesTablePointerLib.h"

Functions
VOID	ClearGlobalData (VOID)

VOID EFIAPI	UnitTestResetSystem2 (IN EFI_RESET_TYPE ResetType, IN EFI_STATUS ResetStatus, IN UINTN DataSize, IN VOID *ResetData OPTIONAL)

CONST EFI_PEI_SERVICES **EFIAPI	GetPeiServicesTablePointer (VOID)

VOID EFIAPI	SetPeiServicesTablePointer (IN CONST EFI_PEI_SERVICES **PeiServicesTablePointer)

VOID EFIAPI	MigratePeiServicesTablePointer (VOID)

EFI_STATUS EFIAPI	UnitTestPeiServicesTablePointerLibConstructor (VOID)

Variables
EFI_PEI_SERVICES	mPeiServices

PEI_CORE_INSTANCE	mPrivateData

UINT8	mHobBuffer [MAX_HOB_SIZE]

VOID *	mPeiServicesPointer

Detailed Description

This library supports a PEI Service table Pointer library implementation that allows code dependent upon PEI Service to operate in an isolated execution environment such as within the context of a host-based unit test framework.

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

Definition in file UnitTestPeiServicesTablePointerLib.c.

Function Documentation

◆ ClearGlobalData()

VOID ClearGlobalData ( VOID )

Clear Buffer For Global Data.

Definition at line 69 of file UnitTestPeiServicesTablePointerLib.c.

◆ GetPeiServicesTablePointer()

CONST EFI_PEI_SERVICES **EFIAPI GetPeiServicesTablePointer ( VOID )

Retrieves the cached value of the PEI Services Table pointer.

Returns the cached value of the PEI Services Table pointer in a CPU specific manner as specified in the CPU binding section of the Platform Initialization Pre-EFI Initialization Core Interface Specification.

If the cached PEI Services Table pointer is NULL, then ASSERT().

Returns: The pointer to PeiServices.

Definition at line 122 of file UnitTestPeiServicesTablePointerLib.c.

◆ MigratePeiServicesTablePointer()

VOID EFIAPI MigratePeiServicesTablePointer ( VOID )

Perform CPU specific actions required to migrate the PEI Services Table pointer from temporary RAM to permanent RAM.

For IA32 CPUs, the PEI Services Table pointer is stored in the 4 bytes immediately preceding the Interrupt Descriptor Table (IDT) in memory. For X64 CPUs, the PEI Services Table pointer is stored in the 8 bytes immediately preceding the Interrupt Descriptor Table (IDT) in memory. For Itanium and ARM CPUs, a the PEI Services Table Pointer is stored in a dedicated CPU register. This means that there is no memory storage associated with storing the PEI Services Table pointer, so no additional migration actions are required for Itanium or ARM CPUs.

Definition at line 166 of file UnitTestPeiServicesTablePointerLib.c.

◆ SetPeiServicesTablePointer()

VOID EFIAPI SetPeiServicesTablePointer ( IN CONST EFI_PEI_SERVICES ** PeiServicesTablePointer )

Caches a pointer PEI Services Table.

Caches the pointer to the PEI Services Table specified by PeiServicesTablePointer in a CPU specific manner as specified in the CPU binding section of the Platform Initialization Pre-EFI Initialization Core Interface Specification.

If PeiServicesTablePointer is NULL, then ASSERT().

Parameters

PeiServicesTablePointer The address of PeiServices pointer.

Definition at line 143 of file UnitTestPeiServicesTablePointerLib.c.

◆ UnitTestPeiServicesTablePointerLibConstructor()

EFI_STATUS EFIAPI UnitTestPeiServicesTablePointerLibConstructor ( VOID )

The constructor function init PeiServicesTable with clean buffer.

Return values

EFI_SUCCESS The constructor always returns EFI_SUCCESS.

Definition at line 181 of file UnitTestPeiServicesTablePointerLib.c.

◆ UnitTestResetSystem2()

VOID EFIAPI UnitTestResetSystem2	(	IN EFI_RESET_TYPE	ResetType,
		IN EFI_STATUS	ResetStatus,
		IN UINTN	DataSize,
		IN VOID *ResetData	OPTIONAL
	)

Resets the entire platform.

Parameters

[in]	ResetType	The type of reset to perform.
[in]	ResetStatus	The status code for the reset.
[in]	DataSize	The size, in bytes, of ResetData.
[in]	ResetData	For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown the data buffer starts with a Null-terminated string, optionally followed by additional binary data. The string is a description that the caller may use to further indicate the reason for the system reset.