[mirror_edk2.git] / UefiCpuPkg / Library / MpInitLib / MpLib.h

/** @file\r
  Common header file for MP Initialize Library.\r
\r
  Copyright (c) 2016 - 2019, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _MP_LIB_H_\r
#define _MP_LIB_H_\r
\r
#include <PiPei.h>\r
\r
#include <Register/Intel/Cpuid.h>\r
#include <Register/Intel/Msr.h>\r
#include <Register/Intel/LocalApic.h>\r
#include <Register/Intel/Microcode.h>\r
\r
#include <Library/MpInitLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/LocalApicLib.h>\r
#include <Library/CpuLib.h>\r
#include <Library/UefiCpuLib.h>\r
#include <Library/TimerLib.h>\r
#include <Library/SynchronizationLib.h>\r
#include <Library/MtrrLib.h>\r
#include <Library/HobLib.h>\r
\r
#define WAKEUP_AP_SIGNAL SIGNATURE_32 ('S', 'T', 'A', 'P')\r
\r
#define CPU_INIT_MP_LIB_HOB_GUID \\r
  { \\r
    0x58eb6a19, 0x3699, 0x4c68, { 0xa8, 0x36, 0xda, 0xcd, 0x8e, 0xdc, 0xad, 0x4a } \\r
  }\r
\r
//\r
//  The MP data for switch BSP\r
//\r
#define CPU_SWITCH_STATE_IDLE   0\r
#define CPU_SWITCH_STATE_STORED 1\r
#define CPU_SWITCH_STATE_LOADED 2\r
\r
//\r
// Default maximum number of entries to store the microcode patches information\r
//\r
#define DEFAULT_MAX_MICROCODE_PATCH_NUM 8\r
\r
//\r
// Data structure for microcode patch information\r
//\r
typedef struct {\r
  UINTN    Address;\r
  UINTN    Size;\r
  UINTN    AlignedSize;\r
} MICROCODE_PATCH_INFO;\r
\r
//\r
// CPU exchange information for switch BSP\r
//\r
typedef struct {\r
  UINT8             State;        // offset 0\r
  UINTN             StackPointer; // offset 4 / 8\r
  IA32_DESCRIPTOR   Gdtr;         // offset 8 / 16\r
  IA32_DESCRIPTOR   Idtr;         // offset 14 / 26\r
} CPU_EXCHANGE_ROLE_INFO;\r
\r
//\r
// AP loop state when APs are in idle state\r
// It's value is the same with PcdCpuApLoopMode\r
//\r
typedef enum {\r
  ApInHltLoop   = 1,\r
  ApInMwaitLoop = 2,\r
  ApInRunLoop   = 3\r
} AP_LOOP_MODE;\r
\r
//\r
// AP initialization state during APs wakeup\r
//\r
typedef enum {\r
  ApInitConfig   = 1,\r
  ApInitReconfig = 2,\r
  ApInitDone     = 3\r
} AP_INIT_STATE;\r
\r
//\r
// AP state\r
//\r
// The state transitions for an AP when it process a procedure are:\r
//  Idle ----> Ready ----> Busy ----> Idle\r
//       [BSP]       [AP]       [AP]\r
//\r
typedef enum {\r
  CpuStateIdle,\r
  CpuStateReady,\r
  CpuStateBusy,\r
  CpuStateFinished,\r
  CpuStateDisabled\r
} CPU_STATE;\r
\r
//\r
// CPU volatile registers around INIT-SIPI-SIPI\r
//\r
typedef struct {\r
  UINTN                          Cr0;\r
  UINTN                          Cr3;\r
  UINTN                          Cr4;\r
  UINTN                          Dr0;\r
  UINTN                          Dr1;\r
  UINTN                          Dr2;\r
  UINTN                          Dr3;\r
  UINTN                          Dr6;\r
  UINTN                          Dr7;\r
  IA32_DESCRIPTOR                Gdtr;\r
  IA32_DESCRIPTOR                Idtr;\r
  UINT16                         Tr;\r
} CPU_VOLATILE_REGISTERS;\r
\r
//\r
// AP related data\r
//\r
typedef struct {\r
  SPIN_LOCK                      ApLock;\r
  volatile UINT32                *StartupApSignal;\r
  volatile UINTN                 ApFunction;\r
  volatile UINTN                 ApFunctionArgument;\r
  BOOLEAN                        CpuHealthy;\r
  volatile CPU_STATE             State;\r
  CPU_VOLATILE_REGISTERS         VolatileRegisters;\r
  BOOLEAN                        Waiting;\r
  BOOLEAN                        *Finished;\r
  UINT64                         ExpectedTime;\r
  UINT64                         CurrentTime;\r
  UINT64                         TotalTime;\r
  EFI_EVENT                      WaitEvent;\r
  UINT32                         ProcessorSignature;\r
  UINT8                          PlatformId;\r
} CPU_AP_DATA;\r
\r
//\r
// Basic CPU information saved in Guided HOB.\r
// Because the contents will be shard between PEI and DXE,\r
// we need to make sure the each fields offset same in different\r
// architecture.\r
//\r
#pragma pack (1)\r
typedef struct {\r
  UINT32                         InitialApicId;\r
  UINT32                         ApicId;\r
  UINT32                         Health;\r
  UINT64                         ApTopOfStack;\r
} CPU_INFO_IN_HOB;\r
#pragma pack ()\r
\r
//\r
// AP reset code information including code address and size,\r
// this structure will be shared be C code and assembly code.\r
// It is natural aligned by design.\r
//\r
typedef struct {\r
  UINT8             *RendezvousFunnelAddress;\r
  UINTN             ModeEntryOffset;\r
  UINTN             RendezvousFunnelSize;\r
  UINT8             *RelocateApLoopFuncAddress;\r
  UINTN             RelocateApLoopFuncSize;\r
  UINTN             ModeTransitionOffset;\r
} MP_ASSEMBLY_ADDRESS_MAP;\r
\r
typedef struct _CPU_MP_DATA  CPU_MP_DATA;\r
\r
#pragma pack(1)\r
\r
//\r
// MP CPU exchange information for AP reset code\r
// This structure is required to be packed because fixed field offsets\r
// into this structure are used in assembly code in this module\r
//\r
typedef struct {\r
  UINTN                 Lock;\r
  UINTN                 StackStart;\r
  UINTN                 StackSize;\r
  UINTN                 CFunction;\r
  IA32_DESCRIPTOR       GdtrProfile;\r
  IA32_DESCRIPTOR       IdtrProfile;\r
  UINTN                 BufferStart;\r
  UINTN                 ModeOffset;\r
  UINTN                 ApIndex;\r
  UINTN                 CodeSegment;\r
  UINTN                 DataSegment;\r
  UINTN                 EnableExecuteDisable;\r
  UINTN                 Cr3;\r
  UINTN                 InitFlag;\r
  CPU_INFO_IN_HOB       *CpuInfo;\r
  UINTN                 NumApsExecuting;\r
  CPU_MP_DATA           *CpuMpData;\r
  UINTN                 InitializeFloatingPointUnitsAddress;\r
  UINT32                ModeTransitionMemory;\r
  UINT16                ModeTransitionSegment;\r
  UINT32                ModeHighMemory;\r
  UINT16                ModeHighSegment;\r
  //\r
  // Enable5LevelPaging indicates whether 5-level paging is enabled in long mode.\r
  //\r
  BOOLEAN               Enable5LevelPaging;\r
} MP_CPU_EXCHANGE_INFO;\r
\r
#pragma pack()\r
\r
//\r
// CPU MP Data save in memory\r
//\r
struct _CPU_MP_DATA {\r
  UINT64                         CpuInfoInHob;\r
  UINT32                         CpuCount;\r
  UINT32                         BspNumber;\r
  //\r
  // The above fields data will be passed from PEI to DXE\r
  // Please make sure the fields offset same in the different\r
  // architecture.\r
  //\r
  SPIN_LOCK                      MpLock;\r
  UINTN                          Buffer;\r
  UINTN                          CpuApStackSize;\r
  MP_ASSEMBLY_ADDRESS_MAP        AddressMap;\r
  UINTN                          WakeupBuffer;\r
  UINTN                          WakeupBufferHigh;\r
  UINTN                          BackupBuffer;\r
  UINTN                          BackupBufferSize;\r
\r
  volatile UINT32                FinishedCount;\r
  UINT32                         RunningCount;\r
  BOOLEAN                        SingleThread;\r
  EFI_AP_PROCEDURE               Procedure;\r
  VOID                           *ProcArguments;\r
  BOOLEAN                        *Finished;\r
  UINT64                         ExpectedTime;\r
  UINT64                         CurrentTime;\r
  UINT64                         TotalTime;\r
  EFI_EVENT                      WaitEvent;\r
  UINTN                          **FailedCpuList;\r
\r
  AP_INIT_STATE                  InitFlag;\r
  BOOLEAN                        SwitchBspFlag;\r
  UINTN                          NewBspNumber;\r
  CPU_EXCHANGE_ROLE_INFO         BSPInfo;\r
  CPU_EXCHANGE_ROLE_INFO         APInfo;\r
  MTRR_SETTINGS                  MtrrTable;\r
  UINT8                          ApLoopMode;\r
  UINT8                          ApTargetCState;\r
  UINT16                         PmCodeSegment;\r
  CPU_AP_DATA                    *CpuData;\r
  volatile MP_CPU_EXCHANGE_INFO  *MpCpuExchangeInfo;\r
\r
  UINT32                         CurrentTimerCount;\r
  UINTN                          DivideValue;\r
  UINT8                          Vector;\r
  BOOLEAN                        PeriodicMode;\r
  BOOLEAN                        TimerInterruptState;\r
  UINT64                         MicrocodePatchAddress;\r
  UINT64                         MicrocodePatchRegionSize;\r
\r
  UINT32                         ProcessorSignature;\r
  UINT32                         ProcessorFlags;\r
  UINT64                         MicrocodeDataAddress;\r
  UINT32                         MicrocodeRevision;\r
\r
  //\r
  // Whether need to use Init-Sipi-Sipi to wake up the APs.\r
  // Two cases need to set this value to TRUE. One is in HLT\r
  // loop mode, the other is resume from S3 which loop mode\r
  // will be hardcode change to HLT mode by PiSmmCpuDxeSmm\r
  // driver.\r
  //\r
  BOOLEAN                        WakeUpByInitSipiSipi;\r
};\r
\r
extern EFI_GUID mCpuInitMpLibHobGuid;\r
\r
/**\r
  Assembly code to place AP into safe loop mode.\r
\r
  Place AP into targeted C-State if MONITOR is supported, otherwise\r
  place AP into hlt state.\r
  Place AP in protected mode if the current is long mode. Due to AP maybe\r
  wakeup by some hardware event. It could avoid accessing page table that\r
  may not available during booting to OS.\r
\r
  @param[in] MwaitSupport    TRUE indicates MONITOR is supported.\r
                             FALSE indicates MONITOR is not supported.\r
  @param[in] ApTargetCState  Target C-State value.\r
  @param[in] PmCodeSegment   Protected mode code segment value.\r
**/\r
typedef\r
VOID\r
(EFIAPI * ASM_RELOCATE_AP_LOOP) (\r
  IN BOOLEAN                 MwaitSupport,\r
  IN UINTN                   ApTargetCState,\r
  IN UINTN                   PmCodeSegment,\r
  IN UINTN                   TopOfApStack,\r
  IN UINTN                   NumberToFinish\r
  );\r
