Data Structures
struct	_EDKII_PEI_MP_SERVICES2_PPI

Macros
#define	EDKII_PEI_MP_SERVICES2_PPI_GUID

Typedefs
typedef struct _EDKII_PEI_MP_SERVICES2_PPI	EDKII_PEI_MP_SERVICES2_PPI

typedef OUT UINTN *	NumberOfProcessors

typedef OUT UINTN OUT UINTN *	NumberOfEnabledProcessors

typedef IN UINTN	ProcessorNumber

typedef IN UINTN OUT EFI_PROCESSOR_INFORMATION *	ProcessorInfoBuffer

typedef IN EFI_AP_PROCEDURE	Procedure

typedef IN EFI_AP_PROCEDURE IN BOOLEAN	SingleThread

typedef IN EFI_AP_PROCEDURE IN BOOLEAN IN UINTN	TimeoutInMicroSeconds

typedef IN EFI_AP_PROCEDURE IN BOOLEAN IN UINTN IN VOID *	ProcedureArgument

typedef IN EFI_AP_PROCEDURE IN UINTN IN UINTN	TimeoutInMicroseconds

typedef IN UINTN IN BOOLEAN	EnableOldBSP

typedef IN UINTN IN BOOLEAN	EnableAP

typedef IN UINTN IN BOOLEAN IN UINT32 *	HealthFlag

