2 CPU MP Initialize Library common functions.
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.
17 EFI_GUID mCpuInitMpLibHobGuid
= CPU_INIT_MP_LIB_HOB_GUID
;
20 The function will check if BSP Execute Disable is enabled.
22 DxeIpl may have enabled Execute Disable for BSP, APs need to
23 get the status and sync up the settings.
24 If BSP's CR0.Paging is not set, BSP execute Disble feature is
27 @retval TRUE BSP Execute Disable is enabled.
28 @retval FALSE BSP Execute Disable is not enabled.
31 IsBspExecuteDisableEnabled (
36 CPUID_EXTENDED_CPU_SIG_EDX Edx
;
37 MSR_IA32_EFER_REGISTER EferMsr
;
42 Cr0
.UintN
= AsmReadCr0 ();
43 if (Cr0
.Bits
.PG
!= 0) {
45 // If CR0 Paging bit is set
47 AsmCpuid (CPUID_EXTENDED_FUNCTION
, &Eax
, NULL
, NULL
, NULL
);
48 if (Eax
>= CPUID_EXTENDED_CPU_SIG
) {
49 AsmCpuid (CPUID_EXTENDED_CPU_SIG
, NULL
, NULL
, NULL
, &Edx
.Uint32
);
52 // Bit 20: Execute Disable Bit available.
54 if (Edx
.Bits
.NX
!= 0) {
55 EferMsr
.Uint64
= AsmReadMsr64 (MSR_IA32_EFER
);
58 // Bit 11: Execute Disable Bit enable.
60 if (EferMsr
.Bits
.NXE
!= 0) {
71 Worker function for SwitchBSP().
73 Worker function for SwitchBSP(), assigned to the AP which is intended
76 @param[in] Buffer Pointer to CPU MP Data
84 CPU_MP_DATA
*DataInHob
;
86 DataInHob
= (CPU_MP_DATA
*) Buffer
;
87 AsmExchangeRole (&DataInHob
->APInfo
, &DataInHob
->BSPInfo
);
91 Get the Application Processors state.
93 @param[in] CpuData The pointer to CPU_AP_DATA of specified AP
99 IN CPU_AP_DATA
*CpuData
102 return CpuData
->State
;
106 Set the Application Processors state.
108 @param[in] CpuData The pointer to CPU_AP_DATA of specified AP
109 @param[in] State The AP status
113 IN CPU_AP_DATA
*CpuData
,
117 AcquireSpinLock (&CpuData
->ApLock
);
118 CpuData
->State
= State
;
119 ReleaseSpinLock (&CpuData
->ApLock
);
123 Save BSP's local APIC timer setting.
125 @param[in] CpuMpData Pointer to CPU MP Data
128 SaveLocalApicTimerSetting (
129 IN CPU_MP_DATA
*CpuMpData
133 // Record the current local APIC timer setting of BSP
136 &CpuMpData
->DivideValue
,
137 &CpuMpData
->PeriodicMode
,
140 CpuMpData
->CurrentTimerCount
= GetApicTimerCurrentCount ();
141 CpuMpData
->TimerInterruptState
= GetApicTimerInterruptState ();
145 Sync local APIC timer setting from BSP to AP.
147 @param[in] CpuMpData Pointer to CPU MP Data
150 SyncLocalApicTimerSetting (
151 IN CPU_MP_DATA
*CpuMpData
155 // Sync local APIC timer setting from BSP to AP
157 InitializeApicTimer (
158 CpuMpData
->DivideValue
,
159 CpuMpData
->CurrentTimerCount
,
160 CpuMpData
->PeriodicMode
,
164 // Disable AP's local APIC timer interrupt
166 DisableApicTimerInterrupt ();
170 Save the volatile registers required to be restored following INIT IPI.
172 @param[out] VolatileRegisters Returns buffer saved the volatile resisters
175 SaveVolatileRegisters (
176 OUT CPU_VOLATILE_REGISTERS
*VolatileRegisters
179 CPUID_VERSION_INFO_EDX VersionInfoEdx
;
181 VolatileRegisters
->Cr0
= AsmReadCr0 ();
182 VolatileRegisters
->Cr3
= AsmReadCr3 ();
183 VolatileRegisters
->Cr4
= AsmReadCr4 ();
185 AsmCpuid (CPUID_VERSION_INFO
, NULL
, NULL
, NULL
, &VersionInfoEdx
.Uint32
);
186 if (VersionInfoEdx
.Bits
.DE
!= 0) {
188 // If processor supports Debugging Extensions feature
189 // by CPUID.[EAX=01H]:EDX.BIT2
191 VolatileRegisters
->Dr0
= AsmReadDr0 ();
192 VolatileRegisters
->Dr1
= AsmReadDr1 ();
193 VolatileRegisters
->Dr2
= AsmReadDr2 ();
194 VolatileRegisters
->Dr3
= AsmReadDr3 ();
195 VolatileRegisters
->Dr6
= AsmReadDr6 ();
196 VolatileRegisters
->Dr7
= AsmReadDr7 ();
201 Restore the volatile registers following INIT IPI.
203 @param[in] VolatileRegisters Pointer to volatile resisters
204 @param[in] IsRestoreDr TRUE: Restore DRx if supported
205 FALSE: Do not restore DRx
208 RestoreVolatileRegisters (
209 IN CPU_VOLATILE_REGISTERS
*VolatileRegisters
,
210 IN BOOLEAN IsRestoreDr
213 CPUID_VERSION_INFO_EDX VersionInfoEdx
;
215 AsmWriteCr0 (VolatileRegisters
->Cr0
);
216 AsmWriteCr3 (VolatileRegisters
->Cr3
);
217 AsmWriteCr4 (VolatileRegisters
->Cr4
);
220 AsmCpuid (CPUID_VERSION_INFO
, NULL
, NULL
, NULL
, &VersionInfoEdx
.Uint32
);
221 if (VersionInfoEdx
.Bits
.DE
!= 0) {
223 // If processor supports Debugging Extensions feature
224 // by CPUID.[EAX=01H]:EDX.BIT2
226 AsmWriteDr0 (VolatileRegisters
->Dr0
);
227 AsmWriteDr1 (VolatileRegisters
->Dr1
);
228 AsmWriteDr2 (VolatileRegisters
->Dr2
);
229 AsmWriteDr3 (VolatileRegisters
->Dr3
);
230 AsmWriteDr6 (VolatileRegisters
->Dr6
);
231 AsmWriteDr7 (VolatileRegisters
->Dr7
);
237 Detect whether Mwait-monitor feature is supported.
239 @retval TRUE Mwait-monitor feature is supported.
240 @retval FALSE Mwait-monitor feature is not supported.
247 CPUID_VERSION_INFO_ECX VersionInfoEcx
;
249 AsmCpuid (CPUID_VERSION_INFO
, NULL
, NULL
, &VersionInfoEcx
.Uint32
, NULL
);
250 return (VersionInfoEcx
.Bits
.MONITOR
== 1) ? TRUE
: FALSE
;
256 @param[out] MonitorFilterSize Returns the largest monitor-line size in bytes.
258 @return The AP loop mode.
262 OUT UINT32
*MonitorFilterSize
266 CPUID_MONITOR_MWAIT_EBX MonitorMwaitEbx
;
268 ASSERT (MonitorFilterSize
!= NULL
);
270 ApLoopMode
= PcdGet8 (PcdCpuApLoopMode
);
271 ASSERT (ApLoopMode
>= ApInHltLoop
&& ApLoopMode
<= ApInRunLoop
);
272 if (ApLoopMode
== ApInMwaitLoop
) {
273 if (!IsMwaitSupport ()) {
275 // If processor does not support MONITOR/MWAIT feature,
276 // force AP in Hlt-loop mode
278 ApLoopMode
= ApInHltLoop
;
282 if (ApLoopMode
!= ApInMwaitLoop
) {
283 *MonitorFilterSize
= sizeof (UINT32
);
286 // CPUID.[EAX=05H]:EBX.BIT0-15: Largest monitor-line size in bytes
287 // CPUID.[EAX=05H].EDX: C-states supported using MWAIT
289 AsmCpuid (CPUID_MONITOR_MWAIT
, NULL
, &MonitorMwaitEbx
.Uint32
, NULL
, NULL
);
290 *MonitorFilterSize
= MonitorMwaitEbx
.Bits
.LargestMonitorLineSize
;
297 Sort the APIC ID of all processors.
299 This function sorts the APIC ID of all processors so that processor number is
300 assigned in the ascending order of APIC ID which eases MP debugging.
302 @param[in] CpuMpData Pointer to PEI CPU MP Data
306 IN CPU_MP_DATA
*CpuMpData
313 CPU_INFO_IN_HOB CpuInfo
;
315 CPU_INFO_IN_HOB
*CpuInfoInHob
;
317 ApCount
= CpuMpData
->CpuCount
- 1;
318 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
320 for (Index1
= 0; Index1
< ApCount
; Index1
++) {
323 // Sort key is the hardware default APIC ID
325 ApicId
= CpuInfoInHob
[Index1
].ApicId
;
326 for (Index2
= Index1
+ 1; Index2
<= ApCount
; Index2
++) {
327 if (ApicId
> CpuInfoInHob
[Index2
].ApicId
) {
329 ApicId
= CpuInfoInHob
[Index2
].ApicId
;
332 if (Index3
!= Index1
) {
333 CopyMem (&CpuInfo
, &CpuInfoInHob
[Index3
], sizeof (CPU_INFO_IN_HOB
));
335 &CpuInfoInHob
[Index3
],
336 &CpuInfoInHob
[Index1
],
337 sizeof (CPU_INFO_IN_HOB
)
339 CopyMem (&CpuInfoInHob
[Index1
], &CpuInfo
, sizeof (CPU_INFO_IN_HOB
));
344 // Get the processor number for the BSP
346 ApicId
= GetInitialApicId ();
347 for (Index1
= 0; Index1
< CpuMpData
->CpuCount
; Index1
++) {
348 if (CpuInfoInHob
[Index1
].ApicId
== ApicId
) {
349 CpuMpData
->BspNumber
= (UINT32
) Index1
;
357 Enable x2APIC mode on APs.
359 @param[in, out] Buffer Pointer to private data buffer.
367 SetApicMode (LOCAL_APIC_MODE_X2APIC
);
373 @param[in, out] Buffer Pointer to private data buffer.
381 CPU_MP_DATA
*CpuMpData
;
383 CpuMpData
= (CPU_MP_DATA
*) Buffer
;
385 // Load microcode on AP
387 MicrocodeDetect (CpuMpData
);
389 // Sync BSP's MTRR table to AP
391 MtrrSetAllMtrrs (&CpuMpData
->MtrrTable
);
395 Find the current Processor number by APIC ID.
397 @param[in] CpuMpData Pointer to PEI CPU MP Data
398 @param[out] ProcessorNumber Return the pocessor number found
400 @retval EFI_SUCCESS ProcessorNumber is found and returned.
401 @retval EFI_NOT_FOUND ProcessorNumber is not found.
405 IN CPU_MP_DATA
*CpuMpData
,
406 OUT UINTN
*ProcessorNumber
409 UINTN TotalProcessorNumber
;
411 CPU_INFO_IN_HOB
*CpuInfoInHob
;
413 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
415 TotalProcessorNumber
= CpuMpData
->CpuCount
;
416 for (Index
= 0; Index
< TotalProcessorNumber
; Index
++) {
417 if (CpuInfoInHob
[Index
].ApicId
== GetApicId ()) {
418 *ProcessorNumber
= Index
;
422 return EFI_NOT_FOUND
;
426 This function will get CPU count in the system.
428 @param[in] CpuMpData Pointer to PEI CPU MP Data
430 @return CPU count detected
433 CollectProcessorCount (
434 IN CPU_MP_DATA
*CpuMpData
440 // Send 1st broadcast IPI to APs to wakeup APs
442 CpuMpData
->InitFlag
= ApInitConfig
;
443 CpuMpData
->X2ApicEnable
= FALSE
;
444 WakeUpAP (CpuMpData
, TRUE
, 0, NULL
, NULL
);
445 CpuMpData
->InitFlag
= ApInitDone
;
446 ASSERT (CpuMpData
->CpuCount
<= PcdGet32 (PcdCpuMaxLogicalProcessorNumber
));
448 // Wait for all APs finished the initialization
450 while (CpuMpData
->FinishedCount
< (CpuMpData
->CpuCount
- 1)) {
454 if (CpuMpData
->X2ApicEnable
) {
455 DEBUG ((DEBUG_INFO
, "Force x2APIC mode!\n"));
457 // Wakeup all APs to enable x2APIC mode
459 WakeUpAP (CpuMpData
, TRUE
, 0, ApFuncEnableX2Apic
, NULL
);
461 // Wait for all known APs finished
463 while (CpuMpData
->FinishedCount
< (CpuMpData
->CpuCount
- 1)) {
467 // Enable x2APIC on BSP
469 SetApicMode (LOCAL_APIC_MODE_X2APIC
);
471 // Set BSP/Aps state to IDLE
473 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
474 SetApState (&CpuMpData
->CpuData
[Index
], CpuStateIdle
);
477 DEBUG ((DEBUG_INFO
, "APIC MODE is %d\n", GetApicMode ()));
479 // Sort BSP/Aps by CPU APIC ID in ascending order
481 SortApicId (CpuMpData
);
483 DEBUG ((DEBUG_INFO
, "MpInitLib: Find %d processors in system.\n", CpuMpData
->CpuCount
));
485 return CpuMpData
->CpuCount
;
489 Initialize CPU AP Data when AP is wakeup at the first time.
491 @param[in, out] CpuMpData Pointer to PEI CPU MP Data
492 @param[in] ProcessorNumber The handle number of processor
493 @param[in] BistData Processor BIST data
494 @param[in] ApTopOfStack Top of AP stack
499 IN OUT CPU_MP_DATA
*CpuMpData
,
500 IN UINTN ProcessorNumber
,
502 IN UINT64 ApTopOfStack
505 CPU_INFO_IN_HOB
*CpuInfoInHob
;
507 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
508 CpuInfoInHob
[ProcessorNumber
].InitialApicId
= GetInitialApicId ();
509 CpuInfoInHob
[ProcessorNumber
].ApicId
= GetApicId ();
510 CpuInfoInHob
[ProcessorNumber
].Health
= BistData
;
511 CpuInfoInHob
[ProcessorNumber
].ApTopOfStack
= ApTopOfStack
;
513 CpuMpData
->CpuData
[ProcessorNumber
].Waiting
= FALSE
;
514 CpuMpData
->CpuData
[ProcessorNumber
].CpuHealthy
= (BistData
== 0) ? TRUE
: FALSE
;
515 if (CpuInfoInHob
[ProcessorNumber
].InitialApicId
>= 0xFF) {
517 // Set x2APIC mode if there are any logical processor reporting
518 // an Initial APIC ID of 255 or greater.
520 AcquireSpinLock(&CpuMpData
->MpLock
);
521 CpuMpData
->X2ApicEnable
= TRUE
;
522 ReleaseSpinLock(&CpuMpData
->MpLock
);
525 InitializeSpinLock(&CpuMpData
->CpuData
[ProcessorNumber
].ApLock
);
526 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateIdle
);
530 This function will be called from AP reset code if BSP uses WakeUpAP.
532 @param[in] ExchangeInfo Pointer to the MP exchange info buffer
533 @param[in] NumApsExecuting Number of current executing AP
538 IN MP_CPU_EXCHANGE_INFO
*ExchangeInfo
,
539 IN UINTN NumApsExecuting
542 CPU_MP_DATA
*CpuMpData
;
543 UINTN ProcessorNumber
;
544 EFI_AP_PROCEDURE Procedure
;
547 volatile UINT32
*ApStartupSignalBuffer
;
548 CPU_INFO_IN_HOB
*CpuInfoInHob
;
550 UINTN CurrentApicMode
;
553 // AP finished assembly code and begin to execute C code
555 CpuMpData
= ExchangeInfo
->CpuMpData
;
558 // AP's local APIC settings will be lost after received INIT IPI
559 // We need to re-initialize them at here
561 ProgramVirtualWireMode ();
562 SyncLocalApicTimerSetting (CpuMpData
);
564 CurrentApicMode
= GetApicMode ();
566 if (CpuMpData
->InitFlag
== ApInitConfig
) {
570 InterlockedIncrement ((UINT32
*) &CpuMpData
->CpuCount
);
571 ProcessorNumber
= NumApsExecuting
;
573 // This is first time AP wakeup, get BIST information from AP stack
575 ApTopOfStack
= CpuMpData
->Buffer
+ (ProcessorNumber
+ 1) * CpuMpData
->CpuApStackSize
;
576 BistData
= *(UINT32
*) ((UINTN
) ApTopOfStack
- sizeof (UINTN
));
578 // Do some AP initialize sync
580 ApInitializeSync (CpuMpData
);
582 // Sync BSP's Control registers to APs
584 RestoreVolatileRegisters (&CpuMpData
->CpuData
[0].VolatileRegisters
, FALSE
);
585 InitializeApData (CpuMpData
, ProcessorNumber
, BistData
, ApTopOfStack
);
586 ApStartupSignalBuffer
= CpuMpData
->CpuData
[ProcessorNumber
].StartupApSignal
;
589 // Execute AP function if AP is ready
591 GetProcessorNumber (CpuMpData
, &ProcessorNumber
);
593 // Clear AP start-up signal when AP waken up
595 ApStartupSignalBuffer
= CpuMpData
->CpuData
[ProcessorNumber
].StartupApSignal
;
596 InterlockedCompareExchange32 (
597 (UINT32
*) ApStartupSignalBuffer
,
601 if (CpuMpData
->ApLoopMode
== ApInHltLoop
) {
603 // Restore AP's volatile registers saved
605 RestoreVolatileRegisters (&CpuMpData
->CpuData
[ProcessorNumber
].VolatileRegisters
, TRUE
);
608 if (GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]) == CpuStateReady
) {
609 Procedure
= (EFI_AP_PROCEDURE
)CpuMpData
->CpuData
[ProcessorNumber
].ApFunction
;
610 Parameter
= (VOID
*) CpuMpData
->CpuData
[ProcessorNumber
].ApFunctionArgument
;
611 if (Procedure
!= NULL
) {
612 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateBusy
);
614 // Enable source debugging on AP function
618 // Invoke AP function here
620 Procedure (Parameter
);
621 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
622 if (CpuMpData
->SwitchBspFlag
) {
624 // Re-get the processor number due to BSP/AP maybe exchange in AP function
626 GetProcessorNumber (CpuMpData
, &ProcessorNumber
);
627 CpuMpData
->CpuData
[ProcessorNumber
].ApFunction
= 0;
628 CpuMpData
->CpuData
[ProcessorNumber
].ApFunctionArgument
= 0;
629 ApStartupSignalBuffer
= CpuMpData
->CpuData
[ProcessorNumber
].StartupApSignal
;
630 CpuInfoInHob
[ProcessorNumber
].ApTopOfStack
= CpuInfoInHob
[CpuMpData
->NewBspNumber
].ApTopOfStack
;
632 if (CpuInfoInHob
[ProcessorNumber
].ApicId
!= GetApicId () ||
633 CpuInfoInHob
[ProcessorNumber
].InitialApicId
!= GetInitialApicId ()) {
634 if (CurrentApicMode
!= GetApicMode ()) {
636 // If APIC mode change happened during AP function execution,
637 // we do not support APIC ID value changed.
643 // Re-get the CPU APICID and Initial APICID if they are changed
645 CpuInfoInHob
[ProcessorNumber
].ApicId
= GetApicId ();
646 CpuInfoInHob
[ProcessorNumber
].InitialApicId
= GetInitialApicId ();
651 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateFinished
);
656 // AP finished executing C code
658 InterlockedIncrement ((UINT32
*) &CpuMpData
->FinishedCount
);
661 // Place AP is specified loop mode
663 if (CpuMpData
->ApLoopMode
== ApInHltLoop
) {
665 // Save AP volatile registers
667 SaveVolatileRegisters (&CpuMpData
->CpuData
[ProcessorNumber
].VolatileRegisters
);
669 // Place AP in HLT-loop
672 DisableInterrupts ();
678 DisableInterrupts ();
679 if (CpuMpData
->ApLoopMode
== ApInMwaitLoop
) {
681 // Place AP in MWAIT-loop
683 AsmMonitor ((UINTN
) ApStartupSignalBuffer
, 0, 0);
684 if (*ApStartupSignalBuffer
!= WAKEUP_AP_SIGNAL
) {
686 // Check AP start-up signal again.
687 // If AP start-up signal is not set, place AP into
688 // the specified C-state
690 AsmMwait (CpuMpData
->ApTargetCState
<< 4, 0);
692 } else if (CpuMpData
->ApLoopMode
== ApInRunLoop
) {
694 // Place AP in Run-loop
702 // If AP start-up signal is written, AP is waken up
703 // otherwise place AP in loop again
705 if (*ApStartupSignalBuffer
== WAKEUP_AP_SIGNAL
) {
713 Wait for AP wakeup and write AP start-up signal till AP is waken up.
715 @param[in] ApStartupSignalBuffer Pointer to AP wakeup signal
719 IN
volatile UINT32
*ApStartupSignalBuffer
723 // If AP is waken up, StartupApSignal should be cleared.
724 // Otherwise, write StartupApSignal again till AP waken up.
726 while (InterlockedCompareExchange32 (
727 (UINT32
*) ApStartupSignalBuffer
,
736 This function will fill the exchange info structure.
738 @param[in] CpuMpData Pointer to CPU MP Data
742 FillExchangeInfoData (
743 IN CPU_MP_DATA
*CpuMpData
746 volatile MP_CPU_EXCHANGE_INFO
*ExchangeInfo
;
748 ExchangeInfo
= CpuMpData
->MpCpuExchangeInfo
;
749 ExchangeInfo
->Lock
= 0;
750 ExchangeInfo
->StackStart
= CpuMpData
->Buffer
;
751 ExchangeInfo
->StackSize
= CpuMpData
->CpuApStackSize
;
752 ExchangeInfo
->BufferStart
= CpuMpData
->WakeupBuffer
;
753 ExchangeInfo
->ModeOffset
= CpuMpData
->AddressMap
.ModeEntryOffset
;
755 ExchangeInfo
->CodeSegment
= AsmReadCs ();
756 ExchangeInfo
->DataSegment
= AsmReadDs ();
758 ExchangeInfo
->Cr3
= AsmReadCr3 ();
760 ExchangeInfo
->CFunction
= (UINTN
) ApWakeupFunction
;
761 ExchangeInfo
->NumApsExecuting
= 0;
762 ExchangeInfo
->InitFlag
= (UINTN
) CpuMpData
->InitFlag
;
763 ExchangeInfo
->CpuInfo
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
764 ExchangeInfo
->CpuMpData
= CpuMpData
;
766 ExchangeInfo
->EnableExecuteDisable
= IsBspExecuteDisableEnabled ();
768 ExchangeInfo
->InitializeFloatingPointUnitsAddress
= (UINTN
)InitializeFloatingPointUnits
;
771 // Get the BSP's data of GDT and IDT
773 AsmReadGdtr ((IA32_DESCRIPTOR
*) &ExchangeInfo
->GdtrProfile
);
774 AsmReadIdtr ((IA32_DESCRIPTOR
*) &ExchangeInfo
->IdtrProfile
);
778 Helper function that waits until the finished AP count reaches the specified
779 limit, or the specified timeout elapses (whichever comes first).
781 @param[in] CpuMpData Pointer to CPU MP Data.
782 @param[in] FinishedApLimit The number of finished APs to wait for.
783 @param[in] TimeLimit The number of microseconds to wait for.
786 TimedWaitForApFinish (
787 IN CPU_MP_DATA
*CpuMpData
,
788 IN UINT32 FinishedApLimit
,
793 This function will be called by BSP to wakeup AP.
795 @param[in] CpuMpData Pointer to CPU MP Data
796 @param[in] Broadcast TRUE: Send broadcast IPI to all APs
797 FALSE: Send IPI to AP by ApicId
798 @param[in] ProcessorNumber The handle number of specified processor
799 @param[in] Procedure The function to be invoked by AP
800 @param[in] ProcedureArgument The argument to be passed into AP function
804 IN CPU_MP_DATA
*CpuMpData
,
805 IN BOOLEAN Broadcast
,
806 IN UINTN ProcessorNumber
,
807 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
808 IN VOID
*ProcedureArgument OPTIONAL
811 volatile MP_CPU_EXCHANGE_INFO
*ExchangeInfo
;
813 CPU_AP_DATA
*CpuData
;
814 BOOLEAN ResetVectorRequired
;
815 CPU_INFO_IN_HOB
*CpuInfoInHob
;
817 CpuMpData
->FinishedCount
= 0;
818 ResetVectorRequired
= FALSE
;
820 if (CpuMpData
->ApLoopMode
== ApInHltLoop
||
821 CpuMpData
->InitFlag
!= ApInitDone
) {
822 ResetVectorRequired
= TRUE
;
823 AllocateResetVector (CpuMpData
);
824 FillExchangeInfoData (CpuMpData
);
825 SaveLocalApicTimerSetting (CpuMpData
);
826 } else if (CpuMpData
->ApLoopMode
== ApInMwaitLoop
) {
828 // Get AP target C-state each time when waking up AP,
829 // for it maybe updated by platform again
831 CpuMpData
->ApTargetCState
= PcdGet8 (PcdCpuApTargetCstate
);
834 ExchangeInfo
= CpuMpData
->MpCpuExchangeInfo
;
837 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
838 if (Index
!= CpuMpData
->BspNumber
) {
839 CpuData
= &CpuMpData
->CpuData
[Index
];
840 CpuData
->ApFunction
= (UINTN
) Procedure
;
841 CpuData
->ApFunctionArgument
= (UINTN
) ProcedureArgument
;
842 SetApState (CpuData
, CpuStateReady
);
843 if (CpuMpData
->InitFlag
!= ApInitConfig
) {
844 *(UINT32
*) CpuData
->StartupApSignal
= WAKEUP_AP_SIGNAL
;
848 if (ResetVectorRequired
) {
852 SendInitSipiSipiAllExcludingSelf ((UINT32
) ExchangeInfo
->BufferStart
);
854 if (CpuMpData
->InitFlag
== ApInitConfig
) {
856 // Wait for all potential APs waken up in one specified period
858 TimedWaitForApFinish (
860 PcdGet32 (PcdCpuMaxLogicalProcessorNumber
) - 1,
861 PcdGet32 (PcdCpuApInitTimeOutInMicroSeconds
)
865 // Wait all APs waken up if this is not the 1st broadcast of SIPI
867 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
868 CpuData
= &CpuMpData
->CpuData
[Index
];
869 if (Index
!= CpuMpData
->BspNumber
) {
870 WaitApWakeup (CpuData
->StartupApSignal
);
875 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
876 CpuData
->ApFunction
= (UINTN
) Procedure
;
877 CpuData
->ApFunctionArgument
= (UINTN
) ProcedureArgument
;
878 SetApState (CpuData
, CpuStateReady
);
880 // Wakeup specified AP
882 ASSERT (CpuMpData
->InitFlag
!= ApInitConfig
);
883 *(UINT32
*) CpuData
->StartupApSignal
= WAKEUP_AP_SIGNAL
;
884 if (ResetVectorRequired
) {
885 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
887 CpuInfoInHob
[ProcessorNumber
].ApicId
,
888 (UINT32
) ExchangeInfo
->BufferStart
892 // Wait specified AP waken up
894 WaitApWakeup (CpuData
->StartupApSignal
);
897 if (ResetVectorRequired
) {
898 FreeResetVector (CpuMpData
);
903 Calculate timeout value and return the current performance counter value.
905 Calculate the number of performance counter ticks required for a timeout.
906 If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
909 @param[in] TimeoutInMicroseconds Timeout value in microseconds.
910 @param[out] CurrentTime Returns the current value of the performance counter.
912 @return Expected time stamp counter for timeout.
913 If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
919 IN UINTN TimeoutInMicroseconds
,
920 OUT UINT64
*CurrentTime
924 // Read the current value of the performance counter
926 *CurrentTime
= GetPerformanceCounter ();
929 // If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
932 if (TimeoutInMicroseconds
== 0) {
937 // GetPerformanceCounterProperties () returns the timestamp counter's frequency
938 // in Hz. So multiply the return value with TimeoutInMicroseconds and then divide
939 // it by 1,000,000, to get the number of ticks for the timeout value.
943 GetPerformanceCounterProperties (NULL
, NULL
),
944 TimeoutInMicroseconds
951 Checks whether timeout expires.
953 Check whether the number of elapsed performance counter ticks required for
954 a timeout condition has been reached.
955 If Timeout is zero, which means infinity, return value is always FALSE.
957 @param[in, out] PreviousTime On input, the value of the performance counter
958 when it was last read.
959 On output, the current value of the performance
961 @param[in] TotalTime The total amount of elapsed time in performance
963 @param[in] Timeout The number of performance counter ticks required
964 to reach a timeout condition.
966 @retval TRUE A timeout condition has been reached.
967 @retval FALSE A timeout condition has not been reached.
972 IN OUT UINT64
*PreviousTime
,
973 IN UINT64
*TotalTime
,
986 GetPerformanceCounterProperties (&Start
, &End
);
992 CurrentTime
= GetPerformanceCounter();
993 Delta
= (INT64
) (CurrentTime
- *PreviousTime
);
1000 *TotalTime
+= Delta
;
1001 *PreviousTime
= CurrentTime
;
1002 if (*TotalTime
> Timeout
) {
1009 Helper function that waits until the finished AP count reaches the specified
1010 limit, or the specified timeout elapses (whichever comes first).
1012 @param[in] CpuMpData Pointer to CPU MP Data.
1013 @param[in] FinishedApLimit The number of finished APs to wait for.
1014 @param[in] TimeLimit The number of microseconds to wait for.
1017 TimedWaitForApFinish (
1018 IN CPU_MP_DATA
*CpuMpData
,
1019 IN UINT32 FinishedApLimit
,
1024 // CalculateTimeout() and CheckTimeout() consider a TimeLimit of 0
1025 // "infinity", so check for (TimeLimit == 0) explicitly.
1027 if (TimeLimit
== 0) {
1031 CpuMpData
->TotalTime
= 0;
1032 CpuMpData
->ExpectedTime
= CalculateTimeout (
1034 &CpuMpData
->CurrentTime
1036 while (CpuMpData
->FinishedCount
< FinishedApLimit
&&
1038 &CpuMpData
->CurrentTime
,
1039 &CpuMpData
->TotalTime
,
1040 CpuMpData
->ExpectedTime
1045 if (CpuMpData
->FinishedCount
>= FinishedApLimit
) {
1048 "%a: reached FinishedApLimit=%u in %Lu microseconds\n",
1051 DivU64x64Remainder (
1052 MultU64x32 (CpuMpData
->TotalTime
, 1000000),
1053 GetPerformanceCounterProperties (NULL
, NULL
),
1061 Reset an AP to Idle state.
1063 Any task being executed by the AP will be aborted and the AP
1064 will be waiting for a new task in Wait-For-SIPI state.
1066 @param[in] ProcessorNumber The handle number of processor.
1069 ResetProcessorToIdleState (
1070 IN UINTN ProcessorNumber
1073 CPU_MP_DATA
*CpuMpData
;
1075 CpuMpData
= GetCpuMpData ();
1077 CpuMpData
->InitFlag
= ApInitReconfig
;
1078 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, NULL
, NULL
);
1079 while (CpuMpData
->FinishedCount
< 1) {
1082 CpuMpData
->InitFlag
= ApInitDone
;
1084 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateIdle
);
1088 Searches for the next waiting AP.
1090 Search for the next AP that is put in waiting state by single-threaded StartupAllAPs().
1092 @param[out] NextProcessorNumber Pointer to the processor number of the next waiting AP.
1094 @retval EFI_SUCCESS The next waiting AP has been found.
1095 @retval EFI_NOT_FOUND No waiting AP exists.
1099 GetNextWaitingProcessorNumber (
1100 OUT UINTN
*NextProcessorNumber
1103 UINTN ProcessorNumber
;
1104 CPU_MP_DATA
*CpuMpData
;
1106 CpuMpData
= GetCpuMpData ();
1108 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
1109 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1110 *NextProcessorNumber
= ProcessorNumber
;
1115 return EFI_NOT_FOUND
;
1118 /** Checks status of specified AP.
1120 This function checks whether the specified AP has finished the task assigned
1121 by StartupThisAP(), and whether timeout expires.
1123 @param[in] ProcessorNumber The handle number of processor.
1125 @retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().
1126 @retval EFI_TIMEOUT The timeout expires.
1127 @retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.
1131 IN UINTN ProcessorNumber
1134 CPU_MP_DATA
*CpuMpData
;
1135 CPU_AP_DATA
*CpuData
;
1137 CpuMpData
= GetCpuMpData ();
1138 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1141 // Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.
1142 // Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the
1143 // value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.
1146 // If the AP finishes for StartupThisAP(), return EFI_SUCCESS.
1148 if (GetApState(CpuData
) == CpuStateFinished
) {
1149 if (CpuData
->Finished
!= NULL
) {
1150 *(CpuData
->Finished
) = TRUE
;
1152 SetApState (CpuData
, CpuStateIdle
);
1156 // If timeout expires for StartupThisAP(), report timeout.
1158 if (CheckTimeout (&CpuData
->CurrentTime
, &CpuData
->TotalTime
, CpuData
->ExpectedTime
)) {
1159 if (CpuData
->Finished
!= NULL
) {
1160 *(CpuData
->Finished
) = FALSE
;
1163 // Reset failed AP to idle state
1165 ResetProcessorToIdleState (ProcessorNumber
);
1170 return EFI_NOT_READY
;
1174 Checks status of all APs.
1176 This function checks whether all APs have finished task assigned by StartupAllAPs(),
1177 and whether timeout expires.
1179 @retval EFI_SUCCESS All APs have finished task assigned by StartupAllAPs().
1180 @retval EFI_TIMEOUT The timeout expires.
1181 @retval EFI_NOT_READY APs have not finished task and timeout has not expired.
1188 UINTN ProcessorNumber
;
1189 UINTN NextProcessorNumber
;
1192 CPU_MP_DATA
*CpuMpData
;
1193 CPU_AP_DATA
*CpuData
;
1195 CpuMpData
= GetCpuMpData ();
1197 NextProcessorNumber
= 0;
1200 // Go through all APs that are responsible for the StartupAllAPs().
1202 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
1203 if (!CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1207 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1209 // Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.
1210 // Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the
1211 // value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.
1213 if (GetApState(CpuData
) == CpuStateFinished
) {
1214 CpuMpData
->RunningCount
++;
1215 CpuMpData
->CpuData
[ProcessorNumber
].Waiting
= FALSE
;
1216 SetApState(CpuData
, CpuStateIdle
);
1219 // If in Single Thread mode, then search for the next waiting AP for execution.
1221 if (CpuMpData
->SingleThread
) {
1222 Status
= GetNextWaitingProcessorNumber (&NextProcessorNumber
);
1224 if (!EFI_ERROR (Status
)) {
1228 (UINT32
) NextProcessorNumber
,
1229 CpuMpData
->Procedure
,
1230 CpuMpData
->ProcArguments
1238 // If all APs finish, return EFI_SUCCESS.
1240 if (CpuMpData
->RunningCount
== CpuMpData
->StartCount
) {
1245 // If timeout expires, report timeout.
1248 &CpuMpData
->CurrentTime
,
1249 &CpuMpData
->TotalTime
,
1250 CpuMpData
->ExpectedTime
)
1253 // If FailedCpuList is not NULL, record all failed APs in it.
1255 if (CpuMpData
->FailedCpuList
!= NULL
) {
1256 *CpuMpData
->FailedCpuList
=
1257 AllocatePool ((CpuMpData
->StartCount
- CpuMpData
->FinishedCount
+ 1) * sizeof (UINTN
));
1258 ASSERT (*CpuMpData
->FailedCpuList
!= NULL
);
1262 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
1264 // Check whether this processor is responsible for StartupAllAPs().
1266 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1268 // Reset failed APs to idle state
1270 ResetProcessorToIdleState (ProcessorNumber
);
1271 CpuMpData
->CpuData
[ProcessorNumber
].Waiting
= FALSE
;
1272 if (CpuMpData
->FailedCpuList
!= NULL
) {
1273 (*CpuMpData
->FailedCpuList
)[ListIndex
++] = ProcessorNumber
;
1277 if (CpuMpData
->FailedCpuList
!= NULL
) {
1278 (*CpuMpData
->FailedCpuList
)[ListIndex
] = END_OF_CPU_LIST
;
1282 return EFI_NOT_READY
;
1286 MP Initialize Library initialization.
1288 This service will allocate AP reset vector and wakeup all APs to do APs
1291 This service must be invoked before all other MP Initialize Library
1292 service are invoked.
1294 @retval EFI_SUCCESS MP initialization succeeds.
1295 @retval Others MP initialization fails.
1300 MpInitLibInitialize (
1304 CPU_MP_DATA
*OldCpuMpData
;
1305 CPU_INFO_IN_HOB
*CpuInfoInHob
;
1306 UINT32 MaxLogicalProcessorNumber
;
1308 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
1310 UINT32 MonitorFilterSize
;
1313 CPU_MP_DATA
*CpuMpData
;
1315 UINT8
*MonitorBuffer
;
1317 UINTN ApResetVectorSize
;
1318 UINTN BackupBufferAddr
;
1320 OldCpuMpData
= GetCpuMpDataFromGuidedHob ();
1321 if (OldCpuMpData
== NULL
) {
1322 MaxLogicalProcessorNumber
= PcdGet32(PcdCpuMaxLogicalProcessorNumber
);
1324 MaxLogicalProcessorNumber
= OldCpuMpData
->CpuCount
;
1326 ASSERT (MaxLogicalProcessorNumber
!= 0);
1328 AsmGetAddressMap (&AddressMap
);
1329 ApResetVectorSize
= AddressMap
.RendezvousFunnelSize
+ sizeof (MP_CPU_EXCHANGE_INFO
);
1330 ApStackSize
= PcdGet32(PcdCpuApStackSize
);
1331 ApLoopMode
= GetApLoopMode (&MonitorFilterSize
);
1333 BufferSize
= ApStackSize
* MaxLogicalProcessorNumber
;
1334 BufferSize
+= MonitorFilterSize
* MaxLogicalProcessorNumber
;
1335 BufferSize
+= sizeof (CPU_MP_DATA
);
1336 BufferSize
+= ApResetVectorSize
;
1337 BufferSize
+= (sizeof (CPU_AP_DATA
) + sizeof (CPU_INFO_IN_HOB
))* MaxLogicalProcessorNumber
;
1338 MpBuffer
= AllocatePages (EFI_SIZE_TO_PAGES (BufferSize
));
1339 ASSERT (MpBuffer
!= NULL
);
1340 ZeroMem (MpBuffer
, BufferSize
);
1341 Buffer
= (UINTN
) MpBuffer
;
1343 MonitorBuffer
= (UINT8
*) (Buffer
+ ApStackSize
* MaxLogicalProcessorNumber
);
1344 BackupBufferAddr
= (UINTN
) MonitorBuffer
+ MonitorFilterSize
* MaxLogicalProcessorNumber
;
1345 CpuMpData
= (CPU_MP_DATA
*) (BackupBufferAddr
+ ApResetVectorSize
);
1346 CpuMpData
->Buffer
= Buffer
;
1347 CpuMpData
->CpuApStackSize
= ApStackSize
;
1348 CpuMpData
->BackupBuffer
= BackupBufferAddr
;
1349 CpuMpData
->BackupBufferSize
= ApResetVectorSize
;
1350 CpuMpData
->SaveRestoreFlag
= FALSE
;
1351 CpuMpData
->WakeupBuffer
= (UINTN
) -1;
1352 CpuMpData
->CpuCount
= 1;
1353 CpuMpData
->BspNumber
= 0;
1354 CpuMpData
->WaitEvent
= NULL
;
1355 CpuMpData
->SwitchBspFlag
= FALSE
;
1356 CpuMpData
->CpuData
= (CPU_AP_DATA
*) (CpuMpData
+ 1);
1357 CpuMpData
->CpuInfoInHob
= (UINT64
) (UINTN
) (CpuMpData
->CpuData
+ MaxLogicalProcessorNumber
);
1358 InitializeSpinLock(&CpuMpData
->MpLock
);
1360 // Save BSP's Control registers to APs
1362 SaveVolatileRegisters (&CpuMpData
->CpuData
[0].VolatileRegisters
);
1364 // Set BSP basic information
1366 InitializeApData (CpuMpData
, 0, 0, CpuMpData
->Buffer
);
1368 // Save assembly code information
1370 CopyMem (&CpuMpData
->AddressMap
, &AddressMap
, sizeof (MP_ASSEMBLY_ADDRESS_MAP
));
1372 // Finally set AP loop mode
1374 CpuMpData
->ApLoopMode
= ApLoopMode
;
1375 DEBUG ((DEBUG_INFO
, "AP Loop Mode is %d\n", CpuMpData
->ApLoopMode
));
1377 // Set up APs wakeup signal buffer
1379 for (Index
= 0; Index
< MaxLogicalProcessorNumber
; Index
++) {
1380 CpuMpData
->CpuData
[Index
].StartupApSignal
=
1381 (UINT32
*)(MonitorBuffer
+ MonitorFilterSize
* Index
);
1384 // Load Microcode on BSP
1386 MicrocodeDetect (CpuMpData
);
1388 // Store BSP's MTRR setting
1390 MtrrGetAllMtrrs (&CpuMpData
->MtrrTable
);
1392 // Enable the local APIC for Virtual Wire Mode.
1394 ProgramVirtualWireMode ();
1396 if (OldCpuMpData
== NULL
) {
1397 if (MaxLogicalProcessorNumber
> 1) {
1399 // Wakeup all APs and calculate the processor count in system
1401 CollectProcessorCount (CpuMpData
);
1405 // APs have been wakeup before, just get the CPU Information
1408 CpuMpData
->CpuCount
= OldCpuMpData
->CpuCount
;
1409 CpuMpData
->BspNumber
= OldCpuMpData
->BspNumber
;
1410 CpuMpData
->InitFlag
= ApInitReconfig
;
1411 CpuMpData
->CpuInfoInHob
= OldCpuMpData
->CpuInfoInHob
;
1412 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
1413 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
1414 InitializeSpinLock(&CpuMpData
->CpuData
[Index
].ApLock
);
1415 if (CpuInfoInHob
[Index
].InitialApicId
>= 255) {
1416 CpuMpData
->X2ApicEnable
= TRUE
;
1418 CpuMpData
->CpuData
[Index
].CpuHealthy
= (CpuInfoInHob
[Index
].Health
== 0)? TRUE
:FALSE
;
1419 CpuMpData
->CpuData
[Index
].ApFunction
= 0;
1421 &CpuMpData
->CpuData
[Index
].VolatileRegisters
,
1422 &CpuMpData
->CpuData
[0].VolatileRegisters
,
1423 sizeof (CPU_VOLATILE_REGISTERS
)
1426 if (MaxLogicalProcessorNumber
> 1) {
1428 // Wakeup APs to do some AP initialize sync
1430 WakeUpAP (CpuMpData
, TRUE
, 0, ApInitializeSync
, CpuMpData
);
1432 // Wait for all APs finished initialization
1434 while (CpuMpData
->FinishedCount
< (CpuMpData
->CpuCount
- 1)) {
1437 CpuMpData
->InitFlag
= ApInitDone
;
1438 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
1439 SetApState (&CpuMpData
->CpuData
[Index
], CpuStateIdle
);
1445 // Initialize global data for MP support
1447 InitMpGlobalData (CpuMpData
);
1453 Gets detailed MP-related information on the requested processor at the
1454 instant this call is made. This service may only be called from the BSP.
1456 @param[in] ProcessorNumber The handle number of processor.
1457 @param[out] ProcessorInfoBuffer A pointer to the buffer where information for
1458 the requested processor is deposited.
1459 @param[out] HealthData Return processor health data.
1461 @retval EFI_SUCCESS Processor information was returned.
1462 @retval EFI_DEVICE_ERROR The calling processor is an AP.
1463 @retval EFI_INVALID_PARAMETER ProcessorInfoBuffer is NULL.
1464 @retval EFI_NOT_FOUND The processor with the handle specified by
1465 ProcessorNumber does not exist in the platform.
1466 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1471 MpInitLibGetProcessorInfo (
1472 IN UINTN ProcessorNumber
,
1473 OUT EFI_PROCESSOR_INFORMATION
*ProcessorInfoBuffer
,
1474 OUT EFI_HEALTH_FLAGS
*HealthData OPTIONAL
1477 CPU_MP_DATA
*CpuMpData
;
1479 CPU_INFO_IN_HOB
*CpuInfoInHob
;
1481 CpuMpData
= GetCpuMpData ();
1482 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
1485 // Check whether caller processor is BSP
1487 MpInitLibWhoAmI (&CallerNumber
);
1488 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1489 return EFI_DEVICE_ERROR
;
1492 if (ProcessorInfoBuffer
== NULL
) {
1493 return EFI_INVALID_PARAMETER
;
1496 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1497 return EFI_NOT_FOUND
;
1500 ProcessorInfoBuffer
->ProcessorId
= (UINT64
) CpuInfoInHob
[ProcessorNumber
].ApicId
;
1501 ProcessorInfoBuffer
->StatusFlag
= 0;
1502 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1503 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_AS_BSP_BIT
;
1505 if (CpuMpData
->CpuData
[ProcessorNumber
].CpuHealthy
) {
1506 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_HEALTH_STATUS_BIT
;
1508 if (GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]) == CpuStateDisabled
) {
1509 ProcessorInfoBuffer
->StatusFlag
&= ~PROCESSOR_ENABLED_BIT
;
1511 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_ENABLED_BIT
;
1515 // Get processor location information
1517 GetProcessorLocationByApicId (
1518 CpuInfoInHob
[ProcessorNumber
].ApicId
,
1519 &ProcessorInfoBuffer
->Location
.Package
,
1520 &ProcessorInfoBuffer
->Location
.Core
,
1521 &ProcessorInfoBuffer
->Location
.Thread
1524 if (HealthData
!= NULL
) {
1525 HealthData
->Uint32
= CpuInfoInHob
[ProcessorNumber
].Health
;
1532 Worker function to switch the requested AP to be the BSP from that point onward.
1534 @param[in] ProcessorNumber The handle number of AP that is to become the new BSP.
1535 @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an
1536 enabled AP. Otherwise, it will be disabled.
1538 @retval EFI_SUCCESS BSP successfully switched.
1539 @retval others Failed to switch BSP.
1544 IN UINTN ProcessorNumber
,
1545 IN BOOLEAN EnableOldBSP
1548 CPU_MP_DATA
*CpuMpData
;
1551 MSR_IA32_APIC_BASE_REGISTER ApicBaseMsr
;
1552 BOOLEAN OldInterruptState
;
1553 BOOLEAN OldTimerInterruptState
;
1556 // Save and Disable Local APIC timer interrupt
1558 OldTimerInterruptState
= GetApicTimerInterruptState ();
1559 DisableApicTimerInterrupt ();
1561 // Before send both BSP and AP to a procedure to exchange their roles,
1562 // interrupt must be disabled. This is because during the exchange role
1563 // process, 2 CPU may use 1 stack. If interrupt happens, the stack will
1564 // be corrupted, since interrupt return address will be pushed to stack
1567 OldInterruptState
= SaveAndDisableInterrupts ();
1570 // Mask LINT0 & LINT1 for the old BSP
1572 DisableLvtInterrupts ();
1574 CpuMpData
= GetCpuMpData ();
1577 // Check whether caller processor is BSP
1579 MpInitLibWhoAmI (&CallerNumber
);
1580 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1584 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1585 return EFI_NOT_FOUND
;
1589 // Check whether specified AP is disabled
1591 State
= GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]);
1592 if (State
== CpuStateDisabled
) {
1593 return EFI_INVALID_PARAMETER
;
1597 // Check whether ProcessorNumber specifies the current BSP
1599 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1600 return EFI_INVALID_PARAMETER
;
1604 // Check whether specified AP is busy
1606 if (State
== CpuStateBusy
) {
1607 return EFI_NOT_READY
;
1610 CpuMpData
->BSPInfo
.State
= CPU_SWITCH_STATE_IDLE
;
1611 CpuMpData
->APInfo
.State
= CPU_SWITCH_STATE_IDLE
;
1612 CpuMpData
->SwitchBspFlag
= TRUE
;
1613 CpuMpData
->NewBspNumber
= ProcessorNumber
;
1616 // Clear the BSP bit of MSR_IA32_APIC_BASE
1618 ApicBaseMsr
.Uint64
= AsmReadMsr64 (MSR_IA32_APIC_BASE
);
1619 ApicBaseMsr
.Bits
.BSP
= 0;
1620 AsmWriteMsr64 (MSR_IA32_APIC_BASE
, ApicBaseMsr
.Uint64
);
1623 // Need to wakeUp AP (future BSP).
1625 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, FutureBSPProc
, CpuMpData
);
1627 AsmExchangeRole (&CpuMpData
->BSPInfo
, &CpuMpData
->APInfo
);
1630 // Set the BSP bit of MSR_IA32_APIC_BASE on new BSP
1632 ApicBaseMsr
.Uint64
= AsmReadMsr64 (MSR_IA32_APIC_BASE
);
1633 ApicBaseMsr
.Bits
.BSP
= 1;
1634 AsmWriteMsr64 (MSR_IA32_APIC_BASE
, ApicBaseMsr
.Uint64
);
1637 // Wait for old BSP finished AP task
1639 while (GetApState (&CpuMpData
->CpuData
[CallerNumber
]) != CpuStateFinished
) {
1643 CpuMpData
->SwitchBspFlag
= FALSE
;
1645 // Set old BSP enable state
1647 if (!EnableOldBSP
) {
1648 SetApState (&CpuMpData
->CpuData
[CallerNumber
], CpuStateDisabled
);
1650 SetApState (&CpuMpData
->CpuData
[CallerNumber
], CpuStateIdle
);
1653 // Save new BSP number
1655 CpuMpData
->BspNumber
= (UINT32
) ProcessorNumber
;
1658 // Restore interrupt state.
1660 SetInterruptState (OldInterruptState
);
1662 if (OldTimerInterruptState
) {
1663 EnableApicTimerInterrupt ();
1670 Worker function to let the caller enable or disable an AP from this point onward.
1671 This service may only be called from the BSP.
1673 @param[in] ProcessorNumber The handle number of AP.
1674 @param[in] EnableAP Specifies the new state for the processor for
1675 enabled, FALSE for disabled.
1676 @param[in] HealthFlag If not NULL, a pointer to a value that specifies
1677 the new health status of the AP.
1679 @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
1680 @retval others Failed to Enable/Disable AP.
1684 EnableDisableApWorker (
1685 IN UINTN ProcessorNumber
,
1686 IN BOOLEAN EnableAP
,
1687 IN UINT32
*HealthFlag OPTIONAL
1690 CPU_MP_DATA
*CpuMpData
;
1693 CpuMpData
= GetCpuMpData ();
1696 // Check whether caller processor is BSP
1698 MpInitLibWhoAmI (&CallerNumber
);
1699 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1700 return EFI_DEVICE_ERROR
;
1703 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1704 return EFI_INVALID_PARAMETER
;
1707 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1708 return EFI_NOT_FOUND
;
1712 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateDisabled
);
1714 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateIdle
);
1717 if (HealthFlag
!= NULL
) {
1718 CpuMpData
->CpuData
[ProcessorNumber
].CpuHealthy
=
1719 (BOOLEAN
) ((*HealthFlag
& PROCESSOR_HEALTH_STATUS_BIT
) != 0);
1726 This return the handle number for the calling processor. This service may be
1727 called from the BSP and APs.
1729 @param[out] ProcessorNumber Pointer to the handle number of AP.
1730 The range is from 0 to the total number of
1731 logical processors minus 1. The total number of
1732 logical processors can be retrieved by
1733 MpInitLibGetNumberOfProcessors().
1735 @retval EFI_SUCCESS The current processor handle number was returned
1737 @retval EFI_INVALID_PARAMETER ProcessorNumber is NULL.
1738 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1744 OUT UINTN
*ProcessorNumber
1747 CPU_MP_DATA
*CpuMpData
;
1749 if (ProcessorNumber
== NULL
) {
1750 return EFI_INVALID_PARAMETER
;
1753 CpuMpData
= GetCpuMpData ();
1755 return GetProcessorNumber (CpuMpData
, ProcessorNumber
);
1759 Retrieves the number of logical processor in the platform and the number of
1760 those logical processors that are enabled on this boot. This service may only
1761 be called from the BSP.
1763 @param[out] NumberOfProcessors Pointer to the total number of logical
1764 processors in the system, including the BSP
1766 @param[out] NumberOfEnabledProcessors Pointer to the number of enabled logical
1767 processors that exist in system, including
1770 @retval EFI_SUCCESS The number of logical processors and enabled
1771 logical processors was retrieved.
1772 @retval EFI_DEVICE_ERROR The calling processor is an AP.
1773 @retval EFI_INVALID_PARAMETER NumberOfProcessors is NULL and NumberOfEnabledProcessors
1775 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1780 MpInitLibGetNumberOfProcessors (
1781 OUT UINTN
*NumberOfProcessors
, OPTIONAL
1782 OUT UINTN
*NumberOfEnabledProcessors OPTIONAL
1785 CPU_MP_DATA
*CpuMpData
;
1787 UINTN ProcessorNumber
;
1788 UINTN EnabledProcessorNumber
;
1791 CpuMpData
= GetCpuMpData ();
1793 if ((NumberOfProcessors
== NULL
) && (NumberOfEnabledProcessors
== NULL
)) {
1794 return EFI_INVALID_PARAMETER
;
1798 // Check whether caller processor is BSP
1800 MpInitLibWhoAmI (&CallerNumber
);
1801 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1802 return EFI_DEVICE_ERROR
;
1805 ProcessorNumber
= CpuMpData
->CpuCount
;
1806 EnabledProcessorNumber
= 0;
1807 for (Index
= 0; Index
< ProcessorNumber
; Index
++) {
1808 if (GetApState (&CpuMpData
->CpuData
[Index
]) != CpuStateDisabled
) {
1809 EnabledProcessorNumber
++;
1813 if (NumberOfProcessors
!= NULL
) {
1814 *NumberOfProcessors
= ProcessorNumber
;
1816 if (NumberOfEnabledProcessors
!= NULL
) {
1817 *NumberOfEnabledProcessors
= EnabledProcessorNumber
;
1825 Worker function to execute a caller provided function on all enabled APs.
1827 @param[in] Procedure A pointer to the function to be run on
1828 enabled APs of the system.
1829 @param[in] SingleThread If TRUE, then all the enabled APs execute
1830 the function specified by Procedure one by
1831 one, in ascending order of processor handle
1832 number. If FALSE, then all the enabled APs
1833 execute the function specified by Procedure
1835 @param[in] WaitEvent The event created by the caller with CreateEvent()
1837 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
1838 APs to return from Procedure, either for
1839 blocking or non-blocking mode.
1840 @param[in] ProcedureArgument The parameter passed into Procedure for
1842 @param[out] FailedCpuList If all APs finish successfully, then its
1843 content is set to NULL. If not all APs
1844 finish before timeout expires, then its
1845 content is set to address of the buffer
1846 holding handle numbers of the failed APs.
1848 @retval EFI_SUCCESS In blocking mode, all APs have finished before
1849 the timeout expired.
1850 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched
1852 @retval others Failed to Startup all APs.
1856 StartupAllAPsWorker (
1857 IN EFI_AP_PROCEDURE Procedure
,
1858 IN BOOLEAN SingleThread
,
1859 IN EFI_EVENT WaitEvent OPTIONAL
,
1860 IN UINTN TimeoutInMicroseconds
,
1861 IN VOID
*ProcedureArgument OPTIONAL
,
1862 OUT UINTN
**FailedCpuList OPTIONAL
1866 CPU_MP_DATA
*CpuMpData
;
1867 UINTN ProcessorCount
;
1868 UINTN ProcessorNumber
;
1870 CPU_AP_DATA
*CpuData
;
1871 BOOLEAN HasEnabledAp
;
1874 CpuMpData
= GetCpuMpData ();
1876 if (FailedCpuList
!= NULL
) {
1877 *FailedCpuList
= NULL
;
1880 if (CpuMpData
->CpuCount
== 1) {
1881 return EFI_NOT_STARTED
;
1884 if (Procedure
== NULL
) {
1885 return EFI_INVALID_PARAMETER
;
1889 // Check whether caller processor is BSP
1891 MpInitLibWhoAmI (&CallerNumber
);
1892 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1893 return EFI_DEVICE_ERROR
;
1899 CheckAndUpdateApsStatus ();
1901 ProcessorCount
= CpuMpData
->CpuCount
;
1902 HasEnabledAp
= FALSE
;
1904 // Check whether all enabled APs are idle.
1905 // If any enabled AP is not idle, return EFI_NOT_READY.
1907 for (ProcessorNumber
= 0; ProcessorNumber
< ProcessorCount
; ProcessorNumber
++) {
1908 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1909 if (ProcessorNumber
!= CpuMpData
->BspNumber
) {
1910 ApState
= GetApState (CpuData
);
1911 if (ApState
!= CpuStateDisabled
) {
1912 HasEnabledAp
= TRUE
;
1913 if (ApState
!= CpuStateIdle
) {
1915 // If any enabled APs are busy, return EFI_NOT_READY.
1917 return EFI_NOT_READY
;
1923 if (!HasEnabledAp
) {
1925 // If no enabled AP exists, return EFI_NOT_STARTED.
1927 return EFI_NOT_STARTED
;
1930 CpuMpData
->StartCount
= 0;
1931 for (ProcessorNumber
= 0; ProcessorNumber
< ProcessorCount
; ProcessorNumber
++) {
1932 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1933 CpuData
->Waiting
= FALSE
;
1934 if (ProcessorNumber
!= CpuMpData
->BspNumber
) {
1935 if (CpuData
->State
== CpuStateIdle
) {
1937 // Mark this processor as responsible for current calling.
1939 CpuData
->Waiting
= TRUE
;
1940 CpuMpData
->StartCount
++;
1945 CpuMpData
->Procedure
= Procedure
;
1946 CpuMpData
->ProcArguments
= ProcedureArgument
;
1947 CpuMpData
->SingleThread
= SingleThread
;
1948 CpuMpData
->FinishedCount
= 0;
1949 CpuMpData
->RunningCount
= 0;
1950 CpuMpData
->FailedCpuList
= FailedCpuList
;
1951 CpuMpData
->ExpectedTime
= CalculateTimeout (
1952 TimeoutInMicroseconds
,
1953 &CpuMpData
->CurrentTime
1955 CpuMpData
->TotalTime
= 0;
1956 CpuMpData
->WaitEvent
= WaitEvent
;
1958 if (!SingleThread
) {
1959 WakeUpAP (CpuMpData
, TRUE
, 0, Procedure
, ProcedureArgument
);
1961 for (ProcessorNumber
= 0; ProcessorNumber
< ProcessorCount
; ProcessorNumber
++) {
1962 if (ProcessorNumber
== CallerNumber
) {
1965 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1966 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, Procedure
, ProcedureArgument
);
1972 Status
= EFI_SUCCESS
;
1973 if (WaitEvent
== NULL
) {
1975 Status
= CheckAllAPs ();
1976 } while (Status
== EFI_NOT_READY
);
1983 Worker function to let the caller get one enabled AP to execute a caller-provided
1986 @param[in] Procedure A pointer to the function to be run on
1987 enabled APs of the system.
1988 @param[in] ProcessorNumber The handle number of the AP.
1989 @param[in] WaitEvent The event created by the caller with CreateEvent()
1991 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
1992 APs to return from Procedure, either for
1993 blocking or non-blocking mode.
1994 @param[in] ProcedureArgument The parameter passed into Procedure for
1996 @param[out] Finished If AP returns from Procedure before the
1997 timeout expires, its content is set to TRUE.
1998 Otherwise, the value is set to FALSE.
2000 @retval EFI_SUCCESS In blocking mode, specified AP finished before
2001 the timeout expires.
2002 @retval others Failed to Startup AP.
2006 StartupThisAPWorker (
2007 IN EFI_AP_PROCEDURE Procedure
,
2008 IN UINTN ProcessorNumber
,
2009 IN EFI_EVENT WaitEvent OPTIONAL
,
2010 IN UINTN TimeoutInMicroseconds
,
2011 IN VOID
*ProcedureArgument OPTIONAL
,
2012 OUT BOOLEAN
*Finished OPTIONAL
2016 CPU_MP_DATA
*CpuMpData
;
2017 CPU_AP_DATA
*CpuData
;
2020 CpuMpData
= GetCpuMpData ();
2022 if (Finished
!= NULL
) {
2027 // Check whether caller processor is BSP
2029 MpInitLibWhoAmI (&CallerNumber
);
2030 if (CallerNumber
!= CpuMpData
->BspNumber
) {
2031 return EFI_DEVICE_ERROR
;
2035 // Check whether processor with the handle specified by ProcessorNumber exists
2037 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
2038 return EFI_NOT_FOUND
;
2042 // Check whether specified processor is BSP
2044 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
2045 return EFI_INVALID_PARAMETER
;
2049 // Check parameter Procedure
2051 if (Procedure
== NULL
) {
2052 return EFI_INVALID_PARAMETER
;
2058 CheckAndUpdateApsStatus ();
2061 // Check whether specified AP is disabled
2063 if (GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]) == CpuStateDisabled
) {
2064 return EFI_INVALID_PARAMETER
;
2068 // If WaitEvent is not NULL, execute in non-blocking mode.
2069 // BSP saves data for CheckAPsStatus(), and returns EFI_SUCCESS.
2070 // CheckAPsStatus() will check completion and timeout periodically.
2072 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
2073 CpuData
->WaitEvent
= WaitEvent
;
2074 CpuData
->Finished
= Finished
;
2075 CpuData
->ExpectedTime
= CalculateTimeout (TimeoutInMicroseconds
, &CpuData
->CurrentTime
);
2076 CpuData
->TotalTime
= 0;
2078 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, Procedure
, ProcedureArgument
);
2081 // If WaitEvent is NULL, execute in blocking mode.
2082 // BSP checks AP's state until it finishes or TimeoutInMicrosecsond expires.
2084 Status
= EFI_SUCCESS
;
2085 if (WaitEvent
== NULL
) {
2087 Status
= CheckThisAP (ProcessorNumber
);
2088 } while (Status
== EFI_NOT_READY
);
2095 Get pointer to CPU MP Data structure from GUIDed HOB.
2097 @return The pointer to CPU MP Data structure.
2100 GetCpuMpDataFromGuidedHob (
2104 EFI_HOB_GUID_TYPE
*GuidHob
;
2106 CPU_MP_DATA
*CpuMpData
;
2109 GuidHob
= GetFirstGuidHob (&mCpuInitMpLibHobGuid
);
2110 if (GuidHob
!= NULL
) {
2111 DataInHob
= GET_GUID_HOB_DATA (GuidHob
);
2112 CpuMpData
= (CPU_MP_DATA
*) (*(UINTN
*) DataInHob
);
2118 Get available system memory below 1MB by specified size.
2120 @param[in] CpuMpData The pointer to CPU MP Data structure.
2123 BackupAndPrepareWakeupBuffer(
2124 IN CPU_MP_DATA
*CpuMpData
2128 (VOID
*) CpuMpData
->BackupBuffer
,
2129 (VOID
*) CpuMpData
->WakeupBuffer
,
2130 CpuMpData
->BackupBufferSize
2133 (VOID
*) CpuMpData
->WakeupBuffer
,
2134 (VOID
*) CpuMpData
->AddressMap
.RendezvousFunnelAddress
,
2135 CpuMpData
->AddressMap
.RendezvousFunnelSize
2140 Restore wakeup buffer data.
2142 @param[in] CpuMpData The pointer to CPU MP Data structure.
2145 RestoreWakeupBuffer(
2146 IN CPU_MP_DATA
*CpuMpData
2150 (VOID
*) CpuMpData
->WakeupBuffer
,
2151 (VOID
*) CpuMpData
->BackupBuffer
,
2152 CpuMpData
->BackupBufferSize