2 Common header file for MP Initialize Library.
4 Copyright (c) 2016, 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
;
172 UINTN NumApsExecuting
;
175 UINTN EnableExecuteDisable
;
178 CPU_INFO_IN_HOB
*CpuInfo
;
179 CPU_MP_DATA
*CpuMpData
;
180 } MP_CPU_EXCHANGE_INFO
;
185 // CPU MP Data save in memory
187 struct _CPU_MP_DATA
{
192 // The above fields data will be passed from PEI to DXE
193 // Please make sure the fields offset same in the different
198 UINTN CpuApStackSize
;
199 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
202 UINTN BackupBufferSize
;
203 BOOLEAN SaveRestoreFlag
;
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
;
238 extern EFI_GUID mCpuInitMpLibHobGuid
;
241 Assembly code to place AP into safe loop mode.
243 Place AP into targeted C-State if MONITOR is supported, otherwise
244 place AP into hlt state.
245 Place AP in protected mode if the current is long mode. Due to AP maybe
246 wakeup by some hardware event. It could avoid accessing page table that
247 may not available during booting to OS.
249 @param[in] MwaitSupport TRUE indicates MONITOR is supported.
250 FALSE indicates MONITOR is not supported.
251 @param[in] ApTargetCState Target C-State value.
252 @param[in] PmCodeSegment Protected mode code segment value.
256 (EFIAPI
* ASM_RELOCATE_AP_LOOP
) (
257 IN BOOLEAN MwaitSupport
,
258 IN UINTN ApTargetCState
,
259 IN UINTN PmCodeSegment
,
260 IN UINTN TopOfApStack
,
261 IN UINTN NumberToFinish
265 Assembly code to get starting address and size of the rendezvous entry for APs.
266 Information for fixing a jump instruction in the code is also returned.
268 @param[out] AddressMap Output buffer for address map information.
273 OUT MP_ASSEMBLY_ADDRESS_MAP
*AddressMap
277 This function is called by both the BSP and the AP which is to become the BSP to
278 Exchange execution context including stack between them. After return from this
279 function, the BSP becomes AP and the AP becomes the BSP.
281 @param[in] MyInfo Pointer to buffer holding the exchanging information for the executing processor.
282 @param[in] OthersInfo Pointer to buffer holding the exchanging information for the peer.
288 IN CPU_EXCHANGE_ROLE_INFO
*MyInfo
,
289 IN CPU_EXCHANGE_ROLE_INFO
*OthersInfo
293 Get the pointer to CPU MP Data structure.
295 @return The pointer to CPU MP Data structure.
303 Save the pointer to CPU MP Data structure.
305 @param[in] CpuMpData The pointer to CPU MP Data structure will be saved.
309 IN CPU_MP_DATA
*CpuMpData
313 Allocate reset vector buffer.
315 @param[in, out] CpuMpData The pointer to CPU MP Data structure.
318 AllocateResetVector (
319 IN OUT CPU_MP_DATA
*CpuMpData
323 Free AP reset vector buffer.
325 @param[in] CpuMpData The pointer to CPU MP Data structure.
329 IN CPU_MP_DATA
*CpuMpData
333 This function will be called by BSP to wakeup AP.
335 @param[in] CpuMpData Pointer to CPU MP Data
336 @param[in] Broadcast TRUE: Send broadcast IPI to all APs
337 FALSE: Send IPI to AP by ApicId
338 @param[in] ProcessorNumber The handle number of specified processor
339 @param[in] Procedure The function to be invoked by AP
340 @param[in] ProcedureArgument The argument to be passed into AP function
344 IN CPU_MP_DATA
*CpuMpData
,
345 IN BOOLEAN Broadcast
,
346 IN UINTN ProcessorNumber
,
347 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
348 IN VOID
*ProcedureArgument OPTIONAL
352 Initialize global data for MP support.
354 @param[in] CpuMpData The pointer to CPU MP Data structure.
358 IN CPU_MP_DATA
*CpuMpData
362 Worker function to execute a caller provided function on all enabled APs.
364 @param[in] Procedure A pointer to the function to be run on
365 enabled APs of the system.
366 @param[in] SingleThread If TRUE, then all the enabled APs execute
367 the function specified by Procedure one by
368 one, in ascending order of processor handle
369 number. If FALSE, then all the enabled APs
370 execute the function specified by Procedure
372 @param[in] WaitEvent The event created by the caller with CreateEvent()
374 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
375 APs to return from Procedure, either for
376 blocking or non-blocking mode.
377 @param[in] ProcedureArgument The parameter passed into Procedure for
379 @param[out] FailedCpuList If all APs finish successfully, then its
380 content is set to NULL. If not all APs
381 finish before timeout expires, then its
382 content is set to address of the buffer
383 holding handle numbers of the failed APs.
385 @retval EFI_SUCCESS In blocking mode, all APs have finished before
387 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched
389 @retval others Failed to Startup all APs.
393 StartupAllAPsWorker (
394 IN EFI_AP_PROCEDURE Procedure
,
395 IN BOOLEAN SingleThread
,
396 IN EFI_EVENT WaitEvent OPTIONAL
,
397 IN UINTN TimeoutInMicroseconds
,
398 IN VOID
*ProcedureArgument OPTIONAL
,
399 OUT UINTN
**FailedCpuList OPTIONAL
403 Worker function to let the caller get one enabled AP to execute a caller-provided
406 @param[in] Procedure A pointer to the function to be run on
407 enabled APs of the system.
408 @param[in] ProcessorNumber The handle number of the AP.
409 @param[in] WaitEvent The event created by the caller with CreateEvent()
411 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
412 APs to return from Procedure, either for
413 blocking or non-blocking mode.
414 @param[in] ProcedureArgument The parameter passed into Procedure for
416 @param[out] Finished If AP returns from Procedure before the
417 timeout expires, its content is set to TRUE.
418 Otherwise, the value is set to FALSE.
420 @retval EFI_SUCCESS In blocking mode, specified AP finished before
422 @retval others Failed to Startup AP.
426 StartupThisAPWorker (
427 IN EFI_AP_PROCEDURE Procedure
,
428 IN UINTN ProcessorNumber
,
429 IN EFI_EVENT WaitEvent OPTIONAL
,
430 IN UINTN TimeoutInMicroseconds
,
431 IN VOID
*ProcedureArgument OPTIONAL
,
432 OUT BOOLEAN
*Finished OPTIONAL
436 Worker function to switch the requested AP to be the BSP from that point onward.
438 @param[in] ProcessorNumber The handle number of AP that is to become the new BSP.
439 @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an
440 enabled AP. Otherwise, it will be disabled.
442 @retval EFI_SUCCESS BSP successfully switched.
443 @retval others Failed to switch BSP.
448 IN UINTN ProcessorNumber
,
449 IN BOOLEAN EnableOldBSP
453 Worker function to let the caller enable or disable an AP from this point onward.
454 This service may only be called from the BSP.
456 @param[in] ProcessorNumber The handle number of AP.
457 @param[in] EnableAP Specifies the new state for the processor for
458 enabled, FALSE for disabled.
459 @param[in] HealthFlag If not NULL, a pointer to a value that specifies
460 the new health status of the AP.
462 @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
463 @retval others Failed to Enable/Disable AP.
467 EnableDisableApWorker (
468 IN UINTN ProcessorNumber
,
470 IN UINT32
*HealthFlag OPTIONAL
474 Get pointer to CPU MP Data structure from GUIDed HOB.
476 @return The pointer to CPU MP Data structure.
479 GetCpuMpDataFromGuidedHob (
483 /** Checks status of specified AP.
485 This function checks whether the specified AP has finished the task assigned
486 by StartupThisAP(), and whether timeout expires.
488 @param[in] ProcessorNumber The handle number of processor.
490 @retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().
491 @retval EFI_TIMEOUT The timeout expires.
492 @retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.
496 IN UINTN ProcessorNumber
500 Checks status of all APs.
502 This function checks whether all APs have finished task assigned by StartupAllAPs(),
503 and whether timeout expires.
505 @retval EFI_SUCCESS All APs have finished task assigned by StartupAllAPs().
506 @retval EFI_TIMEOUT The timeout expires.
507 @retval EFI_NOT_READY APs have not finished task and timeout has not expired.
515 Checks APs status and updates APs status if needed.
519 CheckAndUpdateApsStatus (
524 Detect whether specified processor can find matching microcode patch and load it.
526 @param[in] CpuMpData The pointer to CPU MP Data structure.
530 IN CPU_MP_DATA
*CpuMpData
534 Detect whether Mwait-monitor feature is supported.
536 @retval TRUE Mwait-monitor feature is supported.
537 @retval FALSE Mwait-monitor feature is not supported.
545 Notify function on End Of PEI PPI.
547 On S3 boot, this function will restore wakeup buffer data.
548 On normal boot, this function will flag wakeup buffer to be un-used type.
550 @param[in] PeiServices The pointer to the PEI Services Table.
551 @param[in] NotifyDescriptor Address of the notification descriptor data structure.
552 @param[in] Ppi Address of the PPI that was installed.
554 @retval EFI_SUCCESS When everything is OK.
558 CpuMpEndOfPeiCallback (
559 IN EFI_PEI_SERVICES
**PeiServices
,
560 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDescriptor
,
565 Get available system memory below 1MB by specified size.
567 @param[in] CpuMpData The pointer to CPU MP Data structure.
570 BackupAndPrepareWakeupBuffer(
571 IN CPU_MP_DATA
*CpuMpData
575 Restore wakeup buffer data.
577 @param[in] CpuMpData The pointer to CPU MP Data structure.
581 IN CPU_MP_DATA
*CpuMpData
585 Enable Debug Agent to support source debugging on AP function.