2 Common header file for MP Initialize Library.
4 Copyright (c) 2016 - 2020, 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 #include <IndustryStandard/FirmwareInterfaceTable.h>
35 #define WAKEUP_AP_SIGNAL SIGNATURE_32 ('S', 'T', 'A', 'P')
37 #define CPU_INIT_MP_LIB_HOB_GUID \
39 0x58eb6a19, 0x3699, 0x4c68, { 0xa8, 0x36, 0xda, 0xcd, 0x8e, 0xdc, 0xad, 0x4a } \
43 // The MP data for switch BSP
45 #define CPU_SWITCH_STATE_IDLE 0
46 #define CPU_SWITCH_STATE_STORED 1
47 #define CPU_SWITCH_STATE_LOADED 2
50 // Default maximum number of entries to store the microcode patches information
52 #define DEFAULT_MAX_MICROCODE_PATCH_NUM 8
55 // Data structure for microcode patch information
60 } MICROCODE_PATCH_INFO
;
63 // CPU exchange information for switch BSP
66 UINT8 State
; // offset 0
67 UINTN StackPointer
; // offset 4 / 8
68 IA32_DESCRIPTOR Gdtr
; // offset 8 / 16
69 IA32_DESCRIPTOR Idtr
; // offset 14 / 26
70 } CPU_EXCHANGE_ROLE_INFO
;
73 // AP loop state when APs are in idle state
74 // It's value is the same with PcdCpuApLoopMode
83 // AP initialization state during APs wakeup
94 // The state transitions for an AP when it process a procedure are:
95 // Idle ----> Ready ----> Busy ----> Idle
107 // CPU volatile registers around INIT-SIPI-SIPI
119 IA32_DESCRIPTOR Gdtr
;
120 IA32_DESCRIPTOR Idtr
;
122 } CPU_VOLATILE_REGISTERS
;
129 volatile UINT32
*StartupApSignal
;
130 volatile UINTN ApFunction
;
131 volatile UINTN ApFunctionArgument
;
133 volatile CPU_STATE State
;
134 CPU_VOLATILE_REGISTERS VolatileRegisters
;
141 UINT32 ProcessorSignature
;
143 UINT64 MicrocodeEntryAddr
;
147 // Basic CPU information saved in Guided HOB.
148 // Because the contents will be shard between PEI and DXE,
149 // we need to make sure the each fields offset same in different
154 UINT32 InitialApicId
;
162 // AP reset code information including code address and size,
163 // this structure will be shared be C code and assembly code.
164 // It is natural aligned by design.
167 UINT8
*RendezvousFunnelAddress
;
168 UINTN ModeEntryOffset
;
169 UINTN RendezvousFunnelSize
;
170 UINT8
*RelocateApLoopFuncAddress
;
171 UINTN RelocateApLoopFuncSize
;
172 UINTN ModeTransitionOffset
;
173 } MP_ASSEMBLY_ADDRESS_MAP
;
175 typedef struct _CPU_MP_DATA CPU_MP_DATA
;
180 // MP CPU exchange information for AP reset code
181 // This structure is required to be packed because fixed field offsets
182 // into this structure are used in assembly code in this module
189 IA32_DESCRIPTOR GdtrProfile
;
190 IA32_DESCRIPTOR IdtrProfile
;
196 UINTN EnableExecuteDisable
;
199 CPU_INFO_IN_HOB
*CpuInfo
;
200 UINTN NumApsExecuting
;
201 CPU_MP_DATA
*CpuMpData
;
202 UINTN InitializeFloatingPointUnitsAddress
;
203 UINT32 ModeTransitionMemory
;
204 UINT16 ModeTransitionSegment
;
205 UINT32 ModeHighMemory
;
206 UINT16 ModeHighSegment
;
208 // Enable5LevelPaging indicates whether 5-level paging is enabled in long mode.
210 BOOLEAN Enable5LevelPaging
;
211 } MP_CPU_EXCHANGE_INFO
;
216 // CPU MP Data save in memory
218 struct _CPU_MP_DATA
{
222 UINT64 MicrocodePatchAddress
;
223 UINT64 MicrocodePatchRegionSize
;
225 // The above fields data will be passed from PEI to DXE
226 // Please make sure the fields offset same in the different
231 UINTN CpuApStackSize
;
232 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
234 UINTN WakeupBufferHigh
;
236 UINTN BackupBufferSize
;
238 volatile UINT32 FinishedCount
;
240 BOOLEAN SingleThread
;
241 EFI_AP_PROCEDURE Procedure
;
248 UINTN
**FailedCpuList
;
250 AP_INIT_STATE InitFlag
;
251 BOOLEAN SwitchBspFlag
;
253 CPU_EXCHANGE_ROLE_INFO BSPInfo
;
254 CPU_EXCHANGE_ROLE_INFO APInfo
;
255 MTRR_SETTINGS MtrrTable
;
257 UINT8 ApTargetCState
;
258 UINT16 PmCodeSegment
;
259 CPU_AP_DATA
*CpuData
;
260 volatile MP_CPU_EXCHANGE_INFO
*MpCpuExchangeInfo
;
262 UINT32 CurrentTimerCount
;
265 BOOLEAN PeriodicMode
;
266 BOOLEAN TimerInterruptState
;
269 // Whether need to use Init-Sipi-Sipi to wake up the APs.
270 // Two cases need to set this value to TRUE. One is in HLT
271 // loop mode, the other is resume from S3 which loop mode
272 // will be hardcode change to HLT mode by PiSmmCpuDxeSmm
275 BOOLEAN WakeUpByInitSipiSipi
;
278 extern EFI_GUID mCpuInitMpLibHobGuid
;
281 Assembly code to place AP into safe loop mode.
283 Place AP into targeted C-State if MONITOR is supported, otherwise
284 place AP into hlt state.
285 Place AP in protected mode if the current is long mode. Due to AP maybe
286 wakeup by some hardware event. It could avoid accessing page table that
287 may not available during booting to OS.
289 @param[in] MwaitSupport TRUE indicates MONITOR is supported.
290 FALSE indicates MONITOR is not supported.
291 @param[in] ApTargetCState Target C-State value.
292 @param[in] PmCodeSegment Protected mode code segment value.
296 (EFIAPI
* ASM_RELOCATE_AP_LOOP
) (
297 IN BOOLEAN MwaitSupport
,
298 IN UINTN ApTargetCState
,
299 IN UINTN PmCodeSegment
,
300 IN UINTN TopOfApStack
,
301 IN UINTN NumberToFinish
305 Assembly code to get starting address and size of the rendezvous entry for APs.
306 Information for fixing a jump instruction in the code is also returned.
308 @param[out] AddressMap Output buffer for address map information.
313 OUT MP_ASSEMBLY_ADDRESS_MAP
*AddressMap
317 This function is called by both the BSP and the AP which is to become the BSP to
318 Exchange execution context including stack between them. After return from this
319 function, the BSP becomes AP and the AP becomes the BSP.
321 @param[in] MyInfo Pointer to buffer holding the exchanging information for the executing processor.
322 @param[in] OthersInfo Pointer to buffer holding the exchanging information for the peer.
328 IN CPU_EXCHANGE_ROLE_INFO
*MyInfo
,
329 IN CPU_EXCHANGE_ROLE_INFO
*OthersInfo
333 Get the pointer to CPU MP Data structure.
335 @return The pointer to CPU MP Data structure.
343 Save the pointer to CPU MP Data structure.
345 @param[in] CpuMpData The pointer to CPU MP Data structure will be saved.
349 IN CPU_MP_DATA
*CpuMpData
354 Get available system memory below 1MB by specified size.
356 @param[in] WakeupBufferSize Wakeup buffer size required
358 @retval other Return wakeup buffer address below 1MB.
359 @retval -1 Cannot find free memory below 1MB.
363 IN UINTN WakeupBufferSize
367 Get available EfiBootServicesCode memory below 4GB by specified size.
369 This buffer is required to safely transfer AP from real address mode to
370 protected mode or long mode, due to the fact that the buffer returned by
371 GetWakeupBuffer() may be marked as non-executable.
373 @param[in] BufferSize Wakeup transition buffer size.
375 @retval other Return wakeup transition buffer address below 4GB.
376 @retval 0 Cannot find free memory below 4GB.
379 GetModeTransitionBuffer (
384 This function will be called by BSP to wakeup AP.
386 @param[in] CpuMpData Pointer to CPU MP Data
387 @param[in] Broadcast TRUE: Send broadcast IPI to all APs
388 FALSE: Send IPI to AP by ApicId
389 @param[in] ProcessorNumber The handle number of specified processor
390 @param[in] Procedure The function to be invoked by AP
391 @param[in] ProcedureArgument The argument to be passed into AP function
392 @param[in] WakeUpDisabledAps Whether need to wake up disabled APs in broadcast mode.
396 IN CPU_MP_DATA
*CpuMpData
,
397 IN BOOLEAN Broadcast
,
398 IN UINTN ProcessorNumber
,
399 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
400 IN VOID
*ProcedureArgument
, OPTIONAL
401 IN BOOLEAN WakeUpDisabledAps OPTIONAL
405 Initialize global data for MP support.
407 @param[in] CpuMpData The pointer to CPU MP Data structure.
411 IN CPU_MP_DATA
*CpuMpData
415 Worker function to execute a caller provided function on all enabled APs.
417 @param[in] Procedure A pointer to the function to be run on
418 enabled APs of the system.
419 @param[in] SingleThread If TRUE, then all the enabled APs execute
420 the function specified by Procedure one by
421 one, in ascending order of processor handle
422 number. If FALSE, then all the enabled APs
423 execute the function specified by Procedure
425 @param[in] ExcludeBsp Whether let BSP also trig this task.
426 @param[in] WaitEvent The event created by the caller with CreateEvent()
428 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
429 APs to return from Procedure, either for
430 blocking or non-blocking mode.
431 @param[in] ProcedureArgument The parameter passed into Procedure for
433 @param[out] FailedCpuList If all APs finish successfully, then its
434 content is set to NULL. If not all APs
435 finish before timeout expires, then its
436 content is set to address of the buffer
437 holding handle numbers of the failed APs.
439 @retval EFI_SUCCESS In blocking mode, all APs have finished before
441 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched
443 @retval others Failed to Startup all APs.
447 StartupAllCPUsWorker (
448 IN EFI_AP_PROCEDURE Procedure
,
449 IN BOOLEAN SingleThread
,
450 IN BOOLEAN ExcludeBsp
,
451 IN EFI_EVENT WaitEvent OPTIONAL
,
452 IN UINTN TimeoutInMicroseconds
,
453 IN VOID
*ProcedureArgument OPTIONAL
,
454 OUT UINTN
**FailedCpuList OPTIONAL
458 Worker function to let the caller get one enabled AP to execute a caller-provided
461 @param[in] Procedure A pointer to the function to be run on
462 enabled APs of the system.
463 @param[in] ProcessorNumber The handle number of the AP.
464 @param[in] WaitEvent The event created by the caller with CreateEvent()
466 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
467 APs to return from Procedure, either for
468 blocking or non-blocking mode.
469 @param[in] ProcedureArgument The parameter passed into Procedure for
471 @param[out] Finished If AP returns from Procedure before the
472 timeout expires, its content is set to TRUE.
473 Otherwise, the value is set to FALSE.
475 @retval EFI_SUCCESS In blocking mode, specified AP finished before
477 @retval others Failed to Startup AP.
481 StartupThisAPWorker (
482 IN EFI_AP_PROCEDURE Procedure
,
483 IN UINTN ProcessorNumber
,
484 IN EFI_EVENT WaitEvent OPTIONAL
,
485 IN UINTN TimeoutInMicroseconds
,
486 IN VOID
*ProcedureArgument OPTIONAL
,
487 OUT BOOLEAN
*Finished OPTIONAL
491 Worker function to switch the requested AP to be the BSP from that point onward.
493 @param[in] ProcessorNumber The handle number of AP that is to become the new BSP.
494 @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an
495 enabled AP. Otherwise, it will be disabled.
497 @retval EFI_SUCCESS BSP successfully switched.
498 @retval others Failed to switch BSP.
503 IN UINTN ProcessorNumber
,
504 IN BOOLEAN EnableOldBSP
508 Worker function to let the caller enable or disable an AP from this point onward.
509 This service may only be called from the BSP.
511 @param[in] ProcessorNumber The handle number of AP.
512 @param[in] EnableAP Specifies the new state for the processor for
513 enabled, FALSE for disabled.
514 @param[in] HealthFlag If not NULL, a pointer to a value that specifies
515 the new health status of the AP.
517 @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
518 @retval others Failed to Enable/Disable AP.
522 EnableDisableApWorker (
523 IN UINTN ProcessorNumber
,
525 IN UINT32
*HealthFlag OPTIONAL
529 Get pointer to CPU MP Data structure from GUIDed HOB.
531 @return The pointer to CPU MP Data structure.
534 GetCpuMpDataFromGuidedHob (
538 /** Checks status of specified AP.
540 This function checks whether the specified AP has finished the task assigned
541 by StartupThisAP(), and whether timeout expires.
543 @param[in] ProcessorNumber The handle number of processor.
545 @retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().
546 @retval EFI_TIMEOUT The timeout expires.
547 @retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.
551 IN UINTN ProcessorNumber
555 Checks status of all APs.
557 This function checks whether all APs have finished task assigned by StartupAllAPs(),
558 and whether timeout expires.
560 @retval EFI_SUCCESS All APs have finished task assigned by StartupAllAPs().
561 @retval EFI_TIMEOUT The timeout expires.
562 @retval EFI_NOT_READY APs have not finished task and timeout has not expired.
570 Checks APs status and updates APs status if needed.
574 CheckAndUpdateApsStatus (
579 Detect whether specified processor can find matching microcode patch and load it.
581 @param[in] CpuMpData The pointer to CPU MP Data structure.
582 @param[in] ProcessorNumber The handle number of the processor. The range is
583 from 0 to the total number of logical processors
588 IN CPU_MP_DATA
*CpuMpData
,
589 IN UINTN ProcessorNumber
593 Shadow the required microcode patches data into memory.
595 @param[in, out] CpuMpData The pointer to CPU MP Data structure.
598 ShadowMicrocodeUpdatePatch (
599 IN OUT CPU_MP_DATA
*CpuMpData
603 Detect whether Mwait-monitor feature is supported.
605 @retval TRUE Mwait-monitor feature is supported.
606 @retval FALSE Mwait-monitor feature is not supported.
614 Enable Debug Agent to support source debugging on AP function.
623 Find the current Processor number by APIC ID.
625 @param[in] CpuMpData Pointer to PEI CPU MP Data
626 @param[out] ProcessorNumber Return the pocessor number found
628 @retval EFI_SUCCESS ProcessorNumber is found and returned.
629 @retval EFI_NOT_FOUND ProcessorNumber is not found.
633 IN CPU_MP_DATA
*CpuMpData
,
634 OUT UINTN
*ProcessorNumber