#include "MpLib.h"
#include <Library/PeiServicesLib.h>
#include <Guid/S3SmmInitDone.h>
#include <Guid/EndOfS3Resume.h>
#include <Ppi/ShadowMicrocode.h>

Functions
VOID	EnableDebugAgent (VOID)

CPU_MP_DATA *	GetCpuMpData (VOID)

VOID	SaveCpuMpData (IN CPU_MP_DATA *CpuMpData)

BOOLEAN	CheckOverlapWithAllocatedBuffer (IN UINT64 WakeupBufferStart, IN UINT64 WakeupBufferEnd)

UINTN	GetWakeupBuffer (IN UINTN WakeupBufferSize)

UINTN	AllocateCodeBuffer (IN UINTN BufferSize)

UINTN	GetSevEsAPMemory (VOID)

VOID	CheckAndUpdateApsStatus (VOID)

VOID	BuildMicrocodeCacheHob (IN CPU_MP_DATA *CpuMpData)

EFI_STATUS EFIAPI	NotifyOnEndOfS3Resume (IN EFI_PEI_SERVICES *PeiServices, IN EFI_PEI_NOTIFY_DESCRIPTOR NotifyDesc, IN VOID *InvokePpi)

VOID	InitMpGlobalData (IN CPU_MP_DATA *CpuMpData)

EFI_STATUS EFIAPI	MpInitLibStartupAllAPs (IN EFI_AP_PROCEDURE Procedure, IN BOOLEAN SingleThread, IN EFI_EVENT WaitEvent OPTIONAL, IN UINTN TimeoutInMicroseconds, IN VOID ProcedureArgument OPTIONAL, OUT UINTN *FailedCpuList OPTIONAL)

EFI_STATUS EFIAPI	MpInitLibStartupThisAP (IN EFI_AP_PROCEDURE Procedure, IN UINTN ProcessorNumber, IN EFI_EVENT WaitEvent OPTIONAL, IN UINTN TimeoutInMicroseconds, IN VOID ProcedureArgument OPTIONAL, OUT BOOLEAN Finished OPTIONAL)

EFI_STATUS EFIAPI	MpInitLibSwitchBSP (IN UINTN ProcessorNumber, IN BOOLEAN EnableOldBSP)

EFI_STATUS EFIAPI	MpInitLibEnableDisableAP (IN UINTN ProcessorNumber, IN BOOLEAN EnableAP, IN UINT32 *HealthFlag OPTIONAL)

EFI_STATUS	PlatformShadowMicrocode (IN OUT CPU_MP_DATA *CpuMpData)

VOID	AllocateApLoopCodeBuffer (IN UINTN Pages, IN OUT EFI_PHYSICAL_ADDRESS *Address)

VOID	RemoveNxprotection (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINTN Length)

Variables
STATIC UINT64	mSevEsPeiWakeupBuffer = BASE_1MB

EFI_PEI_NOTIFY_DESCRIPTOR	mEndOfS3ResumeNotifyDesc

Detailed Description

MP initialize support functions for PEI phase.

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

Definition in file PeiMpLib.c.

Function Documentation

◆ AllocateApLoopCodeBuffer()

VOID AllocateApLoopCodeBuffer	(	IN UINTN	Pages,
		IN OUT EFI_PHYSICAL_ADDRESS *	Address
	)

Allocate buffer for ApLoopCode.

Parameters

[in]	Pages	Number of pages to allocate.
[in,out]	Address	Pointer to the allocated buffer.

Definition at line 808 of file PeiMpLib.c.

◆ AllocateCodeBuffer()

UINTN AllocateCodeBuffer ( IN UINTN BufferSize )

Get available EfiBootServicesCode memory below 4GB by specified size.

This buffer is required to safely transfer AP from real address mode to protected mode or long mode, due to the fact that the buffer returned by GetWakeupBuffer() may be marked as non-executable.

Parameters

[in] BufferSize Wakeup transition buffer size.

Return values

other	Return wakeup transition buffer address below 4GB.
0	Cannot find free memory below 4GB.

