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
->InitFlag
= (UINTN
) CpuMpData
->InitFlag
;
668 ExchangeInfo
->CpuInfo
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
669 ExchangeInfo
->CpuMpData
= CpuMpData
;
671 ExchangeInfo
->EnableExecuteDisable
= IsBspExecuteDisableEnabled ();
674 // Get the BSP's data of GDT and IDT
676 AsmReadGdtr ((IA32_DESCRIPTOR
*) &ExchangeInfo
->GdtrProfile
);
677 AsmReadIdtr ((IA32_DESCRIPTOR
*) &ExchangeInfo
->IdtrProfile
);
681 This function will be called by BSP to wakeup AP.
683 @param[in] CpuMpData Pointer to CPU MP Data
684 @param[in] Broadcast TRUE: Send broadcast IPI to all APs
685 FALSE: Send IPI to AP by ApicId
686 @param[in] ProcessorNumber The handle number of specified processor
687 @param[in] Procedure The function to be invoked by AP
688 @param[in] ProcedureArgument The argument to be passed into AP function
692 IN CPU_MP_DATA
*CpuMpData
,
693 IN BOOLEAN Broadcast
,
694 IN UINTN ProcessorNumber
,
695 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
696 IN VOID
*ProcedureArgument OPTIONAL
699 volatile MP_CPU_EXCHANGE_INFO
*ExchangeInfo
;
701 CPU_AP_DATA
*CpuData
;
702 BOOLEAN ResetVectorRequired
;
703 CPU_INFO_IN_HOB
*CpuInfoInHob
;
705 CpuMpData
->FinishedCount
= 0;
706 ResetVectorRequired
= FALSE
;
708 if (CpuMpData
->ApLoopMode
== ApInHltLoop
||
709 CpuMpData
->InitFlag
!= ApInitDone
) {
710 ResetVectorRequired
= TRUE
;
711 AllocateResetVector (CpuMpData
);
712 FillExchangeInfoData (CpuMpData
);
713 } else if (CpuMpData
->ApLoopMode
== ApInMwaitLoop
) {
715 // Get AP target C-state each time when waking up AP,
716 // for it maybe updated by platform again
718 CpuMpData
->ApTargetCState
= PcdGet8 (PcdCpuApTargetCstate
);
721 ExchangeInfo
= CpuMpData
->MpCpuExchangeInfo
;
724 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
725 if (Index
!= CpuMpData
->BspNumber
) {
726 CpuData
= &CpuMpData
->CpuData
[Index
];
727 CpuData
->ApFunction
= (UINTN
) Procedure
;
728 CpuData
->ApFunctionArgument
= (UINTN
) ProcedureArgument
;
729 SetApState (CpuData
, CpuStateReady
);
730 if (CpuMpData
->InitFlag
!= ApInitConfig
) {
731 *(UINT32
*) CpuData
->StartupApSignal
= WAKEUP_AP_SIGNAL
;
735 if (ResetVectorRequired
) {
739 SendInitSipiSipiAllExcludingSelf ((UINT32
) ExchangeInfo
->BufferStart
);
741 if (CpuMpData
->InitFlag
== ApInitConfig
) {
743 // Wait for all potential APs waken up in one specified period
745 MicroSecondDelay (PcdGet32(PcdCpuApInitTimeOutInMicroSeconds
));
748 // Wait all APs waken up if this is not the 1st broadcast of SIPI
750 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
751 CpuData
= &CpuMpData
->CpuData
[Index
];
752 if (Index
!= CpuMpData
->BspNumber
) {
753 WaitApWakeup (CpuData
->StartupApSignal
);
758 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
759 CpuData
->ApFunction
= (UINTN
) Procedure
;
760 CpuData
->ApFunctionArgument
= (UINTN
) ProcedureArgument
;
761 SetApState (CpuData
, CpuStateReady
);
763 // Wakeup specified AP
765 ASSERT (CpuMpData
->InitFlag
!= ApInitConfig
);
766 *(UINT32
*) CpuData
->StartupApSignal
= WAKEUP_AP_SIGNAL
;
767 if (ResetVectorRequired
) {
768 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
770 CpuInfoInHob
[ProcessorNumber
].ApicId
,
771 (UINT32
) ExchangeInfo
->BufferStart
775 // Wait specified AP waken up
777 WaitApWakeup (CpuData
->StartupApSignal
);
780 if (ResetVectorRequired
) {
781 FreeResetVector (CpuMpData
);
786 Calculate timeout value and return the current performance counter value.
788 Calculate the number of performance counter ticks required for a timeout.
789 If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
792 @param[in] TimeoutInMicroseconds Timeout value in microseconds.
793 @param[out] CurrentTime Returns the current value of the performance counter.
795 @return Expected time stamp counter for timeout.
796 If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
802 IN UINTN TimeoutInMicroseconds
,
803 OUT UINT64
*CurrentTime
807 // Read the current value of the performance counter
809 *CurrentTime
= GetPerformanceCounter ();
812 // If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
815 if (TimeoutInMicroseconds
== 0) {
820 // GetPerformanceCounterProperties () returns the timestamp counter's frequency
821 // in Hz. So multiply the return value with TimeoutInMicroseconds and then divide
822 // it by 1,000,000, to get the number of ticks for the timeout value.
826 GetPerformanceCounterProperties (NULL
, NULL
),
827 TimeoutInMicroseconds
834 Checks whether timeout expires.
836 Check whether the number of elapsed performance counter ticks required for
837 a timeout condition has been reached.
838 If Timeout is zero, which means infinity, return value is always FALSE.
840 @param[in, out] PreviousTime On input, the value of the performance counter
841 when it was last read.
842 On output, the current value of the performance
844 @param[in] TotalTime The total amount of elapsed time in performance
846 @param[in] Timeout The number of performance counter ticks required
847 to reach a timeout condition.
849 @retval TRUE A timeout condition has been reached.
850 @retval FALSE A timeout condition has not been reached.
855 IN OUT UINT64
*PreviousTime
,
856 IN UINT64
*TotalTime
,
869 GetPerformanceCounterProperties (&Start
, &End
);
875 CurrentTime
= GetPerformanceCounter();
876 Delta
= (INT64
) (CurrentTime
- *PreviousTime
);
884 *PreviousTime
= CurrentTime
;
885 if (*TotalTime
> Timeout
) {
892 Reset an AP to Idle state.
894 Any task being executed by the AP will be aborted and the AP
895 will be waiting for a new task in Wait-For-SIPI state.
897 @param[in] ProcessorNumber The handle number of processor.
900 ResetProcessorToIdleState (
901 IN UINTN ProcessorNumber
904 CPU_MP_DATA
*CpuMpData
;
906 CpuMpData
= GetCpuMpData ();
908 CpuMpData
->InitFlag
= ApInitReconfig
;
909 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, NULL
, NULL
);
910 while (CpuMpData
->FinishedCount
< 1) {
913 CpuMpData
->InitFlag
= ApInitDone
;
915 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateIdle
);
919 Searches for the next waiting AP.
921 Search for the next AP that is put in waiting state by single-threaded StartupAllAPs().
923 @param[out] NextProcessorNumber Pointer to the processor number of the next waiting AP.
925 @retval EFI_SUCCESS The next waiting AP has been found.
926 @retval EFI_NOT_FOUND No waiting AP exists.
930 GetNextWaitingProcessorNumber (
931 OUT UINTN
*NextProcessorNumber
934 UINTN ProcessorNumber
;
935 CPU_MP_DATA
*CpuMpData
;
937 CpuMpData
= GetCpuMpData ();
939 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
940 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
941 *NextProcessorNumber
= ProcessorNumber
;
946 return EFI_NOT_FOUND
;
949 /** Checks status of specified AP.
951 This function checks whether the specified AP has finished the task assigned
952 by StartupThisAP(), and whether timeout expires.
954 @param[in] ProcessorNumber The handle number of processor.
956 @retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().
957 @retval EFI_TIMEOUT The timeout expires.
958 @retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.
962 IN UINTN ProcessorNumber
965 CPU_MP_DATA
*CpuMpData
;
966 CPU_AP_DATA
*CpuData
;
968 CpuMpData
= GetCpuMpData ();
969 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
972 // Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.
973 // Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the
974 // value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.
977 // If the AP finishes for StartupThisAP(), return EFI_SUCCESS.
979 if (GetApState(CpuData
) == CpuStateFinished
) {
980 if (CpuData
->Finished
!= NULL
) {
981 *(CpuData
->Finished
) = TRUE
;
983 SetApState (CpuData
, CpuStateIdle
);
987 // If timeout expires for StartupThisAP(), report timeout.
989 if (CheckTimeout (&CpuData
->CurrentTime
, &CpuData
->TotalTime
, CpuData
->ExpectedTime
)) {
990 if (CpuData
->Finished
!= NULL
) {
991 *(CpuData
->Finished
) = FALSE
;
994 // Reset failed AP to idle state
996 ResetProcessorToIdleState (ProcessorNumber
);
1001 return EFI_NOT_READY
;
1005 Checks status of all APs.
1007 This function checks whether all APs have finished task assigned by StartupAllAPs(),
1008 and whether timeout expires.
1010 @retval EFI_SUCCESS All APs have finished task assigned by StartupAllAPs().
1011 @retval EFI_TIMEOUT The timeout expires.
1012 @retval EFI_NOT_READY APs have not finished task and timeout has not expired.
1019 UINTN ProcessorNumber
;
1020 UINTN NextProcessorNumber
;
1023 CPU_MP_DATA
*CpuMpData
;
1024 CPU_AP_DATA
*CpuData
;
1026 CpuMpData
= GetCpuMpData ();
1028 NextProcessorNumber
= 0;
1031 // Go through all APs that are responsible for the StartupAllAPs().
1033 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
1034 if (!CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1038 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1040 // Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.
1041 // Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the
1042 // value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.
1044 if (GetApState(CpuData
) == CpuStateFinished
) {
1045 CpuMpData
->RunningCount
++;
1046 CpuMpData
->CpuData
[ProcessorNumber
].Waiting
= FALSE
;
1047 SetApState(CpuData
, CpuStateIdle
);
1050 // If in Single Thread mode, then search for the next waiting AP for execution.
1052 if (CpuMpData
->SingleThread
) {
1053 Status
= GetNextWaitingProcessorNumber (&NextProcessorNumber
);
1055 if (!EFI_ERROR (Status
)) {
1059 (UINT32
) NextProcessorNumber
,
1060 CpuMpData
->Procedure
,
1061 CpuMpData
->ProcArguments
1069 // If all APs finish, return EFI_SUCCESS.
1071 if (CpuMpData
->RunningCount
== CpuMpData
->StartCount
) {
1076 // If timeout expires, report timeout.
1079 &CpuMpData
->CurrentTime
,
1080 &CpuMpData
->TotalTime
,
1081 CpuMpData
->ExpectedTime
)
1084 // If FailedCpuList is not NULL, record all failed APs in it.
1086 if (CpuMpData
->FailedCpuList
!= NULL
) {
1087 *CpuMpData
->FailedCpuList
=
1088 AllocatePool ((CpuMpData
->StartCount
- CpuMpData
->FinishedCount
+ 1) * sizeof (UINTN
));
1089 ASSERT (*CpuMpData
->FailedCpuList
!= NULL
);
1093 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
1095 // Check whether this processor is responsible for StartupAllAPs().
1097 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1099 // Reset failed APs to idle state
1101 ResetProcessorToIdleState (ProcessorNumber
);
1102 CpuMpData
->CpuData
[ProcessorNumber
].Waiting
= FALSE
;
1103 if (CpuMpData
->FailedCpuList
!= NULL
) {
1104 (*CpuMpData
->FailedCpuList
)[ListIndex
++] = ProcessorNumber
;
1108 if (CpuMpData
->FailedCpuList
!= NULL
) {
1109 (*CpuMpData
->FailedCpuList
)[ListIndex
] = END_OF_CPU_LIST
;
1113 return EFI_NOT_READY
;
1117 MP Initialize Library initialization.
1119 This service will allocate AP reset vector and wakeup all APs to do APs
1122 This service must be invoked before all other MP Initialize Library
1123 service are invoked.
1125 @retval EFI_SUCCESS MP initialization succeeds.
1126 @retval Others MP initialization fails.
1131 MpInitLibInitialize (
1135 CPU_MP_DATA
*OldCpuMpData
;
1136 CPU_INFO_IN_HOB
*CpuInfoInHob
;
1137 UINT32 MaxLogicalProcessorNumber
;
1139 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
1141 UINT32 MonitorFilterSize
;
1144 CPU_MP_DATA
*CpuMpData
;
1146 UINT8
*MonitorBuffer
;
1148 UINTN ApResetVectorSize
;
1149 UINTN BackupBufferAddr
;
1151 OldCpuMpData
= GetCpuMpDataFromGuidedHob ();
1152 if (OldCpuMpData
== NULL
) {
1153 MaxLogicalProcessorNumber
= PcdGet32(PcdCpuMaxLogicalProcessorNumber
);
1155 MaxLogicalProcessorNumber
= OldCpuMpData
->CpuCount
;
1157 ASSERT (MaxLogicalProcessorNumber
!= 0);
1159 AsmGetAddressMap (&AddressMap
);
1160 ApResetVectorSize
= AddressMap
.RendezvousFunnelSize
+ sizeof (MP_CPU_EXCHANGE_INFO
);
1161 ApStackSize
= PcdGet32(PcdCpuApStackSize
);
1162 ApLoopMode
= GetApLoopMode (&MonitorFilterSize
);
1164 BufferSize
= ApStackSize
* MaxLogicalProcessorNumber
;
1165 BufferSize
+= MonitorFilterSize
* MaxLogicalProcessorNumber
;
1166 BufferSize
+= sizeof (CPU_MP_DATA
);
1167 BufferSize
+= ApResetVectorSize
;
1168 BufferSize
+= (sizeof (CPU_AP_DATA
) + sizeof (CPU_INFO_IN_HOB
))* MaxLogicalProcessorNumber
;
1169 MpBuffer
= AllocatePages (EFI_SIZE_TO_PAGES (BufferSize
));
1170 ASSERT (MpBuffer
!= NULL
);
1171 ZeroMem (MpBuffer
, BufferSize
);
1172 Buffer
= (UINTN
) MpBuffer
;
1174 MonitorBuffer
= (UINT8
*) (Buffer
+ ApStackSize
* MaxLogicalProcessorNumber
);
1175 BackupBufferAddr
= (UINTN
) MonitorBuffer
+ MonitorFilterSize
* MaxLogicalProcessorNumber
;
1176 CpuMpData
= (CPU_MP_DATA
*) (BackupBufferAddr
+ ApResetVectorSize
);
1177 CpuMpData
->Buffer
= Buffer
;
1178 CpuMpData
->CpuApStackSize
= ApStackSize
;
1179 CpuMpData
->BackupBuffer
= BackupBufferAddr
;
1180 CpuMpData
->BackupBufferSize
= ApResetVectorSize
;
1181 CpuMpData
->SaveRestoreFlag
= FALSE
;
1182 CpuMpData
->WakeupBuffer
= (UINTN
) -1;
1183 CpuMpData
->CpuCount
= 1;
1184 CpuMpData
->BspNumber
= 0;
1185 CpuMpData
->WaitEvent
= NULL
;
1186 CpuMpData
->SwitchBspFlag
= FALSE
;
1187 CpuMpData
->CpuData
= (CPU_AP_DATA
*) (CpuMpData
+ 1);
1188 CpuMpData
->CpuInfoInHob
= (UINT64
) (UINTN
) (CpuMpData
->CpuData
+ MaxLogicalProcessorNumber
);
1189 InitializeSpinLock(&CpuMpData
->MpLock
);
1191 // Save BSP's Control registers to APs
1193 SaveVolatileRegisters (&CpuMpData
->CpuData
[0].VolatileRegisters
);
1195 // Set BSP basic information
1197 InitializeApData (CpuMpData
, 0, 0);
1199 // Save assembly code information
1201 CopyMem (&CpuMpData
->AddressMap
, &AddressMap
, sizeof (MP_ASSEMBLY_ADDRESS_MAP
));
1203 // Finally set AP loop mode
1205 CpuMpData
->ApLoopMode
= ApLoopMode
;
1206 DEBUG ((DEBUG_INFO
, "AP Loop Mode is %d\n", CpuMpData
->ApLoopMode
));
1208 // Set up APs wakeup signal buffer
1210 for (Index
= 0; Index
< MaxLogicalProcessorNumber
; Index
++) {
1211 CpuMpData
->CpuData
[Index
].StartupApSignal
=
1212 (UINT32
*)(MonitorBuffer
+ MonitorFilterSize
* Index
);
1215 // Load Microcode on BSP
1217 MicrocodeDetect (CpuMpData
);
1219 // Store BSP's MTRR setting
1221 MtrrGetAllMtrrs (&CpuMpData
->MtrrTable
);
1223 if (OldCpuMpData
== NULL
) {
1224 if (MaxLogicalProcessorNumber
> 1) {
1226 // Wakeup all APs and calculate the processor count in system
1228 CollectProcessorCount (CpuMpData
);
1232 // APs have been wakeup before, just get the CPU Information
1235 CpuMpData
->CpuCount
= OldCpuMpData
->CpuCount
;
1236 CpuMpData
->BspNumber
= OldCpuMpData
->BspNumber
;
1237 CpuMpData
->InitFlag
= ApInitReconfig
;
1238 CpuMpData
->CpuInfoInHob
= OldCpuMpData
->CpuInfoInHob
;
1239 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
1240 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
1241 InitializeSpinLock(&CpuMpData
->CpuData
[Index
].ApLock
);
1242 if (CpuInfoInHob
[Index
].InitialApicId
>= 255) {
1243 CpuMpData
->X2ApicEnable
= TRUE
;
1245 CpuMpData
->CpuData
[Index
].CpuHealthy
= (CpuInfoInHob
[Index
].Health
== 0)? TRUE
:FALSE
;
1246 CpuMpData
->CpuData
[Index
].ApFunction
= 0;
1248 &CpuMpData
->CpuData
[Index
].VolatileRegisters
,
1249 &CpuMpData
->CpuData
[0].VolatileRegisters
,
1250 sizeof (CPU_VOLATILE_REGISTERS
)
1253 if (MaxLogicalProcessorNumber
> 1) {
1255 // Wakeup APs to do some AP initialize sync
1257 WakeUpAP (CpuMpData
, TRUE
, 0, ApInitializeSync
, CpuMpData
);
1259 // Wait for all APs finished initialization
1261 while (CpuMpData
->FinishedCount
< (CpuMpData
->CpuCount
- 1)) {
1264 CpuMpData
->InitFlag
= ApInitDone
;
1265 for (Index
= 0; Index
< CpuMpData
->CpuCount
; Index
++) {
1266 SetApState (&CpuMpData
->CpuData
[Index
], CpuStateIdle
);
1272 // Initialize global data for MP support
1274 InitMpGlobalData (CpuMpData
);
1280 Gets detailed MP-related information on the requested processor at the
1281 instant this call is made. This service may only be called from the BSP.
1283 @param[in] ProcessorNumber The handle number of processor.
1284 @param[out] ProcessorInfoBuffer A pointer to the buffer where information for
1285 the requested processor is deposited.
1286 @param[out] HealthData Return processor health data.
1288 @retval EFI_SUCCESS Processor information was returned.
1289 @retval EFI_DEVICE_ERROR The calling processor is an AP.
1290 @retval EFI_INVALID_PARAMETER ProcessorInfoBuffer is NULL.
1291 @retval EFI_NOT_FOUND The processor with the handle specified by
1292 ProcessorNumber does not exist in the platform.
1293 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1298 MpInitLibGetProcessorInfo (
1299 IN UINTN ProcessorNumber
,
1300 OUT EFI_PROCESSOR_INFORMATION
*ProcessorInfoBuffer
,
1301 OUT EFI_HEALTH_FLAGS
*HealthData OPTIONAL
1304 CPU_MP_DATA
*CpuMpData
;
1306 CPU_INFO_IN_HOB
*CpuInfoInHob
;
1308 CpuMpData
= GetCpuMpData ();
1309 CpuInfoInHob
= (CPU_INFO_IN_HOB
*) (UINTN
) CpuMpData
->CpuInfoInHob
;
1312 // Check whether caller processor is BSP
1314 MpInitLibWhoAmI (&CallerNumber
);
1315 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1316 return EFI_DEVICE_ERROR
;
1319 if (ProcessorInfoBuffer
== NULL
) {
1320 return EFI_INVALID_PARAMETER
;
1323 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1324 return EFI_NOT_FOUND
;
1327 ProcessorInfoBuffer
->ProcessorId
= (UINT64
) CpuInfoInHob
[ProcessorNumber
].ApicId
;
1328 ProcessorInfoBuffer
->StatusFlag
= 0;
1329 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1330 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_AS_BSP_BIT
;
1332 if (CpuMpData
->CpuData
[ProcessorNumber
].CpuHealthy
) {
1333 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_HEALTH_STATUS_BIT
;
1335 if (GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]) == CpuStateDisabled
) {
1336 ProcessorInfoBuffer
->StatusFlag
&= ~PROCESSOR_ENABLED_BIT
;
1338 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_ENABLED_BIT
;
1342 // Get processor location information
1344 GetProcessorLocationByApicId (
1345 CpuInfoInHob
[ProcessorNumber
].ApicId
,
1346 &ProcessorInfoBuffer
->Location
.Package
,
1347 &ProcessorInfoBuffer
->Location
.Core
,
1348 &ProcessorInfoBuffer
->Location
.Thread
1351 if (HealthData
!= NULL
) {
1352 HealthData
->Uint32
= CpuInfoInHob
[ProcessorNumber
].Health
;
1359 Worker function to switch the requested AP to be the BSP from that point onward.
1361 @param[in] ProcessorNumber The handle number of AP that is to become the new BSP.
1362 @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an
1363 enabled AP. Otherwise, it will be disabled.
1365 @retval EFI_SUCCESS BSP successfully switched.
1366 @retval others Failed to switch BSP.
1371 IN UINTN ProcessorNumber
,
1372 IN BOOLEAN EnableOldBSP
1375 CPU_MP_DATA
*CpuMpData
;
1378 MSR_IA32_APIC_BASE_REGISTER ApicBaseMsr
;
1380 CpuMpData
= GetCpuMpData ();
1383 // Check whether caller processor is BSP
1385 MpInitLibWhoAmI (&CallerNumber
);
1386 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1390 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1391 return EFI_NOT_FOUND
;
1395 // Check whether specified AP is disabled
1397 State
= GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]);
1398 if (State
== CpuStateDisabled
) {
1399 return EFI_INVALID_PARAMETER
;
1403 // Check whether ProcessorNumber specifies the current BSP
1405 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1406 return EFI_INVALID_PARAMETER
;
1410 // Check whether specified AP is busy
1412 if (State
== CpuStateBusy
) {
1413 return EFI_NOT_READY
;
1416 CpuMpData
->BSPInfo
.State
= CPU_SWITCH_STATE_IDLE
;
1417 CpuMpData
->APInfo
.State
= CPU_SWITCH_STATE_IDLE
;
1418 CpuMpData
->SwitchBspFlag
= TRUE
;
1421 // Clear the BSP bit of MSR_IA32_APIC_BASE
1423 ApicBaseMsr
.Uint64
= AsmReadMsr64 (MSR_IA32_APIC_BASE
);
1424 ApicBaseMsr
.Bits
.BSP
= 0;
1425 AsmWriteMsr64 (MSR_IA32_APIC_BASE
, ApicBaseMsr
.Uint64
);
1428 // Need to wakeUp AP (future BSP).
1430 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, FutureBSPProc
, CpuMpData
);
1432 AsmExchangeRole (&CpuMpData
->BSPInfo
, &CpuMpData
->APInfo
);
1435 // Set the BSP bit of MSR_IA32_APIC_BASE on new BSP
1437 ApicBaseMsr
.Uint64
= AsmReadMsr64 (MSR_IA32_APIC_BASE
);
1438 ApicBaseMsr
.Bits
.BSP
= 1;
1439 AsmWriteMsr64 (MSR_IA32_APIC_BASE
, ApicBaseMsr
.Uint64
);
1442 // Wait for old BSP finished AP task
1444 while (GetApState (&CpuMpData
->CpuData
[CallerNumber
]) != CpuStateFinished
) {
1448 CpuMpData
->SwitchBspFlag
= FALSE
;
1450 // Set old BSP enable state
1452 if (!EnableOldBSP
) {
1453 SetApState (&CpuMpData
->CpuData
[CallerNumber
], CpuStateDisabled
);
1456 // Save new BSP number
1458 CpuMpData
->BspNumber
= (UINT32
) ProcessorNumber
;
1464 Worker function to let the caller enable or disable an AP from this point onward.
1465 This service may only be called from the BSP.
1467 @param[in] ProcessorNumber The handle number of AP.
1468 @param[in] EnableAP Specifies the new state for the processor for
1469 enabled, FALSE for disabled.
1470 @param[in] HealthFlag If not NULL, a pointer to a value that specifies
1471 the new health status of the AP.
1473 @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
1474 @retval others Failed to Enable/Disable AP.
1478 EnableDisableApWorker (
1479 IN UINTN ProcessorNumber
,
1480 IN BOOLEAN EnableAP
,
1481 IN UINT32
*HealthFlag OPTIONAL
1484 CPU_MP_DATA
*CpuMpData
;
1487 CpuMpData
= GetCpuMpData ();
1490 // Check whether caller processor is BSP
1492 MpInitLibWhoAmI (&CallerNumber
);
1493 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1494 return EFI_DEVICE_ERROR
;
1497 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1498 return EFI_INVALID_PARAMETER
;
1501 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1502 return EFI_NOT_FOUND
;
1506 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateDisabled
);
1508 SetApState (&CpuMpData
->CpuData
[ProcessorNumber
], CpuStateIdle
);
1511 if (HealthFlag
!= NULL
) {
1512 CpuMpData
->CpuData
[ProcessorNumber
].CpuHealthy
=
1513 (BOOLEAN
) ((*HealthFlag
& PROCESSOR_HEALTH_STATUS_BIT
) != 0);
1520 This return the handle number for the calling processor. This service may be
1521 called from the BSP and APs.
1523 @param[out] ProcessorNumber Pointer to the handle number of AP.
1524 The range is from 0 to the total number of
1525 logical processors minus 1. The total number of
1526 logical processors can be retrieved by
1527 MpInitLibGetNumberOfProcessors().
1529 @retval EFI_SUCCESS The current processor handle number was returned
1531 @retval EFI_INVALID_PARAMETER ProcessorNumber is NULL.
1532 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1538 OUT UINTN
*ProcessorNumber
1541 CPU_MP_DATA
*CpuMpData
;
1543 if (ProcessorNumber
== NULL
) {
1544 return EFI_INVALID_PARAMETER
;
1547 CpuMpData
= GetCpuMpData ();
1549 return GetProcessorNumber (CpuMpData
, ProcessorNumber
);
1553 Retrieves the number of logical processor in the platform and the number of
1554 those logical processors that are enabled on this boot. This service may only
1555 be called from the BSP.
1557 @param[out] NumberOfProcessors Pointer to the total number of logical
1558 processors in the system, including the BSP
1560 @param[out] NumberOfEnabledProcessors Pointer to the number of enabled logical
1561 processors that exist in system, including
1564 @retval EFI_SUCCESS The number of logical processors and enabled
1565 logical processors was retrieved.
1566 @retval EFI_DEVICE_ERROR The calling processor is an AP.
1567 @retval EFI_INVALID_PARAMETER NumberOfProcessors is NULL and NumberOfEnabledProcessors
1569 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1574 MpInitLibGetNumberOfProcessors (
1575 OUT UINTN
*NumberOfProcessors
, OPTIONAL
1576 OUT UINTN
*NumberOfEnabledProcessors OPTIONAL
1579 CPU_MP_DATA
*CpuMpData
;
1581 UINTN ProcessorNumber
;
1582 UINTN EnabledProcessorNumber
;
1585 CpuMpData
= GetCpuMpData ();
1587 if ((NumberOfProcessors
== NULL
) && (NumberOfEnabledProcessors
== NULL
)) {
1588 return EFI_INVALID_PARAMETER
;
1592 // Check whether caller processor is BSP
1594 MpInitLibWhoAmI (&CallerNumber
);
1595 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1596 return EFI_DEVICE_ERROR
;
1599 ProcessorNumber
= CpuMpData
->CpuCount
;
1600 EnabledProcessorNumber
= 0;
1601 for (Index
= 0; Index
< ProcessorNumber
; Index
++) {
1602 if (GetApState (&CpuMpData
->CpuData
[Index
]) != CpuStateDisabled
) {
1603 EnabledProcessorNumber
++;
1607 if (NumberOfProcessors
!= NULL
) {
1608 *NumberOfProcessors
= ProcessorNumber
;
1610 if (NumberOfEnabledProcessors
!= NULL
) {
1611 *NumberOfEnabledProcessors
= EnabledProcessorNumber
;
1619 Worker function to execute a caller provided function on all enabled APs.
1621 @param[in] Procedure A pointer to the function to be run on
1622 enabled APs of the system.
1623 @param[in] SingleThread If TRUE, then all the enabled APs execute
1624 the function specified by Procedure one by
1625 one, in ascending order of processor handle
1626 number. If FALSE, then all the enabled APs
1627 execute the function specified by Procedure
1629 @param[in] WaitEvent The event created by the caller with CreateEvent()
1631 @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for
1632 APs to return from Procedure, either for
1633 blocking or non-blocking mode.
1634 @param[in] ProcedureArgument The parameter passed into Procedure for
1636 @param[out] FailedCpuList If all APs finish successfully, then its
1637 content is set to NULL. If not all APs
1638 finish before timeout expires, then its
1639 content is set to address of the buffer
1640 holding handle numbers of the failed APs.
1642 @retval EFI_SUCCESS In blocking mode, all APs have finished before
1643 the timeout expired.
1644 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched
1646 @retval others Failed to Startup all APs.
1650 StartupAllAPsWorker (
1651 IN EFI_AP_PROCEDURE Procedure
,
1652 IN BOOLEAN SingleThread
,
1653 IN EFI_EVENT WaitEvent OPTIONAL
,
1654 IN UINTN TimeoutInMicroseconds
,
1655 IN VOID
*ProcedureArgument OPTIONAL
,
1656 OUT UINTN
**FailedCpuList OPTIONAL
1660 CPU_MP_DATA
*CpuMpData
;
1661 UINTN ProcessorCount
;
1662 UINTN ProcessorNumber
;
1664 CPU_AP_DATA
*CpuData
;
1665 BOOLEAN HasEnabledAp
;
1668 CpuMpData
= GetCpuMpData ();
1670 if (FailedCpuList
!= NULL
) {
1671 *FailedCpuList
= NULL
;
1674 if (CpuMpData
->CpuCount
== 1) {
1675 return EFI_NOT_STARTED
;
1678 if (Procedure
== NULL
) {
1679 return EFI_INVALID_PARAMETER
;
1683 // Check whether caller processor is BSP
1685 MpInitLibWhoAmI (&CallerNumber
);
1686 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1687 return EFI_DEVICE_ERROR
;
1693 CheckAndUpdateApsStatus ();
1695 ProcessorCount
= CpuMpData
->CpuCount
;
1696 HasEnabledAp
= FALSE
;
1698 // Check whether all enabled APs are idle.
1699 // If any enabled AP is not idle, return EFI_NOT_READY.
1701 for (ProcessorNumber
= 0; ProcessorNumber
< ProcessorCount
; ProcessorNumber
++) {
1702 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1703 if (ProcessorNumber
!= CpuMpData
->BspNumber
) {
1704 ApState
= GetApState (CpuData
);
1705 if (ApState
!= CpuStateDisabled
) {
1706 HasEnabledAp
= TRUE
;
1707 if (ApState
!= CpuStateIdle
) {
1709 // If any enabled APs are busy, return EFI_NOT_READY.
1711 return EFI_NOT_READY
;
1717 if (!HasEnabledAp
) {
1719 // If no enabled AP exists, return EFI_NOT_STARTED.
1721 return EFI_NOT_STARTED
;
1724 CpuMpData
->StartCount
= 0;
1725 for (ProcessorNumber
= 0; ProcessorNumber
< ProcessorCount
; ProcessorNumber
++) {
1726 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1727 CpuData
->Waiting
= FALSE
;
1728 if (ProcessorNumber
!= CpuMpData
->BspNumber
) {
1729 if (CpuData
->State
== CpuStateIdle
) {
1731 // Mark this processor as responsible for current calling.
1733 CpuData
->Waiting
= TRUE
;
1734 CpuMpData
->StartCount
++;
1739 CpuMpData
->Procedure
= Procedure
;
1740 CpuMpData
->ProcArguments
= ProcedureArgument
;
1741 CpuMpData
->SingleThread
= SingleThread
;
1742 CpuMpData
->FinishedCount
= 0;
1743 CpuMpData
->RunningCount
= 0;
1744 CpuMpData
->FailedCpuList
= FailedCpuList
;
1745 CpuMpData
->ExpectedTime
= CalculateTimeout (
1746 TimeoutInMicroseconds
,
1747 &CpuMpData
->CurrentTime
1749 CpuMpData
->TotalTime
= 0;
1750 CpuMpData
->WaitEvent
= WaitEvent
;
1752 if (!SingleThread
) {
1753 WakeUpAP (CpuMpData
, TRUE
, 0, Procedure
, ProcedureArgument
);
1755 for (ProcessorNumber
= 0; ProcessorNumber
< ProcessorCount
; ProcessorNumber
++) {
1756 if (ProcessorNumber
== CallerNumber
) {
1759 if (CpuMpData
->CpuData
[ProcessorNumber
].Waiting
) {
1760 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, Procedure
, ProcedureArgument
);
1766 Status
= EFI_SUCCESS
;
1767 if (WaitEvent
== NULL
) {
1769 Status
= CheckAllAPs ();
1770 } while (Status
== EFI_NOT_READY
);
1777 Worker function to let the caller get one enabled AP to execute a caller-provided
1780 @param[in] Procedure A pointer to the function to be run on
1781 enabled APs of the system.
1782 @param[in] ProcessorNumber The handle number of the AP.
1783 @param[in] WaitEvent The event created by the caller with CreateEvent()
1785 @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for
1786 APs to return from Procedure, either for
1787 blocking or non-blocking mode.
1788 @param[in] ProcedureArgument The parameter passed into Procedure for
1790 @param[out] Finished If AP returns from Procedure before the
1791 timeout expires, its content is set to TRUE.
1792 Otherwise, the value is set to FALSE.
1794 @retval EFI_SUCCESS In blocking mode, specified AP finished before
1795 the timeout expires.
1796 @retval others Failed to Startup AP.
1800 StartupThisAPWorker (
1801 IN EFI_AP_PROCEDURE Procedure
,
1802 IN UINTN ProcessorNumber
,
1803 IN EFI_EVENT WaitEvent OPTIONAL
,
1804 IN UINTN TimeoutInMicroseconds
,
1805 IN VOID
*ProcedureArgument OPTIONAL
,
1806 OUT BOOLEAN
*Finished OPTIONAL
1810 CPU_MP_DATA
*CpuMpData
;
1811 CPU_AP_DATA
*CpuData
;
1814 CpuMpData
= GetCpuMpData ();
1816 if (Finished
!= NULL
) {
1821 // Check whether caller processor is BSP
1823 MpInitLibWhoAmI (&CallerNumber
);
1824 if (CallerNumber
!= CpuMpData
->BspNumber
) {
1825 return EFI_DEVICE_ERROR
;
1829 // Check whether processor with the handle specified by ProcessorNumber exists
1831 if (ProcessorNumber
>= CpuMpData
->CpuCount
) {
1832 return EFI_NOT_FOUND
;
1836 // Check whether specified processor is BSP
1838 if (ProcessorNumber
== CpuMpData
->BspNumber
) {
1839 return EFI_INVALID_PARAMETER
;
1843 // Check parameter Procedure
1845 if (Procedure
== NULL
) {
1846 return EFI_INVALID_PARAMETER
;
1852 CheckAndUpdateApsStatus ();
1855 // Check whether specified AP is disabled
1857 if (GetApState (&CpuMpData
->CpuData
[ProcessorNumber
]) == CpuStateDisabled
) {
1858 return EFI_INVALID_PARAMETER
;
1862 // If WaitEvent is not NULL, execute in non-blocking mode.
1863 // BSP saves data for CheckAPsStatus(), and returns EFI_SUCCESS.
1864 // CheckAPsStatus() will check completion and timeout periodically.
1866 CpuData
= &CpuMpData
->CpuData
[ProcessorNumber
];
1867 CpuData
->WaitEvent
= WaitEvent
;
1868 CpuData
->Finished
= Finished
;
1869 CpuData
->ExpectedTime
= CalculateTimeout (TimeoutInMicroseconds
, &CpuData
->CurrentTime
);
1870 CpuData
->TotalTime
= 0;
1872 WakeUpAP (CpuMpData
, FALSE
, ProcessorNumber
, Procedure
, ProcedureArgument
);
1875 // If WaitEvent is NULL, execute in blocking mode.
1876 // BSP checks AP's state until it finishes or TimeoutInMicrosecsond expires.
1878 Status
= EFI_SUCCESS
;
1879 if (WaitEvent
== NULL
) {
1881 Status
= CheckThisAP (ProcessorNumber
);
1882 } while (Status
== EFI_NOT_READY
);
1889 Get pointer to CPU MP Data structure from GUIDed HOB.
1891 @return The pointer to CPU MP Data structure.
1894 GetCpuMpDataFromGuidedHob (
1898 EFI_HOB_GUID_TYPE
*GuidHob
;
1900 CPU_MP_DATA
*CpuMpData
;
1903 GuidHob
= GetFirstGuidHob (&mCpuInitMpLibHobGuid
);
1904 if (GuidHob
!= NULL
) {
1905 DataInHob
= GET_GUID_HOB_DATA (GuidHob
);
1906 CpuMpData
= (CPU_MP_DATA
*) (*(UINTN
*) DataInHob
);
1912 Get available system memory below 1MB by specified size.
1914 @param[in] CpuMpData The pointer to CPU MP Data structure.
1917 BackupAndPrepareWakeupBuffer(
1918 IN CPU_MP_DATA
*CpuMpData
1922 (VOID
*) CpuMpData
->BackupBuffer
,
1923 (VOID
*) CpuMpData
->WakeupBuffer
,
1924 CpuMpData
->BackupBufferSize
1927 (VOID
*) CpuMpData
->WakeupBuffer
,
1928 (VOID
*) CpuMpData
->AddressMap
.RendezvousFunnelAddress
,
1929 CpuMpData
->AddressMap
.RendezvousFunnelSize
1934 Restore wakeup buffer data.
1936 @param[in] CpuMpData The pointer to CPU MP Data structure.
1939 RestoreWakeupBuffer(
1940 IN CPU_MP_DATA
*CpuMpData
1944 (VOID
*) CpuMpData
->WakeupBuffer
,
1945 (VOID
*) CpuMpData
->BackupBuffer
,
1946 CpuMpData
->BackupBufferSize