]>
Commit | Line | Data |
---|---|---|
615c6dd0 | 1 | /** @file\r |
b1f6a7c6 | 2 | Definition of Pei Core Structures and Services\r |
3 | \r | |
192f6d4c | 4 | Copyright (c) 2006 - 2007, Intel Corporation\r |
5 | All rights reserved. This program and the accompanying materials\r | |
6 | are licensed and made available under the terms and conditions of the BSD License\r | |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
615c6dd0 | 13 | **/\r |
192f6d4c | 14 | \r |
15 | #ifndef _PEI_MAIN_H_\r | |
16 | #define _PEI_MAIN_H_\r | |
17 | \r | |
859b72fa | 18 | #include <PiPei.h>\r |
859b72fa A |
19 | #include <Ppi/DxeIpl.h>\r |
20 | #include <Ppi/MemoryDiscovered.h>\r | |
859b72fa | 21 | #include <Ppi/StatusCode.h>\r |
859b72fa | 22 | #include <Ppi/Reset.h>\r |
b0d803fe | 23 | #include <Ppi/FirmwareVolume.h>\r |
24 | #include <Ppi/FirmwareVolumeInfo.h>\r | |
25 | #include <Ppi/Decompress.h>\r | |
26 | #include <Ppi/GuidedSectionExtraction.h>\r | |
27 | #include <Ppi/LoadFile.h>\r | |
28 | #include <Ppi/Security2.h>\r | |
58dcdada | 29 | #include <Ppi/TemporaryRamSupport.h>\r |
859b72fa A |
30 | #include <Library/DebugLib.h>\r |
31 | #include <Library/PeiCoreEntryPoint.h>\r | |
32 | #include <Library/BaseLib.h>\r | |
33 | #include <Library/HobLib.h>\r | |
34 | #include <Library/PerformanceLib.h>\r | |
35 | #include <Library/PeiServicesLib.h>\r | |
36 | #include <Library/ReportStatusCodeLib.h>\r | |
c58cf83d | 37 | #include <Library/PeCoffLib.h>\r |
859b72fa A |
38 | #include <Library/PeCoffGetEntryPointLib.h>\r |
39 | #include <Library/BaseMemoryLib.h>\r | |
b0d803fe | 40 | #include <Library/CacheMaintenanceLib.h>\r |
859b72fa | 41 | #include <Library/TimerLib.h>\r |
177aabe6 | 42 | #include <Library/PcdLib.h>\r |
28dc3c67 | 43 | #include <IndustryStandard/PeImage.h>\r |
14e8823a | 44 | #include <Library/PeiServicesTablePointerLib.h>\r |
b0d803fe | 45 | #include <Library/MemoryAllocationLib.h>\r |
288f9b38 | 46 | #include <Library/PeiPiLib.h>\r |
b0d803fe | 47 | #include <Guid/FirmwareFileSystem2.h>\r |
48 | #include <Guid/AprioriFileName.h>\r | |
192f6d4c | 49 | \r |
3a63377f | 50 | #define PEI_CORE_INTERNAL_FFS_FILE_DISPATCH_TYPE 0xff\r |
51 | \r | |
b1f6a7c6 | 52 | ///\r |
53 | /// Pei Core private data structures\r | |
54 | ///\r | |
192f6d4c | 55 | typedef union {\r |
56 | EFI_PEI_PPI_DESCRIPTOR *Ppi;\r | |
57 | EFI_PEI_NOTIFY_DESCRIPTOR *Notify;\r | |
58 | VOID *Raw;\r | |
59 | } PEI_PPI_LIST_POINTERS;\r | |
60 | \r | |
192f6d4c | 61 | typedef struct {\r |
62 | INTN PpiListEnd;\r | |
63 | INTN NotifyListEnd;\r | |
64 | INTN DispatchListEnd;\r | |
65 | INTN LastDispatchedInstall;\r | |
66 | INTN LastDispatchedNotify;\r | |
eaf539d0 | 67 | PEI_PPI_LIST_POINTERS PpiListPtrs[FixedPcdGet32 (PcdPeiCoreMaxPpiSupported)];\r |
192f6d4c | 68 | } PEI_PPI_DATABASE;\r |
69 | \r | |
3a63377f | 70 | \r |
3a63377f | 71 | //\r |
72 | // PEI_CORE_FV_HANDE.PeimState\r | |
73 | // Do not change these values as there is code doing math to change states.\r | |
74 | // Look for Private->Fv[FvCount].PeimState[PeimCount]++;\r | |
75 | //\r | |
76 | #define PEIM_STATE_NOT_DISPATCHED 0x00\r | |
77 | #define PEIM_STATE_DISPATCHED 0x01\r | |
78 | #define PEIM_STATE_REGISITER_FOR_SHADOW 0x02\r | |
79 | #define PEIM_STATE_DONE 0x03\r | |
80 | \r | |
81 | typedef struct {\r | |
82 | EFI_FIRMWARE_VOLUME_HEADER *FvHeader;\r | |
50cb16d9 | 83 | UINT8 PeimState[FixedPcdGet32 (PcdPeiCoreMaxPeimPerFv)];\r |
177aabe6 | 84 | EFI_PEI_FILE_HANDLE FvFileHandles[FixedPcdGet32 (PcdPeiCoreMaxPeimPerFv)];\r |
3a63377f | 85 | BOOLEAN ScanFv;\r |
86 | } PEI_CORE_FV_HANDLE;\r | |
87 | \r | |
288f9b38 LG |
88 | #define CACHE_SETION_MAX_NUMBER 0x10\r |
89 | typedef struct {\r | |
90 | EFI_COMMON_SECTION_HEADER* Section[CACHE_SETION_MAX_NUMBER];\r | |
91 | VOID* SectionData[CACHE_SETION_MAX_NUMBER];\r | |
92 | UINTN SectionSize[CACHE_SETION_MAX_NUMBER];\r | |
93 | UINTN AllSectionCount;\r | |
94 | UINTN SectionIndex;\r | |
95 | } CACHE_SECTION_DATA;\r | |
96 | \r | |
192f6d4c | 97 | //\r |
98 | // Pei Core private data structure instance\r | |
99 | //\r | |
100 | \r | |
101 | #define PEI_CORE_HANDLE_SIGNATURE EFI_SIGNATURE_32('P','e','i','C')\r | |
102 | \r | |
103 | typedef struct{\r | |
104 | UINTN Signature;\r | |
105 | EFI_PEI_SERVICES *PS; // Point to ServiceTableShadow\r | |
106 | PEI_PPI_DATABASE PpiData;\r | |
3a63377f | 107 | UINTN FvCount;\r |
177aabe6 | 108 | PEI_CORE_FV_HANDLE Fv[FixedPcdGet32 (PcdPeiCoreMaxFvSupported)];\r |
109 | EFI_PEI_FILE_HANDLE CurrentFvFileHandles[FixedPcdGet32 (PcdPeiCoreMaxPeimPerFv)];\r | |
3a63377f | 110 | UINTN AprioriCount;\r |
50cb16d9 | 111 | UINTN CurrentPeimFvCount;\r |
3a63377f | 112 | UINTN CurrentPeimCount;\r |
113 | EFI_PEI_FILE_HANDLE CurrentFileHandle;\r | |
114 | UINTN AllFvCount;\r | |
177aabe6 | 115 | EFI_PEI_FV_HANDLE AllFv[FixedPcdGet32 (PcdPeiCoreMaxFvSupported)];\r |
192f6d4c | 116 | EFI_PEI_HOB_POINTERS HobList;\r |
117 | BOOLEAN SwitchStackSignal;\r | |
118 | BOOLEAN PeiMemoryInstalled;\r | |
119 | EFI_PHYSICAL_ADDRESS StackBase;\r | |
120 | UINT64 StackSize;\r | |
121 | VOID *BottomOfCarHeap;\r | |
122 | VOID *TopOfCarHeap;\r | |
123 | VOID *CpuIo;\r | |
b0d803fe | 124 | EFI_PEI_SECURITY2_PPI *PrivateSecurityPpi;\r |
192f6d4c | 125 | EFI_PEI_SERVICES ServiceTableShadow;\r |
58dcdada | 126 | UINTN SizeOfTemporaryMemory;\r |
192f6d4c | 127 | UINTN SizeOfCacheAsRam;\r |
128 | VOID *MaxTopOfCarHeap;\r | |
b0d803fe | 129 | EFI_PEI_PPI_DESCRIPTOR *XipLoadFile;\r |
58dcdada | 130 | EFI_PHYSICAL_ADDRESS PhysicalMemoryBegin;\r |
131 | UINT64 PhysicalMemoryLength;\r | |
132 | EFI_PHYSICAL_ADDRESS FreePhysicalMemoryTop;\r | |
133 | VOID* ShadowedPeiCore;\r | |
288f9b38 | 134 | CACHE_SECTION_DATA CacheSection;\r |
192f6d4c | 135 | } PEI_CORE_INSTANCE;\r |
136 | \r | |
137 | //\r | |
138 | // Pei Core Instance Data Macros\r | |
139 | //\r | |
140 | \r | |
141 | #define PEI_CORE_INSTANCE_FROM_PS_THIS(a) \\r | |
142 | CR(a, PEI_CORE_INSTANCE, PS, PEI_CORE_HANDLE_SIGNATURE)\r | |
143 | \r | |
192f6d4c | 144 | typedef\r |
145 | EFI_STATUS\r | |
146 | (EFIAPI *PEI_CORE_ENTRY_POINT)(\r | |
b98c2ab7 | 147 | IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r |
148 | IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,\r | |
149 | IN PEI_CORE_INSTANCE *OldCoreData\r | |
192f6d4c | 150 | );\r |
151 | \r | |
b1f6a7c6 | 152 | ///\r |
153 | /// Union of temporarily used function pointers (to save stack space)\r | |
154 | ///\r | |
192f6d4c | 155 | typedef union {\r |
156 | PEI_CORE_ENTRY_POINT PeiCore;\r | |
1c9d209f | 157 | EFI_PEIM_ENTRY_POINT2 PeimEntry;\r |
192f6d4c | 158 | EFI_PEIM_NOTIFY_ENTRY_POINT PeimNotifyEntry;\r |
159 | EFI_DXE_IPL_PPI *DxeIpl;\r | |
160 | EFI_PEI_PPI_DESCRIPTOR *PpiDescriptor;\r | |
161 | EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor;\r | |
162 | VOID *Raw;\r | |
163 | } PEI_CORE_TEMP_POINTERS;\r | |
164 | \r | |
165 | \r | |
b98c2ab7 | 166 | \r |
167 | typedef struct {\r | |
168 | CONST EFI_SEC_PEI_HAND_OFF *SecCoreData;\r | |
169 | EFI_PEI_PPI_DESCRIPTOR *PpiList;\r | |
170 | VOID *Data;\r | |
171 | } PEI_CORE_PARAMETERS;\r | |
172 | \r | |
192f6d4c | 173 | //\r |
174 | // PeiCore function\r | |
175 | //\r | |
b1f6a7c6 | 176 | /**\r |
192f6d4c | 177 | \r |
178 | The entry routine to Pei Core, invoked by PeiMain during transition\r | |
179 | from SEC to PEI. After switching stack in the PEI core, it will restart\r | |
180 | with the old core data.\r | |
181 | \r | |
192f6d4c | 182 | \r |
b1f6a7c6 | 183 | @param SecCoreData Points to a data structure containing information about the PEI core's operating\r |
184 | environment, such as the size and location of temporary RAM, the stack location and\r | |
185 | the BFV location.\r | |
186 | @param PpiList Points to a list of one or more PPI descriptors to be installed initially by the PEI core.\r | |
187 | An empty PPI list consists of a single descriptor with the end-tag\r | |
188 | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. As part of its initialization\r | |
189 | phase, the PEI Foundation will add these SEC-hosted PPIs to its PPI database such\r | |
190 | that both the PEI Foundation and any modules can leverage the associated service\r | |
191 | calls and/or code in these early PPIs\r | |
192 | @param Data Pointer to old core data that is used to initialize the\r | |
192f6d4c | 193 | core's data areas.\r |
194 | \r | |
b1f6a7c6 | 195 | @retval EFI_NOT_FOUND Never reach\r |
192f6d4c | 196 | \r |
b1f6a7c6 | 197 | **/\r |
198 | EFI_STATUS\r | |
199 | EFIAPI\r | |
200 | PeiCore (\r | |
201 | IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r | |
202 | IN CONST EFI_PEI_PPI_DESCRIPTOR *PpList,\r | |
203 | IN VOID *Data\r | |
204 | )\r | |
192f6d4c | 205 | ;\r |
206 | \r | |
207 | //\r | |
208 | // Dispatcher support functions\r | |
209 | //\r | |
210 | \r | |
b1f6a7c6 | 211 | /**\r |
192f6d4c | 212 | \r |
213 | This is the POSTFIX version of the dependency evaluator. When a\r | |
214 | PUSH [PPI GUID] is encountered, a pointer to the GUID is stored on\r | |
215 | the evaluation stack. When that entry is poped from the evaluation\r | |
216 | stack, the PPI is checked if it is installed. This method allows\r | |
217 | some time savings as not all PPIs must be checked for certain\r | |
218 | operation types (AND, OR).\r | |
219 | \r | |
192f6d4c | 220 | \r |
b1f6a7c6 | 221 | @param PeiServices Calling context.\r |
222 | @param DependencyExpression Pointer to a dependency expression. The Grammar adheres to\r | |
223 | the BNF described above and is stored in postfix notation.\r | |
192f6d4c | 224 | \r |
b1f6a7c6 | 225 | @retval TRUE if it is a well-formed Grammar\r |
226 | @retval FALSE if the dependency expression overflows the evaluation stack\r | |
227 | if the dependency expression underflows the evaluation stack\r | |
228 | if the dependency expression is not a well-formed Grammar.\r | |
192f6d4c | 229 | \r |
b1f6a7c6 | 230 | **/\r |
231 | BOOLEAN\r | |
232 | PeimDispatchReadiness (\r | |
233 | IN EFI_PEI_SERVICES **PeiServices,\r | |
234 | IN VOID *DependencyExpression\r | |
235 | )\r | |
192f6d4c | 236 | ;\r |
237 | \r | |
b1f6a7c6 | 238 | /**\r |
239 | Conduct PEIM dispatch.\r | |
240 | \r | |
241 | @param SecCoreData Points to a data structure containing information about the PEI core's operating\r | |
242 | environment, such as the size and location of temporary RAM, the stack location and\r | |
243 | the BFV location.\r | |
244 | PrivateData - Pointer to the private data passed in from caller\r | |
245 | DispatchData - Pointer to PEI_CORE_DISPATCH_DATA data.\r | |
246 | @param Private EDES_TODO: Add parameter description\r | |
192f6d4c | 247 | \r |
b1f6a7c6 | 248 | @retval EFI_SUCCESS Successfully dispatched PEIM.\r |
249 | @retval EFI_NOT_FOUND The dispatch failed.\r | |
250 | \r | |
251 | **/\r | |
b0d803fe | 252 | VOID\r |
192f6d4c | 253 | PeiDispatcher (\r |
5aae0aa7 | 254 | IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r |
b0d803fe | 255 | IN PEI_CORE_INSTANCE *PrivateData\r |
192f6d4c | 256 | )\r |
b1f6a7c6 | 257 | ;\r |
192f6d4c | 258 | \r |
b1f6a7c6 | 259 | /**\r |
260 | Initialize the Dispatcher's data members\r | |
192f6d4c | 261 | \r |
b1f6a7c6 | 262 | @param PrivateData PeiCore's private data structure\r |
263 | @param OldCoreData Old data from SecCore\r | |
264 | NULL if being run in non-permament memory mode.\r | |
265 | @param SecCoreData Points to a data structure containing information about the PEI core's operating\r | |
266 | environment, such as the size and location of temporary RAM, the stack location and\r | |
267 | the BFV location.\r | |
192f6d4c | 268 | \r |
b1f6a7c6 | 269 | @return None.\r |
192f6d4c | 270 | \r |
b1f6a7c6 | 271 | **/\r |
192f6d4c | 272 | VOID\r |
273 | InitializeDispatcherData (\r | |
b0d803fe | 274 | IN PEI_CORE_INSTANCE *PrivateData,\r |
192f6d4c | 275 | IN PEI_CORE_INSTANCE *OldCoreData,\r |
5aae0aa7 | 276 | IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData\r |
192f6d4c | 277 | )\r |
192f6d4c | 278 | ;\r |
279 | \r | |
b1f6a7c6 | 280 | /**\r |
281 | This routine parses the Dependency Expression, if available, and\r | |
282 | decides if the module can be executed.\r | |
192f6d4c | 283 | \r |
192f6d4c | 284 | \r |
b1f6a7c6 | 285 | @param Private PeiCore's private data structure\r |
286 | @param FileHandle PEIM's file handle\r | |
287 | @param PeimCount Peim count in all dispatched PEIMs.\r | |
192f6d4c | 288 | \r |
b1f6a7c6 | 289 | @retval TRUE Can be dispatched\r |
290 | @retval FALSE Cannot be dispatched\r | |
192f6d4c | 291 | \r |
b1f6a7c6 | 292 | **/\r |
192f6d4c | 293 | BOOLEAN\r |
294 | DepexSatisfied (\r | |
b0d803fe | 295 | IN PEI_CORE_INSTANCE *Private,\r |
296 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
297 | IN UINTN PeimCount\r | |
192f6d4c | 298 | )\r |
192f6d4c | 299 | ;\r |
300 | \r | |
192f6d4c | 301 | //\r |
302 | // PPI support functions\r | |
303 | //\r | |
b1f6a7c6 | 304 | /**\r |
305 | \r | |
306 | Initialize PPI services.\r | |
307 | \r | |
308 | \r | |
309 | @param PrivateData Pointer to the PEI Core data.\r | |
310 | @param OldCoreData Pointer to old PEI Core data. \r | |
311 | NULL if being run in non-permament memory mode.\r | |
312 | \r | |
313 | **/\r | |
192f6d4c | 314 | VOID\r |
315 | InitializePpiServices (\r | |
b0d803fe | 316 | IN PEI_CORE_INSTANCE *PrivateData,\r |
192f6d4c | 317 | IN PEI_CORE_INSTANCE *OldCoreData\r |
318 | )\r | |
b1f6a7c6 | 319 | ;\r |
192f6d4c | 320 | \r |
b1f6a7c6 | 321 | /**\r |
192f6d4c | 322 | \r |
b1f6a7c6 | 323 | Migrate the Hob list from the CAR stack to PEI installed memory.\r |
192f6d4c | 324 | \r |
b1f6a7c6 | 325 | @param PeiServices The PEI core services table.\r |
326 | @param OldCheckingBottom The old checking bottom.\r | |
327 | @param OldCheckingTop The old checking top.\r | |
5c5a0601 | 328 | @param Fixup The address difference between\r |
329 | the new Hob list and old Hob list.\r | |
192f6d4c | 330 | \r |
b1f6a7c6 | 331 | **/\r |
192f6d4c | 332 | VOID\r |
333 | ConvertPpiPointers (\r | |
5c5a0601 | 334 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
58dcdada | 335 | IN UINTN OldCheckingBottom,\r |
336 | IN UINTN OldCheckingTop,\r | |
5c5a0601 | 337 | IN UINTN Fixup\r |
192f6d4c | 338 | )\r |
b1f6a7c6 | 339 | ;\r |
192f6d4c | 340 | \r |
b1f6a7c6 | 341 | /**\r |
192f6d4c | 342 | \r |
b1f6a7c6 | 343 | Install PPI services.\r |
192f6d4c | 344 | \r |
b1f6a7c6 | 345 | @param PeiServices - Pointer to the PEI Service Table\r |
346 | @param PpiList - Pointer to a list of PEI PPI Descriptors.\r | |
192f6d4c | 347 | \r |
b1f6a7c6 | 348 | @retval EFI_SUCCESS - if all PPIs in PpiList are successfully installed.\r |
349 | @retval EFI_INVALID_PARAMETER - if PpiList is NULL pointer\r | |
350 | @retval EFI_INVALID_PARAMETER - if any PPI in PpiList is not valid\r | |
351 | @retval EFI_OUT_OF_RESOURCES - if there is no more memory resource to install PPI\r | |
192f6d4c | 352 | \r |
b1f6a7c6 | 353 | **/\r |
192f6d4c | 354 | EFI_STATUS\r |
355 | EFIAPI\r | |
356 | PeiInstallPpi (\r | |
0c2b5da8 | 357 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
358 | IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList\r | |
192f6d4c | 359 | )\r |
b1f6a7c6 | 360 | ;\r |
192f6d4c | 361 | \r |
b1f6a7c6 | 362 | /**\r |
192f6d4c | 363 | \r |
b1f6a7c6 | 364 | Re-Install PPI services.\r |
192f6d4c | 365 | \r |
b1f6a7c6 | 366 | @param PeiServices - Pointer to the PEI Service Table\r |
367 | @param OldPpi - Pointer to the old PEI PPI Descriptors.\r | |
368 | @param NewPpi - Pointer to the new PEI PPI Descriptors.\r | |
192f6d4c | 369 | \r |
b1f6a7c6 | 370 | @retval EFI_SUCCESS - if the operation was successful\r |
371 | @retval EFI_INVALID_PARAMETER - if OldPpi or NewPpi is NULL\r | |
372 | @retval EFI_INVALID_PARAMETER - if NewPpi is not valid\r | |
373 | @retval EFI_NOT_FOUND - if the PPI was not in the database\r | |
192f6d4c | 374 | \r |
b1f6a7c6 | 375 | **/\r |
192f6d4c | 376 | EFI_STATUS\r |
377 | EFIAPI\r | |
378 | PeiReInstallPpi (\r | |
0c2b5da8 | 379 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
380 | IN CONST EFI_PEI_PPI_DESCRIPTOR *OldPpi,\r | |
381 | IN CONST EFI_PEI_PPI_DESCRIPTOR *NewPpi\r | |
192f6d4c | 382 | )\r |
b1f6a7c6 | 383 | ;\r |
192f6d4c | 384 | \r |
b1f6a7c6 | 385 | /**\r |
192f6d4c | 386 | \r |
b1f6a7c6 | 387 | Locate a given named PPI.\r |
192f6d4c | 388 | \r |
192f6d4c | 389 | \r |
b1f6a7c6 | 390 | @param PeiServices - Pointer to the PEI Service Table\r |
391 | @param Guid - Pointer to GUID of the PPI.\r | |
392 | @param Instance - Instance Number to discover.\r | |
393 | @param PpiDescriptor - Pointer to reference the found descriptor. If not NULL,\r | |
394 | returns a pointer to the descriptor (includes flags, etc)\r | |
395 | @param Ppi - Pointer to reference the found PPI\r | |
192f6d4c | 396 | \r |
b1f6a7c6 | 397 | @retval EFI_SUCCESS if the PPI is in the database\r |
398 | @retval EFI_NOT_FOUND if the PPI is not in the database\r | |
192f6d4c | 399 | \r |
b1f6a7c6 | 400 | **/\r |
192f6d4c | 401 | EFI_STATUS\r |
402 | EFIAPI\r | |
403 | PeiLocatePpi (\r | |
0c2b5da8 | 404 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
405 | IN CONST EFI_GUID *Guid,\r | |
192f6d4c | 406 | IN UINTN Instance,\r |
407 | IN OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor,\r | |
408 | IN OUT VOID **Ppi\r | |
409 | )\r | |
b1f6a7c6 | 410 | ;\r |
192f6d4c | 411 | \r |
b1f6a7c6 | 412 | /**\r |
192f6d4c | 413 | \r |
b1f6a7c6 | 414 | Install a notification for a given PPI.\r |
192f6d4c | 415 | \r |
192f6d4c | 416 | \r |
b1f6a7c6 | 417 | @param PeiServices - Pointer to the PEI Service Table\r |
418 | @param NotifyList - Pointer to list of Descriptors to notify upon.\r | |
192f6d4c | 419 | \r |
b1f6a7c6 | 420 | @retval EFI_SUCCESS if successful\r |
421 | @retval EFI_OUT_OF_RESOURCES if no space in the database\r | |
422 | @retval EFI_INVALID_PARAMETER if not a good decriptor\r | |
192f6d4c | 423 | \r |
b1f6a7c6 | 424 | **/\r |
192f6d4c | 425 | EFI_STATUS\r |
426 | EFIAPI\r | |
427 | PeiNotifyPpi (\r | |
0c2b5da8 | 428 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
429 | IN CONST EFI_PEI_NOTIFY_DESCRIPTOR *NotifyList\r | |
192f6d4c | 430 | )\r |
b1f6a7c6 | 431 | ;\r |
192f6d4c | 432 | \r |
b1f6a7c6 | 433 | /**\r |
192f6d4c | 434 | \r |
b1f6a7c6 | 435 | Process the Notify List at dispatch level.\r |
192f6d4c | 436 | \r |
b1f6a7c6 | 437 | @param PrivateData PeiCore's private data structure.\r |
192f6d4c | 438 | \r |
b1f6a7c6 | 439 | **/\r |
192f6d4c | 440 | VOID\r |
441 | ProcessNotifyList (\r | |
b0d803fe | 442 | IN PEI_CORE_INSTANCE *PrivateData\r |
192f6d4c | 443 | )\r |
b1f6a7c6 | 444 | ;\r |
192f6d4c | 445 | \r |
b1f6a7c6 | 446 | /**\r |
192f6d4c | 447 | \r |
b1f6a7c6 | 448 | Dispatch notifications.\r |
192f6d4c | 449 | \r |
b1f6a7c6 | 450 | @param PrivateData PeiCore's private data structure\r |
451 | @param NotifyType Type of notify to fire.\r | |
452 | @param InstallStartIndex Install Beginning index.\r | |
453 | @param InstallStopIndex Install Ending index.\r | |
454 | @param NotifyStartIndex Notify Beginning index.\r | |
455 | @param NotifyStopIndex Notify Ending index.\r | |
192f6d4c | 456 | \r |
b1f6a7c6 | 457 | **/\r |
192f6d4c | 458 | VOID\r |
459 | DispatchNotify (\r | |
b0d803fe | 460 | IN PEI_CORE_INSTANCE *PrivateData,\r |
192f6d4c | 461 | IN UINTN NotifyType,\r |
462 | IN INTN InstallStartIndex,\r | |
463 | IN INTN InstallStopIndex,\r | |
464 | IN INTN NotifyStartIndex,\r | |
465 | IN INTN NotifyStopIndex\r | |
466 | )\r | |
192f6d4c | 467 | ;\r |
468 | \r | |
469 | //\r | |
470 | // Boot mode support functions\r | |
471 | //\r | |
b1f6a7c6 | 472 | /**\r |
473 | This service enables PEIMs to ascertain the present value of the boot mode.\r | |
474 | \r | |
475 | @param PeiServices The PEI core services table.\r | |
476 | @param BootMode A pointer to contain the value of the boot mode.\r | |
477 | \r | |
478 | @retval EFI_SUCCESS The boot mode was returned successfully.\r | |
479 | @retval EFI_INVALID_PARAMETER BootMode is NULL.\r | |
480 | \r | |
481 | **/\r | |
192f6d4c | 482 | EFI_STATUS\r |
483 | EFIAPI\r | |
484 | PeiGetBootMode (\r | |
0c2b5da8 | 485 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
192f6d4c | 486 | IN OUT EFI_BOOT_MODE *BootMode\r |
487 | )\r | |
b1f6a7c6 | 488 | ;\r |
192f6d4c | 489 | \r |
b1f6a7c6 | 490 | /**\r |
491 | This service enables PEIMs to update the boot mode variable.\r | |
192f6d4c | 492 | \r |
192f6d4c | 493 | \r |
b1f6a7c6 | 494 | @param PeiServices - The PEI core services table.\r |
495 | @param BootMode - The value of the boot mode to set.\r | |
192f6d4c | 496 | \r |
b1f6a7c6 | 497 | @return EFI_SUCCESS - The value was successfully updated\r |
192f6d4c | 498 | \r |
b1f6a7c6 | 499 | **/\r |
192f6d4c | 500 | EFI_STATUS\r |
501 | EFIAPI\r | |
502 | PeiSetBootMode (\r | |
0c2b5da8 | 503 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
192f6d4c | 504 | IN EFI_BOOT_MODE BootMode\r |
505 | )\r | |
192f6d4c | 506 | ;\r |
507 | \r | |
508 | //\r | |
509 | // Security support functions\r | |
510 | //\r | |
b1f6a7c6 | 511 | /**\r |
512 | \r | |
513 | Initialize the security services.\r | |
514 | \r | |
515 | \r | |
516 | @param PeiServices - The PEI core services table.\r | |
517 | @param OldCoreData - Pointer to the old core data.\r | |
518 | NULL if being run in non-permament memory mode.\r | |
519 | \r | |
520 | **/\r | |
192f6d4c | 521 | VOID\r |
522 | InitializeSecurityServices (\r | |
523 | IN EFI_PEI_SERVICES **PeiServices,\r | |
524 | IN PEI_CORE_INSTANCE *OldCoreData\r | |
525 | )\r | |
b1f6a7c6 | 526 | ;\r |
192f6d4c | 527 | \r |
b1f6a7c6 | 528 | /**\r |
529 | Verify a Firmware volume\r | |
192f6d4c | 530 | \r |
b1f6a7c6 | 531 | @param CurrentFvAddress - Pointer to the current Firmware Volume under consideration\r |
192f6d4c | 532 | \r |
b1f6a7c6 | 533 | @retval EFI_SUCCESS - Firmware Volume is legal\r |
534 | @retval EFI_SECURITY_VIOLATION - Firmware Volume fails integrity test\r | |
192f6d4c | 535 | \r |
b1f6a7c6 | 536 | **/\r |
192f6d4c | 537 | EFI_STATUS\r |
538 | VerifyFv (\r | |
539 | IN EFI_FIRMWARE_VOLUME_HEADER *CurrentFvAddress\r | |
540 | )\r | |
b1f6a7c6 | 541 | ;\r |
192f6d4c | 542 | \r |
b1f6a7c6 | 543 | /**\r |
192f6d4c | 544 | \r |
b1f6a7c6 | 545 | Provide a callout to the security verification service.\r |
192f6d4c | 546 | \r |
192f6d4c | 547 | \r |
b1f6a7c6 | 548 | @param PrivateData PeiCore's private data structure\r |
549 | @param VolumeHandle Handle of FV\r | |
550 | @param FileHandle Handle of PEIM's ffs\r | |
192f6d4c | 551 | \r |
b1f6a7c6 | 552 | @retval EFI_SUCCESS Image is OK\r |
553 | @retval EFI_SECURITY_VIOLATION Image is illegal\r | |
192f6d4c | 554 | \r |
b1f6a7c6 | 555 | **/\r |
192f6d4c | 556 | EFI_STATUS\r |
557 | VerifyPeim (\r | |
b0d803fe | 558 | IN PEI_CORE_INSTANCE *PrivateData,\r |
559 | IN EFI_PEI_FV_HANDLE VolumeHandle,\r | |
560 | IN EFI_PEI_FILE_HANDLE FileHandle\r | |
192f6d4c | 561 | )\r |
b1f6a7c6 | 562 | ;\r |
192f6d4c | 563 | \r |
b1f6a7c6 | 564 | /**\r |
192f6d4c | 565 | \r |
b1f6a7c6 | 566 | Gets the pointer to the HOB List.\r |
192f6d4c | 567 | \r |
192f6d4c | 568 | \r |
b1f6a7c6 | 569 | @param PeiServices The PEI core services table.\r |
570 | @param HobList Pointer to the HOB List.\r | |
192f6d4c | 571 | \r |
b1f6a7c6 | 572 | @retval EFI_SUCCESS Get the pointer of HOB List\r |
573 | @retval EFI_NOT_AVAILABLE_YET the HOB List is not yet published\r | |
574 | @retval EFI_INVALID_PARAMETER HobList is NULL (in debug mode)\r | |
192f6d4c | 575 | \r |
b1f6a7c6 | 576 | **/\r |
192f6d4c | 577 | EFI_STATUS\r |
578 | EFIAPI\r | |
579 | PeiGetHobList (\r | |
0c2b5da8 | 580 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
192f6d4c | 581 | IN OUT VOID **HobList\r |
582 | )\r | |
b1f6a7c6 | 583 | ;\r |
192f6d4c | 584 | \r |
b1f6a7c6 | 585 | /**\r |
586 | Add a new HOB to the HOB List.\r | |
192f6d4c | 587 | \r |
b1f6a7c6 | 588 | @param PeiServices - The PEI core services table.\r |
589 | @param Type - Type of the new HOB.\r | |
590 | @param Length - Length of the new HOB to allocate.\r | |
591 | @param Hob - Pointer to the new HOB.\r | |
192f6d4c | 592 | \r |
b1f6a7c6 | 593 | @return EFI_SUCCESS Success to create hob.\r |
594 | @retval EFI_INVALID_PARAMETER if Hob is NULL\r | |
595 | @retval EFI_NOT_AVAILABLE_YET if HobList is still not available.\r | |
596 | @retval EFI_OUT_OF_RESOURCES if there is no more memory to grow the Hoblist.\r | |
192f6d4c | 597 | \r |
b1f6a7c6 | 598 | **/\r |
192f6d4c | 599 | EFI_STATUS\r |
600 | EFIAPI\r | |
601 | PeiCreateHob (\r | |
0c2b5da8 | 602 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
192f6d4c | 603 | IN UINT16 Type,\r |
604 | IN UINT16 Length,\r | |
605 | IN OUT VOID **Hob\r | |
606 | )\r | |
b1f6a7c6 | 607 | ;\r |
192f6d4c | 608 | \r |
b1f6a7c6 | 609 | /**\r |
192f6d4c | 610 | \r |
b1f6a7c6 | 611 | Builds a Handoff Information Table HOB\r |
192f6d4c | 612 | \r |
b1f6a7c6 | 613 | @param BootMode - Current Bootmode\r |
614 | @param MemoryBegin - Start Memory Address.\r | |
615 | @param MemoryLength - Length of Memory.\r | |
192f6d4c | 616 | \r |
b1f6a7c6 | 617 | @return EFI_SUCCESS Always success to initialize HOB.\r |
192f6d4c | 618 | \r |
b1f6a7c6 | 619 | **/\r |
192f6d4c | 620 | EFI_STATUS\r |
621 | PeiCoreBuildHobHandoffInfoTable (\r | |
622 | IN EFI_BOOT_MODE BootMode,\r | |
623 | IN EFI_PHYSICAL_ADDRESS MemoryBegin,\r | |
624 | IN UINT64 MemoryLength\r | |
625 | )\r | |
192f6d4c | 626 | ;\r |
627 | \r | |
628 | \r | |
629 | //\r | |
630 | // FFS Fw Volume support functions\r | |
631 | //\r | |
b1f6a7c6 | 632 | /**\r |
633 | Given the input file pointer, search for the next matching file in the\r | |
634 | FFS volume as defined by SearchType. The search starts from FileHeader inside\r | |
635 | the Firmware Volume defined by FwVolHeader.\r | |
636 | \r | |
637 | \r | |
638 | @param PeiServices Pointer to the PEI Core Services Table.\r | |
639 | @param SearchType Filter to find only files of this type.\r | |
640 | Type EFI_FV_FILETYPE_ALL causes no filtering to be done.\r | |
641 | @param VolumeHandle Pointer to the FV header of the volume to search.\r | |
642 | @param FileHandle Pointer to the current file from which to begin searching.\r | |
643 | This pointer will be updated upon return to reflect the file found.\r | |
644 | @retval EFI_NOT_FOUND No files matching the search criteria were found\r | |
645 | @retval EFI_SUCCESS Success to find next file in given volume\r | |
646 | \r | |
647 | **/\r | |
192f6d4c | 648 | EFI_STATUS\r |
649 | EFIAPI\r | |
650 | PeiFfsFindNextFile (\r | |
0c2b5da8 | 651 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
192f6d4c | 652 | IN UINT8 SearchType,\r |
0c2b5da8 | 653 | IN EFI_PEI_FV_HANDLE FwVolHeader,\r |
654 | IN OUT EFI_PEI_FILE_HANDLE *FileHeader\r | |
192f6d4c | 655 | )\r |
b1f6a7c6 | 656 | ;\r |
192f6d4c | 657 | \r |
b1f6a7c6 | 658 | /**\r |
659 | Given the input file pointer, search for the next matching section in the\r | |
660 | FFS volume.\r | |
192f6d4c | 661 | \r |
192f6d4c | 662 | \r |
b1f6a7c6 | 663 | @param PeiServices Pointer to the PEI Core Services Table.\r |
664 | @param SectionType Filter to find only sections of this type.\r | |
665 | @param FileHandle Pointer to the current file to search.\r | |
666 | @param SectionData Pointer to the Section matching SectionType in FfsFileHeader.\r | |
667 | NULL if section not found\r | |
192f6d4c | 668 | \r |
b1f6a7c6 | 669 | @retval EFI_NOT_FOUND No files matching the search criteria were found\r |
670 | @retval EFI_SUCCESS Success to find section data in given file\r | |
192f6d4c | 671 | \r |
b1f6a7c6 | 672 | **/\r |
192f6d4c | 673 | EFI_STATUS\r |
674 | EFIAPI\r | |
675 | PeiFfsFindSectionData (\r | |
b0d803fe | 676 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
192f6d4c | 677 | IN EFI_SECTION_TYPE SectionType,\r |
0c2b5da8 | 678 | IN EFI_PEI_FILE_HANDLE FfsFileHeader,\r |
192f6d4c | 679 | IN OUT VOID **SectionData\r |
680 | )\r | |
b1f6a7c6 | 681 | ;\r |
192f6d4c | 682 | \r |
b1f6a7c6 | 683 | /**\r |
684 | search the firmware volumes by index\r | |
192f6d4c | 685 | \r |
b1f6a7c6 | 686 | @param PeiServices The PEI core services table.\r |
687 | @param Instance Instance of FV to find\r | |
688 | @param VolumeHandle Pointer to found Volume.\r | |
192f6d4c | 689 | \r |
b1f6a7c6 | 690 | @retval EFI_INVALID_PARAMETER FwVolHeader is NULL\r |
691 | @retval EFI_SUCCESS Firmware volume instance successfully found.\r | |
192f6d4c | 692 | \r |
b1f6a7c6 | 693 | **/\r |
192f6d4c | 694 | EFI_STATUS\r |
695 | EFIAPI\r | |
696 | PeiFvFindNextVolume (\r | |
0c2b5da8 | 697 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
192f6d4c | 698 | IN UINTN Instance,\r |
0c2b5da8 | 699 | IN OUT EFI_PEI_FV_HANDLE *FwVolHeader\r |
192f6d4c | 700 | )\r |
192f6d4c | 701 | ;\r |
702 | \r | |
703 | //\r | |
704 | // Memory support functions\r | |
705 | //\r | |
b1f6a7c6 | 706 | /**\r |
707 | \r | |
708 | Initialize the memory services.\r | |
709 | \r | |
710 | \r | |
711 | @param PrivateData Add parameter description\r | |
712 | @param SecCoreData Points to a data structure containing information about the PEI core's operating\r | |
713 | environment, such as the size and location of temporary RAM, the stack location and\r | |
714 | the BFV location.\r | |
715 | @param OldCoreData Pointer to the PEI Core data.\r | |
716 | NULL if being run in non-permament memory mode.\r | |
717 | \r | |
718 | **/\r | |
192f6d4c | 719 | VOID\r |
720 | InitializeMemoryServices (\r | |
b0d803fe | 721 | IN PEI_CORE_INSTANCE *PrivateData,\r |
5aae0aa7 | 722 | IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r |
192f6d4c | 723 | IN PEI_CORE_INSTANCE *OldCoreData\r |
724 | )\r | |
b1f6a7c6 | 725 | ;\r |
192f6d4c | 726 | \r |
b1f6a7c6 | 727 | /**\r |
192f6d4c | 728 | \r |
b1f6a7c6 | 729 | Install the permanent memory is now available.\r |
730 | Creates HOB (PHIT and Stack).\r | |
192f6d4c | 731 | \r |
b1f6a7c6 | 732 | @param PeiServices - The PEI core services table.\r |
733 | @param MemoryBegin - Start of memory address.\r | |
734 | @param MemoryLength - Length of memory.\r | |
192f6d4c | 735 | \r |
b1f6a7c6 | 736 | @return EFI_SUCCESS Always success.\r |
192f6d4c | 737 | \r |
b1f6a7c6 | 738 | **/\r |
192f6d4c | 739 | EFI_STATUS\r |
740 | EFIAPI\r | |
741 | PeiInstallPeiMemory (\r | |
0c2b5da8 | 742 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
192f6d4c | 743 | IN EFI_PHYSICAL_ADDRESS MemoryBegin,\r |
744 | IN UINT64 MemoryLength\r | |
745 | )\r | |
b1f6a7c6 | 746 | ;\r |
192f6d4c | 747 | \r |
b1f6a7c6 | 748 | /**\r |
192f6d4c | 749 | \r |
b1f6a7c6 | 750 | Memory allocation service on permanent memory,\r |
751 | not usable prior to the memory installation.\r | |
192f6d4c | 752 | \r |
192f6d4c | 753 | \r |
b1f6a7c6 | 754 | @param PeiServices - The PEI core services table.\r |
755 | @param MemoryType - Type of memory to allocate.\r | |
756 | @param Pages - Number of pages to allocate.\r | |
757 | @param Memory - Pointer of memory allocated.\r | |
192f6d4c | 758 | \r |
b1f6a7c6 | 759 | @retval EFI_SUCCESS The allocation was successful\r |
760 | @retval EFI_INVALID_PARAMETER Only AllocateAnyAddress is supported.\r | |
761 | @retval EFI_NOT_AVAILABLE_YET Called with permanent memory not available\r | |
762 | @retval EFI_OUT_OF_RESOURCES There is not enough HOB heap to satisfy the requirement\r | |
763 | to allocate the number of pages.\r | |
192f6d4c | 764 | \r |
b1f6a7c6 | 765 | **/\r |
192f6d4c | 766 | EFI_STATUS\r |
767 | EFIAPI\r | |
768 | PeiAllocatePages (\r | |
0c2b5da8 | 769 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
192f6d4c | 770 | IN EFI_MEMORY_TYPE MemoryType,\r |
771 | IN UINTN Pages,\r | |
772 | OUT EFI_PHYSICAL_ADDRESS *Memory\r | |
773 | )\r | |
b1f6a7c6 | 774 | ;\r |
192f6d4c | 775 | \r |
b1f6a7c6 | 776 | /**\r |
192f6d4c | 777 | \r |
b1f6a7c6 | 778 | Memory allocation service on the CAR.\r |
192f6d4c | 779 | \r |
192f6d4c | 780 | \r |
b1f6a7c6 | 781 | @param PeiServices - The PEI core services table.\r |
782 | @param Size - Amount of memory required\r | |
783 | @param Buffer - Address of pointer to the buffer\r | |
192f6d4c | 784 | \r |
b1f6a7c6 | 785 | @retval EFI_SUCCESS The allocation was successful\r |
786 | @retval EFI_OUT_OF_RESOURCES There is not enough heap to satisfy the requirement\r | |
787 | to allocate the requested size.\r | |
192f6d4c | 788 | \r |
b1f6a7c6 | 789 | **/\r |
192f6d4c | 790 | EFI_STATUS\r |
791 | EFIAPI\r | |
792 | PeiAllocatePool (\r | |
0c2b5da8 | 793 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
192f6d4c | 794 | IN UINTN Size,\r |
795 | OUT VOID **Buffer\r | |
796 | )\r | |
b1f6a7c6 | 797 | ;\r |
192f6d4c | 798 | \r |
b1f6a7c6 | 799 | /**\r |
192f6d4c | 800 | \r |
b1f6a7c6 | 801 | Routine for load image file.\r |
192f6d4c | 802 | \r |
192f6d4c | 803 | \r |
b1f6a7c6 | 804 | @param PeiServices - The PEI core services table.\r |
805 | @param FileHandle - Pointer to the FFS file header of the image.\r | |
806 | @param EntryPoint - Pointer to entry point of specified image file for output.\r | |
807 | @param AuthenticationState - Pointer to attestation authentication state of image.\r | |
192f6d4c | 808 | \r |
b1f6a7c6 | 809 | @retval EFI_SUCCESS - Image is successfully loaded.\r |
810 | @retval EFI_NOT_FOUND - Fail to locate necessary PPI\r | |
811 | @retval Others - Fail to load file.\r | |
192f6d4c | 812 | \r |
b1f6a7c6 | 813 | **/\r |
192f6d4c | 814 | EFI_STATUS\r |
815 | PeiLoadImage (\r | |
816 | IN EFI_PEI_SERVICES **PeiServices,\r | |
b0d803fe | 817 | IN EFI_PEI_FILE_HANDLE FileHandle,\r |
818 | OUT EFI_PHYSICAL_ADDRESS *EntryPoint,\r | |
819 | OUT UINT32 *AuthenticationState\r | |
192f6d4c | 820 | )\r |
b1f6a7c6 | 821 | ;\r |
192f6d4c | 822 | \r |
b1f6a7c6 | 823 | /**\r |
192f6d4c | 824 | \r |
b1f6a7c6 | 825 | Core version of the Status Code reporter\r |
192f6d4c | 826 | \r |
192f6d4c | 827 | \r |
b1f6a7c6 | 828 | @param PeiServices The PEI core services table.\r |
829 | @param CodeType Type of Status Code.\r | |
830 | @param Value Value to output for Status Code.\r | |
831 | @param Instance Instance Number of this status code.\r | |
832 | @param CallerId ID of the caller of this status code.\r | |
833 | @param Data Optional data associated with this status code.\r | |
192f6d4c | 834 | \r |
b1f6a7c6 | 835 | @retval EFI_SUCCESS if status code is successfully reported\r |
836 | @retval EFI_NOT_AVAILABLE_YET if StatusCodePpi has not been installed\r | |
192f6d4c | 837 | \r |
b1f6a7c6 | 838 | **/\r |
192f6d4c | 839 | EFI_STATUS\r |
840 | EFIAPI\r | |
841 | PeiReportStatusCode (\r | |
0c2b5da8 | 842 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
192f6d4c | 843 | IN EFI_STATUS_CODE_TYPE CodeType,\r |
844 | IN EFI_STATUS_CODE_VALUE Value,\r | |
845 | IN UINT32 Instance,\r | |
0c2b5da8 | 846 | IN CONST EFI_GUID *CallerId,\r |
847 | IN CONST EFI_STATUS_CODE_DATA *Data OPTIONAL\r | |
192f6d4c | 848 | )\r |
b1f6a7c6 | 849 | ;\r |
192f6d4c | 850 | \r |
b1f6a7c6 | 851 | /**\r |
192f6d4c | 852 | \r |
b1f6a7c6 | 853 | Core version of the Reset System\r |
192f6d4c | 854 | \r |
192f6d4c | 855 | \r |
b1f6a7c6 | 856 | @param PeiServices - The PEI core services table.\r |
192f6d4c | 857 | \r |
b1f6a7c6 | 858 | @retval EFI_NOT_AVAILABLE_YET PPI not available yet.\r |
859 | @retval EFI_DEVICE_ERROR Did not reset system.\r | |
860 | Otherwise, resets the system.\r | |
192f6d4c | 861 | \r |
b1f6a7c6 | 862 | **/\r |
192f6d4c | 863 | EFI_STATUS\r |
864 | EFIAPI\r | |
865 | PeiResetSystem (\r | |
b0d803fe | 866 | IN CONST EFI_PEI_SERVICES **PeiServices\r |
192f6d4c | 867 | )\r |
b1f6a7c6 | 868 | ;\r |
192f6d4c | 869 | \r |
b1f6a7c6 | 870 | /**\r |
192f6d4c | 871 | \r |
b1f6a7c6 | 872 | Initialize PeiCore Fv List.\r |
192f6d4c | 873 | \r |
192f6d4c | 874 | \r |
b1f6a7c6 | 875 | @param PrivateData - Pointer to PEI_CORE_INSTANCE.\r |
876 | @param SecCoreData - Pointer to EFI_SEC_PEI_HAND_OFF.\r | |
192f6d4c | 877 | \r |
b1f6a7c6 | 878 | @return NONE\r |
192f6d4c | 879 | \r |
b1f6a7c6 | 880 | **/\r |
50cb16d9 | 881 | VOID\r |
b0d803fe | 882 | PeiInitializeFv (\r |
883 | IN PEI_CORE_INSTANCE *PrivateData,\r | |
884 | IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData\r | |
885 | )\r | |
b1f6a7c6 | 886 | ;\r |
b0d803fe | 887 | \r |
b1f6a7c6 | 888 | /**\r |
889 | Process Firmware Volum Information once FvInfoPPI install.\r | |
b0d803fe | 890 | \r |
b0d803fe | 891 | \r |
b1f6a7c6 | 892 | @param PeiServices - General purpose services available to every PEIM.\r |
893 | @param NotifyDescriptor EDES_TODO: Add parameter description\r | |
894 | @param Ppi EDES_TODO: Add parameter description\r | |
50cb16d9 | 895 | \r |
b1f6a7c6 | 896 | @retval EFI_SUCCESS if the interface could be successfully installed\r |
b0d803fe | 897 | \r |
b1f6a7c6 | 898 | **/\r |
b0d803fe | 899 | EFI_STATUS\r |
900 | EFIAPI\r | |
901 | FirmwareVolmeInfoPpiNotifyCallback (\r | |
902 | IN EFI_PEI_SERVICES **PeiServices,\r | |
903 | IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor,\r | |
904 | IN VOID *Ppi\r | |
905 | )\r | |
b1f6a7c6 | 906 | ;\r |
b0d803fe | 907 | \r |
b1f6a7c6 | 908 | /**\r |
50cb16d9 | 909 | \r |
b1f6a7c6 | 910 | Given the input VolumeHandle, search for the next matching name file.\r |
b0d803fe | 911 | \r |
b0d803fe | 912 | \r |
b1f6a7c6 | 913 | @param FileName - File name to search.\r |
914 | @param VolumeHandle - The current FV to search.\r | |
915 | @param FileHandle - Pointer to the file matching name in VolumeHandle.\r | |
916 | - NULL if file not found\r | |
b0d803fe | 917 | \r |
b1f6a7c6 | 918 | @return EFI_STATUS\r |
b0d803fe | 919 | \r |
b1f6a7c6 | 920 | **/\r |
b0d803fe | 921 | EFI_STATUS\r |
50cb16d9 | 922 | EFIAPI\r |
b0d803fe | 923 | PeiFfsFindFileByName (\r |
924 | IN CONST EFI_GUID *FileName,\r | |
925 | IN EFI_PEI_FV_HANDLE VolumeHandle,\r | |
926 | OUT EFI_PEI_FILE_HANDLE *FileHandle\r | |
927 | )\r | |
b1f6a7c6 | 928 | ;\r |
b0d803fe | 929 | \r |
b1f6a7c6 | 930 | /**\r |
b0d803fe | 931 | \r |
b1f6a7c6 | 932 | Returns information about a specific file.\r |
b0d803fe | 933 | \r |
b0d803fe | 934 | \r |
b1f6a7c6 | 935 | @param FileHandle - The handle to file.\r |
936 | @param FileInfo - Pointer to the file information.\r | |
b0d803fe | 937 | \r |
b1f6a7c6 | 938 | @retval EFI_INVALID_PARAMETER Invalid FileHandle or FileInfo.\r |
939 | @retval EFI_SUCCESS Success to collect file info.\r | |
b0d803fe | 940 | \r |
b1f6a7c6 | 941 | **/\r |
b0d803fe | 942 | EFI_STATUS\r |
50cb16d9 | 943 | EFIAPI\r |
b0d803fe | 944 | PeiFfsGetFileInfo (\r |
945 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
946 | OUT EFI_FV_FILE_INFO *FileInfo\r | |
947 | )\r | |
b1f6a7c6 | 948 | ;\r |
b0d803fe | 949 | \r |
b1f6a7c6 | 950 | /**\r |
b0d803fe | 951 | \r |
b1f6a7c6 | 952 | Collect information of given Fv Volume.\r |
b0d803fe | 953 | \r |
b1f6a7c6 | 954 | @param VolumeHandle - The handle to Fv Volume.\r |
955 | @param VolumeInfo - The pointer to volume information.\r | |
b0d803fe | 956 | \r |
b1f6a7c6 | 957 | @retval EFI_INVALID_PARAMETER VolumeInfo is NULL\r |
958 | @retval EFI_SUCCESS Success to collect fv info.\r | |
959 | **/\r | |
b0d803fe | 960 | EFI_STATUS\r |
50cb16d9 | 961 | EFIAPI\r |
b0d803fe | 962 | PeiFfsGetVolumeInfo (\r |
963 | IN EFI_PEI_FV_HANDLE VolumeHandle,\r | |
964 | OUT EFI_FV_INFO *VolumeInfo\r | |
965 | )\r | |
b0d803fe | 966 | ;\r |
967 | \r | |
14e8823a | 968 | /**\r |
969 | This routine enable a PEIM to register itself to shadow when PEI Foundation\r | |
970 | discovery permanent memory.\r | |
971 | \r | |
b1f6a7c6 | 972 | @param FileHandle File handle of a PEIM.\r |
50cb16d9 | 973 | \r |
b1f6a7c6 | 974 | @retval EFI_NOT_FOUND The file handle doesn't point to PEIM itself.\r |
975 | @retval EFI_ALREADY_STARTED Indicate that the PEIM has been registered itself.\r | |
976 | @retval EFI_SUCCESS Successfully to register itself.\r | |
14e8823a | 977 | \r |
50cb16d9 | 978 | **/\r |
14e8823a | 979 | EFI_STATUS\r |
980 | EFIAPI\r | |
981 | PeiRegisterForShadow (\r | |
982 | IN EFI_PEI_FILE_HANDLE FileHandle\r | |
983 | )\r | |
984 | ;\r | |
985 | \r | |
b1f6a7c6 | 986 | /**\r |
987 | Given the input file pointer, search for the next matching file in the\r | |
988 | FFS volume as defined by SearchType. The search starts from FileHeader inside\r | |
989 | the Firmware Volume defined by FwVolHeader.\r | |
990 | \r | |
991 | \r | |
992 | @param FvHandle Pointer to the FV header of the volume to search\r | |
993 | @param FileName File name\r | |
994 | @param SearchType Filter to find only files of this type.\r | |
995 | Type EFI_FV_FILETYPE_ALL causes no filtering to be done.\r | |
996 | @param FileHandle This parameter must point to a valid FFS volume.\r | |
997 | @param AprioriFile Pointer to AprioriFile image in this FV if has\r | |
998 | \r | |
999 | @return EFI_NOT_FOUND No files matching the search criteria were found\r | |
1000 | @retval EFI_SUCCESS Success to search given file\r | |
1001 | \r | |
1002 | **/\r | |
b0d803fe | 1003 | EFI_STATUS\r |
1004 | PeiFindFileEx (\r | |
1005 | IN CONST EFI_PEI_FV_HANDLE FvHandle,\r | |
1006 | IN CONST EFI_GUID *FileName, OPTIONAL\r | |
1007 | IN EFI_FV_FILETYPE SearchType,\r | |
1008 | IN OUT EFI_PEI_FILE_HANDLE *FileHandle,\r | |
1009 | IN OUT EFI_PEI_FV_HANDLE *AprioriFile OPTIONAL\r | |
1010 | )\r | |
b0d803fe | 1011 | ;\r |
1012 | \r | |
b1f6a7c6 | 1013 | /**\r |
b0d803fe | 1014 | \r |
c58cf83d | 1015 | Install Pei Load File PPI.\r |
b0d803fe | 1016 | \r |
b0d803fe | 1017 | \r |
b1f6a7c6 | 1018 | @param PrivateData - Pointer to PEI_CORE_INSTANCE.\r |
1019 | @param OldCoreData - Pointer to PEI_CORE_INSTANCE.\r | |
b0d803fe | 1020 | \r |
b1f6a7c6 | 1021 | **/\r |
1022 | VOID\r | |
1023 | InitializeImageServices (\r | |
1024 | IN PEI_CORE_INSTANCE *PrivateData,\r | |
1025 | IN PEI_CORE_INSTANCE *OldCoreData\r | |
1026 | )\r | |
b0d803fe | 1027 | ;\r |
1028 | \r | |
288f9b38 LG |
1029 | /**\r |
1030 | Get Fv image from the FV type file, then install FV INFO ppi, Build FV hob.\r | |
1031 | \r | |
b1f6a7c6 | 1032 | @param PeiServices Pointer to the PEI Core Services Table.\r |
1033 | @param FileHandle File handle of a Fv type file.\r | |
288f9b38 LG |
1034 | @param AuthenticationState Pointer to attestation authentication state of image.\r |
1035 | \r | |
50cb16d9 | 1036 | \r |
b1f6a7c6 | 1037 | @retval EFI_NOT_FOUND FV image can't be found.\r |
1038 | @retval EFI_SUCCESS Successfully to process it.\r | |
288f9b38 LG |
1039 | \r |
1040 | **/\r | |
1041 | EFI_STATUS\r | |
1042 | ProcessFvFile (\r | |
1043 | IN EFI_PEI_SERVICES **PeiServices,\r | |
1044 | IN EFI_PEI_FILE_HANDLE FvFileHandle,\r | |
1045 | OUT UINT32 *AuthenticationState\r | |
1046 | );\r | |
1047 | \r | |
192f6d4c | 1048 | #endif\r |