Definition at line 293 of file PeiMpLib.c.

◆ BuildMicrocodeCacheHob()

VOID BuildMicrocodeCacheHob ( IN CPU_MP_DATA * CpuMpData )

Build the microcode patch HOB that contains the base address and size of the microcode patch stored in the memory.

Parameters

[in] CpuMpData Pointer to the CPU_MP_DATA structure.

Definition at line 346 of file PeiMpLib.c.

◆ CheckAndUpdateApsStatus()

VOID CheckAndUpdateApsStatus ( VOID )

Checks APs status and updates APs status if needed.

Definition at line 332 of file PeiMpLib.c.

◆ CheckOverlapWithAllocatedBuffer()

BOOLEAN CheckOverlapWithAllocatedBuffer	(	IN UINT64	WakeupBufferStart,
		IN UINT64	WakeupBufferEnd
	)

Check if AP wakeup buffer is overlapped with existing allocated buffer.

Parameters

[in]	WakeupBufferStart	AP wakeup buffer start address.
[in]	WakeupBufferEnd	AP wakeup buffer end address.

Return values

TRUE	There is overlap.
FALSE	There is no overlap.

Definition at line 141 of file PeiMpLib.c.

◆ EnableDebugAgent()

VOID EnableDebugAgent ( VOID )

Enable Debug Agent to support source debugging on AP function.

Definition at line 22 of file PeiMpLib.c.

◆ GetCpuMpData()

CPU_MP_DATA * GetCpuMpData ( VOID )

Get pointer to CPU MP Data structure. For BSP, the pointer is retrieved from HOB. For AP, the structure is stored in the top of each AP's stack.

Returns: The pointer to CPU MP Data structure.

Definition at line 36 of file PeiMpLib.c.

◆ GetSevEsAPMemory()

UINTN GetSevEsAPMemory ( VOID )

Return the address of the SEV-ES AP jump table.

This buffer is required in order for an SEV-ES guest to transition from UEFI into an OS.

Returns: Return SEV-ES AP jump table buffer

Definition at line 317 of file PeiMpLib.c.

◆ GetWakeupBuffer()

UINTN GetWakeupBuffer ( IN UINTN WakeupBufferSize )

Get available system memory below 1MB by specified size.

Parameters

[in] WakeupBufferSize Wakeup buffer size required

Return values

other	Return wakeup buffer address below 1MB.
-1	Cannot find free memory below 1MB.

Definition at line 186 of file PeiMpLib.c.

◆ InitMpGlobalData()

VOID InitMpGlobalData ( IN CPU_MP_DATA * CpuMpData )

Initialize global data for MP support.

Parameters

[in] CpuMpData The pointer to CPU MP Data structure.

Install Notify

Definition at line 438 of file PeiMpLib.c.

◆ MpInitLibEnableDisableAP()

EFI_STATUS EFIAPI MpInitLibEnableDisableAP	(	IN UINTN	ProcessorNumber,
		IN BOOLEAN	EnableAP,
		IN UINT32 *HealthFlag	OPTIONAL
	)

This service lets the caller enable or disable an AP from this point onward. This service may only be called from the BSP.

Parameters

[in]	ProcessorNumber	The handle number of AP. The range is from 0 to the total number of logical processors minus 1. The total number of logical processors can be retrieved by MpInitLibGetNumberOfProcessors().
[in]	EnableAP	Specifies the new state for the processor for enabled, FALSE for disabled.
[in]	HealthFlag	If not NULL, a pointer to a value that specifies the new health status of the AP. This flag corresponds to StatusFlag defined in EFI_MP_SERVICES_PROTOCOL.GetProcessorInfo(). Only the PROCESSOR_HEALTH_STATUS_BIT is used. All other bits are ignored. If it is NULL, this parameter is ignored.

Return values