\r
/**\r
  Assembly code to get starting address and size of the rendezvous entry for APs.\r
  Information for fixing a jump instruction in the code is also returned.\r
\r
  @param[out] AddressMap  Output buffer for address map information.\r
**/\r
VOID\r
EFIAPI\r
AsmGetAddressMap (\r
  OUT MP_ASSEMBLY_ADDRESS_MAP    *AddressMap\r
  );\r
\r
/**\r
  This function is called by both the BSP and the AP which is to become the BSP to\r
  Exchange execution context including stack between them. After return from this\r
  function, the BSP becomes AP and the AP becomes the BSP.\r
\r
  @param[in] MyInfo      Pointer to buffer holding the exchanging information for the executing processor.\r
  @param[in] OthersInfo  Pointer to buffer holding the exchanging information for the peer.\r
\r
**/\r
VOID\r
EFIAPI\r
AsmExchangeRole (\r
  IN CPU_EXCHANGE_ROLE_INFO    *MyInfo,\r
  IN CPU_EXCHANGE_ROLE_INFO    *OthersInfo\r
  );\r
\r
/**\r
  Get the pointer to CPU MP Data structure.\r
\r
  @return  The pointer to CPU MP Data structure.\r
**/\r
CPU_MP_DATA *\r
GetCpuMpData (\r
  VOID\r
  );\r
\r
/**\r
  Save the pointer to CPU MP Data structure.\r
\r
  @param[in] CpuMpData  The pointer to CPU MP Data structure will be saved.\r
**/\r
VOID\r
SaveCpuMpData (\r
  IN CPU_MP_DATA   *CpuMpData\r
  );\r
