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
->CpuCount
> 255) {
456 // If there are more than 255 processor found, force to enable X2APIC
458 CpuMpData
->X2ApicEnable
= TRUE
;
460 if (CpuMpData
->X2ApicEnable
) {
461 DEBUG ((DEBUG_INFO
, "Force x2APIC mode!\n"));
463 // Wakeup all APs to enable x2APIC mode
465 WakeUpAP (CpuMpData
, TRUE
, 0, ApFuncEnableX2Apic
, NULL
);
467 // Wait for all known APs finished
469 while (CpuMpData
->FinishedCount
< (CpuMpData
->CpuCount
- 1)) {
473 // Enable x2APIC on BSP
475 SetApicMode (LOCAL_APIC_MODE_X2APIC
);
477 // Set BSP/Aps state to IDLE
479 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
480 SetApState (&CpuMpData
->CpuData
[Index
], CpuStateIdle
);
483 DEBUG ((DEBUG_INFO
, "APIC MODE is %d\n", GetApicMode ()));
485 // Sort BSP/Aps by CPU APIC ID in ascending order
487 SortApicId (CpuMpData
);
489 DEBUG ((DEBUG_INFO
, "MpInitLib: Find %d processors in system.\n", CpuMpData
->CpuCount
));
491 return CpuMpData
->CpuCount
;
495 Initialize CPU AP Data when AP is wakeup at the first time.
497 @param[in, out] CpuMpData Pointer to PEI CPU MP Data
498 @param[in] ProcessorNumber The handle number of processor
499 @param[in] BistData Processor BIST data
500 @param[in] ApTopOfStack Top of AP stack
505 IN OUT CPU_MP_DATA
*CpuMpData
,
506 IN UINTN ProcessorNumber
,
508 IN UINT64 ApTopOfStack
511 CPU_INFO_IN_HOB
*CpuInfoInHob
;
513 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
514 CpuInfoInHob
[ProcessorNumber
].InitialApicId
= GetInitialApicId ();
515 CpuInfoInHob
[ProcessorNumber
].ApicId
= GetApicId ();
516 CpuInfoInHob
[ProcessorNumber
].Health
= BistData
;
517 CpuInfoInHob
[ProcessorNumber
].ApTopOfStack
= ApTopOfStack
;
519 CpuMpData
->CpuData
[ProcessorNumber
].Waiting
= FALSE
;
520 CpuMpData
->CpuData
[ProcessorNumber
].CpuHealthy
= (BistData
== 0) ? TRUE
: FALSE
;
521 if (CpuInfoInHob
[ProcessorNumber
].InitialApicId
>= 0xFF) {
523 // Set x2APIC mode if there are any logical processor reporting
524 // an Initial APIC ID of 255 or greater.
526 AcquireSpinLock(&CpuMpData
->MpLock
);
527 CpuMpData
->X2ApicEnable
= TRUE
;
528 ReleaseSpinLock(&CpuMpData
->MpLock
);
531 InitializeSpinLock(&CpuMpData
->CpuData
[ProcessorNumber
].ApLock
);
532 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateIdle
);
536 This function will be called from AP reset code if BSP uses WakeUpAP.
538 @param[in] ExchangeInfo Pointer to the MP exchange info buffer
539 @param[in] NumApsExecuting Number of current executing AP
544 IN MP_CPU_EXCHANGE_INFO
*ExchangeInfo
,
545 IN UINTN NumApsExecuting
548 CPU_MP_DATA
*CpuMpData
;
549 UINTN ProcessorNumber
;
550 EFI_AP_PROCEDURE Procedure
;
553 volatile UINT32
*ApStartupSignalBuffer
;
554 CPU_INFO_IN_HOB
*CpuInfoInHob
;
556 UINTN CurrentApicMode
;
559 // AP finished assembly code and begin to execute C code
561 CpuMpData
= ExchangeInfo
->CpuMpData
;
564 // AP's local APIC settings will be lost after received INIT IPI
565 // We need to re-initialize them at here
567 ProgramVirtualWireMode ();
568 SyncLocalApicTimerSetting (CpuMpData
);
570 CurrentApicMode
= GetApicMode ();
572 if (CpuMpData
->InitFlag
== ApInitConfig
) {
576 InterlockedIncrement ((UINT32
*) &CpuMpData
->CpuCount
);
577 ProcessorNumber
= NumApsExecuting
;
579 // This is first time AP wakeup, get BIST information from AP stack
581 ApTopOfStack
= CpuMpData
->Buffer
+ (ProcessorNumber
+ 1) * CpuMpData
->CpuApStackSize
;
582 BistData
= *(UINT32
*) ((UINTN
) ApTopOfStack
- sizeof (UINTN
));
584 // Do some AP initialize sync
586 ApInitializeSync (CpuMpData
);
588 // Sync BSP's Control registers to APs
590 RestoreVolatileRegisters (&CpuMpData
->CpuData
[0].VolatileRegisters
, FALSE
);
591 InitializeApData (CpuMpData
, ProcessorNumber
, BistData
, ApTopOfStack
);
592 ApStartupSignalBuffer
= CpuMpData
->CpuData
[ProcessorNumber
].StartupApSignal
;
595 // Execute AP function if AP is ready
597 GetProcessorNumber (CpuMpData
, &ProcessorNumber
);
599 // Clear AP start-up signal when AP waken up
601 ApStartupSignalBuffer
= CpuMpData
->CpuData
[ProcessorNumber
].StartupApSignal
;
602 InterlockedCompareExchange32 (
603 (UINT32
*) ApStartupSignalBuffer
,
607 if (CpuMpData
->ApLoopMode
== ApInHltLoop
) {
609 // Restore AP's volatile registers saved
611 RestoreVolatileRegisters (&CpuMpData
->CpuData
[ProcessorNumber
].VolatileRegisters
, TRUE
);
614 if (GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]) == CpuStateReady
) {
615 Procedure
= (EFI_AP_PROCEDURE
)CpuMpData
->CpuData
[ProcessorNumber
].ApFunction
;
616 Parameter
= (VOID
*) CpuMpData
->CpuData
[ProcessorNumber
].ApFunctionArgument
;
617 if (Procedure
!= NULL
) {
618 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateBusy
);
620 // Enable source debugging on AP function
624 // Invoke AP function here
626 Procedure (Parameter
);
627 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
628 if (CpuMpData
->SwitchBspFlag
) {
630 // Re-get the processor number due to BSP/AP maybe exchange in AP function
632 GetProcessorNumber (CpuMpData
, &ProcessorNumber
);
633 CpuMpData
->CpuData
[ProcessorNumber
].ApFunction
= 0;
634 CpuMpData
->CpuData
[ProcessorNumber
].ApFunctionArgument
= 0;
635 ApStartupSignalBuffer
= CpuMpData
->CpuData
[ProcessorNumber
].StartupApSignal
;
636 CpuInfoInHob
[ProcessorNumber
].ApTopOfStack
= CpuInfoInHob
[CpuMpData
->NewBspNumber
].ApTopOfStack
;
638 if (CpuInfoInHob
[ProcessorNumber
].ApicId
!= GetApicId () ||
639 CpuInfoInHob
[ProcessorNumber
].InitialApicId
!= GetInitialApicId ()) {
640 if (CurrentApicMode
!= GetApicMode ()) {
642 // If APIC mode change happened during AP function execution,
643 // we do not support APIC ID value changed.
649 // Re-get the CPU APICID and Initial APICID if they are changed
651 CpuInfoInHob
[ProcessorNumber
].ApicId
= GetApicId ();
652 CpuInfoInHob
[ProcessorNumber
].InitialApicId
= GetInitialApicId ();
657 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateFinished
);
662 // AP finished executing C code
664 InterlockedIncrement ((UINT32
*) &CpuMpData
->FinishedCount
);
667 // Place AP is specified loop mode
669 if (CpuMpData
->ApLoopMode
== ApInHltLoop
) {
671 // Save AP volatile registers
673 SaveVolatileRegisters (&CpuMpData
->CpuData
[ProcessorNumber
].VolatileRegisters
);
675 // Place AP in HLT-loop
678 DisableInterrupts ();
684 DisableInterrupts ();
685 if (CpuMpData
->ApLoopMode
== ApInMwaitLoop
) {
687 // Place AP in MWAIT-loop
689 AsmMonitor ((UINTN
) ApStartupSignalBuffer
, 0, 0);
690 if (*ApStartupSignalBuffer
!= WAKEUP_AP_SIGNAL
) {
692 // Check AP start-up signal again.
693 // If AP start-up signal is not set, place AP into
694 // the specified C-state
696 AsmMwait (CpuMpData
->ApTargetCState
<< 4, 0);
698 } else if (CpuMpData
->ApLoopMode
== ApInRunLoop
) {
700 // Place AP in Run-loop
708 // If AP start-up signal is written, AP is waken up
709 // otherwise place AP in loop again
711 if (*ApStartupSignalBuffer
== WAKEUP_AP_SIGNAL
) {
719 Wait for AP wakeup and write AP start-up signal till AP is waken up.
721 @param[in] ApStartupSignalBuffer Pointer to AP wakeup signal
725 IN
volatile UINT32
*ApStartupSignalBuffer
729 // If AP is waken up, StartupApSignal should be cleared.
730 // Otherwise, write StartupApSignal again till AP waken up.
732 while (InterlockedCompareExchange32 (
733 (UINT32
*) ApStartupSignalBuffer
,
742 This function will fill the exchange info structure.
744 @param[in] CpuMpData Pointer to CPU MP Data
748 FillExchangeInfoData (
749 IN CPU_MP_DATA
*CpuMpData
752 volatile MP_CPU_EXCHANGE_INFO
*ExchangeInfo
;
754 ExchangeInfo
= CpuMpData
->MpCpuExchangeInfo
;
755 ExchangeInfo
->Lock
= 0;
756 ExchangeInfo
->StackStart
= CpuMpData
->Buffer
;
757 ExchangeInfo
->StackSize
= CpuMpData
->CpuApStackSize
;
758 ExchangeInfo
->BufferStart
= CpuMpData
->WakeupBuffer
;
759 ExchangeInfo
->ModeOffset
= CpuMpData
->AddressMap
.ModeEntryOffset
;
761 ExchangeInfo
->CodeSegment
= AsmReadCs ();
762 ExchangeInfo
->DataSegment
= AsmReadDs ();
764 ExchangeInfo
->Cr3
= AsmReadCr3 ();
766 ExchangeInfo
->CFunction
= (UINTN
) ApWakeupFunction
;
767 ExchangeInfo
->NumApsExecuting
= 0;
768 ExchangeInfo
->InitFlag
= (UINTN
) CpuMpData
->InitFlag
;
769 ExchangeInfo
->CpuInfo
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
770 ExchangeInfo
->CpuMpData
= CpuMpData
;
772 ExchangeInfo
->EnableExecuteDisable
= IsBspExecuteDisableEnabled ();
774 ExchangeInfo
->InitializeFloatingPointUnitsAddress
= (UINTN
)InitializeFloatingPointUnits
;
777 // Get the BSP's data of GDT and IDT
779 AsmReadGdtr ((IA32_DESCRIPTOR
*) &ExchangeInfo
->GdtrProfile
);
780 AsmReadIdtr ((IA32_DESCRIPTOR
*) &ExchangeInfo
->IdtrProfile
);
784 Helper function that waits until the finished AP count reaches the specified
785 limit, or the specified timeout elapses (whichever comes first).
787 @param[in] CpuMpData Pointer to CPU MP Data.
788 @param[in] FinishedApLimit The number of finished APs to wait for.
789 @param[in] TimeLimit The number of microseconds to wait for.
792 TimedWaitForApFinish (
793 IN CPU_MP_DATA
*CpuMpData
,
794 IN UINT32 FinishedApLimit
,
799 Get available system memory below 1MB by specified size.
801 @param[in] CpuMpData The pointer to CPU MP Data structure.
804 BackupAndPrepareWakeupBuffer(
805 IN CPU_MP_DATA
*CpuMpData
809 (VOID
*) CpuMpData
->BackupBuffer
,
810 (VOID
*) CpuMpData
->WakeupBuffer
,
811 CpuMpData
->BackupBufferSize
814 (VOID
*) CpuMpData
->WakeupBuffer
,
815 (VOID
*) CpuMpData
->AddressMap
.RendezvousFunnelAddress
,
816 CpuMpData
->AddressMap
.RendezvousFunnelSize
821 Restore wakeup buffer data.
823 @param[in] CpuMpData The pointer to CPU MP Data structure.
827 IN CPU_MP_DATA
*CpuMpData
831 (VOID
*) CpuMpData
->WakeupBuffer
,
832 (VOID
*) CpuMpData
->BackupBuffer
,
833 CpuMpData
->BackupBufferSize
838 Allocate reset vector buffer.
840 @param[in, out] CpuMpData The pointer to CPU MP Data structure.
843 AllocateResetVector (
844 IN OUT CPU_MP_DATA
*CpuMpData
847 UINTN ApResetVectorSize
;
849 if (CpuMpData
->WakeupBuffer
== (UINTN
) -1) {
850 ApResetVectorSize
= CpuMpData
->AddressMap
.RendezvousFunnelSize
+
851 sizeof (MP_CPU_EXCHANGE_INFO
);
853 CpuMpData
->WakeupBuffer
= GetWakeupBuffer (ApResetVectorSize
);
854 CpuMpData
->MpCpuExchangeInfo
= (MP_CPU_EXCHANGE_INFO
*) (UINTN
)
855 (CpuMpData
->WakeupBuffer
+ CpuMpData
->AddressMap
.RendezvousFunnelSize
);
857 BackupAndPrepareWakeupBuffer (CpuMpData
);
861 Free AP reset vector buffer.
863 @param[in] CpuMpData The pointer to CPU MP Data structure.
867 IN CPU_MP_DATA
*CpuMpData
870 RestoreWakeupBuffer (CpuMpData
);
874 This function will be called by BSP to wakeup AP.
876 @param[in] CpuMpData Pointer to CPU MP Data
877 @param[in] Broadcast TRUE: Send broadcast IPI to all APs
878 FALSE: Send IPI to AP by ApicId
879 @param[in] ProcessorNumber The handle number of specified processor
880 @param[in] Procedure The function to be invoked by AP
881 @param[in] ProcedureArgument The argument to be passed into AP function
885 IN CPU_MP_DATA
*CpuMpData
,
886 IN BOOLEAN Broadcast
,
887 IN UINTN ProcessorNumber
,
888 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
889 IN VOID
*ProcedureArgument OPTIONAL
892 volatile MP_CPU_EXCHANGE_INFO
*ExchangeInfo
;
894 CPU_AP_DATA
*CpuData
;
895 BOOLEAN ResetVectorRequired
;
896 CPU_INFO_IN_HOB
*CpuInfoInHob
;
898 CpuMpData
->FinishedCount
= 0;
899 ResetVectorRequired
= FALSE
;
901 if (CpuMpData
->ApLoopMode
== ApInHltLoop
||
902 CpuMpData
->InitFlag
!= ApInitDone
) {
903 ResetVectorRequired
= TRUE
;
904 AllocateResetVector (CpuMpData
);
905 FillExchangeInfoData (CpuMpData
);
906 SaveLocalApicTimerSetting (CpuMpData
);
907 } else if (CpuMpData
->ApLoopMode
== ApInMwaitLoop
) {
909 // Get AP target C-state each time when waking up AP,
910 // for it maybe updated by platform again
912 CpuMpData
->ApTargetCState
= PcdGet8 (PcdCpuApTargetCstate
);
915 ExchangeInfo
= CpuMpData
->MpCpuExchangeInfo
;
918 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
919 if (Index
!= CpuMpData
->BspNumber
) {
920 CpuData
= &CpuMpData
->CpuData
[Index
];
921 CpuData
->ApFunction
= (UINTN
) Procedure
;
922 CpuData
->ApFunctionArgument
= (UINTN
) ProcedureArgument
;
923 SetApState (CpuData
, CpuStateReady
);
924 if (CpuMpData
->InitFlag
!= ApInitConfig
) {
925 *(UINT32
*) CpuData
->StartupApSignal
= WAKEUP_AP_SIGNAL
;
929 if (ResetVectorRequired
) {
933 SendInitSipiSipiAllExcludingSelf ((UINT32
) ExchangeInfo
->BufferStart
);
935 if (CpuMpData
->InitFlag
== ApInitConfig
) {
937 // Wait for all potential APs waken up in one specified period
939 TimedWaitForApFinish (
941 PcdGet32 (PcdCpuMaxLogicalProcessorNumber
) - 1,
942 PcdGet32 (PcdCpuApInitTimeOutInMicroSeconds
)
946 // Wait all APs waken up if this is not the 1st broadcast of SIPI
948 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
949 CpuData
= &CpuMpData
->CpuData
[Index
];
950 if (Index
!= CpuMpData
->BspNumber
) {
951 WaitApWakeup (CpuData
->StartupApSignal
);
956 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
957 CpuData
->ApFunction
= (UINTN
) Procedure
;
958 CpuData
->ApFunctionArgument
= (UINTN
) ProcedureArgument
;
959 SetApState (CpuData
, CpuStateReady
);
961 // Wakeup specified AP
963 ASSERT (CpuMpData
->InitFlag
!= ApInitConfig
);
964 *(UINT32
*) CpuData
->StartupApSignal
= WAKEUP_AP_SIGNAL
;
965 if (ResetVectorRequired
) {
966 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
968 CpuInfoInHob
[ProcessorNumber
].ApicId
,
969 (UINT32
) ExchangeInfo
->BufferStart
973 // Wait specified AP waken up
975 WaitApWakeup (CpuData
->StartupApSignal
);
978 if (ResetVectorRequired
) {
979 FreeResetVector (CpuMpData
);
984 Calculate timeout value and return the current performance counter value.
986 Calculate the number of performance counter ticks required for a timeout.
987 If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
990 @param[in] TimeoutInMicroseconds Timeout value in microseconds.
991 @param[out] CurrentTime Returns the current value of the performance counter.
993 @return Expected time stamp counter for timeout.
994 If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
1000 IN UINTN TimeoutInMicroseconds
,
1001 OUT UINT64
*CurrentTime
1005 // Read the current value of the performance counter
1007 *CurrentTime
= GetPerformanceCounter ();
1010 // If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
1013 if (TimeoutInMicroseconds
== 0) {
1018 // GetPerformanceCounterProperties () returns the timestamp counter's frequency
1019 // in Hz. So multiply the return value with TimeoutInMicroseconds and then divide
1020 // it by 1,000,000, to get the number of ticks for the timeout value.
1024 GetPerformanceCounterProperties (NULL
, NULL
),
1025 TimeoutInMicroseconds
1032 Checks whether timeout expires.
1034 Check whether the number of elapsed performance counter ticks required for
1035 a timeout condition has been reached.
1036 If Timeout is zero, which means infinity, return value is always FALSE.
1038 @param[in, out] PreviousTime On input, the value of the performance counter
1039 when it was last read.
1040 On output, the current value of the performance
1042 @param[in] TotalTime The total amount of elapsed time in performance
1044 @param[in] Timeout The number of performance counter ticks required
1045 to reach a timeout condition.
1047 @retval TRUE A timeout condition has been reached.
1048 @retval FALSE A timeout condition has not been reached.
1053 IN OUT UINT64
*PreviousTime
,
1054 IN UINT64
*TotalTime
,
1067 GetPerformanceCounterProperties (&Start
, &End
);
1068 Cycle
= End
- Start
;
1073 CurrentTime
= GetPerformanceCounter();
1074 Delta
= (INT64
) (CurrentTime
- *PreviousTime
);
1081 *TotalTime
+= Delta
;
1082 *PreviousTime
= CurrentTime
;
1083 if (*TotalTime
> Timeout
) {
1090 Helper function that waits until the finished AP count reaches the specified
1091 limit, or the specified timeout elapses (whichever comes first).
1093 @param[in] CpuMpData Pointer to CPU MP Data.
1094 @param[in] FinishedApLimit The number of finished APs to wait for.
1095 @param[in] TimeLimit The number of microseconds to wait for.
1098 TimedWaitForApFinish (
1099 IN CPU_MP_DATA
*CpuMpData
,
1100 IN UINT32 FinishedApLimit
,
1105 // CalculateTimeout() and CheckTimeout() consider a TimeLimit of 0
1106 // "infinity", so check for (TimeLimit == 0) explicitly.
1108 if (TimeLimit
== 0) {
1112 CpuMpData
->TotalTime
= 0;
1113 CpuMpData
->ExpectedTime
= CalculateTimeout (
1115 &CpuMpData
->CurrentTime
1117 while (CpuMpData
->FinishedCount
< FinishedApLimit
&&
1119 &CpuMpData
->CurrentTime
,
1120 &CpuMpData
->TotalTime
,
1121 CpuMpData
->ExpectedTime
1126 if (CpuMpData
->FinishedCount
>= FinishedApLimit
) {
1129 "%a: reached FinishedApLimit=%u in %Lu microseconds\n",
1132 DivU64x64Remainder (
1133 MultU64x32 (CpuMpData
->TotalTime
, 1000000),
1134 GetPerformanceCounterProperties (NULL
, NULL
),
1142 Reset an AP to Idle state.
1144 Any task being executed by the AP will be aborted and the AP
1145 will be waiting for a new task in Wait-For-SIPI state.
1147 @param[in] ProcessorNumber The handle number of processor.
1150 ResetProcessorToIdleState (
1151 IN UINTN ProcessorNumber
1154 CPU_MP_DATA
*CpuMpData
;
1156 CpuMpData
= GetCpuMpData ();
1158 CpuMpData
->InitFlag
= ApInitReconfig
;
1159 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, NULL
, NULL
);
1160 while (CpuMpData
->FinishedCount
< 1) {
1163 CpuMpData
->InitFlag
= ApInitDone
;
1165 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateIdle
);
1169 Searches for the next waiting AP.
1171 Search for the next AP that is put in waiting state by single-threaded StartupAllAPs().
1173 @param[out] NextProcessorNumber Pointer to the processor number of the next waiting AP.
1175 @retval EFI_SUCCESS The next waiting AP has been found.
1176 @retval EFI_NOT_FOUND No waiting AP exists.
1180 GetNextWaitingProcessorNumber (
1181 OUT UINTN
*NextProcessorNumber
1184 UINTN ProcessorNumber
;
1185 CPU_MP_DATA
*CpuMpData
;
1187 CpuMpData
= GetCpuMpData ();
1189 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
1190 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1191 *NextProcessorNumber
= ProcessorNumber
;
1196 return EFI_NOT_FOUND
;
1199 /** Checks status of specified AP.
1201 This function checks whether the specified AP has finished the task assigned
1202 by StartupThisAP(), and whether timeout expires.
1204 @param[in] ProcessorNumber The handle number of processor.
1206 @retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().
1207 @retval EFI_TIMEOUT The timeout expires.
1208 @retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.
1212 IN UINTN ProcessorNumber
1215 CPU_MP_DATA
*CpuMpData
;
1216 CPU_AP_DATA
*CpuData
;
1218 CpuMpData
= GetCpuMpData ();
1219 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1222 // Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.
1223 // Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the
1224 // value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.
1227 // If the AP finishes for StartupThisAP(), return EFI_SUCCESS.
1229 if (GetApState(CpuData
) == CpuStateFinished
) {
1230 if (CpuData
->Finished
!= NULL
) {
1231 *(CpuData
->Finished
) = TRUE
;
1233 SetApState (CpuData
, CpuStateIdle
);
1237 // If timeout expires for StartupThisAP(), report timeout.
1239 if (CheckTimeout (&CpuData
->CurrentTime
, &CpuData
->TotalTime
, CpuData
->ExpectedTime
)) {
1240 if (CpuData
->Finished
!= NULL
) {
1241 *(CpuData
->Finished
) = FALSE
;
1244 // Reset failed AP to idle state
1246 ResetProcessorToIdleState (ProcessorNumber
);
1251 return EFI_NOT_READY
;
1255 Checks status of all APs.
1257 This function checks whether all APs have finished task assigned by StartupAllAPs(),
1258 and whether timeout expires.
1260 @retval EFI_SUCCESS All APs have finished task assigned by StartupAllAPs().
1261 @retval EFI_TIMEOUT The timeout expires.
1262 @retval EFI_NOT_READY APs have not finished task and timeout has not expired.
1269 UINTN ProcessorNumber
;
1270 UINTN NextProcessorNumber
;
1273 CPU_MP_DATA
*CpuMpData
;
1274 CPU_AP_DATA
*CpuData
;
1276 CpuMpData
= GetCpuMpData ();
1278 NextProcessorNumber
= 0;
1281 // Go through all APs that are responsible for the StartupAllAPs().
1283 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
1284 if (!CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1288 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1290 // Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.
1291 // Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the
1292 // value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.
1294 if (GetApState(CpuData
) == CpuStateFinished
) {
1295 CpuMpData
->RunningCount
++;
1296 CpuMpData
->CpuData
[ProcessorNumber
].Waiting
= FALSE
;
1297 SetApState(CpuData
, CpuStateIdle
);
1300 // If in Single Thread mode, then search for the next waiting AP for execution.
1302 if (CpuMpData
->SingleThread
) {
1303 Status
= GetNextWaitingProcessorNumber (&NextProcessorNumber
);
1305 if (!EFI_ERROR (Status
)) {
1309 (UINT32
) NextProcessorNumber
,
1310 CpuMpData
->Procedure
,
1311 CpuMpData
->ProcArguments
1319 // If all APs finish, return EFI_SUCCESS.
1321 if (CpuMpData
->RunningCount
== CpuMpData
->StartCount
) {
1326 // If timeout expires, report timeout.
1329 &CpuMpData
->CurrentTime
,
1330 &CpuMpData
->TotalTime
,
1331 CpuMpData
->ExpectedTime
)
1334 // If FailedCpuList is not NULL, record all failed APs in it.
1336 if (CpuMpData
->FailedCpuList
!= NULL
) {
1337 *CpuMpData
->FailedCpuList
=
1338 AllocatePool ((CpuMpData
->StartCount
- CpuMpData
->FinishedCount
+ 1) * sizeof (UINTN
));
1339 ASSERT (*CpuMpData
->FailedCpuList
!= NULL
);
1343 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
1345 // Check whether this processor is responsible for StartupAllAPs().
1347 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1349 // Reset failed APs to idle state
1351 ResetProcessorToIdleState (ProcessorNumber
);
1352 CpuMpData
->CpuData
[ProcessorNumber
].Waiting
= FALSE
;
1353 if (CpuMpData
->FailedCpuList
!= NULL
) {
1354 (*CpuMpData
->FailedCpuList
)[ListIndex
++] = ProcessorNumber
;
1358 if (CpuMpData
->FailedCpuList
!= NULL
) {
1359 (*CpuMpData
->FailedCpuList
)[ListIndex
] = END_OF_CPU_LIST
;
1363 return EFI_NOT_READY
;
1367 MP Initialize Library initialization.
1369 This service will allocate AP reset vector and wakeup all APs to do APs
1372 This service must be invoked before all other MP Initialize Library
1373 service are invoked.
1375 @retval EFI_SUCCESS MP initialization succeeds.
1376 @retval Others MP initialization fails.
1381 MpInitLibInitialize (
1385 CPU_MP_DATA
*OldCpuMpData
;
1386 CPU_INFO_IN_HOB
*CpuInfoInHob
;
1387 UINT32 MaxLogicalProcessorNumber
;
1389 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
1391 UINT32 MonitorFilterSize
;
1394 CPU_MP_DATA
*CpuMpData
;
1396 UINT8
*MonitorBuffer
;
1398 UINTN ApResetVectorSize
;
1399 UINTN BackupBufferAddr
;
1401 OldCpuMpData
= GetCpuMpDataFromGuidedHob ();
1402 if (OldCpuMpData
== NULL
) {
1403 MaxLogicalProcessorNumber
= PcdGet32(PcdCpuMaxLogicalProcessorNumber
);
1405 MaxLogicalProcessorNumber
= OldCpuMpData
->CpuCount
;
1407 ASSERT (MaxLogicalProcessorNumber
!= 0);
1409 AsmGetAddressMap (&AddressMap
);
1410 ApResetVectorSize
= AddressMap
.RendezvousFunnelSize
+ sizeof (MP_CPU_EXCHANGE_INFO
);
1411 ApStackSize
= PcdGet32(PcdCpuApStackSize
);
1412 ApLoopMode
= GetApLoopMode (&MonitorFilterSize
);
1414 BufferSize
= ApStackSize
* MaxLogicalProcessorNumber
;
1415 BufferSize
+= MonitorFilterSize
* MaxLogicalProcessorNumber
;
1416 BufferSize
+= sizeof (CPU_MP_DATA
);
1417 BufferSize
+= ApResetVectorSize
;
1418 BufferSize
+= (sizeof (CPU_AP_DATA
) + sizeof (CPU_INFO_IN_HOB
))* MaxLogicalProcessorNumber
;
1419 MpBuffer
= AllocatePages (EFI_SIZE_TO_PAGES (BufferSize
));
1420 ASSERT (MpBuffer
!= NULL
);
1421 ZeroMem (MpBuffer
, BufferSize
);
1422 Buffer
= (UINTN
) MpBuffer
;
1424 MonitorBuffer
= (UINT8
*) (Buffer
+ ApStackSize
* MaxLogicalProcessorNumber
);
1425 BackupBufferAddr
= (UINTN
) MonitorBuffer
+ MonitorFilterSize
* MaxLogicalProcessorNumber
;
1426 CpuMpData
= (CPU_MP_DATA
*) (BackupBufferAddr
+ ApResetVectorSize
);
1427 CpuMpData
->Buffer
= Buffer
;
1428 CpuMpData
->CpuApStackSize
= ApStackSize
;
1429 CpuMpData
->BackupBuffer
= BackupBufferAddr
;
1430 CpuMpData
->BackupBufferSize
= ApResetVectorSize
;
1431 CpuMpData
->WakeupBuffer
= (UINTN
) -1;
1432 CpuMpData
->CpuCount
= 1;
1433 CpuMpData
->BspNumber
= 0;
1434 CpuMpData
->WaitEvent
= NULL
;
1435 CpuMpData
->SwitchBspFlag
= FALSE
;
1436 CpuMpData
->CpuData
= (CPU_AP_DATA
*) (CpuMpData
+ 1);
1437 CpuMpData
->CpuInfoInHob
= (UINT64
) (UINTN
) (CpuMpData
->CpuData
+ MaxLogicalProcessorNumber
);
1438 InitializeSpinLock(&CpuMpData
->MpLock
);
1440 // Save BSP's Control registers to APs
1442 SaveVolatileRegisters (&CpuMpData
->CpuData
[0].VolatileRegisters
);
1444 // Set BSP basic information
1446 InitializeApData (CpuMpData
, 0, 0, CpuMpData
->Buffer
);
1448 // Save assembly code information
1450 CopyMem (&CpuMpData
->AddressMap
, &AddressMap
, sizeof (MP_ASSEMBLY_ADDRESS_MAP
));
1452 // Finally set AP loop mode
1454 CpuMpData
->ApLoopMode
= ApLoopMode
;
1455 DEBUG ((DEBUG_INFO
, "AP Loop Mode is %d\n", CpuMpData
->ApLoopMode
));
1457 // Set up APs wakeup signal buffer
1459 for (Index
= 0; Index
< MaxLogicalProcessorNumber
; Index
++) {
1460 CpuMpData
->CpuData
[Index
].StartupApSignal
=
1461 (UINT32
*)(MonitorBuffer
+ MonitorFilterSize
* Index
);
1464 // Load Microcode on BSP
1466 MicrocodeDetect (CpuMpData
);
1468 // Store BSP's MTRR setting
1470 MtrrGetAllMtrrs (&CpuMpData
->MtrrTable
);
1472 // Enable the local APIC for Virtual Wire Mode.
1474 ProgramVirtualWireMode ();
1476 if (OldCpuMpData
== NULL
) {
1477 if (MaxLogicalProcessorNumber
> 1) {
1479 // Wakeup all APs and calculate the processor count in system
1481 CollectProcessorCount (CpuMpData
);
1485 // APs have been wakeup before, just get the CPU Information
1488 CpuMpData
->CpuCount
= OldCpuMpData
->CpuCount
;
1489 CpuMpData
->BspNumber
= OldCpuMpData
->BspNumber
;
1490 CpuMpData
->InitFlag
= ApInitReconfig
;
1491 CpuMpData
->CpuInfoInHob
= OldCpuMpData
->CpuInfoInHob
;
1492 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
1493 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
1494 InitializeSpinLock(&CpuMpData
->CpuData
[Index
].ApLock
);
1495 if (CpuInfoInHob
[Index
].InitialApicId
>= 255 || Index
> 254) {
1496 CpuMpData
->X2ApicEnable
= TRUE
;
1498 CpuMpData
->CpuData
[Index
].CpuHealthy
= (CpuInfoInHob
[Index
].Health
== 0)? TRUE
:FALSE
;
1499 CpuMpData
->CpuData
[Index
].ApFunction
= 0;
1501 &CpuMpData
->CpuData
[Index
].VolatileRegisters
,
1502 &CpuMpData
->CpuData
[0].VolatileRegisters
,
1503 sizeof (CPU_VOLATILE_REGISTERS
)
1506 if (MaxLogicalProcessorNumber
> 1) {
1508 // Wakeup APs to do some AP initialize sync
1510 WakeUpAP (CpuMpData
, TRUE
, 0, ApInitializeSync
, CpuMpData
);
1512 // Wait for all APs finished initialization
1514 while (CpuMpData
->FinishedCount
< (CpuMpData
->CpuCount
- 1)) {
1517 CpuMpData
->InitFlag
= ApInitDone
;
1518 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
1519 SetApState (&CpuMpData
->CpuData
[Index
], CpuStateIdle
);
1525 // Initialize global data for MP support
1527 InitMpGlobalData (CpuMpData
);
1533 Gets detailed MP-related information on the requested processor at the
1534 instant this call is made. This service may only be called from the BSP.
1536 @param[in] ProcessorNumber The handle number of processor.
1537 @param[out] ProcessorInfoBuffer A pointer to the buffer where information for
1538 the requested processor is deposited.
1539 @param[out] HealthData Return processor health data.
1541 @retval EFI_SUCCESS Processor information was returned.
1542 @retval EFI_DEVICE_ERROR The calling processor is an AP.
1543 @retval EFI_INVALID_PARAMETER ProcessorInfoBuffer is NULL.
1544 @retval EFI_NOT_FOUND The processor with the handle specified by
1545 ProcessorNumber does not exist in the platform.
1546 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1551 MpInitLibGetProcessorInfo (
1552 IN UINTN ProcessorNumber
,
1553 OUT EFI_PROCESSOR_INFORMATION
*ProcessorInfoBuffer
,
1554 OUT EFI_HEALTH_FLAGS
*HealthData OPTIONAL
1557 CPU_MP_DATA
*CpuMpData
;
1559 CPU_INFO_IN_HOB
*CpuInfoInHob
;
1561 CpuMpData
= GetCpuMpData ();
1562 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
1565 // Check whether caller processor is BSP
1567 MpInitLibWhoAmI (&CallerNumber
);
1568 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1569 return EFI_DEVICE_ERROR
;
1572 if (ProcessorInfoBuffer
== NULL
) {
1573 return EFI_INVALID_PARAMETER
;
1576 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1577 return EFI_NOT_FOUND
;
1580 ProcessorInfoBuffer
->ProcessorId
= (UINT64
) CpuInfoInHob
[ProcessorNumber
].ApicId
;
1581 ProcessorInfoBuffer
->StatusFlag
= 0;
1582 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1583 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_AS_BSP_BIT
;
1585 if (CpuMpData
->CpuData
[ProcessorNumber
].CpuHealthy
) {
1586 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_HEALTH_STATUS_BIT
;
1588 if (GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]) == CpuStateDisabled
) {
1589 ProcessorInfoBuffer
->StatusFlag
&= ~PROCESSOR_ENABLED_BIT
;
1591 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_ENABLED_BIT
;
1595 // Get processor location information
1597 GetProcessorLocationByApicId (
1598 CpuInfoInHob
[ProcessorNumber
].ApicId
,
1599 &ProcessorInfoBuffer
->Location
.Package
,
1600 &ProcessorInfoBuffer
->Location
.Core
,
1601 &ProcessorInfoBuffer
->Location
.Thread
1604 if (HealthData
!= NULL
) {
1605 HealthData
->Uint32
= CpuInfoInHob
[ProcessorNumber
].Health
;
1612 Worker function to switch the requested AP to be the BSP from that point onward.
1614 @param[in] ProcessorNumber The handle number of AP that is to become the new BSP.
1615 @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an
1616 enabled AP. Otherwise, it will be disabled.
1618 @retval EFI_SUCCESS BSP successfully switched.
1619 @retval others Failed to switch BSP.
1624 IN UINTN ProcessorNumber
,
1625 IN BOOLEAN EnableOldBSP
1628 CPU_MP_DATA
*CpuMpData
;
1631 MSR_IA32_APIC_BASE_REGISTER ApicBaseMsr
;
1632 BOOLEAN OldInterruptState
;
1633 BOOLEAN OldTimerInterruptState
;
1636 // Save and Disable Local APIC timer interrupt
1638 OldTimerInterruptState
= GetApicTimerInterruptState ();
1639 DisableApicTimerInterrupt ();
1641 // Before send both BSP and AP to a procedure to exchange their roles,
1642 // interrupt must be disabled. This is because during the exchange role
1643 // process, 2 CPU may use 1 stack. If interrupt happens, the stack will
1644 // be corrupted, since interrupt return address will be pushed to stack
1647 OldInterruptState
= SaveAndDisableInterrupts ();
1650 // Mask LINT0 & LINT1 for the old BSP
1652 DisableLvtInterrupts ();
1654 CpuMpData
= GetCpuMpData ();
1657 // Check whether caller processor is BSP
1659 MpInitLibWhoAmI (&CallerNumber
);
1660 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1661 return EFI_DEVICE_ERROR
;
1664 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1665 return EFI_NOT_FOUND
;
1669 // Check whether specified AP is disabled
1671 State
= GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]);
1672 if (State
== CpuStateDisabled
) {
1673 return EFI_INVALID_PARAMETER
;
1677 // Check whether ProcessorNumber specifies the current BSP
1679 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1680 return EFI_INVALID_PARAMETER
;
1684 // Check whether specified AP is busy
1686 if (State
== CpuStateBusy
) {
1687 return EFI_NOT_READY
;
1690 CpuMpData
->BSPInfo
.State
= CPU_SWITCH_STATE_IDLE
;
1691 CpuMpData
->APInfo
.State
= CPU_SWITCH_STATE_IDLE
;
1692 CpuMpData
->SwitchBspFlag
= TRUE
;
1693 CpuMpData
->NewBspNumber
= ProcessorNumber
;
1696 // Clear the BSP bit of MSR_IA32_APIC_BASE
1698 ApicBaseMsr
.Uint64
= AsmReadMsr64 (MSR_IA32_APIC_BASE
);
1699 ApicBaseMsr
.Bits
.BSP
= 0;
1700 AsmWriteMsr64 (MSR_IA32_APIC_BASE
, ApicBaseMsr
.Uint64
);
1703 // Need to wakeUp AP (future BSP).
1705 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, FutureBSPProc
, CpuMpData
);
1707 AsmExchangeRole (&CpuMpData
->BSPInfo
, &CpuMpData
->APInfo
);
1710 // Set the BSP bit of MSR_IA32_APIC_BASE on new BSP
1712 ApicBaseMsr
.Uint64
= AsmReadMsr64 (MSR_IA32_APIC_BASE
);
1713 ApicBaseMsr
.Bits
.BSP
= 1;
1714 AsmWriteMsr64 (MSR_IA32_APIC_BASE
, ApicBaseMsr
.Uint64
);
1717 // Wait for old BSP finished AP task
1719 while (GetApState (&CpuMpData
->CpuData
[CallerNumber
]) != CpuStateFinished
) {
1723 CpuMpData
->SwitchBspFlag
= FALSE
;
1725 // Set old BSP enable state
1727 if (!EnableOldBSP
) {
1728 SetApState (&CpuMpData
->CpuData
[CallerNumber
], CpuStateDisabled
);
1730 SetApState (&CpuMpData
->CpuData
[CallerNumber
], CpuStateIdle
);
1733 // Save new BSP number
1735 CpuMpData
->BspNumber
= (UINT32
) ProcessorNumber
;
1738 // Restore interrupt state.
1740 SetInterruptState (OldInterruptState
);
1742 if (OldTimerInterruptState
) {
1743 EnableApicTimerInterrupt ();
1750 Worker function to let the caller enable or disable an AP from this point onward.
1751 This service may only be called from the BSP.
1753 @param[in] ProcessorNumber The handle number of AP.
1754 @param[in] EnableAP Specifies the new state for the processor for
1755 enabled, FALSE for disabled.
1756 @param[in] HealthFlag If not NULL, a pointer to a value that specifies
1757 the new health status of the AP.
1759 @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
1760 @retval others Failed to Enable/Disable AP.
1764 EnableDisableApWorker (
1765 IN UINTN ProcessorNumber
,
1766 IN BOOLEAN EnableAP
,
1767 IN UINT32
*HealthFlag OPTIONAL
1770 CPU_MP_DATA
*CpuMpData
;
1773 CpuMpData
= GetCpuMpData ();
1776 // Check whether caller processor is BSP
1778 MpInitLibWhoAmI (&CallerNumber
);
1779 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1780 return EFI_DEVICE_ERROR
;
1783 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1784 return EFI_INVALID_PARAMETER
;
1787 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1788 return EFI_NOT_FOUND
;
1792 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateDisabled
);
1794 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateIdle
);
1797 if (HealthFlag
!= NULL
) {
1798 CpuMpData
->CpuData
[ProcessorNumber
].CpuHealthy
=
1799 (BOOLEAN
) ((*HealthFlag
& PROCESSOR_HEALTH_STATUS_BIT
) != 0);
1806 This return the handle number for the calling processor. This service may be
1807 called from the BSP and APs.
1809 @param[out] ProcessorNumber Pointer to the handle number of AP.
1810 The range is from 0 to the total number of
1811 logical processors minus 1. The total number of
1812 logical processors can be retrieved by
1813 MpInitLibGetNumberOfProcessors().
1815 @retval EFI_SUCCESS The current processor handle number was returned
1817 @retval EFI_INVALID_PARAMETER ProcessorNumber is NULL.
1818 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1824 OUT UINTN
*ProcessorNumber
1827 CPU_MP_DATA
*CpuMpData
;
1829 if (ProcessorNumber
== NULL
) {
1830 return EFI_INVALID_PARAMETER
;
1833 CpuMpData
= GetCpuMpData ();
1835 return GetProcessorNumber (CpuMpData
, ProcessorNumber
);
1839 Retrieves the number of logical processor in the platform and the number of
1840 those logical processors that are enabled on this boot. This service may only
1841 be called from the BSP.
1843 @param[out] NumberOfProcessors Pointer to the total number of logical
1844 processors in the system, including the BSP
1846 @param[out] NumberOfEnabledProcessors Pointer to the number of enabled logical
1847 processors that exist in system, including
1850 @retval EFI_SUCCESS The number of logical processors and enabled
1851 logical processors was retrieved.
1852 @retval EFI_DEVICE_ERROR The calling processor is an AP.
1853 @retval EFI_INVALID_PARAMETER NumberOfProcessors is NULL and NumberOfEnabledProcessors
1855 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1860 MpInitLibGetNumberOfProcessors (
1861 OUT UINTN
*NumberOfProcessors
, OPTIONAL
1862 OUT UINTN
*NumberOfEnabledProcessors OPTIONAL
1865 CPU_MP_DATA
*CpuMpData
;
1867 UINTN ProcessorNumber
;
1868 UINTN EnabledProcessorNumber
;
1871 CpuMpData
= GetCpuMpData ();
1873 if ((NumberOfProcessors
== NULL
) && (NumberOfEnabledProcessors
== NULL
)) {
1874 return EFI_INVALID_PARAMETER
;
1878 // Check whether caller processor is BSP
1880 MpInitLibWhoAmI (&CallerNumber
);
1881 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1882 return EFI_DEVICE_ERROR
;
1885 ProcessorNumber
= CpuMpData
->CpuCount
;
1886 EnabledProcessorNumber
= 0;
1887 for (Index
= 0; Index
< ProcessorNumber
; Index
++) {
1888 if (GetApState (&CpuMpData
->CpuData
[Index
]) != CpuStateDisabled
) {
1889 EnabledProcessorNumber
++;
1893 if (NumberOfProcessors
!= NULL
) {
1894 *NumberOfProcessors
= ProcessorNumber
;
1896 if (NumberOfEnabledProcessors
!= NULL
) {
1897 *NumberOfEnabledProcessors
= EnabledProcessorNumber
;
1905 Worker function to execute a caller provided function on all enabled APs.
1907 @param[in] Procedure A pointer to the function to be run on
1908 enabled APs of the system.
1909 @param[in] SingleThread If TRUE, then all the enabled APs execute
1910 the function specified by Procedure one by
1911 one, in ascending order of processor handle
1912 number. If FALSE, then all the enabled APs
1913 execute the function specified by Procedure
1915 @param[in] WaitEvent The event created by the caller with CreateEvent()
1917 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
1918 APs to return from Procedure, either for
1919 blocking or non-blocking mode.
1920 @param[in] ProcedureArgument The parameter passed into Procedure for
1922 @param[out] FailedCpuList If all APs finish successfully, then its
1923 content is set to NULL. If not all APs
1924 finish before timeout expires, then its
1925 content is set to address of the buffer
1926 holding handle numbers of the failed APs.
1928 @retval EFI_SUCCESS In blocking mode, all APs have finished before
1929 the timeout expired.
1930 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched
1932 @retval others Failed to Startup all APs.
1936 StartupAllAPsWorker (
1937 IN EFI_AP_PROCEDURE Procedure
,
1938 IN BOOLEAN SingleThread
,
1939 IN EFI_EVENT WaitEvent OPTIONAL
,
1940 IN UINTN TimeoutInMicroseconds
,
1941 IN VOID
*ProcedureArgument OPTIONAL
,
1942 OUT UINTN
**FailedCpuList OPTIONAL
1946 CPU_MP_DATA
*CpuMpData
;
1947 UINTN ProcessorCount
;
1948 UINTN ProcessorNumber
;
1950 CPU_AP_DATA
*CpuData
;
1951 BOOLEAN HasEnabledAp
;
1954 CpuMpData
= GetCpuMpData ();
1956 if (FailedCpuList
!= NULL
) {
1957 *FailedCpuList
= NULL
;
1960 if (CpuMpData
->CpuCount
== 1) {
1961 return EFI_NOT_STARTED
;
1964 if (Procedure
== NULL
) {
1965 return EFI_INVALID_PARAMETER
;
1969 // Check whether caller processor is BSP
1971 MpInitLibWhoAmI (&CallerNumber
);
1972 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1973 return EFI_DEVICE_ERROR
;
1979 CheckAndUpdateApsStatus ();
1981 ProcessorCount
= CpuMpData
->CpuCount
;
1982 HasEnabledAp
= FALSE
;
1984 // Check whether all enabled APs are idle.
1985 // If any enabled AP is not idle, return EFI_NOT_READY.
1987 for (ProcessorNumber
= 0; ProcessorNumber
< ProcessorCount
; ProcessorNumber
++) {
1988 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1989 if (ProcessorNumber
!= CpuMpData
->BspNumber
) {
1990 ApState
= GetApState (CpuData
);
1991 if (ApState
!= CpuStateDisabled
) {
1992 HasEnabledAp
= TRUE
;
1993 if (ApState
!= CpuStateIdle
) {
1995 // If any enabled APs are busy, return EFI_NOT_READY.
1997 return EFI_NOT_READY
;
2003 if (!HasEnabledAp
) {
2005 // If no enabled AP exists, return EFI_NOT_STARTED.
2007 return EFI_NOT_STARTED
;
2010 CpuMpData
->StartCount
= 0;
2011 for (ProcessorNumber
= 0; ProcessorNumber
< ProcessorCount
; ProcessorNumber
++) {
2012 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
2013 CpuData
->Waiting
= FALSE
;
2014 if (ProcessorNumber
!= CpuMpData
->BspNumber
) {
2015 if (CpuData
->State
== CpuStateIdle
) {
2017 // Mark this processor as responsible for current calling.
2019 CpuData
->Waiting
= TRUE
;
2020 CpuMpData
->StartCount
++;
2025 CpuMpData
->Procedure
= Procedure
;
2026 CpuMpData
->ProcArguments
= ProcedureArgument
;
2027 CpuMpData
->SingleThread
= SingleThread
;
2028 CpuMpData
->FinishedCount
= 0;
2029 CpuMpData
->RunningCount
= 0;
2030 CpuMpData
->FailedCpuList
= FailedCpuList
;
2031 CpuMpData
->ExpectedTime
= CalculateTimeout (
2032 TimeoutInMicroseconds
,
2033 &CpuMpData
->CurrentTime
2035 CpuMpData
->TotalTime
= 0;
2036 CpuMpData
->WaitEvent
= WaitEvent
;
2038 if (!SingleThread
) {
2039 WakeUpAP (CpuMpData
, TRUE
, 0, Procedure
, ProcedureArgument
);
2041 for (ProcessorNumber
= 0; ProcessorNumber
< ProcessorCount
; ProcessorNumber
++) {
2042 if (ProcessorNumber
== CallerNumber
) {
2045 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
2046 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, Procedure
, ProcedureArgument
);
2052 Status
= EFI_SUCCESS
;
2053 if (WaitEvent
== NULL
) {
2055 Status
= CheckAllAPs ();
2056 } while (Status
== EFI_NOT_READY
);
2063 Worker function to let the caller get one enabled AP to execute a caller-provided
2066 @param[in] Procedure A pointer to the function to be run on
2067 enabled APs of the system.
2068 @param[in] ProcessorNumber The handle number of the AP.
2069 @param[in] WaitEvent The event created by the caller with CreateEvent()
2071 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
2072 APs to return from Procedure, either for
2073 blocking or non-blocking mode.
2074 @param[in] ProcedureArgument The parameter passed into Procedure for
2076 @param[out] Finished If AP returns from Procedure before the
2077 timeout expires, its content is set to TRUE.
2078 Otherwise, the value is set to FALSE.
2080 @retval EFI_SUCCESS In blocking mode, specified AP finished before
2081 the timeout expires.
2082 @retval others Failed to Startup AP.
2086 StartupThisAPWorker (
2087 IN EFI_AP_PROCEDURE Procedure
,
2088 IN UINTN ProcessorNumber
,
2089 IN EFI_EVENT WaitEvent OPTIONAL
,
2090 IN UINTN TimeoutInMicroseconds
,
2091 IN VOID
*ProcedureArgument OPTIONAL
,
2092 OUT BOOLEAN
*Finished OPTIONAL
2096 CPU_MP_DATA
*CpuMpData
;
2097 CPU_AP_DATA
*CpuData
;
2100 CpuMpData
= GetCpuMpData ();
2102 if (Finished
!= NULL
) {
2107 // Check whether caller processor is BSP
2109 MpInitLibWhoAmI (&CallerNumber
);
2110 if (CallerNumber
!= CpuMpData
->BspNumber
) {
2111 return EFI_DEVICE_ERROR
;
2115 // Check whether processor with the handle specified by ProcessorNumber exists
2117 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
2118 return EFI_NOT_FOUND
;
2122 // Check whether specified processor is BSP
2124 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
2125 return EFI_INVALID_PARAMETER
;
2129 // Check parameter Procedure
2131 if (Procedure
== NULL
) {
2132 return EFI_INVALID_PARAMETER
;
2138 CheckAndUpdateApsStatus ();
2141 // Check whether specified AP is disabled
2143 if (GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]) == CpuStateDisabled
) {
2144 return EFI_INVALID_PARAMETER
;
2148 // If WaitEvent is not NULL, execute in non-blocking mode.
2149 // BSP saves data for CheckAPsStatus(), and returns EFI_SUCCESS.
2150 // CheckAPsStatus() will check completion and timeout periodically.
2152 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
2153 CpuData
->WaitEvent
= WaitEvent
;
2154 CpuData
->Finished
= Finished
;
2155 CpuData
->ExpectedTime
= CalculateTimeout (TimeoutInMicroseconds
, &CpuData
->CurrentTime
);
2156 CpuData
->TotalTime
= 0;
2158 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, Procedure
, ProcedureArgument
);
2161 // If WaitEvent is NULL, execute in blocking mode.
2162 // BSP checks AP's state until it finishes or TimeoutInMicrosecsond expires.
2164 Status
= EFI_SUCCESS
;
2165 if (WaitEvent
== NULL
) {
2167 Status
= CheckThisAP (ProcessorNumber
);
2168 } while (Status
== EFI_NOT_READY
);
2175 Get pointer to CPU MP Data structure from GUIDed HOB.
2177 @return The pointer to CPU MP Data structure.
2180 GetCpuMpDataFromGuidedHob (
2184 EFI_HOB_GUID_TYPE
*GuidHob
;
2186 CPU_MP_DATA
*CpuMpData
;
2189 GuidHob
= GetFirstGuidHob (&mCpuInitMpLibHobGuid
);
2190 if (GuidHob
!= NULL
) {
2191 DataInHob
= GET_GUID_HOB_DATA (GuidHob
);
2192 CpuMpData
= (CPU_MP_DATA
*) (*(UINTN
*) DataInHob
);