EFI_SUCCESS	The specified AP was enabled or disabled successfully.
EFI_UNSUPPORTED	Enabling or disabling an AP cannot be completed prior to this service returning.
EFI_UNSUPPORTED	Enabling or disabling an AP is not supported.
EFI_DEVICE_ERROR	The calling processor is an AP.
EFI_NOT_FOUND	Processor with the handle specified by ProcessorNumber does not exist.
EFI_INVALID_PARAMETER	ProcessorNumber specifies the BSP.
EFI_NOT_READY	MP Initialize Library is not initialized.

Definition at line 721 of file PeiMpLib.c.

◆ MpInitLibStartupAllAPs()

EFI_STATUS EFIAPI MpInitLibStartupAllAPs	(	IN EFI_AP_PROCEDURE	Procedure,
		IN BOOLEAN	SingleThread,
		IN EFI_EVENT WaitEvent	OPTIONAL,
		IN UINTN	TimeoutInMicroseconds,
		IN VOID *ProcedureArgument	OPTIONAL,
		OUT UINTN **FailedCpuList	OPTIONAL
	)

This service executes a caller provided function on all enabled APs.

Parameters

[in]	Procedure	A pointer to the function to be run on enabled APs of the system. See type EFI_AP_PROCEDURE.
[in]	SingleThread	If TRUE, then all the enabled APs execute the function specified by Procedure one by one, in ascending order of processor handle number. If FALSE, then all the enabled APs execute the function specified by Procedure simultaneously.
[in]	WaitEvent	The event created by the caller with CreateEvent() service. If it is NULL, then execute in blocking mode. BSP waits until all APs finish or TimeoutInMicroSeconds expires. If it's not NULL, then execute in non-blocking mode. BSP requests the function specified by Procedure to be started on all the enabled APs, and go on executing immediately. If all return from Procedure, or TimeoutInMicroSeconds expires, this event is signaled. The BSP can use the CheckEvent() or WaitForEvent() services to check the state of event. Type EFI_EVENT is defined in CreateEvent() in the Unified Extensible Firmware Interface Specification.
[in]	TimeoutInMicroseconds	Indicates the time limit in microseconds for APs to return from Procedure, either for blocking or non-blocking mode. Zero means infinity. If the timeout expires before all APs return from Procedure, then Procedure on the failed APs is terminated. All enabled APs are available for next function assigned by MpInitLibStartupAllAPs() or MPInitLibStartupThisAP(). If the timeout expires in blocking mode, BSP returns EFI_TIMEOUT. If the timeout expires in non-blocking mode, WaitEvent is signaled with SignalEvent().
[in]	ProcedureArgument	The parameter passed into Procedure for all APs.
[out]	FailedCpuList	If NULL, this parameter is ignored. Otherwise, if all APs finish successfully, then its content is set to NULL. If not all APs finish before timeout expires, then its content is set to address of the buffer holding handle numbers of the failed APs. The buffer is allocated by MP Initialization library, and it's the caller's responsibility to free the buffer with FreePool() service. In blocking mode, it is ready for consumption when the call returns. In non-blocking mode, it is ready when WaitEvent is signaled. The list of failed CPU is terminated by END_OF_CPU_LIST.

Return values

EFI_SUCCESS	In blocking mode, all APs have finished before the timeout expired.
EFI_SUCCESS	In non-blocking mode, function has been dispatched to all enabled APs.
EFI_UNSUPPORTED	A non-blocking mode request was made after the UEFI event EFI_EVENT_GROUP_READY_TO_BOOT was signaled.
EFI_UNSUPPORTED	WaitEvent is not NULL if non-blocking mode is not supported.
EFI_DEVICE_ERROR	Caller processor is AP.
EFI_NOT_STARTED	No enabled APs exist in the system.
EFI_NOT_READY	Any enabled APs are busy.
EFI_NOT_READY	MP Initialize Library is not initialized.
EFI_TIMEOUT	In blocking mode, the timeout expired before all enabled APs have finished.
EFI_INVALID_PARAMETER	Procedure is NULL.

Definition at line 533 of file PeiMpLib.c.

◆ MpInitLibStartupThisAP()

