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