\r
\r
/**\r
  Get available system memory below 1MB by specified size.\r
\r
  @param[in] WakeupBufferSize   Wakeup buffer size required\r
\r
  @retval other   Return wakeup buffer address below 1MB.\r
  @retval -1      Cannot find free memory below 1MB.\r
**/\r
UINTN\r
GetWakeupBuffer (\r
  IN UINTN                WakeupBufferSize\r
  );\r
\r
/**\r
  Get available EfiBootServicesCode memory below 4GB by specified size.\r
\r
  This buffer is required to safely transfer AP from real address mode to\r
  protected mode or long mode, due to the fact that the buffer returned by\r
  GetWakeupBuffer() may be marked as non-executable.\r
\r
  @param[in] BufferSize   Wakeup transition buffer size.\r
\r
  @retval other   Return wakeup transition buffer address below 4GB.\r
  @retval 0       Cannot find free memory below 4GB.\r
**/\r
UINTN\r
GetModeTransitionBuffer (\r
  IN UINTN                BufferSize\r
  );\r
\r
/**\r
  This function will be called by BSP to wakeup AP.\r
\r
  @param[in] CpuMpData          Pointer to CPU MP Data\r
  @param[in] Broadcast          TRUE:  Send broadcast IPI to all APs\r
                                FALSE: Send IPI to AP by ApicId\r
  @param[in] ProcessorNumber    The handle number of specified processor\r
  @param[in] Procedure          The function to be invoked by AP\r
  @param[in] ProcedureArgument  The argument to be passed into AP function\r
  @param[in] WakeUpDisabledAps  Whether need to wake up disabled APs in broadcast mode.\r
**/\r
VOID\r
WakeUpAP (\r
  IN CPU_MP_DATA               *CpuMpData,\r
  IN BOOLEAN                   Broadcast,\r
  IN UINTN                     ProcessorNumber,\r
  IN EFI_AP_PROCEDURE          Procedure,              OPTIONAL\r
  IN VOID                      *ProcedureArgument,     OPTIONAL\r
  IN BOOLEAN                   WakeUpDisabledAps       OPTIONAL\r
  );\r
\r
/**\r
  Initialize global data for MP support.\r
\r
  @param[in] CpuMpData  The pointer to CPU MP Data structure.\r
**/\r
VOID\r
InitMpGlobalData (\r
  IN CPU_MP_DATA               *CpuMpData\r
  );\r
\r
/**\r
  Worker function to execute a caller provided function on all enabled APs.\r
\r
  @param[in]  Procedure               A pointer to the function to be run on\r
                                      enabled APs of the system.\r
  @param[in]  SingleThread            If TRUE, then all the enabled APs execute\r
                                      the function specified by Procedure one by\r
                                      one, in ascending order of processor handle\r
                                      number.  If FALSE, then all the enabled APs\r
                                      execute the function specified by Procedure\r
                                      simultaneously.\r
  @param[in]  ExcludeBsp              Whether let BSP also trig this task.\r
  @param[in]  WaitEvent               The event created by the caller with CreateEvent()\r
                                      service.\r
  @param[in]  TimeoutInMicroseconds   Indicates the time limit in microseconds for\r
                                      APs to return from Procedure, either for\r
                                      blocking or non-blocking mode.\r
  @param[in]  ProcedureArgument       The parameter passed into Procedure for\r
                                      all APs.\r
  @param[out] FailedCpuList           If all APs finish successfully, then its\r
                                      content is set to NULL. If not all APs\r
                                      finish before timeout expires, then its\r
                                      content is set to address of the buffer\r
                                      holding handle numbers of the failed APs.\r
\r
  @retval EFI_SUCCESS             In blocking mode, all APs have finished before\r
                                  the timeout expired.\r
  @retval EFI_SUCCESS             In non-blocking mode, function has been dispatched\r
                                  to all enabled APs.\r
  @retval others                  Failed to Startup all APs.\r
\r
**/\r
EFI_STATUS\r
StartupAllCPUsWorker (\r
  IN  EFI_AP_PROCEDURE          Procedure,\r
  IN  BOOLEAN                   SingleThread,\r
  IN  BOOLEAN                   ExcludeBsp,\r
  IN  EFI_EVENT                 WaitEvent               OPTIONAL,\r
  IN  UINTN                     TimeoutInMicroseconds,\r
  IN  VOID                      *ProcedureArgument      OPTIONAL,\r
  OUT UINTN                     **FailedCpuList         OPTIONAL\r
  );\r
\r
/**\r
  Worker function to let the caller get one enabled AP to execute a caller-provided\r
  function.\r
\r
  @param[in]  Procedure               A pointer to the function to be run on\r
                                      enabled APs of the system.\r
  @param[in]  ProcessorNumber         The handle number of the AP.\r
  @param[in]  WaitEvent               The event created by the caller with CreateEvent()\r
                                      service.\r
  @param[in]  TimeoutInMicroseconds   Indicates the time limit in microseconds for\r
                                      APs to return from Procedure, either for\r
                                      blocking or non-blocking mode.\r
  @param[in]  ProcedureArgument       The parameter passed into Procedure for\r
                                      all APs.\r
  @param[out] Finished                If AP returns from Procedure before the\r
                                      timeout expires, its content is set to TRUE.\r
                                      Otherwise, the value is set to FALSE.\r
\r
  @retval EFI_SUCCESS             In blocking mode, specified AP finished before\r
                                  the timeout expires.\r
  @retval others                  Failed to Startup AP.\r
\r
**/\r
EFI_STATUS\r
StartupThisAPWorker (\r
  IN  EFI_AP_PROCEDURE          Procedure,\r
  IN  UINTN                     ProcessorNumber,\r
  IN  EFI_EVENT                 WaitEvent               OPTIONAL,\r
  IN  UINTN                     TimeoutInMicroseconds,\r
  IN  VOID                      *ProcedureArgument      OPTIONAL,\r
  OUT BOOLEAN                   *Finished               OPTIONAL\r
  );\r
\r
/**\r
  Worker function to switch the requested AP to be the BSP from that point onward.\r
\r
  @param[in] ProcessorNumber   The handle number of AP that is to become the new BSP.\r
  @param[in] EnableOldBSP      If TRUE, then the old BSP will be listed as an\r
                               enabled AP. Otherwise, it will be disabled.\r
\r
  @retval EFI_SUCCESS          BSP successfully switched.\r
  @retval others               Failed to switch BSP.\r
\r
**/\r
EFI_STATUS\r
SwitchBSPWorker (\r
  IN UINTN                     ProcessorNumber,\r
  IN BOOLEAN                   EnableOldBSP\r
  );\r