EFI_STATUS EFIAPI MpInitLibStartupThisAP	(	IN EFI_AP_PROCEDURE	Procedure,
		IN UINTN	ProcessorNumber,
		IN EFI_EVENT WaitEvent	OPTIONAL,
		IN UINTN	TimeoutInMicroseconds,
		IN VOID *ProcedureArgument	OPTIONAL,
		OUT BOOLEAN *Finished	OPTIONAL
	)

This service lets the caller get one enabled AP to execute a caller-provided function.

Parameters

[in]	Procedure	A pointer to the function to be run on the designated AP of the system. See type EFI_AP_PROCEDURE.
[in]	ProcessorNumber	The handle number of the AP. The range is from 0 to the total number of logical processors minus 1. The total number of logical processors can be retrieved by MpInitLibGetNumberOfProcessors().
[in]	WaitEvent	The event created by the caller with CreateEvent() service. If it is NULL, then execute in blocking mode. BSP waits until this AP finish or TimeoutInMicroSeconds expires. If it's not NULL, then execute in non-blocking mode. BSP requests the function specified by Procedure to be started on this AP, and go on executing immediately. If this AP return from Procedure or TimeoutInMicroSeconds expires, this event is signaled. The BSP can use the CheckEvent() or WaitForEvent() services to check the state of event. Type EFI_EVENT is defined in CreateEvent() in the Unified Extensible Firmware Interface Specification.
[in]	TimeoutInMicroseconds	Indicates the time limit in microseconds for this AP to finish this Procedure, either for blocking or non-blocking mode. Zero means infinity. If the timeout expires before this AP returns from Procedure, then Procedure on the AP is terminated. The AP is available for next function assigned by MpInitLibStartupAllAPs() or MpInitLibStartupThisAP(). If the timeout expires in blocking mode, BSP returns EFI_TIMEOUT. If the timeout expires in non-blocking mode, WaitEvent is signaled with SignalEvent().
[in]	ProcedureArgument	The parameter passed into Procedure on the specified AP.
[out]	Finished	If NULL, this parameter is ignored. In blocking mode, this parameter is ignored. In non-blocking mode, if AP returns from Procedure before the timeout expires, its content is set to TRUE. Otherwise, the value is set to FALSE. The caller can determine if the AP returned from Procedure by evaluating this value.

Return values

EFI_SUCCESS	In blocking mode, specified AP finished before the timeout expires.
EFI_SUCCESS	In non-blocking mode, the function has been dispatched to specified AP.
EFI_UNSUPPORTED	A non-blocking mode request was made after the UEFI event EFI_EVENT_GROUP_READY_TO_BOOT was signaled.
EFI_UNSUPPORTED	WaitEvent is not NULL if non-blocking mode is not supported.
EFI_DEVICE_ERROR	The calling processor is an AP.
EFI_TIMEOUT	In blocking mode, the timeout expired before the specified AP has finished.
EFI_NOT_READY	The specified AP is busy.
EFI_NOT_READY	MP Initialize Library is not initialized.
EFI_NOT_FOUND	The processor with the handle specified by ProcessorNumber does not exist.
EFI_INVALID_PARAMETER	ProcessorNumber specifies the BSP or disabled AP.
EFI_INVALID_PARAMETER	Procedure is NULL.

Definition at line 630 of file PeiMpLib.c.

◆ MpInitLibSwitchBSP()

EFI_STATUS EFIAPI MpInitLibSwitchBSP	(	IN UINTN	ProcessorNumber,
		IN BOOLEAN	EnableOldBSP
	)

This service switches the requested AP to be the BSP from that point onward. This service changes the BSP for all purposes. This call can only be performed by the current BSP.

Parameters

[in]	ProcessorNumber	The handle number of AP that is to become the new BSP. The range is from 0 to the total number of logical processors minus 1. The total number of logical processors can be retrieved by MpInitLibGetNumberOfProcessors().
[in]	EnableOldBSP	If TRUE, then the old BSP will be listed as an enabled AP. Otherwise, it will be disabled.

Return values

