2 Pei Core Main Entry Point
4 Copyright (c) 2006 - 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 EFI_PEI_PPI_DESCRIPTOR mMemoryDiscoveredPpi
= {
18 (EFI_PEI_PPI_DESCRIPTOR_PPI
| EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST
),
19 &gEfiPeiMemoryDiscoveredPpiGuid
,
24 /// Pei service instance
26 EFI_PEI_SERVICES gPs
= {
28 PEI_SERVICES_SIGNATURE
,
29 PEI_SERVICES_REVISION
,
30 sizeof (EFI_PEI_SERVICES
),
47 PeiFfsFindSectionData
,
52 (EFI_PEI_COPY_MEM
)CopyMem
,
53 (EFI_PEI_SET_MEM
)SetMem
,
59 &gPeiDefaultPciCfg2Ppi
,
65 PeiFfsFindSectionData3
,
71 Shadow PeiCore module from flash to installed memory.
73 @param PrivateData PeiCore's private data structure
75 @return PeiCore function address after shadowing.
77 PEICORE_FUNCTION_POINTER
79 IN PEI_CORE_INSTANCE
*PrivateData
82 EFI_PEI_FILE_HANDLE PeiCoreFileHandle
;
83 EFI_PHYSICAL_ADDRESS EntryPoint
;
85 UINT32 AuthenticationState
;
87 PeiCoreFileHandle
= NULL
;
90 // Find the PEI Core in the BFV
92 Status
= PrivateData
->Fv
[0].FvPpi
->FindFileByType (
93 PrivateData
->Fv
[0].FvPpi
,
94 EFI_FV_FILETYPE_PEI_CORE
,
95 PrivateData
->Fv
[0].FvHandle
,
98 ASSERT_EFI_ERROR (Status
);
101 // Shadow PEI Core into memory so it will run faster
103 Status
= PeiLoadImage (
104 GetPeiServicesTablePointer (),
105 *((EFI_PEI_FILE_HANDLE
*)&PeiCoreFileHandle
),
106 PEIM_STATE_REGISITER_FOR_SHADOW
,
110 ASSERT_EFI_ERROR (Status
);
113 // Compute the PeiCore's function address after shaowed PeiCore.
114 // _ModuleEntryPoint is PeiCore main function entry
116 return (PEICORE_FUNCTION_POINTER
)((UINTN
) EntryPoint
+ (UINTN
) PeiCore
- (UINTN
) _ModuleEntryPoint
);
120 This routine is invoked by main entry of PeiMain module during transition
121 from SEC to PEI. After switching stack in the PEI core, it will restart
122 with the old core data.
124 @param SecCoreDataPtr Points to a data structure containing information about the PEI core's operating
125 environment, such as the size and location of temporary RAM, the stack location and
127 @param PpiList Points to a list of one or more PPI descriptors to be installed initially by the PEI core.
128 An empty PPI list consists of a single descriptor with the end-tag
129 EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. As part of its initialization
130 phase, the PEI Foundation will add these SEC-hosted PPIs to its PPI database such
131 that both the PEI Foundation and any modules can leverage the associated service
132 calls and/or code in these early PPIs
133 @param Data Pointer to old core data that is used to initialize the
135 If NULL, it is first PeiCore entering.
142 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreDataPtr
,
143 IN CONST EFI_PEI_PPI_DESCRIPTOR
*PpiList
,
147 PEI_CORE_INSTANCE PrivateData
;
148 EFI_SEC_PEI_HAND_OFF
*SecCoreData
;
149 EFI_SEC_PEI_HAND_OFF NewSecCoreData
;
151 PEI_CORE_TEMP_POINTERS TempPtr
;
152 PEI_CORE_INSTANCE
*OldCoreData
;
153 EFI_PEI_CPU_IO_PPI
*CpuIo
;
154 EFI_PEI_PCI_CFG2_PPI
*PciCfg
;
155 EFI_HOB_HANDOFF_INFO_TABLE
*HandoffInformationTable
;
156 EFI_PEI_TEMPORARY_RAM_DONE_PPI
*TemporaryRamDonePpi
;
160 // Retrieve context passed into PEI Core
162 OldCoreData
= (PEI_CORE_INSTANCE
*) Data
;
163 SecCoreData
= (EFI_SEC_PEI_HAND_OFF
*) SecCoreDataPtr
;
166 // Perform PEI Core phase specific actions.
168 if (OldCoreData
== NULL
) {
170 // If OldCoreData is NULL, means current is the first entry into the PEI Core before memory is available.
172 ZeroMem (&PrivateData
, sizeof (PEI_CORE_INSTANCE
));
173 PrivateData
.Signature
= PEI_CORE_HANDLE_SIGNATURE
;
174 CopyMem (&PrivateData
.ServiceTableShadow
, &gPs
, sizeof (gPs
));
177 // Memory is available to the PEI Core. See if the PEI Core has been shadowed to memory yet.
179 if (OldCoreData
->ShadowedPeiCore
== NULL
) {
181 // Fixup the PeiCore's private data
183 OldCoreData
->Ps
= &OldCoreData
->ServiceTableShadow
;
184 OldCoreData
->CpuIo
= &OldCoreData
->ServiceTableShadow
.CpuIo
;
185 if (OldCoreData
->HeapOffsetPositive
) {
186 OldCoreData
->HobList
.Raw
= (VOID
*)(OldCoreData
->HobList
.Raw
+ OldCoreData
->HeapOffset
);
187 OldCoreData
->UnknownFvInfo
= (PEI_CORE_UNKNOW_FORMAT_FV_INFO
*) ((UINT8
*) OldCoreData
->UnknownFvInfo
+ OldCoreData
->HeapOffset
);
188 OldCoreData
->CurrentFvFileHandles
= (EFI_PEI_FILE_HANDLE
*) ((UINT8
*) OldCoreData
->CurrentFvFileHandles
+ OldCoreData
->HeapOffset
);
189 OldCoreData
->PpiData
.PpiListPtrs
= (PEI_PPI_LIST_POINTERS
*) ((UINT8
*) OldCoreData
->PpiData
.PpiListPtrs
+ OldCoreData
->HeapOffset
);
190 OldCoreData
->Fv
= (PEI_CORE_FV_HANDLE
*) ((UINT8
*) OldCoreData
->Fv
+ OldCoreData
->HeapOffset
);
191 for (Index
= 0; Index
< PcdGet32 (PcdPeiCoreMaxFvSupported
); Index
++) {
192 OldCoreData
->Fv
[Index
].PeimState
= (UINT8
*) OldCoreData
->Fv
[Index
].PeimState
+ OldCoreData
->HeapOffset
;
193 OldCoreData
->Fv
[Index
].FvFileHandles
= (EFI_PEI_FILE_HANDLE
*) ((UINT8
*) OldCoreData
->Fv
[Index
].FvFileHandles
+ OldCoreData
->HeapOffset
);
195 OldCoreData
->FileGuid
= (EFI_GUID
*) ((UINT8
*) OldCoreData
->FileGuid
+ OldCoreData
->HeapOffset
);
196 OldCoreData
->FileHandles
= (EFI_PEI_FILE_HANDLE
*) ((UINT8
*) OldCoreData
->FileHandles
+ OldCoreData
->HeapOffset
);
198 OldCoreData
->HobList
.Raw
= (VOID
*)(OldCoreData
->HobList
.Raw
- OldCoreData
->HeapOffset
);
199 OldCoreData
->UnknownFvInfo
= (PEI_CORE_UNKNOW_FORMAT_FV_INFO
*) ((UINT8
*) OldCoreData
->UnknownFvInfo
- OldCoreData
->HeapOffset
);
200 OldCoreData
->CurrentFvFileHandles
= (EFI_PEI_FILE_HANDLE
*) ((UINT8
*) OldCoreData
->CurrentFvFileHandles
- OldCoreData
->HeapOffset
);
201 OldCoreData
->PpiData
.PpiListPtrs
= (PEI_PPI_LIST_POINTERS
*) ((UINT8
*) OldCoreData
->PpiData
.PpiListPtrs
- OldCoreData
->HeapOffset
);
202 OldCoreData
->Fv
= (PEI_CORE_FV_HANDLE
*) ((UINT8
*) OldCoreData
->Fv
- OldCoreData
->HeapOffset
);
203 for (Index
= 0; Index
< PcdGet32 (PcdPeiCoreMaxFvSupported
); Index
++) {
204 OldCoreData
->Fv
[Index
].PeimState
= (UINT8
*) OldCoreData
->Fv
[Index
].PeimState
- OldCoreData
->HeapOffset
;
205 OldCoreData
->Fv
[Index
].FvFileHandles
= (EFI_PEI_FILE_HANDLE
*) ((UINT8
*) OldCoreData
->Fv
[Index
].FvFileHandles
- OldCoreData
->HeapOffset
);
207 OldCoreData
->FileGuid
= (EFI_GUID
*) ((UINT8
*) OldCoreData
->FileGuid
- OldCoreData
->HeapOffset
);
208 OldCoreData
->FileHandles
= (EFI_PEI_FILE_HANDLE
*) ((UINT8
*) OldCoreData
->FileHandles
- OldCoreData
->HeapOffset
);
212 // Initialize libraries that the PEI Core is linked against
214 ProcessLibraryConstructorList (NULL
, (CONST EFI_PEI_SERVICES
**)&OldCoreData
->Ps
);
217 // Fixup for PeiService's address
219 SetPeiServicesTablePointer ((CONST EFI_PEI_SERVICES
**)&OldCoreData
->Ps
);
222 // Update HandOffHob for new installed permenent memory
224 HandoffInformationTable
= OldCoreData
->HobList
.HandoffInformationTable
;
225 if (OldCoreData
->HeapOffsetPositive
) {
226 HandoffInformationTable
->EfiEndOfHobList
= HandoffInformationTable
->EfiEndOfHobList
+ OldCoreData
->HeapOffset
;
228 HandoffInformationTable
->EfiEndOfHobList
= HandoffInformationTable
->EfiEndOfHobList
- OldCoreData
->HeapOffset
;
230 HandoffInformationTable
->EfiMemoryTop
= OldCoreData
->PhysicalMemoryBegin
+ OldCoreData
->PhysicalMemoryLength
;
231 HandoffInformationTable
->EfiMemoryBottom
= OldCoreData
->PhysicalMemoryBegin
;
232 HandoffInformationTable
->EfiFreeMemoryTop
= OldCoreData
->FreePhysicalMemoryTop
;
233 HandoffInformationTable
->EfiFreeMemoryBottom
= HandoffInformationTable
->EfiEndOfHobList
+ sizeof (EFI_HOB_GENERIC_HEADER
);
236 // We need convert the PPI descriptor's pointer
238 ConvertPpiPointers (SecCoreData
, OldCoreData
);
241 // After the whole temporary memory is migrated, then we can allocate page in
244 OldCoreData
->PeiMemoryInstalled
= TRUE
;
247 // Indicate that PeiCore reenter
249 OldCoreData
->PeimDispatcherReenter
= TRUE
;
251 if (PcdGet64(PcdLoadModuleAtFixAddressEnable
) != 0 && (OldCoreData
->HobList
.HandoffInformationTable
->BootMode
!= BOOT_ON_S3_RESUME
)) {
253 // if Loading Module at Fixed Address is enabled, allocate the PEI code memory range usage bit map array.
254 // Every bit in the array indicate the status of the corresponding memory page available or not
256 OldCoreData
->PeiCodeMemoryRangeUsageBitMap
= AllocateZeroPool (((PcdGet32(PcdLoadFixAddressPeiCodePageNumber
)>>6) + 1)*sizeof(UINT64
));
260 // Shadow PEI Core. When permanent memory is avaiable, shadow
261 // PEI Core and PEIMs to get high performance.
263 OldCoreData
->ShadowedPeiCore
= (PEICORE_FUNCTION_POINTER
) (UINTN
) PeiCore
;
264 if ((HandoffInformationTable
->BootMode
== BOOT_ON_S3_RESUME
&& PcdGetBool (PcdShadowPeimOnS3Boot
))
265 || (HandoffInformationTable
->BootMode
!= BOOT_ON_S3_RESUME
&& PcdGetBool (PcdShadowPeimOnBoot
))) {
266 OldCoreData
->ShadowedPeiCore
= ShadowPeiCore (OldCoreData
);
270 // PEI Core has now been shadowed to memory. Restart PEI Core in memory.
272 OldCoreData
->ShadowedPeiCore (SecCoreData
, PpiList
, OldCoreData
);
275 // Should never reach here.
284 // Memory is available to the PEI Core and the PEI Core has been shadowed to memory.
286 CopyMem (&NewSecCoreData
, SecCoreDataPtr
, sizeof (NewSecCoreData
));
287 SecCoreData
= &NewSecCoreData
;
289 CopyMem (&PrivateData
, OldCoreData
, sizeof (PrivateData
));
291 CpuIo
= (VOID
*)PrivateData
.ServiceTableShadow
.CpuIo
;
292 PciCfg
= (VOID
*)PrivateData
.ServiceTableShadow
.PciCfg
;
294 CopyMem (&PrivateData
.ServiceTableShadow
, &gPs
, sizeof (gPs
));
296 PrivateData
.ServiceTableShadow
.CpuIo
= CpuIo
;
297 PrivateData
.ServiceTableShadow
.PciCfg
= PciCfg
;
301 // Cache a pointer to the PEI Services Table that is either in temporary memory or permanent memory
303 PrivateData
.Ps
= &PrivateData
.ServiceTableShadow
;
306 // Initialize libraries that the PEI Core is linked against
308 ProcessLibraryConstructorList (NULL
, (CONST EFI_PEI_SERVICES
**)&PrivateData
.Ps
);
311 // Save PeiServicePointer so that it can be retrieved anywhere.
313 SetPeiServicesTablePointer ((CONST EFI_PEI_SERVICES
**)&PrivateData
.Ps
);
316 // Initialize PEI Core Services
318 InitializeMemoryServices (&PrivateData
, SecCoreData
, OldCoreData
);
319 if (OldCoreData
== NULL
) {
321 // Initialize PEI Core Private Data Buffer
323 PrivateData
.PpiData
.PpiListPtrs
= AllocateZeroPool (sizeof (PEI_PPI_LIST_POINTERS
) * PcdGet32 (PcdPeiCoreMaxPpiSupported
));
324 ASSERT (PrivateData
.PpiData
.PpiListPtrs
!= NULL
);
325 PrivateData
.Fv
= AllocateZeroPool (sizeof (PEI_CORE_FV_HANDLE
) * PcdGet32 (PcdPeiCoreMaxFvSupported
));
326 ASSERT (PrivateData
.Fv
!= NULL
);
327 PrivateData
.Fv
[0].PeimState
= AllocateZeroPool (sizeof (UINT8
) * PcdGet32 (PcdPeiCoreMaxPeimPerFv
) * PcdGet32 (PcdPeiCoreMaxFvSupported
));
328 ASSERT (PrivateData
.Fv
[0].PeimState
!= NULL
);
329 PrivateData
.Fv
[0].FvFileHandles
= AllocateZeroPool (sizeof (EFI_PEI_FILE_HANDLE
) * PcdGet32 (PcdPeiCoreMaxPeimPerFv
) * PcdGet32 (PcdPeiCoreMaxFvSupported
));
330 ASSERT (PrivateData
.Fv
[0].FvFileHandles
!= NULL
);
331 for (Index
= 1; Index
< PcdGet32 (PcdPeiCoreMaxFvSupported
); Index
++) {
332 PrivateData
.Fv
[Index
].PeimState
= PrivateData
.Fv
[Index
- 1].PeimState
+ PcdGet32 (PcdPeiCoreMaxPeimPerFv
);
333 PrivateData
.Fv
[Index
].FvFileHandles
= PrivateData
.Fv
[Index
- 1].FvFileHandles
+ PcdGet32 (PcdPeiCoreMaxPeimPerFv
);
335 PrivateData
.UnknownFvInfo
= AllocateZeroPool (sizeof (PEI_CORE_UNKNOW_FORMAT_FV_INFO
) * PcdGet32 (PcdPeiCoreMaxFvSupported
));
336 ASSERT (PrivateData
.UnknownFvInfo
!= NULL
);
337 PrivateData
.CurrentFvFileHandles
= AllocateZeroPool (sizeof (EFI_PEI_FILE_HANDLE
) * PcdGet32 (PcdPeiCoreMaxPeimPerFv
));
338 ASSERT (PrivateData
.CurrentFvFileHandles
!= NULL
);
339 PrivateData
.FileGuid
= AllocatePool (sizeof (EFI_GUID
) * PcdGet32 (PcdPeiCoreMaxPeimPerFv
));
340 ASSERT (PrivateData
.FileGuid
!= NULL
);
341 PrivateData
.FileHandles
= AllocatePool (sizeof (EFI_PEI_FILE_HANDLE
) * (PcdGet32 (PcdPeiCoreMaxPeimPerFv
) + 1));
342 ASSERT (PrivateData
.FileHandles
!= NULL
);
344 InitializePpiServices (&PrivateData
, OldCoreData
);
347 // Update performance measurements
349 if (OldCoreData
== NULL
) {
350 PERF_START (NULL
, "SEC", NULL
, 1);
351 PERF_END (NULL
, "SEC", NULL
, 0);
354 // If first pass, start performance measurement.
356 PERF_START (NULL
,"PEI", NULL
, 0);
357 PERF_START (NULL
,"PreMem", NULL
, 0);
360 PERF_END (NULL
,"PreMem", NULL
, 0);
361 PERF_START (NULL
,"PostMem", NULL
, 0);
365 // Complete PEI Core Service initialization
367 InitializeSecurityServices (&PrivateData
.Ps
, OldCoreData
);
368 InitializeDispatcherData (&PrivateData
, OldCoreData
, SecCoreData
);
369 InitializeImageServices (&PrivateData
, OldCoreData
);
372 // Perform PEI Core Phase specific actions
374 if (OldCoreData
== NULL
) {
376 // Report Status Code EFI_SW_PC_INIT
380 (EFI_SOFTWARE_PEI_CORE
| EFI_SW_PC_INIT
)
384 // If SEC provided any PPI services to PEI, install them.
386 if (PpiList
!= NULL
) {
387 Status
= PeiServicesInstallPpi (PpiList
);
388 ASSERT_EFI_ERROR (Status
);
392 // Try to locate Temporary RAM Done Ppi.
394 Status
= PeiServicesLocatePpi (
395 &gEfiTemporaryRamDonePpiGuid
,
398 (VOID
**)&TemporaryRamDonePpi
400 if (!EFI_ERROR (Status
)) {
402 // Disable the use of Temporary RAM after the transition from Temporary RAM to Permanent RAM is complete.
404 TemporaryRamDonePpi
->TemporaryRamDone ();
408 // Alert any listeners that there is permanent memory available
410 PERF_START (NULL
,"DisMem", NULL
, 0);
411 Status
= PeiServicesInstallPpi (&mMemoryDiscoveredPpi
);
414 // Process the Notify list and dispatch any notifies for the Memory Discovered PPI
416 ProcessNotifyList (&PrivateData
);
418 PERF_END (NULL
,"DisMem", NULL
, 0);
422 // Call PEIM dispatcher
424 PeiDispatcher (SecCoreData
, &PrivateData
);
426 if (PrivateData
.HobList
.HandoffInformationTable
->BootMode
!= BOOT_ON_S3_RESUME
) {
428 // Check if InstallPeiMemory service was called on non-S3 resume boot path.
430 ASSERT(PrivateData
.PeiMemoryInstalled
== TRUE
);
434 // Measure PEI Core execution time.
436 PERF_END (NULL
, "PostMem", NULL
, 0);
439 // Lookup DXE IPL PPI
441 Status
= PeiServicesLocatePpi (
445 (VOID
**)&TempPtr
.DxeIpl
447 ASSERT_EFI_ERROR (Status
);
449 if (EFI_ERROR (Status
)) {
451 // Report status code to indicate DXE IPL PPI could not be found.
454 EFI_ERROR_CODE
| EFI_ERROR_MAJOR
,
455 (EFI_SOFTWARE_PEI_CORE
| EFI_SW_PEI_CORE_EC_DXEIPL_NOT_FOUND
)
461 // Enter DxeIpl to load Dxe core.
463 DEBUG ((EFI_D_INFO
, "DXE IPL Entry\n"));
464 Status
= TempPtr
.DxeIpl
->Entry (
470 // Should never reach here.
472 ASSERT_EFI_ERROR (Status
);