2 Pei Core Main Entry Point
4 Copyright (c) 2006 - 2014, 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
,
70 Shadow PeiCore module from flash to installed memory.
72 @param PrivateData PeiCore's private data structure
74 @return PeiCore function address after shadowing.
76 PEICORE_FUNCTION_POINTER
78 IN PEI_CORE_INSTANCE
*PrivateData
81 EFI_PEI_FILE_HANDLE PeiCoreFileHandle
;
82 EFI_PHYSICAL_ADDRESS EntryPoint
;
84 UINT32 AuthenticationState
;
86 PeiCoreFileHandle
= NULL
;
89 // Find the PEI Core in the BFV
91 Status
= PrivateData
->Fv
[0].FvPpi
->FindFileByType (
92 PrivateData
->Fv
[0].FvPpi
,
93 EFI_FV_FILETYPE_PEI_CORE
,
94 PrivateData
->Fv
[0].FvHandle
,
97 ASSERT_EFI_ERROR (Status
);
100 // Shadow PEI Core into memory so it will run faster
102 Status
= PeiLoadImage (
103 GetPeiServicesTablePointer (),
104 *((EFI_PEI_FILE_HANDLE
*)&PeiCoreFileHandle
),
105 PEIM_STATE_REGISITER_FOR_SHADOW
,
109 ASSERT_EFI_ERROR (Status
);
112 // Compute the PeiCore's function address after shaowed PeiCore.
113 // _ModuleEntryPoint is PeiCore main function entry
115 return (PEICORE_FUNCTION_POINTER
)((UINTN
) EntryPoint
+ (UINTN
) PeiCore
- (UINTN
) _ModuleEntryPoint
);
119 This routine is invoked by main entry of PeiMain module during transition
120 from SEC to PEI. After switching stack in the PEI core, it will restart
121 with the old core data.
123 @param SecCoreDataPtr Points to a data structure containing information about the PEI core's operating
124 environment, such as the size and location of temporary RAM, the stack location and
126 @param PpiList Points to a list of one or more PPI descriptors to be installed initially by the PEI core.
127 An empty PPI list consists of a single descriptor with the end-tag
128 EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. As part of its initialization
129 phase, the PEI Foundation will add these SEC-hosted PPIs to its PPI database such
130 that both the PEI Foundation and any modules can leverage the associated service
131 calls and/or code in these early PPIs
132 @param Data Pointer to old core data that is used to initialize the
134 If NULL, it is first PeiCore entering.
140 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreDataPtr
,
141 IN CONST EFI_PEI_PPI_DESCRIPTOR
*PpiList
,
145 PEI_CORE_INSTANCE PrivateData
;
146 EFI_SEC_PEI_HAND_OFF
*SecCoreData
;
147 EFI_SEC_PEI_HAND_OFF NewSecCoreData
;
149 PEI_CORE_TEMP_POINTERS TempPtr
;
150 PEI_CORE_INSTANCE
*OldCoreData
;
151 EFI_PEI_CPU_IO_PPI
*CpuIo
;
152 EFI_PEI_PCI_CFG2_PPI
*PciCfg
;
153 EFI_HOB_HANDOFF_INFO_TABLE
*HandoffInformationTable
;
154 EFI_PEI_TEMPORARY_RAM_DONE_PPI
*TemporaryRamDonePpi
;
158 // Retrieve context passed into PEI Core
160 OldCoreData
= (PEI_CORE_INSTANCE
*) Data
;
161 SecCoreData
= (EFI_SEC_PEI_HAND_OFF
*) SecCoreDataPtr
;
164 // Perform PEI Core phase specific actions.
166 if (OldCoreData
== NULL
) {
168 // If OldCoreData is NULL, means current is the first entry into the PEI Core before memory is available.
170 ZeroMem (&PrivateData
, sizeof (PEI_CORE_INSTANCE
));
171 PrivateData
.Signature
= PEI_CORE_HANDLE_SIGNATURE
;
172 CopyMem (&PrivateData
.ServiceTableShadow
, &gPs
, sizeof (gPs
));
175 // Memory is available to the PEI Core. See if the PEI Core has been shadowed to memory yet.
177 if (OldCoreData
->ShadowedPeiCore
== NULL
) {
179 // Fixup the PeiCore's private data
181 OldCoreData
->Ps
= &OldCoreData
->ServiceTableShadow
;
182 OldCoreData
->CpuIo
= &OldCoreData
->ServiceTableShadow
.CpuIo
;
183 if (OldCoreData
->HeapOffsetPositive
) {
184 OldCoreData
->HobList
.Raw
= (VOID
*)(OldCoreData
->HobList
.Raw
+ OldCoreData
->HeapOffset
);
185 OldCoreData
->UnknownFvInfo
= (PEI_CORE_UNKNOW_FORMAT_FV_INFO
*) ((UINT8
*) OldCoreData
->UnknownFvInfo
+ OldCoreData
->HeapOffset
);
186 OldCoreData
->CurrentFvFileHandles
= (EFI_PEI_FILE_HANDLE
*) ((UINT8
*) OldCoreData
->CurrentFvFileHandles
+ OldCoreData
->HeapOffset
);
187 OldCoreData
->PpiData
.PpiListPtrs
= (PEI_PPI_LIST_POINTERS
*) ((UINT8
*) OldCoreData
->PpiData
.PpiListPtrs
+ OldCoreData
->HeapOffset
);
188 OldCoreData
->Fv
= (PEI_CORE_FV_HANDLE
*) ((UINT8
*) OldCoreData
->Fv
+ OldCoreData
->HeapOffset
);
189 for (Index
= 0; Index
< PcdGet32 (PcdPeiCoreMaxFvSupported
); Index
++) {
190 OldCoreData
->Fv
[Index
].PeimState
= (UINT8
*) OldCoreData
->Fv
[Index
].PeimState
+ OldCoreData
->HeapOffset
;
191 OldCoreData
->Fv
[Index
].FvFileHandles
= (EFI_PEI_FILE_HANDLE
*) ((UINT8
*) OldCoreData
->Fv
[Index
].FvFileHandles
+ OldCoreData
->HeapOffset
);
193 OldCoreData
->FileGuid
= (EFI_GUID
*) ((UINT8
*) OldCoreData
->FileGuid
+ OldCoreData
->HeapOffset
);
194 OldCoreData
->FileHandles
= (EFI_PEI_FILE_HANDLE
*) ((UINT8
*) OldCoreData
->FileHandles
+ OldCoreData
->HeapOffset
);
196 OldCoreData
->HobList
.Raw
= (VOID
*)(OldCoreData
->HobList
.Raw
- OldCoreData
->HeapOffset
);
197 OldCoreData
->UnknownFvInfo
= (PEI_CORE_UNKNOW_FORMAT_FV_INFO
*) ((UINT8
*) OldCoreData
->UnknownFvInfo
- OldCoreData
->HeapOffset
);
198 OldCoreData
->CurrentFvFileHandles
= (EFI_PEI_FILE_HANDLE
*) ((UINT8
*) OldCoreData
->CurrentFvFileHandles
- OldCoreData
->HeapOffset
);
199 OldCoreData
->PpiData
.PpiListPtrs
= (PEI_PPI_LIST_POINTERS
*) ((UINT8
*) OldCoreData
->PpiData
.PpiListPtrs
- OldCoreData
->HeapOffset
);
200 OldCoreData
->Fv
= (PEI_CORE_FV_HANDLE
*) ((UINT8
*) OldCoreData
->Fv
- OldCoreData
->HeapOffset
);
201 for (Index
= 0; Index
< PcdGet32 (PcdPeiCoreMaxFvSupported
); Index
++) {
202 OldCoreData
->Fv
[Index
].PeimState
= (UINT8
*) OldCoreData
->Fv
[Index
].PeimState
- OldCoreData
->HeapOffset
;
203 OldCoreData
->Fv
[Index
].FvFileHandles
= (EFI_PEI_FILE_HANDLE
*) ((UINT8
*) OldCoreData
->Fv
[Index
].FvFileHandles
- OldCoreData
->HeapOffset
);
205 OldCoreData
->FileGuid
= (EFI_GUID
*) ((UINT8
*) OldCoreData
->FileGuid
- OldCoreData
->HeapOffset
);
206 OldCoreData
->FileHandles
= (EFI_PEI_FILE_HANDLE
*) ((UINT8
*) OldCoreData
->FileHandles
- OldCoreData
->HeapOffset
);
210 // Initialize libraries that the PEI Core is linked against
212 ProcessLibraryConstructorList (NULL
, (CONST EFI_PEI_SERVICES
**)&OldCoreData
->Ps
);
215 // Fixup for PeiService's address
217 SetPeiServicesTablePointer ((CONST EFI_PEI_SERVICES
**)&OldCoreData
->Ps
);
220 // Update HandOffHob for new installed permenent memory
222 HandoffInformationTable
= OldCoreData
->HobList
.HandoffInformationTable
;
223 if (OldCoreData
->HeapOffsetPositive
) {
224 HandoffInformationTable
->EfiEndOfHobList
= HandoffInformationTable
->EfiEndOfHobList
+ OldCoreData
->HeapOffset
;
226 HandoffInformationTable
->EfiEndOfHobList
= HandoffInformationTable
->EfiEndOfHobList
- OldCoreData
->HeapOffset
;
228 HandoffInformationTable
->EfiMemoryTop
= OldCoreData
->PhysicalMemoryBegin
+ OldCoreData
->PhysicalMemoryLength
;
229 HandoffInformationTable
->EfiMemoryBottom
= OldCoreData
->PhysicalMemoryBegin
;
230 HandoffInformationTable
->EfiFreeMemoryTop
= OldCoreData
->FreePhysicalMemoryTop
;
231 HandoffInformationTable
->EfiFreeMemoryBottom
= HandoffInformationTable
->EfiEndOfHobList
+ sizeof (EFI_HOB_GENERIC_HEADER
);
234 // We need convert the PPI descriptor's pointer
236 ConvertPpiPointers (SecCoreData
, OldCoreData
);
239 // After the whole temporary memory is migrated, then we can allocate page in
242 OldCoreData
->PeiMemoryInstalled
= TRUE
;
245 // Indicate that PeiCore reenter
247 OldCoreData
->PeimDispatcherReenter
= TRUE
;
249 if (PcdGet64(PcdLoadModuleAtFixAddressEnable
) != 0 && (OldCoreData
->HobList
.HandoffInformationTable
->BootMode
!= BOOT_ON_S3_RESUME
)) {
251 // if Loading Module at Fixed Address is enabled, allocate the PEI code memory range usage bit map array.
252 // Every bit in the array indicate the status of the corresponding memory page available or not
254 OldCoreData
->PeiCodeMemoryRangeUsageBitMap
= AllocateZeroPool (((PcdGet32(PcdLoadFixAddressPeiCodePageNumber
)>>6) + 1)*sizeof(UINT64
));
258 // Shadow PEI Core. When permanent memory is avaiable, shadow
259 // PEI Core and PEIMs to get high performance.
261 OldCoreData
->ShadowedPeiCore
= ShadowPeiCore (OldCoreData
);
264 // PEI Core has now been shadowed to memory. Restart PEI Core in memory.
266 OldCoreData
->ShadowedPeiCore (SecCoreData
, PpiList
, OldCoreData
);
269 // Should never reach here.
276 // Memory is available to the PEI Core and the PEI Core has been shadowed to memory.
278 CopyMem (&NewSecCoreData
, SecCoreDataPtr
, sizeof (NewSecCoreData
));
279 SecCoreData
= &NewSecCoreData
;
281 CopyMem (&PrivateData
, OldCoreData
, sizeof (PrivateData
));
283 CpuIo
= (VOID
*)PrivateData
.ServiceTableShadow
.CpuIo
;
284 PciCfg
= (VOID
*)PrivateData
.ServiceTableShadow
.PciCfg
;
286 CopyMem (&PrivateData
.ServiceTableShadow
, &gPs
, sizeof (gPs
));
288 PrivateData
.ServiceTableShadow
.CpuIo
= CpuIo
;
289 PrivateData
.ServiceTableShadow
.PciCfg
= PciCfg
;
293 // Cache a pointer to the PEI Services Table that is either in temporary memory or permanent memory
295 PrivateData
.Ps
= &PrivateData
.ServiceTableShadow
;
298 // Initialize libraries that the PEI Core is linked against
300 ProcessLibraryConstructorList (NULL
, (CONST EFI_PEI_SERVICES
**)&PrivateData
.Ps
);
303 // Save PeiServicePointer so that it can be retrieved anywhere.
305 SetPeiServicesTablePointer ((CONST EFI_PEI_SERVICES
**)&PrivateData
.Ps
);
308 // Initialize PEI Core Services
310 InitializeMemoryServices (&PrivateData
, SecCoreData
, OldCoreData
);
311 if (OldCoreData
== NULL
) {
313 // Initialize PEI Core Private Data Buffer
315 PrivateData
.PpiData
.PpiListPtrs
= AllocateZeroPool (sizeof (PEI_PPI_LIST_POINTERS
) * PcdGet32 (PcdPeiCoreMaxPpiSupported
));
316 ASSERT (PrivateData
.PpiData
.PpiListPtrs
!= NULL
);
317 PrivateData
.Fv
= AllocateZeroPool (sizeof (PEI_CORE_FV_HANDLE
) * PcdGet32 (PcdPeiCoreMaxFvSupported
));
318 ASSERT (PrivateData
.Fv
!= NULL
);
319 PrivateData
.Fv
[0].PeimState
= AllocateZeroPool (sizeof (UINT8
) * PcdGet32 (PcdPeiCoreMaxPeimPerFv
) * PcdGet32 (PcdPeiCoreMaxFvSupported
));
320 ASSERT (PrivateData
.Fv
[0].PeimState
!= NULL
);
321 PrivateData
.Fv
[0].FvFileHandles
= AllocateZeroPool (sizeof (EFI_PEI_FILE_HANDLE
) * PcdGet32 (PcdPeiCoreMaxPeimPerFv
) * PcdGet32 (PcdPeiCoreMaxFvSupported
));
322 ASSERT (PrivateData
.Fv
[0].FvFileHandles
!= NULL
);
323 for (Index
= 1; Index
< PcdGet32 (PcdPeiCoreMaxFvSupported
); Index
++) {
324 PrivateData
.Fv
[Index
].PeimState
= PrivateData
.Fv
[Index
- 1].PeimState
+ PcdGet32 (PcdPeiCoreMaxPeimPerFv
);
325 PrivateData
.Fv
[Index
].FvFileHandles
= PrivateData
.Fv
[Index
- 1].FvFileHandles
+ PcdGet32 (PcdPeiCoreMaxPeimPerFv
);
327 PrivateData
.UnknownFvInfo
= AllocateZeroPool (sizeof (PEI_CORE_UNKNOW_FORMAT_FV_INFO
) * PcdGet32 (PcdPeiCoreMaxFvSupported
));
328 ASSERT (PrivateData
.UnknownFvInfo
!= NULL
);
329 PrivateData
.CurrentFvFileHandles
= AllocateZeroPool (sizeof (EFI_PEI_FILE_HANDLE
) * PcdGet32 (PcdPeiCoreMaxPeimPerFv
));
330 ASSERT (PrivateData
.CurrentFvFileHandles
!= NULL
);
331 PrivateData
.FileGuid
= AllocatePool (sizeof (EFI_GUID
) * PcdGet32 (PcdPeiCoreMaxPeimPerFv
));
332 ASSERT (PrivateData
.FileGuid
!= NULL
);
333 PrivateData
.FileHandles
= AllocatePool (sizeof (EFI_PEI_FILE_HANDLE
) * (PcdGet32 (PcdPeiCoreMaxPeimPerFv
) + 1));
334 ASSERT (PrivateData
.FileHandles
!= NULL
);
336 InitializePpiServices (&PrivateData
, OldCoreData
);
339 // Update performance measurements
341 if (OldCoreData
== NULL
) {
342 PERF_START (NULL
, "SEC", NULL
, 1);
343 PERF_END (NULL
, "SEC", NULL
, 0);
346 // If first pass, start performance measurement.
348 PERF_START (NULL
,"PEI", NULL
, 0);
349 PERF_START (NULL
,"PreMem", NULL
, 0);
352 PERF_END (NULL
,"PreMem", NULL
, 0);
353 PERF_START (NULL
,"PostMem", NULL
, 0);
357 // Complete PEI Core Service initialization
359 InitializeSecurityServices (&PrivateData
.Ps
, OldCoreData
);
360 InitializeDispatcherData (&PrivateData
, OldCoreData
, SecCoreData
);
361 InitializeImageServices (&PrivateData
, OldCoreData
);
364 // Perform PEI Core Phase specific actions
366 if (OldCoreData
== NULL
) {
368 // Report Status Code EFI_SW_PC_INIT
372 (EFI_SOFTWARE_PEI_CORE
| EFI_SW_PC_INIT
)
376 // If SEC provided any PPI services to PEI, install them.
378 if (PpiList
!= NULL
) {
379 Status
= PeiServicesInstallPpi (PpiList
);
380 ASSERT_EFI_ERROR (Status
);
384 // Try to locate Temporary RAM Done Ppi.
386 Status
= PeiServicesLocatePpi (
387 &gEfiTemporaryRamDonePpiGuid
,
390 (VOID
**)&TemporaryRamDonePpi
392 if (!EFI_ERROR (Status
)) {
394 // Disable the use of Temporary RAM after the transition from Temporary RAM to Permanent RAM is complete.
396 TemporaryRamDonePpi
->TemporaryRamDone ();
400 // Alert any listeners that there is permanent memory available
402 PERF_START (NULL
,"DisMem", NULL
, 0);
403 Status
= PeiServicesInstallPpi (&mMemoryDiscoveredPpi
);
406 // Process the Notify list and dispatch any notifies for the Memory Discovered PPI
408 ProcessNotifyList (&PrivateData
);
410 PERF_END (NULL
,"DisMem", NULL
, 0);
414 // Call PEIM dispatcher
416 PeiDispatcher (SecCoreData
, &PrivateData
);
419 // Check if InstallPeiMemory service was called.
421 ASSERT(PrivateData
.PeiMemoryInstalled
== TRUE
);
424 // Measure PEI Core execution time.
426 PERF_END (NULL
, "PostMem", NULL
, 0);
429 // Lookup DXE IPL PPI
431 Status
= PeiServicesLocatePpi (
435 (VOID
**)&TempPtr
.DxeIpl
437 ASSERT_EFI_ERROR (Status
);
440 // Enter DxeIpl to load Dxe core.
442 DEBUG ((EFI_D_INFO
, "DXE IPL Entry\n"));
443 Status
= TempPtr
.DxeIpl
->Entry (
449 // Should never reach here.
451 ASSERT_EFI_ERROR (Status
);