#include "PeiMain.h"

Functions
VOID	ConvertPointer (IN OUT VOID **Pointer, IN UINTN TempBottom, IN UINTN TempTop, IN UINTN Offset, IN BOOLEAN OffsetPositive)

VOID	ConvertPointerInRanges (IN CONST EFI_SEC_PEI_HAND_OFF SecCoreData, IN PEI_CORE_INSTANCE PrivateData, IN OUT VOID **Pointer)

VOID	ConvertSinglePpiPointer (IN CONST EFI_SEC_PEI_HAND_OFF SecCoreData, IN PEI_CORE_INSTANCE PrivateData, IN PEI_PPI_LIST_POINTERS *PpiPointer)

VOID	ConvertPpiPointers (IN CONST EFI_SEC_PEI_HAND_OFF SecCoreData, IN PEI_CORE_INSTANCE PrivateData)

VOID	ConvertPpiPointersFv (IN PEI_CORE_INSTANCE *PrivateData, IN UINTN OrgFvHandle, IN UINTN FvHandle, IN UINTN FvSize)

VOID	DumpPpiList (IN PEI_CORE_INSTANCE *PrivateData)

EFI_STATUS	InternalPeiInstallPpi (IN CONST EFI_PEI_SERVICES *PeiServices, IN CONST EFI_PEI_PPI_DESCRIPTOR PpiList, IN BOOLEAN Single)

EFI_STATUS EFIAPI	PeiInstallPpi (IN CONST EFI_PEI_SERVICES *PeiServices, IN CONST EFI_PEI_PPI_DESCRIPTOR PpiList)

EFI_STATUS EFIAPI	PeiReInstallPpi (IN CONST EFI_PEI_SERVICES *PeiServices, IN CONST EFI_PEI_PPI_DESCRIPTOR OldPpi, IN CONST EFI_PEI_PPI_DESCRIPTOR *NewPpi)

EFI_STATUS EFIAPI	PeiLocatePpi (IN CONST EFI_PEI_SERVICES *PeiServices, IN CONST EFI_GUID Guid, IN UINTN Instance, IN OUT EFI_PEI_PPI_DESCRIPTOR PpiDescriptor, IN OUT VOID Ppi)

EFI_STATUS	InternalPeiNotifyPpi (IN CONST EFI_PEI_SERVICES *PeiServices, IN CONST EFI_PEI_NOTIFY_DESCRIPTOR NotifyList, IN BOOLEAN Single)

EFI_STATUS EFIAPI	PeiNotifyPpi (IN CONST EFI_PEI_SERVICES *PeiServices, IN CONST EFI_PEI_NOTIFY_DESCRIPTOR NotifyList)

VOID	ProcessDispatchNotifyList (IN PEI_CORE_INSTANCE *PrivateData)

VOID	ProcessNotify (IN PEI_CORE_INSTANCE *PrivateData, IN UINTN NotifyType, IN INTN InstallStartIndex, IN INTN InstallStopIndex, IN INTN NotifyStartIndex, IN INTN NotifyStopIndex)

VOID	ProcessPpiListFromSec (IN CONST EFI_PEI_SERVICES *PeiServices, IN CONST EFI_PEI_PPI_DESCRIPTOR PpiList)

VOID	ConvertPeiCorePpiPointers (IN PEI_CORE_INSTANCE PrivateData, IN PEI_CORE_FV_HANDLE CoreFvHandle)

Detailed Description

EFI PEI Core PPI services

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

Definition in file Ppi.c.

Function Documentation

◆ ConvertPeiCorePpiPointers()

VOID ConvertPeiCorePpiPointers	(	IN PEI_CORE_INSTANCE *	PrivateData,
		IN PEI_CORE_FV_HANDLE *	CoreFvHandle
	)

Migrate PPI Pointers of PEI_CORE from temporary memory to permanent memory.

Parameters

PrivateData	Pointer to PeiCore's private data structure.
CoreFvHandle	Address of PEI_CORE FV Handle in temporary memory.

Definition at line 1080 of file Ppi.c.

◆ ConvertPointer()

VOID ConvertPointer	(	IN OUT VOID **	Pointer,
		IN UINTN	TempBottom,
		IN UINTN	TempTop,
		IN UINTN	Offset,
		IN BOOLEAN	OffsetPositive
	)

Migrate Pointer from the temporary memory to PEI installed memory.

Parameters

Pointer	Pointer to the Pointer needs to be converted.
TempBottom	Base of old temporary memory
TempTop	Top of old temporary memory
Offset	Offset of new memory to old temporary memory.
OffsetPositive	Positive flag of Offset value.

Definition at line 23 of file Ppi.c.

◆ ConvertPointerInRanges()

