TianoCore EDK2 master
MpInitLib.h File Reference

Go to the source code of this file.

Functions

EFI_STATUS EFIAPI MpInitLibInitialize (VOID)
 
EFI_STATUS EFIAPI MpInitLibGetNumberOfProcessors (OUT UINTN *NumberOfProcessors OPTIONAL, OUT UINTN *NumberOfEnabledProcessors OPTIONAL)
 
EFI_STATUS EFIAPI MpInitLibGetProcessorInfo (IN UINTN ProcessorNumber, OUT EFI_PROCESSOR_INFORMATION *ProcessorInfoBuffer, OUT EFI_HEALTH_FLAGS *HealthData OPTIONAL)
 
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 EFIAPI MpInitLibWhoAmI (OUT UINTN *ProcessorNumber)
 
EFI_STATUS EFIAPI MpInitLibStartupAllCPUs (IN EFI_AP_PROCEDURE Procedure, IN UINTN TimeoutInMicroseconds, IN VOID *ProcedureArgument OPTIONAL)
 

Detailed Description

Multiple-Processor initialization Library.

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

Definition in file MpInitLib.h.

Function Documentation

◆ 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]ProcessorNumberThe 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]EnableAPSpecifies the new state for the processor for enabled, FALSE for disabled.
[in]HealthFlagIf 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_SUCCESSThe specified AP was enabled or disabled successfully.
EFI_UNSUPPORTEDEnabling or disabling an AP cannot be completed prior to this service returning.
EFI_UNSUPPORTEDEnabling or disabling an AP is not supported.
EFI_DEVICE_ERRORThe calling processor is an AP.
EFI_NOT_FOUNDProcessor with the handle specified by ProcessorNumber does not exist.
EFI_INVALID_PARAMETERProcessorNumber specifies the BSP.
EFI_NOT_READYMP Initialize Library is not initialized.

Definition at line 947 of file DxeMpLib.c.

◆ MpInitLibGetNumberOfProcessors()

EFI_STATUS EFIAPI MpInitLibGetNumberOfProcessors ( OUT UINTN *NumberOfProcessors  OPTIONAL,
OUT UINTN *NumberOfEnabledProcessors  OPTIONAL 
)

Retrieves the number of logical processor in the platform and the number of those logical processors that are enabled on this boot. This service may only be called from the BSP.

Parameters
[out]NumberOfProcessorsPointer to the total number of logical processors in the system, including the BSP and disabled APs.
[out]NumberOfEnabledProcessorsPointer to the number of enabled logical processors that exist in system, including the BSP.
Return values
EFI_SUCCESSThe number of logical processors and enabled logical processors was retrieved.
EFI_DEVICE_ERRORThe calling processor is an AP.
EFI_INVALID_PARAMETERNumberOfProcessors is NULL and NumberOfEnabledProcessors is NULL.
EFI_NOT_READYMP Initialize Library is not initialized.

Definition at line 2391 of file MpLib.c.

◆ MpInitLibGetProcessorInfo()

EFI_STATUS EFIAPI MpInitLibGetProcessorInfo ( IN UINTN  ProcessorNumber,
OUT EFI_PROCESSOR_INFORMATION ProcessorInfoBuffer,
OUT EFI_HEALTH_FLAGS *HealthData  OPTIONAL 
)

Gets detailed MP-related information on the requested processor at the instant this call is made. This service may only be called from the BSP.

Parameters
[in]ProcessorNumberThe handle number of processor.
[out]ProcessorInfoBufferA pointer to the buffer where information for the requested processor is deposited.
[out]HealthDataReturn processor health data.
Return values
EFI_SUCCESSProcessor information was returned.
EFI_DEVICE_ERRORThe calling processor is an AP.
EFI_INVALID_PARAMETERProcessorInfoBuffer is NULL.
EFI_NOT_FOUNDThe processor with the handle specified by ProcessorNumber does not exist in the platform.
EFI_NOT_READYMP Initialize Library is not initialized.

Definition at line 2059 of file MpLib.c.

◆ MpInitLibInitialize()

EFI_STATUS EFIAPI MpInitLibInitialize ( VOID  )

MP Initialize Library initialization.

This service will allocate AP reset vector and wakeup all APs to do APs initialization.

This service must be invoked before all other MP Initialize Library service are invoked.

Return values
EFI_SUCCESSMP initialization succeeds.
OthersMP initialization fails.

Definition at line 1764 of file MpLib.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]ProcedureA pointer to the function to be run on enabled APs of the system. See type EFI_AP_PROCEDURE.
[in]SingleThreadIf 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]WaitEventThe 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]TimeoutInMicrosecondsIndicates 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]ProcedureArgumentThe parameter passed into Procedure for all APs.
[out]FailedCpuListIf 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_SUCCESSIn blocking mode, all APs have finished before the timeout expired.
EFI_SUCCESSIn non-blocking mode, function has been dispatched to all enabled APs.
EFI_UNSUPPORTEDA non-blocking mode request was made after the UEFI event EFI_EVENT_GROUP_READY_TO_BOOT was signaled.
EFI_UNSUPPORTEDWaitEvent is not NULL if non-blocking mode is not supported.
EFI_DEVICE_ERRORCaller processor is AP.
EFI_NOT_STARTEDNo enabled APs exist in the system.
EFI_NOT_READYAny enabled APs are busy.
EFI_NOT_READYMP Initialize Library is not initialized.
EFI_TIMEOUTIn blocking mode, the timeout expired before all enabled APs have finished.
EFI_INVALID_PARAMETERProcedure is NULL.

