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

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