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 } CPU_VOLATILE_REGISTERS
;
112 volatile UINT32
*StartupApSignal
;
113 volatile UINTN ApFunction
;
114 volatile UINTN ApFunctionArgument
;
116 volatile CPU_STATE State
;
117 CPU_VOLATILE_REGISTERS VolatileRegisters
;
127 // Basic CPU information saved in Guided HOB.
128 // Because the contents will be shard between PEI and DXE,
129 // we need to make sure the each fields offset same in different
134 UINT32 InitialApicId
;
142 // AP reset code information including code address and size,
143 // this structure will be shared be C code and assembly code.
144 // It is natural aligned by design.
147 UINT8
*RendezvousFunnelAddress
;
148 UINTN ModeEntryOffset
;
149 UINTN RendezvousFunnelSize
;
150 UINT8
*RelocateApLoopFuncAddress
;
151 UINTN RelocateApLoopFuncSize
;
152 } MP_ASSEMBLY_ADDRESS_MAP
;
154 typedef struct _CPU_MP_DATA CPU_MP_DATA
;
159 // MP CPU exchange information for AP reset code
160 // This structure is required to be packed because fixed field offsets
161 // into this structure are used in assembly code in this module
168 IA32_DESCRIPTOR GdtrProfile
;
169 IA32_DESCRIPTOR IdtrProfile
;
175 UINTN EnableExecuteDisable
;
178 CPU_INFO_IN_HOB
*CpuInfo
;
179 CPU_MP_DATA
*CpuMpData
;
180 UINTN InitializeFloatingPointUnitsAddress
;
181 } MP_CPU_EXCHANGE_INFO
;
186 // CPU MP Data save in memory
188 struct _CPU_MP_DATA
{
193 // The above fields data will be passed from PEI to DXE
194 // Please make sure the fields offset same in the different
199 UINTN CpuApStackSize
;
200 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
203 UINTN BackupBufferSize
;
205 volatile UINT32 StartCount
;
206 volatile UINT32 FinishedCount
;
207 volatile UINT32 RunningCount
;
208 BOOLEAN SingleThread
;
209 EFI_AP_PROCEDURE Procedure
;
216 UINTN
**FailedCpuList
;
218 AP_INIT_STATE InitFlag
;
219 BOOLEAN X2ApicEnable
;
220 BOOLEAN SwitchBspFlag
;
222 CPU_EXCHANGE_ROLE_INFO BSPInfo
;
223 CPU_EXCHANGE_ROLE_INFO APInfo
;
224 MTRR_SETTINGS MtrrTable
;
226 UINT8 ApTargetCState
;
227 UINT16 PmCodeSegment
;
228 CPU_AP_DATA
*CpuData
;
229 volatile MP_CPU_EXCHANGE_INFO
*MpCpuExchangeInfo
;
231 UINT32 CurrentTimerCount
;
234 BOOLEAN PeriodicMode
;
235 BOOLEAN TimerInterruptState
;
236 UINT64 MicrocodePatchAddress
;
237 UINT64 MicrocodePatchRegionSize
;
240 extern EFI_GUID mCpuInitMpLibHobGuid
;
243 Assembly code to place AP into safe loop mode.
245 Place AP into targeted C-State if MONITOR is supported, otherwise
246 place AP into hlt state.
247 Place AP in protected mode if the current is long mode. Due to AP maybe
248 wakeup by some hardware event. It could avoid accessing page table that
249 may not available during booting to OS.
251 @param[in] MwaitSupport TRUE indicates MONITOR is supported.
252 FALSE indicates MONITOR is not supported.
253 @param[in] ApTargetCState Target C-State value.
254 @param[in] PmCodeSegment Protected mode code segment value.
258 (EFIAPI
* ASM_RELOCATE_AP_LOOP
) (
259 IN BOOLEAN MwaitSupport
,
260 IN UINTN ApTargetCState
,
261 IN UINTN PmCodeSegment
,
262 IN UINTN TopOfApStack
,
263 IN UINTN NumberToFinish
267 Assembly code to get starting address and size of the rendezvous entry for APs.
268 Information for fixing a jump instruction in the code is also returned.
270 @param[out] AddressMap Output buffer for address map information.
275 OUT MP_ASSEMBLY_ADDRESS_MAP
*AddressMap
279 This function is called by both the BSP and the AP which is to become the BSP to
280 Exchange execution context including stack between them. After return from this
281 function, the BSP becomes AP and the AP becomes the BSP.
283 @param[in] MyInfo Pointer to buffer holding the exchanging information for the executing processor.
284 @param[in] OthersInfo Pointer to buffer holding the exchanging information for the peer.
290 IN CPU_EXCHANGE_ROLE_INFO
*MyInfo
,
291 IN CPU_EXCHANGE_ROLE_INFO
*OthersInfo
295 Get the pointer to CPU MP Data structure.
297 @return The pointer to CPU MP Data structure.
305 Save the pointer to CPU MP Data structure.
307 @param[in] CpuMpData The pointer to CPU MP Data structure will be saved.
311 IN CPU_MP_DATA
*CpuMpData
316 Get available system memory below 1MB by specified size.
318 @param[in] WakeupBufferSize Wakeup buffer size required
320 @retval other Return wakeup buffer address below 1MB.
321 @retval -1 Cannot find free memory below 1MB.
325 IN UINTN WakeupBufferSize
329 This function will be called by BSP to wakeup AP.
331 @param[in] CpuMpData Pointer to CPU MP Data
332 @param[in] Broadcast TRUE: Send broadcast IPI to all APs
333 FALSE: Send IPI to AP by ApicId
334 @param[in] ProcessorNumber The handle number of specified processor
335 @param[in] Procedure The function to be invoked by AP
336 @param[in] ProcedureArgument The argument to be passed into AP function
340 IN CPU_MP_DATA
*CpuMpData
,
341 IN BOOLEAN Broadcast
,
342 IN UINTN ProcessorNumber
,
343 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
344 IN VOID
*ProcedureArgument OPTIONAL
348 Initialize global data for MP support.
350 @param[in] CpuMpData The pointer to CPU MP Data structure.
354 IN CPU_MP_DATA
*CpuMpData
358 Worker function to execute a caller provided function on all enabled APs.
360 @param[in] Procedure A pointer to the function to be run on
361 enabled APs of the system.
362 @param[in] SingleThread If TRUE, then all the enabled APs execute
363 the function specified by Procedure one by
364 one, in ascending order of processor handle
365 number. If FALSE, then all the enabled APs
366 execute the function specified by Procedure
368 @param[in] WaitEvent The event created by the caller with CreateEvent()
370 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
371 APs to return from Procedure, either for
372 blocking or non-blocking mode.
373 @param[in] ProcedureArgument The parameter passed into Procedure for
375 @param[out] FailedCpuList If all APs finish successfully, then its
376 content is set to NULL. If not all APs
377 finish before timeout expires, then its
378 content is set to address of the buffer
379 holding handle numbers of the failed APs.
381 @retval EFI_SUCCESS In blocking mode, all APs have finished before
383 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched
385 @retval others Failed to Startup all APs.
389 StartupAllAPsWorker (
390 IN EFI_AP_PROCEDURE Procedure
,
391 IN BOOLEAN SingleThread
,
392 IN EFI_EVENT WaitEvent OPTIONAL
,
393 IN UINTN TimeoutInMicroseconds
,
394 IN VOID
*ProcedureArgument OPTIONAL
,
395 OUT UINTN
**FailedCpuList OPTIONAL
399 Worker function to let the caller get one enabled AP to execute a caller-provided
402 @param[in] Procedure A pointer to the function to be run on
403 enabled APs of the system.
404 @param[in] ProcessorNumber The handle number of the AP.
405 @param[in] WaitEvent The event created by the caller with CreateEvent()
407 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
408 APs to return from Procedure, either for
409 blocking or non-blocking mode.
410 @param[in] ProcedureArgument The parameter passed into Procedure for
412 @param[out] Finished If AP returns from Procedure before the
413 timeout expires, its content is set to TRUE.
414 Otherwise, the value is set to FALSE.
416 @retval EFI_SUCCESS In blocking mode, specified AP finished before
418 @retval others Failed to Startup AP.
422 StartupThisAPWorker (
423 IN EFI_AP_PROCEDURE Procedure
,
424 IN UINTN ProcessorNumber
,
425 IN EFI_EVENT WaitEvent OPTIONAL
,
426 IN UINTN TimeoutInMicroseconds
,
427 IN VOID
*ProcedureArgument OPTIONAL
,
428 OUT BOOLEAN
*Finished OPTIONAL
432 Worker function to switch the requested AP to be the BSP from that point onward.
434 @param[in] ProcessorNumber The handle number of AP that is to become the new BSP.
435 @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an
436 enabled AP. Otherwise, it will be disabled.
438 @retval EFI_SUCCESS BSP successfully switched.
439 @retval others Failed to switch BSP.
444 IN UINTN ProcessorNumber
,
445 IN BOOLEAN EnableOldBSP
449 Worker function to let the caller enable or disable an AP from this point onward.
450 This service may only be called from the BSP.
452 @param[in] ProcessorNumber The handle number of AP.
453 @param[in] EnableAP Specifies the new state for the processor for
454 enabled, FALSE for disabled.
455 @param[in] HealthFlag If not NULL, a pointer to a value that specifies
456 the new health status of the AP.
458 @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
459 @retval others Failed to Enable/Disable AP.
463 EnableDisableApWorker (
464 IN UINTN ProcessorNumber
,
466 IN UINT32
*HealthFlag OPTIONAL
470 Get pointer to CPU MP Data structure from GUIDed HOB.
472 @return The pointer to CPU MP Data structure.
475 GetCpuMpDataFromGuidedHob (
479 /** Checks status of specified AP.
481 This function checks whether the specified AP has finished the task assigned
482 by StartupThisAP(), and whether timeout expires.
484 @param[in] ProcessorNumber The handle number of processor.
486 @retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().
487 @retval EFI_TIMEOUT The timeout expires.
488 @retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.
492 IN UINTN ProcessorNumber
496 Checks status of all APs.
498 This function checks whether all APs have finished task assigned by StartupAllAPs(),
499 and whether timeout expires.
501 @retval EFI_SUCCESS All APs have finished task assigned by StartupAllAPs().
502 @retval EFI_TIMEOUT The timeout expires.
503 @retval EFI_NOT_READY APs have not finished task and timeout has not expired.
511 Checks APs status and updates APs status if needed.
515 CheckAndUpdateApsStatus (
520 Detect whether specified processor can find matching microcode patch and load it.
522 @param[in] CpuMpData The pointer to CPU MP Data structure.
526 IN CPU_MP_DATA
*CpuMpData
530 Detect whether Mwait-monitor feature is supported.
532 @retval TRUE Mwait-monitor feature is supported.
533 @retval FALSE Mwait-monitor feature is not supported.
541 Enable Debug Agent to support source debugging on AP function.