3 Copyright (c) 2006, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 EFI PEI Core dispatch services
28 TransferOldDataToNewDataRange (
29 IN PEI_CORE_INSTANCE
*PrivateData
34 IN EFI_PEI_STARTUP_DESCRIPTOR
*PeiStartupDescriptor
,
35 IN PEI_CORE_INSTANCE
*PrivateData
,
36 IN PEI_CORE_DISPATCH_DATA
*DispatchData
43 Conduct PEIM dispatch.
47 PeiStartupDescriptor - Pointer to IN EFI_PEI_STARTUP_DESCRIPTOR
48 PrivateData - Pointer to the private data passed in from caller
49 DispatchData - Pointer to PEI_CORE_DISPATCH_DATA data.
53 EFI_SUCCESS - Successfully dispatched PEIM.
54 EFI_NOT_FOUND - The dispatch failed.
59 PEI_CORE_TEMP_POINTERS TempPtr
;
60 UINTN PrivateDataInMem
;
62 EFI_FIRMWARE_VOLUME_HEADER
*NextFvAddress
;
63 EFI_FIRMWARE_VOLUME_HEADER
*DefaultFvAddress
;
66 // Debug data for uninstalled Peim list
68 EFI_GUID DebugFoundPeimList
[32];
69 EFI_DEVICE_HANDLE_EXTENDED_DATA ExtendedData
;
72 // save the Current FV Address so that we will not process it again if FindFv returns it later
74 DefaultFvAddress
= DispatchData
->BootFvAddress
;
77 // This is the main dispatch loop. It will search known FVs for PEIMs and
78 // attempt to dispatch them. If any PEIM gets dispatched through a single
79 // pass of the dispatcher, it will start over from the Bfv again to see
80 // if any new PEIMs dependencies got satisfied. With a well ordered
81 // FV where PEIMs are found in the order their dependencies are also
82 // satisfied, this dipatcher should run only once.
86 // This is the PEIM search loop. It will scan through all PEIMs it can find
87 // looking for PEIMs to dispatch, and will dipatch them if they have not
88 // already been dispatched and all of their dependencies are met.
89 // If no more PEIMs can be found in this pass through all known FVs,
90 // then it will break out of this loop.
94 Status
= FindNextPeim (
96 DispatchData
->CurrentFvAddress
,
97 &DispatchData
->CurrentPeimAddress
101 // If we found a PEIM, check if it is dispatched. If so, go to the
102 // next PEIM. If not, dispatch it if its dependencies are satisfied.
103 // If its dependencies are not satisfied, go to the next PEIM.
105 if (Status
== EFI_SUCCESS
) {
110 // Fill list of found Peims for later list of those not installed
113 &DebugFoundPeimList
[DispatchData
->CurrentPeim
],
114 &DispatchData
->CurrentPeimAddress
->Name
,
121 DispatchData
->CurrentPeim
,
122 DispatchData
->DispatchedPeimBitMap
124 if (DepexSatisfied (&PrivateData
->PS
, DispatchData
->CurrentPeimAddress
)) {
125 Status
= PeiLoadImage (
127 DispatchData
->CurrentPeimAddress
,
130 if (Status
== EFI_SUCCESS
) {
133 // The PEIM has its dependencies satisfied, and its entry point
134 // has been found, so invoke it.
137 (VOID
*) (UINTN
) (DispatchData
->CurrentPeimAddress
),
144 // BUGBUG: Used to be EFI_PEI_REPORT_STATUS_CODE_CODE
146 ExtendedData
.Handle
= (EFI_HANDLE
)DispatchData
->CurrentPeimAddress
;
148 REPORT_STATUS_CODE_WITH_EXTENDED_DATA (
150 EFI_SOFTWARE_PEI_CORE
| EFI_SW_PC_INIT_BEGIN
,
151 (VOID
*)(&ExtendedData
),
152 sizeof (ExtendedData
)
156 // Is this a authentic image
158 Status
= VerifyPeim (
160 DispatchData
->CurrentPeimAddress
163 if (Status
!= EFI_SECURITY_VIOLATION
) {
166 // BUGBUG: Before enable PI, we need cast EFI_FFS_FILE_HEADER* to EFI_PEI_FILE_HANDLE*
167 // Because we use new MdePkg's definition, but they are binary compatible in fact.
169 Status
= TempPtr
.PeimEntry (
170 (EFI_PEI_FILE_HANDLE
*)DispatchData
->CurrentPeimAddress
,
175 REPORT_STATUS_CODE_WITH_EXTENDED_DATA (
177 EFI_SOFTWARE_PEI_CORE
| EFI_SW_PC_INIT_END
,
178 (VOID
*)(&ExtendedData
),
179 sizeof (ExtendedData
)
182 PERF_END ((VOID
*) (UINTN
) (DispatchData
->CurrentPeimAddress
), "PEIM", NULL
, 0);
185 // Mark the PEIM as dispatched so we don't attempt to run it again
189 DispatchData
->CurrentPeim
,
190 &DispatchData
->DispatchedPeimBitMap
194 // Process the Notify list and dispatch any notifies for
195 // newly installed PPIs.
197 ProcessNotifyList (&PrivateData
->PS
);
200 // If real system memory was discovered and installed by this
201 // PEIM, switch the stacks to the new memory. Since we are
202 // at dispatch level, only the Core's private data is preserved,
203 // nobody else should have any data on the stack.
205 if (PrivateData
->SwitchStackSignal
) {
206 TempPtr
.PeiCore
= (PEI_CORE_ENTRY_POINT
)PeiCore
;
207 PrivateDataInMem
= (UINTN
) TransferOldDataToNewDataRange (PrivateData
);
208 ASSERT (PrivateDataInMem
!= 0);
210 // Adjust the top of stack to be aligned at CPU_STACK_ALIGNMENT
212 TopOfStack
= (VOID
*)((UINTN
)PrivateData
->StackBase
+ (UINTN
)PrivateData
->StackSize
- CPU_STACK_ALIGNMENT
);
213 TopOfStack
= ALIGN_POINTER (TopOfStack
, CPU_STACK_ALIGNMENT
);
216 (SWITCH_STACK_ENTRY_POINT
)(UINTN
)TempPtr
.Raw
,
217 PeiStartupDescriptor
,
218 (VOID
*)PrivateDataInMem
,
220 (VOID
*)(UINTN
)PrivateData
->StackBase
226 DispatchData
->CurrentPeim
++;
232 // If we could not find another PEIM in the current FV, go try
233 // the FindFv PPI to look in other FVs for more PEIMs. If we can
234 // not locate the FindFv PPI, or if the FindFv PPI can not find
235 // anymore FVs, then exit the PEIM search loop.
237 if (DispatchData
->FindFv
== NULL
) {
238 Status
= PeiServicesLocatePpi (
242 (VOID
**)&DispatchData
->FindFv
244 if (Status
!= EFI_SUCCESS
) {
249 while (!NextFvFound
) {
250 Status
= DispatchData
->FindFv
->FindFv (
251 DispatchData
->FindFv
,
253 &DispatchData
->CurrentFv
,
257 // if there is no next fv, get out of this loop of finding FVs
259 if (Status
!= EFI_SUCCESS
) {
263 // don't process the default Fv again. (we don't know the order in which the hobs were created)
265 if ((NextFvAddress
!= DefaultFvAddress
) &&
266 (NextFvAddress
!= DispatchData
->CurrentFvAddress
)) {
269 // VerifyFv() is currently returns SUCCESS all the time, add code to it to
270 // actually verify the given FV
272 Status
= VerifyFv (NextFvAddress
);
273 if (Status
== EFI_SUCCESS
) {
275 DispatchData
->CurrentFvAddress
= NextFvAddress
;
276 DispatchData
->CurrentPeimAddress
= NULL
;
278 // current PRIM number (CurrentPeim) must continue as is, don't reset it here
284 // if there is no next fv, get out of this loop of dispatching PEIMs
290 // continue in the inner for(;;) loop with a new FV;
296 // If all the PEIMs that we have found have been dispatched, then
297 // there is nothing left to dispatch and we don't need to go search
298 // through all PEIMs again.
300 if ((~(DispatchData
->DispatchedPeimBitMap
) &
301 ((1 << DispatchData
->CurrentPeim
)-1)) == 0) {
306 // Check if no more PEIMs that depex was satisfied
308 if (DispatchData
->DispatchedPeimBitMap
== DispatchData
->PreviousPeimBitMap
) {
313 // Case when Depex is not satisfied and has to traverse the list again
315 DispatchData
->CurrentPeim
= 0;
316 DispatchData
->CurrentPeimAddress
= 0;
317 DispatchData
->PreviousPeimBitMap
= DispatchData
->DispatchedPeimBitMap
;
320 // don't go back to the loop without making sure that the CurrentFvAddress is the
321 // same as the 1st (or default) FV we started with. otherwise we will interpret the bimap wrongly and
322 // mess it up, always start processing the PEIMs from the default FV just like in the first time around.
324 DispatchData
->CurrentFv
= 0;
325 DispatchData
->CurrentFvAddress
= DefaultFvAddress
;
330 // Debug data for uninstalled Peim list
332 UINT32 DebugNotDispatchedBitmap
;
333 UINT8 DebugFoundPeimPoint
;
335 DebugFoundPeimPoint
= 0;
337 // Get bitmap of Peims that were not dispatched,
340 DebugNotDispatchedBitmap
= ((DispatchData
->DispatchedPeimBitMap
) ^ ((1 << DispatchData
->CurrentPeim
)-1));
342 // Scan bitmap of Peims not installed and print GUIDS
344 while (DebugNotDispatchedBitmap
!= 0) {
345 if ((DebugNotDispatchedBitmap
& 1) != 0) {
346 DEBUG ((EFI_D_INFO
, "WARNING -> InstallPpi: Not Installed: %g\n",
347 &DebugFoundPeimList
[DebugFoundPeimPoint
]
350 DebugFoundPeimPoint
++;
351 DebugNotDispatchedBitmap
>>= 1;
356 return EFI_NOT_FOUND
;
360 InitializeDispatcherData (
361 IN EFI_PEI_SERVICES
**PeiServices
,
362 IN PEI_CORE_INSTANCE
*OldCoreData
,
363 IN EFI_PEI_STARTUP_DESCRIPTOR
*PeiStartupDescriptor
369 Initialize the Dispatcher's data members
373 PeiServices - The PEI core services table.
374 OldCoreData - Pointer to old core data (before switching stack).
375 NULL if being run in non-permament memory mode.
376 PeiStartupDescriptor - Information and services provided by SEC phase.
384 PEI_CORE_INSTANCE
*PrivateData
;
386 PrivateData
= PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices
);
388 if (OldCoreData
== NULL
) {
389 PrivateData
->DispatchData
.CurrentFvAddress
= (EFI_FIRMWARE_VOLUME_HEADER
*) PeiStartupDescriptor
->BootFirmwareVolume
;
390 PrivateData
->DispatchData
.BootFvAddress
= (EFI_FIRMWARE_VOLUME_HEADER
*) PeiStartupDescriptor
->BootFirmwareVolume
;
394 // Current peim has been dispatched, but not count
396 PrivateData
->DispatchData
.CurrentPeim
= (UINT8
)(OldCoreData
->DispatchData
.CurrentPeim
+ 1);
405 IN UINT8 CurrentPeim
,
406 IN UINT32 DispatchedPeimBitMap
412 This routine checks to see if a particular PEIM has been dispatched during
413 the PEI core dispatch.
416 CurrentPeim - The PEIM/FV in the bit array to check.
417 DispatchedPeimBitMap - Bit array, each bit corresponds to a PEIM/FV.
420 TRUE - PEIM already dispatched
425 return (BOOLEAN
)((DispatchedPeimBitMap
& (1 << CurrentPeim
)) != 0);
430 IN EFI_PEI_SERVICES
**PeiServices
,
431 IN UINT8 CurrentPeim
,
432 OUT UINT32
*DispatchedPeimBitMap
438 This routine sets a PEIM as having been dispatched once its entry
439 point has been invoked.
443 PeiServices - The PEI core services table.
444 CurrentPeim - The PEIM/FV in the bit array to check.
445 DispatchedPeimBitMap - Bit array, each bit corresponds to a PEIM/FV.
453 // Check if the total number of PEIMs exceed the bitmap.
454 // CurrentPeim is 0-based
456 ASSERT (CurrentPeim
< (sizeof (*DispatchedPeimBitMap
) * 8));
457 *DispatchedPeimBitMap
|= (1 << CurrentPeim
);
463 IN EFI_PEI_SERVICES
**PeiServices
,
464 IN VOID
*CurrentPeimAddress
470 This routine parses the Dependency Expression, if available, and
471 decides if the module can be executed.
474 PeiServices - The PEI Service Table
475 CurrentPeimAddress - Address of the PEIM Firmware File under investigation
478 TRUE - Can be dispatched
479 FALSE - Cannot be dispatched
487 Status
= PeiServicesFfsFindSectionData (
488 EFI_SECTION_PEI_DEPEX
,
493 // If there is no DEPEX, assume the module can be executed
495 if (EFI_ERROR (Status
)) {
500 // Evaluate a given DEPEX
502 Status
= PeimDispatchReadiness (
513 TransferOldDataToNewDataRange (
514 IN PEI_CORE_INSTANCE
*PrivateData
520 This routine transfers the contents of the pre-permanent memory
521 PEI Core private data to a post-permanent memory data location.
525 PrivateData - Pointer to the current PEI Core private data pre-permanent memory
529 Pointer to the PrivateData once the private data has been transferred to permanent memory
534 //Build private HOB to PEI core to transfer old NEM-range data to new NEM-range
536 return BuildGuidDataHob (&gEfiPeiCorePrivateGuid
, PrivateData
, sizeof (PEI_CORE_INSTANCE
));
540 This routine enable a PEIM to register itself to shadow when PEI Foundation
541 discovery permanent memory.
543 @param FileHandle File handle of a PEIM.
545 @retval EFI_NOT_FOUND The file handle doesn't point to PEIM itself.
546 @retval EFI_ALREADY_STARTED Indicate that the PEIM has been registered itself.
547 @retval EFI_SUCCESS Successfully to register itself.
552 PeiRegisterForShadow (
553 IN EFI_PEI_FILE_HANDLE FileHandle
556 PEI_CORE_INSTANCE
*Private
;
557 Private
= PEI_CORE_INSTANCE_FROM_PS_THIS (GetPeiServicesTablePointer ());
559 if (Private
->CurrentFileHandle
!= FileHandle
) {
561 // The FileHandle must be for the current PEIM
563 return EFI_NOT_FOUND
;
566 if (Private
->Fv
[Private
->CurrentPeimFvCount
].PeimState
[Private
->CurrentPeimCount
] >= PEIM_STATE_REGISITER_FOR_SHADOW
) {
568 // If the PEIM has already entered the PEIM_STATE_REGISTER_FOR_SHADOW or PEIM_STATE_DONE then it's already been started
570 return EFI_ALREADY_STARTED
;
573 Private
->Fv
[Private
->CurrentPeimFvCount
].PeimState
[Private
->CurrentPeimCount
] = PEIM_STATE_REGISITER_FOR_SHADOW
;