\r
/**\r
  Worker function to let the caller enable or disable an AP from this point onward.\r
  This service may only be called from the BSP.\r
\r
  @param[in] ProcessorNumber   The handle number of AP.\r
  @param[in] EnableAP          Specifies the new state for the processor for\r
                               enabled, FALSE for disabled.\r
  @param[in] HealthFlag        If not NULL, a pointer to a value that specifies\r
                               the new health status of the AP.\r
\r
  @retval EFI_SUCCESS          The specified AP was enabled or disabled successfully.\r
  @retval others               Failed to Enable/Disable AP.\r
\r
**/\r
EFI_STATUS\r
EnableDisableApWorker (\r
  IN  UINTN                     ProcessorNumber,\r
  IN  BOOLEAN                   EnableAP,\r
  IN  UINT32                    *HealthFlag OPTIONAL\r
  );\r
\r
/**\r
  Get pointer to CPU MP Data structure from GUIDed HOB.\r
\r
  @return  The pointer to CPU MP Data structure.\r
**/\r
CPU_MP_DATA *\r
GetCpuMpDataFromGuidedHob (\r
  VOID\r
  );\r
\r
/** Checks status of specified AP.\r
\r
  This function checks whether the specified AP has finished the task assigned\r
  by StartupThisAP(), and whether timeout expires.\r
\r
  @param[in]  ProcessorNumber       The handle number of processor.\r
\r
  @retval EFI_SUCCESS           Specified AP has finished task assigned by StartupThisAPs().\r
  @retval EFI_TIMEOUT           The timeout expires.\r
  @retval EFI_NOT_READY         Specified AP has not finished task and timeout has not expired.\r
**/\r
EFI_STATUS\r
CheckThisAP (\r
  IN UINTN        ProcessorNumber\r
  );\r
\r
/**\r
  Checks status of all APs.\r
\r
  This function checks whether all APs have finished task assigned by StartupAllAPs(),\r
  and whether timeout expires.\r
\r
  @retval EFI_SUCCESS           All APs have finished task assigned by StartupAllAPs().\r
  @retval EFI_TIMEOUT           The timeout expires.\r
  @retval EFI_NOT_READY         APs have not finished task and timeout has not expired.\r
**/\r
EFI_STATUS\r
CheckAllAPs (\r
  VOID\r
  );\r
\r
/**\r
  Checks APs status and updates APs status if needed.\r
\r
**/\r
VOID\r
CheckAndUpdateApsStatus (\r
  VOID\r
  );\r
\r
/**\r
  Detect whether specified processor can find matching microcode patch and load it.\r
\r
  @param[in]  CpuMpData    The pointer to CPU MP Data structure.\r
  @param[in]  IsBspCallIn  Indicate whether the caller is BSP or not.\r
**/\r
VOID\r
MicrocodeDetect (\r
  IN CPU_MP_DATA             *CpuMpData,\r
  IN BOOLEAN                 IsBspCallIn\r
  );\r
\r
/**\r
  Load the required microcode patches data into memory.\r
\r
  @param[in, out]  CpuMpData    The pointer to CPU MP Data structure.\r
**/\r
VOID\r
LoadMicrocodePatch (\r
  IN OUT CPU_MP_DATA             *CpuMpData\r
  );\r
\r
/**\r
  Detect whether Mwait-monitor feature is supported.\r
\r
  @retval TRUE    Mwait-monitor feature is supported.\r
  @retval FALSE   Mwait-monitor feature is not supported.\r
**/\r
BOOLEAN\r
IsMwaitSupport (\r
  VOID\r
  );\r
\r
/**\r
  Enable Debug Agent to support source debugging on AP function.\r
\r
**/\r
VOID\r
EnableDebugAgent (\r
  VOID\r
  );\r
\r
#endif\r
\r
Commit	Line	Data
3e8ad6bd JF	1	/** @file\r
	2	Common header file for MP Initialize Library.\r
	3	\r
ee0c39fa	4	Copyright (c) 2016 - 2019, Intel Corporation. All rights reserved.<BR>\r
0acd8697	5	SPDX-License-Identifier: BSD-2-Clause-Patent\r
3e8ad6bd JF	6	\r
	7	**/\r
	8	\r
	9	#ifndef _MP_LIB_H_\r
	10	#define _MP_LIB_H_\r
	11	\r
	12	#include <PiPei.h>\r
	13	\r
01acb06c RN	14	#include <Register/Intel/Cpuid.h>\r
	15	#include <Register/Intel/Msr.h>\r
	16	#include <Register/Intel/LocalApic.h>\r
	17	#include <Register/Intel/Microcode.h>\r
3e8ad6bd JF	18	\r
	19	#include <Library/MpInitLib.h>\r
	20	#include <Library/BaseLib.h>\r
	21	#include <Library/BaseMemoryLib.h>\r
	22	#include <Library/MemoryAllocationLib.h>\r
	23	#include <Library/DebugLib.h>\r
	24	#include <Library/LocalApicLib.h>\r
	25	#include <Library/CpuLib.h>\r
	26	#include <Library/UefiCpuLib.h>\r
	27	#include <Library/TimerLib.h>\r
	28	#include <Library/SynchronizationLib.h>\r
	29	#include <Library/MtrrLib.h>\r
	30	#include <Library/HobLib.h>\r
	31	\r
b8b04307 JF	32	#define WAKEUP_AP_SIGNAL SIGNATURE_32 ('S', 'T', 'A', 'P')\r
b8b04307 JF	33	\r
93ca4c0f JF	34	#define CPU_INIT_MP_LIB_HOB_GUID \\r
	35	{ \\r
	36	0x58eb6a19, 0x3699, 0x4c68, { 0xa8, 0x36, 0xda, 0xcd, 0x8e, 0xdc, 0xad, 0x4a } \\r
	37	}\r
	38	\r
41be0da5 JF	39	//\r
	40	// The MP data for switch BSP\r
	41	//\r
	42	#define CPU_SWITCH_STATE_IDLE 0\r
	43	#define CPU_SWITCH_STATE_STORED 1\r
	44	#define CPU_SWITCH_STATE_LOADED 2\r
	45	\r
d786a172 HW	46	//\r
	47	// Default maximum number of entries to store the microcode patches information\r
	48	//\r
	49	#define DEFAULT_MAX_MICROCODE_PATCH_NUM 8\r
	50	\r
	51	//\r
	52	// Data structure for microcode patch information\r
	53	//\r
	54	typedef struct {\r
	55	UINTN Address;\r
	56	UINTN Size;\r
	57	UINTN AlignedSize;\r
	58	} MICROCODE_PATCH_INFO;\r
	59	\r
