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

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