]> git.proxmox.com Git - mirror_edk2.git/blob - UefiCpuPkg/Library/MpInitLib/DxeMpLib.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm
[mirror_edk2.git] / UefiCpuPkg / Library / MpInitLib / DxeMpLib.c
1 /** @file
2 MP initialize support functions for DXE phase.
3
4 Copyright (c) 2016 - 2020, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
6
7 **/
8
9 #include "MpLib.h"
10
11 #include <Library/UefiLib.h>
12 #include <Library/UefiBootServicesTableLib.h>
13 #include <Library/DebugAgentLib.h>
14 #include <Library/DxeServicesTableLib.h>
15 #include <Library/VmgExitLib.h>
16 #include <Register/Amd/Fam17Msr.h>
17 #include <Register/Amd/Ghcb.h>
18
19 #include <Protocol/Timer.h>
20
21 #define AP_SAFE_STACK_SIZE 128
22
23 CPU_MP_DATA *mCpuMpData = NULL;
24 EFI_EVENT mCheckAllApsEvent = NULL;
25 EFI_EVENT mMpInitExitBootServicesEvent = NULL;
26 EFI_EVENT mLegacyBootEvent = NULL;
27 volatile BOOLEAN mStopCheckAllApsStatus = TRUE;
28 VOID *mReservedApLoopFunc = NULL;
29 UINTN mReservedTopOfApStack;
30 volatile UINT32 mNumberToFinish = 0;
31
32 //
33 // Begin wakeup buffer allocation below 0x88000
34 //
35 STATIC EFI_PHYSICAL_ADDRESS mSevEsDxeWakeupBuffer = 0x88000;
36
37 /**
38 Enable Debug Agent to support source debugging on AP function.
39
40 **/
41 VOID
42 EnableDebugAgent (
43 VOID
44 )
45 {
46 //
47 // Initialize Debug Agent to support source level debug in DXE phase
48 //
49 InitializeDebugAgent (DEBUG_AGENT_INIT_DXE_AP, NULL, NULL);
50 }
51
52 /**
53 Get the pointer to CPU MP Data structure.
54
55 @return The pointer to CPU MP Data structure.
56 **/
57 CPU_MP_DATA *
58 GetCpuMpData (
59 VOID
60 )
61 {
62 ASSERT (mCpuMpData != NULL);
63 return mCpuMpData;
64 }
65
66 /**
67 Save the pointer to CPU MP Data structure.
68
69 @param[in] CpuMpData The pointer to CPU MP Data structure will be saved.
70 **/
71 VOID
72 SaveCpuMpData (
73 IN CPU_MP_DATA *CpuMpData
74 )
75 {
76 mCpuMpData = CpuMpData;
77 }
78
79 /**
80 Get available system memory below 0x88000 by specified size.
81
82 @param[in] WakeupBufferSize Wakeup buffer size required
83
84 @retval other Return wakeup buffer address below 1MB.
85 @retval -1 Cannot find free memory below 1MB.
86 **/
87 UINTN
88 GetWakeupBuffer (
89 IN UINTN WakeupBufferSize
90 )
91 {
92 EFI_STATUS Status;
93 EFI_PHYSICAL_ADDRESS StartAddress;
94 EFI_MEMORY_TYPE MemoryType;
95
96 if (ConfidentialComputingGuestHas (CCAttrAmdSevEs) &&
97 !ConfidentialComputingGuestHas (CCAttrAmdSevSnp))
98 {
99 //
100 // An SEV-ES-only guest requires the memory to be reserved. SEV-SNP, which
101 // is also considered SEV-ES, uses a different AP startup method, though,
102 // which does not have the same requirement.
103 //
104 MemoryType = EfiReservedMemoryType;
105 } else {
106 MemoryType = EfiBootServicesData;
107 }
108
109 //
110 // Try to allocate buffer below 1M for waking vector.
111 // LegacyBios driver only reports warning when page allocation in range
112 // [0x60000, 0x88000) fails.
113 // This library is consumed by CpuDxe driver to produce CPU Arch protocol.
114 // LagacyBios driver depends on CPU Arch protocol which guarantees below
115 // allocation runs earlier than LegacyBios driver.
116 //
117 if (ConfidentialComputingGuestHas (CCAttrAmdSevEs)) {
118 //
119 // SEV-ES Wakeup buffer should be under 0x88000 and under any previous one
120 //
121 StartAddress = mSevEsDxeWakeupBuffer;
122 } else {
123 StartAddress = 0x88000;
124 }
125
126 Status = gBS->AllocatePages (
127 AllocateMaxAddress,
128 MemoryType,
129 EFI_SIZE_TO_PAGES (WakeupBufferSize),
130 &StartAddress
131 );
132 ASSERT_EFI_ERROR (Status);
133 if (EFI_ERROR (Status)) {
134 StartAddress = (EFI_PHYSICAL_ADDRESS)-1;
135 } else if (ConfidentialComputingGuestHas (CCAttrAmdSevEs)) {
136 //
137 // Next SEV-ES wakeup buffer allocation must be below this allocation
138 //
139 mSevEsDxeWakeupBuffer = StartAddress;
140 }
141
142 DEBUG ((
143 DEBUG_INFO,
144 "WakeupBufferStart = %x, WakeupBufferSize = %x\n",
145 (UINTN)StartAddress,
146 WakeupBufferSize
147 ));
148
149 return (UINTN)StartAddress;
150 }
151
152 /**
153 Get available EfiBootServicesCode memory below 4GB by specified size.
154
155 This buffer is required to safely transfer AP from real address mode to
156 protected mode or long mode, due to the fact that the buffer returned by
157 GetWakeupBuffer() may be marked as non-executable.
158
159 @param[in] BufferSize Wakeup transition buffer size.
160
161 @retval other Return wakeup transition buffer address below 4GB.
162 @retval 0 Cannot find free memory below 4GB.
163 **/
164 UINTN
165 AllocateCodeBuffer (
166 IN UINTN BufferSize
167 )
168 {
169 EFI_STATUS Status;
170 EFI_PHYSICAL_ADDRESS StartAddress;
171
172 StartAddress = BASE_4GB - 1;
173 Status = gBS->AllocatePages (
174 AllocateMaxAddress,
175 EfiBootServicesCode,
176 EFI_SIZE_TO_PAGES (BufferSize),
177 &StartAddress
178 );
179 if (EFI_ERROR (Status)) {
180 StartAddress = 0;
181 }
182
183 return (UINTN)StartAddress;
184 }
185
186 /**
187 Return the address of the SEV-ES AP jump table.
188
189 This buffer is required in order for an SEV-ES guest to transition from
190 UEFI into an OS.
191
192 @return Return SEV-ES AP jump table buffer
193 **/
194 UINTN
195 GetSevEsAPMemory (
196 VOID
197 )
198 {
199 EFI_STATUS Status;
200 EFI_PHYSICAL_ADDRESS StartAddress;
201 MSR_SEV_ES_GHCB_REGISTER Msr;
202 GHCB *Ghcb;
203 BOOLEAN InterruptState;
204
205 //
206 // Allocate 1 page for AP jump table page
207 //
208 StartAddress = BASE_4GB - 1;
209 Status = gBS->AllocatePages (
210 AllocateMaxAddress,
211 EfiReservedMemoryType,
212 1,
213 &StartAddress
214 );
215 ASSERT_EFI_ERROR (Status);
216
217 DEBUG ((DEBUG_INFO, "Dxe: SevEsAPMemory = %lx\n", (UINTN)StartAddress));
218
219 //
220 // Save the SevEsAPMemory as the AP jump table.
221 //
222 Msr.GhcbPhysicalAddress = AsmReadMsr64 (MSR_SEV_ES_GHCB);
223 Ghcb = Msr.Ghcb;
224
225 VmgInit (Ghcb, &InterruptState);
226 VmgExit (Ghcb, SVM_EXIT_AP_JUMP_TABLE, 0, (UINT64)(UINTN)StartAddress);
227 VmgDone (Ghcb, InterruptState);
228
229 return (UINTN)StartAddress;
230 }
231
232 /**
233 Checks APs status and updates APs status if needed.
234
235 **/
236 VOID
237 CheckAndUpdateApsStatus (
238 VOID
239 )
240 {
241 UINTN ProcessorNumber;
242 EFI_STATUS Status;
243 CPU_MP_DATA *CpuMpData;
244
245 CpuMpData = GetCpuMpData ();
246
247 //
248 // First, check whether pending StartupAllAPs() exists.
249 //
250 if (CpuMpData->WaitEvent != NULL) {
251 Status = CheckAllAPs ();
252 //
253 // If all APs finish for StartupAllAPs(), signal the WaitEvent for it.
254 //
255 if (Status != EFI_NOT_READY) {
256 Status = gBS->SignalEvent (CpuMpData->WaitEvent);
257 CpuMpData->WaitEvent = NULL;
258 }
259 }
260
261 //
262 // Second, check whether pending StartupThisAPs() callings exist.
263 //
264 for (ProcessorNumber = 0; ProcessorNumber < CpuMpData->CpuCount; ProcessorNumber++) {
265 if (CpuMpData->CpuData[ProcessorNumber].WaitEvent == NULL) {
266 continue;
267 }
268
269 Status = CheckThisAP (ProcessorNumber);
270
271 if (Status != EFI_NOT_READY) {
272 gBS->SignalEvent (CpuMpData->CpuData[ProcessorNumber].WaitEvent);
273 CpuMpData->CpuData[ProcessorNumber].WaitEvent = NULL;
274 }
275 }
276 }
277
278 /**
279 Checks APs' status periodically.
280
281 This function is triggered by timer periodically to check the
282 state of APs for StartupAllAPs() and StartupThisAP() executed
283 in non-blocking mode.
284
285 @param[in] Event Event triggered.
286 @param[in] Context Parameter passed with the event.
287
288 **/
289 VOID
290 EFIAPI
291 CheckApsStatus (
292 IN EFI_EVENT Event,
293 IN VOID *Context
294 )
295 {
296 //
297 // If CheckApsStatus() is not stopped, otherwise return immediately.
298 //
299 if (!mStopCheckAllApsStatus) {
300 CheckAndUpdateApsStatus ();
301 }
302 }
303
304 /**
305 Get Protected mode code segment with 16-bit default addressing
306 from current GDT table.
307
308 @return Protected mode 16-bit code segment value.
309 **/
310 UINT16
311 GetProtectedMode16CS (
312 VOID
313 )
314 {
315 IA32_DESCRIPTOR GdtrDesc;
316 IA32_SEGMENT_DESCRIPTOR *GdtEntry;
317 UINTN GdtEntryCount;
318 UINT16 Index;
319
320 Index = (UINT16)-1;
321 AsmReadGdtr (&GdtrDesc);
322 GdtEntryCount = (GdtrDesc.Limit + 1) / sizeof (IA32_SEGMENT_DESCRIPTOR);
323 GdtEntry = (IA32_SEGMENT_DESCRIPTOR *)GdtrDesc.Base;
324 for (Index = 0; Index < GdtEntryCount; Index++) {
325 if (GdtEntry->Bits.L == 0) {
326 if ((GdtEntry->Bits.Type > 8) && (GdtEntry->Bits.DB == 0)) {
327 break;
328 }
329 }
330
331 GdtEntry++;
332 }
333
334 ASSERT (Index != GdtEntryCount);
335 return Index * 8;
336 }
337
338 /**
339 Get Protected mode code segment from current GDT table.
340
341 @return Protected mode code segment value.
342 **/
343 UINT16
344 GetProtectedModeCS (
345 VOID
346 )
347 {
348 IA32_DESCRIPTOR GdtrDesc;
349 IA32_SEGMENT_DESCRIPTOR *GdtEntry;
350 UINTN GdtEntryCount;
351 UINT16 Index;
352
353 AsmReadGdtr (&GdtrDesc);
354 GdtEntryCount = (GdtrDesc.Limit + 1) / sizeof (IA32_SEGMENT_DESCRIPTOR);
355 GdtEntry = (IA32_SEGMENT_DESCRIPTOR *)GdtrDesc.Base;
356 for (Index = 0; Index < GdtEntryCount; Index++) {
357 if (GdtEntry->Bits.L == 0) {
358 if ((GdtEntry->Bits.Type > 8) && (GdtEntry->Bits.DB == 1)) {
359 break;
360 }
361 }
362
363 GdtEntry++;
364 }
365
366 ASSERT (Index != GdtEntryCount);
367 return Index * 8;
368 }
369
370 /**
371 Do sync on APs.
372
373 @param[in, out] Buffer Pointer to private data buffer.
374 **/
375 VOID
376 EFIAPI
377 RelocateApLoop (
378 IN OUT VOID *Buffer
379 )
380 {
381 CPU_MP_DATA *CpuMpData;
382 BOOLEAN MwaitSupport;
383 ASM_RELOCATE_AP_LOOP AsmRelocateApLoopFunc;
384 UINTN ProcessorNumber;
385 UINTN StackStart;
386
387 MpInitLibWhoAmI (&ProcessorNumber);
388 CpuMpData = GetCpuMpData ();
389 MwaitSupport = IsMwaitSupport ();
390 if (CpuMpData->UseSevEsAPMethod) {
391 StackStart = CpuMpData->SevEsAPResetStackStart;
392 } else {
393 StackStart = mReservedTopOfApStack;
394 }
395
396 AsmRelocateApLoopFunc = (ASM_RELOCATE_AP_LOOP)(UINTN)mReservedApLoopFunc;
397 AsmRelocateApLoopFunc (
398 MwaitSupport,
399 CpuMpData->ApTargetCState,
400 CpuMpData->PmCodeSegment,
401 StackStart - ProcessorNumber * AP_SAFE_STACK_SIZE,
402 (UINTN)&mNumberToFinish,
403 CpuMpData->Pm16CodeSegment,
404 CpuMpData->SevEsAPBuffer,
405 CpuMpData->WakeupBuffer
406 );
407 //
408 // It should never reach here
409 //
410 ASSERT (FALSE);
411 }
412
413 /**
414 Callback function for ExitBootServices.
415
416 @param[in] Event Event whose notification function is being invoked.
417 @param[in] Context The pointer to the notification function's context,
418 which is implementation-dependent.
419
420 **/
421 VOID
422 EFIAPI
423 MpInitChangeApLoopCallback (
424 IN EFI_EVENT Event,
425 IN VOID *Context
426 )
427 {
428 CPU_MP_DATA *CpuMpData;
429
430 CpuMpData = GetCpuMpData ();
431 CpuMpData->PmCodeSegment = GetProtectedModeCS ();
432 CpuMpData->Pm16CodeSegment = GetProtectedMode16CS ();
433 CpuMpData->ApLoopMode = PcdGet8 (PcdCpuApLoopMode);
434 mNumberToFinish = CpuMpData->CpuCount - 1;
435 WakeUpAP (CpuMpData, TRUE, 0, RelocateApLoop, NULL, TRUE);
436 while (mNumberToFinish > 0) {
437 CpuPause ();
438 }
439
440 if (CpuMpData->UseSevEsAPMethod && (CpuMpData->WakeupBuffer != (UINTN)-1)) {
441 //
442 // There are APs present. Re-use reserved memory area below 1MB from
443 // WakeupBuffer as the area to be used for transitioning to 16-bit mode
444 // in support of booting of the AP by an OS.
445 //
446 CopyMem (
447 (VOID *)CpuMpData->WakeupBuffer,
448 (VOID *)(CpuMpData->AddressMap.RendezvousFunnelAddress +
449 CpuMpData->AddressMap.SwitchToRealPM16ModeOffset),
450 CpuMpData->AddressMap.SwitchToRealPM16ModeSize
451 );
452 }
453
454 DEBUG ((DEBUG_INFO, "%a() done!\n", __FUNCTION__));
455 }
456
457 /**
458 Initialize global data for MP support.
459
460 @param[in] CpuMpData The pointer to CPU MP Data structure.
461 **/
462 VOID
463 InitMpGlobalData (
464 IN CPU_MP_DATA *CpuMpData
465 )
466 {
467 EFI_STATUS Status;
468 EFI_PHYSICAL_ADDRESS Address;
469 UINTN ApSafeBufferSize;
470 UINTN Index;
471 EFI_GCD_MEMORY_SPACE_DESCRIPTOR MemDesc;
472 UINTN StackBase;
473 CPU_INFO_IN_HOB *CpuInfoInHob;
474
475 SaveCpuMpData (CpuMpData);
476
477 if (CpuMpData->CpuCount == 1) {
478 //
479 // If only BSP exists, return
480 //
481 return;
482 }
483
484 if (PcdGetBool (PcdCpuStackGuard)) {
485 //
486 // One extra page at the bottom of the stack is needed for Guard page.
487 //
488 if (CpuMpData->CpuApStackSize <= EFI_PAGE_SIZE) {
489 DEBUG ((DEBUG_ERROR, "PcdCpuApStackSize is not big enough for Stack Guard!\n"));
490 ASSERT (FALSE);
491 }
492
493 //
494 // DXE will reuse stack allocated for APs at PEI phase if it's available.
495 // Let's check it here.
496 //
497 // Note: BSP's stack guard is set at DxeIpl phase. But for the sake of
498 // BSP/AP exchange, stack guard for ApTopOfStack of cpu 0 will still be
499 // set here.
500 //
501 CpuInfoInHob = (CPU_INFO_IN_HOB *)(UINTN)CpuMpData->CpuInfoInHob;
502 for (Index = 0; Index < CpuMpData->CpuCount; ++Index) {
503 if ((CpuInfoInHob != NULL) && (CpuInfoInHob[Index].ApTopOfStack != 0)) {
504 StackBase = (UINTN)CpuInfoInHob[Index].ApTopOfStack - CpuMpData->CpuApStackSize;
505 } else {
506 StackBase = CpuMpData->Buffer + Index * CpuMpData->CpuApStackSize;
507 }
508
509 Status = gDS->GetMemorySpaceDescriptor (StackBase, &MemDesc);
510 ASSERT_EFI_ERROR (Status);
511
512 Status = gDS->SetMemorySpaceAttributes (
513 StackBase,
514 EFI_PAGES_TO_SIZE (1),
515 MemDesc.Attributes | EFI_MEMORY_RP
516 );
517 ASSERT_EFI_ERROR (Status);
518
519 DEBUG ((
520 DEBUG_INFO,
521 "Stack Guard set at %lx [cpu%lu]!\n",
522 (UINT64)StackBase,
523 (UINT64)Index
524 ));
525 }
526 }
527
528 //
529 // Avoid APs access invalid buffer data which allocated by BootServices,
530 // so we will allocate reserved data for AP loop code. We also need to
531 // allocate this buffer below 4GB due to APs may be transferred to 32bit
532 // protected mode on long mode DXE.
533 // Allocating it in advance since memory services are not available in
534 // Exit Boot Services callback function.
535 //
536 ApSafeBufferSize = EFI_PAGES_TO_SIZE (
537 EFI_SIZE_TO_PAGES (
538 CpuMpData->AddressMap.RelocateApLoopFuncSize
539 )
540 );
541 Address = BASE_4GB - 1;
542 Status = gBS->AllocatePages (
543 AllocateMaxAddress,
544 EfiReservedMemoryType,
545 EFI_SIZE_TO_PAGES (ApSafeBufferSize),
546 &Address
547 );
548 ASSERT_EFI_ERROR (Status);
549
550 mReservedApLoopFunc = (VOID *)(UINTN)Address;
551 ASSERT (mReservedApLoopFunc != NULL);
552
553 //
554 // Make sure that the buffer memory is executable if NX protection is enabled
555 // for EfiReservedMemoryType.
556 //
557 // TODO: Check EFI_MEMORY_XP bit set or not once it's available in DXE GCD
558 // service.
559 //
560 Status = gDS->GetMemorySpaceDescriptor (Address, &MemDesc);
561 if (!EFI_ERROR (Status)) {
562 gDS->SetMemorySpaceAttributes (
563 Address,
564 ApSafeBufferSize,
565 MemDesc.Attributes & (~EFI_MEMORY_XP)
566 );
567 }
568
569 ApSafeBufferSize = EFI_PAGES_TO_SIZE (
570 EFI_SIZE_TO_PAGES (
571 CpuMpData->CpuCount * AP_SAFE_STACK_SIZE
572 )
573 );
574 Address = BASE_4GB - 1;
575 Status = gBS->AllocatePages (
576 AllocateMaxAddress,
577 EfiReservedMemoryType,
578 EFI_SIZE_TO_PAGES (ApSafeBufferSize),
579 &Address
580 );
581 ASSERT_EFI_ERROR (Status);
582
583 mReservedTopOfApStack = (UINTN)Address + ApSafeBufferSize;
584 ASSERT ((mReservedTopOfApStack & (UINTN)(CPU_STACK_ALIGNMENT - 1)) == 0);
585 CopyMem (
586 mReservedApLoopFunc,
587 CpuMpData->AddressMap.RelocateApLoopFuncAddress,
588 CpuMpData->AddressMap.RelocateApLoopFuncSize
589 );
590
591 Status = gBS->CreateEvent (
592 EVT_TIMER | EVT_NOTIFY_SIGNAL,
593 TPL_NOTIFY,
594 CheckApsStatus,
595 NULL,
596 &mCheckAllApsEvent
597 );
598 ASSERT_EFI_ERROR (Status);
599
600 //
601 // Set timer to check all APs status.
602 //
603 Status = gBS->SetTimer (
604 mCheckAllApsEvent,
605 TimerPeriodic,
606 EFI_TIMER_PERIOD_MICROSECONDS (
607 PcdGet32 (PcdCpuApStatusCheckIntervalInMicroSeconds)
608 )
609 );
610 ASSERT_EFI_ERROR (Status);
611
612 Status = gBS->CreateEvent (
613 EVT_SIGNAL_EXIT_BOOT_SERVICES,
614 TPL_CALLBACK,
615 MpInitChangeApLoopCallback,
616 NULL,
617 &mMpInitExitBootServicesEvent
618 );
619 ASSERT_EFI_ERROR (Status);
620
621 Status = gBS->CreateEventEx (
622 EVT_NOTIFY_SIGNAL,
623 TPL_CALLBACK,
624 MpInitChangeApLoopCallback,
625 NULL,
626 &gEfiEventLegacyBootGuid,
627 &mLegacyBootEvent
628 );
629 ASSERT_EFI_ERROR (Status);
630 }
631
632 /**
633 This service executes a caller provided function on all enabled APs.
634
635 @param[in] Procedure A pointer to the function to be run on
636 enabled APs of the system. See type
637 EFI_AP_PROCEDURE.
638 @param[in] SingleThread If TRUE, then all the enabled APs execute
639 the function specified by Procedure one by
640 one, in ascending order of processor handle
641 number. If FALSE, then all the enabled APs
642 execute the function specified by Procedure
643 simultaneously.
644 @param[in] WaitEvent The event created by the caller with CreateEvent()
645 service. If it is NULL, then execute in
646 blocking mode. BSP waits until all APs finish
647 or TimeoutInMicroSeconds expires. If it's
648 not NULL, then execute in non-blocking mode.
649 BSP requests the function specified by
650 Procedure to be started on all the enabled
651 APs, and go on executing immediately. If
652 all return from Procedure, or TimeoutInMicroSeconds
653 expires, this event is signaled. The BSP
654 can use the CheckEvent() or WaitForEvent()
655 services to check the state of event. Type
656 EFI_EVENT is defined in CreateEvent() in
657 the Unified Extensible Firmware Interface
658 Specification.
659 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
660 APs to return from Procedure, either for
661 blocking or non-blocking mode. Zero means
662 infinity. If the timeout expires before
663 all APs return from Procedure, then Procedure
664 on the failed APs is terminated. All enabled
665 APs are available for next function assigned
666 by MpInitLibStartupAllAPs() or
667 MPInitLibStartupThisAP().
668 If the timeout expires in blocking mode,
669 BSP returns EFI_TIMEOUT. If the timeout
670 expires in non-blocking mode, WaitEvent
671 is signaled with SignalEvent().
672 @param[in] ProcedureArgument The parameter passed into Procedure for
673 all APs.
674 @param[out] FailedCpuList If NULL, this parameter is ignored. Otherwise,
675 if all APs finish successfully, then its
676 content is set to NULL. If not all APs
677 finish before timeout expires, then its
678 content is set to address of the buffer
679 holding handle numbers of the failed APs.
680 The buffer is allocated by MP Initialization
681 library, and it's the caller's responsibility to
682 free the buffer with FreePool() service.
683 In blocking mode, it is ready for consumption
684 when the call returns. In non-blocking mode,
685 it is ready when WaitEvent is signaled. The
686 list of failed CPU is terminated by
687 END_OF_CPU_LIST.
688
689 @retval EFI_SUCCESS In blocking mode, all APs have finished before
690 the timeout expired.
691 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched
692 to all enabled APs.
693 @retval EFI_UNSUPPORTED A non-blocking mode request was made after the
694 UEFI event EFI_EVENT_GROUP_READY_TO_BOOT was
695 signaled.
696 @retval EFI_UNSUPPORTED WaitEvent is not NULL if non-blocking mode is not
697 supported.
698 @retval EFI_DEVICE_ERROR Caller processor is AP.
699 @retval EFI_NOT_STARTED No enabled APs exist in the system.
700 @retval EFI_NOT_READY Any enabled APs are busy.
701 @retval EFI_NOT_READY MP Initialize Library is not initialized.
702 @retval EFI_TIMEOUT In blocking mode, the timeout expired before
703 all enabled APs have finished.
704 @retval EFI_INVALID_PARAMETER Procedure is NULL.
705
706 **/
707 EFI_STATUS
708 EFIAPI
709 MpInitLibStartupAllAPs (
710 IN EFI_AP_PROCEDURE Procedure,
711 IN BOOLEAN SingleThread,
712 IN EFI_EVENT WaitEvent OPTIONAL,
713 IN UINTN TimeoutInMicroseconds,
714 IN VOID *ProcedureArgument OPTIONAL,
715 OUT UINTN **FailedCpuList OPTIONAL
716 )
717 {
718 EFI_STATUS Status;
719
720 //
721 // Temporarily stop checkAllApsStatus for avoid resource dead-lock.
722 //
723 mStopCheckAllApsStatus = TRUE;
724
725 Status = StartupAllCPUsWorker (
726 Procedure,
727 SingleThread,
728 TRUE,
729 WaitEvent,
730 TimeoutInMicroseconds,
731 ProcedureArgument,
732 FailedCpuList
733 );
734
735 //
736 // Start checkAllApsStatus
737 //
738 mStopCheckAllApsStatus = FALSE;
739
740 return Status;
741 }
742
743 /**
744 This service lets the caller get one enabled AP to execute a caller-provided
745 function.
746
747 @param[in] Procedure A pointer to the function to be run on the
748 designated AP of the system. See type
749 EFI_AP_PROCEDURE.
750 @param[in] ProcessorNumber The handle number of the AP. The range is
751 from 0 to the total number of logical
752 processors minus 1. The total number of
753 logical processors can be retrieved by
754 MpInitLibGetNumberOfProcessors().
755 @param[in] WaitEvent The event created by the caller with CreateEvent()
756 service. If it is NULL, then execute in
757 blocking mode. BSP waits until this AP finish
758 or TimeoutInMicroSeconds expires. If it's
759 not NULL, then execute in non-blocking mode.
760 BSP requests the function specified by
761 Procedure to be started on this AP,
762 and go on executing immediately. If this AP
763 return from Procedure or TimeoutInMicroSeconds
764 expires, this event is signaled. The BSP
765 can use the CheckEvent() or WaitForEvent()
766 services to check the state of event. Type
767 EFI_EVENT is defined in CreateEvent() in
768 the Unified Extensible Firmware Interface
769 Specification.
770 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
771 this AP to finish this Procedure, either for
772 blocking or non-blocking mode. Zero means
773 infinity. If the timeout expires before
774 this AP returns from Procedure, then Procedure
775 on the AP is terminated. The
776 AP is available for next function assigned
777 by MpInitLibStartupAllAPs() or
778 MpInitLibStartupThisAP().
779 If the timeout expires in blocking mode,
780 BSP returns EFI_TIMEOUT. If the timeout
781 expires in non-blocking mode, WaitEvent
782 is signaled with SignalEvent().
783 @param[in] ProcedureArgument The parameter passed into Procedure on the
784 specified AP.
785 @param[out] Finished If NULL, this parameter is ignored. In
786 blocking mode, this parameter is ignored.
787 In non-blocking mode, if AP returns from
788 Procedure before the timeout expires, its
789 content is set to TRUE. Otherwise, the
790 value is set to FALSE. The caller can
791 determine if the AP returned from Procedure
792 by evaluating this value.
793
794 @retval EFI_SUCCESS In blocking mode, specified AP finished before
795 the timeout expires.
796 @retval EFI_SUCCESS In non-blocking mode, the function has been
797 dispatched to specified AP.
798 @retval EFI_UNSUPPORTED A non-blocking mode request was made after the
799 UEFI event EFI_EVENT_GROUP_READY_TO_BOOT was
800 signaled.
801 @retval EFI_UNSUPPORTED WaitEvent is not NULL if non-blocking mode is not
802 supported.
803 @retval EFI_DEVICE_ERROR The calling processor is an AP.
804 @retval EFI_TIMEOUT In blocking mode, the timeout expired before
805 the specified AP has finished.
806 @retval EFI_NOT_READY The specified AP is busy.
807 @retval EFI_NOT_READY MP Initialize Library is not initialized.
808 @retval EFI_NOT_FOUND The processor with the handle specified by
809 ProcessorNumber does not exist.
810 @retval EFI_INVALID_PARAMETER ProcessorNumber specifies the BSP or disabled AP.
811 @retval EFI_INVALID_PARAMETER Procedure is NULL.
812
813 **/
814 EFI_STATUS
815 EFIAPI
816 MpInitLibStartupThisAP (
817 IN EFI_AP_PROCEDURE Procedure,
818 IN UINTN ProcessorNumber,
819 IN EFI_EVENT WaitEvent OPTIONAL,
820 IN UINTN TimeoutInMicroseconds,
821 IN VOID *ProcedureArgument OPTIONAL,
822 OUT BOOLEAN *Finished OPTIONAL
823 )
824 {
825 EFI_STATUS Status;
826
827 //
828 // temporarily stop checkAllApsStatus for avoid resource dead-lock.
829 //
830 mStopCheckAllApsStatus = TRUE;
831
832 Status = StartupThisAPWorker (
833 Procedure,
834 ProcessorNumber,
835 WaitEvent,
836 TimeoutInMicroseconds,
837 ProcedureArgument,
838 Finished
839 );
840
841 mStopCheckAllApsStatus = FALSE;
842
843 return Status;
844 }
845
846 /**
847 This service switches the requested AP to be the BSP from that point onward.
848 This service changes the BSP for all purposes. This call can only be performed
849 by the current BSP.
850
851 @param[in] ProcessorNumber The handle number of AP that is to become the new
852 BSP. The range is from 0 to the total number of
853 logical processors minus 1. The total number of
854 logical processors can be retrieved by
855 MpInitLibGetNumberOfProcessors().
856 @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an
857 enabled AP. Otherwise, it will be disabled.
858
859 @retval EFI_SUCCESS BSP successfully switched.
860 @retval EFI_UNSUPPORTED Switching the BSP cannot be completed prior to
861 this service returning.
862 @retval EFI_UNSUPPORTED Switching the BSP is not supported.
863 @retval EFI_DEVICE_ERROR The calling processor is an AP.
864 @retval EFI_NOT_FOUND The processor with the handle specified by
865 ProcessorNumber does not exist.
866 @retval EFI_INVALID_PARAMETER ProcessorNumber specifies the current BSP or
867 a disabled AP.
868 @retval EFI_NOT_READY The specified AP is busy.
869 @retval EFI_NOT_READY MP Initialize Library is not initialized.
870
871 **/
872 EFI_STATUS
873 EFIAPI
874 MpInitLibSwitchBSP (
875 IN UINTN ProcessorNumber,
876 IN BOOLEAN EnableOldBSP
877 )
878 {
879 EFI_STATUS Status;
880 EFI_TIMER_ARCH_PROTOCOL *Timer;
881 UINT64 TimerPeriod;
882
883 TimerPeriod = 0;
884 //
885 // Locate Timer Arch Protocol
886 //
887 Status = gBS->LocateProtocol (&gEfiTimerArchProtocolGuid, NULL, (VOID **)&Timer);
888 if (EFI_ERROR (Status)) {
889 Timer = NULL;
890 }
891
892 if (Timer != NULL) {
893 //
894 // Save current rate of DXE Timer
895 //
896 Timer->GetTimerPeriod (Timer, &TimerPeriod);
897 //
898 // Disable DXE Timer and drain pending interrupts
899 //
900 Timer->SetTimerPeriod (Timer, 0);
901 }
902
903 Status = SwitchBSPWorker (ProcessorNumber, EnableOldBSP);
904
905 if (Timer != NULL) {
906 //
907 // Enable and restore rate of DXE Timer
908 //
909 Timer->SetTimerPeriod (Timer, TimerPeriod);
910 }
911
912 return Status;
913 }
914
915 /**
916 This service lets the caller enable or disable an AP from this point onward.
917 This service may only be called from the BSP.
918
919 @param[in] ProcessorNumber The handle number of AP.
920 The range is from 0 to the total number of
921 logical processors minus 1. The total number of
922 logical processors can be retrieved by
923 MpInitLibGetNumberOfProcessors().
924 @param[in] EnableAP Specifies the new state for the processor for
925 enabled, FALSE for disabled.
926 @param[in] HealthFlag If not NULL, a pointer to a value that specifies
927 the new health status of the AP. This flag
928 corresponds to StatusFlag defined in
929 EFI_MP_SERVICES_PROTOCOL.GetProcessorInfo(). Only
930 the PROCESSOR_HEALTH_STATUS_BIT is used. All other
931 bits are ignored. If it is NULL, this parameter
932 is ignored.
933
934 @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
935 @retval EFI_UNSUPPORTED Enabling or disabling an AP cannot be completed
936 prior to this service returning.
937 @retval EFI_UNSUPPORTED Enabling or disabling an AP is not supported.
938 @retval EFI_DEVICE_ERROR The calling processor is an AP.
939 @retval EFI_NOT_FOUND Processor with the handle specified by ProcessorNumber
940 does not exist.
941 @retval EFI_INVALID_PARAMETER ProcessorNumber specifies the BSP.
942 @retval EFI_NOT_READY MP Initialize Library is not initialized.
943
944 **/
945 EFI_STATUS
946 EFIAPI
947 MpInitLibEnableDisableAP (
948 IN UINTN ProcessorNumber,
949 IN BOOLEAN EnableAP,
950 IN UINT32 *HealthFlag OPTIONAL
951 )
952 {
953 EFI_STATUS Status;
954 BOOLEAN TempStopCheckState;
955
956 TempStopCheckState = FALSE;
957 //
958 // temporarily stop checkAllAPsStatus for initialize parameters.
959 //
960 if (!mStopCheckAllApsStatus) {
961 mStopCheckAllApsStatus = TRUE;
962 TempStopCheckState = TRUE;
963 }
964
965 Status = EnableDisableApWorker (ProcessorNumber, EnableAP, HealthFlag);
966
967 if (TempStopCheckState) {
968 mStopCheckAllApsStatus = FALSE;
969 }
970
971 return Status;
972 }
973
974 /**
975 This funtion will try to invoke platform specific microcode shadow logic to
976 relocate microcode update patches into memory.
977
978 @param[in, out] CpuMpData The pointer to CPU MP Data structure.
979
980 @retval EFI_SUCCESS Shadow microcode success.
981 @retval EFI_OUT_OF_RESOURCES No enough resource to complete the operation.
982 @retval EFI_UNSUPPORTED Can't find platform specific microcode shadow
983 PPI/Protocol.
984 **/
985 EFI_STATUS
986 PlatformShadowMicrocode (
987 IN OUT CPU_MP_DATA *CpuMpData
988 )
989 {
990 //
991 // There is no DXE version of platform shadow microcode protocol so far.
992 // A platform which only uses DxeMpInitLib instance could only supports
993 // the PCD based microcode shadowing.
994 //
995 return EFI_UNSUPPORTED;
996 }
EFI Development Kit II mirror for PVE