VOID ConvertPointerInRanges	(	IN CONST EFI_SEC_PEI_HAND_OFF *	SecCoreData,
		IN PEI_CORE_INSTANCE *	PrivateData,
		IN OUT VOID **	Pointer
	)

Migrate Pointer in ranges of the temporary memory to PEI installed memory.

Parameters

SecCoreData	Points to a data structure containing SEC to PEI handoff data, such as the size and location of temporary RAM, the stack location and the BFV location.
PrivateData	Pointer to PeiCore's private data structure.
Pointer	Pointer to the Pointer needs to be converted.

Definition at line 53 of file Ppi.c.

◆ ConvertPpiPointers()

VOID ConvertPpiPointers	(	IN CONST EFI_SEC_PEI_HAND_OFF *	SecCoreData,
		IN PEI_CORE_INSTANCE *	PrivateData
	)

Migrate PPI Pointers from the temporary memory to PEI installed memory.

Parameters

SecCoreData	Points to a data structure containing SEC to PEI handoff data, such as the size and location of temporary RAM, the stack location and the BFV location.
PrivateData	Pointer to PeiCore's private data structure.

Definition at line 161 of file Ppi.c.

◆ ConvertPpiPointersFv()

VOID ConvertPpiPointersFv	(	IN PEI_CORE_INSTANCE *	PrivateData,
		IN UINTN	OrgFvHandle,
		IN UINTN	FvHandle,
		IN UINTN	FvSize
	)

Migrate Notify Pointers inside an FV from temporary memory to permanent memory.

Parameters

PrivateData	Pointer to PeiCore's private data structure.
OrgFvHandle	Address of FV Handle in temporary memory.
FvHandle	Address of FV Handle in permanent memory.
FvSize	Size of the FV.

Definition at line 213 of file Ppi.c.

◆ ConvertSinglePpiPointer()

VOID ConvertSinglePpiPointer	(	IN CONST EFI_SEC_PEI_HAND_OFF *	SecCoreData,
		IN PEI_CORE_INSTANCE *	PrivateData,
		IN PEI_PPI_LIST_POINTERS *	PpiPointer
	)

Migrate Single PPI Pointer from the temporary memory to PEI installed memory.

Parameters

SecCoreData	Points to a data structure containing SEC to PEI handoff data, such as the size and location of temporary RAM, the stack location and the BFV location.
PrivateData	Pointer to PeiCore's private data structure.
PpiPointer	Pointer to Ppi

Definition at line 126 of file Ppi.c.

◆ DumpPpiList()

VOID DumpPpiList ( IN PEI_CORE_INSTANCE * PrivateData )

Dumps the PPI lists to debug output.

Parameters

PrivateData Points to PeiCore's private instance data.

Definition at line 365 of file Ppi.c.

◆ InternalPeiInstallPpi()

EFI_STATUS InternalPeiInstallPpi	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_PPI_DESCRIPTOR *	PpiList,
		IN BOOLEAN	Single
	)

This function installs an interface in the PEI PPI database by GUID. The purpose of the service is to publish an interface that other parties can use to call additional PEIMs.

Parameters

PeiServices	An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
PpiList	Pointer to a list of PEI PPI Descriptors.
Single	TRUE if only single entry in the PpiList. FALSE if the PpiList is ended with an entry which has the EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST flag set in its Flags field.

Return values

EFI_SUCCESS	if all PPIs in PpiList are successfully installed.
EFI_INVALID_PARAMETER	if PpiList is NULL pointer if any PPI in PpiList is not valid
EFI_OUT_OF_RESOURCES	if there is no more memory resource to install PPI

Definition at line 449 of file Ppi.c.

◆ InternalPeiNotifyPpi()

EFI_STATUS InternalPeiNotifyPpi	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_NOTIFY_DESCRIPTOR *	NotifyList,
		IN BOOLEAN	Single
	)

This function installs a notification service to be called back when a given interface is installed or reinstalled. The purpose of the service is to publish an interface that other parties can use to call additional PPIs that may materialize later.

Parameters

PeiServices	An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
NotifyList	Pointer to list of Descriptors to notify upon.
Single	TRUE if only single entry in the NotifyList. FALSE if the NotifyList is ended with an entry which has the EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST flag set in its Flags field.

Return values

EFI_SUCCESS	if successful
EFI_OUT_OF_RESOURCES	if no space in the database
EFI_INVALID_PARAMETER	if not a good descriptor

Definition at line 731 of file Ppi.c.

◆ PeiInstallPpi()

EFI_STATUS EFIAPI PeiInstallPpi	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_PPI_DESCRIPTOR *	PpiList
	)

This function installs an interface in the PEI PPI database by GUID. The purpose of the service is to publish an interface that other parties can use to call additional PEIMs.

Parameters

PeiServices	An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
PpiList	Pointer to a list of PEI PPI Descriptors.

Return values

