2 CPU MP Initialize Library common functions.
4 Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 EFI_GUID mCpuInitMpLibHobGuid
= CPU_INIT_MP_LIB_HOB_GUID
;
20 The function will check if BSP Execute Disable is enabled.
21 DxeIpl may have enabled Execute Disable for BSP,
22 APs need to get the status and sync up the settings.
24 @retval TRUE BSP Execute Disable is enabled.
25 @retval FALSE BSP Execute Disable is not enabled.
28 IsBspExecuteDisableEnabled (
33 CPUID_EXTENDED_CPU_SIG_EDX Edx
;
34 MSR_IA32_EFER_REGISTER EferMsr
;
38 AsmCpuid (CPUID_EXTENDED_FUNCTION
, &Eax
, NULL
, NULL
, NULL
);
39 if (Eax
>= CPUID_EXTENDED_CPU_SIG
) {
40 AsmCpuid (CPUID_EXTENDED_CPU_SIG
, NULL
, NULL
, NULL
, &Edx
.Uint32
);
43 // Bit 20: Execute Disable Bit available.
45 if (Edx
.Bits
.NX
!= 0) {
46 EferMsr
.Uint64
= AsmReadMsr64 (MSR_IA32_EFER
);
49 // Bit 11: Execute Disable Bit enable.
51 if (EferMsr
.Bits
.NXE
!= 0) {
61 Get CPU Package/Core/Thread location information.
63 @param[in] InitialApicId CPU APIC ID
64 @param[out] Location Pointer to CPU location information
67 ExtractProcessorLocation (
68 IN UINT32 InitialApicId
,
69 OUT EFI_CPU_PHYSICAL_LOCATION
*Location
72 BOOLEAN TopologyLeafSupported
;
75 CPUID_VERSION_INFO_EBX VersionInfoEbx
;
76 CPUID_VERSION_INFO_EDX VersionInfoEdx
;
77 CPUID_CACHE_PARAMS_EAX CacheParamsEax
;
78 CPUID_EXTENDED_TOPOLOGY_EAX ExtendedTopologyEax
;
79 CPUID_EXTENDED_TOPOLOGY_EBX ExtendedTopologyEbx
;
80 CPUID_EXTENDED_TOPOLOGY_ECX ExtendedTopologyEcx
;
84 UINT32 MaxLogicProcessorsPerPackage
;
85 UINT32 MaxCoresPerPackage
;
88 // Check if the processor is capable of supporting more than one logical processor.
90 AsmCpuid (CPUID_VERSION_INFO
, NULL
, NULL
, NULL
, &VersionInfoEdx
.Uint32
);
91 if (VersionInfoEdx
.Bits
.HTT
== 0) {
94 Location
->Package
= 0;
102 // Assume three-level mapping of APIC ID: Package:Core:SMT.
105 TopologyLeafSupported
= FALSE
;
107 // Get the max index of basic CPUID
109 AsmCpuid (CPUID_SIGNATURE
, &MaxCpuIdIndex
, NULL
, NULL
, NULL
);
112 // If the extended topology enumeration leaf is available, it
113 // is the preferred mechanism for enumerating topology.
115 if (MaxCpuIdIndex
>= CPUID_EXTENDED_TOPOLOGY
) {
117 CPUID_EXTENDED_TOPOLOGY
,
119 &ExtendedTopologyEax
.Uint32
,
120 &ExtendedTopologyEbx
.Uint32
,
121 &ExtendedTopologyEcx
.Uint32
,
125 // If CPUID.(EAX=0BH, ECX=0H):EBX returns zero and maximum input value for
126 // basic CPUID information is greater than 0BH, then CPUID.0BH leaf is not
127 // supported on that processor.
129 if (ExtendedTopologyEbx
.Uint32
!= 0) {
130 TopologyLeafSupported
= TRUE
;
133 // Sub-leaf index 0 (ECX= 0 as input) provides enumeration parameters to extract
134 // the SMT sub-field of x2APIC ID.
136 LevelType
= ExtendedTopologyEcx
.Bits
.LevelType
;
137 ASSERT (LevelType
== CPUID_EXTENDED_TOPOLOGY_LEVEL_TYPE_SMT
);
138 ThreadBits
= ExtendedTopologyEax
.Bits
.ApicIdShift
;
141 // Software must not assume any "level type" encoding
142 // value to be related to any sub-leaf index, except sub-leaf 0.
147 CPUID_EXTENDED_TOPOLOGY
,
149 &ExtendedTopologyEax
.Uint32
,
151 &ExtendedTopologyEcx
.Uint32
,
154 LevelType
= ExtendedTopologyEcx
.Bits
.LevelType
;
155 if (LevelType
== CPUID_EXTENDED_TOPOLOGY_LEVEL_TYPE_CORE
) {
156 CoreBits
= ExtendedTopologyEax
.Bits
.ApicIdShift
- ThreadBits
;
160 } while (LevelType
!= CPUID_EXTENDED_TOPOLOGY_LEVEL_TYPE_INVALID
);
164 if (!TopologyLeafSupported
) {
165 AsmCpuid (CPUID_VERSION_INFO
, NULL
, &VersionInfoEbx
.Uint32
, NULL
, NULL
);
166 MaxLogicProcessorsPerPackage
= VersionInfoEbx
.Bits
.MaximumAddressableIdsForLogicalProcessors
;
167 if (MaxCpuIdIndex
>= CPUID_CACHE_PARAMS
) {
168 AsmCpuidEx (CPUID_CACHE_PARAMS
, 0, &CacheParamsEax
.Uint32
, NULL
, NULL
, NULL
);
169 MaxCoresPerPackage
= CacheParamsEax
.Bits
.MaximumAddressableIdsForLogicalProcessors
+ 1;
172 // Must be a single-core processor.
174 MaxCoresPerPackage
= 1;
177 ThreadBits
= (UINTN
) (HighBitSet32 (MaxLogicProcessorsPerPackage
/ MaxCoresPerPackage
- 1) + 1);
178 CoreBits
= (UINTN
) (HighBitSet32 (MaxCoresPerPackage
- 1) + 1);
181 Location
->Thread
= InitialApicId
& ((1 << ThreadBits
) - 1);
182 Location
->Core
= (InitialApicId
>> ThreadBits
) & ((1 << CoreBits
) - 1);
183 Location
->Package
= (InitialApicId
>> (ThreadBits
+ CoreBits
));
187 Worker function for SwitchBSP().
189 Worker function for SwitchBSP(), assigned to the AP which is intended
192 @param[in] Buffer Pointer to CPU MP Data
200 CPU_MP_DATA
*DataInHob
;
202 DataInHob
= (CPU_MP_DATA
*) Buffer
;
203 AsmExchangeRole (&DataInHob
->APInfo
, &DataInHob
->BSPInfo
);
207 Get the Application Processors state.
209 @param[in] CpuData The pointer to CPU_AP_DATA of specified AP
211 @return The AP status
215 IN CPU_AP_DATA
*CpuData
218 return CpuData
->State
;
222 Set the Application Processors state.
224 @param[in] CpuData The pointer to CPU_AP_DATA of specified AP
225 @param[in] State The AP status
229 IN CPU_AP_DATA
*CpuData
,
233 AcquireSpinLock (&CpuData
->ApLock
);
234 CpuData
->State
= State
;
235 ReleaseSpinLock (&CpuData
->ApLock
);
239 Save the volatile registers required to be restored following INIT IPI.
241 @param[out] VolatileRegisters Returns buffer saved the volatile resisters
244 SaveVolatileRegisters (
245 OUT CPU_VOLATILE_REGISTERS
*VolatileRegisters
248 CPUID_VERSION_INFO_EDX VersionInfoEdx
;
250 VolatileRegisters
->Cr0
= AsmReadCr0 ();
251 VolatileRegisters
->Cr3
= AsmReadCr3 ();
252 VolatileRegisters
->Cr4
= AsmReadCr4 ();
254 AsmCpuid (CPUID_VERSION_INFO
, NULL
, NULL
, NULL
, &VersionInfoEdx
.Uint32
);
255 if (VersionInfoEdx
.Bits
.DE
!= 0) {
257 // If processor supports Debugging Extensions feature
258 // by CPUID.[EAX=01H]:EDX.BIT2
260 VolatileRegisters
->Dr0
= AsmReadDr0 ();
261 VolatileRegisters
->Dr1
= AsmReadDr1 ();
262 VolatileRegisters
->Dr2
= AsmReadDr2 ();
263 VolatileRegisters
->Dr3
= AsmReadDr3 ();
264 VolatileRegisters
->Dr6
= AsmReadDr6 ();
265 VolatileRegisters
->Dr7
= AsmReadDr7 ();
270 Restore the volatile registers following INIT IPI.
272 @param[in] VolatileRegisters Pointer to volatile resisters
273 @param[in] IsRestoreDr TRUE: Restore DRx if supported
274 FALSE: Do not restore DRx
277 RestoreVolatileRegisters (
278 IN CPU_VOLATILE_REGISTERS
*VolatileRegisters
,
279 IN BOOLEAN IsRestoreDr
282 CPUID_VERSION_INFO_EDX VersionInfoEdx
;
284 AsmWriteCr0 (VolatileRegisters
->Cr0
);
285 AsmWriteCr3 (VolatileRegisters
->Cr3
);
286 AsmWriteCr4 (VolatileRegisters
->Cr4
);
289 AsmCpuid (CPUID_VERSION_INFO
, NULL
, NULL
, NULL
, &VersionInfoEdx
.Uint32
);
290 if (VersionInfoEdx
.Bits
.DE
!= 0) {
292 // If processor supports Debugging Extensions feature
293 // by CPUID.[EAX=01H]:EDX.BIT2
295 AsmWriteDr0 (VolatileRegisters
->Dr0
);
296 AsmWriteDr1 (VolatileRegisters
->Dr1
);
297 AsmWriteDr2 (VolatileRegisters
->Dr2
);
298 AsmWriteDr3 (VolatileRegisters
->Dr3
);
299 AsmWriteDr6 (VolatileRegisters
->Dr6
);
300 AsmWriteDr7 (VolatileRegisters
->Dr7
);
306 Detect whether Mwait-monitor feature is supported.
308 @retval TRUE Mwait-monitor feature is supported.
309 @retval FALSE Mwait-monitor feature is not supported.
316 CPUID_VERSION_INFO_ECX VersionInfoEcx
;
318 AsmCpuid (CPUID_VERSION_INFO
, NULL
, NULL
, &VersionInfoEcx
.Uint32
, NULL
);
319 return (VersionInfoEcx
.Bits
.MONITOR
== 1) ? TRUE
: FALSE
;
325 @param[out] MonitorFilterSize Returns the largest monitor-line size in bytes.
327 @return The AP loop mode.
331 OUT UINT32
*MonitorFilterSize
335 CPUID_MONITOR_MWAIT_EBX MonitorMwaitEbx
;
337 ASSERT (MonitorFilterSize
!= NULL
);
339 ApLoopMode
= PcdGet8 (PcdCpuApLoopMode
);
340 ASSERT (ApLoopMode
>= ApInHltLoop
&& ApLoopMode
<= ApInRunLoop
);
341 if (ApLoopMode
== ApInMwaitLoop
) {
342 if (!IsMwaitSupport ()) {
344 // If processor does not support MONITOR/MWAIT feature,
345 // force AP in Hlt-loop mode
347 ApLoopMode
= ApInHltLoop
;
351 if (ApLoopMode
!= ApInMwaitLoop
) {
352 *MonitorFilterSize
= sizeof (UINT32
);
355 // CPUID.[EAX=05H]:EBX.BIT0-15: Largest monitor-line size in bytes
356 // CPUID.[EAX=05H].EDX: C-states supported using MWAIT
358 AsmCpuid (CPUID_MONITOR_MWAIT
, NULL
, &MonitorMwaitEbx
.Uint32
, NULL
, NULL
);
359 *MonitorFilterSize
= MonitorMwaitEbx
.Bits
.LargestMonitorLineSize
;
366 Sort the APIC ID of all processors.
368 This function sorts the APIC ID of all processors so that processor number is
369 assigned in the ascending order of APIC ID which eases MP debugging.
371 @param[in] CpuMpData Pointer to PEI CPU MP Data
375 IN CPU_MP_DATA
*CpuMpData
384 CPU_INFO_IN_HOB
*CpuInfoInHob
;
386 ApCount
= CpuMpData
->CpuCount
- 1;
389 for (Index1
= 0; Index1
< ApCount
; Index1
++) {
392 // Sort key is the hardware default APIC ID
394 ApicId
= CpuMpData
->CpuData
[Index1
].ApicId
;
395 for (Index2
= Index1
+ 1; Index2
<= ApCount
; Index2
++) {
396 if (ApicId
> CpuMpData
->CpuData
[Index2
].ApicId
) {
398 ApicId
= CpuMpData
->CpuData
[Index2
].ApicId
;
401 if (Index3
!= Index1
) {
402 CopyMem (&CpuData
, &CpuMpData
->CpuData
[Index3
], sizeof (CPU_AP_DATA
));
404 &CpuMpData
->CpuData
[Index3
],
405 &CpuMpData
->CpuData
[Index1
],
408 CopyMem (&CpuMpData
->CpuData
[Index1
], &CpuData
, sizeof (CPU_AP_DATA
));
413 // Get the processor number for the BSP
415 ApicId
= GetInitialApicId ();
416 for (Index1
= 0; Index1
< CpuMpData
->CpuCount
; Index1
++) {
417 if (CpuMpData
->CpuData
[Index1
].ApicId
== ApicId
) {
418 CpuMpData
->BspNumber
= (UINT32
) Index1
;
423 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
424 for (Index1
= 0; Index1
< CpuMpData
->CpuCount
; Index1
++) {
425 CpuInfoInHob
[Index1
].InitialApicId
= CpuMpData
->CpuData
[Index1
].InitialApicId
;
426 CpuInfoInHob
[Index1
].ApicId
= CpuMpData
->CpuData
[Index1
].ApicId
;
427 CpuInfoInHob
[Index1
].Health
= CpuMpData
->CpuData
[Index1
].Health
;
433 Enable x2APIC mode on APs.
435 @param[in, out] Buffer Pointer to private data buffer.
443 SetApicMode (LOCAL_APIC_MODE_X2APIC
);
449 @param[in, out] Buffer Pointer to private data buffer.
457 CPU_MP_DATA
*CpuMpData
;
459 CpuMpData
= (CPU_MP_DATA
*) Buffer
;
461 // Sync BSP's MTRR table to AP
463 MtrrSetAllMtrrs (&CpuMpData
->MtrrTable
);
465 // Load microcode on AP
467 MicrocodeDetect (CpuMpData
);
471 Find the current Processor number by APIC ID.
473 @param[in] CpuMpData Pointer to PEI CPU MP Data
474 @param[in] ProcessorNumber Return the pocessor number found
476 @retval EFI_SUCCESS ProcessorNumber is found and returned.
477 @retval EFI_NOT_FOUND ProcessorNumber is not found.
481 IN CPU_MP_DATA
*CpuMpData
,
482 OUT UINTN
*ProcessorNumber
485 UINTN TotalProcessorNumber
;
488 TotalProcessorNumber
= CpuMpData
->CpuCount
;
489 for (Index
= 0; Index
< TotalProcessorNumber
; Index
++) {
490 if (CpuMpData
->CpuData
[Index
].ApicId
== GetApicId ()) {
491 *ProcessorNumber
= Index
;
495 return EFI_NOT_FOUND
;
499 This function will get CPU count in the system.
501 @param[in] CpuMpData Pointer to PEI CPU MP Data
503 @return CPU count detected
506 CollectProcessorCount (
507 IN CPU_MP_DATA
*CpuMpData
511 // Send 1st broadcast IPI to APs to wakeup APs
513 CpuMpData
->InitFlag
= ApInitConfig
;
514 CpuMpData
->X2ApicEnable
= FALSE
;
515 WakeUpAP (CpuMpData
, TRUE
, 0, NULL
, NULL
);
517 // Wait for AP task to complete and then exit.
519 MicroSecondDelay (PcdGet32(PcdCpuApInitTimeOutInMicroSeconds
));
520 CpuMpData
->InitFlag
= ApInitDone
;
521 ASSERT (CpuMpData
->CpuCount
<= PcdGet32 (PcdCpuMaxLogicalProcessorNumber
));
523 // Wait for all APs finished the initialization
525 while (CpuMpData
->FinishedCount
< (CpuMpData
->CpuCount
- 1)) {
529 if (CpuMpData
->X2ApicEnable
) {
530 DEBUG ((DEBUG_INFO
, "Force x2APIC mode!\n"));
532 // Wakeup all APs to enable x2APIC mode
534 WakeUpAP (CpuMpData
, TRUE
, 0, ApFuncEnableX2Apic
, NULL
);
536 // Wait for all known APs finished
538 while (CpuMpData
->FinishedCount
< (CpuMpData
->CpuCount
- 1)) {
542 // Enable x2APIC on BSP
544 SetApicMode (LOCAL_APIC_MODE_X2APIC
);
546 DEBUG ((DEBUG_INFO
, "APIC MODE is %d\n", GetApicMode ()));
548 // Sort BSP/Aps by CPU APIC ID in ascending order
550 SortApicId (CpuMpData
);
552 DEBUG ((DEBUG_INFO
, "MpInitLib: Find %d processors in system.\n", CpuMpData
->CpuCount
));
554 return CpuMpData
->CpuCount
;
558 Initialize CPU AP Data when AP is wakeup at the first time.
560 @param[in, out] CpuMpData Pointer to PEI CPU MP Data
561 @param[in] ProcessorNumber The handle number of processor
562 @param[in] BistData Processor BIST data
567 IN OUT CPU_MP_DATA
*CpuMpData
,
568 IN UINTN ProcessorNumber
,
572 CpuMpData
->CpuData
[ProcessorNumber
].Waiting
= FALSE
;
573 CpuMpData
->CpuData
[ProcessorNumber
].Health
= BistData
;
574 CpuMpData
->CpuData
[ProcessorNumber
].CpuHealthy
= (BistData
== 0) ? TRUE
: FALSE
;
575 CpuMpData
->CpuData
[ProcessorNumber
].ApicId
= GetApicId ();
576 CpuMpData
->CpuData
[ProcessorNumber
].InitialApicId
= GetInitialApicId ();
577 if (CpuMpData
->CpuData
[ProcessorNumber
].InitialApicId
>= 0xFF) {
579 // Set x2APIC mode if there are any logical processor reporting
580 // an Initial APIC ID of 255 or greater.
582 AcquireSpinLock(&CpuMpData
->MpLock
);
583 CpuMpData
->X2ApicEnable
= TRUE
;
584 ReleaseSpinLock(&CpuMpData
->MpLock
);
587 InitializeSpinLock(&CpuMpData
->CpuData
[ProcessorNumber
].ApLock
);
588 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateIdle
);
592 This function will be called from AP reset code if BSP uses WakeUpAP.
594 @param[in] ExchangeInfo Pointer to the MP exchange info buffer
595 @param[in] NumApsExecuting Number of current executing AP
600 IN MP_CPU_EXCHANGE_INFO
*ExchangeInfo
,
601 IN UINTN NumApsExecuting
604 CPU_MP_DATA
*CpuMpData
;
605 UINTN ProcessorNumber
;
606 EFI_AP_PROCEDURE Procedure
;
609 volatile UINT32
*ApStartupSignalBuffer
;
612 // AP finished assembly code and begin to execute C code
614 CpuMpData
= ExchangeInfo
->CpuMpData
;
616 ProgramVirtualWireMode ();
619 if (CpuMpData
->InitFlag
== ApInitConfig
) {
623 InterlockedIncrement ((UINT32
*) &CpuMpData
->CpuCount
);
624 ProcessorNumber
= NumApsExecuting
;
626 // This is first time AP wakeup, get BIST information from AP stack
628 BistData
= *(UINT32
*) (CpuMpData
->Buffer
+ ProcessorNumber
* CpuMpData
->CpuApStackSize
- sizeof (UINTN
));
630 // Do some AP initialize sync
632 ApInitializeSync (CpuMpData
);
634 // Sync BSP's Control registers to APs
636 RestoreVolatileRegisters (&CpuMpData
->CpuData
[0].VolatileRegisters
, FALSE
);
637 InitializeApData (CpuMpData
, ProcessorNumber
, BistData
);
638 ApStartupSignalBuffer
= CpuMpData
->CpuData
[ProcessorNumber
].StartupApSignal
;
641 // Execute AP function if AP is ready
643 GetProcessorNumber (CpuMpData
, &ProcessorNumber
);
645 // Clear AP start-up signal when AP waken up
647 ApStartupSignalBuffer
= CpuMpData
->CpuData
[ProcessorNumber
].StartupApSignal
;
648 InterlockedCompareExchange32 (
649 (UINT32
*) ApStartupSignalBuffer
,
653 if (CpuMpData
->ApLoopMode
== ApInHltLoop
) {
655 // Restore AP's volatile registers saved
657 RestoreVolatileRegisters (&CpuMpData
->CpuData
[ProcessorNumber
].VolatileRegisters
, TRUE
);
660 if (GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]) == CpuStateReady
) {
661 Procedure
= (EFI_AP_PROCEDURE
)CpuMpData
->CpuData
[ProcessorNumber
].ApFunction
;
662 Parameter
= (VOID
*) CpuMpData
->CpuData
[ProcessorNumber
].ApFunctionArgument
;
663 if (Procedure
!= NULL
) {
664 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateBusy
);
666 // Invoke AP function here
668 Procedure (Parameter
);
669 if (CpuMpData
->SwitchBspFlag
) {
671 // Re-get the processor number due to BSP/AP maybe exchange in AP function
673 GetProcessorNumber (CpuMpData
, &ProcessorNumber
);
674 CpuMpData
->CpuData
[ProcessorNumber
].ApFunction
= 0;
675 CpuMpData
->CpuData
[ProcessorNumber
].ApFunctionArgument
= 0;
678 // Re-get the CPU APICID and Initial APICID
680 CpuMpData
->CpuData
[ProcessorNumber
].ApicId
= GetApicId ();
681 CpuMpData
->CpuData
[ProcessorNumber
].InitialApicId
= GetInitialApicId ();
684 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateFinished
);
689 // AP finished executing C code
691 InterlockedIncrement ((UINT32
*) &CpuMpData
->FinishedCount
);
694 // Place AP is specified loop mode
696 if (CpuMpData
->ApLoopMode
== ApInHltLoop
) {
698 // Save AP volatile registers
700 SaveVolatileRegisters (&CpuMpData
->CpuData
[ProcessorNumber
].VolatileRegisters
);
702 // Place AP in HLT-loop
705 DisableInterrupts ();
711 DisableInterrupts ();
712 if (CpuMpData
->ApLoopMode
== ApInMwaitLoop
) {
714 // Place AP in MWAIT-loop
716 AsmMonitor ((UINTN
) ApStartupSignalBuffer
, 0, 0);
717 if (*ApStartupSignalBuffer
!= WAKEUP_AP_SIGNAL
) {
719 // Check AP start-up signal again.
720 // If AP start-up signal is not set, place AP into
721 // the specified C-state
723 AsmMwait (CpuMpData
->ApTargetCState
<< 4, 0);
725 } else if (CpuMpData
->ApLoopMode
== ApInRunLoop
) {
727 // Place AP in Run-loop
735 // If AP start-up signal is written, AP is waken up
736 // otherwise place AP in loop again
738 if (*ApStartupSignalBuffer
== WAKEUP_AP_SIGNAL
) {
746 Wait for AP wakeup and write AP start-up signal till AP is waken up.
748 @param[in] ApStartupSignalBuffer Pointer to AP wakeup signal
752 IN
volatile UINT32
*ApStartupSignalBuffer
756 // If AP is waken up, StartupApSignal should be cleared.
757 // Otherwise, write StartupApSignal again till AP waken up.
759 while (InterlockedCompareExchange32 (
760 (UINT32
*) ApStartupSignalBuffer
,
769 This function will fill the exchange info structure.
771 @param[in] CpuMpData Pointer to CPU MP Data
775 FillExchangeInfoData (
776 IN CPU_MP_DATA
*CpuMpData
779 volatile MP_CPU_EXCHANGE_INFO
*ExchangeInfo
;
781 ExchangeInfo
= CpuMpData
->MpCpuExchangeInfo
;
782 ExchangeInfo
->Lock
= 0;
783 ExchangeInfo
->StackStart
= CpuMpData
->Buffer
;
784 ExchangeInfo
->StackSize
= CpuMpData
->CpuApStackSize
;
785 ExchangeInfo
->BufferStart
= CpuMpData
->WakeupBuffer
;
786 ExchangeInfo
->ModeOffset
= CpuMpData
->AddressMap
.ModeEntryOffset
;
788 ExchangeInfo
->CodeSegment
= AsmReadCs ();
789 ExchangeInfo
->DataSegment
= AsmReadDs ();
791 ExchangeInfo
->Cr3
= AsmReadCr3 ();
793 ExchangeInfo
->CFunction
= (UINTN
) ApWakeupFunction
;
794 ExchangeInfo
->NumApsExecuting
= 0;
795 ExchangeInfo
->CpuMpData
= CpuMpData
;
797 ExchangeInfo
->EnableExecuteDisable
= IsBspExecuteDisableEnabled ();
800 // Get the BSP's data of GDT and IDT
802 AsmReadGdtr ((IA32_DESCRIPTOR
*) &ExchangeInfo
->GdtrProfile
);
803 AsmReadIdtr ((IA32_DESCRIPTOR
*) &ExchangeInfo
->IdtrProfile
);
807 This function will be called by BSP to wakeup AP.
809 @param[in] CpuMpData Pointer to CPU MP Data
810 @param[in] Broadcast TRUE: Send broadcast IPI to all APs
811 FALSE: Send IPI to AP by ApicId
812 @param[in] ProcessorNumber The handle number of specified processor
813 @param[in] Procedure The function to be invoked by AP
814 @param[in] ProcedureArgument The argument to be passed into AP function
818 IN CPU_MP_DATA
*CpuMpData
,
819 IN BOOLEAN Broadcast
,
820 IN UINTN ProcessorNumber
,
821 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
822 IN VOID
*ProcedureArgument OPTIONAL
825 volatile MP_CPU_EXCHANGE_INFO
*ExchangeInfo
;
827 CPU_AP_DATA
*CpuData
;
828 BOOLEAN ResetVectorRequired
;
830 CpuMpData
->FinishedCount
= 0;
831 ResetVectorRequired
= FALSE
;
833 if (CpuMpData
->ApLoopMode
== ApInHltLoop
||
834 CpuMpData
->InitFlag
!= ApInitDone
) {
835 ResetVectorRequired
= TRUE
;
836 AllocateResetVector (CpuMpData
);
837 FillExchangeInfoData (CpuMpData
);
838 } else if (CpuMpData
->ApLoopMode
== ApInMwaitLoop
) {
840 // Get AP target C-state each time when waking up AP,
841 // for it maybe updated by platform again
843 CpuMpData
->ApTargetCState
= PcdGet8 (PcdCpuApTargetCstate
);
846 ExchangeInfo
= CpuMpData
->MpCpuExchangeInfo
;
849 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
850 if (Index
!= CpuMpData
->BspNumber
) {
851 CpuData
= &CpuMpData
->CpuData
[Index
];
852 CpuData
->ApFunction
= (UINTN
) Procedure
;
853 CpuData
->ApFunctionArgument
= (UINTN
) ProcedureArgument
;
854 SetApState (CpuData
, CpuStateReady
);
855 if (CpuMpData
->InitFlag
!= ApInitConfig
) {
856 *(UINT32
*) CpuData
->StartupApSignal
= WAKEUP_AP_SIGNAL
;
860 if (ResetVectorRequired
) {
864 SendInitSipiSipiAllExcludingSelf ((UINT32
) ExchangeInfo
->BufferStart
);
866 if (CpuMpData
->InitFlag
!= ApInitConfig
) {
868 // Wait all APs waken up if this is not the 1st broadcast of SIPI
870 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
871 CpuData
= &CpuMpData
->CpuData
[Index
];
872 if (Index
!= CpuMpData
->BspNumber
) {
873 WaitApWakeup (CpuData
->StartupApSignal
);
878 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
879 CpuData
->ApFunction
= (UINTN
) Procedure
;
880 CpuData
->ApFunctionArgument
= (UINTN
) ProcedureArgument
;
881 SetApState (CpuData
, CpuStateReady
);
883 // Wakeup specified AP
885 ASSERT (CpuMpData
->InitFlag
!= ApInitConfig
);
886 *(UINT32
*) CpuData
->StartupApSignal
= WAKEUP_AP_SIGNAL
;
887 if (ResetVectorRequired
) {
890 (UINT32
) ExchangeInfo
->BufferStart
894 // Wait specified AP waken up
896 WaitApWakeup (CpuData
->StartupApSignal
);
899 if (ResetVectorRequired
) {
900 FreeResetVector (CpuMpData
);
905 Calculate timeout value and return the current performance counter value.
907 Calculate the number of performance counter ticks required for a timeout.
908 If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
911 @param[in] TimeoutInMicroseconds Timeout value in microseconds.
912 @param[out] CurrentTime Returns the current value of the performance counter.
914 @return Expected time stamp counter for timeout.
915 If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
921 IN UINTN TimeoutInMicroseconds
,
922 OUT UINT64
*CurrentTime
926 // Read the current value of the performance counter
928 *CurrentTime
= GetPerformanceCounter ();
931 // If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
934 if (TimeoutInMicroseconds
== 0) {
939 // GetPerformanceCounterProperties () returns the timestamp counter's frequency
940 // in Hz. So multiply the return value with TimeoutInMicroseconds and then divide
941 // it by 1,000,000, to get the number of ticks for the timeout value.
945 GetPerformanceCounterProperties (NULL
, NULL
),
946 TimeoutInMicroseconds
953 Checks whether timeout expires.
955 Check whether the number of elapsed performance counter ticks required for
956 a timeout condition has been reached.
957 If Timeout is zero, which means infinity, return value is always FALSE.
959 @param[in, out] PreviousTime On input, the value of the performance counter
960 when it was last read.
961 On output, the current value of the performance
963 @param[in] TotalTime The total amount of elapsed time in performance
965 @param[in] Timeout The number of performance counter ticks required
966 to reach a timeout condition.
968 @retval TRUE A timeout condition has been reached.
969 @retval FALSE A timeout condition has not been reached.
974 IN OUT UINT64
*PreviousTime
,
975 IN UINT64
*TotalTime
,
988 GetPerformanceCounterProperties (&Start
, &End
);
994 CurrentTime
= GetPerformanceCounter();
995 Delta
= (INT64
) (CurrentTime
- *PreviousTime
);
1002 *TotalTime
+= Delta
;
1003 *PreviousTime
= CurrentTime
;
1004 if (*TotalTime
> Timeout
) {
1011 Reset an AP to Idle state.
1013 Any task being executed by the AP will be aborted and the AP
1014 will be waiting for a new task in Wait-For-SIPI state.
1016 @param[in] ProcessorNumber The handle number of processor.
1019 ResetProcessorToIdleState (
1020 IN UINTN ProcessorNumber
1023 CPU_MP_DATA
*CpuMpData
;
1025 CpuMpData
= GetCpuMpData ();
1027 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, NULL
, NULL
);
1029 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateIdle
);
1033 Searches for the next waiting AP.
1035 Search for the next AP that is put in waiting state by single-threaded StartupAllAPs().
1037 @param[out] NextProcessorNumber Pointer to the processor number of the next waiting AP.
1039 @retval EFI_SUCCESS The next waiting AP has been found.
1040 @retval EFI_NOT_FOUND No waiting AP exists.
1044 GetNextWaitingProcessorNumber (
1045 OUT UINTN
*NextProcessorNumber
1048 UINTN ProcessorNumber
;
1049 CPU_MP_DATA
*CpuMpData
;
1051 CpuMpData
= GetCpuMpData ();
1053 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
1054 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1055 *NextProcessorNumber
= ProcessorNumber
;
1060 return EFI_NOT_FOUND
;
1063 /** Checks status of specified AP.
1065 This function checks whether the specified AP has finished the task assigned
1066 by StartupThisAP(), and whether timeout expires.
1068 @param[in] ProcessorNumber The handle number of processor.
1070 @retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().
1071 @retval EFI_TIMEOUT The timeout expires.
1072 @retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.
1076 IN UINTN ProcessorNumber
1079 CPU_MP_DATA
*CpuMpData
;
1080 CPU_AP_DATA
*CpuData
;
1082 CpuMpData
= GetCpuMpData ();
1083 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1086 // Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.
1087 // Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the
1088 // value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.
1091 // If the AP finishes for StartupThisAP(), return EFI_SUCCESS.
1093 if (GetApState(CpuData
) == CpuStateFinished
) {
1094 if (CpuData
->Finished
!= NULL
) {
1095 *(CpuData
->Finished
) = TRUE
;
1097 SetApState (CpuData
, CpuStateIdle
);
1101 // If timeout expires for StartupThisAP(), report timeout.
1103 if (CheckTimeout (&CpuData
->CurrentTime
, &CpuData
->TotalTime
, CpuData
->ExpectedTime
)) {
1104 if (CpuData
->Finished
!= NULL
) {
1105 *(CpuData
->Finished
) = FALSE
;
1108 // Reset failed AP to idle state
1110 ResetProcessorToIdleState (ProcessorNumber
);
1115 return EFI_NOT_READY
;
1119 Checks status of all APs.
1121 This function checks whether all APs have finished task assigned by StartupAllAPs(),
1122 and whether timeout expires.
1124 @retval EFI_SUCCESS All APs have finished task assigned by StartupAllAPs().
1125 @retval EFI_TIMEOUT The timeout expires.
1126 @retval EFI_NOT_READY APs have not finished task and timeout has not expired.
1133 UINTN ProcessorNumber
;
1134 UINTN NextProcessorNumber
;
1137 CPU_MP_DATA
*CpuMpData
;
1138 CPU_AP_DATA
*CpuData
;
1140 CpuMpData
= GetCpuMpData ();
1142 NextProcessorNumber
= 0;
1145 // Go through all APs that are responsible for the StartupAllAPs().
1147 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
1148 if (!CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1152 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1154 // Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.
1155 // Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the
1156 // value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.
1158 if (GetApState(CpuData
) == CpuStateFinished
) {
1159 CpuMpData
->RunningCount
++;
1160 CpuMpData
->CpuData
[ProcessorNumber
].Waiting
= FALSE
;
1161 SetApState(CpuData
, CpuStateIdle
);
1164 // If in Single Thread mode, then search for the next waiting AP for execution.
1166 if (CpuMpData
->SingleThread
) {
1167 Status
= GetNextWaitingProcessorNumber (&NextProcessorNumber
);
1169 if (!EFI_ERROR (Status
)) {
1173 (UINT32
) NextProcessorNumber
,
1174 CpuMpData
->Procedure
,
1175 CpuMpData
->ProcArguments
1183 // If all APs finish, return EFI_SUCCESS.
1185 if (CpuMpData
->RunningCount
== CpuMpData
->StartCount
) {
1190 // If timeout expires, report timeout.
1193 &CpuMpData
->CurrentTime
,
1194 &CpuMpData
->TotalTime
,
1195 CpuMpData
->ExpectedTime
)
1198 // If FailedCpuList is not NULL, record all failed APs in it.
1200 if (CpuMpData
->FailedCpuList
!= NULL
) {
1201 *CpuMpData
->FailedCpuList
=
1202 AllocatePool ((CpuMpData
->StartCount
- CpuMpData
->FinishedCount
+ 1) * sizeof (UINTN
));
1203 ASSERT (*CpuMpData
->FailedCpuList
!= NULL
);
1207 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
1209 // Check whether this processor is responsible for StartupAllAPs().
1211 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1213 // Reset failed APs to idle state
1215 ResetProcessorToIdleState (ProcessorNumber
);
1216 CpuMpData
->CpuData
[ProcessorNumber
].Waiting
= FALSE
;
1217 if (CpuMpData
->FailedCpuList
!= NULL
) {
1218 (*CpuMpData
->FailedCpuList
)[ListIndex
++] = ProcessorNumber
;
1222 if (CpuMpData
->FailedCpuList
!= NULL
) {
1223 (*CpuMpData
->FailedCpuList
)[ListIndex
] = END_OF_CPU_LIST
;
1227 return EFI_NOT_READY
;
1231 MP Initialize Library initialization.
1233 This service will allocate AP reset vector and wakeup all APs to do APs
1236 This service must be invoked before all other MP Initialize Library
1237 service are invoked.
1239 @retval EFI_SUCCESS MP initialization succeeds.
1240 @retval Others MP initialization fails.
1245 MpInitLibInitialize (
1249 CPU_MP_DATA
*OldCpuMpData
;
1250 CPU_INFO_IN_HOB
*CpuInfoInHob
;
1251 UINT32 MaxLogicalProcessorNumber
;
1253 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
1255 UINT32 MonitorFilterSize
;
1258 CPU_MP_DATA
*CpuMpData
;
1260 UINT8
*MonitorBuffer
;
1262 UINTN ApResetVectorSize
;
1263 UINTN BackupBufferAddr
;
1265 OldCpuMpData
= GetCpuMpDataFromGuidedHob ();
1266 if (OldCpuMpData
== NULL
) {
1267 MaxLogicalProcessorNumber
= PcdGet32(PcdCpuMaxLogicalProcessorNumber
);
1269 MaxLogicalProcessorNumber
= OldCpuMpData
->CpuCount
;
1272 AsmGetAddressMap (&AddressMap
);
1273 ApResetVectorSize
= AddressMap
.RendezvousFunnelSize
+ sizeof (MP_CPU_EXCHANGE_INFO
);
1274 ApStackSize
= PcdGet32(PcdCpuApStackSize
);
1275 ApLoopMode
= GetApLoopMode (&MonitorFilterSize
);
1277 BufferSize
= ApStackSize
* MaxLogicalProcessorNumber
;
1278 BufferSize
+= MonitorFilterSize
* MaxLogicalProcessorNumber
;
1279 BufferSize
+= sizeof (CPU_MP_DATA
);
1280 BufferSize
+= ApResetVectorSize
;
1281 BufferSize
+= (sizeof (CPU_AP_DATA
) + sizeof (CPU_INFO_IN_HOB
))* MaxLogicalProcessorNumber
;
1282 MpBuffer
= AllocatePages (EFI_SIZE_TO_PAGES (BufferSize
));
1283 ASSERT (MpBuffer
!= NULL
);
1284 ZeroMem (MpBuffer
, BufferSize
);
1285 Buffer
= (UINTN
) MpBuffer
;
1287 MonitorBuffer
= (UINT8
*) (Buffer
+ ApStackSize
* MaxLogicalProcessorNumber
);
1288 BackupBufferAddr
= (UINTN
) MonitorBuffer
+ MonitorFilterSize
* MaxLogicalProcessorNumber
;
1289 CpuMpData
= (CPU_MP_DATA
*) (BackupBufferAddr
+ ApResetVectorSize
);
1290 CpuMpData
->Buffer
= Buffer
;
1291 CpuMpData
->CpuApStackSize
= ApStackSize
;
1292 CpuMpData
->BackupBuffer
= BackupBufferAddr
;
1293 CpuMpData
->BackupBufferSize
= ApResetVectorSize
;
1294 CpuMpData
->EndOfPeiFlag
= FALSE
;
1295 CpuMpData
->WakeupBuffer
= (UINTN
) -1;
1296 CpuMpData
->CpuCount
= 1;
1297 CpuMpData
->BspNumber
= 0;
1298 CpuMpData
->WaitEvent
= NULL
;
1299 CpuMpData
->SwitchBspFlag
= FALSE
;
1300 CpuMpData
->CpuData
= (CPU_AP_DATA
*) (CpuMpData
+ 1);
1301 CpuMpData
->CpuInfoInHob
= (UINT64
) (UINTN
) (CpuMpData
->CpuData
+ MaxLogicalProcessorNumber
);
1302 InitializeSpinLock(&CpuMpData
->MpLock
);
1304 // Save BSP's Control registers to APs
1306 SaveVolatileRegisters (&CpuMpData
->CpuData
[0].VolatileRegisters
);
1308 // Set BSP basic information
1310 InitializeApData (CpuMpData
, 0, 0);
1312 // Save assembly code information
1314 CopyMem (&CpuMpData
->AddressMap
, &AddressMap
, sizeof (MP_ASSEMBLY_ADDRESS_MAP
));
1316 // Finally set AP loop mode
1318 CpuMpData
->ApLoopMode
= ApLoopMode
;
1319 DEBUG ((DEBUG_INFO
, "AP Loop Mode is %d\n", CpuMpData
->ApLoopMode
));
1321 // Set up APs wakeup signal buffer
1323 for (Index
= 0; Index
< MaxLogicalProcessorNumber
; Index
++) {
1324 CpuMpData
->CpuData
[Index
].StartupApSignal
=
1325 (UINT32
*)(MonitorBuffer
+ MonitorFilterSize
* Index
);
1328 // Load Microcode on BSP
1330 MicrocodeDetect (CpuMpData
);
1332 // Store BSP's MTRR setting
1334 MtrrGetAllMtrrs (&CpuMpData
->MtrrTable
);
1336 if (OldCpuMpData
== NULL
) {
1338 // Wakeup all APs and calculate the processor count in system
1340 CollectProcessorCount (CpuMpData
);
1343 // APs have been wakeup before, just get the CPU Information
1346 CpuMpData
->CpuCount
= OldCpuMpData
->CpuCount
;
1347 CpuMpData
->BspNumber
= OldCpuMpData
->BspNumber
;
1348 CpuMpData
->InitFlag
= ApInitReconfig
;
1349 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) OldCpuMpData
->CpuInfoInHob
;
1350 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
1351 InitializeSpinLock(&CpuMpData
->CpuData
[Index
].ApLock
);
1352 CpuMpData
->CpuData
[Index
].ApicId
= CpuInfoInHob
[Index
].ApicId
;
1353 CpuMpData
->CpuData
[Index
].InitialApicId
= CpuInfoInHob
[Index
].InitialApicId
;
1354 if (CpuMpData
->CpuData
[Index
].InitialApicId
>= 255) {
1355 CpuMpData
->X2ApicEnable
= TRUE
;
1357 CpuMpData
->CpuData
[Index
].Health
= CpuInfoInHob
[Index
].Health
;
1358 CpuMpData
->CpuData
[Index
].CpuHealthy
= (CpuMpData
->CpuData
[Index
].Health
== 0)? TRUE
:FALSE
;
1359 CpuMpData
->CpuData
[Index
].ApFunction
= 0;
1361 &CpuMpData
->CpuData
[Index
].VolatileRegisters
,
1362 &CpuMpData
->CpuData
[0].VolatileRegisters
,
1363 sizeof (CPU_VOLATILE_REGISTERS
)
1367 // Wakeup APs to do some AP initialize sync
1369 WakeUpAP (CpuMpData
, TRUE
, 0, ApInitializeSync
, CpuMpData
);
1371 // Wait for all APs finished initialization
1373 while (CpuMpData
->FinishedCount
< (CpuMpData
->CpuCount
- 1)) {
1376 CpuMpData
->InitFlag
= ApInitDone
;
1377 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
1378 SetApState (&CpuMpData
->CpuData
[Index
], CpuStateIdle
);
1383 // Initialize global data for MP support
1385 InitMpGlobalData (CpuMpData
);
1391 Gets detailed MP-related information on the requested processor at the
1392 instant this call is made. This service may only be called from the BSP.
1394 @param[in] ProcessorNumber The handle number of processor.
1395 @param[out] ProcessorInfoBuffer A pointer to the buffer where information for
1396 the requested processor is deposited.
1397 @param[out] HealthData Return processor health data.
1399 @retval EFI_SUCCESS Processor information was returned.
1400 @retval EFI_DEVICE_ERROR The calling processor is an AP.
1401 @retval EFI_INVALID_PARAMETER ProcessorInfoBuffer is NULL.
1402 @retval EFI_NOT_FOUND The processor with the handle specified by
1403 ProcessorNumber does not exist in the platform.
1404 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1409 MpInitLibGetProcessorInfo (
1410 IN UINTN ProcessorNumber
,
1411 OUT EFI_PROCESSOR_INFORMATION
*ProcessorInfoBuffer
,
1412 OUT EFI_HEALTH_FLAGS
*HealthData OPTIONAL
1415 CPU_MP_DATA
*CpuMpData
;
1418 CpuMpData
= GetCpuMpData ();
1421 // Check whether caller processor is BSP
1423 MpInitLibWhoAmI (&CallerNumber
);
1424 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1425 return EFI_DEVICE_ERROR
;
1428 if (ProcessorInfoBuffer
== NULL
) {
1429 return EFI_INVALID_PARAMETER
;
1432 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1433 return EFI_NOT_FOUND
;
1436 ProcessorInfoBuffer
->ProcessorId
= (UINT64
) CpuMpData
->CpuData
[ProcessorNumber
].ApicId
;
1437 ProcessorInfoBuffer
->StatusFlag
= 0;
1438 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1439 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_AS_BSP_BIT
;
1441 if (CpuMpData
->CpuData
[ProcessorNumber
].CpuHealthy
) {
1442 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_HEALTH_STATUS_BIT
;
1444 if (GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]) == CpuStateDisabled
) {
1445 ProcessorInfoBuffer
->StatusFlag
&= ~PROCESSOR_ENABLED_BIT
;
1447 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_ENABLED_BIT
;
1451 // Get processor location information
1453 ExtractProcessorLocation (CpuMpData
->CpuData
[ProcessorNumber
].ApicId
, &ProcessorInfoBuffer
->Location
);
1455 if (HealthData
!= NULL
) {
1456 HealthData
->Uint32
= CpuMpData
->CpuData
[ProcessorNumber
].Health
;
1463 Worker function to switch the requested AP to be the BSP from that point onward.
1465 @param[in] ProcessorNumber The handle number of AP that is to become the new BSP.
1466 @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an
1467 enabled AP. Otherwise, it will be disabled.
1469 @retval EFI_SUCCESS BSP successfully switched.
1470 @retval others Failed to switch BSP.
1475 IN UINTN ProcessorNumber
,
1476 IN BOOLEAN EnableOldBSP
1479 CPU_MP_DATA
*CpuMpData
;
1482 MSR_IA32_APIC_BASE_REGISTER ApicBaseMsr
;
1484 CpuMpData
= GetCpuMpData ();
1487 // Check whether caller processor is BSP
1489 MpInitLibWhoAmI (&CallerNumber
);
1490 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1494 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1495 return EFI_NOT_FOUND
;
1499 // Check whether specified AP is disabled
1501 State
= GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]);
1502 if (State
== CpuStateDisabled
) {
1503 return EFI_INVALID_PARAMETER
;
1507 // Check whether ProcessorNumber specifies the current BSP
1509 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1510 return EFI_INVALID_PARAMETER
;
1514 // Check whether specified AP is busy
1516 if (State
== CpuStateBusy
) {
1517 return EFI_NOT_READY
;
1520 CpuMpData
->BSPInfo
.State
= CPU_SWITCH_STATE_IDLE
;
1521 CpuMpData
->APInfo
.State
= CPU_SWITCH_STATE_IDLE
;
1522 CpuMpData
->SwitchBspFlag
= TRUE
;
1525 // Clear the BSP bit of MSR_IA32_APIC_BASE
1527 ApicBaseMsr
.Uint64
= AsmReadMsr64 (MSR_IA32_APIC_BASE
);
1528 ApicBaseMsr
.Bits
.BSP
= 0;
1529 AsmWriteMsr64 (MSR_IA32_APIC_BASE
, ApicBaseMsr
.Uint64
);
1532 // Need to wakeUp AP (future BSP).
1534 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, FutureBSPProc
, CpuMpData
);
1536 AsmExchangeRole (&CpuMpData
->BSPInfo
, &CpuMpData
->APInfo
);
1539 // Set the BSP bit of MSR_IA32_APIC_BASE on new BSP
1541 ApicBaseMsr
.Uint64
= AsmReadMsr64 (MSR_IA32_APIC_BASE
);
1542 ApicBaseMsr
.Bits
.BSP
= 1;
1543 AsmWriteMsr64 (MSR_IA32_APIC_BASE
, ApicBaseMsr
.Uint64
);
1546 // Wait for old BSP finished AP task
1548 while (GetApState (&CpuMpData
->CpuData
[CallerNumber
]) != CpuStateFinished
) {
1552 CpuMpData
->SwitchBspFlag
= FALSE
;
1554 // Set old BSP enable state
1556 if (!EnableOldBSP
) {
1557 SetApState (&CpuMpData
->CpuData
[CallerNumber
], CpuStateDisabled
);
1560 // Save new BSP number
1562 CpuMpData
->BspNumber
= (UINT32
) ProcessorNumber
;
1568 Worker function to let the caller enable or disable an AP from this point onward.
1569 This service may only be called from the BSP.
1571 @param[in] ProcessorNumber The handle number of AP.
1572 @param[in] EnableAP Specifies the new state for the processor for
1573 enabled, FALSE for disabled.
1574 @param[in] HealthFlag If not NULL, a pointer to a value that specifies
1575 the new health status of the AP.
1577 @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
1578 @retval others Failed to Enable/Disable AP.
1582 EnableDisableApWorker (
1583 IN UINTN ProcessorNumber
,
1584 IN BOOLEAN EnableAP
,
1585 IN UINT32
*HealthFlag OPTIONAL
1588 CPU_MP_DATA
*CpuMpData
;
1591 CpuMpData
= GetCpuMpData ();
1594 // Check whether caller processor is BSP
1596 MpInitLibWhoAmI (&CallerNumber
);
1597 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1598 return EFI_DEVICE_ERROR
;
1601 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1602 return EFI_INVALID_PARAMETER
;
1605 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1606 return EFI_NOT_FOUND
;
1610 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateDisabled
);
1612 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateIdle
);
1615 if (HealthFlag
!= NULL
) {
1616 CpuMpData
->CpuData
[ProcessorNumber
].CpuHealthy
=
1617 (BOOLEAN
) ((*HealthFlag
& PROCESSOR_HEALTH_STATUS_BIT
) != 0);
1624 This return the handle number for the calling processor. This service may be
1625 called from the BSP and APs.
1627 @param[out] ProcessorNumber Pointer to the handle number of AP.
1628 The range is from 0 to the total number of
1629 logical processors minus 1. The total number of
1630 logical processors can be retrieved by
1631 MpInitLibGetNumberOfProcessors().
1633 @retval EFI_SUCCESS The current processor handle number was returned
1635 @retval EFI_INVALID_PARAMETER ProcessorNumber is NULL.
1636 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1642 OUT UINTN
*ProcessorNumber
1645 CPU_MP_DATA
*CpuMpData
;
1647 if (ProcessorNumber
== NULL
) {
1648 return EFI_INVALID_PARAMETER
;
1651 CpuMpData
= GetCpuMpData ();
1653 return GetProcessorNumber (CpuMpData
, ProcessorNumber
);
1657 Retrieves the number of logical processor in the platform and the number of
1658 those logical processors that are enabled on this boot. This service may only
1659 be called from the BSP.
1661 @param[out] NumberOfProcessors Pointer to the total number of logical
1662 processors in the system, including the BSP
1664 @param[out] NumberOfEnabledProcessors Pointer to the number of enabled logical
1665 processors that exist in system, including
1668 @retval EFI_SUCCESS The number of logical processors and enabled
1669 logical processors was retrieved.
1670 @retval EFI_DEVICE_ERROR The calling processor is an AP.
1671 @retval EFI_INVALID_PARAMETER NumberOfProcessors is NULL and NumberOfEnabledProcessors
1673 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1678 MpInitLibGetNumberOfProcessors (
1679 OUT UINTN
*NumberOfProcessors
, OPTIONAL
1680 OUT UINTN
*NumberOfEnabledProcessors OPTIONAL
1683 CPU_MP_DATA
*CpuMpData
;
1685 UINTN ProcessorNumber
;
1686 UINTN EnabledProcessorNumber
;
1689 CpuMpData
= GetCpuMpData ();
1691 if ((NumberOfProcessors
== NULL
) && (NumberOfEnabledProcessors
== NULL
)) {
1692 return EFI_INVALID_PARAMETER
;
1696 // Check whether caller processor is BSP
1698 MpInitLibWhoAmI (&CallerNumber
);
1699 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1700 return EFI_DEVICE_ERROR
;
1703 ProcessorNumber
= CpuMpData
->CpuCount
;
1704 EnabledProcessorNumber
= 0;
1705 for (Index
= 0; Index
< ProcessorNumber
; Index
++) {
1706 if (GetApState (&CpuMpData
->CpuData
[Index
]) != CpuStateDisabled
) {
1707 EnabledProcessorNumber
++;
1711 if (NumberOfProcessors
!= NULL
) {
1712 *NumberOfProcessors
= ProcessorNumber
;
1714 if (NumberOfEnabledProcessors
!= NULL
) {
1715 *NumberOfEnabledProcessors
= EnabledProcessorNumber
;
1723 Worker function to let the caller get one enabled AP to execute a caller-provided
1726 @param[in] Procedure A pointer to the function to be run on
1727 enabled APs of the system.
1728 @param[in] ProcessorNumber The handle number of the AP.
1729 @param[in] WaitEvent The event created by the caller with CreateEvent()
1731 @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for
1732 APs to return from Procedure, either for
1733 blocking or non-blocking mode.
1734 @param[in] ProcedureArgument The parameter passed into Procedure for
1736 @param[out] Finished If AP returns from Procedure before the
1737 timeout expires, its content is set to TRUE.
1738 Otherwise, the value is set to FALSE.
1740 @retval EFI_SUCCESS In blocking mode, specified AP finished before
1741 the timeout expires.
1742 @retval others Failed to Startup AP.
1746 StartupThisAPWorker (
1747 IN EFI_AP_PROCEDURE Procedure
,
1748 IN UINTN ProcessorNumber
,
1749 IN EFI_EVENT WaitEvent OPTIONAL
,
1750 IN UINTN TimeoutInMicroseconds
,
1751 IN VOID
*ProcedureArgument OPTIONAL
,
1752 OUT BOOLEAN
*Finished OPTIONAL
1756 CPU_MP_DATA
*CpuMpData
;
1757 CPU_AP_DATA
*CpuData
;
1760 CpuMpData
= GetCpuMpData ();
1762 if (Finished
!= NULL
) {
1767 // Check whether caller processor is BSP
1769 MpInitLibWhoAmI (&CallerNumber
);
1770 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1771 return EFI_DEVICE_ERROR
;
1775 // Check whether processor with the handle specified by ProcessorNumber exists
1777 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1778 return EFI_NOT_FOUND
;
1782 // Check whether specified processor is BSP
1784 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1785 return EFI_INVALID_PARAMETER
;
1789 // Check parameter Procedure
1791 if (Procedure
== NULL
) {
1792 return EFI_INVALID_PARAMETER
;
1798 CheckAndUpdateApsStatus ();
1801 // Check whether specified AP is disabled
1803 if (GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]) == CpuStateDisabled
) {
1804 return EFI_INVALID_PARAMETER
;
1808 // If WaitEvent is not NULL, execute in non-blocking mode.
1809 // BSP saves data for CheckAPsStatus(), and returns EFI_SUCCESS.
1810 // CheckAPsStatus() will check completion and timeout periodically.
1812 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1813 CpuData
->WaitEvent
= WaitEvent
;
1814 CpuData
->Finished
= Finished
;
1815 CpuData
->ExpectedTime
= CalculateTimeout (TimeoutInMicroseconds
, &CpuData
->CurrentTime
);
1816 CpuData
->TotalTime
= 0;
1818 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, Procedure
, ProcedureArgument
);
1821 // If WaitEvent is NULL, execute in blocking mode.
1822 // BSP checks AP's state until it finishes or TimeoutInMicrosecsond expires.
1824 Status
= EFI_SUCCESS
;
1825 if (WaitEvent
== NULL
) {
1827 Status
= CheckThisAP (ProcessorNumber
);
1828 } while (Status
== EFI_NOT_READY
);
1835 Get pointer to CPU MP Data structure from GUIDed HOB.
1837 @return The pointer to CPU MP Data structure.
1840 GetCpuMpDataFromGuidedHob (
1844 EFI_HOB_GUID_TYPE
*GuidHob
;
1846 CPU_MP_DATA
*CpuMpData
;
1849 GuidHob
= GetFirstGuidHob (&mCpuInitMpLibHobGuid
);
1850 if (GuidHob
!= NULL
) {
1851 DataInHob
= GET_GUID_HOB_DATA (GuidHob
);
1852 CpuMpData
= (CPU_MP_DATA
*) (*(UINTN
*) DataInHob
);