]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Core/Pei/Dispatcher/Dispatcher.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Temporarily rollback the change from 5625 though 5628 for more investigation.
[mirror_edk2.git] / MdeModulePkg / Core / Pei / Dispatcher / Dispatcher.c
1 /** @file
2 EFI PEI Core dispatch services
3
4 Copyright (c) 2006, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 **/
14
15 #include <PeiMain.h>
16
17 ///
18 /// CAR is filled with this initial value during SEC phase
19 ///
20 #define INIT_CAR_VALUE 0x5AA55AA5
21
22 typedef struct {
23 EFI_STATUS_CODE_DATA DataHeader;
24 EFI_HANDLE Handle;
25 } PEIM_FILE_HANDLE_EXTENDED_DATA;
26
27 /**
28
29 Discover all Peims and optional Apriori file in one FV. There is at most one
30 Apriori file in one FV.
31
32
33 @param Private - Pointer to the private data passed in from caller
34 @param VolumeHandle - Fv handle.
35
36 **/
37 VOID
38 DiscoverPeimsAndOrderWithApriori (
39 IN PEI_CORE_INSTANCE *Private,
40 IN EFI_PEI_FV_HANDLE VolumeHandle
41 )
42 {
43 EFI_STATUS Status;
44 EFI_PEI_FV_HANDLE FileHandle;
45 EFI_PEI_FILE_HANDLE AprioriFileHandle;
46 EFI_GUID *Apriori;
47 UINTN Index;
48 UINTN Index2;
49 UINTN PeimIndex;
50 UINTN PeimCount;
51 EFI_GUID *Guid;
52 EFI_PEI_FV_HANDLE TempFileHandles[FixedPcdGet32 (PcdPeiCoreMaxPeimPerFv)];
53 EFI_GUID FileGuid[FixedPcdGet32 (PcdPeiCoreMaxPeimPerFv)];
54
55 //
56 // Walk the FV and find all the PEIMs and the Apriori file.
57 //
58 AprioriFileHandle = NULL;
59 Private->CurrentFvFileHandles[0] = NULL;
60 Guid = NULL;
61 FileHandle = NULL;
62
63 //
64 // If the current Fv has been scanned, directly get its cachable record.
65 //
66 if (Private->Fv[Private->CurrentPeimFvCount].ScanFv) {
67 CopyMem (Private->CurrentFvFileHandles, Private->Fv[Private->CurrentPeimFvCount].FvFileHandles, sizeof (Private->CurrentFvFileHandles));
68 return;
69 }
70
71 //
72 // Go ahead to scan this Fv, and cache FileHandles within it.
73 //
74 for (PeimCount = 0; PeimCount < FixedPcdGet32 (PcdPeiCoreMaxPeimPerFv); PeimCount++) {
75 Status = PeiFindFileEx (
76 VolumeHandle,
77 NULL,
78 PEI_CORE_INTERNAL_FFS_FILE_DISPATCH_TYPE,
79 &FileHandle,
80 &AprioriFileHandle
81 );
82 if (Status != EFI_SUCCESS) {
83 break;
84 }
85
86 Private->CurrentFvFileHandles[PeimCount] = FileHandle;
87 }
88
89 Private->AprioriCount = 0;
90 if (AprioriFileHandle != NULL) {
91 //
92 // Read the Apriori file
93 //
94 Status = PeiServicesFfsFindSectionData (EFI_SECTION_RAW, AprioriFileHandle, (VOID **) &Apriori);
95 if (!EFI_ERROR (Status)) {
96 //
97 // Calculate the number of PEIMs in the A Priori list
98 //
99 Private->AprioriCount = *(UINT32 *)(((EFI_FFS_FILE_HEADER *)AprioriFileHandle)->Size) & 0x00FFFFFF;
100 Private->AprioriCount -= sizeof (EFI_FFS_FILE_HEADER) - sizeof (EFI_COMMON_SECTION_HEADER);
101 Private->AprioriCount /= sizeof (EFI_GUID);
102
103 SetMem (FileGuid, sizeof (FileGuid), 0);
104 for (Index = 0; Index < PeimCount; Index++) {
105 //
106 // Make an array of file name guids that matches the FileHandle array so we can convert
107 // quickly from file name to file handle
108 //
109 CopyMem (&FileGuid[Index], &((EFI_FFS_FILE_HEADER *)Private->CurrentFvFileHandles[Index])->Name,sizeof(EFI_GUID));
110 }
111
112 //
113 // Walk through FileGuid array to find out who is invalid PEIM guid in Apriori file.
114 // Add avalible PEIMs in Apriori file into TempFileHandles array at first.
115 //
116 Index2 = 0;
117 for (Index = 0; Index2 < Private->AprioriCount; Index++) {
118 while (Index2 < Private->AprioriCount) {
119 Guid = ScanGuid (FileGuid, PeimCount * sizeof (EFI_GUID), &Apriori[Index2++]);
120 if (Guid != NULL) {
121 break;
122 }
123 }
124 if (Guid == NULL) {
125 break;
126 }
127 PeimIndex = ((UINTN)Guid - (UINTN)&FileGuid[0])/sizeof (EFI_GUID);
128 TempFileHandles[Index] = Private->CurrentFvFileHandles[PeimIndex];
129
130 //
131 // Since we have copied the file handle we can remove it from this list.
132 //
133 Private->CurrentFvFileHandles[PeimIndex] = NULL;
134 }
135
136 //
137 // Update valid Aprioricount
138 //
139 Private->AprioriCount = Index;
140
141 //
142 // Add in any PEIMs not in the Apriori file
143 //
144 for (;Index < PeimCount; Index++) {
145 for (Index2 = 0; Index2 < PeimCount; Index2++) {
146 if (Private->CurrentFvFileHandles[Index2] != NULL) {
147 TempFileHandles[Index] = Private->CurrentFvFileHandles[Index2];
148 Private->CurrentFvFileHandles[Index2] = NULL;
149 break;
150 }
151 }
152 }
153 //
154 //Index the end of array contains re-range Pei moudle.
155 //
156 TempFileHandles[Index] = NULL;
157
158 //
159 // Private->CurrentFvFileHandles is currently in PEIM in the FV order.
160 // We need to update it to start with files in the A Priori list and
161 // then the remaining files in PEIM order.
162 //
163 CopyMem (Private->CurrentFvFileHandles, TempFileHandles, sizeof (Private->CurrentFvFileHandles));
164 }
165 }
166 //
167 // Cache the current Fv File Handle. So that we don't have to scan the Fv again.
168 // Instead, we can retrieve the file handles within this Fv from cachable data.
169 //
170 Private->Fv[Private->CurrentPeimFvCount].ScanFv = TRUE;
171 CopyMem (Private->Fv[Private->CurrentPeimFvCount].FvFileHandles, Private->CurrentFvFileHandles, sizeof (Private->CurrentFvFileHandles));
172
173 }
174
175 /**
176 Shadow PeiCore module from flash to installed memory.
177
178 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
179 @param PrivateInMem PeiCore's private data structure
180
181 **/
182 VOID*
183 ShadowPeiCore(
184 EFI_PEI_SERVICES **PeiServices,
185 PEI_CORE_INSTANCE *PrivateInMem
186 )
187 {
188 EFI_PEI_FILE_HANDLE PeiCoreFileHandle;
189 EFI_PHYSICAL_ADDRESS EntryPoint;
190 EFI_STATUS Status;
191 UINT32 AuthenticationState;
192
193 PeiCoreFileHandle = NULL;
194
195 //
196 // Find the PEI Core in the BFV
197 //
198 Status = PeiFindFileEx (
199 (EFI_PEI_FV_HANDLE)PrivateInMem->Fv[0].FvHeader,
200 NULL,
201 EFI_FV_FILETYPE_PEI_CORE,
202 &PeiCoreFileHandle,
203 NULL
204 );
205 ASSERT_EFI_ERROR (Status);
206
207 //
208 // Shadow PEI Core into memory so it will run faster
209 //
210 Status = PeiLoadImage (
211 PeiServices,
212 *((EFI_PEI_FILE_HANDLE*)&PeiCoreFileHandle),
213 &EntryPoint,
214 &AuthenticationState
215 );
216 ASSERT_EFI_ERROR (Status);
217
218 return (VOID*) ((UINTN) EntryPoint + (UINTN) PeiCore - (UINTN) _ModuleEntryPoint);
219 }
220
221 /**
222 Conduct PEIM dispatch.
223
224 @param SecCoreData Points to a data structure containing information about the PEI core's operating
225 environment, such as the size and location of temporary RAM, the stack location and
226 the BFV location.
227 @param Private Pointer to the private data passed in from caller
228
229 @retval EFI_SUCCESS - Successfully dispatched PEIM.
230 @retval EFI_NOT_FOUND - The dispatch failed.
231
232 **/
233 VOID
234 PeiDispatcher (
235 IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,
236 IN PEI_CORE_INSTANCE *Private
237 )
238 {
239 EFI_STATUS Status;
240 UINT32 Index1;
241 UINT32 Index2;
242 EFI_PEI_SERVICES **PeiServices;
243 EFI_PEI_FV_HANDLE VolumeHandle;
244 EFI_PEI_FILE_HANDLE PeimFileHandle;
245 UINTN FvCount;
246 UINTN PeimCount;
247 UINT32 AuthenticationState;
248 EFI_PHYSICAL_ADDRESS EntryPoint;
249 EFI_PEIM_ENTRY_POINT2 PeimEntryPoint;
250 BOOLEAN PeimNeedingDispatch;
251 BOOLEAN PeimDispatchOnThisPass;
252 UINTN SaveCurrentPeimCount;
253 UINTN SaveCurrentFvCount;
254 EFI_PEI_FILE_HANDLE SaveCurrentFileHandle;
255 PEIM_FILE_HANDLE_EXTENDED_DATA ExtendedData;
256 EFI_PHYSICAL_ADDRESS NewPermenentMemoryBase;
257 TEMPORARY_RAM_SUPPORT_PPI *TemporaryRamSupportPpi;
258 EFI_HOB_HANDOFF_INFO_TABLE *OldHandOffTable;
259 EFI_HOB_HANDOFF_INFO_TABLE *NewHandOffTable;
260 INTN StackOffset;
261 INTN HeapOffset;
262 PEI_CORE_INSTANCE *PrivateInMem;
263 UINT64 NewPeiStackSize;
264 UINT64 OldPeiStackSize;
265 UINT64 StackGap;
266 EFI_FV_FILE_INFO FvFileInfo;
267 UINTN OldCheckingTop;
268 UINTN OldCheckingBottom;
269
270
271 PeiServices = &Private->PS;
272 PeimEntryPoint = NULL;
273 PeimFileHandle = NULL;
274 EntryPoint = 0;
275
276 if ((Private->PeiMemoryInstalled) && (Private->HobList.HandoffInformationTable->BootMode != BOOT_ON_S3_RESUME)) {
277 //
278 // Once real memory is available, shadow the RegisterForShadow modules. And meanwhile
279 // update the modules' status from PEIM_STATE_REGISITER_FOR_SHADOW to PEIM_STATE_DONE.
280 //
281 SaveCurrentPeimCount = Private->CurrentPeimCount;
282 SaveCurrentFvCount = Private->CurrentPeimFvCount;
283 SaveCurrentFileHandle = Private->CurrentFileHandle;
284
285 for (Index1 = 0; Index1 <= SaveCurrentFvCount; Index1++) {
286 for (Index2 = 0; (Index2 < FixedPcdGet32 (PcdPeiCoreMaxPeimPerFv)) && (Private->Fv[Index1].FvFileHandles[Index2] != NULL); Index2++) {
287 if (Private->Fv[Index1].PeimState[Index2] == PEIM_STATE_REGISITER_FOR_SHADOW) {
288 PeimFileHandle = Private->Fv[Index1].FvFileHandles[Index2];
289 Status = PeiLoadImage (
290 &Private->PS,
291 PeimFileHandle,
292 &EntryPoint,
293 &AuthenticationState
294 );
295 if (Status == EFI_SUCCESS) {
296 //
297 // PEIM_STATE_REGISITER_FOR_SHADOW move to PEIM_STATE_DONE
298 //
299 Private->Fv[Index1].PeimState[Index2]++;
300 Private->CurrentFileHandle = PeimFileHandle;
301 Private->CurrentPeimFvCount = Index1;
302 Private->CurrentPeimCount = Index2;
303 //
304 // Call the PEIM entry point
305 //
306 PeimEntryPoint = (EFI_PEIM_ENTRY_POINT2)(UINTN)EntryPoint;
307
308 PERF_START (0, "PEIM", NULL, 0);
309 PeimEntryPoint(PeimFileHandle, (const EFI_PEI_SERVICES **) &Private->PS);
310 PERF_END (0, "PEIM", NULL, 0);
311 }
312
313 //
314 // Process the Notify list and dispatch any notifies for
315 // newly installed PPIs.
316 //
317 ProcessNotifyList (Private);
318 }
319 }
320 }
321 Private->CurrentFileHandle = SaveCurrentFileHandle;
322 Private->CurrentPeimFvCount = SaveCurrentFvCount;
323 Private->CurrentPeimCount = SaveCurrentPeimCount;
324 }
325
326 //
327 // This is the main dispatch loop. It will search known FVs for PEIMs and
328 // attempt to dispatch them. If any PEIM gets dispatched through a single
329 // pass of the dispatcher, it will start over from the Bfv again to see
330 // if any new PEIMs dependencies got satisfied. With a well ordered
331 // FV where PEIMs are found in the order their dependencies are also
332 // satisfied, this dipatcher should run only once.
333 //
334 do {
335 PeimNeedingDispatch = FALSE;
336 PeimDispatchOnThisPass = FALSE;
337
338 for (FvCount = Private->CurrentPeimFvCount; FvCount < Private->FvCount; FvCount++) {
339 Private->CurrentPeimFvCount = FvCount;
340 VolumeHandle = Private->Fv[FvCount].FvHeader;
341
342 if (Private->CurrentPeimCount == 0) {
343 //
344 // When going through each FV, at first, search Apriori file to
345 // reorder all PEIMs to ensure the PEIMs in Apriori file to get
346 // dispatch at first.
347 //
348 DiscoverPeimsAndOrderWithApriori (Private, VolumeHandle);
349 }
350
351 //
352 // Start to dispatch all modules within the current Fv.
353 //
354 for (PeimCount = Private->CurrentPeimCount;
355 (PeimCount < FixedPcdGet32 (PcdPeiCoreMaxPeimPerFv)) && (Private->CurrentFvFileHandles[PeimCount] != NULL);
356 PeimCount++) {
357 Private->CurrentPeimCount = PeimCount;
358 PeimFileHandle = Private->CurrentFileHandle = Private->CurrentFvFileHandles[PeimCount];
359
360 if (Private->Fv[FvCount].PeimState[PeimCount] == PEIM_STATE_NOT_DISPATCHED) {
361 if (!DepexSatisfied (Private, PeimFileHandle, PeimCount)) {
362 PeimNeedingDispatch = TRUE;
363 } else {
364 Status = PeiFfsGetFileInfo (PeimFileHandle, &FvFileInfo);
365 ASSERT_EFI_ERROR (Status);
366 if (FvFileInfo.FileType == EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE) {
367 //
368 // For Fv type file, Produce new FV PPI and FV hob
369 //
370 Status = ProcessFvFile (PeiServices, PeimFileHandle, &AuthenticationState);
371 } else {
372 //
373 // For PEIM driver, Load its entry point
374 //
375 Status = PeiLoadImage (
376 PeiServices,
377 PeimFileHandle,
378 &EntryPoint,
379 &AuthenticationState
380 );
381 }
382
383 if ((Status == EFI_SUCCESS)) {
384 //
385 // The PEIM has its dependencies satisfied, and its entry point
386 // has been found, so invoke it.
387 //
388 PERF_START (0, "PEIM", NULL, 0);
389
390 ExtendedData.Handle = (EFI_HANDLE)PeimFileHandle;
391
392 REPORT_STATUS_CODE_WITH_EXTENDED_DATA (
393 EFI_PROGRESS_CODE,
394 FixedPcdGet32(PcdStatusCodeValuePeimDispatch),
395 (VOID *)(&ExtendedData),
396 sizeof (ExtendedData)
397 );
398
399 Status = VerifyPeim (Private, VolumeHandle, PeimFileHandle);
400 if (Status != EFI_SECURITY_VIOLATION && (AuthenticationState == 0)) {
401 //
402 // PEIM_STATE_NOT_DISPATCHED move to PEIM_STATE_DISPATCHED
403 //
404 Private->Fv[FvCount].PeimState[PeimCount]++;
405
406 if (FvFileInfo.FileType != EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE) {
407 //
408 // Call the PEIM entry point for PEIM driver
409 //
410 PeimEntryPoint = (EFI_PEIM_ENTRY_POINT2)(UINTN)EntryPoint;
411 PeimEntryPoint (PeimFileHandle, (const EFI_PEI_SERVICES **) PeiServices);
412 }
413
414 PeimDispatchOnThisPass = TRUE;
415 }
416
417 REPORT_STATUS_CODE_WITH_EXTENDED_DATA (
418 EFI_PROGRESS_CODE,
419 FixedPcdGet32(PcdStatusCodeValuePeimDispatch),
420 (VOID *)(&ExtendedData),
421 sizeof (ExtendedData)
422 );
423 PERF_END (0, "PEIM", NULL, 0);
424
425 }
426
427 if (Private->SwitchStackSignal) {
428 //
429 // Before switch stack from CAR to permenent memory, caculate the heap and stack
430 // usage in temporary memory for debuging.
431 //
432 DEBUG_CODE_BEGIN ();
433 UINT32 *StackPointer;
434
435 for (StackPointer = (UINT32*)SecCoreData->StackBase;
436 (StackPointer < (UINT32*)((UINTN)SecCoreData->StackBase + SecCoreData->StackSize)) \
437 && (*StackPointer == INIT_CAR_VALUE);
438 StackPointer ++);
439
440 DEBUG ((EFI_D_INFO, "Total Cache as RAM: %d bytes.\n", SecCoreData->TemporaryRamSize));
441 DEBUG ((EFI_D_INFO, " CAR stack ever used: %d bytes.\n",
442 (SecCoreData->StackSize - ((UINTN) StackPointer - (UINTN)SecCoreData->StackBase))
443 ));
444 DEBUG ((EFI_D_INFO, " CAR heap used: %d bytes.\n",
445 ((UINTN) Private->HobList.HandoffInformationTable->EfiFreeMemoryBottom -
446 (UINTN) Private->HobList.Raw)
447 ));
448 DEBUG_CODE_END ();
449
450 //
451 // Reserve the size of new stack at bottom of physical memory
452 //
453 OldPeiStackSize = Private->StackSize;
454 NewPeiStackSize = (RShiftU64 (Private->PhysicalMemoryLength, 1) + EFI_PAGE_MASK) & ~EFI_PAGE_MASK;
455 if (FixedPcdGet32(PcdPeiCoreMaxPeiStackSize) > (UINT32) NewPeiStackSize) {
456 Private->StackSize = NewPeiStackSize;
457 } else {
458 Private->StackSize = FixedPcdGet32(PcdPeiCoreMaxPeiStackSize);
459 }
460
461 //
462 // In theory, the size of new stack in permenent memory should large than
463 // size of old stack in temporary memory.
464 // But if new stack is smaller than the size of old stack, we also reserve
465 // the size of old stack at bottom of permenent memory.
466 //
467 StackGap = 0;
468 if (Private->StackSize > OldPeiStackSize) {
469 StackGap = Private->StackSize - OldPeiStackSize;
470 }
471
472 //
473 // Update HandOffHob for new installed permenent memory
474 //
475 OldHandOffTable = Private->HobList.HandoffInformationTable;
476 OldCheckingBottom = (UINTN)(SecCoreData->TemporaryRamBase);
477 OldCheckingTop = (UINTN)(OldCheckingBottom + SecCoreData->TemporaryRamSize);
478
479 //
480 // The whole temporary memory will be migrated to physical memory.
481 // CAUTION: The new base is computed accounding to gap of new stack.
482 //
483 NewPermenentMemoryBase = Private->PhysicalMemoryBegin + StackGap;
484
485 //
486 // Caculate stack offset and heap offset between CAR and new permement
487 // memory seperately.
488 //
489 StackOffset = (UINTN) NewPermenentMemoryBase - (UINTN) SecCoreData->StackBase;
490 HeapOffset = (INTN) ((UINTN) Private->PhysicalMemoryBegin + Private->StackSize - \
491 (UINTN) SecCoreData->PeiTemporaryRamBase);
492 DEBUG ((EFI_D_INFO, "Heap Offset = 0x%X Stack Offset = 0x%X\n", HeapOffset, StackOffset));
493
494 //
495 // Caculate new HandOffTable and PrivateData address in permenet memory's stack
496 //
497 NewHandOffTable = (EFI_HOB_HANDOFF_INFO_TABLE *)((UINTN)OldHandOffTable + HeapOffset);
498 PrivateInMem = (PEI_CORE_INSTANCE *)((UINTN) (VOID*) Private + StackOffset);
499
500 //
501 // TemporaryRamSupportPpi is produced by platform's SEC
502 //
503 Status = PeiLocatePpi (
504 (CONST EFI_PEI_SERVICES **) PeiServices,
505 &gEfiTemporaryRamSupportPpiGuid,
506 0,
507 NULL,
508 (VOID**)&TemporaryRamSupportPpi
509 );
510
511
512 if (!EFI_ERROR (Status)) {
513 //
514 // Temporary Ram support Ppi is provided by platform, it will copy
515 // temporary memory to permenent memory and do stack switching.
516 // After invoken temporary Ram support, following code's stack is in
517 // memory but not in CAR.
518 //
519 TemporaryRamSupportPpi->TemporaryRamMigration (
520 (CONST EFI_PEI_SERVICES **) PeiServices,
521 (EFI_PHYSICAL_ADDRESS)(UINTN) SecCoreData->TemporaryRamBase,
522 (EFI_PHYSICAL_ADDRESS)(UINTN) NewPermenentMemoryBase,
523 SecCoreData->TemporaryRamSize
524 );
525
526 } else {
527 //
528 // In IA32/x64/Itanium architecture, we need platform provide
529 // TEMPORAY_RAM_MIGRATION_PPI.
530 //
531 ASSERT (FALSE);
532 }
533
534
535 //
536 //
537 // Fixup the PeiCore's private data
538 //
539 PrivateInMem->PS = &PrivateInMem->ServiceTableShadow;
540 PrivateInMem->CpuIo = &PrivateInMem->ServiceTableShadow.CpuIo;
541 PrivateInMem->HobList.Raw = (VOID*) ((UINTN) PrivateInMem->HobList.Raw + HeapOffset);
542 PrivateInMem->StackBase = (EFI_PHYSICAL_ADDRESS)(((UINTN)PrivateInMem->PhysicalMemoryBegin + EFI_PAGE_MASK) & ~EFI_PAGE_MASK);
543
544 PeiServices = &PrivateInMem->PS;
545
546 //
547 // Fixup for PeiService's address
548 //
549 SetPeiServicesTablePointer(PeiServices);
550
551 //
552 // Update HandOffHob for new installed permenent memory
553 //
554 NewHandOffTable->EfiEndOfHobList =
555 (EFI_PHYSICAL_ADDRESS)((UINTN) NewHandOffTable->EfiEndOfHobList + HeapOffset);
556 NewHandOffTable->EfiMemoryTop = PrivateInMem->PhysicalMemoryBegin +
557 PrivateInMem->PhysicalMemoryLength;
558 NewHandOffTable->EfiMemoryBottom = PrivateInMem->PhysicalMemoryBegin;
559 NewHandOffTable->EfiFreeMemoryTop = PrivateInMem->FreePhysicalMemoryTop;
560 NewHandOffTable->EfiFreeMemoryBottom = NewHandOffTable->EfiEndOfHobList +
561 sizeof (EFI_HOB_GENERIC_HEADER);
562
563 //
564 // We need convert the PPI desciptor's pointer
565 //
566 ConvertPpiPointers (PrivateInMem,
567 OldCheckingBottom,
568 OldCheckingTop,
569 HeapOffset
570 );
571
572 DEBUG ((EFI_D_INFO, "Stack Hob: BaseAddress=0x%X Length=0x%X\n",
573 (UINTN)PrivateInMem->StackBase,
574 PrivateInMem->StackSize));
575 BuildStackHob (PrivateInMem->StackBase, PrivateInMem->StackSize);
576
577 //
578 // After the whole temporary memory is migrated, then we can allocate page in
579 // permenent memory.
580 //
581 PrivateInMem->PeiMemoryInstalled = TRUE;
582
583 //
584 // Restart scan of all PEIMs on next pass
585 //
586 PrivateInMem->CurrentPeimCount = 0;
587
588 //
589 // Shadow PEI Core. When permanent memory is avaiable, shadow
590 // PEI Core and PEIMs to get high performance.
591 //
592 PrivateInMem->ShadowedPeiCore = ShadowPeiCore (
593 PeiServices,
594 PrivateInMem
595 );
596 //
597 // Process the Notify list and dispatch any notifies for
598 // newly installed PPIs.
599 //
600 ProcessNotifyList (PrivateInMem);
601
602 //
603 // Entry PEI Phase 2
604 //
605 PeiCore (SecCoreData, NULL, PrivateInMem);
606
607 //
608 // Code should not come here
609 //
610 ASSERT_EFI_ERROR(FALSE);
611 }
612
613 //
614 // Process the Notify list and dispatch any notifies for
615 // newly installed PPIs.
616 //
617 ProcessNotifyList (Private);
618
619 if ((Private->PeiMemoryInstalled) && (Private->Fv[FvCount].PeimState[PeimCount] == PEIM_STATE_REGISITER_FOR_SHADOW) && \
620 (Private->HobList.HandoffInformationTable->BootMode != BOOT_ON_S3_RESUME)) {
621 //
622 // If memory is availble we shadow images by default for performance reasons.
623 // We call the entry point a 2nd time so the module knows it's shadowed.
624 //
625 //PERF_START (PeiServices, L"PEIM", PeimFileHandle, 0);
626 PeimEntryPoint (PeimFileHandle, (const EFI_PEI_SERVICES **) PeiServices);
627 //PERF_END (PeiServices, L"PEIM", PeimFileHandle, 0);
628
629 //
630 // PEIM_STATE_REGISITER_FOR_SHADOW move to PEIM_STATE_DONE
631 //
632 Private->Fv[FvCount].PeimState[PeimCount]++;
633
634 //
635 // Process the Notify list and dispatch any notifies for
636 // newly installed PPIs.
637 //
638 ProcessNotifyList (Private);
639 }
640 }
641 }
642 }
643
644 //
645 // We set to NULL here to optimize the 2nd entry to this routine after
646 // memory is found. This reprevents rescanning of the FV. We set to
647 // NULL here so we start at the begining of the next FV
648 //
649 Private->CurrentFileHandle = NULL;
650 Private->CurrentPeimCount = 0;
651 //
652 // Before walking through the next FV,Private->CurrentFvFileHandles[]should set to NULL
653 //
654 SetMem (Private->CurrentFvFileHandles, sizeof (Private->CurrentFvFileHandles), 0);
655 }
656
657 //
658 // Before making another pass, we should set Private->CurrentPeimFvCount =0 to go
659 // through all the FV.
660 //
661 Private->CurrentPeimFvCount = 0;
662
663 //
664 // PeimNeedingDispatch being TRUE means we found a PEIM that did not get
665 // dispatched. So we need to make another pass
666 //
667 // PeimDispatchOnThisPass being TRUE means we dispatched a PEIM on this
668 // pass. If we did not dispatch a PEIM there is no point in trying again
669 // as it will fail the next time too (nothing has changed).
670 //
671 } while (PeimNeedingDispatch && PeimDispatchOnThisPass);
672
673 }
674
675 /**
676 Initialize the Dispatcher's data members
677
678 @param PrivateData PeiCore's private data structure
679 @param OldCoreData Old data from SecCore
680 NULL if being run in non-permament memory mode.
681 @param SecCoreData Points to a data structure containing information about the PEI core's operating
682 environment, such as the size and location of temporary RAM, the stack location and
683 the BFV location.
684
685 @return None.
686
687 **/
688 VOID
689 InitializeDispatcherData (
690 IN PEI_CORE_INSTANCE *PrivateData,
691 IN PEI_CORE_INSTANCE *OldCoreData,
692 IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData
693 )
694 {
695 if (OldCoreData == NULL) {
696 PeiInitializeFv (PrivateData, SecCoreData);
697 }
698
699 return;
700 }
701
702 /**
703 This routine parses the Dependency Expression, if available, and
704 decides if the module can be executed.
705
706
707 @param Private PeiCore's private data structure
708 @param FileHandle PEIM's file handle
709 @param PeimCount Peim count in all dispatched PEIMs.
710
711 @retval TRUE Can be dispatched
712 @retval FALSE Cannot be dispatched
713
714 **/
715 BOOLEAN
716 DepexSatisfied (
717 IN PEI_CORE_INSTANCE *Private,
718 IN EFI_PEI_FILE_HANDLE FileHandle,
719 IN UINTN PeimCount
720 )
721 {
722 EFI_STATUS Status;
723 VOID *DepexData;
724
725 if (PeimCount < Private->AprioriCount) {
726 //
727 // If its in the A priori file then we set Depex to TRUE
728 //
729 return TRUE;
730 }
731
732 //
733 // Depex section not in the encapsulated section.
734 //
735 Status = PeiServicesFfsFindSectionData (
736 EFI_SECTION_PEI_DEPEX,
737 FileHandle,
738 (VOID **)&DepexData
739 );
740
741 if (EFI_ERROR (Status)) {
742 //
743 // If there is no DEPEX, assume the module can be executed
744 //
745 return TRUE;
746 }
747
748 //
749 // Evaluate a given DEPEX
750 //
751 return PeimDispatchReadiness (&Private->PS, DepexData);
752 }
753
754 /**
755 This routine enable a PEIM to register itself to shadow when PEI Foundation
756 discovery permanent memory.
757
758 @param FileHandle File handle of a PEIM.
759
760 @retval EFI_NOT_FOUND The file handle doesn't point to PEIM itself.
761 @retval EFI_ALREADY_STARTED Indicate that the PEIM has been registered itself.
762 @retval EFI_SUCCESS Successfully to register itself.
763
764 **/
765 EFI_STATUS
766 EFIAPI
767 PeiRegisterForShadow (
768 IN EFI_PEI_FILE_HANDLE FileHandle
769 )
770 {
771 PEI_CORE_INSTANCE *Private;
772 Private = PEI_CORE_INSTANCE_FROM_PS_THIS (GetPeiServicesTablePointer ());
773
774 if (Private->CurrentFileHandle != FileHandle) {
775 //
776 // The FileHandle must be for the current PEIM
777 //
778 return EFI_NOT_FOUND;
779 }
780
781 if (Private->Fv[Private->CurrentPeimFvCount].PeimState[Private->CurrentPeimCount] >= PEIM_STATE_REGISITER_FOR_SHADOW) {
782 //
783 // If the PEIM has already entered the PEIM_STATE_REGISTER_FOR_SHADOW or PEIM_STATE_DONE then it's already been started
784 //
785 return EFI_ALREADY_STARTED;
786 }
787
788 Private->Fv[Private->CurrentPeimFvCount].PeimState[Private->CurrentPeimCount] = PEIM_STATE_REGISITER_FOR_SHADOW;
789
790 return EFI_SUCCESS;
791 }
792
793 /**
794 Get Fv image from the FV type file, then install FV INFO ppi, Build FV hob.
795
796 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
797 @param FvFileHandle File handle of a Fv type file.
798 @param AuthenticationState Pointer to attestation authentication state of image.
799
800
801 @retval EFI_NOT_FOUND FV image can't be found.
802 @retval EFI_SUCCESS Successfully to process it.
803
804 **/
805 EFI_STATUS
806 ProcessFvFile (
807 IN EFI_PEI_SERVICES **PeiServices,
808 IN EFI_PEI_FILE_HANDLE FvFileHandle,
809 OUT UINT32 *AuthenticationState
810 )
811 {
812 EFI_STATUS Status;
813 EFI_PEI_FV_HANDLE FvImageHandle;
814 EFI_FV_INFO FvImageInfo;
815 UINT32 FvAlignment;
816 VOID *FvBuffer;
817 EFI_PEI_HOB_POINTERS HobFv2;
818
819 FvBuffer = NULL;
820 *AuthenticationState = 0;
821
822 //
823 // Check if this EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE file has already
824 // been extracted.
825 //
826 HobFv2.Raw = GetHobList ();
827 while ((HobFv2.Raw = GetNextHob (EFI_HOB_TYPE_FV2, HobFv2.Raw)) != NULL) {
828 if (CompareGuid (&(((EFI_FFS_FILE_HEADER *)FvFileHandle)->Name), &HobFv2.FirmwareVolume2->FileName)) {
829 //
830 // this FILE has been dispatched, it will not be dispatched again.
831 //
832 return EFI_SUCCESS;
833 }
834 HobFv2.Raw = GET_NEXT_HOB (HobFv2);
835 }
836
837 //
838 // Find FvImage in FvFile
839 //
840 Status = PeiFfsFindSectionData (
841 (CONST EFI_PEI_SERVICES **) PeiServices,
842 EFI_SECTION_FIRMWARE_VOLUME_IMAGE,
843 FvFileHandle,
844 (VOID **)&FvImageHandle
845 );
846
847 if (EFI_ERROR (Status)) {
848 return Status;
849 }
850 //
851 // Collect FvImage Info.
852 //
853 Status = PeiFfsGetVolumeInfo (FvImageHandle, &FvImageInfo);
854 ASSERT_EFI_ERROR (Status);
855 //
856 // FvAlignment must be more than 8 bytes required by FvHeader structure.
857 //
858 FvAlignment = 1 << ((FvImageInfo.FvAttributes & EFI_FVB2_ALIGNMENT) >> 16);
859 if (FvAlignment < 8) {
860 FvAlignment = 8;
861 }
862 //
863 // Check FvImage
864 //
865 if ((UINTN) FvImageInfo.FvStart % FvAlignment != 0) {
866 FvBuffer = AllocateAlignedPages (EFI_SIZE_TO_PAGES ((UINT32) FvImageInfo.FvSize), FvAlignment);
867 if (FvBuffer == NULL) {
868 return EFI_OUT_OF_RESOURCES;
869 }
870 CopyMem (FvBuffer, FvImageInfo.FvStart, (UINTN) FvImageInfo.FvSize);
871 //
872 // Update FvImageInfo after reload FvImage to new aligned memory
873 //
874 PeiFfsGetVolumeInfo ((EFI_PEI_FV_HANDLE) FvBuffer, &FvImageInfo);
875 }
876
877 //
878 // Install FvPpi and Build FvHob
879 //
880 PiLibInstallFvInfoPpi (
881 NULL,
882 FvImageInfo.FvStart,
883 (UINT32) FvImageInfo.FvSize,
884 &(FvImageInfo.FvName),
885 &(((EFI_FFS_FILE_HEADER*)FvFileHandle)->Name)
886 );
887
888 //
889 // Inform HOB consumer phase, i.e. DXE core, the existance of this FV
890 //
891 BuildFvHob (
892 (EFI_PHYSICAL_ADDRESS) (UINTN) FvImageInfo.FvStart,
893 FvImageInfo.FvSize
894 );
895 //
896 // Makes the encapsulated volume show up in DXE phase to skip processing of
897 // encapsulated file again.
898 //
899 BuildFv2Hob (
900 (EFI_PHYSICAL_ADDRESS) (UINTN) FvImageInfo.FvStart,
901 FvImageInfo.FvSize,
902 &FvImageInfo.FvName,
903 &(((EFI_FFS_FILE_HEADER *)FvFileHandle)->Name)
904 );
905
906 return EFI_SUCCESS;
907 }
EFI Development Kit II mirror for PVE