Functions
typedef	EFI_STATUS (EFIAPI EDKII_PEI_MP_SERVICES_GET_NUMBER_OF_PROCESSORS)(IN EDKII_PEI_MP_SERVICES2_PPI This

Variables
EFI_GUID	gEdkiiPeiMpServices2PpiGuid

Detailed Description

This file declares EDKII Multi-processor service PPI.

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

Macro Definition Documentation

#define EDKII_PEI_MP_SERVICES2_PPI_GUID

Value:

{ \
    0x5cb9cb3d, 0x31a4, 0x480c, { 0x94, 0x98, 0x29, 0xd2, 0x69, 0xba, 0xcf, 0xba} \
  }

Typedef Documentation

typedef struct _EDKII_PEI_MP_SERVICES2_PPI EDKII_PEI_MP_SERVICES2_PPI

typedef IN UINTN IN BOOLEAN EnableAP

typedef IN UINTN IN BOOLEAN EnableOldBSP

typedef IN UINTN IN BOOLEAN IN UINT32* HealthFlag

typedef OUT UINTN OUT UINTN* NumberOfEnabledProcessors

typedef OUT UINTN* NumberOfProcessors

typedef IN EFI_AP_PROCEDURE Procedure

typedef IN EFI_AP_PROCEDURE IN UINTN IN VOID * ProcedureArgument

typedef IN UINTN OUT EFI_PROCESSOR_INFORMATION* ProcessorInfoBuffer

typedef OUT UINTN * ProcessorNumber

typedef IN EFI_AP_PROCEDURE IN BOOLEAN SingleThread

typedef IN EFI_AP_PROCEDURE IN UINTN TimeoutInMicroSeconds

typedef IN EFI_AP_PROCEDURE IN UINTN IN UINTN TimeoutInMicroseconds

Function Documentation

typedef EFI_STATUS ( EFIAPI * EDKII_PEI_MP_SERVICES_STARTUP_ALL_CPUS )

Get the number of CPU's.

Parameters

[in]	This	Pointer to this instance of the PPI.
[out]	NumberOfProcessors	Pointer to the total number of logical processors in the system, including the BSP and disabled APs.
[out]	NumberOfEnabledProcessors	Number of processors in the system that are enabled.

Return values

EFI_SUCCESS	The number of logical processors and enabled logical processors was retrieved.
EFI_DEVICE_ERROR	The calling processor is an AP.
EFI_INVALID_PARAMETER	NumberOfProcessors is NULL. NumberOfEnabledProcessors is NULL.

Get information on a specific CPU.

Parameters

[in]	This	Pointer to this instance of the PPI.
[in]	ProcessorNumber	Pointer to the total number of logical processors in the system, including the BSP and disabled APs.
[out]	ProcessorInfoBuffer	Number of processors in the system that are enabled.

Return values

EFI_SUCCESS	Processor information was returned.
EFI_DEVICE_ERROR	The calling processor is an AP.
EFI_INVALID_PARAMETER	ProcessorInfoBuffer is NULL.
EFI_NOT_FOUND	The processor with the handle specified by ProcessorNumber does not exist in the platform.

Activate all of the application proessors.

Parameters

[in]	This	A pointer to the EFI_PEI_MP_SERVICES_PPI instance.
[in]	Procedure	A pointer to the function to be run on enabled APs of the system.
[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]	TimeoutInMicroSeconds	Indicates the time limit in microseconds for APs to return from Procedure, for blocking mode only. 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 EFI_PEI_MP_SERVICES_PPI.StartupAllAPs() or EFI_PEI_MP_SERVICES_PPI.StartupThisAP(). If the timeout expires in blocking mode, BSP returns EFI_TIMEOUT.
[in]	ProcedureArgument	The parameter passed into Procedure for all APs.

Return values

EFI_SUCCESS	In blocking mode, all APs have finished before the timeout expired.
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_TIMEOUT	In blocking mode, the timeout expired before all enabled APs have finished.
EFI_INVALID_PARAMETER	Procedure is NULL.

Activate a specific application processor.

Parameters

[in]	This	A pointer to the EFI_PEI_MP_SERVICES_PPI instance.
[in]	Procedure	A pointer to the function to be run on enabled APs of the system.
[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 EFI_PEI_MP_SERVICES_PPI.GetNumberOfProcessors().
[in]	TimeoutInMicroSeconds	Indicates the time limit in microseconds for APs to return from Procedure, for blocking mode only. 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 EFI_PEI_MP_SERVICES_PPI.StartupAllAPs() or EFI_PEI_MP_SERVICES_PPI.StartupThisAP(). If the timeout expires in blocking mode, BSP returns EFI_TIMEOUT.
[in]	ProcedureArgument	The parameter passed into Procedure for all APs.

Return values

EFI_SUCCESS	In blocking mode, specified AP finished before the timeout expires.
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_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.

Switch the boot strap processor.

Parameters

[in]	This	A pointer to the EFI_PEI_MP_SERVICES_PPI instance.
[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 EFI_PEI_MP_SERVICES_PPI.GetNumberOfProcessors().
[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.

Enable or disable an application processor.

Parameters

[in]	This	A pointer to the EFI_PEI_MP_SERVICES_PPI instance.
[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 EFI_PEI_MP_SERVICES_PPI.GetNumberOfProcessors().
[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_PEI_MP_SERVICES_PPI.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.

Identify the currently executing processor.

Parameters

[in]	This	A pointer to the EFI_PEI_MP_SERVICES_PPI instance.
[out]	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 EFI_PEI_MP_SERVICES_PPI.GetNumberOfProcessors().

Return values

EFI_SUCCESS	The current processor handle number was returned in ProcessorNumber.
EFI_INVALID_PARAMETER	ProcessorNumber is NULL.

Activate all of the application proessors.

Parameters

[in]	This	A pointer to the EDKII_PEI_MP_SERVICES2_PPI instance.
[in]	Procedure	A pointer to the function to be run on enabled APs of the system.
[in]	TimeoutInMicroSeconds	Indicates the time limit in microseconds for APs to return from Procedure, for blocking mode only. Zero means infinity. If the timeout expires in blocking mode, BSP returns EFI_TIMEOUT.
[in]	ProcedureArgument	The parameter passed into Procedure for all CPUs.

Return values

EFI_SUCCESS	In blocking mode, all APs have finished before the timeout expired.
EFI_DEVICE_ERROR	Caller processor is AP.
EFI_NOT_READY	Any enabled APs are busy.
EFI_TIMEOUT	In blocking mode, the timeout expired before all enabled APs have finished.
EFI_INVALID_PARAMETER	Procedure is NULL.

Variable Documentation

EFI_GUID gEdkiiPeiMpServices2PpiGuid

Data Structures

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

Typedef Documentation

Function Documentation

Variable Documentation