2 Common header file for MP Initialize Library.
4 Copyright (c) 2016 - 2020, Intel Corporation. All rights reserved.<BR>
5 Copyright (c) 2020, AMD Inc. All rights reserved.<BR>
7 SPDX-License-Identifier: BSD-2-Clause-Patent
16 #include <Register/Intel/Cpuid.h>
17 #include <Register/Amd/Cpuid.h>
18 #include <Register/Intel/Msr.h>
19 #include <Register/Intel/LocalApic.h>
20 #include <Register/Intel/Microcode.h>
22 #include <Library/MpInitLib.h>
23 #include <Library/BaseLib.h>
24 #include <Library/BaseMemoryLib.h>
25 #include <Library/MemoryAllocationLib.h>
26 #include <Library/DebugLib.h>
27 #include <Library/LocalApicLib.h>
28 #include <Library/CpuLib.h>
29 #include <Library/UefiCpuLib.h>
30 #include <Library/TimerLib.h>
31 #include <Library/SynchronizationLib.h>
32 #include <Library/MtrrLib.h>
33 #include <Library/HobLib.h>
35 #include <Guid/MicrocodePatchHob.h>
37 #define WAKEUP_AP_SIGNAL SIGNATURE_32 ('S', 'T', 'A', 'P')
39 #define CPU_INIT_MP_LIB_HOB_GUID \
41 0x58eb6a19, 0x3699, 0x4c68, { 0xa8, 0x36, 0xda, 0xcd, 0x8e, 0xdc, 0xad, 0x4a } \
45 // The MP data for switch BSP
47 #define CPU_SWITCH_STATE_IDLE 0
48 #define CPU_SWITCH_STATE_STORED 1
49 #define CPU_SWITCH_STATE_LOADED 2
52 // Default maximum number of entries to store the microcode patches information
54 #define DEFAULT_MAX_MICROCODE_PATCH_NUM 8
57 // Data structure for microcode patch information
62 } MICROCODE_PATCH_INFO
;
65 // CPU exchange information for switch BSP
68 UINT8 State
; // offset 0
69 UINTN StackPointer
; // offset 4 / 8
70 IA32_DESCRIPTOR Gdtr
; // offset 8 / 16
71 IA32_DESCRIPTOR Idtr
; // offset 14 / 26
72 } CPU_EXCHANGE_ROLE_INFO
;
75 // AP loop state when APs are in idle state
76 // It's value is the same with PcdCpuApLoopMode
85 // AP initialization state during APs wakeup
96 // The state transitions for an AP when it process a procedure are:
97 // Idle ----> Ready ----> Busy ----> Idle
109 // CPU volatile registers around INIT-SIPI-SIPI
121 IA32_DESCRIPTOR Gdtr
;
122 IA32_DESCRIPTOR Idtr
;
124 } CPU_VOLATILE_REGISTERS
;
131 volatile UINT32
*StartupApSignal
;
132 volatile UINTN ApFunction
;
133 volatile UINTN ApFunctionArgument
;
135 volatile CPU_STATE State
;
136 CPU_VOLATILE_REGISTERS VolatileRegisters
;
143 UINT32 ProcessorSignature
;
145 UINT64 MicrocodeEntryAddr
;
149 // Basic CPU information saved in Guided HOB.
150 // Because the contents will be shard between PEI and DXE,
151 // we need to make sure the each fields offset same in different
156 UINT32 InitialApicId
;
164 // AP reset code information including code address and size,
165 // this structure will be shared be C code and assembly code.
166 // It is natural aligned by design.
169 UINT8
*RendezvousFunnelAddress
;
170 UINTN ModeEntryOffset
;
171 UINTN RendezvousFunnelSize
;
172 UINT8
*RelocateApLoopFuncAddress
;
173 UINTN RelocateApLoopFuncSize
;
174 UINTN ModeTransitionOffset
;
175 } MP_ASSEMBLY_ADDRESS_MAP
;
177 typedef struct _CPU_MP_DATA CPU_MP_DATA
;
182 // MP CPU exchange information for AP reset code
183 // This structure is required to be packed because fixed field offsets
184 // into this structure are used in assembly code in this module
191 IA32_DESCRIPTOR GdtrProfile
;
192 IA32_DESCRIPTOR IdtrProfile
;
198 UINTN EnableExecuteDisable
;
201 CPU_INFO_IN_HOB
*CpuInfo
;
202 UINTN NumApsExecuting
;
203 CPU_MP_DATA
*CpuMpData
;
204 UINTN InitializeFloatingPointUnitsAddress
;
205 UINT32 ModeTransitionMemory
;
206 UINT16 ModeTransitionSegment
;
207 UINT32 ModeHighMemory
;
208 UINT16 ModeHighSegment
;
210 // Enable5LevelPaging indicates whether 5-level paging is enabled in long mode.
212 BOOLEAN Enable5LevelPaging
;
213 } MP_CPU_EXCHANGE_INFO
;
218 // CPU MP Data save in memory
220 struct _CPU_MP_DATA
{
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
;
267 UINT64 MicrocodePatchAddress
;
268 UINT64 MicrocodePatchRegionSize
;
271 // Whether need to use Init-Sipi-Sipi to wake up the APs.
272 // Two cases need to set this value to TRUE. One is in HLT
273 // loop mode, the other is resume from S3 which loop mode
274 // will be hardcode change to HLT mode by PiSmmCpuDxeSmm
277 BOOLEAN WakeUpByInitSipiSipi
;
280 extern EFI_GUID mCpuInitMpLibHobGuid
;
283 Assembly code to place AP into safe loop mode.
285 Place AP into targeted C-State if MONITOR is supported, otherwise
286 place AP into hlt state.
287 Place AP in protected mode if the current is long mode. Due to AP maybe
288 wakeup by some hardware event. It could avoid accessing page table that
289 may not available during booting to OS.
291 @param[in] MwaitSupport TRUE indicates MONITOR is supported.
292 FALSE indicates MONITOR is not supported.
293 @param[in] ApTargetCState Target C-State value.
294 @param[in] PmCodeSegment Protected mode code segment value.
298 (EFIAPI
* ASM_RELOCATE_AP_LOOP
) (
299 IN BOOLEAN MwaitSupport
,
300 IN UINTN ApTargetCState
,
301 IN UINTN PmCodeSegment
,
302 IN UINTN TopOfApStack
,
303 IN UINTN NumberToFinish
307 Assembly code to get starting address and size of the rendezvous entry for APs.
308 Information for fixing a jump instruction in the code is also returned.
310 @param[out] AddressMap Output buffer for address map information.
315 OUT MP_ASSEMBLY_ADDRESS_MAP
*AddressMap
319 This function is called by both the BSP and the AP which is to become the BSP to
320 Exchange execution context including stack between them. After return from this
321 function, the BSP becomes AP and the AP becomes the BSP.
323 @param[in] MyInfo Pointer to buffer holding the exchanging information for the executing processor.
324 @param[in] OthersInfo Pointer to buffer holding the exchanging information for the peer.
330 IN CPU_EXCHANGE_ROLE_INFO
*MyInfo
,
331 IN CPU_EXCHANGE_ROLE_INFO
*OthersInfo
335 Get the pointer to CPU MP Data structure.
337 @return The pointer to CPU MP Data structure.
345 Save the pointer to CPU MP Data structure.
347 @param[in] CpuMpData The pointer to CPU MP Data structure will be saved.
351 IN CPU_MP_DATA
*CpuMpData
356 Get available system memory below 1MB by specified size.
358 @param[in] WakeupBufferSize Wakeup buffer size required
360 @retval other Return wakeup buffer address below 1MB.
361 @retval -1 Cannot find free memory below 1MB.
365 IN UINTN WakeupBufferSize
369 Get available EfiBootServicesCode memory below 4GB by specified size.
371 This buffer is required to safely transfer AP from real address mode to
372 protected mode or long mode, due to the fact that the buffer returned by
373 GetWakeupBuffer() may be marked as non-executable.
375 @param[in] BufferSize Wakeup transition buffer size.
377 @retval other Return wakeup transition buffer address below 4GB.
378 @retval 0 Cannot find free memory below 4GB.
381 GetModeTransitionBuffer (
386 This function will be called by BSP to wakeup AP.
388 @param[in] CpuMpData Pointer to CPU MP Data
389 @param[in] Broadcast TRUE: Send broadcast IPI to all APs
390 FALSE: Send IPI to AP by ApicId
391 @param[in] ProcessorNumber The handle number of specified processor
392 @param[in] Procedure The function to be invoked by AP
393 @param[in] ProcedureArgument The argument to be passed into AP function
394 @param[in] WakeUpDisabledAps Whether need to wake up disabled APs in broadcast mode.
398 IN CPU_MP_DATA
*CpuMpData
,
399 IN BOOLEAN Broadcast
,
400 IN UINTN ProcessorNumber
,
401 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
402 IN VOID
*ProcedureArgument
, OPTIONAL
403 IN BOOLEAN WakeUpDisabledAps OPTIONAL
407 Initialize global data for MP support.
409 @param[in] CpuMpData The pointer to CPU MP Data structure.
413 IN CPU_MP_DATA
*CpuMpData
417 Worker function to execute a caller provided function on all enabled APs.
419 @param[in] Procedure A pointer to the function to be run on
420 enabled APs of the system.
421 @param[in] SingleThread If TRUE, then all the enabled APs execute
422 the function specified by Procedure one by
423 one, in ascending order of processor handle
424 number. If FALSE, then all the enabled APs
425 execute the function specified by Procedure
427 @param[in] ExcludeBsp Whether let BSP also trig this task.
428 @param[in] WaitEvent The event created by the caller with CreateEvent()
430 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
431 APs to return from Procedure, either for
432 blocking or non-blocking mode.
433 @param[in] ProcedureArgument The parameter passed into Procedure for
435 @param[out] FailedCpuList If all APs finish successfully, then its
436 content is set to NULL. If not all APs
437 finish before timeout expires, then its
438 content is set to address of the buffer
439 holding handle numbers of the failed APs.
441 @retval EFI_SUCCESS In blocking mode, all APs have finished before
443 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched
445 @retval others Failed to Startup all APs.
449 StartupAllCPUsWorker (
450 IN EFI_AP_PROCEDURE Procedure
,
451 IN BOOLEAN SingleThread
,
452 IN BOOLEAN ExcludeBsp
,
453 IN EFI_EVENT WaitEvent OPTIONAL
,
454 IN UINTN TimeoutInMicroseconds
,
455 IN VOID
*ProcedureArgument OPTIONAL
,
456 OUT UINTN
**FailedCpuList OPTIONAL
460 Worker function to let the caller get one enabled AP to execute a caller-provided
463 @param[in] Procedure A pointer to the function to be run on
464 enabled APs of the system.
465 @param[in] ProcessorNumber The handle number of the AP.
466 @param[in] WaitEvent The event created by the caller with CreateEvent()
468 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
469 APs to return from Procedure, either for
470 blocking or non-blocking mode.
471 @param[in] ProcedureArgument The parameter passed into Procedure for
473 @param[out] Finished If AP returns from Procedure before the
474 timeout expires, its content is set to TRUE.
475 Otherwise, the value is set to FALSE.
477 @retval EFI_SUCCESS In blocking mode, specified AP finished before
479 @retval others Failed to Startup AP.
483 StartupThisAPWorker (
484 IN EFI_AP_PROCEDURE Procedure
,
485 IN UINTN ProcessorNumber
,
486 IN EFI_EVENT WaitEvent OPTIONAL
,
487 IN UINTN TimeoutInMicroseconds
,
488 IN VOID
*ProcedureArgument OPTIONAL
,
489 OUT BOOLEAN
*Finished OPTIONAL
493 Worker function to switch the requested AP to be the BSP from that point onward.
495 @param[in] ProcessorNumber The handle number of AP that is to become the new BSP.
496 @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an
497 enabled AP. Otherwise, it will be disabled.
499 @retval EFI_SUCCESS BSP successfully switched.
500 @retval others Failed to switch BSP.
505 IN UINTN ProcessorNumber
,
506 IN BOOLEAN EnableOldBSP
510 Worker function to let the caller enable or disable an AP from this point onward.
511 This service may only be called from the BSP.
513 @param[in] ProcessorNumber The handle number of AP.
514 @param[in] EnableAP Specifies the new state for the processor for
515 enabled, FALSE for disabled.
516 @param[in] HealthFlag If not NULL, a pointer to a value that specifies
517 the new health status of the AP.
519 @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
520 @retval others Failed to Enable/Disable AP.
524 EnableDisableApWorker (
525 IN UINTN ProcessorNumber
,
527 IN UINT32
*HealthFlag OPTIONAL
531 Get pointer to CPU MP Data structure from GUIDed HOB.
533 @return The pointer to CPU MP Data structure.
536 GetCpuMpDataFromGuidedHob (
540 /** Checks status of specified AP.
542 This function checks whether the specified AP has finished the task assigned
543 by StartupThisAP(), and whether timeout expires.
545 @param[in] ProcessorNumber The handle number of processor.
547 @retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().
548 @retval EFI_TIMEOUT The timeout expires.
549 @retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.
553 IN UINTN ProcessorNumber
557 Checks status of all APs.
559 This function checks whether all APs have finished task assigned by StartupAllAPs(),
560 and whether timeout expires.
562 @retval EFI_SUCCESS All APs have finished task assigned by StartupAllAPs().
563 @retval EFI_TIMEOUT The timeout expires.
564 @retval EFI_NOT_READY APs have not finished task and timeout has not expired.
572 Checks APs status and updates APs status if needed.
576 CheckAndUpdateApsStatus (
581 Detect whether specified processor can find matching microcode patch and load it.
583 @param[in] CpuMpData The pointer to CPU MP Data structure.
584 @param[in] ProcessorNumber The handle number of the processor. The range is
585 from 0 to the total number of logical processors
590 IN CPU_MP_DATA
*CpuMpData
,
591 IN UINTN ProcessorNumber
595 Shadow the required microcode patches data into memory.
597 @param[in, out] CpuMpData The pointer to CPU MP Data structure.
600 ShadowMicrocodeUpdatePatch (
601 IN OUT CPU_MP_DATA
*CpuMpData
605 Get the cached microcode patch base address and size from the microcode patch
606 information cache HOB.
608 @param[out] Address Base address of the microcode patches data.
609 It will be updated if the microcode patch
610 information cache HOB is found.
611 @param[out] RegionSize Size of the microcode patches data.
612 It will be updated if the microcode patch
613 information cache HOB is found.
615 @retval TRUE The microcode patch information cache HOB is found.
616 @retval FALSE The microcode patch information cache HOB is not found.
620 GetMicrocodePatchInfoFromHob (
626 Detect whether Mwait-monitor feature is supported.
628 @retval TRUE Mwait-monitor feature is supported.
629 @retval FALSE Mwait-monitor feature is not supported.
637 Enable Debug Agent to support source debugging on AP function.
646 Find the current Processor number by APIC ID.
648 @param[in] CpuMpData Pointer to PEI CPU MP Data
649 @param[out] ProcessorNumber Return the pocessor number found
651 @retval EFI_SUCCESS ProcessorNumber is found and returned.
652 @retval EFI_NOT_FOUND ProcessorNumber is not found.
656 IN CPU_MP_DATA
*CpuMpData
,
657 OUT UINTN
*ProcessorNumber
661 This funtion will try to invoke platform specific microcode shadow logic to
662 relocate microcode update patches into memory.
664 @param[in] CpuMpData The pointer to CPU MP Data structure.
666 @retval EFI_SUCCESS Shadow microcode success.
667 @retval EFI_OUT_OF_RESOURCES No enough resource to complete the operation.
668 @retval EFI_UNSUPPORTED Can't find platform specific microcode shadow
672 PlatformShadowMicrocode (
673 IN OUT CPU_MP_DATA
*CpuMpData