Definition at line 709 of file DxeMpLib.c.

◆ MpInitLibStartupAllCPUs()

EFI_STATUS EFIAPI MpInitLibStartupAllCPUs ( IN EFI_AP_PROCEDURE  Procedure,
IN UINTN  TimeoutInMicroseconds,
IN VOID *ProcedureArgument  OPTIONAL 
)

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

Parameters
[in]ProcedureA pointer to the function to be run on enabled APs of the system. See type EFI_AP_PROCEDURE.
[in]TimeoutInMicrosecondsIndicates the time limit in microseconds for APs to return from Procedure, either for blocking or non-blocking mode. Zero means infinity. TimeoutInMicroseconds is ignored for BSP.
[in]ProcedureArgumentThe parameter passed into Procedure for all APs.
Return values
EFI_SUCCESSIn blocking mode, all CPUs have finished before the timeout expired.
EFI_SUCCESSIn non-blocking mode, function has been dispatched to all enabled CPUs.
EFI_DEVICE_ERRORCaller processor is AP.
EFI_NOT_READYAny enabled APs are busy.
EFI_NOT_READYMP Initialize Library is not initialized.
EFI_TIMEOUTIn blocking mode, the timeout expired before all enabled APs have finished.
EFI_INVALID_PARAMETERProcedure is NULL.

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

Parameters
[in]ProcedureA pointer to the function to be run on enabled APs of the system. See type EFI_AP_PROCEDURE.
[in]TimeoutInMicrosecondsIndicates the time limit in microseconds for APs to return from Procedure, either for blocking or non-blocking mode. Zero means infinity. TimeoutInMicroseconds is ignored for BSP.
[in]ProcedureArgumentThe parameter passed into Procedure for all APs.
Return values
EFI_SUCCESSCPU have finished the procedure.
EFI_INVALID_PARAMETERProcedure is NULL.

Definition at line 2766 of file MpLib.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]ProcedureA pointer to the function to be run on the designated AP of the system. See type EFI_AP_PROCEDURE.
[in]ProcessorNumberThe 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]WaitEventThe 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]TimeoutInMicrosecondsIndicates 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]ProcedureArgumentThe parameter passed into Procedure on the specified AP.
[out]FinishedIf 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_SUCCESSIn blocking mode, specified AP finished before the timeout expires.
EFI_SUCCESSIn non-blocking mode, the function has been dispatched to specified AP.
EFI_UNSUPPORTEDA non-blocking mode request was made after the UEFI event EFI_EVENT_GROUP_READY_TO_BOOT was signaled.
EFI_UNSUPPORTEDWaitEvent is not NULL if non-blocking mode is not supported.
EFI_DEVICE_ERRORThe calling processor is an AP.
EFI_TIMEOUTIn blocking mode, the timeout expired before the specified AP has finished.
EFI_NOT_READYThe specified AP is busy.
EFI_NOT_READYMP Initialize Library is not initialized.
EFI_NOT_FOUNDThe processor with the handle specified by ProcessorNumber does not exist.
EFI_INVALID_PARAMETERProcessorNumber specifies the BSP or disabled AP.
EFI_INVALID_PARAMETERProcedure is NULL.

Definition at line 816 of file DxeMpLib.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]ProcessorNumberThe 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]EnableOldBSPIf TRUE, then the old BSP will be listed as an enabled AP. Otherwise, it will be disabled.
Return values
EFI_SUCCESSBSP successfully switched.
EFI_UNSUPPORTEDSwitching the BSP cannot be completed prior to this service returning.
EFI_UNSUPPORTEDSwitching the BSP is not supported.
EFI_DEVICE_ERRORThe calling processor is an AP.
EFI_NOT_FOUNDThe processor with the handle specified by ProcessorNumber does not exist.
EFI_INVALID_PARAMETERProcessorNumber specifies the current BSP or a disabled AP.
EFI_NOT_READYThe specified AP is busy.
EFI_NOT_READYMP Initialize Library is not initialized.

Definition at line 874 of file DxeMpLib.c.

◆ MpInitLibWhoAmI()

EFI_STATUS EFIAPI MpInitLibWhoAmI ( OUT UINTN ProcessorNumber)

This return the handle number for the calling processor. This service may be called from the BSP and APs.

Parameters
[out]ProcessorNumberPointer to 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().
Return values
EFI_SUCCESSThe current processor handle number was returned in ProcessorNumber.
EFI_INVALID_PARAMETERProcessorNumber is NULL.
EFI_NOT_READYMP Initialize Library is not initialized.

Definition at line 2354 of file MpLib.c.