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
133 UINT32 InitialApicId
;
140 // AP reset code information including code address and size,
141 // this structure will be shared be C code and assembly code.
142 // It is natural aligned by design.
145 UINT8
*RendezvousFunnelAddress
;
146 UINTN ModeEntryOffset
;
147 UINTN RendezvousFunnelSize
;
148 UINT8
*RelocateApLoopFuncAddress
;
149 UINTN RelocateApLoopFuncSize
;
150 } MP_ASSEMBLY_ADDRESS_MAP
;
152 typedef struct _CPU_MP_DATA CPU_MP_DATA
;
157 // MP CPU exchange information for AP reset code
158 // This structure is required to be packed because fixed field offsets
159 // into this structure are used in assembly code in this module
166 IA32_DESCRIPTOR GdtrProfile
;
167 IA32_DESCRIPTOR IdtrProfile
;
170 UINTN NumApsExecuting
;
173 UINTN EnableExecuteDisable
;
176 CPU_INFO_IN_HOB
*CpuInfo
;
177 CPU_MP_DATA
*CpuMpData
;
178 } MP_CPU_EXCHANGE_INFO
;
183 // CPU MP Data save in memory
185 struct _CPU_MP_DATA
{
190 // The above fields data will be passed from PEI to DXE
191 // Please make sure the fields offset same in the different
196 UINTN CpuApStackSize
;
197 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
200 UINTN BackupBufferSize
;
201 BOOLEAN SaveRestoreFlag
;
203 volatile UINT32 StartCount
;
204 volatile UINT32 FinishedCount
;
205 volatile UINT32 RunningCount
;
206 BOOLEAN SingleThread
;
207 EFI_AP_PROCEDURE Procedure
;
214 UINTN
**FailedCpuList
;
216 AP_INIT_STATE InitFlag
;
217 BOOLEAN X2ApicEnable
;
218 BOOLEAN SwitchBspFlag
;
219 CPU_EXCHANGE_ROLE_INFO BSPInfo
;
220 CPU_EXCHANGE_ROLE_INFO APInfo
;
221 MTRR_SETTINGS MtrrTable
;
223 UINT8 ApTargetCState
;
224 UINT16 PmCodeSegment
;
225 CPU_AP_DATA
*CpuData
;
226 volatile MP_CPU_EXCHANGE_INFO
*MpCpuExchangeInfo
;
229 extern EFI_GUID mCpuInitMpLibHobGuid
;
232 Assembly code to place AP into safe loop mode.
234 Place AP into targeted C-State if MONITOR is supported, otherwise
235 place AP into hlt state.
236 Place AP in protected mode if the current is long mode. Due to AP maybe
237 wakeup by some hardware event. It could avoid accessing page table that
238 may not available during booting to OS.
240 @param[in] MwaitSupport TRUE indicates MONITOR is supported.
241 FALSE indicates MONITOR is not supported.
242 @param[in] ApTargetCState Target C-State value.
243 @param[in] PmCodeSegment Protected mode code segment value.
247 (EFIAPI
* ASM_RELOCATE_AP_LOOP
) (
248 IN BOOLEAN MwaitSupport
,
249 IN UINTN ApTargetCState
,
250 IN UINTN PmCodeSegment
254 Assembly code to get starting address and size of the rendezvous entry for APs.
255 Information for fixing a jump instruction in the code is also returned.
257 @param[out] AddressMap Output buffer for address map information.
262 OUT MP_ASSEMBLY_ADDRESS_MAP
*AddressMap
266 This function is called by both the BSP and the AP which is to become the BSP to
267 Exchange execution context including stack between them. After return from this
268 function, the BSP becomes AP and the AP becomes the BSP.
270 @param[in] MyInfo Pointer to buffer holding the exchanging information for the executing processor.
271 @param[in] OthersInfo Pointer to buffer holding the exchanging information for the peer.
277 IN CPU_EXCHANGE_ROLE_INFO
*MyInfo
,
278 IN CPU_EXCHANGE_ROLE_INFO
*OthersInfo
282 Get the pointer to CPU MP Data structure.
284 @return The pointer to CPU MP Data structure.
292 Save the pointer to CPU MP Data structure.
294 @param[in] CpuMpData The pointer to CPU MP Data structure will be saved.
298 IN CPU_MP_DATA
*CpuMpData
302 Allocate reset vector buffer.
304 @param[in, out] CpuMpData The pointer to CPU MP Data structure.
307 AllocateResetVector (
308 IN OUT CPU_MP_DATA
*CpuMpData
312 Free AP reset vector buffer.
314 @param[in] CpuMpData The pointer to CPU MP Data structure.
318 IN CPU_MP_DATA
*CpuMpData
322 This function will be called by BSP to wakeup AP.
324 @param[in] CpuMpData Pointer to CPU MP Data
325 @param[in] Broadcast TRUE: Send broadcast IPI to all APs
326 FALSE: Send IPI to AP by ApicId
327 @param[in] ProcessorNumber The handle number of specified processor
328 @param[in] Procedure The function to be invoked by AP
329 @param[in] ProcedureArgument The argument to be passed into AP function
333 IN CPU_MP_DATA
*CpuMpData
,
334 IN BOOLEAN Broadcast
,
335 IN UINTN ProcessorNumber
,
336 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
337 IN VOID
*ProcedureArgument OPTIONAL
341 Initialize global data for MP support.
343 @param[in] CpuMpData The pointer to CPU MP Data structure.
347 IN CPU_MP_DATA
*CpuMpData
351 Worker function to execute a caller provided function on all enabled APs.
353 @param[in] Procedure A pointer to the function to be run on
354 enabled APs of the system.
355 @param[in] SingleThread If TRUE, then all the enabled APs execute
356 the function specified by Procedure one by
357 one, in ascending order of processor handle
358 number. If FALSE, then all the enabled APs
359 execute the function specified by Procedure
361 @param[in] WaitEvent The event created by the caller with CreateEvent()
363 @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for
364 APs to return from Procedure, either for
365 blocking or non-blocking mode.
366 @param[in] ProcedureArgument The parameter passed into Procedure for
368 @param[out] FailedCpuList If all APs finish successfully, then its
369 content is set to NULL. If not all APs
370 finish before timeout expires, then its
371 content is set to address of the buffer
372 holding handle numbers of the failed APs.
374 @retval EFI_SUCCESS In blocking mode, all APs have finished before
376 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched
378 @retval others Failed to Startup all APs.
382 StartupAllAPsWorker (
383 IN EFI_AP_PROCEDURE Procedure
,
384 IN BOOLEAN SingleThread
,
385 IN EFI_EVENT WaitEvent OPTIONAL
,
386 IN UINTN TimeoutInMicroseconds
,
387 IN VOID
*ProcedureArgument OPTIONAL
,
388 OUT UINTN
**FailedCpuList OPTIONAL
392 Worker function to let the caller get one enabled AP to execute a caller-provided
395 @param[in] Procedure A pointer to the function to be run on
396 enabled APs of the system.
397 @param[in] ProcessorNumber The handle number of the AP.
398 @param[in] WaitEvent The event created by the caller with CreateEvent()
400 @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for
401 APs to return from Procedure, either for
402 blocking or non-blocking mode.
403 @param[in] ProcedureArgument The parameter passed into Procedure for
405 @param[out] Finished If AP returns from Procedure before the
406 timeout expires, its content is set to TRUE.
407 Otherwise, the value is set to FALSE.
409 @retval EFI_SUCCESS In blocking mode, specified AP finished before
411 @retval others Failed to Startup AP.
415 StartupThisAPWorker (
416 IN EFI_AP_PROCEDURE Procedure
,
417 IN UINTN ProcessorNumber
,
418 IN EFI_EVENT WaitEvent OPTIONAL
,
419 IN UINTN TimeoutInMicroseconds
,
420 IN VOID
*ProcedureArgument OPTIONAL
,
421 OUT BOOLEAN
*Finished OPTIONAL
425 Worker function to switch the requested AP to be the BSP from that point onward.
427 @param[in] ProcessorNumber The handle number of AP that is to become the new BSP.
428 @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an
429 enabled AP. Otherwise, it will be disabled.
431 @retval EFI_SUCCESS BSP successfully switched.
432 @retval others Failed to switch BSP.
437 IN UINTN ProcessorNumber
,
438 IN BOOLEAN EnableOldBSP
442 Worker function to let the caller enable or disable an AP from this point onward.
443 This service may only be called from the BSP.
445 @param[in] ProcessorNumber The handle number of AP.
446 @param[in] EnableAP Specifies the new state for the processor for
447 enabled, FALSE for disabled.
448 @param[in] HealthFlag If not NULL, a pointer to a value that specifies
449 the new health status of the AP.
451 @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
452 @retval others Failed to Enable/Disable AP.
456 EnableDisableApWorker (
457 IN UINTN ProcessorNumber
,
459 IN UINT32
*HealthFlag OPTIONAL
463 Get pointer to CPU MP Data structure from GUIDed HOB.
465 @return The pointer to CPU MP Data structure.
468 GetCpuMpDataFromGuidedHob (
472 /** Checks status of specified AP.
474 This function checks whether the specified AP has finished the task assigned
475 by StartupThisAP(), and whether timeout expires.
477 @param[in] ProcessorNumber The handle number of processor.
479 @retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().
480 @retval EFI_TIMEOUT The timeout expires.
481 @retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.
485 IN UINTN ProcessorNumber
489 Checks status of all APs.
491 This function checks whether all APs have finished task assigned by StartupAllAPs(),
492 and whether timeout expires.
494 @retval EFI_SUCCESS All APs have finished task assigned by StartupAllAPs().
495 @retval EFI_TIMEOUT The timeout expires.
496 @retval EFI_NOT_READY APs have not finished task and timeout has not expired.
504 Checks APs status and updates APs status if needed.
508 CheckAndUpdateApsStatus (
513 Detect whether specified processor can find matching microcode patch and load it.
515 @param[in] CpuMpData The pointer to CPU MP Data structure.
519 IN CPU_MP_DATA
*CpuMpData
523 Detect whether Mwait-monitor feature is supported.
525 @retval TRUE Mwait-monitor feature is supported.
526 @retval FALSE Mwait-monitor feature is not supported.
534 Notify function on End Of PEI PPI.
536 On S3 boot, this function will restore wakeup buffer data.
537 On normal boot, this function will flag wakeup buffer to be un-used type.
539 @param[in] PeiServices The pointer to the PEI Services Table.
540 @param[in] NotifyDescriptor Address of the notification descriptor data structure.
541 @param[in] Ppi Address of the PPI that was installed.
543 @retval EFI_SUCCESS When everything is OK.
547 CpuMpEndOfPeiCallback (
548 IN EFI_PEI_SERVICES
**PeiServices
,
549 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDescriptor
,
554 Get available system memory below 1MB by specified size.
556 @param[in] CpuMpData The pointer to CPU MP Data structure.
559 BackupAndPrepareWakeupBuffer(
560 IN CPU_MP_DATA
*CpuMpData
564 Restore wakeup buffer data.
566 @param[in] CpuMpData The pointer to CPU MP Data structure.
570 IN CPU_MP_DATA
*CpuMpData