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
,
438 CPU_INFO_IN_HOB
*CpuInfoInHob
;
440 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
441 CpuInfoInHob
[ProcessorNumber
].InitialApicId
= GetInitialApicId ();
442 CpuInfoInHob
[ProcessorNumber
].ApicId
= GetApicId ();
443 CpuInfoInHob
[ProcessorNumber
].Health
= BistData
;
445 CpuMpData
->CpuData
[ProcessorNumber
].Waiting
= FALSE
;
446 CpuMpData
->CpuData
[ProcessorNumber
].CpuHealthy
= (BistData
== 0) ? TRUE
: FALSE
;
447 if (CpuInfoInHob
[ProcessorNumber
].InitialApicId
>= 0xFF) {
449 // Set x2APIC mode if there are any logical processor reporting
450 // an Initial APIC ID of 255 or greater.
452 AcquireSpinLock(&CpuMpData
->MpLock
);
453 CpuMpData
->X2ApicEnable
= TRUE
;
454 ReleaseSpinLock(&CpuMpData
->MpLock
);
457 InitializeSpinLock(&CpuMpData
->CpuData
[ProcessorNumber
].ApLock
);
458 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateIdle
);
462 This function will be called from AP reset code if BSP uses WakeUpAP.
464 @param[in] ExchangeInfo Pointer to the MP exchange info buffer
465 @param[in] NumApsExecuting Number of current executing AP
470 IN MP_CPU_EXCHANGE_INFO
*ExchangeInfo
,
471 IN UINTN NumApsExecuting
474 CPU_MP_DATA
*CpuMpData
;
475 UINTN ProcessorNumber
;
476 EFI_AP_PROCEDURE Procedure
;
479 volatile UINT32
*ApStartupSignalBuffer
;
480 CPU_INFO_IN_HOB
*CpuInfoInHob
;
483 // AP finished assembly code and begin to execute C code
485 CpuMpData
= ExchangeInfo
->CpuMpData
;
487 ProgramVirtualWireMode ();
490 if (CpuMpData
->InitFlag
== ApInitConfig
) {
494 InterlockedIncrement ((UINT32
*) &CpuMpData
->CpuCount
);
495 ProcessorNumber
= NumApsExecuting
;
497 // This is first time AP wakeup, get BIST information from AP stack
499 BistData
= *(UINT32
*) (CpuMpData
->Buffer
+ ProcessorNumber
* CpuMpData
->CpuApStackSize
- sizeof (UINTN
));
501 // Do some AP initialize sync
503 ApInitializeSync (CpuMpData
);
505 // Sync BSP's Control registers to APs
507 RestoreVolatileRegisters (&CpuMpData
->CpuData
[0].VolatileRegisters
, FALSE
);
508 InitializeApData (CpuMpData
, ProcessorNumber
, BistData
);
509 ApStartupSignalBuffer
= CpuMpData
->CpuData
[ProcessorNumber
].StartupApSignal
;
512 // Execute AP function if AP is ready
514 GetProcessorNumber (CpuMpData
, &ProcessorNumber
);
516 // Clear AP start-up signal when AP waken up
518 ApStartupSignalBuffer
= CpuMpData
->CpuData
[ProcessorNumber
].StartupApSignal
;
519 InterlockedCompareExchange32 (
520 (UINT32
*) ApStartupSignalBuffer
,
524 if (CpuMpData
->ApLoopMode
== ApInHltLoop
) {
526 // Restore AP's volatile registers saved
528 RestoreVolatileRegisters (&CpuMpData
->CpuData
[ProcessorNumber
].VolatileRegisters
, TRUE
);
531 if (GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]) == CpuStateReady
) {
532 Procedure
= (EFI_AP_PROCEDURE
)CpuMpData
->CpuData
[ProcessorNumber
].ApFunction
;
533 Parameter
= (VOID
*) CpuMpData
->CpuData
[ProcessorNumber
].ApFunctionArgument
;
534 if (Procedure
!= NULL
) {
535 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateBusy
);
537 // Invoke AP function here
539 Procedure (Parameter
);
540 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
541 if (CpuMpData
->SwitchBspFlag
) {
543 // Re-get the processor number due to BSP/AP maybe exchange in AP function
545 GetProcessorNumber (CpuMpData
, &ProcessorNumber
);
546 CpuMpData
->CpuData
[ProcessorNumber
].ApFunction
= 0;
547 CpuMpData
->CpuData
[ProcessorNumber
].ApFunctionArgument
= 0;
550 // Re-get the CPU APICID and Initial APICID
552 CpuInfoInHob
[ProcessorNumber
].ApicId
= GetApicId ();
553 CpuInfoInHob
[ProcessorNumber
].InitialApicId
= GetInitialApicId ();
556 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateFinished
);
561 // AP finished executing C code
563 InterlockedIncrement ((UINT32
*) &CpuMpData
->FinishedCount
);
566 // Place AP is specified loop mode
568 if (CpuMpData
->ApLoopMode
== ApInHltLoop
) {
570 // Save AP volatile registers
572 SaveVolatileRegisters (&CpuMpData
->CpuData
[ProcessorNumber
].VolatileRegisters
);
574 // Place AP in HLT-loop
577 DisableInterrupts ();
583 DisableInterrupts ();
584 if (CpuMpData
->ApLoopMode
== ApInMwaitLoop
) {
586 // Place AP in MWAIT-loop
588 AsmMonitor ((UINTN
) ApStartupSignalBuffer
, 0, 0);
589 if (*ApStartupSignalBuffer
!= WAKEUP_AP_SIGNAL
) {
591 // Check AP start-up signal again.
592 // If AP start-up signal is not set, place AP into
593 // the specified C-state
595 AsmMwait (CpuMpData
->ApTargetCState
<< 4, 0);
597 } else if (CpuMpData
->ApLoopMode
== ApInRunLoop
) {
599 // Place AP in Run-loop
607 // If AP start-up signal is written, AP is waken up
608 // otherwise place AP in loop again
610 if (*ApStartupSignalBuffer
== WAKEUP_AP_SIGNAL
) {
618 Wait for AP wakeup and write AP start-up signal till AP is waken up.
620 @param[in] ApStartupSignalBuffer Pointer to AP wakeup signal
624 IN
volatile UINT32
*ApStartupSignalBuffer
628 // If AP is waken up, StartupApSignal should be cleared.
629 // Otherwise, write StartupApSignal again till AP waken up.
631 while (InterlockedCompareExchange32 (
632 (UINT32
*) ApStartupSignalBuffer
,
641 This function will fill the exchange info structure.
643 @param[in] CpuMpData Pointer to CPU MP Data
647 FillExchangeInfoData (
648 IN CPU_MP_DATA
*CpuMpData
651 volatile MP_CPU_EXCHANGE_INFO
*ExchangeInfo
;
653 ExchangeInfo
= CpuMpData
->MpCpuExchangeInfo
;
654 ExchangeInfo
->Lock
= 0;
655 ExchangeInfo
->StackStart
= CpuMpData
->Buffer
;
656 ExchangeInfo
->StackSize
= CpuMpData
->CpuApStackSize
;
657 ExchangeInfo
->BufferStart
= CpuMpData
->WakeupBuffer
;
658 ExchangeInfo
->ModeOffset
= CpuMpData
->AddressMap
.ModeEntryOffset
;
660 ExchangeInfo
->CodeSegment
= AsmReadCs ();
661 ExchangeInfo
->DataSegment
= AsmReadDs ();
663 ExchangeInfo
->Cr3
= AsmReadCr3 ();
665 ExchangeInfo
->CFunction
= (UINTN
) ApWakeupFunction
;
666 ExchangeInfo
->NumApsExecuting
= 0;
667 ExchangeInfo
->CpuMpData
= CpuMpData
;
669 ExchangeInfo
->EnableExecuteDisable
= IsBspExecuteDisableEnabled ();
672 // Get the BSP's data of GDT and IDT
674 AsmReadGdtr ((IA32_DESCRIPTOR
*) &ExchangeInfo
->GdtrProfile
);
675 AsmReadIdtr ((IA32_DESCRIPTOR
*) &ExchangeInfo
->IdtrProfile
);
679 This function will be called by BSP to wakeup AP.
681 @param[in] CpuMpData Pointer to CPU MP Data
682 @param[in] Broadcast TRUE: Send broadcast IPI to all APs
683 FALSE: Send IPI to AP by ApicId
684 @param[in] ProcessorNumber The handle number of specified processor
685 @param[in] Procedure The function to be invoked by AP
686 @param[in] ProcedureArgument The argument to be passed into AP function
690 IN CPU_MP_DATA
*CpuMpData
,
691 IN BOOLEAN Broadcast
,
692 IN UINTN ProcessorNumber
,
693 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
694 IN VOID
*ProcedureArgument OPTIONAL
697 volatile MP_CPU_EXCHANGE_INFO
*ExchangeInfo
;
699 CPU_AP_DATA
*CpuData
;
700 BOOLEAN ResetVectorRequired
;
701 CPU_INFO_IN_HOB
*CpuInfoInHob
;
703 CpuMpData
->FinishedCount
= 0;
704 ResetVectorRequired
= FALSE
;
706 if (CpuMpData
->ApLoopMode
== ApInHltLoop
||
707 CpuMpData
->InitFlag
!= ApInitDone
) {
708 ResetVectorRequired
= TRUE
;
709 AllocateResetVector (CpuMpData
);
710 FillExchangeInfoData (CpuMpData
);
711 } else if (CpuMpData
->ApLoopMode
== ApInMwaitLoop
) {
713 // Get AP target C-state each time when waking up AP,
714 // for it maybe updated by platform again
716 CpuMpData
->ApTargetCState
= PcdGet8 (PcdCpuApTargetCstate
);
719 ExchangeInfo
= CpuMpData
->MpCpuExchangeInfo
;
722 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
723 if (Index
!= CpuMpData
->BspNumber
) {
724 CpuData
= &CpuMpData
->CpuData
[Index
];
725 CpuData
->ApFunction
= (UINTN
) Procedure
;
726 CpuData
->ApFunctionArgument
= (UINTN
) ProcedureArgument
;
727 SetApState (CpuData
, CpuStateReady
);
728 if (CpuMpData
->InitFlag
!= ApInitConfig
) {
729 *(UINT32
*) CpuData
->StartupApSignal
= WAKEUP_AP_SIGNAL
;
733 if (ResetVectorRequired
) {
737 SendInitSipiSipiAllExcludingSelf ((UINT32
) ExchangeInfo
->BufferStart
);
739 if (CpuMpData
->InitFlag
== ApInitConfig
) {
741 // Wait for all potential APs waken up in one specified period
743 MicroSecondDelay (PcdGet32(PcdCpuApInitTimeOutInMicroSeconds
));
746 // Wait all APs waken up if this is not the 1st broadcast of SIPI
748 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
749 CpuData
= &CpuMpData
->CpuData
[Index
];
750 if (Index
!= CpuMpData
->BspNumber
) {
751 WaitApWakeup (CpuData
->StartupApSignal
);
756 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
757 CpuData
->ApFunction
= (UINTN
) Procedure
;
758 CpuData
->ApFunctionArgument
= (UINTN
) ProcedureArgument
;
759 SetApState (CpuData
, CpuStateReady
);
761 // Wakeup specified AP
763 ASSERT (CpuMpData
->InitFlag
!= ApInitConfig
);
764 *(UINT32
*) CpuData
->StartupApSignal
= WAKEUP_AP_SIGNAL
;
765 if (ResetVectorRequired
) {
766 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
768 CpuInfoInHob
[ProcessorNumber
].ApicId
,
769 (UINT32
) ExchangeInfo
->BufferStart
773 // Wait specified AP waken up
775 WaitApWakeup (CpuData
->StartupApSignal
);
778 if (ResetVectorRequired
) {
779 FreeResetVector (CpuMpData
);
784 Calculate timeout value and return the current performance counter value.
786 Calculate the number of performance counter ticks required for a timeout.
787 If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
790 @param[in] TimeoutInMicroseconds Timeout value in microseconds.
791 @param[out] CurrentTime Returns the current value of the performance counter.
793 @return Expected time stamp counter for timeout.
794 If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
800 IN UINTN TimeoutInMicroseconds
,
801 OUT UINT64
*CurrentTime
805 // Read the current value of the performance counter
807 *CurrentTime
= GetPerformanceCounter ();
810 // If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
813 if (TimeoutInMicroseconds
== 0) {
818 // GetPerformanceCounterProperties () returns the timestamp counter's frequency
819 // in Hz. So multiply the return value with TimeoutInMicroseconds and then divide
820 // it by 1,000,000, to get the number of ticks for the timeout value.
824 GetPerformanceCounterProperties (NULL
, NULL
),
825 TimeoutInMicroseconds
832 Checks whether timeout expires.
834 Check whether the number of elapsed performance counter ticks required for
835 a timeout condition has been reached.
836 If Timeout is zero, which means infinity, return value is always FALSE.
838 @param[in, out] PreviousTime On input, the value of the performance counter
839 when it was last read.
840 On output, the current value of the performance
842 @param[in] TotalTime The total amount of elapsed time in performance
844 @param[in] Timeout The number of performance counter ticks required
845 to reach a timeout condition.
847 @retval TRUE A timeout condition has been reached.
848 @retval FALSE A timeout condition has not been reached.
853 IN OUT UINT64
*PreviousTime
,
854 IN UINT64
*TotalTime
,
867 GetPerformanceCounterProperties (&Start
, &End
);
873 CurrentTime
= GetPerformanceCounter();
874 Delta
= (INT64
) (CurrentTime
- *PreviousTime
);
882 *PreviousTime
= CurrentTime
;
883 if (*TotalTime
> Timeout
) {
890 Reset an AP to Idle state.
892 Any task being executed by the AP will be aborted and the AP
893 will be waiting for a new task in Wait-For-SIPI state.
895 @param[in] ProcessorNumber The handle number of processor.
898 ResetProcessorToIdleState (
899 IN UINTN ProcessorNumber
902 CPU_MP_DATA
*CpuMpData
;
904 CpuMpData
= GetCpuMpData ();
906 CpuMpData
->InitFlag
= ApInitReconfig
;
907 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, NULL
, NULL
);
908 while (CpuMpData
->FinishedCount
< 1) {
911 CpuMpData
->InitFlag
= ApInitDone
;
913 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateIdle
);
917 Searches for the next waiting AP.
919 Search for the next AP that is put in waiting state by single-threaded StartupAllAPs().
921 @param[out] NextProcessorNumber Pointer to the processor number of the next waiting AP.
923 @retval EFI_SUCCESS The next waiting AP has been found.
924 @retval EFI_NOT_FOUND No waiting AP exists.
928 GetNextWaitingProcessorNumber (
929 OUT UINTN
*NextProcessorNumber
932 UINTN ProcessorNumber
;
933 CPU_MP_DATA
*CpuMpData
;
935 CpuMpData
= GetCpuMpData ();
937 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
938 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
939 *NextProcessorNumber
= ProcessorNumber
;
944 return EFI_NOT_FOUND
;
947 /** Checks status of specified AP.
949 This function checks whether the specified AP has finished the task assigned
950 by StartupThisAP(), and whether timeout expires.
952 @param[in] ProcessorNumber The handle number of processor.
954 @retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().
955 @retval EFI_TIMEOUT The timeout expires.
956 @retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.
960 IN UINTN ProcessorNumber
963 CPU_MP_DATA
*CpuMpData
;
964 CPU_AP_DATA
*CpuData
;
966 CpuMpData
= GetCpuMpData ();
967 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
970 // Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.
971 // Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the
972 // value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.
975 // If the AP finishes for StartupThisAP(), return EFI_SUCCESS.
977 if (GetApState(CpuData
) == CpuStateFinished
) {
978 if (CpuData
->Finished
!= NULL
) {
979 *(CpuData
->Finished
) = TRUE
;
981 SetApState (CpuData
, CpuStateIdle
);
985 // If timeout expires for StartupThisAP(), report timeout.
987 if (CheckTimeout (&CpuData
->CurrentTime
, &CpuData
->TotalTime
, CpuData
->ExpectedTime
)) {
988 if (CpuData
->Finished
!= NULL
) {
989 *(CpuData
->Finished
) = FALSE
;
992 // Reset failed AP to idle state
994 ResetProcessorToIdleState (ProcessorNumber
);
999 return EFI_NOT_READY
;
1003 Checks status of all APs.
1005 This function checks whether all APs have finished task assigned by StartupAllAPs(),
1006 and whether timeout expires.
1008 @retval EFI_SUCCESS All APs have finished task assigned by StartupAllAPs().
1009 @retval EFI_TIMEOUT The timeout expires.
1010 @retval EFI_NOT_READY APs have not finished task and timeout has not expired.
1017 UINTN ProcessorNumber
;
1018 UINTN NextProcessorNumber
;
1021 CPU_MP_DATA
*CpuMpData
;
1022 CPU_AP_DATA
*CpuData
;
1024 CpuMpData
= GetCpuMpData ();
1026 NextProcessorNumber
= 0;
1029 // Go through all APs that are responsible for the StartupAllAPs().
1031 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
1032 if (!CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1036 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1038 // Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.
1039 // Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the
1040 // value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.
1042 if (GetApState(CpuData
) == CpuStateFinished
) {
1043 CpuMpData
->RunningCount
++;
1044 CpuMpData
->CpuData
[ProcessorNumber
].Waiting
= FALSE
;
1045 SetApState(CpuData
, CpuStateIdle
);
1048 // If in Single Thread mode, then search for the next waiting AP for execution.
1050 if (CpuMpData
->SingleThread
) {
1051 Status
= GetNextWaitingProcessorNumber (&NextProcessorNumber
);
1053 if (!EFI_ERROR (Status
)) {
1057 (UINT32
) NextProcessorNumber
,
1058 CpuMpData
->Procedure
,
1059 CpuMpData
->ProcArguments
1067 // If all APs finish, return EFI_SUCCESS.
1069 if (CpuMpData
->RunningCount
== CpuMpData
->StartCount
) {
1074 // If timeout expires, report timeout.
1077 &CpuMpData
->CurrentTime
,
1078 &CpuMpData
->TotalTime
,
1079 CpuMpData
->ExpectedTime
)
1082 // If FailedCpuList is not NULL, record all failed APs in it.
1084 if (CpuMpData
->FailedCpuList
!= NULL
) {
1085 *CpuMpData
->FailedCpuList
=
1086 AllocatePool ((CpuMpData
->StartCount
- CpuMpData
->FinishedCount
+ 1) * sizeof (UINTN
));
1087 ASSERT (*CpuMpData
->FailedCpuList
!= NULL
);
1091 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
1093 // Check whether this processor is responsible for StartupAllAPs().
1095 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1097 // Reset failed APs to idle state
1099 ResetProcessorToIdleState (ProcessorNumber
);
1100 CpuMpData
->CpuData
[ProcessorNumber
].Waiting
= FALSE
;
1101 if (CpuMpData
->FailedCpuList
!= NULL
) {
1102 (*CpuMpData
->FailedCpuList
)[ListIndex
++] = ProcessorNumber
;
1106 if (CpuMpData
->FailedCpuList
!= NULL
) {
1107 (*CpuMpData
->FailedCpuList
)[ListIndex
] = END_OF_CPU_LIST
;
1111 return EFI_NOT_READY
;
1115 MP Initialize Library initialization.
1117 This service will allocate AP reset vector and wakeup all APs to do APs
1120 This service must be invoked before all other MP Initialize Library
1121 service are invoked.
1123 @retval EFI_SUCCESS MP initialization succeeds.
1124 @retval Others MP initialization fails.
1129 MpInitLibInitialize (
1133 CPU_MP_DATA
*OldCpuMpData
;
1134 CPU_INFO_IN_HOB
*CpuInfoInHob
;
1135 UINT32 MaxLogicalProcessorNumber
;
1137 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
1139 UINT32 MonitorFilterSize
;
1142 CPU_MP_DATA
*CpuMpData
;
1144 UINT8
*MonitorBuffer
;
1146 UINTN ApResetVectorSize
;
1147 UINTN BackupBufferAddr
;
1149 OldCpuMpData
= GetCpuMpDataFromGuidedHob ();
1150 if (OldCpuMpData
== NULL
) {
1151 MaxLogicalProcessorNumber
= PcdGet32(PcdCpuMaxLogicalProcessorNumber
);
1153 MaxLogicalProcessorNumber
= OldCpuMpData
->CpuCount
;
1155 ASSERT (MaxLogicalProcessorNumber
!= 0);
1157 AsmGetAddressMap (&AddressMap
);
1158 ApResetVectorSize
= AddressMap
.RendezvousFunnelSize
+ sizeof (MP_CPU_EXCHANGE_INFO
);
1159 ApStackSize
= PcdGet32(PcdCpuApStackSize
);
1160 ApLoopMode
= GetApLoopMode (&MonitorFilterSize
);
1162 BufferSize
= ApStackSize
* MaxLogicalProcessorNumber
;
1163 BufferSize
+= MonitorFilterSize
* MaxLogicalProcessorNumber
;
1164 BufferSize
+= sizeof (CPU_MP_DATA
);
1165 BufferSize
+= ApResetVectorSize
;
1166 BufferSize
+= (sizeof (CPU_AP_DATA
) + sizeof (CPU_INFO_IN_HOB
))* MaxLogicalProcessorNumber
;
1167 MpBuffer
= AllocatePages (EFI_SIZE_TO_PAGES (BufferSize
));
1168 ASSERT (MpBuffer
!= NULL
);
1169 ZeroMem (MpBuffer
, BufferSize
);
1170 Buffer
= (UINTN
) MpBuffer
;
1172 MonitorBuffer
= (UINT8
*) (Buffer
+ ApStackSize
* MaxLogicalProcessorNumber
);
1173 BackupBufferAddr
= (UINTN
) MonitorBuffer
+ MonitorFilterSize
* MaxLogicalProcessorNumber
;
1174 CpuMpData
= (CPU_MP_DATA
*) (BackupBufferAddr
+ ApResetVectorSize
);
1175 CpuMpData
->Buffer
= Buffer
;
1176 CpuMpData
->CpuApStackSize
= ApStackSize
;
1177 CpuMpData
->BackupBuffer
= BackupBufferAddr
;
1178 CpuMpData
->BackupBufferSize
= ApResetVectorSize
;
1179 CpuMpData
->SaveRestoreFlag
= FALSE
;
1180 CpuMpData
->WakeupBuffer
= (UINTN
) -1;
1181 CpuMpData
->CpuCount
= 1;
1182 CpuMpData
->BspNumber
= 0;
1183 CpuMpData
->WaitEvent
= NULL
;
1184 CpuMpData
->SwitchBspFlag
= FALSE
;
1185 CpuMpData
->CpuData
= (CPU_AP_DATA
*) (CpuMpData
+ 1);
1186 CpuMpData
->CpuInfoInHob
= (UINT64
) (UINTN
) (CpuMpData
->CpuData
+ MaxLogicalProcessorNumber
);
1187 InitializeSpinLock(&CpuMpData
->MpLock
);
1189 // Save BSP's Control registers to APs
1191 SaveVolatileRegisters (&CpuMpData
->CpuData
[0].VolatileRegisters
);
1193 // Set BSP basic information
1195 InitializeApData (CpuMpData
, 0, 0);
1197 // Save assembly code information
1199 CopyMem (&CpuMpData
->AddressMap
, &AddressMap
, sizeof (MP_ASSEMBLY_ADDRESS_MAP
));
1201 // Finally set AP loop mode
1203 CpuMpData
->ApLoopMode
= ApLoopMode
;
1204 DEBUG ((DEBUG_INFO
, "AP Loop Mode is %d\n", CpuMpData
->ApLoopMode
));
1206 // Set up APs wakeup signal buffer
1208 for (Index
= 0; Index
< MaxLogicalProcessorNumber
; Index
++) {
1209 CpuMpData
->CpuData
[Index
].StartupApSignal
=
1210 (UINT32
*)(MonitorBuffer
+ MonitorFilterSize
* Index
);
1213 // Load Microcode on BSP
1215 MicrocodeDetect (CpuMpData
);
1217 // Store BSP's MTRR setting
1219 MtrrGetAllMtrrs (&CpuMpData
->MtrrTable
);
1221 if (OldCpuMpData
== NULL
) {
1222 if (MaxLogicalProcessorNumber
> 1) {
1224 // Wakeup all APs and calculate the processor count in system
1226 CollectProcessorCount (CpuMpData
);
1230 // APs have been wakeup before, just get the CPU Information
1233 CpuMpData
->CpuCount
= OldCpuMpData
->CpuCount
;
1234 CpuMpData
->BspNumber
= OldCpuMpData
->BspNumber
;
1235 CpuMpData
->InitFlag
= ApInitReconfig
;
1236 CpuMpData
->CpuInfoInHob
= OldCpuMpData
->CpuInfoInHob
;
1237 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
1238 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
1239 InitializeSpinLock(&CpuMpData
->CpuData
[Index
].ApLock
);
1240 if (CpuInfoInHob
[Index
].InitialApicId
>= 255) {
1241 CpuMpData
->X2ApicEnable
= TRUE
;
1243 CpuMpData
->CpuData
[Index
].CpuHealthy
= (CpuInfoInHob
[Index
].Health
== 0)? TRUE
:FALSE
;
1244 CpuMpData
->CpuData
[Index
].ApFunction
= 0;
1246 &CpuMpData
->CpuData
[Index
].VolatileRegisters
,
1247 &CpuMpData
->CpuData
[0].VolatileRegisters
,
1248 sizeof (CPU_VOLATILE_REGISTERS
)
1251 if (MaxLogicalProcessorNumber
> 1) {
1253 // Wakeup APs to do some AP initialize sync
1255 WakeUpAP (CpuMpData
, TRUE
, 0, ApInitializeSync
, CpuMpData
);
1257 // Wait for all APs finished initialization
1259 while (CpuMpData
->FinishedCount
< (CpuMpData
->CpuCount
- 1)) {
1262 CpuMpData
->InitFlag
= ApInitDone
;
1263 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
1264 SetApState (&CpuMpData
->CpuData
[Index
], CpuStateIdle
);
1270 // Initialize global data for MP support
1272 InitMpGlobalData (CpuMpData
);
1278 Gets detailed MP-related information on the requested processor at the
1279 instant this call is made. This service may only be called from the BSP.
1281 @param[in] ProcessorNumber The handle number of processor.
1282 @param[out] ProcessorInfoBuffer A pointer to the buffer where information for
1283 the requested processor is deposited.
1284 @param[out] HealthData Return processor health data.
1286 @retval EFI_SUCCESS Processor information was returned.
1287 @retval EFI_DEVICE_ERROR The calling processor is an AP.
1288 @retval EFI_INVALID_PARAMETER ProcessorInfoBuffer is NULL.
1289 @retval EFI_NOT_FOUND The processor with the handle specified by
1290 ProcessorNumber does not exist in the platform.
1291 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1296 MpInitLibGetProcessorInfo (
1297 IN UINTN ProcessorNumber
,
1298 OUT EFI_PROCESSOR_INFORMATION
*ProcessorInfoBuffer
,
1299 OUT EFI_HEALTH_FLAGS
*HealthData OPTIONAL
1302 CPU_MP_DATA
*CpuMpData
;
1304 CPU_INFO_IN_HOB
*CpuInfoInHob
;
1306 CpuMpData
= GetCpuMpData ();
1307 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
1310 // Check whether caller processor is BSP
1312 MpInitLibWhoAmI (&CallerNumber
);
1313 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1314 return EFI_DEVICE_ERROR
;
1317 if (ProcessorInfoBuffer
== NULL
) {
1318 return EFI_INVALID_PARAMETER
;
1321 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1322 return EFI_NOT_FOUND
;
1325 ProcessorInfoBuffer
->ProcessorId
= (UINT64
) CpuInfoInHob
[ProcessorNumber
].ApicId
;
1326 ProcessorInfoBuffer
->StatusFlag
= 0;
1327 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1328 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_AS_BSP_BIT
;
1330 if (CpuMpData
->CpuData
[ProcessorNumber
].CpuHealthy
) {
1331 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_HEALTH_STATUS_BIT
;
1333 if (GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]) == CpuStateDisabled
) {
1334 ProcessorInfoBuffer
->StatusFlag
&= ~PROCESSOR_ENABLED_BIT
;
1336 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_ENABLED_BIT
;
1340 // Get processor location information
1342 GetProcessorLocationByApicId (
1343 CpuInfoInHob
[ProcessorNumber
].ApicId
,
1344 &ProcessorInfoBuffer
->Location
.Package
,
1345 &ProcessorInfoBuffer
->Location
.Core
,
1346 &ProcessorInfoBuffer
->Location
.Thread
1349 if (HealthData
!= NULL
) {
1350 HealthData
->Uint32
= CpuInfoInHob
[ProcessorNumber
].Health
;
1357 Worker function to switch the requested AP to be the BSP from that point onward.
1359 @param[in] ProcessorNumber The handle number of AP that is to become the new BSP.
1360 @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an
1361 enabled AP. Otherwise, it will be disabled.
1363 @retval EFI_SUCCESS BSP successfully switched.
1364 @retval others Failed to switch BSP.
1369 IN UINTN ProcessorNumber
,
1370 IN BOOLEAN EnableOldBSP
1373 CPU_MP_DATA
*CpuMpData
;
1376 MSR_IA32_APIC_BASE_REGISTER ApicBaseMsr
;
1378 CpuMpData
= GetCpuMpData ();
1381 // Check whether caller processor is BSP
1383 MpInitLibWhoAmI (&CallerNumber
);
1384 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1388 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1389 return EFI_NOT_FOUND
;
1393 // Check whether specified AP is disabled
1395 State
= GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]);
1396 if (State
== CpuStateDisabled
) {
1397 return EFI_INVALID_PARAMETER
;
1401 // Check whether ProcessorNumber specifies the current BSP
1403 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1404 return EFI_INVALID_PARAMETER
;
1408 // Check whether specified AP is busy
1410 if (State
== CpuStateBusy
) {
1411 return EFI_NOT_READY
;
1414 CpuMpData
->BSPInfo
.State
= CPU_SWITCH_STATE_IDLE
;
1415 CpuMpData
->APInfo
.State
= CPU_SWITCH_STATE_IDLE
;
1416 CpuMpData
->SwitchBspFlag
= TRUE
;
1419 // Clear the BSP bit of MSR_IA32_APIC_BASE
1421 ApicBaseMsr
.Uint64
= AsmReadMsr64 (MSR_IA32_APIC_BASE
);
1422 ApicBaseMsr
.Bits
.BSP
= 0;
1423 AsmWriteMsr64 (MSR_IA32_APIC_BASE
, ApicBaseMsr
.Uint64
);
1426 // Need to wakeUp AP (future BSP).
1428 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, FutureBSPProc
, CpuMpData
);
1430 AsmExchangeRole (&CpuMpData
->BSPInfo
, &CpuMpData
->APInfo
);
1433 // Set the BSP bit of MSR_IA32_APIC_BASE on new BSP
1435 ApicBaseMsr
.Uint64
= AsmReadMsr64 (MSR_IA32_APIC_BASE
);
1436 ApicBaseMsr
.Bits
.BSP
= 1;
1437 AsmWriteMsr64 (MSR_IA32_APIC_BASE
, ApicBaseMsr
.Uint64
);
1440 // Wait for old BSP finished AP task
1442 while (GetApState (&CpuMpData
->CpuData
[CallerNumber
]) != CpuStateFinished
) {
1446 CpuMpData
->SwitchBspFlag
= FALSE
;
1448 // Set old BSP enable state
1450 if (!EnableOldBSP
) {
1451 SetApState (&CpuMpData
->CpuData
[CallerNumber
], CpuStateDisabled
);
1454 // Save new BSP number
1456 CpuMpData
->BspNumber
= (UINT32
) ProcessorNumber
;
1462 Worker function to let the caller enable or disable an AP from this point onward.
1463 This service may only be called from the BSP.
1465 @param[in] ProcessorNumber The handle number of AP.
1466 @param[in] EnableAP Specifies the new state for the processor for
1467 enabled, FALSE for disabled.
1468 @param[in] HealthFlag If not NULL, a pointer to a value that specifies
1469 the new health status of the AP.
1471 @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
1472 @retval others Failed to Enable/Disable AP.
1476 EnableDisableApWorker (
1477 IN UINTN ProcessorNumber
,
1478 IN BOOLEAN EnableAP
,
1479 IN UINT32
*HealthFlag OPTIONAL
1482 CPU_MP_DATA
*CpuMpData
;
1485 CpuMpData
= GetCpuMpData ();
1488 // Check whether caller processor is BSP
1490 MpInitLibWhoAmI (&CallerNumber
);
1491 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1492 return EFI_DEVICE_ERROR
;
1495 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1496 return EFI_INVALID_PARAMETER
;
1499 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1500 return EFI_NOT_FOUND
;
1504 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateDisabled
);
1506 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateIdle
);
1509 if (HealthFlag
!= NULL
) {
1510 CpuMpData
->CpuData
[ProcessorNumber
].CpuHealthy
=
1511 (BOOLEAN
) ((*HealthFlag
& PROCESSOR_HEALTH_STATUS_BIT
) != 0);
1518 This return the handle number for the calling processor. This service may be
1519 called from the BSP and APs.
1521 @param[out] ProcessorNumber Pointer to the handle number of AP.
1522 The range is from 0 to the total number of
1523 logical processors minus 1. The total number of
1524 logical processors can be retrieved by
1525 MpInitLibGetNumberOfProcessors().
1527 @retval EFI_SUCCESS The current processor handle number was returned
1529 @retval EFI_INVALID_PARAMETER ProcessorNumber is NULL.
1530 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1536 OUT UINTN
*ProcessorNumber
1539 CPU_MP_DATA
*CpuMpData
;
1541 if (ProcessorNumber
== NULL
) {
1542 return EFI_INVALID_PARAMETER
;
1545 CpuMpData
= GetCpuMpData ();
1547 return GetProcessorNumber (CpuMpData
, ProcessorNumber
);
1551 Retrieves the number of logical processor in the platform and the number of
1552 those logical processors that are enabled on this boot. This service may only
1553 be called from the BSP.
1555 @param[out] NumberOfProcessors Pointer to the total number of logical
1556 processors in the system, including the BSP
1558 @param[out] NumberOfEnabledProcessors Pointer to the number of enabled logical
1559 processors that exist in system, including
1562 @retval EFI_SUCCESS The number of logical processors and enabled
1563 logical processors was retrieved.
1564 @retval EFI_DEVICE_ERROR The calling processor is an AP.
1565 @retval EFI_INVALID_PARAMETER NumberOfProcessors is NULL and NumberOfEnabledProcessors
1567 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1572 MpInitLibGetNumberOfProcessors (
1573 OUT UINTN
*NumberOfProcessors
, OPTIONAL
1574 OUT UINTN
*NumberOfEnabledProcessors OPTIONAL
1577 CPU_MP_DATA
*CpuMpData
;
1579 UINTN ProcessorNumber
;
1580 UINTN EnabledProcessorNumber
;
1583 CpuMpData
= GetCpuMpData ();
1585 if ((NumberOfProcessors
== NULL
) && (NumberOfEnabledProcessors
== NULL
)) {
1586 return EFI_INVALID_PARAMETER
;
1590 // Check whether caller processor is BSP
1592 MpInitLibWhoAmI (&CallerNumber
);
1593 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1594 return EFI_DEVICE_ERROR
;
1597 ProcessorNumber
= CpuMpData
->CpuCount
;
1598 EnabledProcessorNumber
= 0;
1599 for (Index
= 0; Index
< ProcessorNumber
; Index
++) {
1600 if (GetApState (&CpuMpData
->CpuData
[Index
]) != CpuStateDisabled
) {
1601 EnabledProcessorNumber
++;
1605 if (NumberOfProcessors
!= NULL
) {
1606 *NumberOfProcessors
= ProcessorNumber
;
1608 if (NumberOfEnabledProcessors
!= NULL
) {
1609 *NumberOfEnabledProcessors
= EnabledProcessorNumber
;
1617 Worker function to execute a caller provided function on all enabled APs.
1619 @param[in] Procedure A pointer to the function to be run on
1620 enabled APs of the system.
1621 @param[in] SingleThread If TRUE, then all the enabled APs execute
1622 the function specified by Procedure one by
1623 one, in ascending order of processor handle
1624 number. If FALSE, then all the enabled APs
1625 execute the function specified by Procedure
1627 @param[in] WaitEvent The event created by the caller with CreateEvent()
1629 @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for
1630 APs to return from Procedure, either for
1631 blocking or non-blocking mode.
1632 @param[in] ProcedureArgument The parameter passed into Procedure for
1634 @param[out] FailedCpuList If all APs finish successfully, then its
1635 content is set to NULL. If not all APs
1636 finish before timeout expires, then its
1637 content is set to address of the buffer
1638 holding handle numbers of the failed APs.
1640 @retval EFI_SUCCESS In blocking mode, all APs have finished before
1641 the timeout expired.
1642 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched
1644 @retval others Failed to Startup all APs.
1648 StartupAllAPsWorker (
1649 IN EFI_AP_PROCEDURE Procedure
,
1650 IN BOOLEAN SingleThread
,
1651 IN EFI_EVENT WaitEvent OPTIONAL
,
1652 IN UINTN TimeoutInMicroseconds
,
1653 IN VOID
*ProcedureArgument OPTIONAL
,
1654 OUT UINTN
**FailedCpuList OPTIONAL
1658 CPU_MP_DATA
*CpuMpData
;
1659 UINTN ProcessorCount
;
1660 UINTN ProcessorNumber
;
1662 CPU_AP_DATA
*CpuData
;
1663 BOOLEAN HasEnabledAp
;
1666 CpuMpData
= GetCpuMpData ();
1668 if (FailedCpuList
!= NULL
) {
1669 *FailedCpuList
= NULL
;
1672 if (CpuMpData
->CpuCount
== 1) {
1673 return EFI_NOT_STARTED
;
1676 if (Procedure
== NULL
) {
1677 return EFI_INVALID_PARAMETER
;
1681 // Check whether caller processor is BSP
1683 MpInitLibWhoAmI (&CallerNumber
);
1684 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1685 return EFI_DEVICE_ERROR
;
1691 CheckAndUpdateApsStatus ();
1693 ProcessorCount
= CpuMpData
->CpuCount
;
1694 HasEnabledAp
= FALSE
;
1696 // Check whether all enabled APs are idle.
1697 // If any enabled AP is not idle, return EFI_NOT_READY.
1699 for (ProcessorNumber
= 0; ProcessorNumber
< ProcessorCount
; ProcessorNumber
++) {
1700 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1701 if (ProcessorNumber
!= CpuMpData
->BspNumber
) {
1702 ApState
= GetApState (CpuData
);
1703 if (ApState
!= CpuStateDisabled
) {
1704 HasEnabledAp
= TRUE
;
1705 if (ApState
!= CpuStateIdle
) {
1707 // If any enabled APs are busy, return EFI_NOT_READY.
1709 return EFI_NOT_READY
;
1715 if (!HasEnabledAp
) {
1717 // If no enabled AP exists, return EFI_NOT_STARTED.
1719 return EFI_NOT_STARTED
;
1722 CpuMpData
->StartCount
= 0;
1723 for (ProcessorNumber
= 0; ProcessorNumber
< ProcessorCount
; ProcessorNumber
++) {
1724 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1725 CpuData
->Waiting
= FALSE
;
1726 if (ProcessorNumber
!= CpuMpData
->BspNumber
) {
1727 if (CpuData
->State
== CpuStateIdle
) {
1729 // Mark this processor as responsible for current calling.
1731 CpuData
->Waiting
= TRUE
;
1732 CpuMpData
->StartCount
++;
1737 CpuMpData
->Procedure
= Procedure
;
1738 CpuMpData
->ProcArguments
= ProcedureArgument
;
1739 CpuMpData
->SingleThread
= SingleThread
;
1740 CpuMpData
->FinishedCount
= 0;
1741 CpuMpData
->RunningCount
= 0;
1742 CpuMpData
->FailedCpuList
= FailedCpuList
;
1743 CpuMpData
->ExpectedTime
= CalculateTimeout (
1744 TimeoutInMicroseconds
,
1745 &CpuMpData
->CurrentTime
1747 CpuMpData
->TotalTime
= 0;
1748 CpuMpData
->WaitEvent
= WaitEvent
;
1750 if (!SingleThread
) {
1751 WakeUpAP (CpuMpData
, TRUE
, 0, Procedure
, ProcedureArgument
);
1753 for (ProcessorNumber
= 0; ProcessorNumber
< ProcessorCount
; ProcessorNumber
++) {
1754 if (ProcessorNumber
== CallerNumber
) {
1757 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1758 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, Procedure
, ProcedureArgument
);
1764 Status
= EFI_SUCCESS
;
1765 if (WaitEvent
== NULL
) {
1767 Status
= CheckAllAPs ();
1768 } while (Status
== EFI_NOT_READY
);
1775 Worker function to let the caller get one enabled AP to execute a caller-provided
1778 @param[in] Procedure A pointer to the function to be run on
1779 enabled APs of the system.
1780 @param[in] ProcessorNumber The handle number of the AP.
1781 @param[in] WaitEvent The event created by the caller with CreateEvent()
1783 @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for
1784 APs to return from Procedure, either for
1785 blocking or non-blocking mode.
1786 @param[in] ProcedureArgument The parameter passed into Procedure for
1788 @param[out] Finished If AP returns from Procedure before the
1789 timeout expires, its content is set to TRUE.
1790 Otherwise, the value is set to FALSE.
1792 @retval EFI_SUCCESS In blocking mode, specified AP finished before
1793 the timeout expires.
1794 @retval others Failed to Startup AP.
1798 StartupThisAPWorker (
1799 IN EFI_AP_PROCEDURE Procedure
,
1800 IN UINTN ProcessorNumber
,
1801 IN EFI_EVENT WaitEvent OPTIONAL
,
1802 IN UINTN TimeoutInMicroseconds
,
1803 IN VOID
*ProcedureArgument OPTIONAL
,
1804 OUT BOOLEAN
*Finished OPTIONAL
1808 CPU_MP_DATA
*CpuMpData
;
1809 CPU_AP_DATA
*CpuData
;
1812 CpuMpData
= GetCpuMpData ();
1814 if (Finished
!= NULL
) {
1819 // Check whether caller processor is BSP
1821 MpInitLibWhoAmI (&CallerNumber
);
1822 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1823 return EFI_DEVICE_ERROR
;
1827 // Check whether processor with the handle specified by ProcessorNumber exists
1829 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1830 return EFI_NOT_FOUND
;
1834 // Check whether specified processor is BSP
1836 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1837 return EFI_INVALID_PARAMETER
;
1841 // Check parameter Procedure
1843 if (Procedure
== NULL
) {
1844 return EFI_INVALID_PARAMETER
;
1850 CheckAndUpdateApsStatus ();
1853 // Check whether specified AP is disabled
1855 if (GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]) == CpuStateDisabled
) {
1856 return EFI_INVALID_PARAMETER
;
1860 // If WaitEvent is not NULL, execute in non-blocking mode.
1861 // BSP saves data for CheckAPsStatus(), and returns EFI_SUCCESS.
1862 // CheckAPsStatus() will check completion and timeout periodically.
1864 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1865 CpuData
->WaitEvent
= WaitEvent
;
1866 CpuData
->Finished
= Finished
;
1867 CpuData
->ExpectedTime
= CalculateTimeout (TimeoutInMicroseconds
, &CpuData
->CurrentTime
);
1868 CpuData
->TotalTime
= 0;
1870 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, Procedure
, ProcedureArgument
);
1873 // If WaitEvent is NULL, execute in blocking mode.
1874 // BSP checks AP's state until it finishes or TimeoutInMicrosecsond expires.
1876 Status
= EFI_SUCCESS
;
1877 if (WaitEvent
== NULL
) {
1879 Status
= CheckThisAP (ProcessorNumber
);
1880 } while (Status
== EFI_NOT_READY
);
1887 Get pointer to CPU MP Data structure from GUIDed HOB.
1889 @return The pointer to CPU MP Data structure.
1892 GetCpuMpDataFromGuidedHob (
1896 EFI_HOB_GUID_TYPE
*GuidHob
;
1898 CPU_MP_DATA
*CpuMpData
;
1901 GuidHob
= GetFirstGuidHob (&mCpuInitMpLibHobGuid
);
1902 if (GuidHob
!= NULL
) {
1903 DataInHob
= GET_GUID_HOB_DATA (GuidHob
);
1904 CpuMpData
= (CPU_MP_DATA
*) (*(UINTN
*) DataInHob
);
1910 Get available system memory below 1MB by specified size.
1912 @param[in] CpuMpData The pointer to CPU MP Data structure.
1915 BackupAndPrepareWakeupBuffer(
1916 IN CPU_MP_DATA
*CpuMpData
1920 (VOID
*) CpuMpData
->BackupBuffer
,
1921 (VOID
*) CpuMpData
->WakeupBuffer
,
1922 CpuMpData
->BackupBufferSize
1925 (VOID
*) CpuMpData
->WakeupBuffer
,
1926 (VOID
*) CpuMpData
->AddressMap
.RendezvousFunnelAddress
,
1927 CpuMpData
->AddressMap
.RendezvousFunnelSize
1932 Restore wakeup buffer data.
1934 @param[in] CpuMpData The pointer to CPU MP Data structure.
1937 RestoreWakeupBuffer(
1938 IN CPU_MP_DATA
*CpuMpData
1942 (VOID
*) CpuMpData
->WakeupBuffer
,
1943 (VOID
*) CpuMpData
->BackupBuffer
,
1944 CpuMpData
->BackupBufferSize