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 Worker function for SwitchBSP().
63 Worker function for SwitchBSP(), assigned to the AP which is intended
66 @param[in] Buffer Pointer to CPU MP Data
74 CPU_MP_DATA
*DataInHob
;
76 DataInHob
= (CPU_MP_DATA
*) Buffer
;
77 AsmExchangeRole (&DataInHob
->APInfo
, &DataInHob
->BSPInfo
);
81 Get the Application Processors state.
83 @param[in] CpuData The pointer to CPU_AP_DATA of specified AP
89 IN CPU_AP_DATA
*CpuData
92 return CpuData
->State
;
96 Set the Application Processors state.
98 @param[in] CpuData The pointer to CPU_AP_DATA of specified AP
99 @param[in] State The AP status
103 IN CPU_AP_DATA
*CpuData
,
107 AcquireSpinLock (&CpuData
->ApLock
);
108 CpuData
->State
= State
;
109 ReleaseSpinLock (&CpuData
->ApLock
);
113 Save the volatile registers required to be restored following INIT IPI.
115 @param[out] VolatileRegisters Returns buffer saved the volatile resisters
118 SaveVolatileRegisters (
119 OUT CPU_VOLATILE_REGISTERS
*VolatileRegisters
122 CPUID_VERSION_INFO_EDX VersionInfoEdx
;
124 VolatileRegisters
->Cr0
= AsmReadCr0 ();
125 VolatileRegisters
->Cr3
= AsmReadCr3 ();
126 VolatileRegisters
->Cr4
= AsmReadCr4 ();
128 AsmCpuid (CPUID_VERSION_INFO
, NULL
, NULL
, NULL
, &VersionInfoEdx
.Uint32
);
129 if (VersionInfoEdx
.Bits
.DE
!= 0) {
131 // If processor supports Debugging Extensions feature
132 // by CPUID.[EAX=01H]:EDX.BIT2
134 VolatileRegisters
->Dr0
= AsmReadDr0 ();
135 VolatileRegisters
->Dr1
= AsmReadDr1 ();
136 VolatileRegisters
->Dr2
= AsmReadDr2 ();
137 VolatileRegisters
->Dr3
= AsmReadDr3 ();
138 VolatileRegisters
->Dr6
= AsmReadDr6 ();
139 VolatileRegisters
->Dr7
= AsmReadDr7 ();
144 Restore the volatile registers following INIT IPI.
146 @param[in] VolatileRegisters Pointer to volatile resisters
147 @param[in] IsRestoreDr TRUE: Restore DRx if supported
148 FALSE: Do not restore DRx
151 RestoreVolatileRegisters (
152 IN CPU_VOLATILE_REGISTERS
*VolatileRegisters
,
153 IN BOOLEAN IsRestoreDr
156 CPUID_VERSION_INFO_EDX VersionInfoEdx
;
158 AsmWriteCr0 (VolatileRegisters
->Cr0
);
159 AsmWriteCr3 (VolatileRegisters
->Cr3
);
160 AsmWriteCr4 (VolatileRegisters
->Cr4
);
163 AsmCpuid (CPUID_VERSION_INFO
, NULL
, NULL
, NULL
, &VersionInfoEdx
.Uint32
);
164 if (VersionInfoEdx
.Bits
.DE
!= 0) {
166 // If processor supports Debugging Extensions feature
167 // by CPUID.[EAX=01H]:EDX.BIT2
169 AsmWriteDr0 (VolatileRegisters
->Dr0
);
170 AsmWriteDr1 (VolatileRegisters
->Dr1
);
171 AsmWriteDr2 (VolatileRegisters
->Dr2
);
172 AsmWriteDr3 (VolatileRegisters
->Dr3
);
173 AsmWriteDr6 (VolatileRegisters
->Dr6
);
174 AsmWriteDr7 (VolatileRegisters
->Dr7
);
180 Detect whether Mwait-monitor feature is supported.
182 @retval TRUE Mwait-monitor feature is supported.
183 @retval FALSE Mwait-monitor feature is not supported.
190 CPUID_VERSION_INFO_ECX VersionInfoEcx
;
192 AsmCpuid (CPUID_VERSION_INFO
, NULL
, NULL
, &VersionInfoEcx
.Uint32
, NULL
);
193 return (VersionInfoEcx
.Bits
.MONITOR
== 1) ? TRUE
: FALSE
;
199 @param[out] MonitorFilterSize Returns the largest monitor-line size in bytes.
201 @return The AP loop mode.
205 OUT UINT32
*MonitorFilterSize
209 CPUID_MONITOR_MWAIT_EBX MonitorMwaitEbx
;
211 ASSERT (MonitorFilterSize
!= NULL
);
213 ApLoopMode
= PcdGet8 (PcdCpuApLoopMode
);
214 ASSERT (ApLoopMode
>= ApInHltLoop
&& ApLoopMode
<= ApInRunLoop
);
215 if (ApLoopMode
== ApInMwaitLoop
) {
216 if (!IsMwaitSupport ()) {
218 // If processor does not support MONITOR/MWAIT feature,
219 // force AP in Hlt-loop mode
221 ApLoopMode
= ApInHltLoop
;
225 if (ApLoopMode
!= ApInMwaitLoop
) {
226 *MonitorFilterSize
= sizeof (UINT32
);
229 // CPUID.[EAX=05H]:EBX.BIT0-15: Largest monitor-line size in bytes
230 // CPUID.[EAX=05H].EDX: C-states supported using MWAIT
232 AsmCpuid (CPUID_MONITOR_MWAIT
, NULL
, &MonitorMwaitEbx
.Uint32
, NULL
, NULL
);
233 *MonitorFilterSize
= MonitorMwaitEbx
.Bits
.LargestMonitorLineSize
;
240 Sort the APIC ID of all processors.
242 This function sorts the APIC ID of all processors so that processor number is
243 assigned in the ascending order of APIC ID which eases MP debugging.
245 @param[in] CpuMpData Pointer to PEI CPU MP Data
249 IN CPU_MP_DATA
*CpuMpData
256 CPU_INFO_IN_HOB CpuInfo
;
258 CPU_INFO_IN_HOB
*CpuInfoInHob
;
260 ApCount
= CpuMpData
->CpuCount
- 1;
261 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
263 for (Index1
= 0; Index1
< ApCount
; Index1
++) {
266 // Sort key is the hardware default APIC ID
268 ApicId
= CpuInfoInHob
[Index1
].ApicId
;
269 for (Index2
= Index1
+ 1; Index2
<= ApCount
; Index2
++) {
270 if (ApicId
> CpuInfoInHob
[Index2
].ApicId
) {
272 ApicId
= CpuInfoInHob
[Index2
].ApicId
;
275 if (Index3
!= Index1
) {
276 CopyMem (&CpuInfo
, &CpuInfoInHob
[Index3
], sizeof (CPU_INFO_IN_HOB
));
278 &CpuInfoInHob
[Index3
],
279 &CpuInfoInHob
[Index1
],
280 sizeof (CPU_INFO_IN_HOB
)
282 CopyMem (&CpuInfoInHob
[Index1
], &CpuInfo
, sizeof (CPU_INFO_IN_HOB
));
287 // Get the processor number for the BSP
289 ApicId
= GetInitialApicId ();
290 for (Index1
= 0; Index1
< CpuMpData
->CpuCount
; Index1
++) {
291 if (CpuInfoInHob
[Index1
].ApicId
== ApicId
) {
292 CpuMpData
->BspNumber
= (UINT32
) Index1
;
300 Enable x2APIC mode on APs.
302 @param[in, out] Buffer Pointer to private data buffer.
310 SetApicMode (LOCAL_APIC_MODE_X2APIC
);
316 @param[in, out] Buffer Pointer to private data buffer.
324 CPU_MP_DATA
*CpuMpData
;
326 CpuMpData
= (CPU_MP_DATA
*) Buffer
;
328 // Sync BSP's MTRR table to AP
330 MtrrSetAllMtrrs (&CpuMpData
->MtrrTable
);
332 // Load microcode on AP
334 MicrocodeDetect (CpuMpData
);
338 Find the current Processor number by APIC ID.
340 @param[in] CpuMpData Pointer to PEI CPU MP Data
341 @param[in] ProcessorNumber Return the pocessor number found
343 @retval EFI_SUCCESS ProcessorNumber is found and returned.
344 @retval EFI_NOT_FOUND ProcessorNumber is not found.
348 IN CPU_MP_DATA
*CpuMpData
,
349 OUT UINTN
*ProcessorNumber
352 UINTN TotalProcessorNumber
;
354 CPU_INFO_IN_HOB
*CpuInfoInHob
;
356 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
358 TotalProcessorNumber
= CpuMpData
->CpuCount
;
359 for (Index
= 0; Index
< TotalProcessorNumber
; Index
++) {
360 if (CpuInfoInHob
[Index
].ApicId
== GetApicId ()) {
361 *ProcessorNumber
= Index
;
365 return EFI_NOT_FOUND
;
369 This function will get CPU count in the system.
371 @param[in] CpuMpData Pointer to PEI CPU MP Data
373 @return CPU count detected
376 CollectProcessorCount (
377 IN CPU_MP_DATA
*CpuMpData
381 // Send 1st broadcast IPI to APs to wakeup APs
383 CpuMpData
->InitFlag
= ApInitConfig
;
384 CpuMpData
->X2ApicEnable
= FALSE
;
385 WakeUpAP (CpuMpData
, TRUE
, 0, NULL
, NULL
);
386 CpuMpData
->InitFlag
= ApInitDone
;
387 ASSERT (CpuMpData
->CpuCount
<= PcdGet32 (PcdCpuMaxLogicalProcessorNumber
));
389 // Wait for all APs finished the initialization
391 while (CpuMpData
->FinishedCount
< (CpuMpData
->CpuCount
- 1)) {
395 if (CpuMpData
->X2ApicEnable
) {
396 DEBUG ((DEBUG_INFO
, "Force x2APIC mode!\n"));
398 // Wakeup all APs to enable x2APIC mode
400 WakeUpAP (CpuMpData
, TRUE
, 0, ApFuncEnableX2Apic
, NULL
);
402 // Wait for all known APs finished
404 while (CpuMpData
->FinishedCount
< (CpuMpData
->CpuCount
- 1)) {
408 // Enable x2APIC on BSP
410 SetApicMode (LOCAL_APIC_MODE_X2APIC
);
412 DEBUG ((DEBUG_INFO
, "APIC MODE is %d\n", GetApicMode ()));
414 // Sort BSP/Aps by CPU APIC ID in ascending order
416 SortApicId (CpuMpData
);
418 DEBUG ((DEBUG_INFO
, "MpInitLib: Find %d processors in system.\n", CpuMpData
->CpuCount
));
420 return CpuMpData
->CpuCount
;
424 Initialize CPU AP Data when AP is wakeup at the first time.
426 @param[in, out] CpuMpData Pointer to PEI CPU MP Data
427 @param[in] ProcessorNumber The handle number of processor
428 @param[in] BistData Processor BIST data
433 IN OUT CPU_MP_DATA
*CpuMpData
,
434 IN UINTN ProcessorNumber
,
436 IN UINTN ApTopOfStack
439 CPU_INFO_IN_HOB
*CpuInfoInHob
;
441 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
442 CpuInfoInHob
[ProcessorNumber
].InitialApicId
= GetInitialApicId ();
443 CpuInfoInHob
[ProcessorNumber
].ApicId
= GetApicId ();
444 CpuInfoInHob
[ProcessorNumber
].Health
= BistData
;
445 CpuInfoInHob
[ProcessorNumber
].ApTopOfStack
= (UINT32
) ApTopOfStack
;
447 CpuMpData
->CpuData
[ProcessorNumber
].Waiting
= FALSE
;
448 CpuMpData
->CpuData
[ProcessorNumber
].CpuHealthy
= (BistData
== 0) ? TRUE
: FALSE
;
449 if (CpuInfoInHob
[ProcessorNumber
].InitialApicId
>= 0xFF) {
451 // Set x2APIC mode if there are any logical processor reporting
452 // an Initial APIC ID of 255 or greater.
454 AcquireSpinLock(&CpuMpData
->MpLock
);
455 CpuMpData
->X2ApicEnable
= TRUE
;
456 ReleaseSpinLock(&CpuMpData
->MpLock
);
459 InitializeSpinLock(&CpuMpData
->CpuData
[ProcessorNumber
].ApLock
);
460 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateIdle
);
464 This function will be called from AP reset code if BSP uses WakeUpAP.
466 @param[in] ExchangeInfo Pointer to the MP exchange info buffer
467 @param[in] NumApsExecuting Number of current executing AP
472 IN MP_CPU_EXCHANGE_INFO
*ExchangeInfo
,
473 IN UINTN NumApsExecuting
476 CPU_MP_DATA
*CpuMpData
;
477 UINTN ProcessorNumber
;
478 EFI_AP_PROCEDURE Procedure
;
481 volatile UINT32
*ApStartupSignalBuffer
;
482 CPU_INFO_IN_HOB
*CpuInfoInHob
;
486 // AP finished assembly code and begin to execute C code
488 CpuMpData
= ExchangeInfo
->CpuMpData
;
490 ProgramVirtualWireMode ();
493 if (CpuMpData
->InitFlag
== ApInitConfig
) {
497 InterlockedIncrement ((UINT32
*) &CpuMpData
->CpuCount
);
498 ProcessorNumber
= NumApsExecuting
;
500 // This is first time AP wakeup, get BIST information from AP stack
502 ApTopOfStack
= CpuMpData
->Buffer
+ (ProcessorNumber
+ 1) * CpuMpData
->CpuApStackSize
;
503 BistData
= *(UINT32
*) (ApTopOfStack
- sizeof (UINTN
));
505 // Do some AP initialize sync
507 ApInitializeSync (CpuMpData
);
509 // Sync BSP's Control registers to APs
511 RestoreVolatileRegisters (&CpuMpData
->CpuData
[0].VolatileRegisters
, FALSE
);
512 InitializeApData (CpuMpData
, ProcessorNumber
, BistData
, ApTopOfStack
);
513 ApStartupSignalBuffer
= CpuMpData
->CpuData
[ProcessorNumber
].StartupApSignal
;
516 // Execute AP function if AP is ready
518 GetProcessorNumber (CpuMpData
, &ProcessorNumber
);
520 // Clear AP start-up signal when AP waken up
522 ApStartupSignalBuffer
= CpuMpData
->CpuData
[ProcessorNumber
].StartupApSignal
;
523 InterlockedCompareExchange32 (
524 (UINT32
*) ApStartupSignalBuffer
,
528 if (CpuMpData
->ApLoopMode
== ApInHltLoop
) {
530 // Restore AP's volatile registers saved
532 RestoreVolatileRegisters (&CpuMpData
->CpuData
[ProcessorNumber
].VolatileRegisters
, TRUE
);
535 if (GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]) == CpuStateReady
) {
536 Procedure
= (EFI_AP_PROCEDURE
)CpuMpData
->CpuData
[ProcessorNumber
].ApFunction
;
537 Parameter
= (VOID
*) CpuMpData
->CpuData
[ProcessorNumber
].ApFunctionArgument
;
538 if (Procedure
!= NULL
) {
539 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateBusy
);
541 // Invoke AP function here
543 Procedure (Parameter
);
544 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
545 if (CpuMpData
->SwitchBspFlag
) {
547 // Re-get the processor number due to BSP/AP maybe exchange in AP function
549 GetProcessorNumber (CpuMpData
, &ProcessorNumber
);
550 CpuMpData
->CpuData
[ProcessorNumber
].ApFunction
= 0;
551 CpuMpData
->CpuData
[ProcessorNumber
].ApFunctionArgument
= 0;
554 // Re-get the CPU APICID and Initial APICID
556 CpuInfoInHob
[ProcessorNumber
].ApicId
= GetApicId ();
557 CpuInfoInHob
[ProcessorNumber
].InitialApicId
= GetInitialApicId ();
560 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateFinished
);
565 // AP finished executing C code
567 InterlockedIncrement ((UINT32
*) &CpuMpData
->FinishedCount
);
570 // Place AP is specified loop mode
572 if (CpuMpData
->ApLoopMode
== ApInHltLoop
) {
574 // Save AP volatile registers
576 SaveVolatileRegisters (&CpuMpData
->CpuData
[ProcessorNumber
].VolatileRegisters
);
578 // Place AP in HLT-loop
581 DisableInterrupts ();
587 DisableInterrupts ();
588 if (CpuMpData
->ApLoopMode
== ApInMwaitLoop
) {
590 // Place AP in MWAIT-loop
592 AsmMonitor ((UINTN
) ApStartupSignalBuffer
, 0, 0);
593 if (*ApStartupSignalBuffer
!= WAKEUP_AP_SIGNAL
) {
595 // Check AP start-up signal again.
596 // If AP start-up signal is not set, place AP into
597 // the specified C-state
599 AsmMwait (CpuMpData
->ApTargetCState
<< 4, 0);
601 } else if (CpuMpData
->ApLoopMode
== ApInRunLoop
) {
603 // Place AP in Run-loop
611 // If AP start-up signal is written, AP is waken up
612 // otherwise place AP in loop again
614 if (*ApStartupSignalBuffer
== WAKEUP_AP_SIGNAL
) {
622 Wait for AP wakeup and write AP start-up signal till AP is waken up.
624 @param[in] ApStartupSignalBuffer Pointer to AP wakeup signal
628 IN
volatile UINT32
*ApStartupSignalBuffer
632 // If AP is waken up, StartupApSignal should be cleared.
633 // Otherwise, write StartupApSignal again till AP waken up.
635 while (InterlockedCompareExchange32 (
636 (UINT32
*) ApStartupSignalBuffer
,
645 This function will fill the exchange info structure.
647 @param[in] CpuMpData Pointer to CPU MP Data
651 FillExchangeInfoData (
652 IN CPU_MP_DATA
*CpuMpData
655 volatile MP_CPU_EXCHANGE_INFO
*ExchangeInfo
;
657 ExchangeInfo
= CpuMpData
->MpCpuExchangeInfo
;
658 ExchangeInfo
->Lock
= 0;
659 ExchangeInfo
->StackStart
= CpuMpData
->Buffer
;
660 ExchangeInfo
->StackSize
= CpuMpData
->CpuApStackSize
;
661 ExchangeInfo
->BufferStart
= CpuMpData
->WakeupBuffer
;
662 ExchangeInfo
->ModeOffset
= CpuMpData
->AddressMap
.ModeEntryOffset
;
664 ExchangeInfo
->CodeSegment
= AsmReadCs ();
665 ExchangeInfo
->DataSegment
= AsmReadDs ();
667 ExchangeInfo
->Cr3
= AsmReadCr3 ();
669 ExchangeInfo
->CFunction
= (UINTN
) ApWakeupFunction
;
670 ExchangeInfo
->NumApsExecuting
= 0;
671 ExchangeInfo
->InitFlag
= (UINTN
) CpuMpData
->InitFlag
;
672 ExchangeInfo
->CpuInfo
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
673 ExchangeInfo
->CpuMpData
= CpuMpData
;
675 ExchangeInfo
->EnableExecuteDisable
= IsBspExecuteDisableEnabled ();
678 // Get the BSP's data of GDT and IDT
680 AsmReadGdtr ((IA32_DESCRIPTOR
*) &ExchangeInfo
->GdtrProfile
);
681 AsmReadIdtr ((IA32_DESCRIPTOR
*) &ExchangeInfo
->IdtrProfile
);
685 This function will be called by BSP to wakeup AP.
687 @param[in] CpuMpData Pointer to CPU MP Data
688 @param[in] Broadcast TRUE: Send broadcast IPI to all APs
689 FALSE: Send IPI to AP by ApicId
690 @param[in] ProcessorNumber The handle number of specified processor
691 @param[in] Procedure The function to be invoked by AP
692 @param[in] ProcedureArgument The argument to be passed into AP function
696 IN CPU_MP_DATA
*CpuMpData
,
697 IN BOOLEAN Broadcast
,
698 IN UINTN ProcessorNumber
,
699 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
700 IN VOID
*ProcedureArgument OPTIONAL
703 volatile MP_CPU_EXCHANGE_INFO
*ExchangeInfo
;
705 CPU_AP_DATA
*CpuData
;
706 BOOLEAN ResetVectorRequired
;
707 CPU_INFO_IN_HOB
*CpuInfoInHob
;
709 CpuMpData
->FinishedCount
= 0;
710 ResetVectorRequired
= FALSE
;
712 if (CpuMpData
->ApLoopMode
== ApInHltLoop
||
713 CpuMpData
->InitFlag
!= ApInitDone
) {
714 ResetVectorRequired
= TRUE
;
715 AllocateResetVector (CpuMpData
);
716 FillExchangeInfoData (CpuMpData
);
717 } else if (CpuMpData
->ApLoopMode
== ApInMwaitLoop
) {
719 // Get AP target C-state each time when waking up AP,
720 // for it maybe updated by platform again
722 CpuMpData
->ApTargetCState
= PcdGet8 (PcdCpuApTargetCstate
);
725 ExchangeInfo
= CpuMpData
->MpCpuExchangeInfo
;
728 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
729 if (Index
!= CpuMpData
->BspNumber
) {
730 CpuData
= &CpuMpData
->CpuData
[Index
];
731 CpuData
->ApFunction
= (UINTN
) Procedure
;
732 CpuData
->ApFunctionArgument
= (UINTN
) ProcedureArgument
;
733 SetApState (CpuData
, CpuStateReady
);
734 if (CpuMpData
->InitFlag
!= ApInitConfig
) {
735 *(UINT32
*) CpuData
->StartupApSignal
= WAKEUP_AP_SIGNAL
;
739 if (ResetVectorRequired
) {
743 SendInitSipiSipiAllExcludingSelf ((UINT32
) ExchangeInfo
->BufferStart
);
745 if (CpuMpData
->InitFlag
== ApInitConfig
) {
747 // Wait for all potential APs waken up in one specified period
749 MicroSecondDelay (PcdGet32(PcdCpuApInitTimeOutInMicroSeconds
));
752 // Wait all APs waken up if this is not the 1st broadcast of SIPI
754 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
755 CpuData
= &CpuMpData
->CpuData
[Index
];
756 if (Index
!= CpuMpData
->BspNumber
) {
757 WaitApWakeup (CpuData
->StartupApSignal
);
762 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
763 CpuData
->ApFunction
= (UINTN
) Procedure
;
764 CpuData
->ApFunctionArgument
= (UINTN
) ProcedureArgument
;
765 SetApState (CpuData
, CpuStateReady
);
767 // Wakeup specified AP
769 ASSERT (CpuMpData
->InitFlag
!= ApInitConfig
);
770 *(UINT32
*) CpuData
->StartupApSignal
= WAKEUP_AP_SIGNAL
;
771 if (ResetVectorRequired
) {
772 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
774 CpuInfoInHob
[ProcessorNumber
].ApicId
,
775 (UINT32
) ExchangeInfo
->BufferStart
779 // Wait specified AP waken up
781 WaitApWakeup (CpuData
->StartupApSignal
);
784 if (ResetVectorRequired
) {
785 FreeResetVector (CpuMpData
);
790 Calculate timeout value and return the current performance counter value.
792 Calculate the number of performance counter ticks required for a timeout.
793 If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
796 @param[in] TimeoutInMicroseconds Timeout value in microseconds.
797 @param[out] CurrentTime Returns the current value of the performance counter.
799 @return Expected time stamp counter for timeout.
800 If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
806 IN UINTN TimeoutInMicroseconds
,
807 OUT UINT64
*CurrentTime
811 // Read the current value of the performance counter
813 *CurrentTime
= GetPerformanceCounter ();
816 // If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
819 if (TimeoutInMicroseconds
== 0) {
824 // GetPerformanceCounterProperties () returns the timestamp counter's frequency
825 // in Hz. So multiply the return value with TimeoutInMicroseconds and then divide
826 // it by 1,000,000, to get the number of ticks for the timeout value.
830 GetPerformanceCounterProperties (NULL
, NULL
),
831 TimeoutInMicroseconds
838 Checks whether timeout expires.
840 Check whether the number of elapsed performance counter ticks required for
841 a timeout condition has been reached.
842 If Timeout is zero, which means infinity, return value is always FALSE.
844 @param[in, out] PreviousTime On input, the value of the performance counter
845 when it was last read.
846 On output, the current value of the performance
848 @param[in] TotalTime The total amount of elapsed time in performance
850 @param[in] Timeout The number of performance counter ticks required
851 to reach a timeout condition.
853 @retval TRUE A timeout condition has been reached.
854 @retval FALSE A timeout condition has not been reached.
859 IN OUT UINT64
*PreviousTime
,
860 IN UINT64
*TotalTime
,
873 GetPerformanceCounterProperties (&Start
, &End
);
879 CurrentTime
= GetPerformanceCounter();
880 Delta
= (INT64
) (CurrentTime
- *PreviousTime
);
888 *PreviousTime
= CurrentTime
;
889 if (*TotalTime
> Timeout
) {
896 Reset an AP to Idle state.
898 Any task being executed by the AP will be aborted and the AP
899 will be waiting for a new task in Wait-For-SIPI state.
901 @param[in] ProcessorNumber The handle number of processor.
904 ResetProcessorToIdleState (
905 IN UINTN ProcessorNumber
908 CPU_MP_DATA
*CpuMpData
;
910 CpuMpData
= GetCpuMpData ();
912 CpuMpData
->InitFlag
= ApInitReconfig
;
913 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, NULL
, NULL
);
914 while (CpuMpData
->FinishedCount
< 1) {
917 CpuMpData
->InitFlag
= ApInitDone
;
919 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateIdle
);
923 Searches for the next waiting AP.
925 Search for the next AP that is put in waiting state by single-threaded StartupAllAPs().
927 @param[out] NextProcessorNumber Pointer to the processor number of the next waiting AP.
929 @retval EFI_SUCCESS The next waiting AP has been found.
930 @retval EFI_NOT_FOUND No waiting AP exists.
934 GetNextWaitingProcessorNumber (
935 OUT UINTN
*NextProcessorNumber
938 UINTN ProcessorNumber
;
939 CPU_MP_DATA
*CpuMpData
;
941 CpuMpData
= GetCpuMpData ();
943 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
944 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
945 *NextProcessorNumber
= ProcessorNumber
;
950 return EFI_NOT_FOUND
;
953 /** Checks status of specified AP.
955 This function checks whether the specified AP has finished the task assigned
956 by StartupThisAP(), and whether timeout expires.
958 @param[in] ProcessorNumber The handle number of processor.
960 @retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().
961 @retval EFI_TIMEOUT The timeout expires.
962 @retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.
966 IN UINTN ProcessorNumber
969 CPU_MP_DATA
*CpuMpData
;
970 CPU_AP_DATA
*CpuData
;
972 CpuMpData
= GetCpuMpData ();
973 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
976 // Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.
977 // Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the
978 // value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.
981 // If the AP finishes for StartupThisAP(), return EFI_SUCCESS.
983 if (GetApState(CpuData
) == CpuStateFinished
) {
984 if (CpuData
->Finished
!= NULL
) {
985 *(CpuData
->Finished
) = TRUE
;
987 SetApState (CpuData
, CpuStateIdle
);
991 // If timeout expires for StartupThisAP(), report timeout.
993 if (CheckTimeout (&CpuData
->CurrentTime
, &CpuData
->TotalTime
, CpuData
->ExpectedTime
)) {
994 if (CpuData
->Finished
!= NULL
) {
995 *(CpuData
->Finished
) = FALSE
;
998 // Reset failed AP to idle state
1000 ResetProcessorToIdleState (ProcessorNumber
);
1005 return EFI_NOT_READY
;
1009 Checks status of all APs.
1011 This function checks whether all APs have finished task assigned by StartupAllAPs(),
1012 and whether timeout expires.
1014 @retval EFI_SUCCESS All APs have finished task assigned by StartupAllAPs().
1015 @retval EFI_TIMEOUT The timeout expires.
1016 @retval EFI_NOT_READY APs have not finished task and timeout has not expired.
1023 UINTN ProcessorNumber
;
1024 UINTN NextProcessorNumber
;
1027 CPU_MP_DATA
*CpuMpData
;
1028 CPU_AP_DATA
*CpuData
;
1030 CpuMpData
= GetCpuMpData ();
1032 NextProcessorNumber
= 0;
1035 // Go through all APs that are responsible for the StartupAllAPs().
1037 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
1038 if (!CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1042 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1044 // Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.
1045 // Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the
1046 // value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.
1048 if (GetApState(CpuData
) == CpuStateFinished
) {
1049 CpuMpData
->RunningCount
++;
1050 CpuMpData
->CpuData
[ProcessorNumber
].Waiting
= FALSE
;
1051 SetApState(CpuData
, CpuStateIdle
);
1054 // If in Single Thread mode, then search for the next waiting AP for execution.
1056 if (CpuMpData
->SingleThread
) {
1057 Status
= GetNextWaitingProcessorNumber (&NextProcessorNumber
);
1059 if (!EFI_ERROR (Status
)) {
1063 (UINT32
) NextProcessorNumber
,
1064 CpuMpData
->Procedure
,
1065 CpuMpData
->ProcArguments
1073 // If all APs finish, return EFI_SUCCESS.
1075 if (CpuMpData
->RunningCount
== CpuMpData
->StartCount
) {
1080 // If timeout expires, report timeout.
1083 &CpuMpData
->CurrentTime
,
1084 &CpuMpData
->TotalTime
,
1085 CpuMpData
->ExpectedTime
)
1088 // If FailedCpuList is not NULL, record all failed APs in it.
1090 if (CpuMpData
->FailedCpuList
!= NULL
) {
1091 *CpuMpData
->FailedCpuList
=
1092 AllocatePool ((CpuMpData
->StartCount
- CpuMpData
->FinishedCount
+ 1) * sizeof (UINTN
));
1093 ASSERT (*CpuMpData
->FailedCpuList
!= NULL
);
1097 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
1099 // Check whether this processor is responsible for StartupAllAPs().
1101 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1103 // Reset failed APs to idle state
1105 ResetProcessorToIdleState (ProcessorNumber
);
1106 CpuMpData
->CpuData
[ProcessorNumber
].Waiting
= FALSE
;
1107 if (CpuMpData
->FailedCpuList
!= NULL
) {
1108 (*CpuMpData
->FailedCpuList
)[ListIndex
++] = ProcessorNumber
;
1112 if (CpuMpData
->FailedCpuList
!= NULL
) {
1113 (*CpuMpData
->FailedCpuList
)[ListIndex
] = END_OF_CPU_LIST
;
1117 return EFI_NOT_READY
;
1121 MP Initialize Library initialization.
1123 This service will allocate AP reset vector and wakeup all APs to do APs
1126 This service must be invoked before all other MP Initialize Library
1127 service are invoked.
1129 @retval EFI_SUCCESS MP initialization succeeds.
1130 @retval Others MP initialization fails.
1135 MpInitLibInitialize (
1139 CPU_MP_DATA
*OldCpuMpData
;
1140 CPU_INFO_IN_HOB
*CpuInfoInHob
;
1141 UINT32 MaxLogicalProcessorNumber
;
1143 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
1145 UINT32 MonitorFilterSize
;
1148 CPU_MP_DATA
*CpuMpData
;
1150 UINT8
*MonitorBuffer
;
1152 UINTN ApResetVectorSize
;
1153 UINTN BackupBufferAddr
;
1155 OldCpuMpData
= GetCpuMpDataFromGuidedHob ();
1156 if (OldCpuMpData
== NULL
) {
1157 MaxLogicalProcessorNumber
= PcdGet32(PcdCpuMaxLogicalProcessorNumber
);
1159 MaxLogicalProcessorNumber
= OldCpuMpData
->CpuCount
;
1161 ASSERT (MaxLogicalProcessorNumber
!= 0);
1163 AsmGetAddressMap (&AddressMap
);
1164 ApResetVectorSize
= AddressMap
.RendezvousFunnelSize
+ sizeof (MP_CPU_EXCHANGE_INFO
);
1165 ApStackSize
= PcdGet32(PcdCpuApStackSize
);
1166 ApLoopMode
= GetApLoopMode (&MonitorFilterSize
);
1168 BufferSize
= ApStackSize
* MaxLogicalProcessorNumber
;
1169 BufferSize
+= MonitorFilterSize
* MaxLogicalProcessorNumber
;
1170 BufferSize
+= sizeof (CPU_MP_DATA
);
1171 BufferSize
+= ApResetVectorSize
;
1172 BufferSize
+= (sizeof (CPU_AP_DATA
) + sizeof (CPU_INFO_IN_HOB
))* MaxLogicalProcessorNumber
;
1173 MpBuffer
= AllocatePages (EFI_SIZE_TO_PAGES (BufferSize
));
1174 ASSERT (MpBuffer
!= NULL
);
1175 ZeroMem (MpBuffer
, BufferSize
);
1176 Buffer
= (UINTN
) MpBuffer
;
1178 MonitorBuffer
= (UINT8
*) (Buffer
+ ApStackSize
* MaxLogicalProcessorNumber
);
1179 BackupBufferAddr
= (UINTN
) MonitorBuffer
+ MonitorFilterSize
* MaxLogicalProcessorNumber
;
1180 CpuMpData
= (CPU_MP_DATA
*) (BackupBufferAddr
+ ApResetVectorSize
);
1181 CpuMpData
->Buffer
= Buffer
;
1182 CpuMpData
->CpuApStackSize
= ApStackSize
;
1183 CpuMpData
->BackupBuffer
= BackupBufferAddr
;
1184 CpuMpData
->BackupBufferSize
= ApResetVectorSize
;
1185 CpuMpData
->SaveRestoreFlag
= FALSE
;
1186 CpuMpData
->WakeupBuffer
= (UINTN
) -1;
1187 CpuMpData
->CpuCount
= 1;
1188 CpuMpData
->BspNumber
= 0;
1189 CpuMpData
->WaitEvent
= NULL
;
1190 CpuMpData
->SwitchBspFlag
= FALSE
;
1191 CpuMpData
->CpuData
= (CPU_AP_DATA
*) (CpuMpData
+ 1);
1192 CpuMpData
->CpuInfoInHob
= (UINT64
) (UINTN
) (CpuMpData
->CpuData
+ MaxLogicalProcessorNumber
);
1193 InitializeSpinLock(&CpuMpData
->MpLock
);
1195 // Save BSP's Control registers to APs
1197 SaveVolatileRegisters (&CpuMpData
->CpuData
[0].VolatileRegisters
);
1199 // Set BSP basic information
1201 InitializeApData (CpuMpData
, 0, 0, CpuMpData
->Buffer
);
1203 // Save assembly code information
1205 CopyMem (&CpuMpData
->AddressMap
, &AddressMap
, sizeof (MP_ASSEMBLY_ADDRESS_MAP
));
1207 // Finally set AP loop mode
1209 CpuMpData
->ApLoopMode
= ApLoopMode
;
1210 DEBUG ((DEBUG_INFO
, "AP Loop Mode is %d\n", CpuMpData
->ApLoopMode
));
1212 // Set up APs wakeup signal buffer
1214 for (Index
= 0; Index
< MaxLogicalProcessorNumber
; Index
++) {
1215 CpuMpData
->CpuData
[Index
].StartupApSignal
=
1216 (UINT32
*)(MonitorBuffer
+ MonitorFilterSize
* Index
);
1219 // Load Microcode on BSP
1221 MicrocodeDetect (CpuMpData
);
1223 // Store BSP's MTRR setting
1225 MtrrGetAllMtrrs (&CpuMpData
->MtrrTable
);
1227 if (OldCpuMpData
== NULL
) {
1228 if (MaxLogicalProcessorNumber
> 1) {
1230 // Wakeup all APs and calculate the processor count in system
1232 CollectProcessorCount (CpuMpData
);
1236 // APs have been wakeup before, just get the CPU Information
1239 CpuMpData
->CpuCount
= OldCpuMpData
->CpuCount
;
1240 CpuMpData
->BspNumber
= OldCpuMpData
->BspNumber
;
1241 CpuMpData
->InitFlag
= ApInitReconfig
;
1242 CpuMpData
->CpuInfoInHob
= OldCpuMpData
->CpuInfoInHob
;
1243 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
1244 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
1245 InitializeSpinLock(&CpuMpData
->CpuData
[Index
].ApLock
);
1246 if (CpuInfoInHob
[Index
].InitialApicId
>= 255) {
1247 CpuMpData
->X2ApicEnable
= TRUE
;
1249 CpuMpData
->CpuData
[Index
].CpuHealthy
= (CpuInfoInHob
[Index
].Health
== 0)? TRUE
:FALSE
;
1250 CpuMpData
->CpuData
[Index
].ApFunction
= 0;
1252 &CpuMpData
->CpuData
[Index
].VolatileRegisters
,
1253 &CpuMpData
->CpuData
[0].VolatileRegisters
,
1254 sizeof (CPU_VOLATILE_REGISTERS
)
1257 if (MaxLogicalProcessorNumber
> 1) {
1259 // Wakeup APs to do some AP initialize sync
1261 WakeUpAP (CpuMpData
, TRUE
, 0, ApInitializeSync
, CpuMpData
);
1263 // Wait for all APs finished initialization
1265 while (CpuMpData
->FinishedCount
< (CpuMpData
->CpuCount
- 1)) {
1268 CpuMpData
->InitFlag
= ApInitDone
;
1269 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
1270 SetApState (&CpuMpData
->CpuData
[Index
], CpuStateIdle
);
1276 // Initialize global data for MP support
1278 InitMpGlobalData (CpuMpData
);
1284 Gets detailed MP-related information on the requested processor at the
1285 instant this call is made. This service may only be called from the BSP.
1287 @param[in] ProcessorNumber The handle number of processor.
1288 @param[out] ProcessorInfoBuffer A pointer to the buffer where information for
1289 the requested processor is deposited.
1290 @param[out] HealthData Return processor health data.
1292 @retval EFI_SUCCESS Processor information was returned.
1293 @retval EFI_DEVICE_ERROR The calling processor is an AP.
1294 @retval EFI_INVALID_PARAMETER ProcessorInfoBuffer is NULL.
1295 @retval EFI_NOT_FOUND The processor with the handle specified by
1296 ProcessorNumber does not exist in the platform.
1297 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1302 MpInitLibGetProcessorInfo (
1303 IN UINTN ProcessorNumber
,
1304 OUT EFI_PROCESSOR_INFORMATION
*ProcessorInfoBuffer
,
1305 OUT EFI_HEALTH_FLAGS
*HealthData OPTIONAL
1308 CPU_MP_DATA
*CpuMpData
;
1310 CPU_INFO_IN_HOB
*CpuInfoInHob
;
1312 CpuMpData
= GetCpuMpData ();
1313 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
1316 // Check whether caller processor is BSP
1318 MpInitLibWhoAmI (&CallerNumber
);
1319 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1320 return EFI_DEVICE_ERROR
;
1323 if (ProcessorInfoBuffer
== NULL
) {
1324 return EFI_INVALID_PARAMETER
;
1327 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1328 return EFI_NOT_FOUND
;
1331 ProcessorInfoBuffer
->ProcessorId
= (UINT64
) CpuInfoInHob
[ProcessorNumber
].ApicId
;
1332 ProcessorInfoBuffer
->StatusFlag
= 0;
1333 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1334 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_AS_BSP_BIT
;
1336 if (CpuMpData
->CpuData
[ProcessorNumber
].CpuHealthy
) {
1337 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_HEALTH_STATUS_BIT
;
1339 if (GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]) == CpuStateDisabled
) {
1340 ProcessorInfoBuffer
->StatusFlag
&= ~PROCESSOR_ENABLED_BIT
;
1342 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_ENABLED_BIT
;
1346 // Get processor location information
1348 GetProcessorLocationByApicId (
1349 CpuInfoInHob
[ProcessorNumber
].ApicId
,
1350 &ProcessorInfoBuffer
->Location
.Package
,
1351 &ProcessorInfoBuffer
->Location
.Core
,
1352 &ProcessorInfoBuffer
->Location
.Thread
1355 if (HealthData
!= NULL
) {
1356 HealthData
->Uint32
= CpuInfoInHob
[ProcessorNumber
].Health
;
1363 Worker function to switch the requested AP to be the BSP from that point onward.
1365 @param[in] ProcessorNumber The handle number of AP that is to become the new BSP.
1366 @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an
1367 enabled AP. Otherwise, it will be disabled.
1369 @retval EFI_SUCCESS BSP successfully switched.
1370 @retval others Failed to switch BSP.
1375 IN UINTN ProcessorNumber
,
1376 IN BOOLEAN EnableOldBSP
1379 CPU_MP_DATA
*CpuMpData
;
1382 MSR_IA32_APIC_BASE_REGISTER ApicBaseMsr
;
1384 CpuMpData
= GetCpuMpData ();
1387 // Check whether caller processor is BSP
1389 MpInitLibWhoAmI (&CallerNumber
);
1390 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1394 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1395 return EFI_NOT_FOUND
;
1399 // Check whether specified AP is disabled
1401 State
= GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]);
1402 if (State
== CpuStateDisabled
) {
1403 return EFI_INVALID_PARAMETER
;
1407 // Check whether ProcessorNumber specifies the current BSP
1409 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1410 return EFI_INVALID_PARAMETER
;
1414 // Check whether specified AP is busy
1416 if (State
== CpuStateBusy
) {
1417 return EFI_NOT_READY
;
1420 CpuMpData
->BSPInfo
.State
= CPU_SWITCH_STATE_IDLE
;
1421 CpuMpData
->APInfo
.State
= CPU_SWITCH_STATE_IDLE
;
1422 CpuMpData
->SwitchBspFlag
= TRUE
;
1425 // Clear the BSP bit of MSR_IA32_APIC_BASE
1427 ApicBaseMsr
.Uint64
= AsmReadMsr64 (MSR_IA32_APIC_BASE
);
1428 ApicBaseMsr
.Bits
.BSP
= 0;
1429 AsmWriteMsr64 (MSR_IA32_APIC_BASE
, ApicBaseMsr
.Uint64
);
1432 // Need to wakeUp AP (future BSP).
1434 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, FutureBSPProc
, CpuMpData
);
1436 AsmExchangeRole (&CpuMpData
->BSPInfo
, &CpuMpData
->APInfo
);
1439 // Set the BSP bit of MSR_IA32_APIC_BASE on new BSP
1441 ApicBaseMsr
.Uint64
= AsmReadMsr64 (MSR_IA32_APIC_BASE
);
1442 ApicBaseMsr
.Bits
.BSP
= 1;
1443 AsmWriteMsr64 (MSR_IA32_APIC_BASE
, ApicBaseMsr
.Uint64
);
1446 // Wait for old BSP finished AP task
1448 while (GetApState (&CpuMpData
->CpuData
[CallerNumber
]) != CpuStateFinished
) {
1452 CpuMpData
->SwitchBspFlag
= FALSE
;
1454 // Set old BSP enable state
1456 if (!EnableOldBSP
) {
1457 SetApState (&CpuMpData
->CpuData
[CallerNumber
], CpuStateDisabled
);
1460 // Save new BSP number
1462 CpuMpData
->BspNumber
= (UINT32
) ProcessorNumber
;
1468 Worker function to let the caller enable or disable an AP from this point onward.
1469 This service may only be called from the BSP.
1471 @param[in] ProcessorNumber The handle number of AP.
1472 @param[in] EnableAP Specifies the new state for the processor for
1473 enabled, FALSE for disabled.
1474 @param[in] HealthFlag If not NULL, a pointer to a value that specifies
1475 the new health status of the AP.
1477 @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
1478 @retval others Failed to Enable/Disable AP.
1482 EnableDisableApWorker (
1483 IN UINTN ProcessorNumber
,
1484 IN BOOLEAN EnableAP
,
1485 IN UINT32
*HealthFlag OPTIONAL
1488 CPU_MP_DATA
*CpuMpData
;
1491 CpuMpData
= GetCpuMpData ();
1494 // Check whether caller processor is BSP
1496 MpInitLibWhoAmI (&CallerNumber
);
1497 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1498 return EFI_DEVICE_ERROR
;
1501 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1502 return EFI_INVALID_PARAMETER
;
1505 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1506 return EFI_NOT_FOUND
;
1510 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateDisabled
);
1512 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateIdle
);
1515 if (HealthFlag
!= NULL
) {
1516 CpuMpData
->CpuData
[ProcessorNumber
].CpuHealthy
=
1517 (BOOLEAN
) ((*HealthFlag
& PROCESSOR_HEALTH_STATUS_BIT
) != 0);
1524 This return the handle number for the calling processor. This service may be
1525 called from the BSP and APs.
1527 @param[out] ProcessorNumber Pointer to the handle number of AP.
1528 The range is from 0 to the total number of
1529 logical processors minus 1. The total number of
1530 logical processors can be retrieved by
1531 MpInitLibGetNumberOfProcessors().
1533 @retval EFI_SUCCESS The current processor handle number was returned
1535 @retval EFI_INVALID_PARAMETER ProcessorNumber is NULL.
1536 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1542 OUT UINTN
*ProcessorNumber
1545 CPU_MP_DATA
*CpuMpData
;
1547 if (ProcessorNumber
== NULL
) {
1548 return EFI_INVALID_PARAMETER
;
1551 CpuMpData
= GetCpuMpData ();
1553 return GetProcessorNumber (CpuMpData
, ProcessorNumber
);
1557 Retrieves the number of logical processor in the platform and the number of
1558 those logical processors that are enabled on this boot. This service may only
1559 be called from the BSP.
1561 @param[out] NumberOfProcessors Pointer to the total number of logical
1562 processors in the system, including the BSP
1564 @param[out] NumberOfEnabledProcessors Pointer to the number of enabled logical
1565 processors that exist in system, including
1568 @retval EFI_SUCCESS The number of logical processors and enabled
1569 logical processors was retrieved.
1570 @retval EFI_DEVICE_ERROR The calling processor is an AP.
1571 @retval EFI_INVALID_PARAMETER NumberOfProcessors is NULL and NumberOfEnabledProcessors
1573 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1578 MpInitLibGetNumberOfProcessors (
1579 OUT UINTN
*NumberOfProcessors
, OPTIONAL
1580 OUT UINTN
*NumberOfEnabledProcessors OPTIONAL
1583 CPU_MP_DATA
*CpuMpData
;
1585 UINTN ProcessorNumber
;
1586 UINTN EnabledProcessorNumber
;
1589 CpuMpData
= GetCpuMpData ();
1591 if ((NumberOfProcessors
== NULL
) && (NumberOfEnabledProcessors
== NULL
)) {
1592 return EFI_INVALID_PARAMETER
;
1596 // Check whether caller processor is BSP
1598 MpInitLibWhoAmI (&CallerNumber
);
1599 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1600 return EFI_DEVICE_ERROR
;
1603 ProcessorNumber
= CpuMpData
->CpuCount
;
1604 EnabledProcessorNumber
= 0;
1605 for (Index
= 0; Index
< ProcessorNumber
; Index
++) {
1606 if (GetApState (&CpuMpData
->CpuData
[Index
]) != CpuStateDisabled
) {
1607 EnabledProcessorNumber
++;
1611 if (NumberOfProcessors
!= NULL
) {
1612 *NumberOfProcessors
= ProcessorNumber
;
1614 if (NumberOfEnabledProcessors
!= NULL
) {
1615 *NumberOfEnabledProcessors
= EnabledProcessorNumber
;
1623 Worker function to execute a caller provided function on all enabled APs.
1625 @param[in] Procedure A pointer to the function to be run on
1626 enabled APs of the system.
1627 @param[in] SingleThread If TRUE, then all the enabled APs execute
1628 the function specified by Procedure one by
1629 one, in ascending order of processor handle
1630 number. If FALSE, then all the enabled APs
1631 execute the function specified by Procedure
1633 @param[in] WaitEvent The event created by the caller with CreateEvent()
1635 @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for
1636 APs to return from Procedure, either for
1637 blocking or non-blocking mode.
1638 @param[in] ProcedureArgument The parameter passed into Procedure for
1640 @param[out] FailedCpuList If all APs finish successfully, then its
1641 content is set to NULL. If not all APs
1642 finish before timeout expires, then its
1643 content is set to address of the buffer
1644 holding handle numbers of the failed APs.
1646 @retval EFI_SUCCESS In blocking mode, all APs have finished before
1647 the timeout expired.
1648 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched
1650 @retval others Failed to Startup all APs.
1654 StartupAllAPsWorker (
1655 IN EFI_AP_PROCEDURE Procedure
,
1656 IN BOOLEAN SingleThread
,
1657 IN EFI_EVENT WaitEvent OPTIONAL
,
1658 IN UINTN TimeoutInMicroseconds
,
1659 IN VOID
*ProcedureArgument OPTIONAL
,
1660 OUT UINTN
**FailedCpuList OPTIONAL
1664 CPU_MP_DATA
*CpuMpData
;
1665 UINTN ProcessorCount
;
1666 UINTN ProcessorNumber
;
1668 CPU_AP_DATA
*CpuData
;
1669 BOOLEAN HasEnabledAp
;
1672 CpuMpData
= GetCpuMpData ();
1674 if (FailedCpuList
!= NULL
) {
1675 *FailedCpuList
= NULL
;
1678 if (CpuMpData
->CpuCount
== 1) {
1679 return EFI_NOT_STARTED
;
1682 if (Procedure
== NULL
) {
1683 return EFI_INVALID_PARAMETER
;
1687 // Check whether caller processor is BSP
1689 MpInitLibWhoAmI (&CallerNumber
);
1690 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1691 return EFI_DEVICE_ERROR
;
1697 CheckAndUpdateApsStatus ();
1699 ProcessorCount
= CpuMpData
->CpuCount
;
1700 HasEnabledAp
= FALSE
;
1702 // Check whether all enabled APs are idle.
1703 // If any enabled AP is not idle, return EFI_NOT_READY.
1705 for (ProcessorNumber
= 0; ProcessorNumber
< ProcessorCount
; ProcessorNumber
++) {
1706 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1707 if (ProcessorNumber
!= CpuMpData
->BspNumber
) {
1708 ApState
= GetApState (CpuData
);
1709 if (ApState
!= CpuStateDisabled
) {
1710 HasEnabledAp
= TRUE
;
1711 if (ApState
!= CpuStateIdle
) {
1713 // If any enabled APs are busy, return EFI_NOT_READY.
1715 return EFI_NOT_READY
;
1721 if (!HasEnabledAp
) {
1723 // If no enabled AP exists, return EFI_NOT_STARTED.
1725 return EFI_NOT_STARTED
;
1728 CpuMpData
->StartCount
= 0;
1729 for (ProcessorNumber
= 0; ProcessorNumber
< ProcessorCount
; ProcessorNumber
++) {
1730 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1731 CpuData
->Waiting
= FALSE
;
1732 if (ProcessorNumber
!= CpuMpData
->BspNumber
) {
1733 if (CpuData
->State
== CpuStateIdle
) {
1735 // Mark this processor as responsible for current calling.
1737 CpuData
->Waiting
= TRUE
;
1738 CpuMpData
->StartCount
++;
1743 CpuMpData
->Procedure
= Procedure
;
1744 CpuMpData
->ProcArguments
= ProcedureArgument
;
1745 CpuMpData
->SingleThread
= SingleThread
;
1746 CpuMpData
->FinishedCount
= 0;
1747 CpuMpData
->RunningCount
= 0;
1748 CpuMpData
->FailedCpuList
= FailedCpuList
;
1749 CpuMpData
->ExpectedTime
= CalculateTimeout (
1750 TimeoutInMicroseconds
,
1751 &CpuMpData
->CurrentTime
1753 CpuMpData
->TotalTime
= 0;
1754 CpuMpData
->WaitEvent
= WaitEvent
;
1756 if (!SingleThread
) {
1757 WakeUpAP (CpuMpData
, TRUE
, 0, Procedure
, ProcedureArgument
);
1759 for (ProcessorNumber
= 0; ProcessorNumber
< ProcessorCount
; ProcessorNumber
++) {
1760 if (ProcessorNumber
== CallerNumber
) {
1763 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1764 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, Procedure
, ProcedureArgument
);
1770 Status
= EFI_SUCCESS
;
1771 if (WaitEvent
== NULL
) {
1773 Status
= CheckAllAPs ();
1774 } while (Status
== EFI_NOT_READY
);
1781 Worker function to let the caller get one enabled AP to execute a caller-provided
1784 @param[in] Procedure A pointer to the function to be run on
1785 enabled APs of the system.
1786 @param[in] ProcessorNumber The handle number of the AP.
1787 @param[in] WaitEvent The event created by the caller with CreateEvent()
1789 @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for
1790 APs to return from Procedure, either for
1791 blocking or non-blocking mode.
1792 @param[in] ProcedureArgument The parameter passed into Procedure for
1794 @param[out] Finished If AP returns from Procedure before the
1795 timeout expires, its content is set to TRUE.
1796 Otherwise, the value is set to FALSE.
1798 @retval EFI_SUCCESS In blocking mode, specified AP finished before
1799 the timeout expires.
1800 @retval others Failed to Startup AP.
1804 StartupThisAPWorker (
1805 IN EFI_AP_PROCEDURE Procedure
,
1806 IN UINTN ProcessorNumber
,
1807 IN EFI_EVENT WaitEvent OPTIONAL
,
1808 IN UINTN TimeoutInMicroseconds
,
1809 IN VOID
*ProcedureArgument OPTIONAL
,
1810 OUT BOOLEAN
*Finished OPTIONAL
1814 CPU_MP_DATA
*CpuMpData
;
1815 CPU_AP_DATA
*CpuData
;
1818 CpuMpData
= GetCpuMpData ();
1820 if (Finished
!= NULL
) {
1825 // Check whether caller processor is BSP
1827 MpInitLibWhoAmI (&CallerNumber
);
1828 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1829 return EFI_DEVICE_ERROR
;
1833 // Check whether processor with the handle specified by ProcessorNumber exists
1835 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1836 return EFI_NOT_FOUND
;
1840 // Check whether specified processor is BSP
1842 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1843 return EFI_INVALID_PARAMETER
;
1847 // Check parameter Procedure
1849 if (Procedure
== NULL
) {
1850 return EFI_INVALID_PARAMETER
;
1856 CheckAndUpdateApsStatus ();
1859 // Check whether specified AP is disabled
1861 if (GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]) == CpuStateDisabled
) {
1862 return EFI_INVALID_PARAMETER
;
1866 // If WaitEvent is not NULL, execute in non-blocking mode.
1867 // BSP saves data for CheckAPsStatus(), and returns EFI_SUCCESS.
1868 // CheckAPsStatus() will check completion and timeout periodically.
1870 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1871 CpuData
->WaitEvent
= WaitEvent
;
1872 CpuData
->Finished
= Finished
;
1873 CpuData
->ExpectedTime
= CalculateTimeout (TimeoutInMicroseconds
, &CpuData
->CurrentTime
);
1874 CpuData
->TotalTime
= 0;
1876 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, Procedure
, ProcedureArgument
);
1879 // If WaitEvent is NULL, execute in blocking mode.
1880 // BSP checks AP's state until it finishes or TimeoutInMicrosecsond expires.
1882 Status
= EFI_SUCCESS
;
1883 if (WaitEvent
== NULL
) {
1885 Status
= CheckThisAP (ProcessorNumber
);
1886 } while (Status
== EFI_NOT_READY
);
1893 Get pointer to CPU MP Data structure from GUIDed HOB.
1895 @return The pointer to CPU MP Data structure.
1898 GetCpuMpDataFromGuidedHob (
1902 EFI_HOB_GUID_TYPE
*GuidHob
;
1904 CPU_MP_DATA
*CpuMpData
;
1907 GuidHob
= GetFirstGuidHob (&mCpuInitMpLibHobGuid
);
1908 if (GuidHob
!= NULL
) {
1909 DataInHob
= GET_GUID_HOB_DATA (GuidHob
);
1910 CpuMpData
= (CPU_MP_DATA
*) (*(UINTN
*) DataInHob
);
1916 Get available system memory below 1MB by specified size.
1918 @param[in] CpuMpData The pointer to CPU MP Data structure.
1921 BackupAndPrepareWakeupBuffer(
1922 IN CPU_MP_DATA
*CpuMpData
1926 (VOID
*) CpuMpData
->BackupBuffer
,
1927 (VOID
*) CpuMpData
->WakeupBuffer
,
1928 CpuMpData
->BackupBufferSize
1931 (VOID
*) CpuMpData
->WakeupBuffer
,
1932 (VOID
*) CpuMpData
->AddressMap
.RendezvousFunnelAddress
,
1933 CpuMpData
->AddressMap
.RendezvousFunnelSize
1938 Restore wakeup buffer data.
1940 @param[in] CpuMpData The pointer to CPU MP Data structure.
1943 RestoreWakeupBuffer(
1944 IN CPU_MP_DATA
*CpuMpData
1948 (VOID
*) CpuMpData
->WakeupBuffer
,
1949 (VOID
*) CpuMpData
->BackupBuffer
,
1950 CpuMpData
->BackupBufferSize