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