2 Produces PI MP Services Protocol on top of Framework MP Services Protocol.
4 Intel's Framework MP Services Protocol is replaced by EFI_MP_SERVICES_PROTOCOL in PI 1.1.
5 This module produces PI MP Services Protocol on top of Framework MP Services Protocol.
7 Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
8 This program and the accompanying materials
9 are licensed and made available under the terms and conditions of the BSD License
10 which accompanies this distribution. The full text of the license may be found at
11 http://opensource.org/licenses/bsd-license.php
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 #include "MpServicesOnFrameworkMpServicesThunk.h"
21 EFI_HANDLE mHandle
= NULL
;
22 MP_SYSTEM_DATA mMPSystemData
;
23 EFI_PHYSICAL_ADDRESS mStartupVector
;
24 MP_CPU_EXCHANGE_INFO
*mExchangeInfo
;
25 VOID
*mStackStartAddress
;
26 BOOLEAN mStopCheckAPsStatus
= FALSE
;
27 UINTN mNumberOfProcessors
;
28 EFI_GENERIC_MEMORY_TEST_PROTOCOL
*mGenMemoryTest
;
30 FRAMEWORK_EFI_MP_SERVICES_PROTOCOL
*mFrameworkMpService
;
31 EFI_MP_SERVICES_PROTOCOL mMpService
= {
32 GetNumberOfProcessors
,
43 Implementation of GetNumberOfProcessors() service of MP Services Protocol.
45 This service retrieves the number of logical processor in the platform
46 and the number of those logical processors that are enabled on this boot.
47 This service may only be called from the BSP.
49 @param This A pointer to the EFI_MP_SERVICES_PROTOCOL instance.
50 @param NumberOfProcessors Pointer to the total number of logical processors in the system,
51 including the BSP and disabled APs.
52 @param NumberOfEnabledProcessors Pointer to the number of enabled logical processors that exist
53 in system, including the BSP.
55 @retval EFI_SUCCESS Number of logical processors and enabled logical processors retrieved..
56 @retval EFI_DEVICE_ERROR Caller processor is AP.
57 @retval EFI_INVALID_PARAMETER NumberOfProcessors is NULL
58 @retval EFI_INVALID_PARAMETER NumberOfEnabledProcessors is NULL
63 GetNumberOfProcessors (
64 IN EFI_MP_SERVICES_PROTOCOL
*This
,
65 OUT UINTN
*NumberOfProcessors
,
66 OUT UINTN
*NumberOfEnabledProcessors
73 // Check whether caller processor is BSP
75 WhoAmI (This
, &CallerNumber
);
76 if (CallerNumber
!= GetBspNumber ()) {
77 return EFI_DEVICE_ERROR
;
81 // Check parameter NumberOfProcessors
83 if (NumberOfProcessors
== NULL
) {
84 return EFI_INVALID_PARAMETER
;
88 // Check parameter NumberOfEnabledProcessors
90 if (NumberOfEnabledProcessors
== NULL
) {
91 return EFI_INVALID_PARAMETER
;
94 Status
= mFrameworkMpService
->GetGeneralMPInfo (
98 NumberOfEnabledProcessors
,
102 ASSERT_EFI_ERROR (Status
);
108 Implementation of GetNumberOfProcessors() service of MP Services Protocol.
110 Gets detailed MP-related information on the requested processor at the
111 instant this call is made. This service may only be called from the BSP.
113 @param This A pointer to the EFI_MP_SERVICES_PROTOCOL instance.
114 @param ProcessorNumber The handle number of processor.
115 @param ProcessorInfoBuffer A pointer to the buffer where information for the requested processor is deposited.
117 @retval EFI_SUCCESS Processor information successfully returned.
118 @retval EFI_DEVICE_ERROR Caller processor is AP.
119 @retval EFI_INVALID_PARAMETER ProcessorInfoBuffer is NULL
120 @retval EFI_NOT_FOUND Processor with the handle specified by ProcessorNumber does not exist.
126 IN EFI_MP_SERVICES_PROTOCOL
*This
,
127 IN UINTN ProcessorNumber
,
128 OUT EFI_PROCESSOR_INFORMATION
*ProcessorInfoBuffer
134 EFI_MP_PROC_CONTEXT ProcessorContextBuffer
;
137 // Check whether caller processor is BSP
139 WhoAmI (This
, &CallerNumber
);
140 if (CallerNumber
!= GetBspNumber ()) {
141 return EFI_DEVICE_ERROR
;
145 // Check parameter ProcessorInfoBuffer
147 if (ProcessorInfoBuffer
== NULL
) {
148 return EFI_INVALID_PARAMETER
;
152 // Check whether processor with the handle specified by ProcessorNumber exists
154 if (ProcessorNumber
>= mNumberOfProcessors
) {
155 return EFI_NOT_FOUND
;
158 BufferSize
= sizeof (EFI_MP_PROC_CONTEXT
);
159 Status
= mFrameworkMpService
->GetProcessorContext (
163 &ProcessorContextBuffer
165 ASSERT_EFI_ERROR (Status
);
167 ProcessorInfoBuffer
->ProcessorId
= (UINT64
) ProcessorContextBuffer
.ApicID
;
170 // Get Status Flag of specified processor
172 ProcessorInfoBuffer
->StatusFlag
= 0;
174 if (ProcessorContextBuffer
.Enabled
) {
175 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_ENABLED_BIT
;
178 if (ProcessorContextBuffer
.Designation
== EfiCpuBSP
) {
179 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_AS_BSP_BIT
;
182 if (ProcessorContextBuffer
.Health
.Flags
.Uint32
== 0) {
183 ProcessorInfoBuffer
->StatusFlag
|= PROCESSOR_HEALTH_STATUS_BIT
;
186 ProcessorInfoBuffer
->Location
.Package
= (UINT32
) ProcessorContextBuffer
.PackageNumber
;
187 ProcessorInfoBuffer
->Location
.Core
= (UINT32
) ProcessorContextBuffer
.NumberOfCores
;
188 ProcessorInfoBuffer
->Location
.Thread
= (UINT32
) ProcessorContextBuffer
.NumberOfThreads
;
194 Implementation of StartupAllAPs() service of MP Services Protocol.
196 This service lets the caller get all enabled APs to execute a caller-provided function.
197 This service may only be called from the BSP.
199 @param This A pointer to the EFI_MP_SERVICES_PROTOCOL instance.
200 @param Procedure A pointer to the function to be run on enabled APs of the system.
201 @param SingleThread Indicates whether to execute the function simultaneously or one by one..
202 @param WaitEvent The event created by the caller.
203 If it is NULL, then execute in blocking mode.
204 If it is not NULL, then execute in non-blocking mode.
205 @param TimeoutInMicroSeconds The time limit in microseconds for this AP to finish the function.
207 @param ProcedureArgument Pointer to the optional parameter of the assigned function.
208 @param FailedCpuList The list of processor numbers that fail to finish the function before
209 TimeoutInMicrosecsond expires.
211 @retval EFI_SUCCESS In blocking mode, all APs have finished before the timeout expired.
212 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched to all enabled APs.
213 @retval EFI_DEVICE_ERROR Caller processor is AP.
214 @retval EFI_NOT_STARTED No enabled AP exists in the system.
215 @retval EFI_NOT_READY Any enabled AP is busy.
216 @retval EFI_TIMEOUT In blocking mode, The timeout expired before all enabled APs have finished.
217 @retval EFI_INVALID_PARAMETER Procedure is NULL.
223 IN EFI_MP_SERVICES_PROTOCOL
*This
,
224 IN EFI_AP_PROCEDURE Procedure
,
225 IN BOOLEAN SingleThread
,
226 IN EFI_EVENT WaitEvent OPTIONAL
,
227 IN UINTN TimeoutInMicroSeconds
,
228 IN VOID
*ProcedureArgument OPTIONAL
,
229 OUT UINTN
**FailedCpuList OPTIONAL
233 UINTN ProcessorNumber
;
234 CPU_DATA_BLOCK
*CpuData
;
238 if (FailedCpuList
!= NULL
) {
239 *FailedCpuList
= NULL
;
243 // Check whether caller processor is BSP
245 BspNumber
= GetBspNumber ();
246 WhoAmI (This
, &ProcessorNumber
);
247 if (ProcessorNumber
!= BspNumber
) {
248 return EFI_DEVICE_ERROR
;
252 // Check parameter Procedure
254 if (Procedure
== NULL
) {
255 return EFI_INVALID_PARAMETER
;
259 // Temporarily suppress CheckAPsStatus()
261 mStopCheckAPsStatus
= TRUE
;
264 // Check whether all enabled APs are idle.
265 // If any enabled AP is not idle, return EFI_NOT_READY.
267 for (ProcessorNumber
= 0; ProcessorNumber
< mNumberOfProcessors
; ProcessorNumber
++) {
269 CpuData
= &mMPSystemData
.CpuData
[ProcessorNumber
];
271 mMPSystemData
.CpuList
[ProcessorNumber
] = FALSE
;
272 if (ProcessorNumber
!= BspNumber
) {
273 if (CpuData
->State
!= CpuStateDisabled
) {
274 if (CpuData
->State
!= CpuStateIdle
) {
275 mStopCheckAPsStatus
= FALSE
;
276 return EFI_NOT_READY
;
279 // Mark this processor as responsible for current calling.
281 mMPSystemData
.CpuList
[ProcessorNumber
] = TRUE
;
287 mMPSystemData
.FinishCount
= 0;
288 mMPSystemData
.StartCount
= 0;
291 // Go through all enabled APs to wakeup them for Procedure.
292 // If in Single Thread mode, then only one AP is woken up, and others are waiting.
294 for (ProcessorNumber
= 0; ProcessorNumber
< mNumberOfProcessors
; ProcessorNumber
++) {
296 CpuData
= &mMPSystemData
.CpuData
[ProcessorNumber
];
298 // Check whether this processor is responsible for current calling.
300 if (mMPSystemData
.CpuList
[ProcessorNumber
]) {
302 mMPSystemData
.StartCount
++;
304 AcquireSpinLock (&CpuData
->CpuDataLock
);
305 CpuData
->State
= CpuStateReady
;
306 ReleaseSpinLock (&CpuData
->CpuDataLock
);
323 // If no enabled AP exists, return EFI_NOT_STARTED.
325 if (mMPSystemData
.StartCount
== 0) {
326 mStopCheckAPsStatus
= FALSE
;
327 return EFI_NOT_STARTED
;
331 // If WaitEvent is not NULL, execute in non-blocking mode.
332 // BSP saves data for CheckAPsStatus(), and returns EFI_SUCCESS.
333 // CheckAPsStatus() will check completion and timeout periodically.
335 mMPSystemData
.Procedure
= Procedure
;
336 mMPSystemData
.ProcArguments
= ProcedureArgument
;
337 mMPSystemData
.SingleThread
= SingleThread
;
338 mMPSystemData
.FailedCpuList
= FailedCpuList
;
339 mMPSystemData
.ExpectedTime
= CalculateTimeout (TimeoutInMicroSeconds
, &mMPSystemData
.CurrentTime
);
340 mMPSystemData
.WaitEvent
= WaitEvent
;
343 // Allow CheckAPsStatus()
345 mStopCheckAPsStatus
= FALSE
;
347 if (WaitEvent
!= NULL
) {
352 // If WaitEvent is NULL, execute in blocking mode.
353 // BSP checks APs'state until all APs finish or TimeoutInMicrosecsond expires.
356 Status
= CheckAllAPs ();
357 } while (Status
== EFI_NOT_READY
);
363 Implementation of StartupThisAP() service of MP Services Protocol.
365 This service lets the caller get one enabled AP to execute a caller-provided function.
366 This service may only be called from the BSP.
368 @param This A pointer to the EFI_MP_SERVICES_PROTOCOL instance.
369 @param Procedure A pointer to the function to be run on the designated AP.
370 @param ProcessorNumber The handle number of AP..
371 @param WaitEvent The event created by the caller.
372 If it is NULL, then execute in blocking mode.
373 If it is not NULL, then execute in non-blocking mode.
374 @param TimeoutInMicroseconds The time limit in microseconds for this AP to finish the function.
376 @param ProcedureArgument Pointer to the optional parameter of the assigned function.
377 @param Finished Indicates whether AP has finished assigned function.
378 In blocking mode, it is ignored.
380 @retval EFI_SUCCESS In blocking mode, specified AP has finished before the timeout expires.
381 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched to specified AP.
382 @retval EFI_DEVICE_ERROR Caller processor is AP.
383 @retval EFI_TIMEOUT In blocking mode, the timeout expires before specified AP has finished.
384 @retval EFI_NOT_READY Specified AP is busy.
385 @retval EFI_NOT_FOUND Processor with the handle specified by ProcessorNumber does not exist.
386 @retval EFI_INVALID_PARAMETER ProcessorNumber specifies the BSP or disabled AP.
387 @retval EFI_INVALID_PARAMETER Procedure is NULL.
393 IN EFI_MP_SERVICES_PROTOCOL
*This
,
394 IN EFI_AP_PROCEDURE Procedure
,
395 IN UINTN ProcessorNumber
,
396 IN EFI_EVENT WaitEvent OPTIONAL
,
397 IN UINTN TimeoutInMicroseconds
,
398 IN VOID
*ProcedureArgument OPTIONAL
,
399 OUT BOOLEAN
*Finished OPTIONAL
402 CPU_DATA_BLOCK
*CpuData
;
407 if (Finished
!= NULL
) {
412 // Check whether caller processor is BSP
414 BspNumber
= GetBspNumber ();
415 WhoAmI (This
, &CallerNumber
);
416 if (CallerNumber
!= BspNumber
) {
417 return EFI_DEVICE_ERROR
;
421 // Check whether processor with the handle specified by ProcessorNumber exists
423 if (ProcessorNumber
>= mNumberOfProcessors
) {
424 return EFI_NOT_FOUND
;
428 // Check whether specified processor is BSP
430 if (ProcessorNumber
== BspNumber
) {
431 return EFI_INVALID_PARAMETER
;
435 // Check parameter Procedure
437 if (Procedure
== NULL
) {
438 return EFI_INVALID_PARAMETER
;
441 CpuData
= &mMPSystemData
.CpuData
[ProcessorNumber
];
444 // Temporarily suppress CheckAPsStatus()
446 mStopCheckAPsStatus
= TRUE
;
449 // Check whether specified AP is disabled
451 if (CpuData
->State
== CpuStateDisabled
) {
452 mStopCheckAPsStatus
= FALSE
;
453 return EFI_INVALID_PARAMETER
;
457 // Check whether specified AP is busy
459 if (CpuData
->State
!= CpuStateIdle
) {
460 mStopCheckAPsStatus
= FALSE
;
461 return EFI_NOT_READY
;
465 // Wakeup specified AP for Procedure.
467 AcquireSpinLock (&CpuData
->CpuDataLock
);
468 CpuData
->State
= CpuStateReady
;
469 ReleaseSpinLock (&CpuData
->CpuDataLock
);
478 // If WaitEvent is not NULL, execute in non-blocking mode.
479 // BSP saves data for CheckAPsStatus(), and returns EFI_SUCCESS.
480 // CheckAPsStatus() will check completion and timeout periodically.
482 CpuData
->WaitEvent
= WaitEvent
;
483 CpuData
->Finished
= Finished
;
484 CpuData
->ExpectedTime
= CalculateTimeout (TimeoutInMicroseconds
, &CpuData
->CurrentTime
);
487 // Allow CheckAPsStatus()
489 mStopCheckAPsStatus
= FALSE
;
491 if (WaitEvent
!= NULL
) {
496 // If WaitEvent is NULL, execute in blocking mode.
497 // BSP checks AP's state until it finishes or TimeoutInMicrosecsond expires.
500 Status
= CheckThisAP (ProcessorNumber
);
501 } while (Status
== EFI_NOT_READY
);
507 Implementation of SwitchBSP() service of MP Services Protocol.
509 This service switches the requested AP to be the BSP from that point onward.
510 This service may only be called from the current BSP.
512 @param This A pointer to the EFI_MP_SERVICES_PROTOCOL instance.
513 @param ProcessorNumber The handle number of processor.
514 @param EnableOldBSP Whether to enable or disable the original BSP.
516 @retval EFI_SUCCESS BSP successfully switched.
517 @retval EFI_DEVICE_ERROR Caller processor is AP.
518 @retval EFI_NOT_FOUND Processor with the handle specified by ProcessorNumber does not exist.
519 @retval EFI_INVALID_PARAMETER ProcessorNumber specifies the BSP or disabled AP.
520 @retval EFI_NOT_READY Specified AP is busy.
526 IN EFI_MP_SERVICES_PROTOCOL
*This
,
527 IN UINTN ProcessorNumber
,
528 IN BOOLEAN EnableOldBSP
532 CPU_DATA_BLOCK
*CpuData
;
537 // Check whether caller processor is BSP
539 BspNumber
= GetBspNumber ();
540 WhoAmI (This
, &CallerNumber
);
541 if (CallerNumber
!= BspNumber
) {
542 return EFI_DEVICE_ERROR
;
546 // Check whether processor with the handle specified by ProcessorNumber exists
548 if (ProcessorNumber
>= mNumberOfProcessors
) {
549 return EFI_NOT_FOUND
;
553 // Check whether specified processor is BSP
555 if (ProcessorNumber
== BspNumber
) {
556 return EFI_INVALID_PARAMETER
;
559 CpuData
= &mMPSystemData
.CpuData
[ProcessorNumber
];
562 // Check whether specified AP is disabled
564 if (CpuData
->State
== CpuStateDisabled
) {
565 return EFI_INVALID_PARAMETER
;
569 // Check whether specified AP is busy
571 if (CpuData
->State
!= CpuStateIdle
) {
572 return EFI_NOT_READY
;
575 Status
= mFrameworkMpService
->SwitchBSP (
580 ASSERT_EFI_ERROR (Status
);
582 ChangeCpuState (BspNumber
, EnableOldBSP
);
588 Implementation of EnableDisableAP() service of MP Services Protocol.
590 This service lets the caller enable or disable an AP.
591 This service may only be called from the BSP.
593 @param This A pointer to the EFI_MP_SERVICES_PROTOCOL instance.
594 @param ProcessorNumber The handle number of processor.
595 @param EnableAP Indicates whether the newstate of the AP is enabled or disabled.
596 @param HealthFlag Indicates new health state of the AP..
598 @retval EFI_SUCCESS AP successfully enabled or disabled.
599 @retval EFI_DEVICE_ERROR Caller processor is AP.
600 @retval EFI_NOT_FOUND Processor with the handle specified by ProcessorNumber does not exist.
601 @retval EFI_INVALID_PARAMETERS ProcessorNumber specifies the BSP.
607 IN EFI_MP_SERVICES_PROTOCOL
*This
,
608 IN UINTN ProcessorNumber
,
610 IN UINT32
*HealthFlag OPTIONAL
615 EFI_MP_HEALTH HealthState
;
616 EFI_MP_HEALTH
*HealthStatePointer
;
620 // Check whether caller processor is BSP
622 BspNumber
= GetBspNumber ();
623 WhoAmI (This
, &CallerNumber
);
624 if (CallerNumber
!= BspNumber
) {
625 return EFI_DEVICE_ERROR
;
629 // Check whether processor with the handle specified by ProcessorNumber exists
631 if (ProcessorNumber
>= mNumberOfProcessors
) {
632 return EFI_NOT_FOUND
;
636 // Check whether specified processor is BSP
638 if (ProcessorNumber
== BspNumber
) {
639 return EFI_INVALID_PARAMETER
;
642 if (HealthFlag
== NULL
) {
643 HealthStatePointer
= NULL
;
645 if ((*HealthFlag
& PROCESSOR_HEALTH_STATUS_BIT
) == 0) {
646 HealthState
.Flags
.Uint32
= 1;
648 HealthState
.Flags
.Uint32
= 0;
650 HealthState
.TestStatus
= 0;
652 HealthStatePointer
= &HealthState
;
655 Status
= mFrameworkMpService
->EnableDisableAP (
661 ASSERT_EFI_ERROR (Status
);
663 ChangeCpuState (ProcessorNumber
, EnableAP
);
669 Implementation of WhoAmI() service of MP Services Protocol.
671 This service lets the caller processor get its handle number.
672 This service may be called from the BSP and APs.
674 @param This A pointer to the EFI_MP_SERVICES_PROTOCOL instance.
675 @param ProcessorNumber Pointer to the handle number of AP.
677 @retval EFI_SUCCESS Processor number successfully returned.
678 @retval EFI_INVALID_PARAMETER ProcessorNumber is NULL
684 IN EFI_MP_SERVICES_PROTOCOL
*This
,
685 OUT UINTN
*ProcessorNumber
690 if (ProcessorNumber
== NULL
) {
691 return EFI_INVALID_PARAMETER
;
694 Status
= mFrameworkMpService
->WhoAmI (
698 ASSERT_EFI_ERROR (Status
);
704 Checks APs' status periodically.
706 This function is triggerred by timer perodically to check the
707 state of APs for StartupAllAPs() and StartupThisAP() executed
708 in non-blocking mode.
710 @param Event Event triggered.
711 @param Context Parameter passed with the event.
721 UINTN ProcessorNumber
;
722 CPU_DATA_BLOCK
*CpuData
;
726 // If CheckAPsStatus() is stopped, then return immediately.
728 if (mStopCheckAPsStatus
) {
733 // First, check whether pending StartupAllAPs() exists.
735 if (mMPSystemData
.WaitEvent
!= NULL
) {
737 Status
= CheckAllAPs ();
739 // If all APs finish for StartupAllAPs(), signal the WaitEvent for it..
741 if (Status
!= EFI_NOT_READY
) {
742 Status
= gBS
->SignalEvent (mMPSystemData
.WaitEvent
);
743 mMPSystemData
.WaitEvent
= NULL
;
748 // Second, check whether pending StartupThisAPs() callings exist.
750 for (ProcessorNumber
= 0; ProcessorNumber
< mNumberOfProcessors
; ProcessorNumber
++) {
752 CpuData
= &mMPSystemData
.CpuData
[ProcessorNumber
];
754 if (CpuData
->WaitEvent
== NULL
) {
758 Status
= CheckThisAP (ProcessorNumber
);
760 if (Status
!= EFI_NOT_READY
) {
761 gBS
->SignalEvent (CpuData
->WaitEvent
);
762 CpuData
->WaitEvent
= NULL
;
769 Checks status of all APs.
771 This function checks whether all APs have finished task assigned by StartupAllAPs(),
772 and whether timeout expires.
774 @retval EFI_SUCCESS All APs have finished task assigned by StartupAllAPs().
775 @retval EFI_TIMEOUT The timeout expires.
776 @retval EFI_NOT_READY APs have not finished task and timeout has not expired.
784 UINTN ProcessorNumber
;
785 UINTN NextProcessorNumber
;
789 CPU_DATA_BLOCK
*CpuData
;
791 NextProcessorNumber
= 0;
794 // Go through all APs that are responsible for the StartupAllAPs().
796 for (ProcessorNumber
= 0; ProcessorNumber
< mNumberOfProcessors
; ProcessorNumber
++) {
797 if (!mMPSystemData
.CpuList
[ProcessorNumber
]) {
801 CpuData
= &mMPSystemData
.CpuData
[ProcessorNumber
];
804 // Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.
805 // Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the
806 // value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.
808 AcquireSpinLock (&CpuData
->CpuDataLock
);
809 CpuState
= CpuData
->State
;
810 ReleaseSpinLock (&CpuData
->CpuDataLock
);
812 if (CpuState
== CpuStateFinished
) {
813 mMPSystemData
.FinishCount
++;
814 mMPSystemData
.CpuList
[ProcessorNumber
] = FALSE
;
816 AcquireSpinLock (&CpuData
->CpuDataLock
);
817 CpuData
->State
= CpuStateIdle
;
818 ReleaseSpinLock (&CpuData
->CpuDataLock
);
821 // If in Single Thread mode, then search for the next waiting AP for execution.
823 if (mMPSystemData
.SingleThread
) {
824 Status
= GetNextWaitingProcessorNumber (&NextProcessorNumber
);
826 if (!EFI_ERROR (Status
)) {
829 mMPSystemData
.Procedure
,
830 mMPSystemData
.ProcArguments
838 // If all APs finish, return EFI_SUCCESS.
840 if (mMPSystemData
.FinishCount
== mMPSystemData
.StartCount
) {
845 // If timeout expires, report timeout.
847 if (CheckTimeout (&mMPSystemData
.CurrentTime
, &mMPSystemData
.TotalTime
, mMPSystemData
.ExpectedTime
)) {
849 // If FailedCpuList is not NULL, record all failed APs in it.
851 if (mMPSystemData
.FailedCpuList
!= NULL
) {
852 *mMPSystemData
.FailedCpuList
= AllocatePool ((mMPSystemData
.StartCount
- mMPSystemData
.FinishCount
+ 1) * sizeof(UINTN
));
853 ASSERT (*mMPSystemData
.FailedCpuList
!= NULL
);
857 for (ProcessorNumber
= 0; ProcessorNumber
< mNumberOfProcessors
; ProcessorNumber
++) {
859 // Check whether this processor is responsible for StartupAllAPs().
861 if (mMPSystemData
.CpuList
[ProcessorNumber
]) {
863 // Reset failed APs to idle state
865 ResetProcessorToIdleState (ProcessorNumber
);
866 mMPSystemData
.CpuList
[ProcessorNumber
] = FALSE
;
867 if (mMPSystemData
.FailedCpuList
!= NULL
) {
868 (*mMPSystemData
.FailedCpuList
)[ListIndex
++] = ProcessorNumber
;
872 if (mMPSystemData
.FailedCpuList
!= NULL
) {
873 (*mMPSystemData
.FailedCpuList
)[ListIndex
] = END_OF_CPU_LIST
;
877 return EFI_NOT_READY
;
881 Checks status of specified AP.
883 This function checks whether specified AP has finished task assigned by StartupThisAP(),
884 and whether timeout expires.
886 @param ProcessorNumber The handle number of processor.
888 @retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().
889 @retval EFI_TIMEOUT The timeout expires.
890 @retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.
895 UINTN ProcessorNumber
898 CPU_DATA_BLOCK
*CpuData
;
901 ASSERT (ProcessorNumber
< mNumberOfProcessors
);
902 ASSERT (ProcessorNumber
< MAX_CPU_NUMBER
);
904 CpuData
= &mMPSystemData
.CpuData
[ProcessorNumber
];
907 // Check the CPU state of AP. If it is CpuStateFinished, then the AP has finished its task.
908 // Only BSP and corresponding AP access this unit of CPU Data. This means the AP will not modify the
909 // value of state after setting the it to CpuStateFinished, so BSP can safely make use of its value.
911 AcquireSpinLock (&CpuData
->CpuDataLock
);
912 CpuState
= CpuData
->State
;
913 ReleaseSpinLock (&CpuData
->CpuDataLock
);
916 // If the APs finishes for StartupThisAP(), return EFI_SUCCESS.
918 if (CpuState
== CpuStateFinished
) {
920 AcquireSpinLock (&CpuData
->CpuDataLock
);
921 CpuData
->State
= CpuStateIdle
;
922 ReleaseSpinLock (&CpuData
->CpuDataLock
);
924 if (CpuData
->Finished
!= NULL
) {
925 *(CpuData
->Finished
) = TRUE
;
930 // If timeout expires for StartupThisAP(), report timeout.
932 if (CheckTimeout (&CpuData
->CurrentTime
, &CpuData
->TotalTime
, CpuData
->ExpectedTime
)) {
934 if (CpuData
->Finished
!= NULL
) {
935 *(CpuData
->Finished
) = FALSE
;
938 // Reset failed AP to idle state
940 ResetProcessorToIdleState (ProcessorNumber
);
945 return EFI_NOT_READY
;
949 Calculate timeout value and return the current performance counter value.
951 Calculate the number of performance counter ticks required for a timeout.
952 If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
955 @param TimeoutInMicroseconds Timeout value in microseconds.
956 @param CurrentTime Returns the current value of the performance counter.
958 @return Expected timestamp counter for timeout.
959 If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
965 IN UINTN TimeoutInMicroseconds
,
966 OUT UINT64
*CurrentTime
970 // Read the current value of the performance counter
972 *CurrentTime
= GetPerformanceCounter ();
975 // If TimeoutInMicroseconds is 0, return value is also 0, which is recognized
978 if (TimeoutInMicroseconds
== 0) {
983 // GetPerformanceCounterProperties () returns the timestamp counter's frequency
984 // in Hz. So multiply the return value with TimeoutInMicroseconds and then divide
985 // it by 1,000,000, to get the number of ticks for the timeout value.
989 GetPerformanceCounterProperties (NULL
, NULL
),
990 TimeoutInMicroseconds
997 Checks whether timeout expires.
999 Check whether the number of ellapsed performance counter ticks required for a timeout condition
1000 has been reached. If Timeout is zero, which means infinity, return value is always FALSE.
1002 @param PreviousTime On input, the value of the performance counter when it was last read.
1003 On output, the current value of the performance counter
1004 @param TotalTime The total amount of ellapsed time in performance counter ticks.
1005 @param Timeout The number of performance counter ticks required to reach a timeout condition.
1007 @retval TRUE A timeout condition has been reached.
1008 @retval FALSE A timeout condition has not been reached.
1013 IN OUT UINT64
*PreviousTime
,
1014 IN UINT64
*TotalTime
,
1027 GetPerformanceCounterProperties (&Start
, &End
);
1028 Cycle
= End
- Start
;
1033 CurrentTime
= GetPerformanceCounter();
1034 Delta
= (INT64
) (CurrentTime
- *PreviousTime
);
1041 *TotalTime
+= Delta
;
1042 *PreviousTime
= CurrentTime
;
1043 if (*TotalTime
> Timeout
) {
1050 Searches for the next waiting AP.
1052 Search for the next AP that is put in waiting state by single-threaded StartupAllAPs().
1054 @param NextProcessorNumber Pointer to the processor number of the next waiting AP.
1056 @retval EFI_SUCCESS The next waiting AP has been found.
1057 @retval EFI_NOT_FOUND No waiting AP exists.
1061 GetNextWaitingProcessorNumber (
1062 OUT UINTN
*NextProcessorNumber
1065 UINTN ProcessorNumber
;
1067 for (ProcessorNumber
= 0; ProcessorNumber
< mNumberOfProcessors
; ProcessorNumber
++) {
1069 if (mMPSystemData
.CpuList
[ProcessorNumber
]) {
1070 *NextProcessorNumber
= ProcessorNumber
;
1075 return EFI_NOT_FOUND
;
1079 Wrapper function for all procedures assigned to AP.
1081 Wrapper function for all procedures assigned to AP via MP service protocol.
1082 It controls states of AP and invokes assigned precedure.
1090 EFI_AP_PROCEDURE Procedure
;
1092 UINTN ProcessorNumber
;
1093 CPU_DATA_BLOCK
*CpuData
;
1095 WhoAmI (&mMpService
, &ProcessorNumber
);
1096 CpuData
= &mMPSystemData
.CpuData
[ProcessorNumber
];
1098 AcquireSpinLock (&CpuData
->CpuDataLock
);
1099 CpuData
->State
= CpuStateBusy
;
1100 ReleaseSpinLock (&CpuData
->CpuDataLock
);
1103 // Now let us check it out.
1105 AcquireSpinLock (&CpuData
->CpuDataLock
);
1106 Procedure
= CpuData
->Procedure
;
1107 Parameter
= CpuData
->Parameter
;
1108 ReleaseSpinLock (&CpuData
->CpuDataLock
);
1110 if (Procedure
!= NULL
) {
1112 Procedure (Parameter
);
1115 // if BSP is switched to AP, it continue execute from here, but it carries register state
1116 // of the old AP, so need to reload CpuData (might be stored in a register after compiler
1117 // optimization) to make sure it points to the right data
1119 WhoAmI (&mMpService
, &ProcessorNumber
);
1120 CpuData
= &mMPSystemData
.CpuData
[ProcessorNumber
];
1122 AcquireSpinLock (&CpuData
->CpuDataLock
);
1123 CpuData
->Procedure
= NULL
;
1124 ReleaseSpinLock (&CpuData
->CpuDataLock
);
1127 AcquireSpinLock (&CpuData
->CpuDataLock
);
1128 CpuData
->State
= CpuStateFinished
;
1129 ReleaseSpinLock (&CpuData
->CpuDataLock
);
1133 Sends INIT-SIPI-SIPI to AP.
1135 This function sends INIT-SIPI-SIPI to AP, and assign procedure specified by ApFunction.
1137 @param Broadcast If TRUE, broadcase IPI to all APs; otherwise, send to specified AP.
1138 @param ApicID The Local APIC ID of the specified AP. If Broadcast is TRUE, it is ignored.
1139 @param ApFunction The procedure for AP to work on.
1144 IN BOOLEAN Broadcast
,
1153 UINT32 VectorNumber
;
1154 UINT32 DeliveryMode
;
1156 mExchangeInfo
->ApFunction
= ApFunction
;
1157 mExchangeInfo
->StackStart
= mStackStartAddress
;
1161 ICRLow
= BROADCAST_MODE_ALL_EXCLUDING_SELF_BIT
| TRIGGER_MODE_LEVEL_BIT
| ASSERT_BIT
;
1163 ICRHigh
= ApicID
<< 24;
1164 ICRLow
= SPECIFY_CPU_MODE_BIT
| TRIGGER_MODE_LEVEL_BIT
| ASSERT_BIT
;
1168 DeliveryMode
= DELIVERY_MODE_INIT
;
1169 ICRLow
|= VectorNumber
| (DeliveryMode
<< 8);
1171 ApicBase
= 0xfee00000;
1174 // Write Interrupt Command Registers to send INIT IPI.
1176 MmioWrite32 (ApicBase
+ APIC_REGISTER_ICR_HIGH_OFFSET
, ICRHigh
);
1177 MmioWrite32 (ApicBase
+ APIC_REGISTER_ICR_LOW_OFFSET
, ICRLow
);
1179 MicroSecondDelay (10);
1181 VectorNumber
= (UINT32
) RShiftU64 (mStartupVector
, 12);
1182 DeliveryMode
= DELIVERY_MODE_SIPI
;
1184 ICRLow
= BROADCAST_MODE_ALL_EXCLUDING_SELF_BIT
| TRIGGER_MODE_LEVEL_BIT
| ASSERT_BIT
;
1186 ICRLow
= SPECIFY_CPU_MODE_BIT
| TRIGGER_MODE_LEVEL_BIT
| ASSERT_BIT
;
1189 ICRLow
|= VectorNumber
| (DeliveryMode
<< 8);
1192 // Write Interrupt Command Register to send first SIPI IPI.
1194 MmioWrite32 (ApicBase
+ APIC_REGISTER_ICR_LOW_OFFSET
, ICRLow
);
1196 MicroSecondDelay (200);
1199 // Write Interrupt Command Register to send second SIPI IPI.
1201 MmioWrite32 (ApicBase
+ APIC_REGISTER_ICR_LOW_OFFSET
, ICRLow
);
1205 Function to wake up a specified AP and assign procedure to it.
1207 @param ProcessorNumber Handle number of the specified processor.
1208 @param Procedure Procedure to assign.
1209 @param ProcArguments Argument for Procedure.
1214 IN UINTN ProcessorNumber
,
1215 IN EFI_AP_PROCEDURE Procedure
,
1216 IN VOID
*ProcArguments
1220 CPU_DATA_BLOCK
*CpuData
;
1221 EFI_PROCESSOR_INFORMATION ProcessorInfoBuffer
;
1223 ASSERT (ProcessorNumber
< mNumberOfProcessors
);
1224 ASSERT (ProcessorNumber
< MAX_CPU_NUMBER
);
1226 CpuData
= &mMPSystemData
.CpuData
[ProcessorNumber
];
1228 AcquireSpinLock (&CpuData
->CpuDataLock
);
1229 CpuData
->Parameter
= ProcArguments
;
1230 CpuData
->Procedure
= Procedure
;
1231 ReleaseSpinLock (&CpuData
->CpuDataLock
);
1233 Status
= GetProcessorInfo (
1236 &ProcessorInfoBuffer
1238 ASSERT_EFI_ERROR (Status
);
1242 (UINT32
) ProcessorInfoBuffer
.ProcessorId
,
1243 (VOID
*) (UINTN
) ApProcWrapper
1248 Terminate AP's task and set it to idle state.
1250 This function terminates AP's task due to timeout by sending INIT-SIPI,
1251 and sends it to idle state.
1253 @param ProcessorNumber Handle number of the specified processor.
1257 ResetProcessorToIdleState (
1258 UINTN ProcessorNumber
1262 CPU_DATA_BLOCK
*CpuData
;
1263 EFI_PROCESSOR_INFORMATION ProcessorInfoBuffer
;
1265 Status
= GetProcessorInfo (
1268 &ProcessorInfoBuffer
1270 ASSERT_EFI_ERROR (Status
);
1274 (UINT32
) ProcessorInfoBuffer
.ProcessorId
,
1278 CpuData
= &mMPSystemData
.CpuData
[ProcessorNumber
];
1280 AcquireSpinLock (&CpuData
->CpuDataLock
);
1281 CpuData
->State
= CpuStateIdle
;
1282 ReleaseSpinLock (&CpuData
->CpuDataLock
);
1286 Worker function of EnableDisableAP ()
1288 Worker function of EnableDisableAP (). Changes state of specified processor.
1290 @param ProcessorNumber Processor number of specified AP.
1291 @param NewState Desired state of the specified AP.
1293 @retval EFI_SUCCESS AP's state successfully changed.
1298 IN UINTN ProcessorNumber
,
1302 CPU_DATA_BLOCK
*CpuData
;
1304 ASSERT (ProcessorNumber
< mNumberOfProcessors
);
1305 ASSERT (ProcessorNumber
< MAX_CPU_NUMBER
);
1307 CpuData
= &mMPSystemData
.CpuData
[ProcessorNumber
];
1310 AcquireSpinLock (&CpuData
->CpuDataLock
);
1311 CpuData
->State
= CpuStateDisabled
;
1312 ReleaseSpinLock (&CpuData
->CpuDataLock
);
1314 AcquireSpinLock (&CpuData
->CpuDataLock
);
1315 CpuData
->State
= CpuStateIdle
;
1316 ReleaseSpinLock (&CpuData
->CpuDataLock
);
1323 Test memory region of EfiGcdMemoryTypeReserved.
1325 @param Length The length of memory region to test.
1327 @retval EFI_SUCCESS The memory region passes test.
1328 @retval EFI_NOT_FOUND The memory region is not reserved memory.
1329 @retval EFI_DEVICE_ERROR The memory fails on test.
1333 TestReservedMemory (
1338 EFI_GCD_MEMORY_SPACE_DESCRIPTOR Descriptor
;
1339 EFI_PHYSICAL_ADDRESS Address
;
1340 UINTN LengthCovered
;
1341 UINTN RemainingLength
;
1344 // Walk through the memory descriptors covering the memory range.
1346 Address
= mStartupVector
;
1347 RemainingLength
= Length
;
1348 while (Address
< mStartupVector
+ Length
) {
1349 Status
= gDS
->GetMemorySpaceDescriptor(
1353 if (EFI_ERROR (Status
)) {
1354 return EFI_NOT_FOUND
;
1357 if (Descriptor
.GcdMemoryType
!= EfiGcdMemoryTypeReserved
) {
1358 return EFI_NOT_FOUND
;
1361 // Calculated the length of the intersected range.
1363 LengthCovered
= (UINTN
) (Descriptor
.BaseAddress
+ Descriptor
.Length
- Address
);
1364 if (LengthCovered
> RemainingLength
) {
1365 LengthCovered
= RemainingLength
;
1368 Status
= mGenMemoryTest
->CompatibleRangeTest (
1373 if (EFI_ERROR (Status
)) {
1374 return EFI_DEVICE_ERROR
;
1377 Address
+= LengthCovered
;
1378 RemainingLength
-= LengthCovered
;
1385 Allocates startup vector for APs.
1387 This function allocates Startup vector for APs.
1389 @param Size The size of startup vector.
1393 AllocateStartupVector (
1399 Status
= gBS
->LocateProtocol (
1400 &gEfiGenericMemTestProtocolGuid
,
1402 (VOID
**) &mGenMemoryTest
1404 if (EFI_ERROR (Status
)) {
1405 mGenMemoryTest
= NULL
;
1408 for (mStartupVector
= 0x7F000; mStartupVector
>= 0x2000; mStartupVector
-= EFI_PAGE_SIZE
) {
1409 if (mGenMemoryTest
!= NULL
) {
1411 // Test memory if it is EfiGcdMemoryTypeReserved.
1413 Status
= TestReservedMemory (EFI_SIZE_TO_PAGES (Size
) * EFI_PAGE_SIZE
);
1414 if (Status
== EFI_DEVICE_ERROR
) {
1419 Status
= gBS
->AllocatePages (
1421 EfiBootServicesCode
,
1422 EFI_SIZE_TO_PAGES (Size
),
1426 if (!EFI_ERROR (Status
)) {
1431 ASSERT_EFI_ERROR (Status
);
1435 Prepares Startup Vector for APs.
1437 This function prepares Startup Vector for APs.
1441 PrepareAPStartupVector (
1445 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
1446 IA32_DESCRIPTOR GdtrForBSP
;
1447 EFI_PHYSICAL_ADDRESS GdtForAP
;
1451 // Get the address map of startup code for AP,
1452 // including code size, and offset of long jump instructions to redirect.
1454 AsmGetAddressMap (&AddressMap
);
1457 // Allocate a 4K-aligned region under 1M for startup vector for AP.
1458 // The region contains AP startup code and exchange data between BSP and AP.
1460 AllocateStartupVector (AddressMap
.Size
+ sizeof (MP_CPU_EXCHANGE_INFO
));
1463 // Copy AP startup code to startup vector, and then redirect the long jump
1464 // instructions for mode switching.
1466 CopyMem ((VOID
*) (UINTN
) mStartupVector
, AddressMap
.RendezvousFunnelAddress
, AddressMap
.Size
);
1467 *(UINT32
*) (UINTN
) (mStartupVector
+ AddressMap
.FlatJumpOffset
+ 3) = (UINT32
) (mStartupVector
+ AddressMap
.PModeEntryOffset
);
1469 // For IA32 mode, LongJumpOffset is filled with zero. If non-zero, then we are in X64 mode, so further redirect for long mode switch.
1471 if (AddressMap
.LongJumpOffset
!= 0) {
1472 *(UINT32
*) (UINTN
) (mStartupVector
+ AddressMap
.LongJumpOffset
+ 2) = (UINT32
) (mStartupVector
+ AddressMap
.LModeEntryOffset
);
1476 // Get the start address of exchange data between BSP and AP.
1478 mExchangeInfo
= (MP_CPU_EXCHANGE_INFO
*) (UINTN
) (mStartupVector
+ AddressMap
.Size
);
1480 ZeroMem ((VOID
*) mExchangeInfo
, sizeof (MP_CPU_EXCHANGE_INFO
));
1482 mStackStartAddress
= AllocatePages (EFI_SIZE_TO_PAGES (MAX_CPU_NUMBER
* AP_STACK_SIZE
));
1483 mExchangeInfo
->StackSize
= AP_STACK_SIZE
;
1485 AsmReadGdtr (&GdtrForBSP
);
1488 // Allocate memory under 4G to hold GDT for APs
1490 GdtForAP
= 0xffffffff;
1491 Status
= gBS
->AllocatePages (
1493 EfiBootServicesData
,
1494 EFI_SIZE_TO_PAGES (GdtrForBSP
.Limit
+ 1),
1497 ASSERT_EFI_ERROR (Status
);
1499 CopyMem ((VOID
*) (UINTN
) GdtForAP
, (VOID
*) GdtrForBSP
.Base
, GdtrForBSP
.Limit
+ 1);
1501 mExchangeInfo
->GdtrProfile
.Base
= (UINTN
) GdtForAP
;
1502 mExchangeInfo
->GdtrProfile
.Limit
= GdtrForBSP
.Limit
;
1504 mExchangeInfo
->BufferStart
= (UINT32
) mStartupVector
;
1505 mExchangeInfo
->Cr3
= (UINT32
) (AsmReadCr3 ());
1509 Prepares memory region for processor configuration.
1511 This function prepares memory region for processor configuration.
1515 PrepareMemoryForConfiguration (
1522 // Initialize Spin Locks for system
1524 InitializeSpinLock (&mMPSystemData
.APSerializeLock
);
1525 for (Index
= 0; Index
< MAX_CPU_NUMBER
; Index
++) {
1526 InitializeSpinLock (&mMPSystemData
.CpuData
[Index
].CpuDataLock
);
1529 PrepareAPStartupVector ();
1533 Gets the processor number of BSP.
1535 @return The processor number of BSP.
1543 UINTN ProcessorNumber
;
1544 EFI_MP_PROC_CONTEXT ProcessorContextBuffer
;
1548 BufferSize
= sizeof (EFI_MP_PROC_CONTEXT
);
1550 for (ProcessorNumber
= 0; ProcessorNumber
< mNumberOfProcessors
; ProcessorNumber
++) {
1551 Status
= mFrameworkMpService
->GetProcessorContext (
1552 mFrameworkMpService
,
1555 &ProcessorContextBuffer
1557 ASSERT_EFI_ERROR (Status
);
1559 if (ProcessorContextBuffer
.Designation
== EfiCpuBSP
) {
1563 ASSERT (ProcessorNumber
< mNumberOfProcessors
);
1565 return ProcessorNumber
;
1569 Entrypoint of MP Services Protocol thunk driver.
1571 @param[in] ImageHandle The firmware allocated handle for the EFI image.
1572 @param[in] SystemTable A pointer to the EFI System Table.
1574 @retval EFI_SUCCESS The entry point is executed successfully.
1579 InitializeMpServicesProtocol (
1580 IN EFI_HANDLE ImageHandle
,
1581 IN EFI_SYSTEM_TABLE
*SystemTable
1586 PrepareMemoryForConfiguration ();
1589 // Locates Framework version MP Services Protocol
1591 Status
= gBS
->LocateProtocol (
1592 &gFrameworkEfiMpServiceProtocolGuid
,
1594 (VOID
**) &mFrameworkMpService
1596 ASSERT_EFI_ERROR (Status
);
1598 Status
= mFrameworkMpService
->GetGeneralMPInfo (
1599 mFrameworkMpService
,
1600 &mNumberOfProcessors
,
1606 ASSERT_EFI_ERROR (Status
);
1607 ASSERT (mNumberOfProcessors
< MAX_CPU_NUMBER
);
1610 // Create timer event to check AP state for non-blocking execution.
1612 Status
= gBS
->CreateEvent (
1613 EVT_TIMER
| EVT_NOTIFY_SIGNAL
,
1617 &mMPSystemData
.CheckAPsEvent
1619 ASSERT_EFI_ERROR (Status
);
1622 // Now install the MP services protocol.
1624 Status
= gBS
->InstallProtocolInterface (
1626 &gEfiMpServiceProtocolGuid
,
1627 EFI_NATIVE_INTERFACE
,
1630 ASSERT_EFI_ERROR (Status
);
1633 // Launch the timer event to check AP state.
1635 Status
= gBS
->SetTimer (
1636 mMPSystemData
.CheckAPsEvent
,
1640 ASSERT_EFI_ERROR (Status
);