EFI_SUCCESS	BSP successfully switched.
EFI_UNSUPPORTED	Switching the BSP cannot be completed prior to this service returning.
EFI_UNSUPPORTED	Switching the BSP is not supported.
EFI_DEVICE_ERROR	The calling processor is an AP.
EFI_NOT_FOUND	The processor with the handle specified by ProcessorNumber does not exist.
EFI_INVALID_PARAMETER	ProcessorNumber specifies the current BSP or a disabled AP.
EFI_NOT_READY	The specified AP is busy.
EFI_NOT_READY	MP Initialize Library is not initialized.

Definition at line 681 of file PeiMpLib.c.

◆ NotifyOnEndOfS3Resume()

EFI_STATUS EFIAPI NotifyOnEndOfS3Resume	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN EFI_PEI_NOTIFY_DESCRIPTOR *	NotifyDesc,
		IN VOID *	InvokePpi
	)

S3 SMM Init Done notification function.

Parameters

PeiServices	Indirect reference to the PEI Services Table.
NotifyDesc	Address of the notification descriptor data structure.
InvokePpi	Address of the PPI that was invoked.

Return values

EFI_SUCCESS The function completes successfully.

Definition at line 403 of file PeiMpLib.c.

◆ PlatformShadowMicrocode()

EFI_STATUS PlatformShadowMicrocode ( IN OUT CPU_MP_DATA * CpuMpData )

This funtion will try to invoke platform specific microcode shadow logic to relocate microcode update patches into memory.

Parameters

[in,out] CpuMpData The pointer to CPU MP Data structure.

Return values

EFI_SUCCESS	Shadow microcode success.
EFI_OUT_OF_RESOURCES	No enough resource to complete the operation.
EFI_UNSUPPORTED	Can't find platform specific microcode shadow PPI/Protocol.

Definition at line 742 of file PeiMpLib.c.

◆ RemoveNxprotection()

VOID RemoveNxprotection	(	IN EFI_PHYSICAL_ADDRESS	BaseAddress,
		IN UINTN	Length
	)

Remove Nx protection for the range specific by BaseAddress and Length.

The PEI implementation uses CpuPageTableLib to change the attribute. The DXE implementation uses gDS to change the attribute.

Parameters

[in]	BaseAddress	BaseAddress of the range.
[in]	Length	Length of the range.

Definition at line 831 of file PeiMpLib.c.

◆ SaveCpuMpData()

VOID SaveCpuMpData ( IN CPU_MP_DATA * CpuMpData )

Save the pointer to CPU MP Data structure.

Parameters

[in] CpuMpData The pointer to CPU MP Data structure will be saved.

Definition at line 64 of file PeiMpLib.c.

Variable Documentation

◆ mEndOfS3ResumeNotifyDesc

EFI_PEI_NOTIFY_DESCRIPTOR mEndOfS3ResumeNotifyDesc

Initial value:

= {
  EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,
  &gEdkiiEndOfS3ResumeGuid,
  NotifyOnEndOfS3Resume
}

Definition at line 426 of file PeiMpLib.c.

◆ mSevEsPeiWakeupBuffer

STATIC UINT64 mSevEsPeiWakeupBuffer = BASE_1MB

Definition at line 15 of file PeiMpLib.c.

Functions

Variables

Detailed Description

Function Documentation

◆ AllocateApLoopCodeBuffer()

◆ AllocateCodeBuffer()

◆ BuildMicrocodeCacheHob()

◆ CheckAndUpdateApsStatus()

◆ CheckOverlapWithAllocatedBuffer()

◆ EnableDebugAgent()

◆ GetCpuMpData()

◆ GetSevEsAPMemory()

◆ GetWakeupBuffer()

◆ InitMpGlobalData()

◆ MpInitLibEnableDisableAP()

◆ MpInitLibStartupAllAPs()

◆ MpInitLibStartupThisAP()

◆ MpInitLibSwitchBSP()

◆ NotifyOnEndOfS3Resume()

◆ PlatformShadowMicrocode()

◆ RemoveNxprotection()

◆ SaveCpuMpData()

Variable Documentation

◆ mEndOfS3ResumeNotifyDesc

◆ mSevEsPeiWakeupBuffer