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
,
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
= ApIndex
;
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
);
665 InterlockedDecrement ((UINT32
*) &CpuMpData
->MpCpuExchangeInfo
->NumApsExecuting
);
668 // Place AP is specified loop mode
670 if (CpuMpData
->ApLoopMode
== ApInHltLoop
) {
672 // Save AP volatile registers
674 SaveVolatileRegisters (&CpuMpData
->CpuData
[ProcessorNumber
].VolatileRegisters
);
676 // Place AP in HLT-loop
679 DisableInterrupts ();
685 DisableInterrupts ();
686 if (CpuMpData
->ApLoopMode
== ApInMwaitLoop
) {
688 // Place AP in MWAIT-loop
690 AsmMonitor ((UINTN
) ApStartupSignalBuffer
, 0, 0);
691 if (*ApStartupSignalBuffer
!= WAKEUP_AP_SIGNAL
) {
693 // Check AP start-up signal again.
694 // If AP start-up signal is not set, place AP into
695 // the specified C-state
697 AsmMwait (CpuMpData
->ApTargetCState
<< 4, 0);
699 } else if (CpuMpData
->ApLoopMode
== ApInRunLoop
) {
701 // Place AP in Run-loop
709 // If AP start-up signal is written, AP is waken up
710 // otherwise place AP in loop again
712 if (*ApStartupSignalBuffer
== WAKEUP_AP_SIGNAL
) {
720 Wait for AP wakeup and write AP start-up signal till AP is waken up.
722 @param[in] ApStartupSignalBuffer Pointer to AP wakeup signal
726 IN
volatile UINT32
*ApStartupSignalBuffer
730 // If AP is waken up, StartupApSignal should be cleared.
731 // Otherwise, write StartupApSignal again till AP waken up.
733 while (InterlockedCompareExchange32 (
734 (UINT32
*) ApStartupSignalBuffer
,
743 This function will fill the exchange info structure.
745 @param[in] CpuMpData Pointer to CPU MP Data
749 FillExchangeInfoData (
750 IN CPU_MP_DATA
*CpuMpData
753 volatile MP_CPU_EXCHANGE_INFO
*ExchangeInfo
;
755 ExchangeInfo
= CpuMpData
->MpCpuExchangeInfo
;
756 ExchangeInfo
->Lock
= 0;
757 ExchangeInfo
->StackStart
= CpuMpData
->Buffer
;
758 ExchangeInfo
->StackSize
= CpuMpData
->CpuApStackSize
;
759 ExchangeInfo
->BufferStart
= CpuMpData
->WakeupBuffer
;
760 ExchangeInfo
->ModeOffset
= CpuMpData
->AddressMap
.ModeEntryOffset
;
762 ExchangeInfo
->CodeSegment
= AsmReadCs ();
763 ExchangeInfo
->DataSegment
= AsmReadDs ();
765 ExchangeInfo
->Cr3
= AsmReadCr3 ();
767 ExchangeInfo
->CFunction
= (UINTN
) ApWakeupFunction
;
768 ExchangeInfo
->ApIndex
= 0;
769 ExchangeInfo
->NumApsExecuting
= 0;
770 ExchangeInfo
->InitFlag
= (UINTN
) CpuMpData
->InitFlag
;
771 ExchangeInfo
->CpuInfo
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
772 ExchangeInfo
->CpuMpData
= CpuMpData
;
774 ExchangeInfo
->EnableExecuteDisable
= IsBspExecuteDisableEnabled ();
776 ExchangeInfo
->InitializeFloatingPointUnitsAddress
= (UINTN
)InitializeFloatingPointUnits
;
779 // Get the BSP's data of GDT and IDT
781 AsmReadGdtr ((IA32_DESCRIPTOR
*) &ExchangeInfo
->GdtrProfile
);
782 AsmReadIdtr ((IA32_DESCRIPTOR
*) &ExchangeInfo
->IdtrProfile
);
786 Helper function that waits until the finished AP count reaches the specified
787 limit, or the specified timeout elapses (whichever comes first).
789 @param[in] CpuMpData Pointer to CPU MP Data.
790 @param[in] FinishedApLimit The number of finished APs to wait for.
791 @param[in] TimeLimit The number of microseconds to wait for.
794 TimedWaitForApFinish (
795 IN CPU_MP_DATA
*CpuMpData
,
796 IN UINT32 FinishedApLimit
,
801 Get available system memory below 1MB by specified size.
803 @param[in] CpuMpData The pointer to CPU MP Data structure.
806 BackupAndPrepareWakeupBuffer(
807 IN CPU_MP_DATA
*CpuMpData
811 (VOID
*) CpuMpData
->BackupBuffer
,
812 (VOID
*) CpuMpData
->WakeupBuffer
,
813 CpuMpData
->BackupBufferSize
816 (VOID
*) CpuMpData
->WakeupBuffer
,
817 (VOID
*) CpuMpData
->AddressMap
.RendezvousFunnelAddress
,
818 CpuMpData
->AddressMap
.RendezvousFunnelSize
823 Restore wakeup buffer data.
825 @param[in] CpuMpData The pointer to CPU MP Data structure.
829 IN CPU_MP_DATA
*CpuMpData
833 (VOID
*) CpuMpData
->WakeupBuffer
,
834 (VOID
*) CpuMpData
->BackupBuffer
,
835 CpuMpData
->BackupBufferSize
840 Allocate reset vector buffer.
842 @param[in, out] CpuMpData The pointer to CPU MP Data structure.
845 AllocateResetVector (
846 IN OUT CPU_MP_DATA
*CpuMpData
849 UINTN ApResetVectorSize
;
851 if (CpuMpData
->WakeupBuffer
== (UINTN
) -1) {
852 ApResetVectorSize
= CpuMpData
->AddressMap
.RendezvousFunnelSize
+
853 sizeof (MP_CPU_EXCHANGE_INFO
);
855 CpuMpData
->WakeupBuffer
= GetWakeupBuffer (ApResetVectorSize
);
856 CpuMpData
->MpCpuExchangeInfo
= (MP_CPU_EXCHANGE_INFO
*) (UINTN
)
857 (CpuMpData
->WakeupBuffer
+ CpuMpData
->AddressMap
.RendezvousFunnelSize
);
859 BackupAndPrepareWakeupBuffer (CpuMpData
);
863 Free AP reset vector buffer.
865 @param[in] CpuMpData The pointer to CPU MP Data structure.
869 IN CPU_MP_DATA
*CpuMpData
872 RestoreWakeupBuffer (CpuMpData
);
876 This function will be called by BSP to wakeup AP.
878 @param[in] CpuMpData Pointer to CPU MP Data
879 @param[in] Broadcast TRUE: Send broadcast IPI to all APs
880 FALSE: Send IPI to AP by ApicId
881 @param[in] ProcessorNumber The handle number of specified processor
882 @param[in] Procedure The function to be invoked by AP
883 @param[in] ProcedureArgument The argument to be passed into AP function
887 IN CPU_MP_DATA
*CpuMpData
,
888 IN BOOLEAN Broadcast
,
889 IN UINTN ProcessorNumber
,
890 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
891 IN VOID
*ProcedureArgument OPTIONAL
894 volatile MP_CPU_EXCHANGE_INFO
*ExchangeInfo
;
896 CPU_AP_DATA
*CpuData
;
897 BOOLEAN ResetVectorRequired
;
898 CPU_INFO_IN_HOB
*CpuInfoInHob
;
900 CpuMpData
->FinishedCount
= 0;
901 ResetVectorRequired
= FALSE
;
903 if (CpuMpData
->ApLoopMode
== ApInHltLoop
||
904 CpuMpData
->InitFlag
!= ApInitDone
) {
905 ResetVectorRequired
= TRUE
;
906 AllocateResetVector (CpuMpData
);
907 FillExchangeInfoData (CpuMpData
);
908 SaveLocalApicTimerSetting (CpuMpData
);
909 } else if (CpuMpData
->ApLoopMode
== ApInMwaitLoop
) {
911 // Get AP target C-state each time when waking up AP,
912 // for it maybe updated by platform again
914 CpuMpData
->ApTargetCState
= PcdGet8 (PcdCpuApTargetCstate
);
917 ExchangeInfo
= CpuMpData
->MpCpuExchangeInfo
;
920 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
921 if (Index
!= CpuMpData
->BspNumber
) {
922 CpuData
= &CpuMpData
->CpuData
[Index
];
923 CpuData
->ApFunction
= (UINTN
) Procedure
;
924 CpuData
->ApFunctionArgument
= (UINTN
) ProcedureArgument
;
925 SetApState (CpuData
, CpuStateReady
);
926 if (CpuMpData
->InitFlag
!= ApInitConfig
) {
927 *(UINT32
*) CpuData
->StartupApSignal
= WAKEUP_AP_SIGNAL
;
931 if (ResetVectorRequired
) {
935 SendInitSipiSipiAllExcludingSelf ((UINT32
) ExchangeInfo
->BufferStart
);
937 if (CpuMpData
->InitFlag
== ApInitConfig
) {
939 // Wait for one potential AP waken up in one specified period
941 if (CpuMpData
->CpuCount
== 0) {
942 TimedWaitForApFinish (
944 PcdGet32 (PcdCpuMaxLogicalProcessorNumber
) - 1,
945 PcdGet32 (PcdCpuApInitTimeOutInMicroSeconds
)
949 while (CpuMpData
->MpCpuExchangeInfo
->NumApsExecuting
!= 0) {
954 // Wait all APs waken up if this is not the 1st broadcast of SIPI
956 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
957 CpuData
= &CpuMpData
->CpuData
[Index
];
958 if (Index
!= CpuMpData
->BspNumber
) {
959 WaitApWakeup (CpuData
->StartupApSignal
);
964 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
965 CpuData
->ApFunction
= (UINTN
) Procedure
;
966 CpuData
->ApFunctionArgument
= (UINTN
) ProcedureArgument
;
967 SetApState (CpuData
, CpuStateReady
);
969 // Wakeup specified AP
971 ASSERT (CpuMpData
->InitFlag
!= ApInitConfig
);
972 *(UINT32
*) CpuData
->StartupApSignal
= WAKEUP_AP_SIGNAL
;
973 if (ResetVectorRequired
) {
974 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
976 CpuInfoInHob
[ProcessorNumber
].ApicId
,
977 (UINT32
) ExchangeInfo
->BufferStart
981 // Wait specified AP waken up
983 WaitApWakeup (CpuData
->StartupApSignal
);
986 if (ResetVectorRequired
) {
987 FreeResetVector (CpuMpData
);
992 Calculate timeout value and return the current performance counter value.
994 Calculate the number of performance counter ticks required for a timeout.
995 If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
998 @param[in] TimeoutInMicroseconds Timeout value in microseconds.
999 @param[out] CurrentTime Returns the current value of the performance counter.
1001 @return Expected time stamp counter for timeout.
1002 If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
1008 IN UINTN TimeoutInMicroseconds
,
1009 OUT UINT64
*CurrentTime
1012 UINT64 TimeoutInSeconds
;
1013 UINT64 TimestampCounterFreq
;
1016 // Read the current value of the performance counter
1018 *CurrentTime
= GetPerformanceCounter ();
1021 // If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
1024 if (TimeoutInMicroseconds
== 0) {
1029 // GetPerformanceCounterProperties () returns the timestamp counter's frequency
1032 TimestampCounterFreq
= GetPerformanceCounterProperties (NULL
, NULL
);
1035 // Check the potential overflow before calculate the number of ticks for the timeout value.
1037 if (DivU64x64Remainder (MAX_UINT64
, TimeoutInMicroseconds
, NULL
) < TimestampCounterFreq
) {
1039 // Convert microseconds into seconds if direct multiplication overflows
1041 TimeoutInSeconds
= DivU64x32 (TimeoutInMicroseconds
, 1000000);
1043 // Assertion if the final tick count exceeds MAX_UINT64
1045 ASSERT (DivU64x64Remainder (MAX_UINT64
, TimeoutInSeconds
, NULL
) >= TimestampCounterFreq
);
1046 return MultU64x64 (TimestampCounterFreq
, TimeoutInSeconds
);
1049 // No overflow case, multiply the return value with TimeoutInMicroseconds and then divide
1050 // it by 1,000,000, to get the number of ticks for the timeout value.
1054 TimestampCounterFreq
,
1055 TimeoutInMicroseconds
1063 Checks whether timeout expires.
1065 Check whether the number of elapsed performance counter ticks required for
1066 a timeout condition has been reached.
1067 If Timeout is zero, which means infinity, return value is always FALSE.
1069 @param[in, out] PreviousTime On input, the value of the performance counter
1070 when it was last read.
1071 On output, the current value of the performance
1073 @param[in] TotalTime The total amount of elapsed time in performance
1075 @param[in] Timeout The number of performance counter ticks required
1076 to reach a timeout condition.
1078 @retval TRUE A timeout condition has been reached.
1079 @retval FALSE A timeout condition has not been reached.
1084 IN OUT UINT64
*PreviousTime
,
1085 IN UINT64
*TotalTime
,
1098 GetPerformanceCounterProperties (&Start
, &End
);
1099 Cycle
= End
- Start
;
1104 CurrentTime
= GetPerformanceCounter();
1105 Delta
= (INT64
) (CurrentTime
- *PreviousTime
);
1112 *TotalTime
+= Delta
;
1113 *PreviousTime
= CurrentTime
;
1114 if (*TotalTime
> Timeout
) {
1121 Helper function that waits until the finished AP count reaches the specified
1122 limit, or the specified timeout elapses (whichever comes first).
1124 @param[in] CpuMpData Pointer to CPU MP Data.
1125 @param[in] FinishedApLimit The number of finished APs to wait for.
1126 @param[in] TimeLimit The number of microseconds to wait for.
1129 TimedWaitForApFinish (
1130 IN CPU_MP_DATA
*CpuMpData
,
1131 IN UINT32 FinishedApLimit
,
1136 // CalculateTimeout() and CheckTimeout() consider a TimeLimit of 0
1137 // "infinity", so check for (TimeLimit == 0) explicitly.
1139 if (TimeLimit
== 0) {
1143 CpuMpData
->TotalTime
= 0;
1144 CpuMpData
->ExpectedTime
= CalculateTimeout (
1146 &CpuMpData
->CurrentTime
1148 while (CpuMpData
->FinishedCount
< FinishedApLimit
&&
1150 &CpuMpData
->CurrentTime
,
1151 &CpuMpData
->TotalTime
,
1152 CpuMpData
->ExpectedTime
1157 if (CpuMpData
->FinishedCount
>= FinishedApLimit
) {
1160 "%a: reached FinishedApLimit=%u in %Lu microseconds\n",
1163 DivU64x64Remainder (
1164 MultU64x32 (CpuMpData
->TotalTime
, 1000000),
1165 GetPerformanceCounterProperties (NULL
, NULL
),
1173 Reset an AP to Idle state.
1175 Any task being executed by the AP will be aborted and the AP
1176 will be waiting for a new task in Wait-For-SIPI state.
1178 @param[in] ProcessorNumber The handle number of processor.
1181 ResetProcessorToIdleState (
1182 IN UINTN ProcessorNumber
1185 CPU_MP_DATA
*CpuMpData
;
1187 CpuMpData
= GetCpuMpData ();
1189 CpuMpData
->InitFlag
= ApInitReconfig
;
1190 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, NULL
, NULL
);
1191 while (CpuMpData
->FinishedCount
< 1) {
1194 CpuMpData
->InitFlag
= ApInitDone
;
1196 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateIdle
);
1200 Searches for the next waiting AP.
1202 Search for the next AP that is put in waiting state by single-threaded StartupAllAPs().
1204 @param[out] NextProcessorNumber Pointer to the processor number of the next waiting AP.
1206 @retval EFI_SUCCESS The next waiting AP has been found.
1207 @retval EFI_NOT_FOUND No waiting AP exists.
1211 GetNextWaitingProcessorNumber (
1212 OUT UINTN
*NextProcessorNumber
1215 UINTN ProcessorNumber
;
1216 CPU_MP_DATA
*CpuMpData
;
1218 CpuMpData
= GetCpuMpData ();
1220 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
1221 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1222 *NextProcessorNumber
= ProcessorNumber
;
1227 return EFI_NOT_FOUND
;
1230 /** Checks status of specified AP.
1232 This function checks whether the specified AP has finished the task assigned
1233 by StartupThisAP(), and whether timeout expires.
1235 @param[in] ProcessorNumber The handle number of processor.
1237 @retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().
1238 @retval EFI_TIMEOUT The timeout expires.
1239 @retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.
1243 IN UINTN ProcessorNumber
1246 CPU_MP_DATA
*CpuMpData
;
1247 CPU_AP_DATA
*CpuData
;
1249 CpuMpData
= GetCpuMpData ();
1250 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1253 // Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.
1254 // Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the
1255 // value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.
1258 // If the AP finishes for StartupThisAP(), return EFI_SUCCESS.
1260 if (GetApState(CpuData
) == CpuStateFinished
) {
1261 if (CpuData
->Finished
!= NULL
) {
1262 *(CpuData
->Finished
) = TRUE
;
1264 SetApState (CpuData
, CpuStateIdle
);
1268 // If timeout expires for StartupThisAP(), report timeout.
1270 if (CheckTimeout (&CpuData
->CurrentTime
, &CpuData
->TotalTime
, CpuData
->ExpectedTime
)) {
1271 if (CpuData
->Finished
!= NULL
) {
1272 *(CpuData
->Finished
) = FALSE
;
1275 // Reset failed AP to idle state
1277 ResetProcessorToIdleState (ProcessorNumber
);
1282 return EFI_NOT_READY
;
1286 Checks status of all APs.
1288 This function checks whether all APs have finished task assigned by StartupAllAPs(),
1289 and whether timeout expires.
1291 @retval EFI_SUCCESS All APs have finished task assigned by StartupAllAPs().
1292 @retval EFI_TIMEOUT The timeout expires.
1293 @retval EFI_NOT_READY APs have not finished task and timeout has not expired.
1300 UINTN ProcessorNumber
;
1301 UINTN NextProcessorNumber
;
1304 CPU_MP_DATA
*CpuMpData
;
1305 CPU_AP_DATA
*CpuData
;
1307 CpuMpData
= GetCpuMpData ();
1309 NextProcessorNumber
= 0;
1312 // Go through all APs that are responsible for the StartupAllAPs().
1314 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
1315 if (!CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1319 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1321 // Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.
1322 // Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the
1323 // value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.
1325 if (GetApState(CpuData
) == CpuStateFinished
) {
1326 CpuMpData
->RunningCount
++;
1327 CpuMpData
->CpuData
[ProcessorNumber
].Waiting
= FALSE
;
1328 SetApState(CpuData
, CpuStateIdle
);
1331 // If in Single Thread mode, then search for the next waiting AP for execution.
1333 if (CpuMpData
->SingleThread
) {
1334 Status
= GetNextWaitingProcessorNumber (&NextProcessorNumber
);
1336 if (!EFI_ERROR (Status
)) {
1340 (UINT32
) NextProcessorNumber
,
1341 CpuMpData
->Procedure
,
1342 CpuMpData
->ProcArguments
1350 // If all APs finish, return EFI_SUCCESS.
1352 if (CpuMpData
->RunningCount
== CpuMpData
->StartCount
) {
1357 // If timeout expires, report timeout.
1360 &CpuMpData
->CurrentTime
,
1361 &CpuMpData
->TotalTime
,
1362 CpuMpData
->ExpectedTime
)
1365 // If FailedCpuList is not NULL, record all failed APs in it.
1367 if (CpuMpData
->FailedCpuList
!= NULL
) {
1368 *CpuMpData
->FailedCpuList
=
1369 AllocatePool ((CpuMpData
->StartCount
- CpuMpData
->FinishedCount
+ 1) * sizeof (UINTN
));
1370 ASSERT (*CpuMpData
->FailedCpuList
!= NULL
);
1374 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
1376 // Check whether this processor is responsible for StartupAllAPs().
1378 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1380 // Reset failed APs to idle state
1382 ResetProcessorToIdleState (ProcessorNumber
);
1383 CpuMpData
->CpuData
[ProcessorNumber
].Waiting
= FALSE
;
1384 if (CpuMpData
->FailedCpuList
!= NULL
) {
1385 (*CpuMpData
->FailedCpuList
)[ListIndex
++] = ProcessorNumber
;
1389 if (CpuMpData
->FailedCpuList
!= NULL
) {
1390 (*CpuMpData
->FailedCpuList
)[ListIndex
] = END_OF_CPU_LIST
;
1394 return EFI_NOT_READY
;
1398 MP Initialize Library initialization.
1400 This service will allocate AP reset vector and wakeup all APs to do APs
1403 This service must be invoked before all other MP Initialize Library
1404 service are invoked.
1406 @retval EFI_SUCCESS MP initialization succeeds.
1407 @retval Others MP initialization fails.
1412 MpInitLibInitialize (
1416 CPU_MP_DATA
*OldCpuMpData
;
1417 CPU_INFO_IN_HOB
*CpuInfoInHob
;
1418 UINT32 MaxLogicalProcessorNumber
;
1420 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
1422 UINT32 MonitorFilterSize
;
1425 CPU_MP_DATA
*CpuMpData
;
1427 UINT8
*MonitorBuffer
;
1429 UINTN ApResetVectorSize
;
1430 UINTN BackupBufferAddr
;
1432 OldCpuMpData
= GetCpuMpDataFromGuidedHob ();
1433 if (OldCpuMpData
== NULL
) {
1434 MaxLogicalProcessorNumber
= PcdGet32(PcdCpuMaxLogicalProcessorNumber
);
1436 MaxLogicalProcessorNumber
= OldCpuMpData
->CpuCount
;
1438 ASSERT (MaxLogicalProcessorNumber
!= 0);
1440 AsmGetAddressMap (&AddressMap
);
1441 ApResetVectorSize
= AddressMap
.RendezvousFunnelSize
+ sizeof (MP_CPU_EXCHANGE_INFO
);
1442 ApStackSize
= PcdGet32(PcdCpuApStackSize
);
1443 ApLoopMode
= GetApLoopMode (&MonitorFilterSize
);
1445 BufferSize
= ApStackSize
* MaxLogicalProcessorNumber
;
1446 BufferSize
+= MonitorFilterSize
* MaxLogicalProcessorNumber
;
1447 BufferSize
+= sizeof (CPU_MP_DATA
);
1448 BufferSize
+= ApResetVectorSize
;
1449 BufferSize
+= (sizeof (CPU_AP_DATA
) + sizeof (CPU_INFO_IN_HOB
))* MaxLogicalProcessorNumber
;
1450 MpBuffer
= AllocatePages (EFI_SIZE_TO_PAGES (BufferSize
));
1451 ASSERT (MpBuffer
!= NULL
);
1452 ZeroMem (MpBuffer
, BufferSize
);
1453 Buffer
= (UINTN
) MpBuffer
;
1455 MonitorBuffer
= (UINT8
*) (Buffer
+ ApStackSize
* MaxLogicalProcessorNumber
);
1456 BackupBufferAddr
= (UINTN
) MonitorBuffer
+ MonitorFilterSize
* MaxLogicalProcessorNumber
;
1457 CpuMpData
= (CPU_MP_DATA
*) (BackupBufferAddr
+ ApResetVectorSize
);
1458 CpuMpData
->Buffer
= Buffer
;
1459 CpuMpData
->CpuApStackSize
= ApStackSize
;
1460 CpuMpData
->BackupBuffer
= BackupBufferAddr
;
1461 CpuMpData
->BackupBufferSize
= ApResetVectorSize
;
1462 CpuMpData
->WakeupBuffer
= (UINTN
) -1;
1463 CpuMpData
->CpuCount
= 1;
1464 CpuMpData
->BspNumber
= 0;
1465 CpuMpData
->WaitEvent
= NULL
;
1466 CpuMpData
->SwitchBspFlag
= FALSE
;
1467 CpuMpData
->CpuData
= (CPU_AP_DATA
*) (CpuMpData
+ 1);
1468 CpuMpData
->CpuInfoInHob
= (UINT64
) (UINTN
) (CpuMpData
->CpuData
+ MaxLogicalProcessorNumber
);
1469 CpuMpData
->MicrocodePatchAddress
= PcdGet64 (PcdCpuMicrocodePatchAddress
);
1470 CpuMpData
->MicrocodePatchRegionSize
= PcdGet64 (PcdCpuMicrocodePatchRegionSize
);
1471 InitializeSpinLock(&CpuMpData
->MpLock
);
1473 // Save BSP's Control registers to APs
1475 SaveVolatileRegisters (&CpuMpData
->CpuData
[0].VolatileRegisters
);
1477 // Set BSP basic information
1479 InitializeApData (CpuMpData
, 0, 0, CpuMpData
->Buffer
);
1481 // Save assembly code information
1483 CopyMem (&CpuMpData
->AddressMap
, &AddressMap
, sizeof (MP_ASSEMBLY_ADDRESS_MAP
));
1485 // Finally set AP loop mode
1487 CpuMpData
->ApLoopMode
= ApLoopMode
;
1488 DEBUG ((DEBUG_INFO
, "AP Loop Mode is %d\n", CpuMpData
->ApLoopMode
));
1490 // Set up APs wakeup signal buffer
1492 for (Index
= 0; Index
< MaxLogicalProcessorNumber
; Index
++) {
1493 CpuMpData
->CpuData
[Index
].StartupApSignal
=
1494 (UINT32
*)(MonitorBuffer
+ MonitorFilterSize
* Index
);
1497 // Load Microcode on BSP
1499 MicrocodeDetect (CpuMpData
);
1501 // Store BSP's MTRR setting
1503 MtrrGetAllMtrrs (&CpuMpData
->MtrrTable
);
1505 // Enable the local APIC for Virtual Wire Mode.
1507 ProgramVirtualWireMode ();
1509 if (OldCpuMpData
== NULL
) {
1510 if (MaxLogicalProcessorNumber
> 1) {
1512 // Wakeup all APs and calculate the processor count in system
1514 CollectProcessorCount (CpuMpData
);
1518 // APs have been wakeup before, just get the CPU Information
1521 CpuMpData
->CpuCount
= OldCpuMpData
->CpuCount
;
1522 CpuMpData
->BspNumber
= OldCpuMpData
->BspNumber
;
1523 CpuMpData
->InitFlag
= ApInitReconfig
;
1524 CpuMpData
->CpuInfoInHob
= OldCpuMpData
->CpuInfoInHob
;
1525 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
1526 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
1527 InitializeSpinLock(&CpuMpData
->CpuData
[Index
].ApLock
);
1528 if (CpuInfoInHob
[Index
].InitialApicId
>= 255 || Index
> 254) {
1529 CpuMpData
->X2ApicEnable
= TRUE
;
1531 CpuMpData
->CpuData
[Index
].CpuHealthy
= (CpuInfoInHob
[Index
].Health
== 0)? TRUE
:FALSE
;
1532 CpuMpData
->CpuData
[Index
].ApFunction
= 0;
1534 &CpuMpData
->CpuData
[Index
].VolatileRegisters
,
1535 &CpuMpData
->CpuData
[0].VolatileRegisters
,
1536 sizeof (CPU_VOLATILE_REGISTERS
)
1539 if (MaxLogicalProcessorNumber
> 1) {
1541 // Wakeup APs to do some AP initialize sync
1543 WakeUpAP (CpuMpData
, TRUE
, 0, ApInitializeSync
, CpuMpData
);
1545 // Wait for all APs finished initialization
1547 while (CpuMpData
->FinishedCount
< (CpuMpData
->CpuCount
- 1)) {
1550 CpuMpData
->InitFlag
= ApInitDone
;
1551 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
1552 SetApState (&CpuMpData
->CpuData
[Index
], CpuStateIdle
);
1558 // Initialize global data for MP support
1560 InitMpGlobalData (CpuMpData
);
1566 Gets detailed MP-related information on the requested processor at the
1567 instant this call is made. This service may only be called from the BSP.
1569 @param[in] ProcessorNumber The handle number of processor.
1570 @param[out] ProcessorInfoBuffer A pointer to the buffer where information for
1571 the requested processor is deposited.
1572 @param[out] HealthData Return processor health data.
1574 @retval EFI_SUCCESS Processor information was returned.
1575 @retval EFI_DEVICE_ERROR The calling processor is an AP.
1576 @retval EFI_INVALID_PARAMETER ProcessorInfoBuffer is NULL.
1577 @retval EFI_NOT_FOUND The processor with the handle specified by
1578 ProcessorNumber does not exist in the platform.
1579 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1584 MpInitLibGetProcessorInfo (
1585 IN UINTN ProcessorNumber
,
1586 OUT EFI_PROCESSOR_INFORMATION
*ProcessorInfoBuffer
,
1587 OUT EFI_HEALTH_FLAGS
*HealthData OPTIONAL
1590 CPU_MP_DATA
*CpuMpData
;
1592 CPU_INFO_IN_HOB
*CpuInfoInHob
;
1594 CpuMpData
= GetCpuMpData ();
1595 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
1598 // Check whether caller processor is BSP
1600 MpInitLibWhoAmI (&CallerNumber
);
1601 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1602 return EFI_DEVICE_ERROR
;
1605 if (ProcessorInfoBuffer
== NULL
) {
1606 return EFI_INVALID_PARAMETER
;
1609 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1610 return EFI_NOT_FOUND
;
1613 ProcessorInfoBuffer
->ProcessorId
= (UINT64
) CpuInfoInHob
[ProcessorNumber
].ApicId
;
1614 ProcessorInfoBuffer
->StatusFlag
= 0;
1615 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1616 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_AS_BSP_BIT
;
1618 if (CpuMpData
->CpuData
[ProcessorNumber
].CpuHealthy
) {
1619 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_HEALTH_STATUS_BIT
;
1621 if (GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]) == CpuStateDisabled
) {
1622 ProcessorInfoBuffer
->StatusFlag
&= ~PROCESSOR_ENABLED_BIT
;
1624 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_ENABLED_BIT
;
1628 // Get processor location information
1630 GetProcessorLocationByApicId (
1631 CpuInfoInHob
[ProcessorNumber
].ApicId
,
1632 &ProcessorInfoBuffer
->Location
.Package
,
1633 &ProcessorInfoBuffer
->Location
.Core
,
1634 &ProcessorInfoBuffer
->Location
.Thread
1637 if (HealthData
!= NULL
) {
1638 HealthData
->Uint32
= CpuInfoInHob
[ProcessorNumber
].Health
;
1645 Worker function to switch the requested AP to be the BSP from that point onward.
1647 @param[in] ProcessorNumber The handle number of AP that is to become the new BSP.
1648 @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an
1649 enabled AP. Otherwise, it will be disabled.
1651 @retval EFI_SUCCESS BSP successfully switched.
1652 @retval others Failed to switch BSP.
1657 IN UINTN ProcessorNumber
,
1658 IN BOOLEAN EnableOldBSP
1661 CPU_MP_DATA
*CpuMpData
;
1664 MSR_IA32_APIC_BASE_REGISTER ApicBaseMsr
;
1665 BOOLEAN OldInterruptState
;
1666 BOOLEAN OldTimerInterruptState
;
1669 // Save and Disable Local APIC timer interrupt
1671 OldTimerInterruptState
= GetApicTimerInterruptState ();
1672 DisableApicTimerInterrupt ();
1674 // Before send both BSP and AP to a procedure to exchange their roles,
1675 // interrupt must be disabled. This is because during the exchange role
1676 // process, 2 CPU may use 1 stack. If interrupt happens, the stack will
1677 // be corrupted, since interrupt return address will be pushed to stack
1680 OldInterruptState
= SaveAndDisableInterrupts ();
1683 // Mask LINT0 & LINT1 for the old BSP
1685 DisableLvtInterrupts ();
1687 CpuMpData
= GetCpuMpData ();
1690 // Check whether caller processor is BSP
1692 MpInitLibWhoAmI (&CallerNumber
);
1693 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1694 return EFI_DEVICE_ERROR
;
1697 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1698 return EFI_NOT_FOUND
;
1702 // Check whether specified AP is disabled
1704 State
= GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]);
1705 if (State
== CpuStateDisabled
) {
1706 return EFI_INVALID_PARAMETER
;
1710 // Check whether ProcessorNumber specifies the current BSP
1712 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1713 return EFI_INVALID_PARAMETER
;
1717 // Check whether specified AP is busy
1719 if (State
== CpuStateBusy
) {
1720 return EFI_NOT_READY
;
1723 CpuMpData
->BSPInfo
.State
= CPU_SWITCH_STATE_IDLE
;
1724 CpuMpData
->APInfo
.State
= CPU_SWITCH_STATE_IDLE
;
1725 CpuMpData
->SwitchBspFlag
= TRUE
;
1726 CpuMpData
->NewBspNumber
= ProcessorNumber
;
1729 // Clear the BSP bit of MSR_IA32_APIC_BASE
1731 ApicBaseMsr
.Uint64
= AsmReadMsr64 (MSR_IA32_APIC_BASE
);
1732 ApicBaseMsr
.Bits
.BSP
= 0;
1733 AsmWriteMsr64 (MSR_IA32_APIC_BASE
, ApicBaseMsr
.Uint64
);
1736 // Need to wakeUp AP (future BSP).
1738 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, FutureBSPProc
, CpuMpData
);
1740 AsmExchangeRole (&CpuMpData
->BSPInfo
, &CpuMpData
->APInfo
);
1743 // Set the BSP bit of MSR_IA32_APIC_BASE on new BSP
1745 ApicBaseMsr
.Uint64
= AsmReadMsr64 (MSR_IA32_APIC_BASE
);
1746 ApicBaseMsr
.Bits
.BSP
= 1;
1747 AsmWriteMsr64 (MSR_IA32_APIC_BASE
, ApicBaseMsr
.Uint64
);
1750 // Wait for old BSP finished AP task
1752 while (GetApState (&CpuMpData
->CpuData
[CallerNumber
]) != CpuStateFinished
) {
1756 CpuMpData
->SwitchBspFlag
= FALSE
;
1758 // Set old BSP enable state
1760 if (!EnableOldBSP
) {
1761 SetApState (&CpuMpData
->CpuData
[CallerNumber
], CpuStateDisabled
);
1763 SetApState (&CpuMpData
->CpuData
[CallerNumber
], CpuStateIdle
);
1766 // Save new BSP number
1768 CpuMpData
->BspNumber
= (UINT32
) ProcessorNumber
;
1771 // Restore interrupt state.
1773 SetInterruptState (OldInterruptState
);
1775 if (OldTimerInterruptState
) {
1776 EnableApicTimerInterrupt ();
1783 Worker function to let the caller enable or disable an AP from this point onward.
1784 This service may only be called from the BSP.
1786 @param[in] ProcessorNumber The handle number of AP.
1787 @param[in] EnableAP Specifies the new state for the processor for
1788 enabled, FALSE for disabled.
1789 @param[in] HealthFlag If not NULL, a pointer to a value that specifies
1790 the new health status of the AP.
1792 @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
1793 @retval others Failed to Enable/Disable AP.
1797 EnableDisableApWorker (
1798 IN UINTN ProcessorNumber
,
1799 IN BOOLEAN EnableAP
,
1800 IN UINT32
*HealthFlag OPTIONAL
1803 CPU_MP_DATA
*CpuMpData
;
1806 CpuMpData
= GetCpuMpData ();
1809 // Check whether caller processor is BSP
1811 MpInitLibWhoAmI (&CallerNumber
);
1812 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1813 return EFI_DEVICE_ERROR
;
1816 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1817 return EFI_INVALID_PARAMETER
;
1820 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1821 return EFI_NOT_FOUND
;
1825 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateDisabled
);
1827 ResetProcessorToIdleState (ProcessorNumber
);
1830 if (HealthFlag
!= NULL
) {
1831 CpuMpData
->CpuData
[ProcessorNumber
].CpuHealthy
=
1832 (BOOLEAN
) ((*HealthFlag
& PROCESSOR_HEALTH_STATUS_BIT
) != 0);
1839 This return the handle number for the calling processor. This service may be
1840 called from the BSP and APs.
1842 @param[out] ProcessorNumber Pointer to the handle number of AP.
1843 The range is from 0 to the total number of
1844 logical processors minus 1. The total number of
1845 logical processors can be retrieved by
1846 MpInitLibGetNumberOfProcessors().
1848 @retval EFI_SUCCESS The current processor handle number was returned
1850 @retval EFI_INVALID_PARAMETER ProcessorNumber is NULL.
1851 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1857 OUT UINTN
*ProcessorNumber
1860 CPU_MP_DATA
*CpuMpData
;
1862 if (ProcessorNumber
== NULL
) {
1863 return EFI_INVALID_PARAMETER
;
1866 CpuMpData
= GetCpuMpData ();
1868 return GetProcessorNumber (CpuMpData
, ProcessorNumber
);
1872 Retrieves the number of logical processor in the platform and the number of
1873 those logical processors that are enabled on this boot. This service may only
1874 be called from the BSP.
1876 @param[out] NumberOfProcessors Pointer to the total number of logical
1877 processors in the system, including the BSP
1879 @param[out] NumberOfEnabledProcessors Pointer to the number of enabled logical
1880 processors that exist in system, including
1883 @retval EFI_SUCCESS The number of logical processors and enabled
1884 logical processors was retrieved.
1885 @retval EFI_DEVICE_ERROR The calling processor is an AP.
1886 @retval EFI_INVALID_PARAMETER NumberOfProcessors is NULL and NumberOfEnabledProcessors
1888 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1893 MpInitLibGetNumberOfProcessors (
1894 OUT UINTN
*NumberOfProcessors
, OPTIONAL
1895 OUT UINTN
*NumberOfEnabledProcessors OPTIONAL
1898 CPU_MP_DATA
*CpuMpData
;
1900 UINTN ProcessorNumber
;
1901 UINTN EnabledProcessorNumber
;
1904 CpuMpData
= GetCpuMpData ();
1906 if ((NumberOfProcessors
== NULL
) && (NumberOfEnabledProcessors
== NULL
)) {
1907 return EFI_INVALID_PARAMETER
;
1911 // Check whether caller processor is BSP
1913 MpInitLibWhoAmI (&CallerNumber
);
1914 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1915 return EFI_DEVICE_ERROR
;
1918 ProcessorNumber
= CpuMpData
->CpuCount
;
1919 EnabledProcessorNumber
= 0;
1920 for (Index
= 0; Index
< ProcessorNumber
; Index
++) {
1921 if (GetApState (&CpuMpData
->CpuData
[Index
]) != CpuStateDisabled
) {
1922 EnabledProcessorNumber
++;
1926 if (NumberOfProcessors
!= NULL
) {
1927 *NumberOfProcessors
= ProcessorNumber
;
1929 if (NumberOfEnabledProcessors
!= NULL
) {
1930 *NumberOfEnabledProcessors
= EnabledProcessorNumber
;
1938 Worker function to execute a caller provided function on all enabled APs.
1940 @param[in] Procedure A pointer to the function to be run on
1941 enabled APs of the system.
1942 @param[in] SingleThread If TRUE, then all the enabled APs execute
1943 the function specified by Procedure one by
1944 one, in ascending order of processor handle
1945 number. If FALSE, then all the enabled APs
1946 execute the function specified by Procedure
1948 @param[in] WaitEvent The event created by the caller with CreateEvent()
1950 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
1951 APs to return from Procedure, either for
1952 blocking or non-blocking mode.
1953 @param[in] ProcedureArgument The parameter passed into Procedure for
1955 @param[out] FailedCpuList If all APs finish successfully, then its
1956 content is set to NULL. If not all APs
1957 finish before timeout expires, then its
1958 content is set to address of the buffer
1959 holding handle numbers of the failed APs.
1961 @retval EFI_SUCCESS In blocking mode, all APs have finished before
1962 the timeout expired.
1963 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched
1965 @retval others Failed to Startup all APs.
1969 StartupAllAPsWorker (
1970 IN EFI_AP_PROCEDURE Procedure
,
1971 IN BOOLEAN SingleThread
,
1972 IN EFI_EVENT WaitEvent OPTIONAL
,
1973 IN UINTN TimeoutInMicroseconds
,
1974 IN VOID
*ProcedureArgument OPTIONAL
,
1975 OUT UINTN
**FailedCpuList OPTIONAL
1979 CPU_MP_DATA
*CpuMpData
;
1980 UINTN ProcessorCount
;
1981 UINTN ProcessorNumber
;
1983 CPU_AP_DATA
*CpuData
;
1984 BOOLEAN HasEnabledAp
;
1987 CpuMpData
= GetCpuMpData ();
1989 if (FailedCpuList
!= NULL
) {
1990 *FailedCpuList
= NULL
;
1993 if (CpuMpData
->CpuCount
== 1) {
1994 return EFI_NOT_STARTED
;
1997 if (Procedure
== NULL
) {
1998 return EFI_INVALID_PARAMETER
;
2002 // Check whether caller processor is BSP
2004 MpInitLibWhoAmI (&CallerNumber
);
2005 if (CallerNumber
!= CpuMpData
->BspNumber
) {
2006 return EFI_DEVICE_ERROR
;
2012 CheckAndUpdateApsStatus ();
2014 ProcessorCount
= CpuMpData
->CpuCount
;
2015 HasEnabledAp
= FALSE
;
2017 // Check whether all enabled APs are idle.
2018 // If any enabled AP is not idle, return EFI_NOT_READY.
2020 for (ProcessorNumber
= 0; ProcessorNumber
< ProcessorCount
; ProcessorNumber
++) {
2021 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
2022 if (ProcessorNumber
!= CpuMpData
->BspNumber
) {
2023 ApState
= GetApState (CpuData
);
2024 if (ApState
!= CpuStateDisabled
) {
2025 HasEnabledAp
= TRUE
;
2026 if (ApState
!= CpuStateIdle
) {
2028 // If any enabled APs are busy, return EFI_NOT_READY.
2030 return EFI_NOT_READY
;
2036 if (!HasEnabledAp
) {
2038 // If no enabled AP exists, return EFI_NOT_STARTED.
2040 return EFI_NOT_STARTED
;
2043 CpuMpData
->StartCount
= 0;
2044 for (ProcessorNumber
= 0; ProcessorNumber
< ProcessorCount
; ProcessorNumber
++) {
2045 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
2046 CpuData
->Waiting
= FALSE
;
2047 if (ProcessorNumber
!= CpuMpData
->BspNumber
) {
2048 if (CpuData
->State
== CpuStateIdle
) {
2050 // Mark this processor as responsible for current calling.
2052 CpuData
->Waiting
= TRUE
;
2053 CpuMpData
->StartCount
++;
2058 CpuMpData
->Procedure
= Procedure
;
2059 CpuMpData
->ProcArguments
= ProcedureArgument
;
2060 CpuMpData
->SingleThread
= SingleThread
;
2061 CpuMpData
->FinishedCount
= 0;
2062 CpuMpData
->RunningCount
= 0;
2063 CpuMpData
->FailedCpuList
= FailedCpuList
;
2064 CpuMpData
->ExpectedTime
= CalculateTimeout (
2065 TimeoutInMicroseconds
,
2066 &CpuMpData
->CurrentTime
2068 CpuMpData
->TotalTime
= 0;
2069 CpuMpData
->WaitEvent
= WaitEvent
;
2071 if (!SingleThread
) {
2072 WakeUpAP (CpuMpData
, TRUE
, 0, Procedure
, ProcedureArgument
);
2074 for (ProcessorNumber
= 0; ProcessorNumber
< ProcessorCount
; ProcessorNumber
++) {
2075 if (ProcessorNumber
== CallerNumber
) {
2078 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
2079 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, Procedure
, ProcedureArgument
);
2085 Status
= EFI_SUCCESS
;
2086 if (WaitEvent
== NULL
) {
2088 Status
= CheckAllAPs ();
2089 } while (Status
== EFI_NOT_READY
);
2096 Worker function to let the caller get one enabled AP to execute a caller-provided
2099 @param[in] Procedure A pointer to the function to be run on
2100 enabled APs of the system.
2101 @param[in] ProcessorNumber The handle number of the AP.
2102 @param[in] WaitEvent The event created by the caller with CreateEvent()
2104 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
2105 APs to return from Procedure, either for
2106 blocking or non-blocking mode.
2107 @param[in] ProcedureArgument The parameter passed into Procedure for
2109 @param[out] Finished If AP returns from Procedure before the
2110 timeout expires, its content is set to TRUE.
2111 Otherwise, the value is set to FALSE.
2113 @retval EFI_SUCCESS In blocking mode, specified AP finished before
2114 the timeout expires.
2115 @retval others Failed to Startup AP.
2119 StartupThisAPWorker (
2120 IN EFI_AP_PROCEDURE Procedure
,
2121 IN UINTN ProcessorNumber
,
2122 IN EFI_EVENT WaitEvent OPTIONAL
,
2123 IN UINTN TimeoutInMicroseconds
,
2124 IN VOID
*ProcedureArgument OPTIONAL
,
2125 OUT BOOLEAN
*Finished OPTIONAL
2129 CPU_MP_DATA
*CpuMpData
;
2130 CPU_AP_DATA
*CpuData
;
2133 CpuMpData
= GetCpuMpData ();
2135 if (Finished
!= NULL
) {
2140 // Check whether caller processor is BSP
2142 MpInitLibWhoAmI (&CallerNumber
);
2143 if (CallerNumber
!= CpuMpData
->BspNumber
) {
2144 return EFI_DEVICE_ERROR
;
2148 // Check whether processor with the handle specified by ProcessorNumber exists
2150 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
2151 return EFI_NOT_FOUND
;
2155 // Check whether specified processor is BSP
2157 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
2158 return EFI_INVALID_PARAMETER
;
2162 // Check parameter Procedure
2164 if (Procedure
== NULL
) {
2165 return EFI_INVALID_PARAMETER
;
2171 CheckAndUpdateApsStatus ();
2174 // Check whether specified AP is disabled
2176 if (GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]) == CpuStateDisabled
) {
2177 return EFI_INVALID_PARAMETER
;
2181 // If WaitEvent is not NULL, execute in non-blocking mode.
2182 // BSP saves data for CheckAPsStatus(), and returns EFI_SUCCESS.
2183 // CheckAPsStatus() will check completion and timeout periodically.
2185 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
2186 CpuData
->WaitEvent
= WaitEvent
;
2187 CpuData
->Finished
= Finished
;
2188 CpuData
->ExpectedTime
= CalculateTimeout (TimeoutInMicroseconds
, &CpuData
->CurrentTime
);
2189 CpuData
->TotalTime
= 0;
2191 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, Procedure
, ProcedureArgument
);
2194 // If WaitEvent is NULL, execute in blocking mode.
2195 // BSP checks AP's state until it finishes or TimeoutInMicrosecsond expires.
2197 Status
= EFI_SUCCESS
;
2198 if (WaitEvent
== NULL
) {
2200 Status
= CheckThisAP (ProcessorNumber
);
2201 } while (Status
== EFI_NOT_READY
);
2208 Get pointer to CPU MP Data structure from GUIDed HOB.
2210 @return The pointer to CPU MP Data structure.
2213 GetCpuMpDataFromGuidedHob (
2217 EFI_HOB_GUID_TYPE
*GuidHob
;
2219 CPU_MP_DATA
*CpuMpData
;
2222 GuidHob
= GetFirstGuidHob (&mCpuInitMpLibHobGuid
);
2223 if (GuidHob
!= NULL
) {
2224 DataInHob
= GET_GUID_HOB_DATA (GuidHob
);
2225 CpuMpData
= (CPU_MP_DATA
*) (*(UINTN
*) DataInHob
);