2 MP initialize support functions for DXE phase.
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 #include <Library/UefiLib.h>
18 #include <Library/UefiBootServicesTableLib.h>
19 #include <Library/DebugAgentLib.h>
20 #include <Library/DxeServicesTableLib.h>
22 #include <Protocol/Timer.h>
24 #define AP_CHECK_INTERVAL (EFI_TIMER_PERIOD_MILLISECONDS (100))
25 #define AP_SAFE_STACK_SIZE 128
27 CPU_MP_DATA
*mCpuMpData
= NULL
;
28 EFI_EVENT mCheckAllApsEvent
= NULL
;
29 EFI_EVENT mMpInitExitBootServicesEvent
= NULL
;
30 EFI_EVENT mLegacyBootEvent
= NULL
;
31 volatile BOOLEAN mStopCheckAllApsStatus
= TRUE
;
32 VOID
*mReservedApLoopFunc
= NULL
;
33 UINTN mReservedTopOfApStack
;
34 volatile UINT32 mNumberToFinish
= 0;
37 Enable Debug Agent to support source debugging on AP function.
46 // Initialize Debug Agent to support source level debug in DXE phase
48 InitializeDebugAgent (DEBUG_AGENT_INIT_DXE_AP
, NULL
, NULL
);
52 Get the pointer to CPU MP Data structure.
54 @return The pointer to CPU MP Data structure.
61 ASSERT (mCpuMpData
!= NULL
);
66 Save the pointer to CPU MP Data structure.
68 @param[in] CpuMpData The pointer to CPU MP Data structure will be saved.
72 IN CPU_MP_DATA
*CpuMpData
75 mCpuMpData
= CpuMpData
;
79 Get available system memory below 1MB by specified size.
81 @param[in] WakeupBufferSize Wakeup buffer size required
83 @retval other Return wakeup buffer address below 1MB.
84 @retval -1 Cannot find free memory below 1MB.
88 IN UINTN WakeupBufferSize
92 EFI_PHYSICAL_ADDRESS StartAddress
;
94 StartAddress
= BASE_1MB
;
95 Status
= gBS
->AllocatePages (
98 EFI_SIZE_TO_PAGES (WakeupBufferSize
),
101 ASSERT_EFI_ERROR (Status
);
102 if (!EFI_ERROR (Status
)) {
103 Status
= gBS
->FreePages(
105 EFI_SIZE_TO_PAGES (WakeupBufferSize
)
107 ASSERT_EFI_ERROR (Status
);
108 DEBUG ((DEBUG_INFO
, "WakeupBufferStart = %x, WakeupBufferSize = %x\n",
109 (UINTN
) StartAddress
, WakeupBufferSize
));
111 StartAddress
= (EFI_PHYSICAL_ADDRESS
) -1;
113 return (UINTN
) StartAddress
;
117 Checks APs status and updates APs status if needed.
121 CheckAndUpdateApsStatus (
125 UINTN ProcessorNumber
;
127 CPU_MP_DATA
*CpuMpData
;
129 CpuMpData
= GetCpuMpData ();
132 // First, check whether pending StartupAllAPs() exists.
134 if (CpuMpData
->WaitEvent
!= NULL
) {
136 Status
= CheckAllAPs ();
138 // If all APs finish for StartupAllAPs(), signal the WaitEvent for it.
140 if (Status
!= EFI_NOT_READY
) {
141 Status
= gBS
->SignalEvent (CpuMpData
->WaitEvent
);
142 CpuMpData
->WaitEvent
= NULL
;
147 // Second, check whether pending StartupThisAPs() callings exist.
149 for (ProcessorNumber
= 0; ProcessorNumber
< CpuMpData
->CpuCount
; ProcessorNumber
++) {
151 if (CpuMpData
->CpuData
[ProcessorNumber
].WaitEvent
== NULL
) {
155 Status
= CheckThisAP (ProcessorNumber
);
157 if (Status
!= EFI_NOT_READY
) {
158 gBS
->SignalEvent (CpuMpData
->CpuData
[ProcessorNumber
].WaitEvent
);
159 CpuMpData
->CpuData
[ProcessorNumber
].WaitEvent
= NULL
;
165 Checks APs' status periodically.
167 This function is triggered by timer periodically to check the
168 state of APs for StartupAllAPs() and StartupThisAP() executed
169 in non-blocking mode.
171 @param[in] Event Event triggered.
172 @param[in] Context Parameter passed with the event.
183 // If CheckApsStatus() is not stopped, otherwise return immediately.
185 if (!mStopCheckAllApsStatus
) {
186 CheckAndUpdateApsStatus ();
191 Get Protected mode code segment from current GDT table.
193 @return Protected mode code segment value.
200 IA32_DESCRIPTOR GdtrDesc
;
201 IA32_SEGMENT_DESCRIPTOR
*GdtEntry
;
206 AsmReadGdtr (&GdtrDesc
);
207 GdtEntryCount
= (GdtrDesc
.Limit
+ 1) / sizeof (IA32_SEGMENT_DESCRIPTOR
);
208 GdtEntry
= (IA32_SEGMENT_DESCRIPTOR
*) GdtrDesc
.Base
;
209 for (Index
= 0; Index
< GdtEntryCount
; Index
++) {
210 if (GdtEntry
->Bits
.L
== 0) {
211 if (GdtEntry
->Bits
.Type
> 8 && GdtEntry
->Bits
.L
== 0) {
217 ASSERT (Index
!= -1);
224 @param[in, out] Buffer Pointer to private data buffer.
232 CPU_MP_DATA
*CpuMpData
;
233 BOOLEAN MwaitSupport
;
234 ASM_RELOCATE_AP_LOOP AsmRelocateApLoopFunc
;
235 UINTN ProcessorNumber
;
237 MpInitLibWhoAmI (&ProcessorNumber
);
238 CpuMpData
= GetCpuMpData ();
239 MwaitSupport
= IsMwaitSupport ();
240 AsmRelocateApLoopFunc
= (ASM_RELOCATE_AP_LOOP
) (UINTN
) mReservedApLoopFunc
;
241 AsmRelocateApLoopFunc (
243 CpuMpData
->ApTargetCState
,
244 CpuMpData
->PmCodeSegment
,
245 mReservedTopOfApStack
- ProcessorNumber
* AP_SAFE_STACK_SIZE
,
246 (UINTN
) &mNumberToFinish
249 // It should never reach here
255 Callback function for ExitBootServices.
257 @param[in] Event Event whose notification function is being invoked.
258 @param[in] Context The pointer to the notification function's context,
259 which is implementation-dependent.
264 MpInitChangeApLoopCallback (
269 CPU_MP_DATA
*CpuMpData
;
271 CpuMpData
= GetCpuMpData ();
272 CpuMpData
->PmCodeSegment
= GetProtectedModeCS ();
273 CpuMpData
->ApLoopMode
= PcdGet8 (PcdCpuApLoopMode
);
274 mNumberToFinish
= CpuMpData
->CpuCount
- 1;
275 WakeUpAP (CpuMpData
, TRUE
, 0, RelocateApLoop
, NULL
);
276 while (mNumberToFinish
> 0) {
279 DEBUG ((DEBUG_INFO
, "%a() done!\n", __FUNCTION__
));
283 Initialize global data for MP support.
285 @param[in] CpuMpData The pointer to CPU MP Data structure.
289 IN CPU_MP_DATA
*CpuMpData
293 EFI_PHYSICAL_ADDRESS Address
;
294 UINTN ApSafeBufferSize
;
296 EFI_GCD_MEMORY_SPACE_DESCRIPTOR MemDesc
;
299 SaveCpuMpData (CpuMpData
);
301 if (CpuMpData
->CpuCount
== 1) {
303 // If only BSP exists, return
308 if (PcdGetBool (PcdCpuStackGuard
)) {
310 // One extra page at the bottom of the stack is needed for Guard page.
312 if (CpuMpData
->CpuApStackSize
<= EFI_PAGE_SIZE
) {
313 DEBUG ((DEBUG_ERROR
, "PcdCpuApStackSize is not big enough for Stack Guard!\n"));
317 for (Index
= 0; Index
< CpuMpData
->CpuCount
; ++Index
) {
318 StackBase
= CpuMpData
->Buffer
+ Index
* CpuMpData
->CpuApStackSize
;
320 Status
= gDS
->GetMemorySpaceDescriptor (StackBase
, &MemDesc
);
321 ASSERT_EFI_ERROR (Status
);
323 Status
= gDS
->SetMemorySpaceAttributes (
325 EFI_PAGES_TO_SIZE (1),
326 MemDesc
.Attributes
| EFI_MEMORY_RP
328 ASSERT_EFI_ERROR (Status
);
333 // Avoid APs access invalid buffer data which allocated by BootServices,
334 // so we will allocate reserved data for AP loop code. We also need to
335 // allocate this buffer below 4GB due to APs may be transferred to 32bit
336 // protected mode on long mode DXE.
337 // Allocating it in advance since memory services are not available in
338 // Exit Boot Services callback function.
340 ApSafeBufferSize
= CpuMpData
->AddressMap
.RelocateApLoopFuncSize
;
341 ApSafeBufferSize
+= CpuMpData
->CpuCount
* AP_SAFE_STACK_SIZE
;
343 Address
= BASE_4GB
- 1;
344 Status
= gBS
->AllocatePages (
346 EfiReservedMemoryType
,
347 EFI_SIZE_TO_PAGES (ApSafeBufferSize
),
350 ASSERT_EFI_ERROR (Status
);
351 mReservedApLoopFunc
= (VOID
*) (UINTN
) Address
;
352 ASSERT (mReservedApLoopFunc
!= NULL
);
353 mReservedTopOfApStack
= (UINTN
) Address
+ EFI_PAGES_TO_SIZE (EFI_SIZE_TO_PAGES (ApSafeBufferSize
));
354 ASSERT ((mReservedTopOfApStack
& (UINTN
)(CPU_STACK_ALIGNMENT
- 1)) == 0);
357 CpuMpData
->AddressMap
.RelocateApLoopFuncAddress
,
358 CpuMpData
->AddressMap
.RelocateApLoopFuncSize
361 Status
= gBS
->CreateEvent (
362 EVT_TIMER
| EVT_NOTIFY_SIGNAL
,
368 ASSERT_EFI_ERROR (Status
);
371 // Set timer to check all APs status.
373 Status
= gBS
->SetTimer (
378 ASSERT_EFI_ERROR (Status
);
380 Status
= gBS
->CreateEvent (
381 EVT_SIGNAL_EXIT_BOOT_SERVICES
,
383 MpInitChangeApLoopCallback
,
385 &mMpInitExitBootServicesEvent
387 ASSERT_EFI_ERROR (Status
);
389 Status
= gBS
->CreateEventEx (
392 MpInitChangeApLoopCallback
,
394 &gEfiEventLegacyBootGuid
,
397 ASSERT_EFI_ERROR (Status
);
401 This service executes a caller provided function on all enabled APs.
403 @param[in] Procedure A pointer to the function to be run on
404 enabled APs of the system. See type
406 @param[in] SingleThread If TRUE, then all the enabled APs execute
407 the function specified by Procedure one by
408 one, in ascending order of processor handle
409 number. If FALSE, then all the enabled APs
410 execute the function specified by Procedure
412 @param[in] WaitEvent The event created by the caller with CreateEvent()
413 service. If it is NULL, then execute in
414 blocking mode. BSP waits until all APs finish
415 or TimeoutInMicroSeconds expires. If it's
416 not NULL, then execute in non-blocking mode.
417 BSP requests the function specified by
418 Procedure to be started on all the enabled
419 APs, and go on executing immediately. If
420 all return from Procedure, or TimeoutInMicroSeconds
421 expires, this event is signaled. The BSP
422 can use the CheckEvent() or WaitForEvent()
423 services to check the state of event. Type
424 EFI_EVENT is defined in CreateEvent() in
425 the Unified Extensible Firmware Interface
427 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
428 APs to return from Procedure, either for
429 blocking or non-blocking mode. Zero means
430 infinity. If the timeout expires before
431 all APs return from Procedure, then Procedure
432 on the failed APs is terminated. All enabled
433 APs are available for next function assigned
434 by MpInitLibStartupAllAPs() or
435 MPInitLibStartupThisAP().
436 If the timeout expires in blocking mode,
437 BSP returns EFI_TIMEOUT. If the timeout
438 expires in non-blocking mode, WaitEvent
439 is signaled with SignalEvent().
440 @param[in] ProcedureArgument The parameter passed into Procedure for
442 @param[out] FailedCpuList If NULL, this parameter is ignored. Otherwise,
443 if all APs finish successfully, then its
444 content is set to NULL. If not all APs
445 finish before timeout expires, then its
446 content is set to address of the buffer
447 holding handle numbers of the failed APs.
448 The buffer is allocated by MP Initialization
449 library, and it's the caller's responsibility to
450 free the buffer with FreePool() service.
451 In blocking mode, it is ready for consumption
452 when the call returns. In non-blocking mode,
453 it is ready when WaitEvent is signaled. The
454 list of failed CPU is terminated by
457 @retval EFI_SUCCESS In blocking mode, all APs have finished before
459 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched
461 @retval EFI_UNSUPPORTED A non-blocking mode request was made after the
462 UEFI event EFI_EVENT_GROUP_READY_TO_BOOT was
464 @retval EFI_UNSUPPORTED WaitEvent is not NULL if non-blocking mode is not
466 @retval EFI_DEVICE_ERROR Caller processor is AP.
467 @retval EFI_NOT_STARTED No enabled APs exist in the system.
468 @retval EFI_NOT_READY Any enabled APs are busy.
469 @retval EFI_NOT_READY MP Initialize Library is not initialized.
470 @retval EFI_TIMEOUT In blocking mode, the timeout expired before
471 all enabled APs have finished.
472 @retval EFI_INVALID_PARAMETER Procedure is NULL.
477 MpInitLibStartupAllAPs (
478 IN EFI_AP_PROCEDURE Procedure
,
479 IN BOOLEAN SingleThread
,
480 IN EFI_EVENT WaitEvent OPTIONAL
,
481 IN UINTN TimeoutInMicroseconds
,
482 IN VOID
*ProcedureArgument OPTIONAL
,
483 OUT UINTN
**FailedCpuList OPTIONAL
489 // Temporarily stop checkAllApsStatus for avoid resource dead-lock.
491 mStopCheckAllApsStatus
= TRUE
;
493 Status
= StartupAllAPsWorker (
497 TimeoutInMicroseconds
,
503 // Start checkAllApsStatus
505 mStopCheckAllApsStatus
= FALSE
;
511 This service lets the caller get one enabled AP to execute a caller-provided
514 @param[in] Procedure A pointer to the function to be run on the
515 designated AP of the system. See type
517 @param[in] ProcessorNumber The handle number of the AP. The range is
518 from 0 to the total number of logical
519 processors minus 1. The total number of
520 logical processors can be retrieved by
521 MpInitLibGetNumberOfProcessors().
522 @param[in] WaitEvent The event created by the caller with CreateEvent()
523 service. If it is NULL, then execute in
524 blocking mode. BSP waits until this AP finish
525 or TimeoutInMicroSeconds expires. If it's
526 not NULL, then execute in non-blocking mode.
527 BSP requests the function specified by
528 Procedure to be started on this AP,
529 and go on executing immediately. If this AP
530 return from Procedure or TimeoutInMicroSeconds
531 expires, this event is signaled. The BSP
532 can use the CheckEvent() or WaitForEvent()
533 services to check the state of event. Type
534 EFI_EVENT is defined in CreateEvent() in
535 the Unified Extensible Firmware Interface
537 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
538 this AP to finish this Procedure, either for
539 blocking or non-blocking mode. Zero means
540 infinity. If the timeout expires before
541 this AP returns from Procedure, then Procedure
542 on the AP is terminated. The
543 AP is available for next function assigned
544 by MpInitLibStartupAllAPs() or
545 MpInitLibStartupThisAP().
546 If the timeout expires in blocking mode,
547 BSP returns EFI_TIMEOUT. If the timeout
548 expires in non-blocking mode, WaitEvent
549 is signaled with SignalEvent().
550 @param[in] ProcedureArgument The parameter passed into Procedure on the
552 @param[out] Finished If NULL, this parameter is ignored. In
553 blocking mode, this parameter is ignored.
554 In non-blocking mode, if AP returns from
555 Procedure before the timeout expires, its
556 content is set to TRUE. Otherwise, the
557 value is set to FALSE. The caller can
558 determine if the AP returned from Procedure
559 by evaluating this value.
561 @retval EFI_SUCCESS In blocking mode, specified AP finished before
563 @retval EFI_SUCCESS In non-blocking mode, the function has been
564 dispatched to specified AP.
565 @retval EFI_UNSUPPORTED A non-blocking mode request was made after the
566 UEFI event EFI_EVENT_GROUP_READY_TO_BOOT was
568 @retval EFI_UNSUPPORTED WaitEvent is not NULL if non-blocking mode is not
570 @retval EFI_DEVICE_ERROR The calling processor is an AP.
571 @retval EFI_TIMEOUT In blocking mode, the timeout expired before
572 the specified AP has finished.
573 @retval EFI_NOT_READY The specified AP is busy.
574 @retval EFI_NOT_READY MP Initialize Library is not initialized.
575 @retval EFI_NOT_FOUND The processor with the handle specified by
576 ProcessorNumber does not exist.
577 @retval EFI_INVALID_PARAMETER ProcessorNumber specifies the BSP or disabled AP.
578 @retval EFI_INVALID_PARAMETER Procedure is NULL.
583 MpInitLibStartupThisAP (
584 IN EFI_AP_PROCEDURE Procedure
,
585 IN UINTN ProcessorNumber
,
586 IN EFI_EVENT WaitEvent OPTIONAL
,
587 IN UINTN TimeoutInMicroseconds
,
588 IN VOID
*ProcedureArgument OPTIONAL
,
589 OUT BOOLEAN
*Finished OPTIONAL
595 // temporarily stop checkAllApsStatus for avoid resource dead-lock.
597 mStopCheckAllApsStatus
= TRUE
;
599 Status
= StartupThisAPWorker (
603 TimeoutInMicroseconds
,
608 mStopCheckAllApsStatus
= FALSE
;
614 This service switches the requested AP to be the BSP from that point onward.
615 This service changes the BSP for all purposes. This call can only be performed
618 @param[in] ProcessorNumber The handle number of AP that is to become the new
619 BSP. The range is from 0 to the total number of
620 logical processors minus 1. The total number of
621 logical processors can be retrieved by
622 MpInitLibGetNumberOfProcessors().
623 @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an
624 enabled AP. Otherwise, it will be disabled.
626 @retval EFI_SUCCESS BSP successfully switched.
627 @retval EFI_UNSUPPORTED Switching the BSP cannot be completed prior to
628 this service returning.
629 @retval EFI_UNSUPPORTED Switching the BSP is not supported.
630 @retval EFI_DEVICE_ERROR The calling processor is an AP.
631 @retval EFI_NOT_FOUND The processor with the handle specified by
632 ProcessorNumber does not exist.
633 @retval EFI_INVALID_PARAMETER ProcessorNumber specifies the current BSP or
635 @retval EFI_NOT_READY The specified AP is busy.
636 @retval EFI_NOT_READY MP Initialize Library is not initialized.
642 IN UINTN ProcessorNumber
,
643 IN BOOLEAN EnableOldBSP
647 EFI_TIMER_ARCH_PROTOCOL
*Timer
;
652 // Locate Timer Arch Protocol
654 Status
= gBS
->LocateProtocol (&gEfiTimerArchProtocolGuid
, NULL
, (VOID
**) &Timer
);
655 if (EFI_ERROR (Status
)) {
661 // Save current rate of DXE Timer
663 Timer
->GetTimerPeriod (Timer
, &TimerPeriod
);
665 // Disable DXE Timer and drain pending interrupts
667 Timer
->SetTimerPeriod (Timer
, 0);
670 Status
= SwitchBSPWorker (ProcessorNumber
, EnableOldBSP
);
674 // Enable and restore rate of DXE Timer
676 Timer
->SetTimerPeriod (Timer
, TimerPeriod
);
683 This service lets the caller enable or disable an AP from this point onward.
684 This service may only be called from the BSP.
686 @param[in] ProcessorNumber The handle number of AP.
687 The range is from 0 to the total number of
688 logical processors minus 1. The total number of
689 logical processors can be retrieved by
690 MpInitLibGetNumberOfProcessors().
691 @param[in] EnableAP Specifies the new state for the processor for
692 enabled, FALSE for disabled.
693 @param[in] HealthFlag If not NULL, a pointer to a value that specifies
694 the new health status of the AP. This flag
695 corresponds to StatusFlag defined in
696 EFI_MP_SERVICES_PROTOCOL.GetProcessorInfo(). Only
697 the PROCESSOR_HEALTH_STATUS_BIT is used. All other
698 bits are ignored. If it is NULL, this parameter
701 @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
702 @retval EFI_UNSUPPORTED Enabling or disabling an AP cannot be completed
703 prior to this service returning.
704 @retval EFI_UNSUPPORTED Enabling or disabling an AP is not supported.
705 @retval EFI_DEVICE_ERROR The calling processor is an AP.
706 @retval EFI_NOT_FOUND Processor with the handle specified by ProcessorNumber
708 @retval EFI_INVALID_PARAMETER ProcessorNumber specifies the BSP.
709 @retval EFI_NOT_READY MP Initialize Library is not initialized.
714 MpInitLibEnableDisableAP (
715 IN UINTN ProcessorNumber
,
717 IN UINT32
*HealthFlag OPTIONAL
721 BOOLEAN TempStopCheckState
;
723 TempStopCheckState
= FALSE
;
725 // temporarily stop checkAllAPsStatus for initialize parameters.
727 if (!mStopCheckAllApsStatus
) {
728 mStopCheckAllApsStatus
= TRUE
;
729 TempStopCheckState
= TRUE
;
732 Status
= EnableDisableApWorker (ProcessorNumber
, EnableAP
, HealthFlag
);
734 if (TempStopCheckState
) {
735 mStopCheckAllApsStatus
= FALSE
;