41be0da5 JF	60	//\r
	61	// CPU exchange information for switch BSP\r
	62	//\r
	63	typedef struct {\r
	64	UINT8 State; // offset 0\r
	65	UINTN StackPointer; // offset 4 / 8\r
	66	IA32_DESCRIPTOR Gdtr; // offset 8 / 16\r
	67	IA32_DESCRIPTOR Idtr; // offset 14 / 26\r
	68	} CPU_EXCHANGE_ROLE_INFO;\r
	69	\r
9ebcf0f4 JF	70	//\r
	71	// AP loop state when APs are in idle state\r
	72	// It's value is the same with PcdCpuApLoopMode\r
	73	//\r
	74	typedef enum {\r
	75	ApInHltLoop = 1,\r
	76	ApInMwaitLoop = 2,\r
	77	ApInRunLoop = 3\r
	78	} AP_LOOP_MODE;\r
	79	\r
e59f8f6b JF	80	//\r
	81	// AP initialization state during APs wakeup\r
	82	//\r
	83	typedef enum {\r
	84	ApInitConfig = 1,\r
	85	ApInitReconfig = 2,\r
	86	ApInitDone = 3\r
	87	} AP_INIT_STATE;\r
	88	\r
03a1a925 JF	89	//\r
	90	// AP state\r
	91	//\r
2a5997f8 ED	92	// The state transitions for an AP when it process a procedure are:\r
	93	// Idle ----> Ready ----> Busy ----> Idle\r
	94	// [BSP] [AP] [AP]\r
	95	//\r
03a1a925 JF	96	typedef enum {\r
	97	CpuStateIdle,\r
	98	CpuStateReady,\r
	99	CpuStateBusy,\r
e048ce88	100	CpuStateFinished,\r
03a1a925 JF	101	CpuStateDisabled\r
	102	} CPU_STATE;\r
	103	\r
68cb9330 JF	104	//\r
	105	// CPU volatile registers around INIT-SIPI-SIPI\r
	106	//\r
	107	typedef struct {\r
	108	UINTN Cr0;\r
	109	UINTN Cr3;\r
	110	UINTN Cr4;\r
	111	UINTN Dr0;\r
	112	UINTN Dr1;\r
	113	UINTN Dr2;\r
	114	UINTN Dr3;\r
	115	UINTN Dr6;\r
	116	UINTN Dr7;\r
e9415e48 JW	117	IA32_DESCRIPTOR Gdtr;\r
	118	IA32_DESCRIPTOR Idtr;\r
	119	UINT16 Tr;\r
68cb9330 JF	120	} CPU_VOLATILE_REGISTERS;\r
68cb9330 JF	121	\r
e59f8f6b JF	122	//\r
	123	// AP related data\r
	124	//\r
	125	typedef struct {\r
	126	SPIN_LOCK ApLock;\r
	127	volatile UINT32 *StartupApSignal;\r
	128	volatile UINTN ApFunction;\r
	129	volatile UINTN ApFunctionArgument;\r
e59f8f6b	130	BOOLEAN CpuHealthy;\r
03a1a925	131	volatile CPU_STATE State;\r
68cb9330	132	CPU_VOLATILE_REGISTERS VolatileRegisters;\r
e59f8f6b JF	133	BOOLEAN Waiting;\r
	134	BOOLEAN *Finished;\r
	135	UINT64 ExpectedTime;\r
	136	UINT64 CurrentTime;\r
	137	UINT64 TotalTime;\r
	138	EFI_EVENT WaitEvent;\r
999463c8 HW	139	UINT32 ProcessorSignature;\r
999463c8 HW	140	UINT8 PlatformId;\r
e59f8f6b JF	141	} CPU_AP_DATA;\r
	142	\r
	143	//\r
	144	// Basic CPU information saved in Guided HOB.\r
	145	// Because the contents will be shard between PEI and DXE,\r
	146	// we need to make sure the each fields offset same in different\r
	147	// architecture.\r
	148	//\r
dd3fa0cd	149	#pragma pack (1)\r
e59f8f6b JF	150	typedef struct {\r
	151	UINT32 InitialApicId;\r
	152	UINT32 ApicId;\r
	153	UINT32 Health;\r
dd3fa0cd	154	UINT64 ApTopOfStack;\r
e59f8f6b	155	} CPU_INFO_IN_HOB;\r
dd3fa0cd	156	#pragma pack ()\r
e59f8f6b	157	\r
f7f85d83 JF	158	//\r
	159	// AP reset code information including code address and size,\r
	160	// this structure will be shared be C code and assembly code.\r
	161	// It is natural aligned by design.\r
	162	//\r
	163	typedef struct {\r
	164	UINT8 *RendezvousFunnelAddress;\r
	165	UINTN ModeEntryOffset;\r
	166	UINTN RendezvousFunnelSize;\r
	167	UINT8 *RelocateApLoopFuncAddress;\r
	168	UINTN RelocateApLoopFuncSize;\r
f32bfe6d	169	UINTN ModeTransitionOffset;\r
f7f85d83	170	} MP_ASSEMBLY_ADDRESS_MAP;\r
3e8ad6bd	171	\r
e59f8f6b JF	172	typedef struct _CPU_MP_DATA CPU_MP_DATA;\r
e59f8f6b JF	173	\r
d94e5f67 JF	174	#pragma pack(1)\r
	175	\r
	176	//\r
	177	// MP CPU exchange information for AP reset code\r
	178	// This structure is required to be packed because fixed field offsets\r
	179	// into this structure are used in assembly code in this module\r
	180	//\r
	181	typedef struct {\r
	182	UINTN Lock;\r
	183	UINTN StackStart;\r
	184	UINTN StackSize;\r
	185	UINTN CFunction;\r
	186	IA32_DESCRIPTOR GdtrProfile;\r
	187	IA32_DESCRIPTOR IdtrProfile;\r
	188	UINTN BufferStart;\r
	189	UINTN ModeOffset;\r
37676b9f	190	UINTN ApIndex;\r
d94e5f67 JF	191	UINTN CodeSegment;\r
d94e5f67 JF	192	UINTN DataSegment;\r
5c66d125	193	UINTN EnableExecuteDisable;\r
d94e5f67	194	UINTN Cr3;\r
46d4b885 JF	195	UINTN InitFlag;\r
46d4b885 JF	196	CPU_INFO_IN_HOB *CpuInfo;\r
0594ec41	197	UINTN NumApsExecuting;\r
e59f8f6b	198	CPU_MP_DATA *CpuMpData;\r
3b2928b4	199	UINTN InitializeFloatingPointUnitsAddress;\r
f32bfe6d JW	200	UINT32 ModeTransitionMemory;\r
	201	UINT16 ModeTransitionSegment;\r
	202	UINT32 ModeHighMemory;\r
	203	UINT16 ModeHighSegment;\r
09f69a87 RN	204	//\r
	205	// Enable5LevelPaging indicates whether 5-level paging is enabled in long mode.\r
	206	//\r
	207	BOOLEAN Enable5LevelPaging;\r
d94e5f67 JF	208	} MP_CPU_EXCHANGE_INFO;\r
	209	\r
	210	#pragma pack()\r
