2 Common header file for MP Initialize Library.
4 Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
20 #include <Register/Cpuid.h>
21 #include <Register/Msr.h>
22 #include <Register/LocalApic.h>
23 #include <Register/Microcode.h>
25 #include <Library/MpInitLib.h>
26 #include <Library/BaseLib.h>
27 #include <Library/BaseMemoryLib.h>
28 #include <Library/MemoryAllocationLib.h>
29 #include <Library/DebugLib.h>
30 #include <Library/LocalApicLib.h>
31 #include <Library/CpuLib.h>
32 #include <Library/UefiCpuLib.h>
33 #include <Library/TimerLib.h>
34 #include <Library/SynchronizationLib.h>
35 #include <Library/MtrrLib.h>
36 #include <Library/HobLib.h>
38 #define WAKEUP_AP_SIGNAL SIGNATURE_32 ('S', 'T', 'A', 'P')
40 #define CPU_INIT_MP_LIB_HOB_GUID \
42 0x58eb6a19, 0x3699, 0x4c68, { 0xa8, 0x36, 0xda, 0xcd, 0x8e, 0xdc, 0xad, 0x4a } \
46 // The MP data for switch BSP
48 #define CPU_SWITCH_STATE_IDLE 0
49 #define CPU_SWITCH_STATE_STORED 1
50 #define CPU_SWITCH_STATE_LOADED 2
53 // CPU exchange information for switch BSP
56 UINT8 State
; // offset 0
57 UINTN StackPointer
; // offset 4 / 8
58 IA32_DESCRIPTOR Gdtr
; // offset 8 / 16
59 IA32_DESCRIPTOR Idtr
; // offset 14 / 26
60 } CPU_EXCHANGE_ROLE_INFO
;
63 // AP loop state when APs are in idle state
64 // It's value is the same with PcdCpuApLoopMode
73 // AP initialization state during APs wakeup
84 // The state transitions for an AP when it process a procedure are:
85 // Idle ----> Ready ----> Busy ----> Idle
96 // CPU volatile registers around INIT-SIPI-SIPI
108 IA32_DESCRIPTOR Gdtr
;
109 IA32_DESCRIPTOR Idtr
;
111 } CPU_VOLATILE_REGISTERS
;
118 volatile UINT32
*StartupApSignal
;
119 volatile UINTN ApFunction
;
120 volatile UINTN ApFunctionArgument
;
122 volatile CPU_STATE State
;
123 CPU_VOLATILE_REGISTERS VolatileRegisters
;
133 // Basic CPU information saved in Guided HOB.
134 // Because the contents will be shard between PEI and DXE,
135 // we need to make sure the each fields offset same in different
140 UINT32 InitialApicId
;
148 // AP reset code information including code address and size,
149 // this structure will be shared be C code and assembly code.
150 // It is natural aligned by design.
153 UINT8
*RendezvousFunnelAddress
;
154 UINTN ModeEntryOffset
;
155 UINTN RendezvousFunnelSize
;
156 UINT8
*RelocateApLoopFuncAddress
;
157 UINTN RelocateApLoopFuncSize
;
158 UINTN ModeTransitionOffset
;
159 } MP_ASSEMBLY_ADDRESS_MAP
;
161 typedef struct _CPU_MP_DATA CPU_MP_DATA
;
166 // MP CPU exchange information for AP reset code
167 // This structure is required to be packed because fixed field offsets
168 // into this structure are used in assembly code in this module
175 IA32_DESCRIPTOR GdtrProfile
;
176 IA32_DESCRIPTOR IdtrProfile
;
182 UINTN EnableExecuteDisable
;
185 CPU_INFO_IN_HOB
*CpuInfo
;
186 UINTN NumApsExecuting
;
187 CPU_MP_DATA
*CpuMpData
;
188 UINTN InitializeFloatingPointUnitsAddress
;
189 UINT32 ModeTransitionMemory
;
190 UINT16 ModeTransitionSegment
;
191 UINT32 ModeHighMemory
;
192 UINT16 ModeHighSegment
;
193 } MP_CPU_EXCHANGE_INFO
;
198 // CPU MP Data save in memory
200 struct _CPU_MP_DATA
{
205 // The above fields data will be passed from PEI to DXE
206 // Please make sure the fields offset same in the different
211 UINTN CpuApStackSize
;
212 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
214 UINTN WakeupBufferHigh
;
216 UINTN BackupBufferSize
;
218 volatile UINT32 FinishedCount
;
220 BOOLEAN SingleThread
;
221 EFI_AP_PROCEDURE Procedure
;
228 UINTN
**FailedCpuList
;
230 AP_INIT_STATE InitFlag
;
231 BOOLEAN X2ApicEnable
;
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
383 IN CPU_MP_DATA
*CpuMpData
,
384 IN BOOLEAN Broadcast
,
385 IN UINTN ProcessorNumber
,
386 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
387 IN VOID
*ProcedureArgument OPTIONAL
391 Initialize global data for MP support.
393 @param[in] CpuMpData The pointer to CPU MP Data structure.
397 IN CPU_MP_DATA
*CpuMpData
401 Worker function to execute a caller provided function on all enabled APs.
403 @param[in] Procedure A pointer to the function to be run on
404 enabled APs of the system.
405 @param[in] SingleThread If TRUE, then all the enabled APs execute
406 the function specified by Procedure one by
407 one, in ascending order of processor handle
408 number. If FALSE, then all the enabled APs
409 execute the function specified by Procedure
411 @param[in] WaitEvent The event created by the caller with CreateEvent()
413 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
414 APs to return from Procedure, either for
415 blocking or non-blocking mode.
416 @param[in] ProcedureArgument The parameter passed into Procedure for
418 @param[out] FailedCpuList If all APs finish successfully, then its
419 content is set to NULL. If not all APs
420 finish before timeout expires, then its
421 content is set to address of the buffer
422 holding handle numbers of the failed APs.
424 @retval EFI_SUCCESS In blocking mode, all APs have finished before
426 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched
428 @retval others Failed to Startup all APs.
432 StartupAllAPsWorker (
433 IN EFI_AP_PROCEDURE Procedure
,
434 IN BOOLEAN SingleThread
,
435 IN EFI_EVENT WaitEvent OPTIONAL
,
436 IN UINTN TimeoutInMicroseconds
,
437 IN VOID
*ProcedureArgument OPTIONAL
,
438 OUT UINTN
**FailedCpuList OPTIONAL
442 Worker function to let the caller get one enabled AP to execute a caller-provided
445 @param[in] Procedure A pointer to the function to be run on
446 enabled APs of the system.
447 @param[in] ProcessorNumber The handle number of the AP.
448 @param[in] WaitEvent The event created by the caller with CreateEvent()
450 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
451 APs to return from Procedure, either for
452 blocking or non-blocking mode.
453 @param[in] ProcedureArgument The parameter passed into Procedure for
455 @param[out] Finished If AP returns from Procedure before the
456 timeout expires, its content is set to TRUE.
457 Otherwise, the value is set to FALSE.
459 @retval EFI_SUCCESS In blocking mode, specified AP finished before
461 @retval others Failed to Startup AP.
465 StartupThisAPWorker (
466 IN EFI_AP_PROCEDURE Procedure
,
467 IN UINTN ProcessorNumber
,
468 IN EFI_EVENT WaitEvent OPTIONAL
,
469 IN UINTN TimeoutInMicroseconds
,
470 IN VOID
*ProcedureArgument OPTIONAL
,
471 OUT BOOLEAN
*Finished OPTIONAL
475 Worker function to switch the requested AP to be the BSP from that point onward.
477 @param[in] ProcessorNumber The handle number of AP that is to become the new BSP.
478 @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an
479 enabled AP. Otherwise, it will be disabled.
481 @retval EFI_SUCCESS BSP successfully switched.
482 @retval others Failed to switch BSP.
487 IN UINTN ProcessorNumber
,
488 IN BOOLEAN EnableOldBSP
492 Worker function to let the caller enable or disable an AP from this point onward.
493 This service may only be called from the BSP.
495 @param[in] ProcessorNumber The handle number of AP.
496 @param[in] EnableAP Specifies the new state for the processor for
497 enabled, FALSE for disabled.
498 @param[in] HealthFlag If not NULL, a pointer to a value that specifies
499 the new health status of the AP.
501 @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
502 @retval others Failed to Enable/Disable AP.
506 EnableDisableApWorker (
507 IN UINTN ProcessorNumber
,
509 IN UINT32
*HealthFlag OPTIONAL
513 Get pointer to CPU MP Data structure from GUIDed HOB.
515 @return The pointer to CPU MP Data structure.
518 GetCpuMpDataFromGuidedHob (
522 /** Checks status of specified AP.
524 This function checks whether the specified AP has finished the task assigned
525 by StartupThisAP(), and whether timeout expires.
527 @param[in] ProcessorNumber The handle number of processor.
529 @retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().
530 @retval EFI_TIMEOUT The timeout expires.
531 @retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.
535 IN UINTN ProcessorNumber
539 Checks status of all APs.
541 This function checks whether all APs have finished task assigned by StartupAllAPs(),
542 and whether timeout expires.
544 @retval EFI_SUCCESS All APs have finished task assigned by StartupAllAPs().
545 @retval EFI_TIMEOUT The timeout expires.
546 @retval EFI_NOT_READY APs have not finished task and timeout has not expired.
554 Checks APs status and updates APs status if needed.
558 CheckAndUpdateApsStatus (
563 Detect whether specified processor can find matching microcode patch and load it.
565 @param[in] CpuMpData The pointer to CPU MP Data structure.
566 @param[in] IsBspCallIn Indicate whether the caller is BSP or not.
570 IN CPU_MP_DATA
*CpuMpData
,
571 IN BOOLEAN IsBspCallIn
575 Detect whether Mwait-monitor feature is supported.
577 @retval TRUE Mwait-monitor feature is supported.
578 @retval FALSE Mwait-monitor feature is not supported.
586 Enable Debug Agent to support source debugging on AP function.