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

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