2 Common header file for MP Initialize Library.
4 Copyright (c) 2016 - 2017, 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
93 // CPU volatile registers around INIT-SIPI-SIPI
105 IA32_DESCRIPTOR Gdtr
;
106 IA32_DESCRIPTOR Idtr
;
108 } CPU_VOLATILE_REGISTERS
;
115 volatile UINT32
*StartupApSignal
;
116 volatile UINTN ApFunction
;
117 volatile UINTN ApFunctionArgument
;
119 volatile CPU_STATE State
;
120 CPU_VOLATILE_REGISTERS VolatileRegisters
;
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
;
190 } MP_CPU_EXCHANGE_INFO
;
195 // CPU MP Data save in memory
197 struct _CPU_MP_DATA
{
202 // The above fields data will be passed from PEI to DXE
203 // Please make sure the fields offset same in the different
208 UINTN CpuApStackSize
;
209 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
212 UINTN BackupBufferSize
;
214 volatile UINT32 StartCount
;
215 volatile UINT32 FinishedCount
;
216 volatile UINT32 RunningCount
;
217 BOOLEAN SingleThread
;
218 EFI_AP_PROCEDURE Procedure
;
225 UINTN
**FailedCpuList
;
227 AP_INIT_STATE InitFlag
;
228 BOOLEAN X2ApicEnable
;
229 BOOLEAN SwitchBspFlag
;
231 CPU_EXCHANGE_ROLE_INFO BSPInfo
;
232 CPU_EXCHANGE_ROLE_INFO APInfo
;
233 MTRR_SETTINGS MtrrTable
;
235 UINT8 ApTargetCState
;
236 UINT16 PmCodeSegment
;
237 CPU_AP_DATA
*CpuData
;
238 volatile MP_CPU_EXCHANGE_INFO
*MpCpuExchangeInfo
;
240 UINT32 CurrentTimerCount
;
243 BOOLEAN PeriodicMode
;
244 BOOLEAN TimerInterruptState
;
245 UINT64 MicrocodePatchAddress
;
246 UINT64 MicrocodePatchRegionSize
;
249 extern EFI_GUID mCpuInitMpLibHobGuid
;
252 Assembly code to place AP into safe loop mode.
254 Place AP into targeted C-State if MONITOR is supported, otherwise
255 place AP into hlt state.
256 Place AP in protected mode if the current is long mode. Due to AP maybe
257 wakeup by some hardware event. It could avoid accessing page table that
258 may not available during booting to OS.
260 @param[in] MwaitSupport TRUE indicates MONITOR is supported.
261 FALSE indicates MONITOR is not supported.
262 @param[in] ApTargetCState Target C-State value.
263 @param[in] PmCodeSegment Protected mode code segment value.
267 (EFIAPI
* ASM_RELOCATE_AP_LOOP
) (
268 IN BOOLEAN MwaitSupport
,
269 IN UINTN ApTargetCState
,
270 IN UINTN PmCodeSegment
,
271 IN UINTN TopOfApStack
,
272 IN UINTN NumberToFinish
276 Assembly code to get starting address and size of the rendezvous entry for APs.
277 Information for fixing a jump instruction in the code is also returned.
279 @param[out] AddressMap Output buffer for address map information.
284 OUT MP_ASSEMBLY_ADDRESS_MAP
*AddressMap
288 This function is called by both the BSP and the AP which is to become the BSP to
289 Exchange execution context including stack between them. After return from this
290 function, the BSP becomes AP and the AP becomes the BSP.
292 @param[in] MyInfo Pointer to buffer holding the exchanging information for the executing processor.
293 @param[in] OthersInfo Pointer to buffer holding the exchanging information for the peer.
299 IN CPU_EXCHANGE_ROLE_INFO
*MyInfo
,
300 IN CPU_EXCHANGE_ROLE_INFO
*OthersInfo
304 Get the pointer to CPU MP Data structure.
306 @return The pointer to CPU MP Data structure.
314 Save the pointer to CPU MP Data structure.
316 @param[in] CpuMpData The pointer to CPU MP Data structure will be saved.
320 IN CPU_MP_DATA
*CpuMpData
325 Get available system memory below 1MB by specified size.
327 @param[in] WakeupBufferSize Wakeup buffer size required
329 @retval other Return wakeup buffer address below 1MB.
330 @retval -1 Cannot find free memory below 1MB.
334 IN UINTN WakeupBufferSize
338 Get available EfiBootServicesCode memory below 4GB by specified size.
340 This buffer is required to safely transfer AP from real address mode to
341 protected mode or long mode, due to the fact that the buffer returned by
342 GetWakeupBuffer() may be marked as non-executable.
344 @param[in] BufferSize Wakeup transition buffer size.
346 @retval other Return wakeup transition buffer address below 4GB.
347 @retval 0 Cannot find free memory below 4GB.
350 GetModeTransitionBuffer (
355 This function will be called by BSP to wakeup AP.
357 @param[in] CpuMpData Pointer to CPU MP Data
358 @param[in] Broadcast TRUE: Send broadcast IPI to all APs
359 FALSE: Send IPI to AP by ApicId
360 @param[in] ProcessorNumber The handle number of specified processor
361 @param[in] Procedure The function to be invoked by AP
362 @param[in] ProcedureArgument The argument to be passed into AP function
366 IN CPU_MP_DATA
*CpuMpData
,
367 IN BOOLEAN Broadcast
,
368 IN UINTN ProcessorNumber
,
369 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
370 IN VOID
*ProcedureArgument OPTIONAL
374 Initialize global data for MP support.
376 @param[in] CpuMpData The pointer to CPU MP Data structure.
380 IN CPU_MP_DATA
*CpuMpData
384 Worker function to execute a caller provided function on all enabled APs.
386 @param[in] Procedure A pointer to the function to be run on
387 enabled APs of the system.
388 @param[in] SingleThread If TRUE, then all the enabled APs execute
389 the function specified by Procedure one by
390 one, in ascending order of processor handle
391 number. If FALSE, then all the enabled APs
392 execute the function specified by Procedure
394 @param[in] WaitEvent The event created by the caller with CreateEvent()
396 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
397 APs to return from Procedure, either for
398 blocking or non-blocking mode.
399 @param[in] ProcedureArgument The parameter passed into Procedure for
401 @param[out] FailedCpuList If all APs finish successfully, then its
402 content is set to NULL. If not all APs
403 finish before timeout expires, then its
404 content is set to address of the buffer
405 holding handle numbers of the failed APs.
407 @retval EFI_SUCCESS In blocking mode, all APs have finished before
409 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched
411 @retval others Failed to Startup all APs.
415 StartupAllAPsWorker (
416 IN EFI_AP_PROCEDURE Procedure
,
417 IN BOOLEAN SingleThread
,
418 IN EFI_EVENT WaitEvent OPTIONAL
,
419 IN UINTN TimeoutInMicroseconds
,
420 IN VOID
*ProcedureArgument OPTIONAL
,
421 OUT UINTN
**FailedCpuList OPTIONAL
425 Worker function to let the caller get one enabled AP to execute a caller-provided
428 @param[in] Procedure A pointer to the function to be run on
429 enabled APs of the system.
430 @param[in] ProcessorNumber The handle number of the AP.
431 @param[in] WaitEvent The event created by the caller with CreateEvent()
433 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
434 APs to return from Procedure, either for
435 blocking or non-blocking mode.
436 @param[in] ProcedureArgument The parameter passed into Procedure for
438 @param[out] Finished If AP returns from Procedure before the
439 timeout expires, its content is set to TRUE.
440 Otherwise, the value is set to FALSE.
442 @retval EFI_SUCCESS In blocking mode, specified AP finished before
444 @retval others Failed to Startup AP.
448 StartupThisAPWorker (
449 IN EFI_AP_PROCEDURE Procedure
,
450 IN UINTN ProcessorNumber
,
451 IN EFI_EVENT WaitEvent OPTIONAL
,
452 IN UINTN TimeoutInMicroseconds
,
453 IN VOID
*ProcedureArgument OPTIONAL
,
454 OUT BOOLEAN
*Finished OPTIONAL
458 Worker function to switch the requested AP to be the BSP from that point onward.
460 @param[in] ProcessorNumber The handle number of AP that is to become the new BSP.
461 @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an
462 enabled AP. Otherwise, it will be disabled.
464 @retval EFI_SUCCESS BSP successfully switched.
465 @retval others Failed to switch BSP.
470 IN UINTN ProcessorNumber
,
471 IN BOOLEAN EnableOldBSP
475 Worker function to let the caller enable or disable an AP from this point onward.
476 This service may only be called from the BSP.
478 @param[in] ProcessorNumber The handle number of AP.
479 @param[in] EnableAP Specifies the new state for the processor for
480 enabled, FALSE for disabled.
481 @param[in] HealthFlag If not NULL, a pointer to a value that specifies
482 the new health status of the AP.
484 @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
485 @retval others Failed to Enable/Disable AP.
489 EnableDisableApWorker (
490 IN UINTN ProcessorNumber
,
492 IN UINT32
*HealthFlag OPTIONAL
496 Get pointer to CPU MP Data structure from GUIDed HOB.
498 @return The pointer to CPU MP Data structure.
501 GetCpuMpDataFromGuidedHob (
505 /** Checks status of specified AP.
507 This function checks whether the specified AP has finished the task assigned
508 by StartupThisAP(), and whether timeout expires.
510 @param[in] ProcessorNumber The handle number of processor.
512 @retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().
513 @retval EFI_TIMEOUT The timeout expires.
514 @retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.
518 IN UINTN ProcessorNumber
522 Checks status of all APs.
524 This function checks whether all APs have finished task assigned by StartupAllAPs(),
525 and whether timeout expires.
527 @retval EFI_SUCCESS All APs have finished task assigned by StartupAllAPs().
528 @retval EFI_TIMEOUT The timeout expires.
529 @retval EFI_NOT_READY APs have not finished task and timeout has not expired.
537 Checks APs status and updates APs status if needed.
541 CheckAndUpdateApsStatus (
546 Detect whether specified processor can find matching microcode patch and load it.
548 @param[in] CpuMpData The pointer to CPU MP Data structure.
552 IN CPU_MP_DATA
*CpuMpData
556 Detect whether Mwait-monitor feature is supported.
558 @retval TRUE Mwait-monitor feature is supported.
559 @retval FALSE Mwait-monitor feature is not supported.
567 Enable Debug Agent to support source debugging on AP function.