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 This function will be called by BSP to wakeup AP.
801 @param[in] CpuMpData Pointer to CPU MP Data
802 @param[in] Broadcast TRUE: Send broadcast IPI to all APs
803 FALSE: Send IPI to AP by ApicId
804 @param[in] ProcessorNumber The handle number of specified processor
805 @param[in] Procedure The function to be invoked by AP
806 @param[in] ProcedureArgument The argument to be passed into AP function
810 IN CPU_MP_DATA
*CpuMpData
,
811 IN BOOLEAN Broadcast
,
812 IN UINTN ProcessorNumber
,
813 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
814 IN VOID
*ProcedureArgument OPTIONAL
817 volatile MP_CPU_EXCHANGE_INFO
*ExchangeInfo
;
819 CPU_AP_DATA
*CpuData
;
820 BOOLEAN ResetVectorRequired
;
821 CPU_INFO_IN_HOB
*CpuInfoInHob
;
823 CpuMpData
->FinishedCount
= 0;
824 ResetVectorRequired
= FALSE
;
826 if (CpuMpData
->ApLoopMode
== ApInHltLoop
||
827 CpuMpData
->InitFlag
!= ApInitDone
) {
828 ResetVectorRequired
= TRUE
;
829 AllocateResetVector (CpuMpData
);
830 FillExchangeInfoData (CpuMpData
);
831 SaveLocalApicTimerSetting (CpuMpData
);
832 } else if (CpuMpData
->ApLoopMode
== ApInMwaitLoop
) {
834 // Get AP target C-state each time when waking up AP,
835 // for it maybe updated by platform again
837 CpuMpData
->ApTargetCState
= PcdGet8 (PcdCpuApTargetCstate
);
840 ExchangeInfo
= CpuMpData
->MpCpuExchangeInfo
;
843 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
844 if (Index
!= CpuMpData
->BspNumber
) {
845 CpuData
= &CpuMpData
->CpuData
[Index
];
846 CpuData
->ApFunction
= (UINTN
) Procedure
;
847 CpuData
->ApFunctionArgument
= (UINTN
) ProcedureArgument
;
848 SetApState (CpuData
, CpuStateReady
);
849 if (CpuMpData
->InitFlag
!= ApInitConfig
) {
850 *(UINT32
*) CpuData
->StartupApSignal
= WAKEUP_AP_SIGNAL
;
854 if (ResetVectorRequired
) {
858 SendInitSipiSipiAllExcludingSelf ((UINT32
) ExchangeInfo
->BufferStart
);
860 if (CpuMpData
->InitFlag
== ApInitConfig
) {
862 // Wait for all potential APs waken up in one specified period
864 TimedWaitForApFinish (
866 PcdGet32 (PcdCpuMaxLogicalProcessorNumber
) - 1,
867 PcdGet32 (PcdCpuApInitTimeOutInMicroSeconds
)
871 // Wait all APs waken up if this is not the 1st broadcast of SIPI
873 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
874 CpuData
= &CpuMpData
->CpuData
[Index
];
875 if (Index
!= CpuMpData
->BspNumber
) {
876 WaitApWakeup (CpuData
->StartupApSignal
);
881 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
882 CpuData
->ApFunction
= (UINTN
) Procedure
;
883 CpuData
->ApFunctionArgument
= (UINTN
) ProcedureArgument
;
884 SetApState (CpuData
, CpuStateReady
);
886 // Wakeup specified AP
888 ASSERT (CpuMpData
->InitFlag
!= ApInitConfig
);
889 *(UINT32
*) CpuData
->StartupApSignal
= WAKEUP_AP_SIGNAL
;
890 if (ResetVectorRequired
) {
891 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
893 CpuInfoInHob
[ProcessorNumber
].ApicId
,
894 (UINT32
) ExchangeInfo
->BufferStart
898 // Wait specified AP waken up
900 WaitApWakeup (CpuData
->StartupApSignal
);
903 if (ResetVectorRequired
) {
904 FreeResetVector (CpuMpData
);
909 Calculate timeout value and return the current performance counter value.
911 Calculate the number of performance counter ticks required for a timeout.
912 If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
915 @param[in] TimeoutInMicroseconds Timeout value in microseconds.
916 @param[out] CurrentTime Returns the current value of the performance counter.
918 @return Expected time stamp counter for timeout.
919 If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
925 IN UINTN TimeoutInMicroseconds
,
926 OUT UINT64
*CurrentTime
930 // Read the current value of the performance counter
932 *CurrentTime
= GetPerformanceCounter ();
935 // If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
938 if (TimeoutInMicroseconds
== 0) {
943 // GetPerformanceCounterProperties () returns the timestamp counter's frequency
944 // in Hz. So multiply the return value with TimeoutInMicroseconds and then divide
945 // it by 1,000,000, to get the number of ticks for the timeout value.
949 GetPerformanceCounterProperties (NULL
, NULL
),
950 TimeoutInMicroseconds
957 Checks whether timeout expires.
959 Check whether the number of elapsed performance counter ticks required for
960 a timeout condition has been reached.
961 If Timeout is zero, which means infinity, return value is always FALSE.
963 @param[in, out] PreviousTime On input, the value of the performance counter
964 when it was last read.
965 On output, the current value of the performance
967 @param[in] TotalTime The total amount of elapsed time in performance
969 @param[in] Timeout The number of performance counter ticks required
970 to reach a timeout condition.
972 @retval TRUE A timeout condition has been reached.
973 @retval FALSE A timeout condition has not been reached.
978 IN OUT UINT64
*PreviousTime
,
979 IN UINT64
*TotalTime
,
992 GetPerformanceCounterProperties (&Start
, &End
);
998 CurrentTime
= GetPerformanceCounter();
999 Delta
= (INT64
) (CurrentTime
- *PreviousTime
);
1006 *TotalTime
+= Delta
;
1007 *PreviousTime
= CurrentTime
;
1008 if (*TotalTime
> Timeout
) {
1015 Helper function that waits until the finished AP count reaches the specified
1016 limit, or the specified timeout elapses (whichever comes first).
1018 @param[in] CpuMpData Pointer to CPU MP Data.
1019 @param[in] FinishedApLimit The number of finished APs to wait for.
1020 @param[in] TimeLimit The number of microseconds to wait for.
1023 TimedWaitForApFinish (
1024 IN CPU_MP_DATA
*CpuMpData
,
1025 IN UINT32 FinishedApLimit
,
1030 // CalculateTimeout() and CheckTimeout() consider a TimeLimit of 0
1031 // "infinity", so check for (TimeLimit == 0) explicitly.
1033 if (TimeLimit
== 0) {
1037 CpuMpData
->TotalTime
= 0;
1038 CpuMpData
->ExpectedTime
= CalculateTimeout (
1040 &CpuMpData
->CurrentTime
1042 while (CpuMpData
->FinishedCount
< FinishedApLimit
&&
1044 &CpuMpData
->CurrentTime
,
1045 &CpuMpData
->TotalTime
,
1046 CpuMpData
->ExpectedTime
1051 if (CpuMpData
->FinishedCount
>= FinishedApLimit
) {
1054 "%a: reached FinishedApLimit=%u in %Lu microseconds\n",
1057 DivU64x64Remainder (
1058 MultU64x32 (CpuMpData
->TotalTime
, 1000000),
1059 GetPerformanceCounterProperties (NULL
, NULL
),
1067 Reset an AP to Idle state.
1069 Any task being executed by the AP will be aborted and the AP
1070 will be waiting for a new task in Wait-For-SIPI state.
1072 @param[in] ProcessorNumber The handle number of processor.
1075 ResetProcessorToIdleState (
1076 IN UINTN ProcessorNumber
1079 CPU_MP_DATA
*CpuMpData
;
1081 CpuMpData
= GetCpuMpData ();
1083 CpuMpData
->InitFlag
= ApInitReconfig
;
1084 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, NULL
, NULL
);
1085 while (CpuMpData
->FinishedCount
< 1) {
1088 CpuMpData
->InitFlag
= ApInitDone
;
1090 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateIdle
);
1094 Searches for the next waiting AP.
1096 Search for the next AP that is put in waiting state by single-threaded StartupAllAPs().
1098 @param[out] NextProcessorNumber Pointer to the processor number of the next waiting AP.
1100 @retval EFI_SUCCESS The next waiting AP has been found.
1101 @retval EFI_NOT_FOUND No waiting AP exists.
1105 GetNextWaitingProcessorNumber (
1106 OUT UINTN
*NextProcessorNumber
1109 UINTN ProcessorNumber
;
1110 CPU_MP_DATA
*CpuMpData
;
1112 CpuMpData
= GetCpuMpData ();
1114 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
1115 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1116 *NextProcessorNumber
= ProcessorNumber
;
1121 return EFI_NOT_FOUND
;
1124 /** Checks status of specified AP.
1126 This function checks whether the specified AP has finished the task assigned
1127 by StartupThisAP(), and whether timeout expires.
1129 @param[in] ProcessorNumber The handle number of processor.
1131 @retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().
1132 @retval EFI_TIMEOUT The timeout expires.
1133 @retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.
1137 IN UINTN ProcessorNumber
1140 CPU_MP_DATA
*CpuMpData
;
1141 CPU_AP_DATA
*CpuData
;
1143 CpuMpData
= GetCpuMpData ();
1144 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1147 // Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.
1148 // Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the
1149 // value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.
1152 // If the AP finishes for StartupThisAP(), return EFI_SUCCESS.
1154 if (GetApState(CpuData
) == CpuStateFinished
) {
1155 if (CpuData
->Finished
!= NULL
) {
1156 *(CpuData
->Finished
) = TRUE
;
1158 SetApState (CpuData
, CpuStateIdle
);
1162 // If timeout expires for StartupThisAP(), report timeout.
1164 if (CheckTimeout (&CpuData
->CurrentTime
, &CpuData
->TotalTime
, CpuData
->ExpectedTime
)) {
1165 if (CpuData
->Finished
!= NULL
) {
1166 *(CpuData
->Finished
) = FALSE
;
1169 // Reset failed AP to idle state
1171 ResetProcessorToIdleState (ProcessorNumber
);
1176 return EFI_NOT_READY
;
1180 Checks status of all APs.
1182 This function checks whether all APs have finished task assigned by StartupAllAPs(),
1183 and whether timeout expires.
1185 @retval EFI_SUCCESS All APs have finished task assigned by StartupAllAPs().
1186 @retval EFI_TIMEOUT The timeout expires.
1187 @retval EFI_NOT_READY APs have not finished task and timeout has not expired.
1194 UINTN ProcessorNumber
;
1195 UINTN NextProcessorNumber
;
1198 CPU_MP_DATA
*CpuMpData
;
1199 CPU_AP_DATA
*CpuData
;
1201 CpuMpData
= GetCpuMpData ();
1203 NextProcessorNumber
= 0;
1206 // Go through all APs that are responsible for the StartupAllAPs().
1208 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
1209 if (!CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1213 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1215 // Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.
1216 // Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the
1217 // value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.
1219 if (GetApState(CpuData
) == CpuStateFinished
) {
1220 CpuMpData
->RunningCount
++;
1221 CpuMpData
->CpuData
[ProcessorNumber
].Waiting
= FALSE
;
1222 SetApState(CpuData
, CpuStateIdle
);
1225 // If in Single Thread mode, then search for the next waiting AP for execution.
1227 if (CpuMpData
->SingleThread
) {
1228 Status
= GetNextWaitingProcessorNumber (&NextProcessorNumber
);
1230 if (!EFI_ERROR (Status
)) {
1234 (UINT32
) NextProcessorNumber
,
1235 CpuMpData
->Procedure
,
1236 CpuMpData
->ProcArguments
1244 // If all APs finish, return EFI_SUCCESS.
1246 if (CpuMpData
->RunningCount
== CpuMpData
->StartCount
) {
1251 // If timeout expires, report timeout.
1254 &CpuMpData
->CurrentTime
,
1255 &CpuMpData
->TotalTime
,
1256 CpuMpData
->ExpectedTime
)
1259 // If FailedCpuList is not NULL, record all failed APs in it.
1261 if (CpuMpData
->FailedCpuList
!= NULL
) {
1262 *CpuMpData
->FailedCpuList
=
1263 AllocatePool ((CpuMpData
->StartCount
- CpuMpData
->FinishedCount
+ 1) * sizeof (UINTN
));
1264 ASSERT (*CpuMpData
->FailedCpuList
!= NULL
);
1268 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
1270 // Check whether this processor is responsible for StartupAllAPs().
1272 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1274 // Reset failed APs to idle state
1276 ResetProcessorToIdleState (ProcessorNumber
);
1277 CpuMpData
->CpuData
[ProcessorNumber
].Waiting
= FALSE
;
1278 if (CpuMpData
->FailedCpuList
!= NULL
) {
1279 (*CpuMpData
->FailedCpuList
)[ListIndex
++] = ProcessorNumber
;
1283 if (CpuMpData
->FailedCpuList
!= NULL
) {
1284 (*CpuMpData
->FailedCpuList
)[ListIndex
] = END_OF_CPU_LIST
;
1288 return EFI_NOT_READY
;
1292 MP Initialize Library initialization.
1294 This service will allocate AP reset vector and wakeup all APs to do APs
1297 This service must be invoked before all other MP Initialize Library
1298 service are invoked.
1300 @retval EFI_SUCCESS MP initialization succeeds.
1301 @retval Others MP initialization fails.
1306 MpInitLibInitialize (
1310 CPU_MP_DATA
*OldCpuMpData
;
1311 CPU_INFO_IN_HOB
*CpuInfoInHob
;
1312 UINT32 MaxLogicalProcessorNumber
;
1314 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
1316 UINT32 MonitorFilterSize
;
1319 CPU_MP_DATA
*CpuMpData
;
1321 UINT8
*MonitorBuffer
;
1323 UINTN ApResetVectorSize
;
1324 UINTN BackupBufferAddr
;
1326 OldCpuMpData
= GetCpuMpDataFromGuidedHob ();
1327 if (OldCpuMpData
== NULL
) {
1328 MaxLogicalProcessorNumber
= PcdGet32(PcdCpuMaxLogicalProcessorNumber
);
1330 MaxLogicalProcessorNumber
= OldCpuMpData
->CpuCount
;
1332 ASSERT (MaxLogicalProcessorNumber
!= 0);
1334 AsmGetAddressMap (&AddressMap
);
1335 ApResetVectorSize
= AddressMap
.RendezvousFunnelSize
+ sizeof (MP_CPU_EXCHANGE_INFO
);
1336 ApStackSize
= PcdGet32(PcdCpuApStackSize
);
1337 ApLoopMode
= GetApLoopMode (&MonitorFilterSize
);
1339 BufferSize
= ApStackSize
* MaxLogicalProcessorNumber
;
1340 BufferSize
+= MonitorFilterSize
* MaxLogicalProcessorNumber
;
1341 BufferSize
+= sizeof (CPU_MP_DATA
);
1342 BufferSize
+= ApResetVectorSize
;
1343 BufferSize
+= (sizeof (CPU_AP_DATA
) + sizeof (CPU_INFO_IN_HOB
))* MaxLogicalProcessorNumber
;
1344 MpBuffer
= AllocatePages (EFI_SIZE_TO_PAGES (BufferSize
));
1345 ASSERT (MpBuffer
!= NULL
);
1346 ZeroMem (MpBuffer
, BufferSize
);
1347 Buffer
= (UINTN
) MpBuffer
;
1349 MonitorBuffer
= (UINT8
*) (Buffer
+ ApStackSize
* MaxLogicalProcessorNumber
);
1350 BackupBufferAddr
= (UINTN
) MonitorBuffer
+ MonitorFilterSize
* MaxLogicalProcessorNumber
;
1351 CpuMpData
= (CPU_MP_DATA
*) (BackupBufferAddr
+ ApResetVectorSize
);
1352 CpuMpData
->Buffer
= Buffer
;
1353 CpuMpData
->CpuApStackSize
= ApStackSize
;
1354 CpuMpData
->BackupBuffer
= BackupBufferAddr
;
1355 CpuMpData
->BackupBufferSize
= ApResetVectorSize
;
1356 CpuMpData
->SaveRestoreFlag
= FALSE
;
1357 CpuMpData
->WakeupBuffer
= (UINTN
) -1;
1358 CpuMpData
->CpuCount
= 1;
1359 CpuMpData
->BspNumber
= 0;
1360 CpuMpData
->WaitEvent
= NULL
;
1361 CpuMpData
->SwitchBspFlag
= FALSE
;
1362 CpuMpData
->CpuData
= (CPU_AP_DATA
*) (CpuMpData
+ 1);
1363 CpuMpData
->CpuInfoInHob
= (UINT64
) (UINTN
) (CpuMpData
->CpuData
+ MaxLogicalProcessorNumber
);
1364 InitializeSpinLock(&CpuMpData
->MpLock
);
1366 // Save BSP's Control registers to APs
1368 SaveVolatileRegisters (&CpuMpData
->CpuData
[0].VolatileRegisters
);
1370 // Set BSP basic information
1372 InitializeApData (CpuMpData
, 0, 0, CpuMpData
->Buffer
);
1374 // Save assembly code information
1376 CopyMem (&CpuMpData
->AddressMap
, &AddressMap
, sizeof (MP_ASSEMBLY_ADDRESS_MAP
));
1378 // Finally set AP loop mode
1380 CpuMpData
->ApLoopMode
= ApLoopMode
;
1381 DEBUG ((DEBUG_INFO
, "AP Loop Mode is %d\n", CpuMpData
->ApLoopMode
));
1383 // Set up APs wakeup signal buffer
1385 for (Index
= 0; Index
< MaxLogicalProcessorNumber
; Index
++) {
1386 CpuMpData
->CpuData
[Index
].StartupApSignal
=
1387 (UINT32
*)(MonitorBuffer
+ MonitorFilterSize
* Index
);
1390 // Load Microcode on BSP
1392 MicrocodeDetect (CpuMpData
);
1394 // Store BSP's MTRR setting
1396 MtrrGetAllMtrrs (&CpuMpData
->MtrrTable
);
1398 // Enable the local APIC for Virtual Wire Mode.
1400 ProgramVirtualWireMode ();
1402 if (OldCpuMpData
== NULL
) {
1403 if (MaxLogicalProcessorNumber
> 1) {
1405 // Wakeup all APs and calculate the processor count in system
1407 CollectProcessorCount (CpuMpData
);
1411 // APs have been wakeup before, just get the CPU Information
1414 CpuMpData
->CpuCount
= OldCpuMpData
->CpuCount
;
1415 CpuMpData
->BspNumber
= OldCpuMpData
->BspNumber
;
1416 CpuMpData
->InitFlag
= ApInitReconfig
;
1417 CpuMpData
->CpuInfoInHob
= OldCpuMpData
->CpuInfoInHob
;
1418 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
1419 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
1420 InitializeSpinLock(&CpuMpData
->CpuData
[Index
].ApLock
);
1421 if (CpuInfoInHob
[Index
].InitialApicId
>= 255 || Index
> 254) {
1422 CpuMpData
->X2ApicEnable
= TRUE
;
1424 CpuMpData
->CpuData
[Index
].CpuHealthy
= (CpuInfoInHob
[Index
].Health
== 0)? TRUE
:FALSE
;
1425 CpuMpData
->CpuData
[Index
].ApFunction
= 0;
1427 &CpuMpData
->CpuData
[Index
].VolatileRegisters
,
1428 &CpuMpData
->CpuData
[0].VolatileRegisters
,
1429 sizeof (CPU_VOLATILE_REGISTERS
)
1432 if (MaxLogicalProcessorNumber
> 1) {
1434 // Wakeup APs to do some AP initialize sync
1436 WakeUpAP (CpuMpData
, TRUE
, 0, ApInitializeSync
, CpuMpData
);
1438 // Wait for all APs finished initialization
1440 while (CpuMpData
->FinishedCount
< (CpuMpData
->CpuCount
- 1)) {
1443 CpuMpData
->InitFlag
= ApInitDone
;
1444 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
1445 SetApState (&CpuMpData
->CpuData
[Index
], CpuStateIdle
);
1451 // Initialize global data for MP support
1453 InitMpGlobalData (CpuMpData
);
1459 Gets detailed MP-related information on the requested processor at the
1460 instant this call is made. This service may only be called from the BSP.
1462 @param[in] ProcessorNumber The handle number of processor.
1463 @param[out] ProcessorInfoBuffer A pointer to the buffer where information for
1464 the requested processor is deposited.
1465 @param[out] HealthData Return processor health data.
1467 @retval EFI_SUCCESS Processor information was returned.
1468 @retval EFI_DEVICE_ERROR The calling processor is an AP.
1469 @retval EFI_INVALID_PARAMETER ProcessorInfoBuffer is NULL.
1470 @retval EFI_NOT_FOUND The processor with the handle specified by
1471 ProcessorNumber does not exist in the platform.
1472 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1477 MpInitLibGetProcessorInfo (
1478 IN UINTN ProcessorNumber
,
1479 OUT EFI_PROCESSOR_INFORMATION
*ProcessorInfoBuffer
,
1480 OUT EFI_HEALTH_FLAGS
*HealthData OPTIONAL
1483 CPU_MP_DATA
*CpuMpData
;
1485 CPU_INFO_IN_HOB
*CpuInfoInHob
;
1487 CpuMpData
= GetCpuMpData ();
1488 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
1491 // Check whether caller processor is BSP
1493 MpInitLibWhoAmI (&CallerNumber
);
1494 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1495 return EFI_DEVICE_ERROR
;
1498 if (ProcessorInfoBuffer
== NULL
) {
1499 return EFI_INVALID_PARAMETER
;
1502 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1503 return EFI_NOT_FOUND
;
1506 ProcessorInfoBuffer
->ProcessorId
= (UINT64
) CpuInfoInHob
[ProcessorNumber
].ApicId
;
1507 ProcessorInfoBuffer
->StatusFlag
= 0;
1508 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1509 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_AS_BSP_BIT
;
1511 if (CpuMpData
->CpuData
[ProcessorNumber
].CpuHealthy
) {
1512 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_HEALTH_STATUS_BIT
;
1514 if (GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]) == CpuStateDisabled
) {
1515 ProcessorInfoBuffer
->StatusFlag
&= ~PROCESSOR_ENABLED_BIT
;
1517 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_ENABLED_BIT
;
1521 // Get processor location information
1523 GetProcessorLocationByApicId (
1524 CpuInfoInHob
[ProcessorNumber
].ApicId
,
1525 &ProcessorInfoBuffer
->Location
.Package
,
1526 &ProcessorInfoBuffer
->Location
.Core
,
1527 &ProcessorInfoBuffer
->Location
.Thread
1530 if (HealthData
!= NULL
) {
1531 HealthData
->Uint32
= CpuInfoInHob
[ProcessorNumber
].Health
;
1538 Worker function to switch the requested AP to be the BSP from that point onward.
1540 @param[in] ProcessorNumber The handle number of AP that is to become the new BSP.
1541 @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an
1542 enabled AP. Otherwise, it will be disabled.
1544 @retval EFI_SUCCESS BSP successfully switched.
1545 @retval others Failed to switch BSP.
1550 IN UINTN ProcessorNumber
,
1551 IN BOOLEAN EnableOldBSP
1554 CPU_MP_DATA
*CpuMpData
;
1557 MSR_IA32_APIC_BASE_REGISTER ApicBaseMsr
;
1558 BOOLEAN OldInterruptState
;
1559 BOOLEAN OldTimerInterruptState
;
1562 // Save and Disable Local APIC timer interrupt
1564 OldTimerInterruptState
= GetApicTimerInterruptState ();
1565 DisableApicTimerInterrupt ();
1567 // Before send both BSP and AP to a procedure to exchange their roles,
1568 // interrupt must be disabled. This is because during the exchange role
1569 // process, 2 CPU may use 1 stack. If interrupt happens, the stack will
1570 // be corrupted, since interrupt return address will be pushed to stack
1573 OldInterruptState
= SaveAndDisableInterrupts ();
1576 // Mask LINT0 & LINT1 for the old BSP
1578 DisableLvtInterrupts ();
1580 CpuMpData
= GetCpuMpData ();
1583 // Check whether caller processor is BSP
1585 MpInitLibWhoAmI (&CallerNumber
);
1586 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1587 return EFI_DEVICE_ERROR
;
1590 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1591 return EFI_NOT_FOUND
;
1595 // Check whether specified AP is disabled
1597 State
= GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]);
1598 if (State
== CpuStateDisabled
) {
1599 return EFI_INVALID_PARAMETER
;
1603 // Check whether ProcessorNumber specifies the current BSP
1605 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1606 return EFI_INVALID_PARAMETER
;
1610 // Check whether specified AP is busy
1612 if (State
== CpuStateBusy
) {
1613 return EFI_NOT_READY
;
1616 CpuMpData
->BSPInfo
.State
= CPU_SWITCH_STATE_IDLE
;
1617 CpuMpData
->APInfo
.State
= CPU_SWITCH_STATE_IDLE
;
1618 CpuMpData
->SwitchBspFlag
= TRUE
;
1619 CpuMpData
->NewBspNumber
= ProcessorNumber
;
1622 // Clear the BSP bit of MSR_IA32_APIC_BASE
1624 ApicBaseMsr
.Uint64
= AsmReadMsr64 (MSR_IA32_APIC_BASE
);
1625 ApicBaseMsr
.Bits
.BSP
= 0;
1626 AsmWriteMsr64 (MSR_IA32_APIC_BASE
, ApicBaseMsr
.Uint64
);
1629 // Need to wakeUp AP (future BSP).
1631 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, FutureBSPProc
, CpuMpData
);
1633 AsmExchangeRole (&CpuMpData
->BSPInfo
, &CpuMpData
->APInfo
);
1636 // Set the BSP bit of MSR_IA32_APIC_BASE on new BSP
1638 ApicBaseMsr
.Uint64
= AsmReadMsr64 (MSR_IA32_APIC_BASE
);
1639 ApicBaseMsr
.Bits
.BSP
= 1;
1640 AsmWriteMsr64 (MSR_IA32_APIC_BASE
, ApicBaseMsr
.Uint64
);
1643 // Wait for old BSP finished AP task
1645 while (GetApState (&CpuMpData
->CpuData
[CallerNumber
]) != CpuStateFinished
) {
1649 CpuMpData
->SwitchBspFlag
= FALSE
;
1651 // Set old BSP enable state
1653 if (!EnableOldBSP
) {
1654 SetApState (&CpuMpData
->CpuData
[CallerNumber
], CpuStateDisabled
);
1656 SetApState (&CpuMpData
->CpuData
[CallerNumber
], CpuStateIdle
);
1659 // Save new BSP number
1661 CpuMpData
->BspNumber
= (UINT32
) ProcessorNumber
;
1664 // Restore interrupt state.
1666 SetInterruptState (OldInterruptState
);
1668 if (OldTimerInterruptState
) {
1669 EnableApicTimerInterrupt ();
1676 Worker function to let the caller enable or disable an AP from this point onward.
1677 This service may only be called from the BSP.
1679 @param[in] ProcessorNumber The handle number of AP.
1680 @param[in] EnableAP Specifies the new state for the processor for
1681 enabled, FALSE for disabled.
1682 @param[in] HealthFlag If not NULL, a pointer to a value that specifies
1683 the new health status of the AP.
1685 @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
1686 @retval others Failed to Enable/Disable AP.
1690 EnableDisableApWorker (
1691 IN UINTN ProcessorNumber
,
1692 IN BOOLEAN EnableAP
,
1693 IN UINT32
*HealthFlag OPTIONAL
1696 CPU_MP_DATA
*CpuMpData
;
1699 CpuMpData
= GetCpuMpData ();
1702 // Check whether caller processor is BSP
1704 MpInitLibWhoAmI (&CallerNumber
);
1705 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1706 return EFI_DEVICE_ERROR
;
1709 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1710 return EFI_INVALID_PARAMETER
;
1713 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1714 return EFI_NOT_FOUND
;
1718 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateDisabled
);
1720 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateIdle
);
1723 if (HealthFlag
!= NULL
) {
1724 CpuMpData
->CpuData
[ProcessorNumber
].CpuHealthy
=
1725 (BOOLEAN
) ((*HealthFlag
& PROCESSOR_HEALTH_STATUS_BIT
) != 0);
1732 This return the handle number for the calling processor. This service may be
1733 called from the BSP and APs.
1735 @param[out] ProcessorNumber Pointer to the handle number of AP.
1736 The range is from 0 to the total number of
1737 logical processors minus 1. The total number of
1738 logical processors can be retrieved by
1739 MpInitLibGetNumberOfProcessors().
1741 @retval EFI_SUCCESS The current processor handle number was returned
1743 @retval EFI_INVALID_PARAMETER ProcessorNumber is NULL.
1744 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1750 OUT UINTN
*ProcessorNumber
1753 CPU_MP_DATA
*CpuMpData
;
1755 if (ProcessorNumber
== NULL
) {
1756 return EFI_INVALID_PARAMETER
;
1759 CpuMpData
= GetCpuMpData ();
1761 return GetProcessorNumber (CpuMpData
, ProcessorNumber
);
1765 Retrieves the number of logical processor in the platform and the number of
1766 those logical processors that are enabled on this boot. This service may only
1767 be called from the BSP.
1769 @param[out] NumberOfProcessors Pointer to the total number of logical
1770 processors in the system, including the BSP
1772 @param[out] NumberOfEnabledProcessors Pointer to the number of enabled logical
1773 processors that exist in system, including
1776 @retval EFI_SUCCESS The number of logical processors and enabled
1777 logical processors was retrieved.
1778 @retval EFI_DEVICE_ERROR The calling processor is an AP.
1779 @retval EFI_INVALID_PARAMETER NumberOfProcessors is NULL and NumberOfEnabledProcessors
1781 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1786 MpInitLibGetNumberOfProcessors (
1787 OUT UINTN
*NumberOfProcessors
, OPTIONAL
1788 OUT UINTN
*NumberOfEnabledProcessors OPTIONAL
1791 CPU_MP_DATA
*CpuMpData
;
1793 UINTN ProcessorNumber
;
1794 UINTN EnabledProcessorNumber
;
1797 CpuMpData
= GetCpuMpData ();
1799 if ((NumberOfProcessors
== NULL
) && (NumberOfEnabledProcessors
== NULL
)) {
1800 return EFI_INVALID_PARAMETER
;
1804 // Check whether caller processor is BSP
1806 MpInitLibWhoAmI (&CallerNumber
);
1807 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1808 return EFI_DEVICE_ERROR
;
1811 ProcessorNumber
= CpuMpData
->CpuCount
;
1812 EnabledProcessorNumber
= 0;
1813 for (Index
= 0; Index
< ProcessorNumber
; Index
++) {
1814 if (GetApState (&CpuMpData
->CpuData
[Index
]) != CpuStateDisabled
) {
1815 EnabledProcessorNumber
++;
1819 if (NumberOfProcessors
!= NULL
) {
1820 *NumberOfProcessors
= ProcessorNumber
;
1822 if (NumberOfEnabledProcessors
!= NULL
) {
1823 *NumberOfEnabledProcessors
= EnabledProcessorNumber
;
1831 Worker function to execute a caller provided function on all enabled APs.
1833 @param[in] Procedure A pointer to the function to be run on
1834 enabled APs of the system.
1835 @param[in] SingleThread If TRUE, then all the enabled APs execute
1836 the function specified by Procedure one by
1837 one, in ascending order of processor handle
1838 number. If FALSE, then all the enabled APs
1839 execute the function specified by Procedure
1841 @param[in] WaitEvent The event created by the caller with CreateEvent()
1843 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
1844 APs to return from Procedure, either for
1845 blocking or non-blocking mode.
1846 @param[in] ProcedureArgument The parameter passed into Procedure for
1848 @param[out] FailedCpuList If all APs finish successfully, then its
1849 content is set to NULL. If not all APs
1850 finish before timeout expires, then its
1851 content is set to address of the buffer
1852 holding handle numbers of the failed APs.
1854 @retval EFI_SUCCESS In blocking mode, all APs have finished before
1855 the timeout expired.
1856 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched
1858 @retval others Failed to Startup all APs.
1862 StartupAllAPsWorker (
1863 IN EFI_AP_PROCEDURE Procedure
,
1864 IN BOOLEAN SingleThread
,
1865 IN EFI_EVENT WaitEvent OPTIONAL
,
1866 IN UINTN TimeoutInMicroseconds
,
1867 IN VOID
*ProcedureArgument OPTIONAL
,
1868 OUT UINTN
**FailedCpuList OPTIONAL
1872 CPU_MP_DATA
*CpuMpData
;
1873 UINTN ProcessorCount
;
1874 UINTN ProcessorNumber
;
1876 CPU_AP_DATA
*CpuData
;
1877 BOOLEAN HasEnabledAp
;
1880 CpuMpData
= GetCpuMpData ();
1882 if (FailedCpuList
!= NULL
) {
1883 *FailedCpuList
= NULL
;
1886 if (CpuMpData
->CpuCount
== 1) {
1887 return EFI_NOT_STARTED
;
1890 if (Procedure
== NULL
) {
1891 return EFI_INVALID_PARAMETER
;
1895 // Check whether caller processor is BSP
1897 MpInitLibWhoAmI (&CallerNumber
);
1898 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1899 return EFI_DEVICE_ERROR
;
1905 CheckAndUpdateApsStatus ();
1907 ProcessorCount
= CpuMpData
->CpuCount
;
1908 HasEnabledAp
= FALSE
;
1910 // Check whether all enabled APs are idle.
1911 // If any enabled AP is not idle, return EFI_NOT_READY.
1913 for (ProcessorNumber
= 0; ProcessorNumber
< ProcessorCount
; ProcessorNumber
++) {
1914 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1915 if (ProcessorNumber
!= CpuMpData
->BspNumber
) {
1916 ApState
= GetApState (CpuData
);
1917 if (ApState
!= CpuStateDisabled
) {
1918 HasEnabledAp
= TRUE
;
1919 if (ApState
!= CpuStateIdle
) {
1921 // If any enabled APs are busy, return EFI_NOT_READY.
1923 return EFI_NOT_READY
;
1929 if (!HasEnabledAp
) {
1931 // If no enabled AP exists, return EFI_NOT_STARTED.
1933 return EFI_NOT_STARTED
;
1936 CpuMpData
->StartCount
= 0;
1937 for (ProcessorNumber
= 0; ProcessorNumber
< ProcessorCount
; ProcessorNumber
++) {
1938 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1939 CpuData
->Waiting
= FALSE
;
1940 if (ProcessorNumber
!= CpuMpData
->BspNumber
) {
1941 if (CpuData
->State
== CpuStateIdle
) {
1943 // Mark this processor as responsible for current calling.
1945 CpuData
->Waiting
= TRUE
;
1946 CpuMpData
->StartCount
++;
1951 CpuMpData
->Procedure
= Procedure
;
1952 CpuMpData
->ProcArguments
= ProcedureArgument
;
1953 CpuMpData
->SingleThread
= SingleThread
;
1954 CpuMpData
->FinishedCount
= 0;
1955 CpuMpData
->RunningCount
= 0;
1956 CpuMpData
->FailedCpuList
= FailedCpuList
;
1957 CpuMpData
->ExpectedTime
= CalculateTimeout (
1958 TimeoutInMicroseconds
,
1959 &CpuMpData
->CurrentTime
1961 CpuMpData
->TotalTime
= 0;
1962 CpuMpData
->WaitEvent
= WaitEvent
;
1964 if (!SingleThread
) {
1965 WakeUpAP (CpuMpData
, TRUE
, 0, Procedure
, ProcedureArgument
);
1967 for (ProcessorNumber
= 0; ProcessorNumber
< ProcessorCount
; ProcessorNumber
++) {
1968 if (ProcessorNumber
== CallerNumber
) {
1971 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1972 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, Procedure
, ProcedureArgument
);
1978 Status
= EFI_SUCCESS
;
1979 if (WaitEvent
== NULL
) {
1981 Status
= CheckAllAPs ();
1982 } while (Status
== EFI_NOT_READY
);
1989 Worker function to let the caller get one enabled AP to execute a caller-provided
1992 @param[in] Procedure A pointer to the function to be run on
1993 enabled APs of the system.
1994 @param[in] ProcessorNumber The handle number of the AP.
1995 @param[in] WaitEvent The event created by the caller with CreateEvent()
1997 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
1998 APs to return from Procedure, either for
1999 blocking or non-blocking mode.
2000 @param[in] ProcedureArgument The parameter passed into Procedure for
2002 @param[out] Finished If AP returns from Procedure before the
2003 timeout expires, its content is set to TRUE.
2004 Otherwise, the value is set to FALSE.
2006 @retval EFI_SUCCESS In blocking mode, specified AP finished before
2007 the timeout expires.
2008 @retval others Failed to Startup AP.
2012 StartupThisAPWorker (
2013 IN EFI_AP_PROCEDURE Procedure
,
2014 IN UINTN ProcessorNumber
,
2015 IN EFI_EVENT WaitEvent OPTIONAL
,
2016 IN UINTN TimeoutInMicroseconds
,
2017 IN VOID
*ProcedureArgument OPTIONAL
,
2018 OUT BOOLEAN
*Finished OPTIONAL
2022 CPU_MP_DATA
*CpuMpData
;
2023 CPU_AP_DATA
*CpuData
;
2026 CpuMpData
= GetCpuMpData ();
2028 if (Finished
!= NULL
) {
2033 // Check whether caller processor is BSP
2035 MpInitLibWhoAmI (&CallerNumber
);
2036 if (CallerNumber
!= CpuMpData
->BspNumber
) {
2037 return EFI_DEVICE_ERROR
;
2041 // Check whether processor with the handle specified by ProcessorNumber exists
2043 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
2044 return EFI_NOT_FOUND
;
2048 // Check whether specified processor is BSP
2050 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
2051 return EFI_INVALID_PARAMETER
;
2055 // Check parameter Procedure
2057 if (Procedure
== NULL
) {
2058 return EFI_INVALID_PARAMETER
;
2064 CheckAndUpdateApsStatus ();
2067 // Check whether specified AP is disabled
2069 if (GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]) == CpuStateDisabled
) {
2070 return EFI_INVALID_PARAMETER
;
2074 // If WaitEvent is not NULL, execute in non-blocking mode.
2075 // BSP saves data for CheckAPsStatus(), and returns EFI_SUCCESS.
2076 // CheckAPsStatus() will check completion and timeout periodically.
2078 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
2079 CpuData
->WaitEvent
= WaitEvent
;
2080 CpuData
->Finished
= Finished
;
2081 CpuData
->ExpectedTime
= CalculateTimeout (TimeoutInMicroseconds
, &CpuData
->CurrentTime
);
2082 CpuData
->TotalTime
= 0;
2084 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, Procedure
, ProcedureArgument
);
2087 // If WaitEvent is NULL, execute in blocking mode.
2088 // BSP checks AP's state until it finishes or TimeoutInMicrosecsond expires.
2090 Status
= EFI_SUCCESS
;
2091 if (WaitEvent
== NULL
) {
2093 Status
= CheckThisAP (ProcessorNumber
);
2094 } while (Status
== EFI_NOT_READY
);
2101 Get pointer to CPU MP Data structure from GUIDed HOB.
2103 @return The pointer to CPU MP Data structure.
2106 GetCpuMpDataFromGuidedHob (
2110 EFI_HOB_GUID_TYPE
*GuidHob
;
2112 CPU_MP_DATA
*CpuMpData
;
2115 GuidHob
= GetFirstGuidHob (&mCpuInitMpLibHobGuid
);
2116 if (GuidHob
!= NULL
) {
2117 DataInHob
= GET_GUID_HOB_DATA (GuidHob
);
2118 CpuMpData
= (CPU_MP_DATA
*) (*(UINTN
*) DataInHob
);
2124 Get available system memory below 1MB by specified size.
2126 @param[in] CpuMpData The pointer to CPU MP Data structure.
2129 BackupAndPrepareWakeupBuffer(
2130 IN CPU_MP_DATA
*CpuMpData
2134 (VOID
*) CpuMpData
->BackupBuffer
,
2135 (VOID
*) CpuMpData
->WakeupBuffer
,
2136 CpuMpData
->BackupBufferSize
2139 (VOID
*) CpuMpData
->WakeupBuffer
,
2140 (VOID
*) CpuMpData
->AddressMap
.RendezvousFunnelAddress
,
2141 CpuMpData
->AddressMap
.RendezvousFunnelSize
2146 Restore wakeup buffer data.
2148 @param[in] CpuMpData The pointer to CPU MP Data structure.
2151 RestoreWakeupBuffer(
2152 IN CPU_MP_DATA
*CpuMpData
2156 (VOID
*) CpuMpData
->WakeupBuffer
,
2157 (VOID
*) CpuMpData
->BackupBuffer
,
2158 CpuMpData
->BackupBufferSize