e59f8f6b JF	211	\r
	212	//\r
	213	// CPU MP Data save in memory\r
	214	//\r
	215	struct _CPU_MP_DATA {\r
	216	UINT64 CpuInfoInHob;\r
	217	UINT32 CpuCount;\r
	218	UINT32 BspNumber;\r
	219	//\r
	220	// The above fields data will be passed from PEI to DXE\r
	221	// Please make sure the fields offset same in the different\r
	222	// architecture.\r
	223	//\r
	224	SPIN_LOCK MpLock;\r
	225	UINTN Buffer;\r
	226	UINTN CpuApStackSize;\r
	227	MP_ASSEMBLY_ADDRESS_MAP AddressMap;\r
	228	UINTN WakeupBuffer;\r
66833b2a	229	UINTN WakeupBufferHigh;\r
e59f8f6b JF	230	UINTN BackupBuffer;\r
e59f8f6b JF	231	UINTN BackupBufferSize;\r
e59f8f6b	232	\r
e59f8f6b	233	volatile UINT32 FinishedCount;\r
2da3e96c	234	UINT32 RunningCount;\r
e59f8f6b JF	235	BOOLEAN SingleThread;\r
	236	EFI_AP_PROCEDURE Procedure;\r
	237	VOID *ProcArguments;\r
	238	BOOLEAN *Finished;\r
	239	UINT64 ExpectedTime;\r
	240	UINT64 CurrentTime;\r
	241	UINT64 TotalTime;\r
	242	EFI_EVENT WaitEvent;\r
	243	UINTN **FailedCpuList;\r
	244	\r
	245	AP_INIT_STATE InitFlag;\r
41be0da5	246	BOOLEAN SwitchBspFlag;\r
b3775af2	247	UINTN NewBspNumber;\r
41be0da5 JF	248	CPU_EXCHANGE_ROLE_INFO BSPInfo;\r
41be0da5 JF	249	CPU_EXCHANGE_ROLE_INFO APInfo;\r
e59f8f6b JF	250	MTRR_SETTINGS MtrrTable;\r
	251	UINT8 ApLoopMode;\r
	252	UINT8 ApTargetCState;\r
	253	UINT16 PmCodeSegment;\r
	254	CPU_AP_DATA *CpuData;\r
	255	volatile MP_CPU_EXCHANGE_INFO *MpCpuExchangeInfo;\r
ffab2442 JF	256	\r
	257	UINT32 CurrentTimerCount;\r
	258	UINTN DivideValue;\r
	259	UINT8 Vector;\r
	260	BOOLEAN PeriodicMode;\r
	261	BOOLEAN TimerInterruptState;\r
1e3f7a37 ED	262	UINT64 MicrocodePatchAddress;\r
1e3f7a37 ED	263	UINT64 MicrocodePatchRegionSize;\r
2a089134 ED	264	\r
	265	UINT32 ProcessorSignature;\r
	266	UINT32 ProcessorFlags;\r
	267	UINT64 MicrocodeDataAddress;\r
	268	UINT32 MicrocodeRevision;\r
58942277 ED	269	\r
	270	//\r
	271	// Whether need to use Init-Sipi-Sipi to wake up the APs.\r
	272	// Two cases need to set this value to TRUE. One is in HLT\r
	273	// loop mode, the other is resume from S3 which loop mode\r
e23d9c3e	274	// will be hardcode change to HLT mode by PiSmmCpuDxeSmm\r
58942277 ED	275	// driver.\r
	276	//\r
	277	BOOLEAN WakeUpByInitSipiSipi;\r
e59f8f6b	278	};\r
93ca4c0f JF	279	\r
	280	extern EFI_GUID mCpuInitMpLibHobGuid;\r
	281	\r
76157021 JF	282	/**\r
	283	Assembly code to place AP into safe loop mode.\r
	284	\r
	285	Place AP into targeted C-State if MONITOR is supported, otherwise\r
	286	place AP into hlt state.\r
	287	Place AP in protected mode if the current is long mode. Due to AP maybe\r
	288	wakeup by some hardware event. It could avoid accessing page table that\r
	289	may not available during booting to OS.\r
	290	\r
	291	@param[in] MwaitSupport TRUE indicates MONITOR is supported.\r
	292	FALSE indicates MONITOR is not supported.\r
	293	@param[in] ApTargetCState Target C-State value.\r
	294	@param[in] PmCodeSegment Protected mode code segment value.\r
	295	**/\r
	296	typedef\r
	297	VOID\r
	298	(EFIAPI * ASM_RELOCATE_AP_LOOP) (\r
	299	IN BOOLEAN MwaitSupport,\r
	300	IN UINTN ApTargetCState,\r
bf2786dc	301	IN UINTN PmCodeSegment,\r
9f91cb01 JF	302	IN UINTN TopOfApStack,\r
9f91cb01 JF	303	IN UINTN NumberToFinish\r
76157021	304	);\r
f7f85d83 JF	305	\r
	306	/**\r
	307	Assembly code to get starting address and size of the rendezvous entry for APs.\r
	308	Information for fixing a jump instruction in the code is also returned.\r
	309	\r
	310	@param[out] AddressMap Output buffer for address map information.\r
	311	**/\r
	312	VOID\r
	313	EFIAPI\r
	314	AsmGetAddressMap (\r
	315	OUT MP_ASSEMBLY_ADDRESS_MAP *AddressMap\r
	316	);\r
	317	\r
41be0da5 JF	318	/**\r
	319	This function is called by both the BSP and the AP which is to become the BSP to\r
	320	Exchange execution context including stack between them. After return from this\r
	321	function, the BSP becomes AP and the AP becomes the BSP.\r
	322	\r
	323	@param[in] MyInfo Pointer to buffer holding the exchanging information for the executing processor.\r
	324	@param[in] OthersInfo Pointer to buffer holding the exchanging information for the peer.\r
	325	\r
	326	**/\r
	327	VOID\r
	328	EFIAPI\r
	329	AsmExchangeRole (\r
	330	IN CPU_EXCHANGE_ROLE_INFO *MyInfo,\r
	331	IN CPU_EXCHANGE_ROLE_INFO *OthersInfo\r
	332	);\r
	333	\r
