|
MdePkg[all]
1.08
|
|
MdePkg[all]
1.08
|
Data Structures | |
| struct | EFI_CPU_PHYSICAL_LOCATION |
| struct | EFI_CPU_PHYSICAL_LOCATION2 |
| union | EXTENDED_PROCESSOR_INFORMATION |
| struct | EFI_PROCESSOR_INFORMATION |
| struct | _EFI_MP_SERVICES_PROTOCOL |
Macros | |
| #define | EFI_MP_SERVICES_PROTOCOL_GUID |
| #define | CPU_V2_EXTENDED_TOPOLOGY BIT24 |
| #define | END_OF_CPU_LIST 0xffffffff |
| #define | PROCESSOR_AS_BSP_BIT 0x00000001 |
| #define | PROCESSOR_ENABLED_BIT 0x00000002 |
| #define | PROCESSOR_HEALTH_STATUS_BIT 0x00000004 |
Variables | |
| EFI_GUID | gEfiMpServiceProtocolGuid |
When installed, the MP Services Protocol produces a collection of services that are needed for MP management.
The MP Services Protocol provides a generalized way of performing following tasks:
The MP Services Protocol must be produced on any system with more than one logical processor.
The Protocol is available only during boot time.
MP Services Protocol is hardware-independent. Most of the logic of this protocol is architecturally neutral. It abstracts the multi-processor environment and status of processors, and provides interfaces to retrieve information, maintain, and dispatch.
MP Services Protocol may be consumed by ACPI module. The ACPI module may use this protocol to retrieve data that are needed for an MP platform and report them to OS. MP Services Protocol may also be used to program and configure processors, such as MTRR synchronization for memory space attributes setting in DXE Services. MP Services Protocol may be used by non-CPU DXE drivers to speed up platform boot by taking advantage of the processing capabilities of the APs, for example, using APs to help test system memory in parallel with other device initialization. Diagnostics applications may also use this protocol for multi-processor.
Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
| #define CPU_V2_EXTENDED_TOPOLOGY BIT24 |
Value used in the NumberProcessors parameter of the GetProcessorInfo function
| #define EFI_MP_SERVICES_PROTOCOL_GUID |
Global ID for the EFI_MP_SERVICES_PROTOCOL.
| #define END_OF_CPU_LIST 0xffffffff |
Terminator for a list of failed CPUs returned by StartAllAPs().
| #define PROCESSOR_AS_BSP_BIT 0x00000001 |
This bit is used in the StatusFlag field of EFI_PROCESSOR_INFORMATION and indicates whether the processor is playing the role of BSP. If the bit is 1, then the processor is BSP. Otherwise, it is AP.
| #define PROCESSOR_ENABLED_BIT 0x00000002 |
This bit is used in the StatusFlag field of EFI_PROCESSOR_INFORMATION and indicates whether the processor is enabled. If the bit is 1, then the processor is enabled. Otherwise, it is disabled.
| #define PROCESSOR_HEALTH_STATUS_BIT 0x00000004 |
This bit is used in the StatusFlag field of EFI_PROCESSOR_INFORMATION and indicates whether the processor is healthy. If the bit is 1, then the processor is healthy. Otherwise, some fault has been detected for the processor.
| typedef EFI_STATUS(EFIAPI * EFI_MP_SERVICES_ENABLEDISABLEAP)(IN EFI_MP_SERVICES_PROTOCOL *This, IN UINTN ProcessorNumber, IN BOOLEAN EnableAP, IN UINT32 *HealthFlag) |
This service lets the caller enable or disable an AP from this point onward. This service may only be called from the BSP.
This service allows the caller enable or disable an AP from this point onward. The caller can optionally specify the health status of the AP by Health. If an AP is being disabled, then the state of the disabled AP is implementation dependent. If an AP is enabled, then the implementation must guarantee that a complete initialization sequence is performed on the AP, so the AP is in a state that is compatible with an MP operating system. This service may not be supported after the UEFI Event EFI_EVENT_GROUP_READY_TO_BOOT is signaled.
If the enable or disable AP operation cannot be completed prior to the return from this service, then EFI_UNSUPPORTED must be returned.
| [in] | This | A pointer to the EFI_MP_SERVICES_PROTOCOL instance. |
| [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 EFI_MP_SERVICES_PROTOCOL.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_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. |
| 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. |
| typedef EFI_STATUS(EFIAPI * EFI_MP_SERVICES_GET_NUMBER_OF_PROCESSORS)(IN EFI_MP_SERVICES_PROTOCOL *This, OUT UINTN *NumberOfProcessors, OUT UINTN *NumberOfEnabledProcessors) |
This service 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.
This function is used to retrieve the following information:
Because MP Service Protocol provides services to enable and disable processors dynamically, the number of enabled logical processors may vary during the course of a boot session.
If this service is called from an AP, then EFI_DEVICE_ERROR is returned. If NumberOfProcessors or NumberOfEnabledProcessors is NULL, then EFI_INVALID_PARAMETER is returned. Otherwise, the total number of processors is returned in NumberOfProcessors, the number of currently enabled processor is returned in NumberOfEnabledProcessors, and EFI_SUCCESS is returned.
| [in] | This | A pointer to the EFI_MP_SERVICES_PROTOCOL instance. |
| [out] | NumberOfProcessors | Pointer to the total number of logical processors in the system, including the BSP and disabled APs. |
| [out] | NumberOfEnabledProcessors | Pointer to the number of enabled logical processors that exist in system, including the BSP. |
| 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. |
| EFI_INVALID_PARAMETER | NumberOfEnabledProcessors is NULL. |
| typedef EFI_STATUS(EFIAPI * EFI_MP_SERVICES_GET_PROCESSOR_INFO)(IN EFI_MP_SERVICES_PROTOCOL *This, IN UINTN ProcessorNumber, OUT EFI_PROCESSOR_INFORMATION *ProcessorInfoBuffer) |
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.
This service retrieves detailed MP-related information about any processor on the platform. Note the following:
Information regarding the number of caches and their sizes, frequency of operation, slot numbers is all considered platform-related information and is not provided by this service.
| [in] | This | A pointer to the EFI_MP_SERVICES_PROTOCOL instance. |
| [in] | ProcessorNumber | The handle number of processor. |
| [out] | ProcessorInfoBuffer | A pointer to the buffer where information for the requested processor is deposited. |
| 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. |
| typedef struct _EFI_MP_SERVICES_PROTOCOL EFI_MP_SERVICES_PROTOCOL |
Forward declaration for the EFI_MP_SERVICES_PROTOCOL.
| typedef EFI_STATUS(EFIAPI * EFI_MP_SERVICES_STARTUP_ALL_APS)(IN EFI_MP_SERVICES_PROTOCOL *This, IN EFI_AP_PROCEDURE Procedure, IN BOOLEAN SingleThread, IN EFI_EVENT WaitEvent, IN UINTN TimeoutInMicroSeconds, IN VOID *ProcedureArgument, OUT UINTN **FailedCpuList) |
This service executes a caller provided function on all enabled APs. APs can run either simultaneously or one at a time in sequence. This service supports both blocking and non-blocking requests. The non-blocking requests use EFI events so the BSP can detect when the APs have finished. This service may only be called from the BSP.
This function is used to dispatch all the enabled APs to the function specified by Procedure. If any enabled AP is busy, then EFI_NOT_READY is returned immediately and Procedure is not started on any AP.
If SingleThread is TRUE, all the enabled APs execute the function specified by Procedure one by one, in ascending order of processor handle number. Otherwise, all the enabled APs execute the function specified by Procedure simultaneously.
If WaitEvent is NULL, execution is in blocking mode. The BSP waits until all APs finish or TimeoutInMicroSecs expires. Otherwise, execution is in non-blocking mode, and the BSP returns from this service without waiting for APs. If a non-blocking mode is requested after the UEFI Event EFI_EVENT_GROUP_READY_TO_BOOT is signaled, then EFI_UNSUPPORTED must be returned.
If the timeout specified by TimeoutInMicroseconds expires before all APs return from Procedure, then Procedure on the failed APs is terminated. All enabled APs are always available for further calls to EFI_MP_SERVICES_PROTOCOL.StartupAllAPs() and EFI_MP_SERVICES_PROTOCOL.StartupThisAP(). If FailedCpuList is not NULL, its content points to the list of processor handle numbers in which Procedure was terminated.
Note: It is the responsibility of the consumer of the EFI_MP_SERVICES_PROTOCOL.StartupAllAPs() to make sure that the nature of the code that is executed on the BSP and the dispatched APs is well controlled. The MP Services Protocol does not guarantee that the Procedure function is MP-safe. Hence, the tasks that can be run in parallel are limited to certain independent tasks and well-controlled exclusive code. EFI services and protocols may not be called by APs unless otherwise specified.
In blocking execution mode, BSP waits until all APs finish or TimeoutInMicroSeconds expires.
In non-blocking execution mode, BSP is freed to return to the caller and then proceed to the next task without having to wait for APs. The following sequence needs to occur in a non-blocking execution mode:
| [in] | This | A pointer to the EFI_MP_SERVICES_PROTOCOL instance. |
| [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] | TimeoutInMicrosecsond | 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 EFI_MP_SERVICES_PROTOCOL.StartupAllAPs() or EFI_MP_SERVICES_PROTOCOL.StartupThisAP(). 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 Service Protocol, 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. |
| 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_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. |
| typedef EFI_STATUS(EFIAPI * EFI_MP_SERVICES_STARTUP_THIS_AP)(IN EFI_MP_SERVICES_PROTOCOL *This, IN EFI_AP_PROCEDURE Procedure, IN UINTN ProcessorNumber, IN EFI_EVENT WaitEvent, IN UINTN TimeoutInMicroseconds, IN VOID *ProcedureArgument, OUT BOOLEAN *Finished) |
This service lets the caller get one enabled AP to execute a caller-provided function. The caller can request the BSP to either wait for the completion of the AP or just proceed with the next task by using the EFI event mechanism. See EFI_MP_SERVICES_PROTOCOL.StartupAllAPs() for more details on non-blocking execution support. This service may only be called from the BSP.
This function is used to dispatch one enabled AP to the function specified by Procedure passing in the argument specified by ProcedureArgument. If WaitEvent is NULL, execution is in blocking mode. The BSP waits until the AP finishes or TimeoutInMicroSecondss expires. Otherwise, execution is in non-blocking mode. BSP proceeds to the next task without waiting for the AP. If a non-blocking mode is requested after the UEFI Event EFI_EVENT_GROUP_READY_TO_BOOT is signaled, then EFI_UNSUPPORTED must be returned.
If the timeout specified by TimeoutInMicroseconds expires before the AP returns from Procedure, then execution of Procedure by the AP is terminated. The AP is available for subsequent calls to EFI_MP_SERVICES_PROTOCOL.StartupAllAPs() and EFI_MP_SERVICES_PROTOCOL.StartupThisAP().
| [in] | This | A pointer to the EFI_MP_SERVICES_PROTOCOL instance. |
| [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 EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors(). |
| [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] | TimeoutInMicrosecsond | 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 EFI_MP_SERVICES_PROTOCOL.StartupAllAPs() or EFI_MP_SERVICES_PROTOCOL.StartupThisAP(). 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. |
| 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_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_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. |
| typedef EFI_STATUS(EFIAPI * EFI_MP_SERVICES_SWITCH_BSP)(IN EFI_MP_SERVICES_PROTOCOL *This, 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.
This service switches the requested AP to be the BSP from that point onward. This service changes the BSP for all purposes. The new BSP can take over the execution of the old BSP and continue seamlessly from where the old one left off. This service may not be supported after the UEFI Event EFI_EVENT_GROUP_READY_TO_BOOT is signaled.
If the BSP cannot be switched prior to the return from this service, then EFI_UNSUPPORTED must be returned.
| [in] | This | A pointer to the EFI_MP_SERVICES_PROTOCOL instance. |
| [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 EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors(). |
| [in] | EnableOldBSP | If TRUE, then the old BSP will be listed as an enabled AP. Otherwise, it will be disabled. |
| 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. |
| typedef EFI_STATUS(EFIAPI * EFI_MP_SERVICES_WHOAMI)(IN EFI_MP_SERVICES_PROTOCOL *This, OUT UINTN *ProcessorNumber) |
This return the handle number for the calling processor. This service may be called from the BSP and APs.
This service returns the processor handle number for the calling processor. The returned value is in the range from 0 to the total number of logical processors minus 1. The total number of logical processors can be retrieved with EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors(). This service may be called from the BSP and APs. If ProcessorNumber is NULL, then EFI_INVALID_PARAMETER is returned. Otherwise, the current processors handle number is returned in ProcessorNumber, and EFI_SUCCESS is returned.
| [in] | This | A pointer to the EFI_MP_SERVICES_PROTOCOL instance. |
| [in] | ProcessorNumber | Pointer 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 EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors(). |
| EFI_SUCCESS | The current processor handle number was returned in ProcessorNumber. |
| EFI_INVALID_PARAMETER | ProcessorNumber is NULL. |
| EFI_GUID gEfiMpServiceProtocolGuid |
1.8.6 