EFI_SUCCESS	if all PPIs in PpiList are successfully installed.
EFI_INVALID_PARAMETER	if PpiList is NULL pointer if any PPI in PpiList is not valid
EFI_OUT_OF_RESOURCES	if there is no more memory resource to install PPI

Definition at line 563 of file Ppi.c.

◆ PeiLocatePpi()

EFI_STATUS EFIAPI PeiLocatePpi	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_GUID *	Guid,
		IN UINTN	Instance,
		IN OUT EFI_PEI_PPI_DESCRIPTOR **	PpiDescriptor,
		IN OUT VOID **	Ppi
	)

Locate a given named PPI.

Parameters

PeiServices	An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
Guid	Pointer to GUID of the PPI.
Instance	Instance Number to discover.
PpiDescriptor	Pointer to reference the found descriptor. If not NULL, returns a pointer to the descriptor (includes flags, etc)
Ppi	Pointer to reference the found PPI

Return values

EFI_SUCCESS	if the PPI is in the database
EFI_NOT_FOUND	if the PPI is not in the database

Definition at line 662 of file Ppi.c.

◆ PeiNotifyPpi()

EFI_STATUS EFIAPI PeiNotifyPpi	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_NOTIFY_DESCRIPTOR *	NotifyList
	)

This function installs a notification service to be called back when a given interface is installed or reinstalled. The purpose of the service is to publish an interface that other parties can use to call additional PPIs that may materialize later.

Parameters

PeiServices	An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
NotifyList	Pointer to list of Descriptors to notify upon.

Return values

EFI_SUCCESS	if successful
EFI_OUT_OF_RESOURCES	if no space in the database
EFI_INVALID_PARAMETER	if not a good descriptor

Definition at line 874 of file Ppi.c.

◆ PeiReInstallPpi()

EFI_STATUS EFIAPI PeiReInstallPpi	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_PPI_DESCRIPTOR *	OldPpi,
		IN CONST EFI_PEI_PPI_DESCRIPTOR *	NewPpi
	)

This function reinstalls an interface in the PEI PPI database by GUID. The purpose of the service is to publish an interface that other parties can use to replace an interface of the same name in the protocol database with a different interface.

Parameters

PeiServices	An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
OldPpi	Pointer to the old PEI PPI Descriptors.
NewPpi	Pointer to the new PEI PPI Descriptors.

Return values

EFI_SUCCESS	if the operation was successful
EFI_INVALID_PARAMETER	if OldPpi or NewPpi is NULL
EFI_INVALID_PARAMETER	if NewPpi is not valid
EFI_NOT_FOUND	if the PPI was not in the database

Definition at line 590 of file Ppi.c.

◆ ProcessDispatchNotifyList()

VOID ProcessDispatchNotifyList ( IN PEI_CORE_INSTANCE * PrivateData )

Process the Notify List at dispatch level.

Parameters

PrivateData PeiCore's private data structure.

Definition at line 890 of file Ppi.c.

◆ ProcessNotify()

VOID ProcessNotify	(	IN PEI_CORE_INSTANCE *	PrivateData,
		IN UINTN	NotifyType,
		IN INTN	InstallStartIndex,
		IN INTN	InstallStopIndex,
		IN INTN	NotifyStartIndex,
		IN INTN	NotifyStopIndex
	)

Process notifications.

Parameters

PrivateData	PeiCore's private data structure
NotifyType	Type of notify to fire.
InstallStartIndex	Install Beginning index.
InstallStopIndex	Install Ending index.
NotifyStartIndex	Notify Beginning index.
NotifyStopIndex	Notify Ending index.

Definition at line 960 of file Ppi.c.

◆ ProcessPpiListFromSec()

VOID ProcessPpiListFromSec	(	IN CONST EFI_PEI_SERVICES **	PeiServices,
		IN CONST EFI_PEI_PPI_DESCRIPTOR *	PpiList
	)

Process PpiList from SEC phase.

Parameters

PeiServices	An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
PpiList	Points to a list of one or more PPI descriptors to be installed initially by the PEI core. These PPI's will be installed and/or immediately signaled if they are notification type.

Definition at line 1021 of file Ppi.c.

Functions

Detailed Description

Function Documentation

◆ ConvertPeiCorePpiPointers()

◆ ConvertPointer()

◆ ConvertPointerInRanges()

◆ ConvertPpiPointers()

◆ ConvertPpiPointersFv()

◆ ConvertSinglePpiPointer()

◆ DumpPpiList()

◆ InternalPeiInstallPpi()

◆ InternalPeiNotifyPpi()

◆ PeiInstallPpi()

◆ PeiLocatePpi()

◆ PeiNotifyPpi()

◆ PeiReInstallPpi()

◆ ProcessDispatchNotifyList()

◆ ProcessNotify()

◆ ProcessPpiListFromSec()