2 Common header file for MP Initialize Library.
4 Copyright (c) 2016 - 2019, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
14 #include <Register/Intel/Cpuid.h>
15 #include <Register/Intel/Msr.h>
16 #include <Register/Intel/LocalApic.h>
17 #include <Register/Intel/Microcode.h>
19 #include <Library/MpInitLib.h>
20 #include <Library/BaseLib.h>
21 #include <Library/BaseMemoryLib.h>
22 #include <Library/MemoryAllocationLib.h>
23 #include <Library/DebugLib.h>
24 #include <Library/LocalApicLib.h>
25 #include <Library/CpuLib.h>
26 #include <Library/UefiCpuLib.h>
27 #include <Library/TimerLib.h>
28 #include <Library/SynchronizationLib.h>
29 #include <Library/MtrrLib.h>
30 #include <Library/HobLib.h>
32 #define WAKEUP_AP_SIGNAL SIGNATURE_32 ('S', 'T', 'A', 'P')
34 #define CPU_INIT_MP_LIB_HOB_GUID \
36 0x58eb6a19, 0x3699, 0x4c68, { 0xa8, 0x36, 0xda, 0xcd, 0x8e, 0xdc, 0xad, 0x4a } \
40 // The MP data for switch BSP
42 #define CPU_SWITCH_STATE_IDLE 0
43 #define CPU_SWITCH_STATE_STORED 1
44 #define CPU_SWITCH_STATE_LOADED 2
47 // CPU exchange information for switch BSP
50 UINT8 State
; // offset 0
51 UINTN StackPointer
; // offset 4 / 8
52 IA32_DESCRIPTOR Gdtr
; // offset 8 / 16
53 IA32_DESCRIPTOR Idtr
; // offset 14 / 26
54 } CPU_EXCHANGE_ROLE_INFO
;
57 // AP loop state when APs are in idle state
58 // It's value is the same with PcdCpuApLoopMode
67 // AP initialization state during APs wakeup
78 // The state transitions for an AP when it process a procedure are:
79 // Idle ----> Ready ----> Busy ----> Idle
91 // CPU volatile registers around INIT-SIPI-SIPI
103 IA32_DESCRIPTOR Gdtr
;
104 IA32_DESCRIPTOR Idtr
;
106 } CPU_VOLATILE_REGISTERS
;
113 volatile UINT32
*StartupApSignal
;
114 volatile UINTN ApFunction
;
115 volatile UINTN ApFunctionArgument
;
117 volatile CPU_STATE State
;
118 CPU_VOLATILE_REGISTERS VolatileRegisters
;
125 UINT32 ProcessorSignature
;
130 // Basic CPU information saved in Guided HOB.
131 // Because the contents will be shard between PEI and DXE,
132 // we need to make sure the each fields offset same in different
137 UINT32 InitialApicId
;
145 // AP reset code information including code address and size,
146 // this structure will be shared be C code and assembly code.
147 // It is natural aligned by design.
150 UINT8
*RendezvousFunnelAddress
;
151 UINTN ModeEntryOffset
;
152 UINTN RendezvousFunnelSize
;
153 UINT8
*RelocateApLoopFuncAddress
;
154 UINTN RelocateApLoopFuncSize
;
155 UINTN ModeTransitionOffset
;
156 } MP_ASSEMBLY_ADDRESS_MAP
;
158 typedef struct _CPU_MP_DATA CPU_MP_DATA
;
163 // MP CPU exchange information for AP reset code
164 // This structure is required to be packed because fixed field offsets
165 // into this structure are used in assembly code in this module
172 IA32_DESCRIPTOR GdtrProfile
;
173 IA32_DESCRIPTOR IdtrProfile
;
179 UINTN EnableExecuteDisable
;
182 CPU_INFO_IN_HOB
*CpuInfo
;
183 UINTN NumApsExecuting
;
184 CPU_MP_DATA
*CpuMpData
;
185 UINTN InitializeFloatingPointUnitsAddress
;
186 UINT32 ModeTransitionMemory
;
187 UINT16 ModeTransitionSegment
;
188 UINT32 ModeHighMemory
;
189 UINT16 ModeHighSegment
;
191 // Enable5LevelPaging indicates whether 5-level paging is enabled in long mode.
193 BOOLEAN Enable5LevelPaging
;
194 } MP_CPU_EXCHANGE_INFO
;
199 // CPU MP Data save in memory
201 struct _CPU_MP_DATA
{
206 // The above fields data will be passed from PEI to DXE
207 // Please make sure the fields offset same in the different
212 UINTN CpuApStackSize
;
213 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
215 UINTN WakeupBufferHigh
;
217 UINTN BackupBufferSize
;
219 volatile UINT32 FinishedCount
;
221 BOOLEAN SingleThread
;
222 EFI_AP_PROCEDURE Procedure
;
229 UINTN
**FailedCpuList
;
231 AP_INIT_STATE InitFlag
;
232 BOOLEAN SwitchBspFlag
;
234 CPU_EXCHANGE_ROLE_INFO BSPInfo
;
235 CPU_EXCHANGE_ROLE_INFO APInfo
;
236 MTRR_SETTINGS MtrrTable
;
238 UINT8 ApTargetCState
;
239 UINT16 PmCodeSegment
;
240 CPU_AP_DATA
*CpuData
;
241 volatile MP_CPU_EXCHANGE_INFO
*MpCpuExchangeInfo
;
243 UINT32 CurrentTimerCount
;
246 BOOLEAN PeriodicMode
;
247 BOOLEAN TimerInterruptState
;
248 UINT64 MicrocodePatchAddress
;
249 UINT64 MicrocodePatchRegionSize
;
251 UINT32 ProcessorSignature
;
252 UINT32 ProcessorFlags
;
253 UINT64 MicrocodeDataAddress
;
254 UINT32 MicrocodeRevision
;
257 // Whether need to use Init-Sipi-Sipi to wake up the APs.
258 // Two cases need to set this value to TRUE. One is in HLT
259 // loop mode, the other is resume from S3 which loop mode
260 // will be hardcode change to HLT mode by PiSmmCpuDxeSmm
263 BOOLEAN WakeUpByInitSipiSipi
;
266 extern EFI_GUID mCpuInitMpLibHobGuid
;
269 Assembly code to place AP into safe loop mode.
271 Place AP into targeted C-State if MONITOR is supported, otherwise
272 place AP into hlt state.
273 Place AP in protected mode if the current is long mode. Due to AP maybe
274 wakeup by some hardware event. It could avoid accessing page table that
275 may not available during booting to OS.
277 @param[in] MwaitSupport TRUE indicates MONITOR is supported.
278 FALSE indicates MONITOR is not supported.
279 @param[in] ApTargetCState Target C-State value.
280 @param[in] PmCodeSegment Protected mode code segment value.
284 (EFIAPI
* ASM_RELOCATE_AP_LOOP
) (
285 IN BOOLEAN MwaitSupport
,
286 IN UINTN ApTargetCState
,
287 IN UINTN PmCodeSegment
,
288 IN UINTN TopOfApStack
,
289 IN UINTN NumberToFinish
293 Assembly code to get starting address and size of the rendezvous entry for APs.
294 Information for fixing a jump instruction in the code is also returned.
296 @param[out] AddressMap Output buffer for address map information.
301 OUT MP_ASSEMBLY_ADDRESS_MAP
*AddressMap
305 This function is called by both the BSP and the AP which is to become the BSP to
306 Exchange execution context including stack between them. After return from this
307 function, the BSP becomes AP and the AP becomes the BSP.
309 @param[in] MyInfo Pointer to buffer holding the exchanging information for the executing processor.
310 @param[in] OthersInfo Pointer to buffer holding the exchanging information for the peer.
316 IN CPU_EXCHANGE_ROLE_INFO
*MyInfo
,
317 IN CPU_EXCHANGE_ROLE_INFO
*OthersInfo
321 Get the pointer to CPU MP Data structure.
323 @return The pointer to CPU MP Data structure.
331 Save the pointer to CPU MP Data structure.
333 @param[in] CpuMpData The pointer to CPU MP Data structure will be saved.
337 IN CPU_MP_DATA
*CpuMpData
342 Get available system memory below 1MB by specified size.
344 @param[in] WakeupBufferSize Wakeup buffer size required
346 @retval other Return wakeup buffer address below 1MB.
347 @retval -1 Cannot find free memory below 1MB.
351 IN UINTN WakeupBufferSize
355 Get available EfiBootServicesCode memory below 4GB by specified size.
357 This buffer is required to safely transfer AP from real address mode to
358 protected mode or long mode, due to the fact that the buffer returned by
359 GetWakeupBuffer() may be marked as non-executable.
361 @param[in] BufferSize Wakeup transition buffer size.
363 @retval other Return wakeup transition buffer address below 4GB.
364 @retval 0 Cannot find free memory below 4GB.
367 GetModeTransitionBuffer (
372 This function will be called by BSP to wakeup AP.
374 @param[in] CpuMpData Pointer to CPU MP Data
375 @param[in] Broadcast TRUE: Send broadcast IPI to all APs
376 FALSE: Send IPI to AP by ApicId
377 @param[in] ProcessorNumber The handle number of specified processor
378 @param[in] Procedure The function to be invoked by AP
379 @param[in] ProcedureArgument The argument to be passed into AP function
380 @param[in] WakeUpDisabledAps Whether need to wake up disabled APs in broadcast mode.
384 IN CPU_MP_DATA
*CpuMpData
,
385 IN BOOLEAN Broadcast
,
386 IN UINTN ProcessorNumber
,
387 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
388 IN VOID
*ProcedureArgument
, OPTIONAL
389 IN BOOLEAN WakeUpDisabledAps OPTIONAL
393 Initialize global data for MP support.
395 @param[in] CpuMpData The pointer to CPU MP Data structure.
399 IN CPU_MP_DATA
*CpuMpData
403 Worker function to execute a caller provided function on all enabled APs.
405 @param[in] Procedure A pointer to the function to be run on
406 enabled APs of the system.
407 @param[in] SingleThread If TRUE, then all the enabled APs execute
408 the function specified by Procedure one by
409 one, in ascending order of processor handle
410 number. If FALSE, then all the enabled APs
411 execute the function specified by Procedure
413 @param[in] ExcludeBsp Whether let BSP also trig this task.
414 @param[in] WaitEvent The event created by the caller with CreateEvent()
416 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
417 APs to return from Procedure, either for
418 blocking or non-blocking mode.
419 @param[in] ProcedureArgument The parameter passed into Procedure for
421 @param[out] FailedCpuList If all APs finish successfully, then its
422 content is set to NULL. If not all APs
423 finish before timeout expires, then its
424 content is set to address of the buffer
425 holding handle numbers of the failed APs.
427 @retval EFI_SUCCESS In blocking mode, all APs have finished before
429 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched
431 @retval others Failed to Startup all APs.
435 StartupAllCPUsWorker (
436 IN EFI_AP_PROCEDURE Procedure
,
437 IN BOOLEAN SingleThread
,
438 IN BOOLEAN ExcludeBsp
,
439 IN EFI_EVENT WaitEvent OPTIONAL
,
440 IN UINTN TimeoutInMicroseconds
,
441 IN VOID
*ProcedureArgument OPTIONAL
,
442 OUT UINTN
**FailedCpuList OPTIONAL
446 Worker function to let the caller get one enabled AP to execute a caller-provided
449 @param[in] Procedure A pointer to the function to be run on
450 enabled APs of the system.
451 @param[in] ProcessorNumber The handle number of the AP.
452 @param[in] WaitEvent The event created by the caller with CreateEvent()
454 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
455 APs to return from Procedure, either for
456 blocking or non-blocking mode.
457 @param[in] ProcedureArgument The parameter passed into Procedure for
459 @param[out] Finished If AP returns from Procedure before the
460 timeout expires, its content is set to TRUE.
461 Otherwise, the value is set to FALSE.
463 @retval EFI_SUCCESS In blocking mode, specified AP finished before
465 @retval others Failed to Startup AP.
469 StartupThisAPWorker (
470 IN EFI_AP_PROCEDURE Procedure
,
471 IN UINTN ProcessorNumber
,
472 IN EFI_EVENT WaitEvent OPTIONAL
,
473 IN UINTN TimeoutInMicroseconds
,
474 IN VOID
*ProcedureArgument OPTIONAL
,
475 OUT BOOLEAN
*Finished OPTIONAL
479 Worker function to switch the requested AP to be the BSP from that point onward.
481 @param[in] ProcessorNumber The handle number of AP that is to become the new BSP.
482 @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an
483 enabled AP. Otherwise, it will be disabled.
485 @retval EFI_SUCCESS BSP successfully switched.
486 @retval others Failed to switch BSP.
491 IN UINTN ProcessorNumber
,
492 IN BOOLEAN EnableOldBSP
496 Worker function to let the caller enable or disable an AP from this point onward.
497 This service may only be called from the BSP.
499 @param[in] ProcessorNumber The handle number of AP.
500 @param[in] EnableAP Specifies the new state for the processor for
501 enabled, FALSE for disabled.
502 @param[in] HealthFlag If not NULL, a pointer to a value that specifies
503 the new health status of the AP.
505 @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
506 @retval others Failed to Enable/Disable AP.
510 EnableDisableApWorker (
511 IN UINTN ProcessorNumber
,
513 IN UINT32
*HealthFlag OPTIONAL
517 Get pointer to CPU MP Data structure from GUIDed HOB.
519 @return The pointer to CPU MP Data structure.
522 GetCpuMpDataFromGuidedHob (
526 /** Checks status of specified AP.
528 This function checks whether the specified AP has finished the task assigned
529 by StartupThisAP(), and whether timeout expires.
531 @param[in] ProcessorNumber The handle number of processor.
533 @retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().
534 @retval EFI_TIMEOUT The timeout expires.
535 @retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.
539 IN UINTN ProcessorNumber
543 Checks status of all APs.
545 This function checks whether all APs have finished task assigned by StartupAllAPs(),
546 and whether timeout expires.
548 @retval EFI_SUCCESS All APs have finished task assigned by StartupAllAPs().
549 @retval EFI_TIMEOUT The timeout expires.
550 @retval EFI_NOT_READY APs have not finished task and timeout has not expired.
558 Checks APs status and updates APs status if needed.
562 CheckAndUpdateApsStatus (
567 Detect whether specified processor can find matching microcode patch and load it.
569 @param[in] CpuMpData The pointer to CPU MP Data structure.
570 @param[in] IsBspCallIn Indicate whether the caller is BSP or not.
574 IN CPU_MP_DATA
*CpuMpData
,
575 IN BOOLEAN IsBspCallIn
579 Detect whether Mwait-monitor feature is supported.
581 @retval TRUE Mwait-monitor feature is supported.
582 @retval FALSE Mwait-monitor feature is not supported.
590 Enable Debug Agent to support source debugging on AP function.