UefiCpuPkg: Move GetProcessorLocation() to LocalApicLib library
[mirror_edk2.git] / UefiCpuPkg / Library / MpInitLib / MpLib.c
1 /** @file
2 CPU MP Initialize Library common functions.
3
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
9
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.
12
13 **/
14
15 #include "MpLib.h"
16
17 EFI_GUID mCpuInitMpLibHobGuid = CPU_INIT_MP_LIB_HOB_GUID;
18
19 /**
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.
23
24 @retval TRUE BSP Execute Disable is enabled.
25 @retval FALSE BSP Execute Disable is not enabled.
26 **/
27 BOOLEAN
28 IsBspExecuteDisableEnabled (
29 VOID
30 )
31 {
32 UINT32 Eax;
33 CPUID_EXTENDED_CPU_SIG_EDX Edx;
34 MSR_IA32_EFER_REGISTER EferMsr;
35 BOOLEAN Enabled;
36
37 Enabled = FALSE;
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);
41 //
42 // CPUID 0x80000001
43 // Bit 20: Execute Disable Bit available.
44 //
45 if (Edx.Bits.NX != 0) {
46 EferMsr.Uint64 = AsmReadMsr64 (MSR_IA32_EFER);
47 //
48 // MSR 0xC0000080
49 // Bit 11: Execute Disable Bit enable.
50 //
51 if (EferMsr.Bits.NXE != 0) {
52 Enabled = TRUE;
53 }
54 }
55 }
56
57 return Enabled;
58 }
59
60 /**
61 Worker function for SwitchBSP().
62
63 Worker function for SwitchBSP(), assigned to the AP which is intended
64 to become BSP.
65
66 @param[in] Buffer Pointer to CPU MP Data
67 **/
68 VOID
69 EFIAPI
70 FutureBSPProc (
71 IN VOID *Buffer
72 )
73 {
74 CPU_MP_DATA *DataInHob;
75
76 DataInHob = (CPU_MP_DATA *) Buffer;
77 AsmExchangeRole (&DataInHob->APInfo, &DataInHob->BSPInfo);
78 }
79
80 /**
81 Get the Application Processors state.
82
83 @param[in] CpuData The pointer to CPU_AP_DATA of specified AP
84
85 @return The AP status
86 **/
87 CPU_STATE
88 GetApState (
89 IN CPU_AP_DATA *CpuData
90 )
91 {
92 return CpuData->State;
93 }
94
95 /**
96 Set the Application Processors state.
97
98 @param[in] CpuData The pointer to CPU_AP_DATA of specified AP
99 @param[in] State The AP status
100 **/
101 VOID
102 SetApState (
103 IN CPU_AP_DATA *CpuData,
104 IN CPU_STATE State
105 )
106 {
107 AcquireSpinLock (&CpuData->ApLock);
108 CpuData->State = State;
109 ReleaseSpinLock (&CpuData->ApLock);
110 }
111
112 /**
113 Save the volatile registers required to be restored following INIT IPI.
114
115 @param[out] VolatileRegisters Returns buffer saved the volatile resisters
116 **/
117 VOID
118 SaveVolatileRegisters (
119 OUT CPU_VOLATILE_REGISTERS *VolatileRegisters
120 )
121 {
122 CPUID_VERSION_INFO_EDX VersionInfoEdx;
123
124 VolatileRegisters->Cr0 = AsmReadCr0 ();
125 VolatileRegisters->Cr3 = AsmReadCr3 ();
126 VolatileRegisters->Cr4 = AsmReadCr4 ();
127
128 AsmCpuid (CPUID_VERSION_INFO, NULL, NULL, NULL, &VersionInfoEdx.Uint32);
129 if (VersionInfoEdx.Bits.DE != 0) {
130 //
131 // If processor supports Debugging Extensions feature
132 // by CPUID.[EAX=01H]:EDX.BIT2
133 //
134 VolatileRegisters->Dr0 = AsmReadDr0 ();
135 VolatileRegisters->Dr1 = AsmReadDr1 ();
136 VolatileRegisters->Dr2 = AsmReadDr2 ();
137 VolatileRegisters->Dr3 = AsmReadDr3 ();
138 VolatileRegisters->Dr6 = AsmReadDr6 ();
139 VolatileRegisters->Dr7 = AsmReadDr7 ();
140 }
141 }
142
143 /**
144 Restore the volatile registers following INIT IPI.
145
146 @param[in] VolatileRegisters Pointer to volatile resisters
147 @param[in] IsRestoreDr TRUE: Restore DRx if supported
148 FALSE: Do not restore DRx
149 **/
150 VOID
151 RestoreVolatileRegisters (
152 IN CPU_VOLATILE_REGISTERS *VolatileRegisters,
153 IN BOOLEAN IsRestoreDr
154 )
155 {
156 CPUID_VERSION_INFO_EDX VersionInfoEdx;
157
158 AsmWriteCr0 (VolatileRegisters->Cr0);
159 AsmWriteCr3 (VolatileRegisters->Cr3);
160 AsmWriteCr4 (VolatileRegisters->Cr4);
161
162 if (IsRestoreDr) {
163 AsmCpuid (CPUID_VERSION_INFO, NULL, NULL, NULL, &VersionInfoEdx.Uint32);
164 if (VersionInfoEdx.Bits.DE != 0) {
165 //
166 // If processor supports Debugging Extensions feature
167 // by CPUID.[EAX=01H]:EDX.BIT2
168 //
169 AsmWriteDr0 (VolatileRegisters->Dr0);
170 AsmWriteDr1 (VolatileRegisters->Dr1);
171 AsmWriteDr2 (VolatileRegisters->Dr2);
172 AsmWriteDr3 (VolatileRegisters->Dr3);
173 AsmWriteDr6 (VolatileRegisters->Dr6);
174 AsmWriteDr7 (VolatileRegisters->Dr7);
175 }
176 }
177 }
178
179 /**
180 Detect whether Mwait-monitor feature is supported.
181
182 @retval TRUE Mwait-monitor feature is supported.
183 @retval FALSE Mwait-monitor feature is not supported.
184 **/
185 BOOLEAN
186 IsMwaitSupport (
187 VOID
188 )
189 {
190 CPUID_VERSION_INFO_ECX VersionInfoEcx;
191
192 AsmCpuid (CPUID_VERSION_INFO, NULL, NULL, &VersionInfoEcx.Uint32, NULL);
193 return (VersionInfoEcx.Bits.MONITOR == 1) ? TRUE : FALSE;
194 }
195
196 /**
197 Get AP loop mode.
198
199 @param[out] MonitorFilterSize Returns the largest monitor-line size in bytes.
200
201 @return The AP loop mode.
202 **/
203 UINT8
204 GetApLoopMode (
205 OUT UINT32 *MonitorFilterSize
206 )
207 {
208 UINT8 ApLoopMode;
209 CPUID_MONITOR_MWAIT_EBX MonitorMwaitEbx;
210
211 ASSERT (MonitorFilterSize != NULL);
212
213 ApLoopMode = PcdGet8 (PcdCpuApLoopMode);
214 ASSERT (ApLoopMode >= ApInHltLoop && ApLoopMode <= ApInRunLoop);
215 if (ApLoopMode == ApInMwaitLoop) {
216 if (!IsMwaitSupport ()) {
217 //
218 // If processor does not support MONITOR/MWAIT feature,
219 // force AP in Hlt-loop mode
220 //
221 ApLoopMode = ApInHltLoop;
222 }
223 }
224
225 if (ApLoopMode != ApInMwaitLoop) {
226 *MonitorFilterSize = sizeof (UINT32);
227 } else {
228 //
229 // CPUID.[EAX=05H]:EBX.BIT0-15: Largest monitor-line size in bytes
230 // CPUID.[EAX=05H].EDX: C-states supported using MWAIT
231 //
232 AsmCpuid (CPUID_MONITOR_MWAIT, NULL, &MonitorMwaitEbx.Uint32, NULL, NULL);
233 *MonitorFilterSize = MonitorMwaitEbx.Bits.LargestMonitorLineSize;
234 }
235
236 return ApLoopMode;
237 }
238
239 /**
240 Sort the APIC ID of all processors.
241
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.
244
245 @param[in] CpuMpData Pointer to PEI CPU MP Data
246 **/
247 VOID
248 SortApicId (
249 IN CPU_MP_DATA *CpuMpData
250 )
251 {
252 UINTN Index1;
253 UINTN Index2;
254 UINTN Index3;
255 UINT32 ApicId;
256 CPU_AP_DATA CpuData;
257 UINT32 ApCount;
258 CPU_INFO_IN_HOB *CpuInfoInHob;
259
260 ApCount = CpuMpData->CpuCount - 1;
261
262 if (ApCount != 0) {
263 for (Index1 = 0; Index1 < ApCount; Index1++) {
264 Index3 = Index1;
265 //
266 // Sort key is the hardware default APIC ID
267 //
268 ApicId = CpuMpData->CpuData[Index1].ApicId;
269 for (Index2 = Index1 + 1; Index2 <= ApCount; Index2++) {
270 if (ApicId > CpuMpData->CpuData[Index2].ApicId) {
271 Index3 = Index2;
272 ApicId = CpuMpData->CpuData[Index2].ApicId;
273 }
274 }
275 if (Index3 != Index1) {
276 CopyMem (&CpuData, &CpuMpData->CpuData[Index3], sizeof (CPU_AP_DATA));
277 CopyMem (
278 &CpuMpData->CpuData[Index3],
279 &CpuMpData->CpuData[Index1],
280 sizeof (CPU_AP_DATA)
281 );
282 CopyMem (&CpuMpData->CpuData[Index1], &CpuData, sizeof (CPU_AP_DATA));
283 }
284 }
285
286 //
287 // Get the processor number for the BSP
288 //
289 ApicId = GetInitialApicId ();
290 for (Index1 = 0; Index1 < CpuMpData->CpuCount; Index1++) {
291 if (CpuMpData->CpuData[Index1].ApicId == ApicId) {
292 CpuMpData->BspNumber = (UINT32) Index1;
293 break;
294 }
295 }
296
297 CpuInfoInHob = (CPU_INFO_IN_HOB *) (UINTN) CpuMpData->CpuInfoInHob;
298 for (Index1 = 0; Index1 < CpuMpData->CpuCount; Index1++) {
299 CpuInfoInHob[Index1].InitialApicId = CpuMpData->CpuData[Index1].InitialApicId;
300 CpuInfoInHob[Index1].ApicId = CpuMpData->CpuData[Index1].ApicId;
301 CpuInfoInHob[Index1].Health = CpuMpData->CpuData[Index1].Health;
302 }
303 }
304 }
305
306 /**
307 Enable x2APIC mode on APs.
308
309 @param[in, out] Buffer Pointer to private data buffer.
310 **/
311 VOID
312 EFIAPI
313 ApFuncEnableX2Apic (
314 IN OUT VOID *Buffer
315 )
316 {
317 SetApicMode (LOCAL_APIC_MODE_X2APIC);
318 }
319
320 /**
321 Do sync on APs.
322
323 @param[in, out] Buffer Pointer to private data buffer.
324 **/
325 VOID
326 EFIAPI
327 ApInitializeSync (
328 IN OUT VOID *Buffer
329 )
330 {
331 CPU_MP_DATA *CpuMpData;
332
333 CpuMpData = (CPU_MP_DATA *) Buffer;
334 //
335 // Sync BSP's MTRR table to AP
336 //
337 MtrrSetAllMtrrs (&CpuMpData->MtrrTable);
338 //
339 // Load microcode on AP
340 //
341 MicrocodeDetect (CpuMpData);
342 }
343
344 /**
345 Find the current Processor number by APIC ID.
346
347 @param[in] CpuMpData Pointer to PEI CPU MP Data
348 @param[in] ProcessorNumber Return the pocessor number found
349
350 @retval EFI_SUCCESS ProcessorNumber is found and returned.
351 @retval EFI_NOT_FOUND ProcessorNumber is not found.
352 **/
353 EFI_STATUS
354 GetProcessorNumber (
355 IN CPU_MP_DATA *CpuMpData,
356 OUT UINTN *ProcessorNumber
357 )
358 {
359 UINTN TotalProcessorNumber;
360 UINTN Index;
361
362 TotalProcessorNumber = CpuMpData->CpuCount;
363 for (Index = 0; Index < TotalProcessorNumber; Index ++) {
364 if (CpuMpData->CpuData[Index].ApicId == GetApicId ()) {
365 *ProcessorNumber = Index;
366 return EFI_SUCCESS;
367 }
368 }
369 return EFI_NOT_FOUND;
370 }
371
372 /**
373 This function will get CPU count in the system.
374
375 @param[in] CpuMpData Pointer to PEI CPU MP Data
376
377 @return CPU count detected
378 **/
379 UINTN
380 CollectProcessorCount (
381 IN CPU_MP_DATA *CpuMpData
382 )
383 {
384 //
385 // Send 1st broadcast IPI to APs to wakeup APs
386 //
387 CpuMpData->InitFlag = ApInitConfig;
388 CpuMpData->X2ApicEnable = FALSE;
389 WakeUpAP (CpuMpData, TRUE, 0, NULL, NULL);
390 CpuMpData->InitFlag = ApInitDone;
391 ASSERT (CpuMpData->CpuCount <= PcdGet32 (PcdCpuMaxLogicalProcessorNumber));
392 //
393 // Wait for all APs finished the initialization
394 //
395 while (CpuMpData->FinishedCount < (CpuMpData->CpuCount - 1)) {
396 CpuPause ();
397 }
398
399 if (CpuMpData->X2ApicEnable) {
400 DEBUG ((DEBUG_INFO, "Force x2APIC mode!\n"));
401 //
402 // Wakeup all APs to enable x2APIC mode
403 //
404 WakeUpAP (CpuMpData, TRUE, 0, ApFuncEnableX2Apic, NULL);
405 //
406 // Wait for all known APs finished
407 //
408 while (CpuMpData->FinishedCount < (CpuMpData->CpuCount - 1)) {
409 CpuPause ();
410 }
411 //
412 // Enable x2APIC on BSP
413 //
414 SetApicMode (LOCAL_APIC_MODE_X2APIC);
415 }
416 DEBUG ((DEBUG_INFO, "APIC MODE is %d\n", GetApicMode ()));
417 //
418 // Sort BSP/Aps by CPU APIC ID in ascending order
419 //
420 SortApicId (CpuMpData);
421
422 DEBUG ((DEBUG_INFO, "MpInitLib: Find %d processors in system.\n", CpuMpData->CpuCount));
423
424 return CpuMpData->CpuCount;
425 }
426
427 /*
428 Initialize CPU AP Data when AP is wakeup at the first time.
429
430 @param[in, out] CpuMpData Pointer to PEI CPU MP Data
431 @param[in] ProcessorNumber The handle number of processor
432 @param[in] BistData Processor BIST data
433
434 **/
435 VOID
436 InitializeApData (
437 IN OUT CPU_MP_DATA *CpuMpData,
438 IN UINTN ProcessorNumber,
439 IN UINT32 BistData
440 )
441 {
442 CpuMpData->CpuData[ProcessorNumber].Waiting = FALSE;
443 CpuMpData->CpuData[ProcessorNumber].Health = BistData;
444 CpuMpData->CpuData[ProcessorNumber].CpuHealthy = (BistData == 0) ? TRUE : FALSE;
445 CpuMpData->CpuData[ProcessorNumber].ApicId = GetApicId ();
446 CpuMpData->CpuData[ProcessorNumber].InitialApicId = GetInitialApicId ();
447 if (CpuMpData->CpuData[ProcessorNumber].InitialApicId >= 0xFF) {
448 //
449 // Set x2APIC mode if there are any logical processor reporting
450 // an Initial APIC ID of 255 or greater.
451 //
452 AcquireSpinLock(&CpuMpData->MpLock);
453 CpuMpData->X2ApicEnable = TRUE;
454 ReleaseSpinLock(&CpuMpData->MpLock);
455 }
456
457 InitializeSpinLock(&CpuMpData->CpuData[ProcessorNumber].ApLock);
458 SetApState (&CpuMpData->CpuData[ProcessorNumber], CpuStateIdle);
459 }
460
461 /**
462 This function will be called from AP reset code if BSP uses WakeUpAP.
463
464 @param[in] ExchangeInfo Pointer to the MP exchange info buffer
465 @param[in] NumApsExecuting Number of current executing AP
466 **/
467 VOID
468 EFIAPI
469 ApWakeupFunction (
470 IN MP_CPU_EXCHANGE_INFO *ExchangeInfo,
471 IN UINTN NumApsExecuting
472 )
473 {
474 CPU_MP_DATA *CpuMpData;
475 UINTN ProcessorNumber;
476 EFI_AP_PROCEDURE Procedure;
477 VOID *Parameter;
478 UINT32 BistData;
479 volatile UINT32 *ApStartupSignalBuffer;
480
481 //
482 // AP finished assembly code and begin to execute C code
483 //
484 CpuMpData = ExchangeInfo->CpuMpData;
485
486 ProgramVirtualWireMode ();
487
488 while (TRUE) {
489 if (CpuMpData->InitFlag == ApInitConfig) {
490 //
491 // Add CPU number
492 //
493 InterlockedIncrement ((UINT32 *) &CpuMpData->CpuCount);
494 ProcessorNumber = NumApsExecuting;
495 //
496 // This is first time AP wakeup, get BIST information from AP stack
497 //
498 BistData = *(UINT32 *) (CpuMpData->Buffer + ProcessorNumber * CpuMpData->CpuApStackSize - sizeof (UINTN));
499 //
500 // Do some AP initialize sync
501 //
502 ApInitializeSync (CpuMpData);
503 //
504 // Sync BSP's Control registers to APs
505 //
506 RestoreVolatileRegisters (&CpuMpData->CpuData[0].VolatileRegisters, FALSE);
507 InitializeApData (CpuMpData, ProcessorNumber, BistData);
508 ApStartupSignalBuffer = CpuMpData->CpuData[ProcessorNumber].StartupApSignal;
509 } else {
510 //
511 // Execute AP function if AP is ready
512 //
513 GetProcessorNumber (CpuMpData, &ProcessorNumber);
514 //
515 // Clear AP start-up signal when AP waken up
516 //
517 ApStartupSignalBuffer = CpuMpData->CpuData[ProcessorNumber].StartupApSignal;
518 InterlockedCompareExchange32 (
519 (UINT32 *) ApStartupSignalBuffer,
520 WAKEUP_AP_SIGNAL,
521 0
522 );
523 if (CpuMpData->ApLoopMode == ApInHltLoop) {
524 //
525 // Restore AP's volatile registers saved
526 //
527 RestoreVolatileRegisters (&CpuMpData->CpuData[ProcessorNumber].VolatileRegisters, TRUE);
528 }
529
530 if (GetApState (&CpuMpData->CpuData[ProcessorNumber]) == CpuStateReady) {
531 Procedure = (EFI_AP_PROCEDURE)CpuMpData->CpuData[ProcessorNumber].ApFunction;
532 Parameter = (VOID *) CpuMpData->CpuData[ProcessorNumber].ApFunctionArgument;
533 if (Procedure != NULL) {
534 SetApState (&CpuMpData->CpuData[ProcessorNumber], CpuStateBusy);
535 //
536 // Invoke AP function here
537 //
538 Procedure (Parameter);
539 if (CpuMpData->SwitchBspFlag) {
540 //
541 // Re-get the processor number due to BSP/AP maybe exchange in AP function
542 //
543 GetProcessorNumber (CpuMpData, &ProcessorNumber);
544 CpuMpData->CpuData[ProcessorNumber].ApFunction = 0;
545 CpuMpData->CpuData[ProcessorNumber].ApFunctionArgument = 0;
546 } else {
547 //
548 // Re-get the CPU APICID and Initial APICID
549 //
550 CpuMpData->CpuData[ProcessorNumber].ApicId = GetApicId ();
551 CpuMpData->CpuData[ProcessorNumber].InitialApicId = GetInitialApicId ();
552 }
553 }
554 SetApState (&CpuMpData->CpuData[ProcessorNumber], CpuStateFinished);
555 }
556 }
557
558 //
559 // AP finished executing C code
560 //
561 InterlockedIncrement ((UINT32 *) &CpuMpData->FinishedCount);
562
563 //
564 // Place AP is specified loop mode
565 //
566 if (CpuMpData->ApLoopMode == ApInHltLoop) {
567 //
568 // Save AP volatile registers
569 //
570 SaveVolatileRegisters (&CpuMpData->CpuData[ProcessorNumber].VolatileRegisters);
571 //
572 // Place AP in HLT-loop
573 //
574 while (TRUE) {
575 DisableInterrupts ();
576 CpuSleep ();
577 CpuPause ();
578 }
579 }
580 while (TRUE) {
581 DisableInterrupts ();
582 if (CpuMpData->ApLoopMode == ApInMwaitLoop) {
583 //
584 // Place AP in MWAIT-loop
585 //
586 AsmMonitor ((UINTN) ApStartupSignalBuffer, 0, 0);
587 if (*ApStartupSignalBuffer != WAKEUP_AP_SIGNAL) {
588 //
589 // Check AP start-up signal again.
590 // If AP start-up signal is not set, place AP into
591 // the specified C-state
592 //
593 AsmMwait (CpuMpData->ApTargetCState << 4, 0);
594 }
595 } else if (CpuMpData->ApLoopMode == ApInRunLoop) {
596 //
597 // Place AP in Run-loop
598 //
599 CpuPause ();
600 } else {
601 ASSERT (FALSE);
602 }
603
604 //
605 // If AP start-up signal is written, AP is waken up
606 // otherwise place AP in loop again
607 //
608 if (*ApStartupSignalBuffer == WAKEUP_AP_SIGNAL) {
609 break;
610 }
611 }
612 }
613 }
614
615 /**
616 Wait for AP wakeup and write AP start-up signal till AP is waken up.
617
618 @param[in] ApStartupSignalBuffer Pointer to AP wakeup signal
619 **/
620 VOID
621 WaitApWakeup (
622 IN volatile UINT32 *ApStartupSignalBuffer
623 )
624 {
625 //
626 // If AP is waken up, StartupApSignal should be cleared.
627 // Otherwise, write StartupApSignal again till AP waken up.
628 //
629 while (InterlockedCompareExchange32 (
630 (UINT32 *) ApStartupSignalBuffer,
631 WAKEUP_AP_SIGNAL,
632 WAKEUP_AP_SIGNAL
633 ) != 0) {
634 CpuPause ();
635 }
636 }
637
638 /**
639 This function will fill the exchange info structure.
640
641 @param[in] CpuMpData Pointer to CPU MP Data
642
643 **/
644 VOID
645 FillExchangeInfoData (
646 IN CPU_MP_DATA *CpuMpData
647 )
648 {
649 volatile MP_CPU_EXCHANGE_INFO *ExchangeInfo;
650
651 ExchangeInfo = CpuMpData->MpCpuExchangeInfo;
652 ExchangeInfo->Lock = 0;
653 ExchangeInfo->StackStart = CpuMpData->Buffer;
654 ExchangeInfo->StackSize = CpuMpData->CpuApStackSize;
655 ExchangeInfo->BufferStart = CpuMpData->WakeupBuffer;
656 ExchangeInfo->ModeOffset = CpuMpData->AddressMap.ModeEntryOffset;
657
658 ExchangeInfo->CodeSegment = AsmReadCs ();
659 ExchangeInfo->DataSegment = AsmReadDs ();
660
661 ExchangeInfo->Cr3 = AsmReadCr3 ();
662
663 ExchangeInfo->CFunction = (UINTN) ApWakeupFunction;
664 ExchangeInfo->NumApsExecuting = 0;
665 ExchangeInfo->CpuMpData = CpuMpData;
666
667 ExchangeInfo->EnableExecuteDisable = IsBspExecuteDisableEnabled ();
668
669 //
670 // Get the BSP's data of GDT and IDT
671 //
672 AsmReadGdtr ((IA32_DESCRIPTOR *) &ExchangeInfo->GdtrProfile);
673 AsmReadIdtr ((IA32_DESCRIPTOR *) &ExchangeInfo->IdtrProfile);
674 }
675
676 /**
677 This function will be called by BSP to wakeup AP.
678
679 @param[in] CpuMpData Pointer to CPU MP Data
680 @param[in] Broadcast TRUE: Send broadcast IPI to all APs
681 FALSE: Send IPI to AP by ApicId
682 @param[in] ProcessorNumber The handle number of specified processor
683 @param[in] Procedure The function to be invoked by AP
684 @param[in] ProcedureArgument The argument to be passed into AP function
685 **/
686 VOID
687 WakeUpAP (
688 IN CPU_MP_DATA *CpuMpData,
689 IN BOOLEAN Broadcast,
690 IN UINTN ProcessorNumber,
691 IN EFI_AP_PROCEDURE Procedure, OPTIONAL
692 IN VOID *ProcedureArgument OPTIONAL
693 )
694 {
695 volatile MP_CPU_EXCHANGE_INFO *ExchangeInfo;
696 UINTN Index;
697 CPU_AP_DATA *CpuData;
698 BOOLEAN ResetVectorRequired;
699
700 CpuMpData->FinishedCount = 0;
701 ResetVectorRequired = FALSE;
702
703 if (CpuMpData->ApLoopMode == ApInHltLoop ||
704 CpuMpData->InitFlag != ApInitDone) {
705 ResetVectorRequired = TRUE;
706 AllocateResetVector (CpuMpData);
707 FillExchangeInfoData (CpuMpData);
708 } else if (CpuMpData->ApLoopMode == ApInMwaitLoop) {
709 //
710 // Get AP target C-state each time when waking up AP,
711 // for it maybe updated by platform again
712 //
713 CpuMpData->ApTargetCState = PcdGet8 (PcdCpuApTargetCstate);
714 }
715
716 ExchangeInfo = CpuMpData->MpCpuExchangeInfo;
717
718 if (Broadcast) {
719 for (Index = 0; Index < CpuMpData->CpuCount; Index++) {
720 if (Index != CpuMpData->BspNumber) {
721 CpuData = &CpuMpData->CpuData[Index];
722 CpuData->ApFunction = (UINTN) Procedure;
723 CpuData->ApFunctionArgument = (UINTN) ProcedureArgument;
724 SetApState (CpuData, CpuStateReady);
725 if (CpuMpData->InitFlag != ApInitConfig) {
726 *(UINT32 *) CpuData->StartupApSignal = WAKEUP_AP_SIGNAL;
727 }
728 }
729 }
730 if (ResetVectorRequired) {
731 //
732 // Wakeup all APs
733 //
734 SendInitSipiSipiAllExcludingSelf ((UINT32) ExchangeInfo->BufferStart);
735 }
736 if (CpuMpData->InitFlag == ApInitConfig) {
737 //
738 // Wait for all potential APs waken up in one specified period
739 //
740 MicroSecondDelay (PcdGet32(PcdCpuApInitTimeOutInMicroSeconds));
741 } else {
742 //
743 // Wait all APs waken up if this is not the 1st broadcast of SIPI
744 //
745 for (Index = 0; Index < CpuMpData->CpuCount; Index++) {
746 CpuData = &CpuMpData->CpuData[Index];
747 if (Index != CpuMpData->BspNumber) {
748 WaitApWakeup (CpuData->StartupApSignal);
749 }
750 }
751 }
752 } else {
753 CpuData = &CpuMpData->CpuData[ProcessorNumber];
754 CpuData->ApFunction = (UINTN) Procedure;
755 CpuData->ApFunctionArgument = (UINTN) ProcedureArgument;
756 SetApState (CpuData, CpuStateReady);
757 //
758 // Wakeup specified AP
759 //
760 ASSERT (CpuMpData->InitFlag != ApInitConfig);
761 *(UINT32 *) CpuData->StartupApSignal = WAKEUP_AP_SIGNAL;
762 if (ResetVectorRequired) {
763 SendInitSipiSipi (
764 CpuData->ApicId,
765 (UINT32) ExchangeInfo->BufferStart
766 );
767 }
768 //
769 // Wait specified AP waken up
770 //
771 WaitApWakeup (CpuData->StartupApSignal);
772 }
773
774 if (ResetVectorRequired) {
775 FreeResetVector (CpuMpData);
776 }
777 }
778
779 /**
780 Calculate timeout value and return the current performance counter value.
781
782 Calculate the number of performance counter ticks required for a timeout.
783 If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
784 as infinity.
785
786 @param[in] TimeoutInMicroseconds Timeout value in microseconds.
787 @param[out] CurrentTime Returns the current value of the performance counter.
788
789 @return Expected time stamp counter for timeout.
790 If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
791 as infinity.
792
793 **/
794 UINT64
795 CalculateTimeout (
796 IN UINTN TimeoutInMicroseconds,
797 OUT UINT64 *CurrentTime
798 )
799 {
800 //
801 // Read the current value of the performance counter
802 //
803 *CurrentTime = GetPerformanceCounter ();
804
805 //
806 // If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
807 // as infinity.
808 //
809 if (TimeoutInMicroseconds == 0) {
810 return 0;
811 }
812
813 //
814 // GetPerformanceCounterProperties () returns the timestamp counter's frequency
815 // in Hz. So multiply the return value with TimeoutInMicroseconds and then divide
816 // it by 1,000,000, to get the number of ticks for the timeout value.
817 //
818 return DivU64x32 (
819 MultU64x64 (
820 GetPerformanceCounterProperties (NULL, NULL),
821 TimeoutInMicroseconds
822 ),
823 1000000
824 );
825 }
826
827 /**
828 Checks whether timeout expires.
829
830 Check whether the number of elapsed performance counter ticks required for
831 a timeout condition has been reached.
832 If Timeout is zero, which means infinity, return value is always FALSE.
833
834 @param[in, out] PreviousTime On input, the value of the performance counter
835 when it was last read.
836 On output, the current value of the performance
837 counter
838 @param[in] TotalTime The total amount of elapsed time in performance
839 counter ticks.
840 @param[in] Timeout The number of performance counter ticks required
841 to reach a timeout condition.
842
843 @retval TRUE A timeout condition has been reached.
844 @retval FALSE A timeout condition has not been reached.
845
846 **/
847 BOOLEAN
848 CheckTimeout (
849 IN OUT UINT64 *PreviousTime,
850 IN UINT64 *TotalTime,
851 IN UINT64 Timeout
852 )
853 {
854 UINT64 Start;
855 UINT64 End;
856 UINT64 CurrentTime;
857 INT64 Delta;
858 INT64 Cycle;
859
860 if (Timeout == 0) {
861 return FALSE;
862 }
863 GetPerformanceCounterProperties (&Start, &End);
864 Cycle = End - Start;
865 if (Cycle < 0) {
866 Cycle = -Cycle;
867 }
868 Cycle++;
869 CurrentTime = GetPerformanceCounter();
870 Delta = (INT64) (CurrentTime - *PreviousTime);
871 if (Start > End) {
872 Delta = -Delta;
873 }
874 if (Delta < 0) {
875 Delta += Cycle;
876 }
877 *TotalTime += Delta;
878 *PreviousTime = CurrentTime;
879 if (*TotalTime > Timeout) {
880 return TRUE;
881 }
882 return FALSE;
883 }
884
885 /**
886 Reset an AP to Idle state.
887
888 Any task being executed by the AP will be aborted and the AP
889 will be waiting for a new task in Wait-For-SIPI state.
890
891 @param[in] ProcessorNumber The handle number of processor.
892 **/
893 VOID
894 ResetProcessorToIdleState (
895 IN UINTN ProcessorNumber
896 )
897 {
898 CPU_MP_DATA *CpuMpData;
899
900 CpuMpData = GetCpuMpData ();
901
902 WakeUpAP (CpuMpData, FALSE, ProcessorNumber, NULL, NULL);
903
904 SetApState (&CpuMpData->CpuData[ProcessorNumber], CpuStateIdle);
905 }
906
907 /**
908 Searches for the next waiting AP.
909
910 Search for the next AP that is put in waiting state by single-threaded StartupAllAPs().
911
912 @param[out] NextProcessorNumber Pointer to the processor number of the next waiting AP.
913
914 @retval EFI_SUCCESS The next waiting AP has been found.
915 @retval EFI_NOT_FOUND No waiting AP exists.
916
917 **/
918 EFI_STATUS
919 GetNextWaitingProcessorNumber (
920 OUT UINTN *NextProcessorNumber
921 )
922 {
923 UINTN ProcessorNumber;
924 CPU_MP_DATA *CpuMpData;
925
926 CpuMpData = GetCpuMpData ();
927
928 for (ProcessorNumber = 0; ProcessorNumber < CpuMpData->CpuCount; ProcessorNumber++) {
929 if (CpuMpData->CpuData[ProcessorNumber].Waiting) {
930 *NextProcessorNumber = ProcessorNumber;
931 return EFI_SUCCESS;
932 }
933 }
934
935 return EFI_NOT_FOUND;
936 }
937
938 /** Checks status of specified AP.
939
940 This function checks whether the specified AP has finished the task assigned
941 by StartupThisAP(), and whether timeout expires.
942
943 @param[in] ProcessorNumber The handle number of processor.
944
945 @retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().
946 @retval EFI_TIMEOUT The timeout expires.
947 @retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.
948 **/
949 EFI_STATUS
950 CheckThisAP (
951 IN UINTN ProcessorNumber
952 )
953 {
954 CPU_MP_DATA *CpuMpData;
955 CPU_AP_DATA *CpuData;
956
957 CpuMpData = GetCpuMpData ();
958 CpuData = &CpuMpData->CpuData[ProcessorNumber];
959
960 //
961 // Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.
962 // Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the
963 // value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.
964 //
965 //
966 // If the AP finishes for StartupThisAP(), return EFI_SUCCESS.
967 //
968 if (GetApState(CpuData) == CpuStateFinished) {
969 if (CpuData->Finished != NULL) {
970 *(CpuData->Finished) = TRUE;
971 }
972 SetApState (CpuData, CpuStateIdle);
973 return EFI_SUCCESS;
974 } else {
975 //
976 // If timeout expires for StartupThisAP(), report timeout.
977 //
978 if (CheckTimeout (&CpuData->CurrentTime, &CpuData->TotalTime, CpuData->ExpectedTime)) {
979 if (CpuData->Finished != NULL) {
980 *(CpuData->Finished) = FALSE;
981 }
982 //
983 // Reset failed AP to idle state
984 //
985 ResetProcessorToIdleState (ProcessorNumber);
986
987 return EFI_TIMEOUT;
988 }
989 }
990 return EFI_NOT_READY;
991 }
992
993 /**
994 Checks status of all APs.
995
996 This function checks whether all APs have finished task assigned by StartupAllAPs(),
997 and whether timeout expires.
998
999 @retval EFI_SUCCESS All APs have finished task assigned by StartupAllAPs().
1000 @retval EFI_TIMEOUT The timeout expires.
1001 @retval EFI_NOT_READY APs have not finished task and timeout has not expired.
1002 **/
1003 EFI_STATUS
1004 CheckAllAPs (
1005 VOID
1006 )
1007 {
1008 UINTN ProcessorNumber;
1009 UINTN NextProcessorNumber;
1010 UINTN ListIndex;
1011 EFI_STATUS Status;
1012 CPU_MP_DATA *CpuMpData;
1013 CPU_AP_DATA *CpuData;
1014
1015 CpuMpData = GetCpuMpData ();
1016
1017 NextProcessorNumber = 0;
1018
1019 //
1020 // Go through all APs that are responsible for the StartupAllAPs().
1021 //
1022 for (ProcessorNumber = 0; ProcessorNumber < CpuMpData->CpuCount; ProcessorNumber++) {
1023 if (!CpuMpData->CpuData[ProcessorNumber].Waiting) {
1024 continue;
1025 }
1026
1027 CpuData = &CpuMpData->CpuData[ProcessorNumber];
1028 //
1029 // Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.
1030 // Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the
1031 // value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.
1032 //
1033 if (GetApState(CpuData) == CpuStateFinished) {
1034 CpuMpData->RunningCount ++;
1035 CpuMpData->CpuData[ProcessorNumber].Waiting = FALSE;
1036 SetApState(CpuData, CpuStateIdle);
1037
1038 //
1039 // If in Single Thread mode, then search for the next waiting AP for execution.
1040 //
1041 if (CpuMpData->SingleThread) {
1042 Status = GetNextWaitingProcessorNumber (&NextProcessorNumber);
1043
1044 if (!EFI_ERROR (Status)) {
1045 WakeUpAP (
1046 CpuMpData,
1047 FALSE,
1048 (UINT32) NextProcessorNumber,
1049 CpuMpData->Procedure,
1050 CpuMpData->ProcArguments
1051 );
1052 }
1053 }
1054 }
1055 }
1056
1057 //
1058 // If all APs finish, return EFI_SUCCESS.
1059 //
1060 if (CpuMpData->RunningCount == CpuMpData->StartCount) {
1061 return EFI_SUCCESS;
1062 }
1063
1064 //
1065 // If timeout expires, report timeout.
1066 //
1067 if (CheckTimeout (
1068 &CpuMpData->CurrentTime,
1069 &CpuMpData->TotalTime,
1070 CpuMpData->ExpectedTime)
1071 ) {
1072 //
1073 // If FailedCpuList is not NULL, record all failed APs in it.
1074 //
1075 if (CpuMpData->FailedCpuList != NULL) {
1076 *CpuMpData->FailedCpuList =
1077 AllocatePool ((CpuMpData->StartCount - CpuMpData->FinishedCount + 1) * sizeof (UINTN));
1078 ASSERT (*CpuMpData->FailedCpuList != NULL);
1079 }
1080 ListIndex = 0;
1081
1082 for (ProcessorNumber = 0; ProcessorNumber < CpuMpData->CpuCount; ProcessorNumber++) {
1083 //
1084 // Check whether this processor is responsible for StartupAllAPs().
1085 //
1086 if (CpuMpData->CpuData[ProcessorNumber].Waiting) {
1087 //
1088 // Reset failed APs to idle state
1089 //
1090 ResetProcessorToIdleState (ProcessorNumber);
1091 CpuMpData->CpuData[ProcessorNumber].Waiting = FALSE;
1092 if (CpuMpData->FailedCpuList != NULL) {
1093 (*CpuMpData->FailedCpuList)[ListIndex++] = ProcessorNumber;
1094 }
1095 }
1096 }
1097 if (CpuMpData->FailedCpuList != NULL) {
1098 (*CpuMpData->FailedCpuList)[ListIndex] = END_OF_CPU_LIST;
1099 }
1100 return EFI_TIMEOUT;
1101 }
1102 return EFI_NOT_READY;
1103 }
1104
1105 /**
1106 MP Initialize Library initialization.
1107
1108 This service will allocate AP reset vector and wakeup all APs to do APs
1109 initialization.
1110
1111 This service must be invoked before all other MP Initialize Library
1112 service are invoked.
1113
1114 @retval EFI_SUCCESS MP initialization succeeds.
1115 @retval Others MP initialization fails.
1116
1117 **/
1118 EFI_STATUS
1119 EFIAPI
1120 MpInitLibInitialize (
1121 VOID
1122 )
1123 {
1124 CPU_MP_DATA *OldCpuMpData;
1125 CPU_INFO_IN_HOB *CpuInfoInHob;
1126 UINT32 MaxLogicalProcessorNumber;
1127 UINT32 ApStackSize;
1128 MP_ASSEMBLY_ADDRESS_MAP AddressMap;
1129 UINTN BufferSize;
1130 UINT32 MonitorFilterSize;
1131 VOID *MpBuffer;
1132 UINTN Buffer;
1133 CPU_MP_DATA *CpuMpData;
1134 UINT8 ApLoopMode;
1135 UINT8 *MonitorBuffer;
1136 UINTN Index;
1137 UINTN ApResetVectorSize;
1138 UINTN BackupBufferAddr;
1139
1140 OldCpuMpData = GetCpuMpDataFromGuidedHob ();
1141 if (OldCpuMpData == NULL) {
1142 MaxLogicalProcessorNumber = PcdGet32(PcdCpuMaxLogicalProcessorNumber);
1143 } else {
1144 MaxLogicalProcessorNumber = OldCpuMpData->CpuCount;
1145 }
1146
1147 AsmGetAddressMap (&AddressMap);
1148 ApResetVectorSize = AddressMap.RendezvousFunnelSize + sizeof (MP_CPU_EXCHANGE_INFO);
1149 ApStackSize = PcdGet32(PcdCpuApStackSize);
1150 ApLoopMode = GetApLoopMode (&MonitorFilterSize);
1151
1152 BufferSize = ApStackSize * MaxLogicalProcessorNumber;
1153 BufferSize += MonitorFilterSize * MaxLogicalProcessorNumber;
1154 BufferSize += sizeof (CPU_MP_DATA);
1155 BufferSize += ApResetVectorSize;
1156 BufferSize += (sizeof (CPU_AP_DATA) + sizeof (CPU_INFO_IN_HOB))* MaxLogicalProcessorNumber;
1157 MpBuffer = AllocatePages (EFI_SIZE_TO_PAGES (BufferSize));
1158 ASSERT (MpBuffer != NULL);
1159 ZeroMem (MpBuffer, BufferSize);
1160 Buffer = (UINTN) MpBuffer;
1161
1162 MonitorBuffer = (UINT8 *) (Buffer + ApStackSize * MaxLogicalProcessorNumber);
1163 BackupBufferAddr = (UINTN) MonitorBuffer + MonitorFilterSize * MaxLogicalProcessorNumber;
1164 CpuMpData = (CPU_MP_DATA *) (BackupBufferAddr + ApResetVectorSize);
1165 CpuMpData->Buffer = Buffer;
1166 CpuMpData->CpuApStackSize = ApStackSize;
1167 CpuMpData->BackupBuffer = BackupBufferAddr;
1168 CpuMpData->BackupBufferSize = ApResetVectorSize;
1169 CpuMpData->SaveRestoreFlag = FALSE;
1170 CpuMpData->WakeupBuffer = (UINTN) -1;
1171 CpuMpData->CpuCount = 1;
1172 CpuMpData->BspNumber = 0;
1173 CpuMpData->WaitEvent = NULL;
1174 CpuMpData->SwitchBspFlag = FALSE;
1175 CpuMpData->CpuData = (CPU_AP_DATA *) (CpuMpData + 1);
1176 CpuMpData->CpuInfoInHob = (UINT64) (UINTN) (CpuMpData->CpuData + MaxLogicalProcessorNumber);
1177 InitializeSpinLock(&CpuMpData->MpLock);
1178 //
1179 // Save BSP's Control registers to APs
1180 //
1181 SaveVolatileRegisters (&CpuMpData->CpuData[0].VolatileRegisters);
1182 //
1183 // Set BSP basic information
1184 //
1185 InitializeApData (CpuMpData, 0, 0);
1186 //
1187 // Save assembly code information
1188 //
1189 CopyMem (&CpuMpData->AddressMap, &AddressMap, sizeof (MP_ASSEMBLY_ADDRESS_MAP));
1190 //
1191 // Finally set AP loop mode
1192 //
1193 CpuMpData->ApLoopMode = ApLoopMode;
1194 DEBUG ((DEBUG_INFO, "AP Loop Mode is %d\n", CpuMpData->ApLoopMode));
1195 //
1196 // Set up APs wakeup signal buffer
1197 //
1198 for (Index = 0; Index < MaxLogicalProcessorNumber; Index++) {
1199 CpuMpData->CpuData[Index].StartupApSignal =
1200 (UINT32 *)(MonitorBuffer + MonitorFilterSize * Index);
1201 }
1202 //
1203 // Load Microcode on BSP
1204 //
1205 MicrocodeDetect (CpuMpData);
1206 //
1207 // Store BSP's MTRR setting
1208 //
1209 MtrrGetAllMtrrs (&CpuMpData->MtrrTable);
1210
1211 if (OldCpuMpData == NULL) {
1212 //
1213 // Wakeup all APs and calculate the processor count in system
1214 //
1215 CollectProcessorCount (CpuMpData);
1216 } else {
1217 //
1218 // APs have been wakeup before, just get the CPU Information
1219 // from HOB
1220 //
1221 CpuMpData->CpuCount = OldCpuMpData->CpuCount;
1222 CpuMpData->BspNumber = OldCpuMpData->BspNumber;
1223 CpuMpData->InitFlag = ApInitReconfig;
1224 CpuInfoInHob = (CPU_INFO_IN_HOB *) (UINTN) OldCpuMpData->CpuInfoInHob;
1225 for (Index = 0; Index < CpuMpData->CpuCount; Index++) {
1226 InitializeSpinLock(&CpuMpData->CpuData[Index].ApLock);
1227 CpuMpData->CpuData[Index].ApicId = CpuInfoInHob[Index].ApicId;
1228 CpuMpData->CpuData[Index].InitialApicId = CpuInfoInHob[Index].InitialApicId;
1229 if (CpuMpData->CpuData[Index].InitialApicId >= 255) {
1230 CpuMpData->X2ApicEnable = TRUE;
1231 }
1232 CpuMpData->CpuData[Index].Health = CpuInfoInHob[Index].Health;
1233 CpuMpData->CpuData[Index].CpuHealthy = (CpuMpData->CpuData[Index].Health == 0)? TRUE:FALSE;
1234 CpuMpData->CpuData[Index].ApFunction = 0;
1235 CopyMem (
1236 &CpuMpData->CpuData[Index].VolatileRegisters,
1237 &CpuMpData->CpuData[0].VolatileRegisters,
1238 sizeof (CPU_VOLATILE_REGISTERS)
1239 );
1240 }
1241 //
1242 // Wakeup APs to do some AP initialize sync
1243 //
1244 WakeUpAP (CpuMpData, TRUE, 0, ApInitializeSync, CpuMpData);
1245 //
1246 // Wait for all APs finished initialization
1247 //
1248 while (CpuMpData->FinishedCount < (CpuMpData->CpuCount - 1)) {
1249 CpuPause ();
1250 }
1251 CpuMpData->InitFlag = ApInitDone;
1252 for (Index = 0; Index < CpuMpData->CpuCount; Index++) {
1253 SetApState (&CpuMpData->CpuData[Index], CpuStateIdle);
1254 }
1255 }
1256
1257 //
1258 // Initialize global data for MP support
1259 //
1260 InitMpGlobalData (CpuMpData);
1261
1262 return EFI_SUCCESS;
1263 }
1264
1265 /**
1266 Gets detailed MP-related information on the requested processor at the
1267 instant this call is made. This service may only be called from the BSP.
1268
1269 @param[in] ProcessorNumber The handle number of processor.
1270 @param[out] ProcessorInfoBuffer A pointer to the buffer where information for
1271 the requested processor is deposited.
1272 @param[out] HealthData Return processor health data.
1273
1274 @retval EFI_SUCCESS Processor information was returned.
1275 @retval EFI_DEVICE_ERROR The calling processor is an AP.
1276 @retval EFI_INVALID_PARAMETER ProcessorInfoBuffer is NULL.
1277 @retval EFI_NOT_FOUND The processor with the handle specified by
1278 ProcessorNumber does not exist in the platform.
1279 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1280
1281 **/
1282 EFI_STATUS
1283 EFIAPI
1284 MpInitLibGetProcessorInfo (
1285 IN UINTN ProcessorNumber,
1286 OUT EFI_PROCESSOR_INFORMATION *ProcessorInfoBuffer,
1287 OUT EFI_HEALTH_FLAGS *HealthData OPTIONAL
1288 )
1289 {
1290 CPU_MP_DATA *CpuMpData;
1291 UINTN CallerNumber;
1292
1293 CpuMpData = GetCpuMpData ();
1294
1295 //
1296 // Check whether caller processor is BSP
1297 //
1298 MpInitLibWhoAmI (&CallerNumber);
1299 if (CallerNumber != CpuMpData->BspNumber) {
1300 return EFI_DEVICE_ERROR;
1301 }
1302
1303 if (ProcessorInfoBuffer == NULL) {
1304 return EFI_INVALID_PARAMETER;
1305 }
1306
1307 if (ProcessorNumber >= CpuMpData->CpuCount) {
1308 return EFI_NOT_FOUND;
1309 }
1310
1311 ProcessorInfoBuffer->ProcessorId = (UINT64) CpuMpData->CpuData[ProcessorNumber].ApicId;
1312 ProcessorInfoBuffer->StatusFlag = 0;
1313 if (ProcessorNumber == CpuMpData->BspNumber) {
1314 ProcessorInfoBuffer->StatusFlag |= PROCESSOR_AS_BSP_BIT;
1315 }
1316 if (CpuMpData->CpuData[ProcessorNumber].CpuHealthy) {
1317 ProcessorInfoBuffer->StatusFlag |= PROCESSOR_HEALTH_STATUS_BIT;
1318 }
1319 if (GetApState (&CpuMpData->CpuData[ProcessorNumber]) == CpuStateDisabled) {
1320 ProcessorInfoBuffer->StatusFlag &= ~PROCESSOR_ENABLED_BIT;
1321 } else {
1322 ProcessorInfoBuffer->StatusFlag |= PROCESSOR_ENABLED_BIT;
1323 }
1324
1325 //
1326 // Get processor location information
1327 //
1328 GetProcessorLocation (
1329 CpuMpData->CpuData[ProcessorNumber].ApicId,
1330 &ProcessorInfoBuffer->Location.Package,
1331 &ProcessorInfoBuffer->Location.Core,
1332 &ProcessorInfoBuffer->Location.Thread
1333 );
1334
1335 if (HealthData != NULL) {
1336 HealthData->Uint32 = CpuMpData->CpuData[ProcessorNumber].Health;
1337 }
1338
1339 return EFI_SUCCESS;
1340 }
1341
1342 /**
1343 Worker function to switch the requested AP to be the BSP from that point onward.
1344
1345 @param[in] ProcessorNumber The handle number of AP that is to become the new BSP.
1346 @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an
1347 enabled AP. Otherwise, it will be disabled.
1348
1349 @retval EFI_SUCCESS BSP successfully switched.
1350 @retval others Failed to switch BSP.
1351
1352 **/
1353 EFI_STATUS
1354 SwitchBSPWorker (
1355 IN UINTN ProcessorNumber,
1356 IN BOOLEAN EnableOldBSP
1357 )
1358 {
1359 CPU_MP_DATA *CpuMpData;
1360 UINTN CallerNumber;
1361 CPU_STATE State;
1362 MSR_IA32_APIC_BASE_REGISTER ApicBaseMsr;
1363
1364 CpuMpData = GetCpuMpData ();
1365
1366 //
1367 // Check whether caller processor is BSP
1368 //
1369 MpInitLibWhoAmI (&CallerNumber);
1370 if (CallerNumber != CpuMpData->BspNumber) {
1371 return EFI_SUCCESS;
1372 }
1373
1374 if (ProcessorNumber >= CpuMpData->CpuCount) {
1375 return EFI_NOT_FOUND;
1376 }
1377
1378 //
1379 // Check whether specified AP is disabled
1380 //
1381 State = GetApState (&CpuMpData->CpuData[ProcessorNumber]);
1382 if (State == CpuStateDisabled) {
1383 return EFI_INVALID_PARAMETER;
1384 }
1385
1386 //
1387 // Check whether ProcessorNumber specifies the current BSP
1388 //
1389 if (ProcessorNumber == CpuMpData->BspNumber) {
1390 return EFI_INVALID_PARAMETER;
1391 }
1392
1393 //
1394 // Check whether specified AP is busy
1395 //
1396 if (State == CpuStateBusy) {
1397 return EFI_NOT_READY;
1398 }
1399
1400 CpuMpData->BSPInfo.State = CPU_SWITCH_STATE_IDLE;
1401 CpuMpData->APInfo.State = CPU_SWITCH_STATE_IDLE;
1402 CpuMpData->SwitchBspFlag = TRUE;
1403
1404 //
1405 // Clear the BSP bit of MSR_IA32_APIC_BASE
1406 //
1407 ApicBaseMsr.Uint64 = AsmReadMsr64 (MSR_IA32_APIC_BASE);
1408 ApicBaseMsr.Bits.BSP = 0;
1409 AsmWriteMsr64 (MSR_IA32_APIC_BASE, ApicBaseMsr.Uint64);
1410
1411 //
1412 // Need to wakeUp AP (future BSP).
1413 //
1414 WakeUpAP (CpuMpData, FALSE, ProcessorNumber, FutureBSPProc, CpuMpData);
1415
1416 AsmExchangeRole (&CpuMpData->BSPInfo, &CpuMpData->APInfo);
1417
1418 //
1419 // Set the BSP bit of MSR_IA32_APIC_BASE on new BSP
1420 //
1421 ApicBaseMsr.Uint64 = AsmReadMsr64 (MSR_IA32_APIC_BASE);
1422 ApicBaseMsr.Bits.BSP = 1;
1423 AsmWriteMsr64 (MSR_IA32_APIC_BASE, ApicBaseMsr.Uint64);
1424
1425 //
1426 // Wait for old BSP finished AP task
1427 //
1428 while (GetApState (&CpuMpData->CpuData[CallerNumber]) != CpuStateFinished) {
1429 CpuPause ();
1430 }
1431
1432 CpuMpData->SwitchBspFlag = FALSE;
1433 //
1434 // Set old BSP enable state
1435 //
1436 if (!EnableOldBSP) {
1437 SetApState (&CpuMpData->CpuData[CallerNumber], CpuStateDisabled);
1438 }
1439 //
1440 // Save new BSP number
1441 //
1442 CpuMpData->BspNumber = (UINT32) ProcessorNumber;
1443
1444 return EFI_SUCCESS;
1445 }
1446
1447 /**
1448 Worker function to let the caller enable or disable an AP from this point onward.
1449 This service may only be called from the BSP.
1450
1451 @param[in] ProcessorNumber The handle number of AP.
1452 @param[in] EnableAP Specifies the new state for the processor for
1453 enabled, FALSE for disabled.
1454 @param[in] HealthFlag If not NULL, a pointer to a value that specifies
1455 the new health status of the AP.
1456
1457 @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
1458 @retval others Failed to Enable/Disable AP.
1459
1460 **/
1461 EFI_STATUS
1462 EnableDisableApWorker (
1463 IN UINTN ProcessorNumber,
1464 IN BOOLEAN EnableAP,
1465 IN UINT32 *HealthFlag OPTIONAL
1466 )
1467 {
1468 CPU_MP_DATA *CpuMpData;
1469 UINTN CallerNumber;
1470
1471 CpuMpData = GetCpuMpData ();
1472
1473 //
1474 // Check whether caller processor is BSP
1475 //
1476 MpInitLibWhoAmI (&CallerNumber);
1477 if (CallerNumber != CpuMpData->BspNumber) {
1478 return EFI_DEVICE_ERROR;
1479 }
1480
1481 if (ProcessorNumber == CpuMpData->BspNumber) {
1482 return EFI_INVALID_PARAMETER;
1483 }
1484
1485 if (ProcessorNumber >= CpuMpData->CpuCount) {
1486 return EFI_NOT_FOUND;
1487 }
1488
1489 if (!EnableAP) {
1490 SetApState (&CpuMpData->CpuData[ProcessorNumber], CpuStateDisabled);
1491 } else {
1492 SetApState (&CpuMpData->CpuData[ProcessorNumber], CpuStateIdle);
1493 }
1494
1495 if (HealthFlag != NULL) {
1496 CpuMpData->CpuData[ProcessorNumber].CpuHealthy =
1497 (BOOLEAN) ((*HealthFlag & PROCESSOR_HEALTH_STATUS_BIT) != 0);
1498 }
1499
1500 return EFI_SUCCESS;
1501 }
1502
1503 /**
1504 This return the handle number for the calling processor. This service may be
1505 called from the BSP and APs.
1506
1507 @param[out] ProcessorNumber Pointer to the handle number of AP.
1508 The range is from 0 to the total number of
1509 logical processors minus 1. The total number of
1510 logical processors can be retrieved by
1511 MpInitLibGetNumberOfProcessors().
1512
1513 @retval EFI_SUCCESS The current processor handle number was returned
1514 in ProcessorNumber.
1515 @retval EFI_INVALID_PARAMETER ProcessorNumber is NULL.
1516 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1517
1518 **/
1519 EFI_STATUS
1520 EFIAPI
1521 MpInitLibWhoAmI (
1522 OUT UINTN *ProcessorNumber
1523 )
1524 {
1525 CPU_MP_DATA *CpuMpData;
1526
1527 if (ProcessorNumber == NULL) {
1528 return EFI_INVALID_PARAMETER;
1529 }
1530
1531 CpuMpData = GetCpuMpData ();
1532
1533 return GetProcessorNumber (CpuMpData, ProcessorNumber);
1534 }
1535
1536 /**
1537 Retrieves the number of logical processor in the platform and the number of
1538 those logical processors that are enabled on this boot. This service may only
1539 be called from the BSP.
1540
1541 @param[out] NumberOfProcessors Pointer to the total number of logical
1542 processors in the system, including the BSP
1543 and disabled APs.
1544 @param[out] NumberOfEnabledProcessors Pointer to the number of enabled logical
1545 processors that exist in system, including
1546 the BSP.
1547
1548 @retval EFI_SUCCESS The number of logical processors and enabled
1549 logical processors was retrieved.
1550 @retval EFI_DEVICE_ERROR The calling processor is an AP.
1551 @retval EFI_INVALID_PARAMETER NumberOfProcessors is NULL and NumberOfEnabledProcessors
1552 is NULL.
1553 @retval EFI_NOT_READY MP Initialize Library is not initialized.
1554
1555 **/
1556 EFI_STATUS
1557 EFIAPI
1558 MpInitLibGetNumberOfProcessors (
1559 OUT UINTN *NumberOfProcessors, OPTIONAL
1560 OUT UINTN *NumberOfEnabledProcessors OPTIONAL
1561 )
1562 {
1563 CPU_MP_DATA *CpuMpData;
1564 UINTN CallerNumber;
1565 UINTN ProcessorNumber;
1566 UINTN EnabledProcessorNumber;
1567 UINTN Index;
1568
1569 CpuMpData = GetCpuMpData ();
1570
1571 if ((NumberOfProcessors == NULL) && (NumberOfEnabledProcessors == NULL)) {
1572 return EFI_INVALID_PARAMETER;
1573 }
1574
1575 //
1576 // Check whether caller processor is BSP
1577 //
1578 MpInitLibWhoAmI (&CallerNumber);
1579 if (CallerNumber != CpuMpData->BspNumber) {
1580 return EFI_DEVICE_ERROR;
1581 }
1582
1583 ProcessorNumber = CpuMpData->CpuCount;
1584 EnabledProcessorNumber = 0;
1585 for (Index = 0; Index < ProcessorNumber; Index++) {
1586 if (GetApState (&CpuMpData->CpuData[Index]) != CpuStateDisabled) {
1587 EnabledProcessorNumber ++;
1588 }
1589 }
1590
1591 if (NumberOfProcessors != NULL) {
1592 *NumberOfProcessors = ProcessorNumber;
1593 }
1594 if (NumberOfEnabledProcessors != NULL) {
1595 *NumberOfEnabledProcessors = EnabledProcessorNumber;
1596 }
1597
1598 return EFI_SUCCESS;
1599 }
1600
1601
1602 /**
1603 Worker function to execute a caller provided function on all enabled APs.
1604
1605 @param[in] Procedure A pointer to the function to be run on
1606 enabled APs of the system.
1607 @param[in] SingleThread If TRUE, then all the enabled APs execute
1608 the function specified by Procedure one by
1609 one, in ascending order of processor handle
1610 number. If FALSE, then all the enabled APs
1611 execute the function specified by Procedure
1612 simultaneously.
1613 @param[in] WaitEvent The event created by the caller with CreateEvent()
1614 service.
1615 @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for
1616 APs to return from Procedure, either for
1617 blocking or non-blocking mode.
1618 @param[in] ProcedureArgument The parameter passed into Procedure for
1619 all APs.
1620 @param[out] FailedCpuList If all APs finish successfully, then its
1621 content is set to NULL. If not all APs
1622 finish before timeout expires, then its
1623 content is set to address of the buffer
1624 holding handle numbers of the failed APs.
1625
1626 @retval EFI_SUCCESS In blocking mode, all APs have finished before
1627 the timeout expired.
1628 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched
1629 to all enabled APs.
1630 @retval others Failed to Startup all APs.
1631
1632 **/
1633 EFI_STATUS
1634 StartupAllAPsWorker (
1635 IN EFI_AP_PROCEDURE Procedure,
1636 IN BOOLEAN SingleThread,
1637 IN EFI_EVENT WaitEvent OPTIONAL,
1638 IN UINTN TimeoutInMicroseconds,
1639 IN VOID *ProcedureArgument OPTIONAL,
1640 OUT UINTN **FailedCpuList OPTIONAL
1641 )
1642 {
1643 EFI_STATUS Status;
1644 CPU_MP_DATA *CpuMpData;
1645 UINTN ProcessorCount;
1646 UINTN ProcessorNumber;
1647 UINTN CallerNumber;
1648 CPU_AP_DATA *CpuData;
1649 BOOLEAN HasEnabledAp;
1650 CPU_STATE ApState;
1651
1652 CpuMpData = GetCpuMpData ();
1653
1654 if (FailedCpuList != NULL) {
1655 *FailedCpuList = NULL;
1656 }
1657
1658 if (CpuMpData->CpuCount == 1) {
1659 return EFI_NOT_STARTED;
1660 }
1661
1662 if (Procedure == NULL) {
1663 return EFI_INVALID_PARAMETER;
1664 }
1665
1666 //
1667 // Check whether caller processor is BSP
1668 //
1669 MpInitLibWhoAmI (&CallerNumber);
1670 if (CallerNumber != CpuMpData->BspNumber) {
1671 return EFI_DEVICE_ERROR;
1672 }
1673
1674 //
1675 // Update AP state
1676 //
1677 CheckAndUpdateApsStatus ();
1678
1679 ProcessorCount = CpuMpData->CpuCount;
1680 HasEnabledAp = FALSE;
1681 //
1682 // Check whether all enabled APs are idle.
1683 // If any enabled AP is not idle, return EFI_NOT_READY.
1684 //
1685 for (ProcessorNumber = 0; ProcessorNumber < ProcessorCount; ProcessorNumber++) {
1686 CpuData = &CpuMpData->CpuData[ProcessorNumber];
1687 if (ProcessorNumber != CpuMpData->BspNumber) {
1688 ApState = GetApState (CpuData);
1689 if (ApState != CpuStateDisabled) {
1690 HasEnabledAp = TRUE;
1691 if (ApState != CpuStateIdle) {
1692 //
1693 // If any enabled APs are busy, return EFI_NOT_READY.
1694 //
1695 return EFI_NOT_READY;
1696 }
1697 }
1698 }
1699 }
1700
1701 if (!HasEnabledAp) {
1702 //
1703 // If no enabled AP exists, return EFI_NOT_STARTED.
1704 //
1705 return EFI_NOT_STARTED;
1706 }
1707
1708 CpuMpData->StartCount = 0;
1709 for (ProcessorNumber = 0; ProcessorNumber < ProcessorCount; ProcessorNumber++) {
1710 CpuData = &CpuMpData->CpuData[ProcessorNumber];
1711 CpuData->Waiting = FALSE;
1712 if (ProcessorNumber != CpuMpData->BspNumber) {
1713 if (CpuData->State == CpuStateIdle) {
1714 //
1715 // Mark this processor as responsible for current calling.
1716 //
1717 CpuData->Waiting = TRUE;
1718 CpuMpData->StartCount++;
1719 }
1720 }
1721 }
1722
1723 CpuMpData->Procedure = Procedure;
1724 CpuMpData->ProcArguments = ProcedureArgument;
1725 CpuMpData->SingleThread = SingleThread;
1726 CpuMpData->FinishedCount = 0;
1727 CpuMpData->RunningCount = 0;
1728 CpuMpData->FailedCpuList = FailedCpuList;
1729 CpuMpData->ExpectedTime = CalculateTimeout (
1730 TimeoutInMicroseconds,
1731 &CpuMpData->CurrentTime
1732 );
1733 CpuMpData->TotalTime = 0;
1734 CpuMpData->WaitEvent = WaitEvent;
1735
1736 if (!SingleThread) {
1737 WakeUpAP (CpuMpData, TRUE, 0, Procedure, ProcedureArgument);
1738 } else {
1739 for (ProcessorNumber = 0; ProcessorNumber < ProcessorCount; ProcessorNumber++) {
1740 if (ProcessorNumber == CallerNumber) {
1741 continue;
1742 }
1743 if (CpuMpData->CpuData[ProcessorNumber].Waiting) {
1744 WakeUpAP (CpuMpData, FALSE, ProcessorNumber, Procedure, ProcedureArgument);
1745 break;
1746 }
1747 }
1748 }
1749
1750 Status = EFI_SUCCESS;
1751 if (WaitEvent == NULL) {
1752 do {
1753 Status = CheckAllAPs ();
1754 } while (Status == EFI_NOT_READY);
1755 }
1756
1757 return Status;
1758 }
1759
1760 /**
1761 Worker function to let the caller get one enabled AP to execute a caller-provided
1762 function.
1763
1764 @param[in] Procedure A pointer to the function to be run on
1765 enabled APs of the system.
1766 @param[in] ProcessorNumber The handle number of the AP.
1767 @param[in] WaitEvent The event created by the caller with CreateEvent()
1768 service.
1769 @param[in] TimeoutInMicrosecsond Indicates the time limit in microseconds for
1770 APs to return from Procedure, either for
1771 blocking or non-blocking mode.
1772 @param[in] ProcedureArgument The parameter passed into Procedure for
1773 all APs.
1774 @param[out] Finished If AP returns from Procedure before the
1775 timeout expires, its content is set to TRUE.
1776 Otherwise, the value is set to FALSE.
1777
1778 @retval EFI_SUCCESS In blocking mode, specified AP finished before
1779 the timeout expires.
1780 @retval others Failed to Startup AP.
1781
1782 **/
1783 EFI_STATUS
1784 StartupThisAPWorker (
1785 IN EFI_AP_PROCEDURE Procedure,
1786 IN UINTN ProcessorNumber,
1787 IN EFI_EVENT WaitEvent OPTIONAL,
1788 IN UINTN TimeoutInMicroseconds,
1789 IN VOID *ProcedureArgument OPTIONAL,
1790 OUT BOOLEAN *Finished OPTIONAL
1791 )
1792 {
1793 EFI_STATUS Status;
1794 CPU_MP_DATA *CpuMpData;
1795 CPU_AP_DATA *CpuData;
1796 UINTN CallerNumber;
1797
1798 CpuMpData = GetCpuMpData ();
1799
1800 if (Finished != NULL) {
1801 *Finished = FALSE;
1802 }
1803
1804 //
1805 // Check whether caller processor is BSP
1806 //
1807 MpInitLibWhoAmI (&CallerNumber);
1808 if (CallerNumber != CpuMpData->BspNumber) {
1809 return EFI_DEVICE_ERROR;
1810 }
1811
1812 //
1813 // Check whether processor with the handle specified by ProcessorNumber exists
1814 //
1815 if (ProcessorNumber >= CpuMpData->CpuCount) {
1816 return EFI_NOT_FOUND;
1817 }
1818
1819 //
1820 // Check whether specified processor is BSP
1821 //
1822 if (ProcessorNumber == CpuMpData->BspNumber) {
1823 return EFI_INVALID_PARAMETER;
1824 }
1825
1826 //
1827 // Check parameter Procedure
1828 //
1829 if (Procedure == NULL) {
1830 return EFI_INVALID_PARAMETER;
1831 }
1832
1833 //
1834 // Update AP state
1835 //
1836 CheckAndUpdateApsStatus ();
1837
1838 //
1839 // Check whether specified AP is disabled
1840 //
1841 if (GetApState (&CpuMpData->CpuData[ProcessorNumber]) == CpuStateDisabled) {
1842 return EFI_INVALID_PARAMETER;
1843 }
1844
1845 //
1846 // If WaitEvent is not NULL, execute in non-blocking mode.
1847 // BSP saves data for CheckAPsStatus(), and returns EFI_SUCCESS.
1848 // CheckAPsStatus() will check completion and timeout periodically.
1849 //
1850 CpuData = &CpuMpData->CpuData[ProcessorNumber];
1851 CpuData->WaitEvent = WaitEvent;
1852 CpuData->Finished = Finished;
1853 CpuData->ExpectedTime = CalculateTimeout (TimeoutInMicroseconds, &CpuData->CurrentTime);
1854 CpuData->TotalTime = 0;
1855
1856 WakeUpAP (CpuMpData, FALSE, ProcessorNumber, Procedure, ProcedureArgument);
1857
1858 //
1859 // If WaitEvent is NULL, execute in blocking mode.
1860 // BSP checks AP's state until it finishes or TimeoutInMicrosecsond expires.
1861 //
1862 Status = EFI_SUCCESS;
1863 if (WaitEvent == NULL) {
1864 do {
1865 Status = CheckThisAP (ProcessorNumber);
1866 } while (Status == EFI_NOT_READY);
1867 }
1868
1869 return Status;
1870 }
1871
1872 /**
1873 Get pointer to CPU MP Data structure from GUIDed HOB.
1874
1875 @return The pointer to CPU MP Data structure.
1876 **/
1877 CPU_MP_DATA *
1878 GetCpuMpDataFromGuidedHob (
1879 VOID
1880 )
1881 {
1882 EFI_HOB_GUID_TYPE *GuidHob;
1883 VOID *DataInHob;
1884 CPU_MP_DATA *CpuMpData;
1885
1886 CpuMpData = NULL;
1887 GuidHob = GetFirstGuidHob (&mCpuInitMpLibHobGuid);
1888 if (GuidHob != NULL) {
1889 DataInHob = GET_GUID_HOB_DATA (GuidHob);
1890 CpuMpData = (CPU_MP_DATA *) (*(UINTN *) DataInHob);
1891 }
1892 return CpuMpData;
1893 }
1894
1895 /**
1896 Get available system memory below 1MB by specified size.
1897
1898 @param[in] CpuMpData The pointer to CPU MP Data structure.
1899 **/
1900 VOID
1901 BackupAndPrepareWakeupBuffer(
1902 IN CPU_MP_DATA *CpuMpData
1903 )
1904 {
1905 CopyMem (
1906 (VOID *) CpuMpData->BackupBuffer,
1907 (VOID *) CpuMpData->WakeupBuffer,
1908 CpuMpData->BackupBufferSize
1909 );
1910 CopyMem (
1911 (VOID *) CpuMpData->WakeupBuffer,
1912 (VOID *) CpuMpData->AddressMap.RendezvousFunnelAddress,
1913 CpuMpData->AddressMap.RendezvousFunnelSize
1914 );
1915 }
1916
1917 /**
1918 Restore wakeup buffer data.
1919
1920 @param[in] CpuMpData The pointer to CPU MP Data structure.
1921 **/
1922 VOID
1923 RestoreWakeupBuffer(
1924 IN CPU_MP_DATA *CpuMpData
1925 )
1926 {
1927 CopyMem (
1928 (VOID *) CpuMpData->WakeupBuffer,
1929 (VOID *) CpuMpData->BackupBuffer,
1930 CpuMpData->BackupBufferSize
1931 );
1932 }