fa7ce675b9
Due to the implementation of AcquireSpinLock() is not MP safe, so we should use AcquireSpinLockOrFail directly instead. Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Chen Fan <chen.fan.fnst@cn.fujitsu.com> Reviewed-by: Jeff Fan <jeff.fan@intel.com> git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@16357 6f19259b-4bc3-4df7-8a09-765794883524
288 lines
11 KiB
C
288 lines
11 KiB
C
/** @file
|
|
CPU DXE MP support
|
|
|
|
Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
|
|
This program and the accompanying materials
|
|
are licensed and made available under the terms and conditions of the BSD License
|
|
which accompanies this distribution. The full text of the license may be found at
|
|
http://opensource.org/licenses/bsd-license.php
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
**/
|
|
|
|
#ifndef _CPU_MP_H_
|
|
#define _CPU_MP_H_
|
|
|
|
#include <Protocol/MpService.h>
|
|
#include <Library/SynchronizationLib.h>
|
|
|
|
/**
|
|
Initialize Multi-processor support.
|
|
|
|
**/
|
|
VOID
|
|
InitializeMpSupport (
|
|
VOID
|
|
);
|
|
|
|
typedef
|
|
VOID
|
|
(EFIAPI *STACKLESS_AP_ENTRY_POINT)(
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Starts the Application Processors and directs them to jump to the
|
|
specified routine.
|
|
|
|
The processor jumps to this code in flat mode, but the processor's
|
|
stack is not initialized.
|
|
|
|
@param ApEntryPoint Pointer to the Entry Point routine
|
|
|
|
@retval EFI_SUCCESS The APs were started
|
|
@retval EFI_OUT_OF_RESOURCES Cannot allocate memory to start APs
|
|
|
|
**/
|
|
EFI_STATUS
|
|
StartApsStackless (
|
|
IN STACKLESS_AP_ENTRY_POINT ApEntryPoint
|
|
);
|
|
|
|
/**
|
|
The AP entry point that the Startup-IPI target code will jump to.
|
|
|
|
The processor jumps to this code in flat mode, but the processor's
|
|
stack is not initialized.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
AsmApEntryPoint (
|
|
VOID
|
|
);
|
|
|
|
/**
|
|
Releases the lock preventing other APs from using the shared AP
|
|
stack.
|
|
|
|
Once the AP has transitioned to using a new stack, it can call this
|
|
function to allow another AP to proceed with using the shared stack.
|
|
|
|
**/
|
|
VOID
|
|
EFIAPI
|
|
AsmApDoneWithCommonStack (
|
|
VOID
|
|
);
|
|
|
|
typedef enum {
|
|
CpuStateIdle,
|
|
CpuStateBlocked,
|
|
CpuStateReady,
|
|
CpuStateBuzy,
|
|
CpuStateFinished
|
|
} CPU_STATE;
|
|
|
|
/**
|
|
Define Individual Processor Data block.
|
|
|
|
**/
|
|
typedef struct {
|
|
EFI_PROCESSOR_INFORMATION Info;
|
|
SPIN_LOCK CpuDataLock;
|
|
volatile CPU_STATE State;
|
|
|
|
EFI_AP_PROCEDURE Procedure;
|
|
VOID *Parameter;
|
|
} CPU_DATA_BLOCK;
|
|
|
|
/**
|
|
Define MP data block which consumes individual processor block.
|
|
|
|
**/
|
|
typedef struct {
|
|
CPU_DATA_BLOCK *CpuDatas;
|
|
UINTN NumberOfProcessors;
|
|
UINTN NumberOfEnabledProcessors;
|
|
} MP_SYSTEM_DATA;
|
|
|
|
/**
|
|
This function is called by all processors (both BSP and AP) once and collects MP related data.
|
|
|
|
@param Bsp TRUE if the CPU is BSP
|
|
@param ProcessorNumber The specific processor number
|
|
|
|
@retval EFI_SUCCESS Data for the processor collected and filled in
|
|
|
|
**/
|
|
EFI_STATUS
|
|
FillInProcessorInformation (
|
|
IN BOOLEAN Bsp,
|
|
IN UINTN ProcessorNumber
|
|
);
|
|
|
|
/**
|
|
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:
|
|
- The number of logical processors that are present in the system.
|
|
- The number of enabled logical processors in the system at the instant
|
|
this call is made.
|
|
|
|
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.
|
|
|
|
@param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL
|
|
instance.
|
|
@param[out] NumberOfProcessors Pointer to the total number of logical
|
|
processors in the system, including the BSP
|
|
and disabled APs.
|
|
@param[out] NumberOfEnabledProcessors Pointer to the number of enabled logical
|
|
processors that exist in system, including
|
|
the BSP.
|
|
|
|
@retval EFI_SUCCESS The number of logical processors and enabled
|
|
logical processors was retrieved.
|
|
@retval EFI_DEVICE_ERROR The calling processor is an AP.
|
|
@retval EFI_INVALID_PARAMETER NumberOfProcessors is NULL.
|
|
@retval EFI_INVALID_PARAMETER NumberOfEnabledProcessors is NULL.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
GetNumberOfProcessors (
|
|
IN EFI_MP_SERVICES_PROTOCOL *This,
|
|
OUT UINTN *NumberOfProcessors,
|
|
OUT UINTN *NumberOfEnabledProcessors
|
|
);
|
|
|
|
/**
|
|
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:
|
|
- The processor information may change during the course of a boot session.
|
|
- The information presented here is entirely MP related.
|
|
|
|
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.
|
|
|
|
@param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL
|
|
instance.
|
|
@param[in] ProcessorNumber The handle number of processor.
|
|
@param[out] ProcessorInfoBuffer A pointer to the buffer where information for
|
|
the requested processor is deposited.
|
|
|
|
@retval EFI_SUCCESS Processor information was returned.
|
|
@retval EFI_DEVICE_ERROR The calling processor is an AP.
|
|
@retval EFI_INVALID_PARAMETER ProcessorInfoBuffer is NULL.
|
|
@retval EFI_NOT_FOUND The processor with the handle specified by
|
|
ProcessorNumber does not exist in the platform.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
GetProcessorInfo (
|
|
IN EFI_MP_SERVICES_PROTOCOL *This,
|
|
IN UINTN ProcessorNumber,
|
|
OUT EFI_PROCESSOR_INFORMATION *ProcessorInfoBuffer
|
|
);
|
|
|
|
/**
|
|
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.
|
|
|
|
@param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL instance.
|
|
@param[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().
|
|
@param[in] EnableAP Specifies the new state for the processor for
|
|
enabled, FALSE for disabled.
|
|
@param[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.
|
|
|
|
@retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
|
|
@retval EFI_UNSUPPORTED Enabling or disabling an AP cannot be completed
|
|
prior to this service returning.
|
|
@retval EFI_UNSUPPORTED Enabling or disabling an AP is not supported.
|
|
@retval EFI_DEVICE_ERROR The calling processor is an AP.
|
|
@retval EFI_NOT_FOUND Processor with the handle specified by ProcessorNumber
|
|
does not exist.
|
|
@retval EFI_INVALID_PARAMETER ProcessorNumber specifies the BSP.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
EnableDisableAP (
|
|
IN EFI_MP_SERVICES_PROTOCOL *This,
|
|
IN UINTN ProcessorNumber,
|
|
IN BOOLEAN EnableAP,
|
|
IN UINT32 *HealthFlag OPTIONAL
|
|
);
|
|
|
|
/**
|
|
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.
|
|
|
|
@param[in] This A pointer to the EFI_MP_SERVICES_PROTOCOL instance.
|
|
@param[out] 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().
|
|
|
|
@retval EFI_SUCCESS The current processor handle number was returned
|
|
in ProcessorNumber.
|
|
@retval EFI_INVALID_PARAMETER ProcessorNumber is NULL.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
WhoAmI (
|
|
IN EFI_MP_SERVICES_PROTOCOL *This,
|
|
OUT UINTN *ProcessorNumber
|
|
);
|
|
|
|
#endif // _CPU_MP_H_
|
|
|