93ca4c0f JF	334	/**\r
	335	Get the pointer to CPU MP Data structure.\r
	336	\r
	337	@return The pointer to CPU MP Data structure.\r
	338	**/\r
	339	CPU_MP_DATA *\r
	340	GetCpuMpData (\r
	341	VOID\r
	342	);\r
	343	\r
	344	/**\r
	345	Save the pointer to CPU MP Data structure.\r
	346	\r
	347	@param[in] CpuMpData The pointer to CPU MP Data structure will be saved.\r
	348	**/\r
	349	VOID\r
	350	SaveCpuMpData (\r
	351	IN CPU_MP_DATA *CpuMpData\r
	352	);\r
	353	\r
ed66e0e3 JF	354	\r
ed66e0e3 JF	355	/**\r
a6b3d753	356	Get available system memory below 1MB by specified size.\r
ed66e0e3	357	\r
a6b3d753 SZ	358	@param[in] WakeupBufferSize Wakeup buffer size required\r
	359	\r
	360	@retval other Return wakeup buffer address below 1MB.\r
	361	@retval -1 Cannot find free memory below 1MB.\r
ed66e0e3	362	**/\r
a6b3d753 SZ	363	UINTN\r
	364	GetWakeupBuffer (\r
	365	IN UINTN WakeupBufferSize\r
ed66e0e3 JF	366	);\r
ed66e0e3 JF	367	\r
f32bfe6d JW	368	/**\r
	369	Get available EfiBootServicesCode memory below 4GB by specified size.\r
	370	\r
	371	This buffer is required to safely transfer AP from real address mode to\r
	372	protected mode or long mode, due to the fact that the buffer returned by\r
	373	GetWakeupBuffer() may be marked as non-executable.\r
	374	\r
	375	@param[in] BufferSize Wakeup transition buffer size.\r
	376	\r
	377	@retval other Return wakeup transition buffer address below 4GB.\r
	378	@retval 0 Cannot find free memory below 4GB.\r
	379	**/\r
	380	UINTN\r
	381	GetModeTransitionBuffer (\r
	382	IN UINTN BufferSize\r
	383	);\r
	384	\r
96f5920d JF	385	/**\r
	386	This function will be called by BSP to wakeup AP.\r
	387	\r
	388	@param[in] CpuMpData Pointer to CPU MP Data\r
	389	@param[in] Broadcast TRUE: Send broadcast IPI to all APs\r
	390	FALSE: Send IPI to AP by ApicId\r
	391	@param[in] ProcessorNumber The handle number of specified processor\r
	392	@param[in] Procedure The function to be invoked by AP\r
	393	@param[in] ProcedureArgument The argument to be passed into AP function\r
cf4e79e4	394	@param[in] WakeUpDisabledAps Whether need to wake up disabled APs in broadcast mode.\r
96f5920d JF	395	**/\r
	396	VOID\r
	397	WakeUpAP (\r
	398	IN CPU_MP_DATA *CpuMpData,\r
	399	IN BOOLEAN Broadcast,\r
	400	IN UINTN ProcessorNumber,\r
	401	IN EFI_AP_PROCEDURE Procedure, OPTIONAL\r
cf4e79e4 ED	402	IN VOID *ProcedureArgument, OPTIONAL\r
cf4e79e4 ED	403	IN BOOLEAN WakeUpDisabledAps OPTIONAL\r
96f5920d JF	404	);\r
96f5920d JF	405	\r
93ca4c0f JF	406	/**\r
	407	Initialize global data for MP support.\r
	408	\r
	409	@param[in] CpuMpData The pointer to CPU MP Data structure.\r
	410	**/\r
	411	VOID\r
	412	InitMpGlobalData (\r
	413	IN CPU_MP_DATA *CpuMpData\r
	414	);\r
	415	\r
86efe976 JF	416	/**\r
	417	Worker function to execute a caller provided function on all enabled APs.\r
	418	\r
	419	@param[in] Procedure A pointer to the function to be run on\r
	420	enabled APs of the system.\r
	421	@param[in] SingleThread If TRUE, then all the enabled APs execute\r
	422	the function specified by Procedure one by\r
	423	one, in ascending order of processor handle\r
	424	number. If FALSE, then all the enabled APs\r
	425	execute the function specified by Procedure\r
	426	simultaneously.\r
ee0c39fa	427	@param[in] ExcludeBsp Whether let BSP also trig this task.\r
86efe976 JF	428	@param[in] WaitEvent The event created by the caller with CreateEvent()\r
86efe976 JF	429	service.\r
367284e7	430	@param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for\r
86efe976 JF	431	APs to return from Procedure, either for\r
	432	blocking or non-blocking mode.\r
	433	@param[in] ProcedureArgument The parameter passed into Procedure for\r
	434	all APs.\r
	435	@param[out] FailedCpuList If all APs finish successfully, then its\r
	436	content is set to NULL. If not all APs\r
	437	finish before timeout expires, then its\r
	438	content is set to address of the buffer\r
	439	holding handle numbers of the failed APs.\r
	440	\r
	441	@retval EFI_SUCCESS In blocking mode, all APs have finished before\r
	442	the timeout expired.\r
	443	@retval EFI_SUCCESS In non-blocking mode, function has been dispatched\r
	444	to all enabled APs.\r
	445	@retval others Failed to Startup all APs.\r
	446	\r
	447	**/\r
	448	EFI_STATUS\r
ee0c39fa	449	StartupAllCPUsWorker (\r
86efe976 JF	450	IN EFI_AP_PROCEDURE Procedure,\r
86efe976 JF	451	IN BOOLEAN SingleThread,\r
ee0c39fa	452	IN BOOLEAN ExcludeBsp,\r
86efe976 JF	453	IN EFI_EVENT WaitEvent OPTIONAL,\r
	454	IN UINTN TimeoutInMicroseconds,\r
	455	IN VOID *ProcedureArgument OPTIONAL,\r
	456	OUT UINTN **FailedCpuList OPTIONAL\r
	457	);\r
	458	\r
