[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
\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
  );\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]  TimeoutInMicrosecsond   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]  TimeoutInMicrosecsond   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
#endif\r
\r
Commit	Line	Data
	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
	38	#define WAKEUP_AP_SIGNAL SIGNATURE_32 ('S', 'T', 'A', 'P')\r
	39	\r
	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
	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
	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
	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
	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
	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
	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
	115	BOOLEAN CpuHealthy;\r
	116	volatile CPU_STATE State;\r
	117	CPU_VOLATILE_REGISTERS VolatileRegisters;\r
	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
	132	#pragma pack (1)\r
	133	typedef struct {\r
	134	UINT32 InitialApicId;\r
	135	UINT32 ApicId;\r
	136	UINT32 Health;\r
	137	UINT64 ApTopOfStack;\r
	138	} CPU_INFO_IN_HOB;\r
	139	#pragma pack ()\r
	140	\r
	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
	153	\r
	154	typedef struct _CPU_MP_DATA CPU_MP_DATA;\r
	155	\r
	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
	175	UINTN EnableExecuteDisable;\r
	176	UINTN Cr3;\r
	177	UINTN InitFlag;\r
	178	CPU_INFO_IN_HOB *CpuInfo;\r
	179	CPU_MP_DATA *CpuMpData;\r
	180	} MP_CPU_EXCHANGE_INFO;\r
	181	\r
	182	#pragma pack()\r
	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
	203	BOOLEAN SaveRestoreFlag;\r
	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
	220	BOOLEAN SwitchBspFlag;\r
	221	UINTN NewBspNumber;\r
	222	CPU_EXCHANGE_ROLE_INFO BSPInfo;\r
	223	CPU_EXCHANGE_ROLE_INFO APInfo;\r
	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
	230	};\r
	231	\r
	232	extern EFI_GUID mCpuInitMpLibHobGuid;\r
	233	\r
	234	/**\r
	235	Assembly code to place AP into safe loop mode.\r
	236	\r
	237	Place AP into targeted C-State if MONITOR is supported, otherwise\r
	238	place AP into hlt state.\r
	239	Place AP in protected mode if the current is long mode. Due to AP maybe\r
	240	wakeup by some hardware event. It could avoid accessing page table that\r
	241	may not available during booting to OS.\r
	242	\r
	243	@param[in] MwaitSupport TRUE indicates MONITOR is supported.\r
	244	FALSE indicates MONITOR is not supported.\r
	245	@param[in] ApTargetCState Target C-State value.\r
	246	@param[in] PmCodeSegment Protected mode code segment value.\r
	247	**/\r
	248	typedef\r
	249	VOID\r
	250	(EFIAPI * ASM_RELOCATE_AP_LOOP) (\r
	251	IN BOOLEAN MwaitSupport,\r
	252	IN UINTN ApTargetCState,\r
	253	IN UINTN PmCodeSegment\r
	254	);\r
	255	\r
	256	/**\r
	257	Assembly code to get starting address and size of the rendezvous entry for APs.\r
	258	Information for fixing a jump instruction in the code is also returned.\r
	259	\r
	260	@param[out] AddressMap Output buffer for address map information.\r
	261	**/\r
	262	VOID\r
	263	EFIAPI\r
	264	AsmGetAddressMap (\r
	265	OUT MP_ASSEMBLY_ADDRESS_MAP *AddressMap\r
	266	);\r
	267	\r
	268	/**\r
	269	This function is called by both the BSP and the AP which is to become the BSP to\r
	270	Exchange execution context including stack between them. After return from this\r
	271	function, the BSP becomes AP and the AP becomes the BSP.\r
	272	\r
	273	@param[in] MyInfo Pointer to buffer holding the exchanging information for the executing processor.\r
	274	@param[in] OthersInfo Pointer to buffer holding the exchanging information for the peer.\r
	275	\r
	276	**/\r
	277	VOID\r
	278	EFIAPI\r
	279	AsmExchangeRole (\r
	280	IN CPU_EXCHANGE_ROLE_INFO *MyInfo,\r
	281	IN CPU_EXCHANGE_ROLE_INFO *OthersInfo\r
	282	);\r
	283	\r
	284	/**\r
	285	Get the pointer to CPU MP Data structure.\r
	286	\r
	287	@return The pointer to CPU MP Data structure.\r
	288	**/\r
	289	CPU_MP_DATA *\r
	290	GetCpuMpData (\r
	291	VOID\r
	292	);\r
	293	\r
	294	/**\r
	295	Save the pointer to CPU MP Data structure.\r
	296	\r
	297	@param[in] CpuMpData The pointer to CPU MP Data structure will be saved.\r
	298	**/\r
	299	VOID\r
	300	SaveCpuMpData (\r
	301	IN CPU_MP_DATA *CpuMpData\r
	302	);\r
	303	\r
	304	/**\r
	305	Allocate reset vector buffer.\r
	306	\r
	307	@param[in, out] CpuMpData The pointer to CPU MP Data structure.\r
	308	**/\r
	309	VOID\r
	310	AllocateResetVector (\r
	311	IN OUT CPU_MP_DATA *CpuMpData\r
	312	);\r
	313	\r
	314	/**\r
	315	Free AP reset vector buffer.\r
	316	\r
	317	@param[in] CpuMpData The pointer to CPU MP Data structure.\r
	318	**/\r
	319	VOID\r
	320	FreeResetVector (\r
	321	IN CPU_MP_DATA *CpuMpData\r
	322	);\r
	323	\r
	324	/**\r
	325	This function will be called by BSP to wakeup AP.\r
	326	\r
	327	@param[in] CpuMpData Pointer to CPU MP Data\r
	328	@param[in] Broadcast TRUE: Send broadcast IPI to all APs\r
	329	FALSE: Send IPI to AP by ApicId\r
	330	@param[in] ProcessorNumber The handle number of specified processor\r
	331	@param[in] Procedure The function to be invoked by AP\r
	332	@param[in] ProcedureArgument The argument to be passed into AP function\r
	333	**/\r
	334	VOID\r
	335	WakeUpAP (\r
	336	IN CPU_MP_DATA *CpuMpData,\r
	337	IN BOOLEAN Broadcast,\r
	338	IN UINTN ProcessorNumber,\r
	339	IN EFI_AP_PROCEDURE Procedure, OPTIONAL\r
	340	IN VOID *ProcedureArgument OPTIONAL\r
	341	);\r
	342	\r
	343	/**\r
	344	Initialize global data for MP support.\r
	345	\r
	346	@param[in] CpuMpData The pointer to CPU MP Data structure.\r
	347	**/\r
	348	VOID\r
	349	InitMpGlobalData (\r
	350	IN CPU_MP_DATA *CpuMpData\r
	351	);\r
	352	\r
	353	/**\r
	354	Worker function to execute a caller provided function on all enabled APs.\r
	355	\r
	356	@param[in] Procedure A pointer to the function to be run on\r
	357	enabled APs of the system.\r
	358	@param[in] SingleThread If TRUE, then all the enabled APs execute\r
	359	the function specified by Procedure one by\r
	360	one, in ascending order of processor handle\r
	361	number. If FALSE, then all the enabled APs\r
	362	execute the function specified by Procedure\r
	363	simultaneously.\r
	364	@param[in] WaitEvent The event created by the caller with CreateEvent()\r
	365	service.\r
	366	@param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for\r
	367	APs to return from Procedure, either for\r
	368	blocking or non-blocking mode.\r
	369	@param[in] ProcedureArgument The parameter passed into Procedure for\r
	370	all APs.\r
	371	@param[out] FailedCpuList If all APs finish successfully, then its\r
	372	content is set to NULL. If not all APs\r
	373	finish before timeout expires, then its\r
	374	content is set to address of the buffer\r
	375	holding handle numbers of the failed APs.\r
	376	\r
	377	@retval EFI_SUCCESS In blocking mode, all APs have finished before\r
	378	the timeout expired.\r
	379	@retval EFI_SUCCESS In non-blocking mode, function has been dispatched\r
	380	to all enabled APs.\r
	381	@retval others Failed to Startup all APs.\r
	382	\r
	383	**/\r
	384	EFI_STATUS\r
	385	StartupAllAPsWorker (\r
	386	IN EFI_AP_PROCEDURE Procedure,\r
	387	IN BOOLEAN SingleThread,\r
	388	IN EFI_EVENT WaitEvent OPTIONAL,\r
	389	IN UINTN TimeoutInMicroseconds,\r
	390	IN VOID *ProcedureArgument OPTIONAL,\r
	391	OUT UINTN **FailedCpuList OPTIONAL\r
	392	);\r
	393	\r
	394	/**\r
	395	Worker function to let the caller get one enabled AP to execute a caller-provided\r
	396	function.\r
	397	\r
	398	@param[in] Procedure A pointer to the function to be run on\r
	399	enabled APs of the system.\r
	400	@param[in] ProcessorNumber The handle number of the AP.\r
	401	@param[in] WaitEvent The event created by the caller with CreateEvent()\r
	402	service.\r
	403	@param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for\r
	404	APs to return from Procedure, either for\r
	405	blocking or non-blocking mode.\r
	406	@param[in] ProcedureArgument The parameter passed into Procedure for\r
	407	all APs.\r
	408	@param[out] Finished If AP returns from Procedure before the\r
	409	timeout expires, its content is set to TRUE.\r
	410	Otherwise, the value is set to FALSE.\r
	411	\r
	412	@retval EFI_SUCCESS In blocking mode, specified AP finished before\r
	413	the timeout expires.\r
	414	@retval others Failed to Startup AP.\r
	415	\r
	416	**/\r
	417	EFI_STATUS\r
	418	StartupThisAPWorker (\r
	419	IN EFI_AP_PROCEDURE Procedure,\r
	420	IN UINTN ProcessorNumber,\r
	421	IN EFI_EVENT WaitEvent OPTIONAL,\r
	422	IN UINTN TimeoutInMicroseconds,\r
	423	IN VOID *ProcedureArgument OPTIONAL,\r
	424	OUT BOOLEAN *Finished OPTIONAL\r
	425	);\r
	426	\r
	427	/**\r
	428	Worker function to switch the requested AP to be the BSP from that point onward.\r
	429	\r
	430	@param[in] ProcessorNumber The handle number of AP that is to become the new BSP.\r
	431	@param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an\r
	432	enabled AP. Otherwise, it will be disabled.\r
	433	\r
	434	@retval EFI_SUCCESS BSP successfully switched.\r
	435	@retval others Failed to switch BSP. \r
	436	\r
	437	**/\r
	438	EFI_STATUS\r
	439	SwitchBSPWorker (\r
	440	IN UINTN ProcessorNumber,\r
	441	IN BOOLEAN EnableOldBSP\r
	442	);\r
	443	\r
	444	/**\r
	445	Worker function to let the caller enable or disable an AP from this point onward.\r
	446	This service may only be called from the BSP.\r
	447	\r
	448	@param[in] ProcessorNumber The handle number of AP.\r
	449	@param[in] EnableAP Specifies the new state for the processor for\r
	450	enabled, FALSE for disabled.\r
	451	@param[in] HealthFlag If not NULL, a pointer to a value that specifies\r
	452	the new health status of the AP.\r
	453	\r
	454	@retval EFI_SUCCESS The specified AP was enabled or disabled successfully.\r
	455	@retval others Failed to Enable/Disable AP.\r
	456	\r
	457	**/\r
	458	EFI_STATUS\r
	459	EnableDisableApWorker (\r
	460	IN UINTN ProcessorNumber,\r
	461	IN BOOLEAN EnableAP,\r
	462	IN UINT32 *HealthFlag OPTIONAL\r
	463	);\r
	464	\r
	465	/**\r
	466	Get pointer to CPU MP Data structure from GUIDed HOB.\r
	467	\r
	468	@return The pointer to CPU MP Data structure.\r
	469	**/\r
	470	CPU_MP_DATA *\r
	471	GetCpuMpDataFromGuidedHob (\r
	472	VOID\r
	473	);\r
	474	\r
	475	/** Checks status of specified AP.\r
	476	\r
	477	This function checks whether the specified AP has finished the task assigned\r
	478	by StartupThisAP(), and whether timeout expires.\r
	479	\r
	480	@param[in] ProcessorNumber The handle number of processor.\r
	481	\r
	482	@retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().\r
	483	@retval EFI_TIMEOUT The timeout expires.\r
	484	@retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.\r
	485	**/\r
	486	EFI_STATUS\r
	487	CheckThisAP (\r
	488	IN UINTN ProcessorNumber\r
	489	);\r
	490	\r
	491	/**\r
	492	Checks status of all APs.\r
	493	\r
	494	This function checks whether all APs have finished task assigned by StartupAllAPs(),\r
	495	and whether timeout expires.\r
	496	\r
	497	@retval EFI_SUCCESS All APs have finished task assigned by StartupAllAPs().\r
	498	@retval EFI_TIMEOUT The timeout expires.\r
	499	@retval EFI_NOT_READY APs have not finished task and timeout has not expired.\r
	500	**/\r
	501	EFI_STATUS\r
	502	CheckAllAPs (\r
	503	VOID\r
	504	);\r
	505	\r
	506	/**\r
	507	Checks APs status and updates APs status if needed.\r
	508	\r
	509	**/\r
	510	VOID\r
	511	CheckAndUpdateApsStatus (\r
	512	VOID\r
	513	);\r
	514	\r
	515	/**\r
	516	Detect whether specified processor can find matching microcode patch and load it.\r
	517	\r
	518	@param[in] CpuMpData The pointer to CPU MP Data structure.\r
	519	**/\r
	520	VOID\r
	521	MicrocodeDetect (\r
	522	IN CPU_MP_DATA *CpuMpData\r
	523	);\r
	524	\r
	525	/**\r
	526	Detect whether Mwait-monitor feature is supported.\r
	527	\r
	528	@retval TRUE Mwait-monitor feature is supported.\r
	529	@retval FALSE Mwait-monitor feature is not supported.\r
	530	**/\r
	531	BOOLEAN\r
	532	IsMwaitSupport (\r
	533	VOID\r
	534	);\r
	535	\r
	536	/**\r
	537	Notify function on End Of PEI PPI.\r
	538	\r
	539	On S3 boot, this function will restore wakeup buffer data.\r
	540	On normal boot, this function will flag wakeup buffer to be un-used type.\r
	541	\r
	542	@param[in] PeiServices The pointer to the PEI Services Table.\r
	543	@param[in] NotifyDescriptor Address of the notification descriptor data structure.\r
	544	@param[in] Ppi Address of the PPI that was installed.\r
	545	\r
	546	@retval EFI_SUCCESS When everything is OK.\r
	547	**/\r
	548	EFI_STATUS\r
	549	EFIAPI\r
	550	CpuMpEndOfPeiCallback (\r
	551	IN EFI_PEI_SERVICES **PeiServices,\r
	552	IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor,\r
	553	IN VOID *Ppi\r
	554	);\r
	555	\r
	556	/**\r
	557	Get available system memory below 1MB by specified size.\r
	558	\r
	559	@param[in] CpuMpData The pointer to CPU MP Data structure.\r
	560	**/\r
	561	VOID\r
	562	BackupAndPrepareWakeupBuffer(\r
	563	IN CPU_MP_DATA *CpuMpData\r
	564	);\r
	565	\r
	566	/**\r
	567	Restore wakeup buffer data.\r
	568	\r
	569	@param[in] CpuMpData The pointer to CPU MP Data structure.\r
	570	**/\r
	571	VOID\r
	572	RestoreWakeupBuffer(\r
	573	IN CPU_MP_DATA *CpuMpData\r
	574	);\r
	575	\r
	576	#endif\r
	577	\r