20ae5774 JF	459	/**\r
	460	Worker function to let the caller get one enabled AP to execute a caller-provided\r
	461	function.\r
	462	\r
	463	@param[in] Procedure A pointer to the function to be run on\r
	464	enabled APs of the system.\r
	465	@param[in] ProcessorNumber The handle number of the AP.\r
	466	@param[in] WaitEvent The event created by the caller with CreateEvent()\r
	467	service.\r
367284e7	468	@param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for\r
20ae5774 JF	469	APs to return from Procedure, either for\r
	470	blocking or non-blocking mode.\r
	471	@param[in] ProcedureArgument The parameter passed into Procedure for\r
	472	all APs.\r
	473	@param[out] Finished If AP returns from Procedure before the\r
	474	timeout expires, its content is set to TRUE.\r
	475	Otherwise, the value is set to FALSE.\r
	476	\r
	477	@retval EFI_SUCCESS In blocking mode, specified AP finished before\r
	478	the timeout expires.\r
	479	@retval others Failed to Startup AP.\r
	480	\r
	481	**/\r
	482	EFI_STATUS\r
	483	StartupThisAPWorker (\r
	484	IN EFI_AP_PROCEDURE Procedure,\r
	485	IN UINTN ProcessorNumber,\r
	486	IN EFI_EVENT WaitEvent OPTIONAL,\r
	487	IN UINTN TimeoutInMicroseconds,\r
	488	IN VOID *ProcedureArgument OPTIONAL,\r
	489	OUT BOOLEAN *Finished OPTIONAL\r
	490	);\r
	491	\r
41be0da5 JF	492	/**\r
	493	Worker function to switch the requested AP to be the BSP from that point onward.\r
	494	\r
	495	@param[in] ProcessorNumber The handle number of AP that is to become the new BSP.\r
	496	@param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an\r
	497	enabled AP. Otherwise, it will be disabled.\r
	498	\r
	499	@retval EFI_SUCCESS BSP successfully switched.\r
7367cc6c	500	@retval others Failed to switch BSP.\r
41be0da5 JF	501	\r
	502	**/\r
	503	EFI_STATUS\r
	504	SwitchBSPWorker (\r
	505	IN UINTN ProcessorNumber,\r
	506	IN BOOLEAN EnableOldBSP\r
	507	);\r
	508	\r
e37109bc JF	509	/**\r
	510	Worker function to let the caller enable or disable an AP from this point onward.\r
	511	This service may only be called from the BSP.\r
	512	\r
	513	@param[in] ProcessorNumber The handle number of AP.\r
	514	@param[in] EnableAP Specifies the new state for the processor for\r
	515	enabled, FALSE for disabled.\r
	516	@param[in] HealthFlag If not NULL, a pointer to a value that specifies\r
	517	the new health status of the AP.\r
	518	\r
	519	@retval EFI_SUCCESS The specified AP was enabled or disabled successfully.\r
	520	@retval others Failed to Enable/Disable AP.\r
	521	\r
	522	**/\r
	523	EFI_STATUS\r
	524	EnableDisableApWorker (\r
	525	IN UINTN ProcessorNumber,\r
	526	IN BOOLEAN EnableAP,\r
	527	IN UINT32 *HealthFlag OPTIONAL\r
	528	);\r
	529	\r
93ca4c0f JF	530	/**\r
	531	Get pointer to CPU MP Data structure from GUIDed HOB.\r
	532	\r
	533	@return The pointer to CPU MP Data structure.\r
	534	**/\r
	535	CPU_MP_DATA *\r
	536	GetCpuMpDataFromGuidedHob (\r
	537	VOID\r
	538	);\r
08085f08 JF	539	\r
	540	/** Checks status of specified AP.\r
	541	\r
	542	This function checks whether the specified AP has finished the task assigned\r
	543	by StartupThisAP(), and whether timeout expires.\r
	544	\r
	545	@param[in] ProcessorNumber The handle number of processor.\r
	546	\r
	547	@retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().\r
	548	@retval EFI_TIMEOUT The timeout expires.\r
	549	@retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.\r
	550	**/\r
	551	EFI_STATUS\r
	552	CheckThisAP (\r
	553	IN UINTN ProcessorNumber\r
	554	);\r
	555	\r
	556	/**\r
	557	Checks status of all APs.\r
	558	\r
	559	This function checks whether all APs have finished task assigned by StartupAllAPs(),\r
	560	and whether timeout expires.\r
	561	\r
	562	@retval EFI_SUCCESS All APs have finished task assigned by StartupAllAPs().\r
	563	@retval EFI_TIMEOUT The timeout expires.\r
	564	@retval EFI_NOT_READY APs have not finished task and timeout has not expired.\r
	565	**/\r
	566	EFI_STATUS\r
	567	CheckAllAPs (\r
	568	VOID\r
	569	);\r
	570	\r
	571	/**\r
	572	Checks APs status and updates APs status if needed.\r
	573	\r
	574	**/\r
	575	VOID\r
	576	CheckAndUpdateApsStatus (\r
	577	VOID\r
	578	);\r
	579	\r
94f63c76 JF	580	/**\r
	581	Detect whether specified processor can find matching microcode patch and load it.\r
	582	\r
2a089134 ED	583	@param[in] CpuMpData The pointer to CPU MP Data structure.\r
2a089134 ED	584	@param[in] IsBspCallIn Indicate whether the caller is BSP or not.\r
94f63c76 JF	585	**/\r
	586	VOID\r
	587	MicrocodeDetect (\r
2a089134 ED	588	IN CPU_MP_DATA *CpuMpData,\r
2a089134 ED	589	IN BOOLEAN IsBspCallIn\r
94f63c76 JF	590	);\r
94f63c76 JF	591	\r
d786a172 HW	592	/**\r
	593	Load the required microcode patches data into memory.\r
	594	\r
	595	@param[in, out] CpuMpData The pointer to CPU MP Data structure.\r
	596	**/\r
	597	VOID\r
	598	LoadMicrocodePatch (\r
	599	IN OUT CPU_MP_DATA *CpuMpData\r
	600	);\r
	601	\r
4d3314f6 JF	602	/**\r
	603	Detect whether Mwait-monitor feature is supported.\r
	604	\r
	605	@retval TRUE Mwait-monitor feature is supported.\r
	606	@retval FALSE Mwait-monitor feature is not supported.\r
	607	**/\r
	608	BOOLEAN\r
	609	IsMwaitSupport (\r
	610	VOID\r
	611	);\r
	612	\r
43c9fdcc JF	613	/**\r
	614	Enable Debug Agent to support source debugging on AP function.\r
	615	\r
	616	**/\r
	617	VOID\r
	618	EnableDebugAgent (\r
	619	VOID\r
	620	);\r
	621	\r
3e8ad6bd JF	622	#endif\r
3e8ad6bd JF	623	\r