]>
Commit | Line | Data |
---|---|---|
fb3df220 | 1 | /** @file\r |
50a64e5b | 2 | Provides library functions for all PEI Services.\r |
fb3df220 | 3 | \r |
ced8f52f | 4 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r |
9df063a0 | 5 | This program and the accompanying materials\r |
50a64e5b | 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 | |
fb3df220 | 9 | \r |
50a64e5b | 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 | |
fb3df220 | 12 | \r |
fb3df220 | 13 | **/\r |
14 | \r | |
15 | #ifndef __PEI_SERVICES_LIB_H__\r | |
16 | #define __PEI_SERVICES_LIB_H__\r | |
17 | \r | |
18 | /**\r | |
122e2191 | 19 | This service enables a given PEIM to register an interface into the PEI Foundation.\r |
fb3df220 | 20 | \r |
21 | @param PpiList A pointer to the list of interfaces that the caller shall install.\r | |
22 | \r | |
23 | @retval EFI_SUCCESS The interface was successfully installed.\r | |
24 | @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL.\r | |
25 | @retval EFI_INVALID_PARAMETER Any of the PEI PPI descriptors in the list do not have the\r | |
26 | EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r | |
27 | @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r | |
28 | \r | |
29 | **/\r | |
30 | EFI_STATUS\r | |
31 | EFIAPI\r | |
32 | PeiServicesInstallPpi (\r | |
1c280088 | 33 | IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList\r |
fb3df220 | 34 | );\r |
35 | \r | |
36 | /**\r | |
37 | This service enables PEIMs to replace an entry in the PPI database with an alternate entry.\r | |
38 | \r | |
39 | @param OldPpi Pointer to the old PEI PPI Descriptors.\r | |
40 | @param NewPpi Pointer to the new PEI PPI Descriptors.\r | |
41 | \r | |
42 | @retval EFI_SUCCESS The interface was successfully installed.\r | |
43 | @retval EFI_INVALID_PARAMETER The OldPpi or NewPpi is NULL.\r | |
44 | @retval EFI_INVALID_PARAMETER Any of the PEI PPI descriptors in the list do not have the\r | |
45 | EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.\r | |
46 | @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r | |
47 | @retval EFI_NOT_FOUND The PPI for which the reinstallation was requested has not been\r | |
48 | installed.\r | |
49 | \r | |
50 | **/\r | |
51 | EFI_STATUS\r | |
52 | EFIAPI\r | |
53 | PeiServicesReInstallPpi (\r | |
1c280088 | 54 | IN CONST EFI_PEI_PPI_DESCRIPTOR *OldPpi,\r |
55 | IN CONST EFI_PEI_PPI_DESCRIPTOR *NewPpi\r | |
fb3df220 | 56 | );\r |
57 | \r | |
58 | /**\r | |
59 | This service enables PEIMs to discover a given instance of an interface.\r | |
60 | \r | |
61 | @param Guid A pointer to the GUID whose corresponding interface needs to be\r | |
62 | found.\r | |
63 | @param Instance The N-th instance of the interface that is required.\r | |
64 | @param PpiDescriptor A pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.\r | |
65 | @param Ppi A pointer to the instance of the interface.\r | |
66 | \r | |
67 | @retval EFI_SUCCESS The interface was successfully returned.\r | |
68 | @retval EFI_NOT_FOUND The PPI descriptor is not found in the database.\r | |
69 | \r | |
70 | **/\r | |
71 | EFI_STATUS\r | |
72 | EFIAPI\r | |
73 | PeiServicesLocatePpi (\r | |
1c280088 | 74 | IN CONST EFI_GUID *Guid,\r |
fb3df220 | 75 | IN UINTN Instance,\r |
ced8f52f | 76 | IN OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor, OPTIONAL\r |
fb3df220 | 77 | IN OUT VOID **Ppi\r |
78 | );\r | |
79 | \r | |
80 | /**\r | |
81 | This service enables PEIMs to register a given service to be invoked when another service is\r | |
82 | installed or reinstalled.\r | |
83 | \r | |
84 | @param NotifyList A pointer to the list of notification interfaces that the caller\r | |
85 | shall install.\r | |
86 | \r | |
87 | @retval EFI_SUCCESS The interface was successfully installed.\r | |
88 | @retval EFI_INVALID_PARAMETER The NotifyList pointer is NULL.\r | |
89 | @retval EFI_INVALID_PARAMETER Any of the PEI notify descriptors in the list do not have the\r | |
90 | EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES bit set in the Flags field.\r | |
91 | @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.\r | |
92 | \r | |
93 | **/\r | |
94 | EFI_STATUS\r | |
95 | EFIAPI\r | |
96 | PeiServicesNotifyPpi (\r | |
1c280088 | 97 | IN CONST EFI_PEI_NOTIFY_DESCRIPTOR *NotifyList\r |
fb3df220 | 98 | );\r |
99 | \r | |
100 | /**\r | |
122e2191 | 101 | This service enables PEIMs to ascertain the present value of the boot mode.\r |
fb3df220 | 102 | \r |
103 | @param BootMode A pointer to contain the value of the boot mode.\r | |
104 | \r | |
105 | @retval EFI_SUCCESS The boot mode was returned successfully.\r | |
106 | @retval EFI_INVALID_PARAMETER BootMode is NULL.\r | |
107 | \r | |
108 | **/\r | |
109 | EFI_STATUS\r | |
110 | EFIAPI\r | |
111 | PeiServicesGetBootMode (\r | |
c3363c92 | 112 | OUT EFI_BOOT_MODE *BootMode\r |
fb3df220 | 113 | );\r |
114 | \r | |
115 | /**\r | |
122e2191 | 116 | This service enables PEIMs to update the boot mode variable.\r |
fb3df220 | 117 | \r |
118 | @param BootMode The value of the boot mode to set.\r | |
119 | \r | |
120 | @retval EFI_SUCCESS The value was successfully updated\r | |
121 | \r | |
122 | **/\r | |
123 | EFI_STATUS\r | |
124 | EFIAPI\r | |
125 | PeiServicesSetBootMode (\r | |
126 | IN EFI_BOOT_MODE BootMode\r | |
127 | );\r | |
128 | \r | |
129 | /**\r | |
130 | This service enables a PEIM to ascertain the address of the list of HOBs in memory.\r | |
131 | \r | |
132 | @param HobList A pointer to the list of HOBs that the PEI Foundation will initialize.\r | |
133 | \r | |
134 | @retval EFI_SUCCESS The list was successfully returned.\r | |
135 | @retval EFI_NOT_AVAILABLE_YET The HOB list is not yet published.\r | |
136 | \r | |
137 | **/\r | |
138 | EFI_STATUS\r | |
139 | EFIAPI\r | |
140 | PeiServicesGetHobList (\r | |
67c89a21 | 141 | OUT VOID **HobList\r |
fb3df220 | 142 | );\r |
143 | \r | |
144 | /**\r | |
145 | This service enables PEIMs to create various types of HOBs.\r | |
146 | \r | |
147 | @param Type The type of HOB to be installed.\r | |
148 | @param Length The length of the HOB to be added.\r | |
149 | @param Hob The address of a pointer that will contain the HOB header.\r | |
150 | \r | |
151 | @retval EFI_SUCCESS The HOB was successfully created.\r | |
152 | @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.\r | |
153 | \r | |
154 | **/\r | |
155 | EFI_STATUS\r | |
156 | EFIAPI\r | |
157 | PeiServicesCreateHob (\r | |
158 | IN UINT16 Type,\r | |
159 | IN UINT16 Length,\r | |
67c89a21 | 160 | OUT VOID **Hob\r |
fb3df220 | 161 | );\r |
162 | \r | |
163 | /**\r | |
164 | This service enables PEIMs to discover additional firmware volumes.\r | |
165 | \r | |
166 | @param Instance This instance of the firmware volume to find. The value 0 is the\r | |
167 | Boot Firmware Volume (BFV).\r | |
122e2191 | 168 | @param VolumeHandle Handle of the firmware volume header of the volume to return.\r |
fb3df220 | 169 | \r |
170 | @retval EFI_SUCCESS The volume was found.\r | |
171 | @retval EFI_NOT_FOUND The volume was not found.\r | |
172 | @retval EFI_INVALID_PARAMETER FwVolHeader is NULL.\r | |
173 | \r | |
174 | **/\r | |
175 | EFI_STATUS\r | |
176 | EFIAPI\r | |
177 | PeiServicesFfsFindNextVolume (\r | |
178 | IN UINTN Instance,\r | |
1c280088 | 179 | IN OUT EFI_PEI_FV_HANDLE *VolumeHandle\r |
fb3df220 | 180 | );\r |
181 | \r | |
182 | /**\r | |
183 | This service enables PEIMs to discover additional firmware files.\r | |
184 | \r | |
185 | @param SearchType A filter to find files only of this type.\r | |
01aef47b | 186 | @param VolumeHandle Pointer to the firmware volume header of the volume to search.\r |
fb3df220 | 187 | This parameter must point to a valid FFS volume.\r |
122e2191 | 188 | @param FileHandle Handle of the current file from which to begin searching.\r |
fb3df220 | 189 | \r |
190 | @retval EFI_SUCCESS The file was found.\r | |
191 | @retval EFI_NOT_FOUND The file was not found.\r | |
192 | @retval EFI_NOT_FOUND The header checksum was not zero.\r | |
193 | \r | |
194 | **/\r | |
195 | EFI_STATUS\r | |
196 | EFIAPI\r | |
197 | PeiServicesFfsFindNextFile (\r | |
198 | IN EFI_FV_FILETYPE SearchType,\r | |
1c280088 | 199 | IN EFI_PEI_FV_HANDLE VolumeHandle,\r |
200 | IN OUT EFI_PEI_FILE_HANDLE *FileHandle\r | |
fb3df220 | 201 | );\r |
202 | \r | |
203 | /**\r | |
204 | This service enables PEIMs to discover sections of a given type within a valid FFS file.\r | |
205 | \r | |
01aef47b | 206 | @param SectionType The value of the section type to find.\r |
207 | @param FileHandle A pointer to the file header that contains the set of sections to\r | |
fb3df220 | 208 | be searched.\r |
209 | @param SectionData A pointer to the discovered section, if successful.\r | |
210 | \r | |
211 | @retval EFI_SUCCESS The section was found.\r | |
212 | @retval EFI_NOT_FOUND The section was not found.\r | |
213 | \r | |
214 | **/\r | |
215 | EFI_STATUS\r | |
216 | EFIAPI\r | |
217 | PeiServicesFfsFindSectionData (\r | |
218 | IN EFI_SECTION_TYPE SectionType,\r | |
1c280088 | 219 | IN EFI_PEI_FILE_HANDLE FileHandle,\r |
67c89a21 | 220 | OUT VOID **SectionData\r |
fb3df220 | 221 | );\r |
222 | \r | |
c7935105 SZ |
223 | /**\r |
224 | This service enables PEIMs to discover sections of a given instance and type within a valid FFS file.\r | |
225 | \r | |
226 | @param SectionType The value of the section type to find.\r | |
227 | @param SectionInstance Section instance to find.\r | |
9095d37b | 228 | @param FileHandle A pointer to the file header that contains the set\r |
c7935105 SZ |
229 | of sections to be searched.\r |
230 | @param SectionData A pointer to the discovered section, if successful.\r | |
231 | @param AuthenticationStatus A pointer to the authentication status for this section.\r | |
232 | \r | |
233 | @retval EFI_SUCCESS The section was found.\r | |
234 | @retval EFI_NOT_FOUND The section was not found.\r | |
235 | \r | |
236 | **/\r | |
237 | EFI_STATUS\r | |
238 | EFIAPI\r | |
239 | PeiServicesFfsFindSectionData3 (\r | |
240 | IN EFI_SECTION_TYPE SectionType,\r | |
241 | IN UINTN SectionInstance,\r | |
242 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
243 | OUT VOID **SectionData,\r | |
244 | OUT UINT32 *AuthenticationStatus\r | |
245 | );\r | |
246 | \r | |
fb3df220 | 247 | /**\r |
248 | This service enables PEIMs to register the permanent memory configuration\r | |
249 | that has been initialized with the PEI Foundation.\r | |
250 | \r | |
251 | @param MemoryBegin The value of a region of installed memory.\r | |
252 | @param MemoryLength The corresponding length of a region of installed memory.\r | |
253 | \r | |
254 | @retval EFI_SUCCESS The region was successfully installed in a HOB.\r | |
255 | @retval EFI_INVALID_PARAMETER MemoryBegin and MemoryLength are illegal for this system.\r | |
256 | @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.\r | |
257 | \r | |
258 | **/\r | |
259 | EFI_STATUS\r | |
260 | EFIAPI\r | |
261 | PeiServicesInstallPeiMemory (\r | |
262 | IN EFI_PHYSICAL_ADDRESS MemoryBegin,\r | |
263 | IN UINT64 MemoryLength\r | |
264 | );\r | |
265 | \r | |
266 | /**\r | |
3f315ecd | 267 | This service enables PEIMs to allocate memory.\r |
fb3df220 | 268 | \r |
269 | @param MemoryType Type of memory to allocate.\r | |
3f315ecd | 270 | @param Pages The number of pages to allocate.\r |
fb3df220 | 271 | @param Memory Pointer of memory allocated.\r |
272 | \r | |
273 | @retval EFI_SUCCESS The memory range was successfully allocated.\r | |
3f315ecd SZ |
274 | @retval EFI_INVALID_PARAMETER Type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode,\r |
275 | EfiRuntimeServicesData, EfiBootServicesCode, EfiBootServicesData,\r | |
276 | EfiACPIReclaimMemory, EfiReservedMemoryType, or EfiACPIMemoryNVS.\r | |
fb3df220 | 277 | @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.\r |
278 | \r | |
279 | **/\r | |
280 | EFI_STATUS\r | |
281 | EFIAPI\r | |
282 | PeiServicesAllocatePages (\r | |
283 | IN EFI_MEMORY_TYPE MemoryType,\r | |
284 | IN UINTN Pages,\r | |
67c89a21 | 285 | OUT EFI_PHYSICAL_ADDRESS *Memory\r |
fb3df220 | 286 | );\r |
287 | \r | |
3f315ecd SZ |
288 | /**\r |
289 | This service enables PEIMs to free memory.\r | |
290 | \r | |
291 | @param Memory Memory to be freed.\r | |
292 | @param Pages The number of pages to free.\r | |
293 | \r | |
294 | @retval EFI_SUCCESS The requested pages were freed.\r | |
295 | @retval EFI_INVALID_PARAMETER Memory is not a page-aligned address or Pages is invalid.\r | |
296 | @retval EFI_NOT_FOUND The requested memory pages were not allocated with\r | |
297 | AllocatePages().\r | |
298 | \r | |
299 | **/\r | |
300 | EFI_STATUS\r | |
301 | EFIAPI\r | |
302 | PeiServicesFreePages (\r | |
303 | IN EFI_PHYSICAL_ADDRESS Memory,\r | |
304 | IN UINTN Pages\r | |
305 | );\r | |
306 | \r | |
fb3df220 | 307 | /**\r |
308 | This service allocates memory from the Hand-Off Block (HOB) heap.\r | |
309 | \r | |
310 | @param Size The number of bytes to allocate from the pool.\r | |
311 | @param Buffer If the call succeeds, a pointer to a pointer to the allocate\r | |
312 | buffer; undefined otherwise.\r | |
313 | \r | |
314 | @retval EFI_SUCCESS The allocation was successful\r | |
315 | @retval EFI_OUT_OF_RESOURCES There is not enough heap to allocate the requested size.\r | |
316 | \r | |
317 | **/\r | |
318 | EFI_STATUS\r | |
319 | EFIAPI\r | |
320 | PeiServicesAllocatePool (\r | |
321 | IN UINTN Size,\r | |
322 | OUT VOID **Buffer\r | |
323 | );\r | |
324 | \r | |
325 | /**\r | |
67c89a21 | 326 | Resets the entire platform.\r |
fb3df220 | 327 | \r |
67c89a21 | 328 | @retval EFI_SUCCESS The function completed successfully.\r |
fb3df220 | 329 | @retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.\r |
330 | \r | |
331 | **/\r | |
332 | EFI_STATUS\r | |
333 | EFIAPI\r | |
334 | PeiServicesResetSystem (\r | |
335 | VOID\r | |
336 | );\r | |
337 | \r | |
338 | \r | |
67c89a21 | 339 | /**\r |
9095d37b LG |
340 | This service is a wrapper for the PEI Service FfsFindByName(), except the pointer to the PEI Services\r |
341 | Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface\r | |
342 | Specification for details.\r | |
67c89a21 | 343 | \r |
344 | @param FileName A pointer to the name of the file to\r | |
345 | find within the firmware volume.\r | |
346 | \r | |
347 | @param VolumeHandle The firmware volume to search FileHandle\r | |
348 | Upon exit, points to the found file's\r | |
349 | handle or NULL if it could not be found.\r | |
9095d37b | 350 | @param FileHandle Pointer to found file handle\r |
67c89a21 | 351 | \r |
352 | @retval EFI_SUCCESS File was found.\r | |
353 | \r | |
354 | @retval EFI_NOT_FOUND File was not found.\r | |
355 | \r | |
356 | @retval EFI_INVALID_PARAMETER VolumeHandle or FileHandle or\r | |
357 | FileName was NULL.\r | |
358 | \r | |
359 | **/\r | |
b0d803fe | 360 | EFI_STATUS\r |
361 | EFIAPI\r | |
98db57b0 | 362 | PeiServicesFfsFindFileByName (\r |
b0d803fe | 363 | IN CONST EFI_GUID *FileName,\r |
364 | IN CONST EFI_PEI_FV_HANDLE VolumeHandle,\r | |
365 | OUT EFI_PEI_FILE_HANDLE *FileHandle\r | |
366 | );\r | |
367 | \r | |
368 | \r | |
67c89a21 | 369 | /**\r |
9095d37b LG |
370 | This service is a wrapper for the PEI Service FfsGetFileInfo(), except the pointer to the PEI Services\r |
371 | Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface\r | |
372 | Specification for details.\r | |
67c89a21 | 373 | \r |
374 | @param FileHandle Handle of the file.\r | |
375 | \r | |
376 | @param FileInfo Upon exit, points to the file's\r | |
377 | information.\r | |
378 | \r | |
379 | @retval EFI_SUCCESS File information returned.\r | |
9095d37b | 380 | \r |
67c89a21 | 381 | @retval EFI_INVALID_PARAMETER If FileHandle does not\r |
382 | represent a valid file.\r | |
9095d37b | 383 | \r |
67c89a21 | 384 | @retval EFI_INVALID_PARAMETER If FileInfo is NULL.\r |
9095d37b | 385 | \r |
67c89a21 | 386 | **/\r |
b0d803fe | 387 | EFI_STATUS\r |
9095d37b | 388 | EFIAPI\r |
b0d803fe | 389 | PeiServicesFfsGetFileInfo (\r |
390 | IN CONST EFI_PEI_FILE_HANDLE FileHandle,\r | |
391 | OUT EFI_FV_FILE_INFO *FileInfo\r | |
392 | );\r | |
393 | \r | |
c7935105 SZ |
394 | /**\r |
395 | This service is a wrapper for the PEI Service FfsGetFileInfo2(), except the pointer to the PEI Services\r | |
396 | Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface\r | |
397 | Specification for details.\r | |
398 | \r | |
399 | @param FileHandle Handle of the file.\r | |
400 | \r | |
401 | @param FileInfo Upon exit, points to the file's\r | |
402 | information.\r | |
403 | \r | |
404 | @retval EFI_SUCCESS File information returned.\r | |
9095d37b | 405 | \r |
c7935105 SZ |
406 | @retval EFI_INVALID_PARAMETER If FileHandle does not\r |
407 | represent a valid file.\r | |
9095d37b | 408 | \r |
c7935105 | 409 | @retval EFI_INVALID_PARAMETER If FileInfo is NULL.\r |
9095d37b | 410 | \r |
c7935105 SZ |
411 | **/\r |
412 | EFI_STATUS\r | |
413 | EFIAPI\r | |
414 | PeiServicesFfsGetFileInfo2 (\r | |
415 | IN CONST EFI_PEI_FILE_HANDLE FileHandle,\r | |
416 | OUT EFI_FV_FILE_INFO2 *FileInfo\r | |
417 | );\r | |
418 | \r | |
67c89a21 | 419 | /**\r |
9095d37b LG |
420 | This service is a wrapper for the PEI Service FfsGetVolumeInfo(), except the pointer to the PEI Services\r |
421 | Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface\r | |
422 | Specification for details.\r | |
67c89a21 | 423 | \r |
424 | @param VolumeHandle Handle of the volume.\r | |
425 | \r | |
426 | @param VolumeInfo Upon exit, points to the volume's\r | |
427 | information.\r | |
428 | \r | |
429 | @retval EFI_SUCCESS File information returned.\r | |
9095d37b | 430 | \r |
67c89a21 | 431 | @retval EFI_INVALID_PARAMETER If FileHandle does not\r |
432 | represent a valid file.\r | |
9095d37b | 433 | \r |
67c89a21 | 434 | @retval EFI_INVALID_PARAMETER If FileInfo is NULL.\r |
435 | \r | |
436 | **/\r | |
b0d803fe | 437 | EFI_STATUS\r |
438 | EFIAPI\r | |
439 | PeiServicesFfsGetVolumeInfo (\r | |
440 | IN EFI_PEI_FV_HANDLE VolumeHandle,\r | |
441 | OUT EFI_FV_INFO *VolumeInfo\r | |
442 | );\r | |
443 | \r | |
444 | \r | |
67c89a21 | 445 | /**\r |
9095d37b LG |
446 | This service is a wrapper for the PEI Service RegisterForShadow(), except the pointer to the PEI Services\r |
447 | Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface\r | |
448 | Specification for details.\r | |
67c89a21 | 449 | \r |
450 | @param FileHandle PEIM's file handle. Must be the currently\r | |
451 | executing PEIM.\r | |
9095d37b | 452 | \r |
67c89a21 | 453 | @retval EFI_SUCCESS The PEIM was successfully registered for\r |
454 | shadowing.\r | |
455 | \r | |
456 | @retval EFI_ALREADY_STARTED The PEIM was previously\r | |
457 | registered for shadowing.\r | |
458 | \r | |
459 | @retval EFI_NOT_FOUND The FileHandle does not refer to a\r | |
460 | valid file handle.\r | |
461 | **/\r | |
b0d803fe | 462 | EFI_STATUS\r |
463 | EFIAPI\r | |
464 | PeiServicesRegisterForShadow (\r | |
465 | IN EFI_PEI_FILE_HANDLE FileHandle\r | |
466 | );\r | |
467 | \r | |
f26f70ad | 468 | /**\r |
b75a165d | 469 | Install a EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance so the PEI Core will be notified about a new firmware volume.\r |
9095d37b LG |
470 | \r |
471 | This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO_PPI using\r | |
b75a165d LG |
472 | the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance.\r |
473 | If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO_PPI, then ASSERT().\r | |
474 | If the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI can not be installed, then ASSERT().\r | |
475 | \r | |
9095d37b | 476 | \r |
b75a165d | 477 | @param FvFormat Unique identifier of the format of the memory-mapped firmware volume.\r |
9095d37b | 478 | This parameter is optional and may be NULL.\r |
b75a165d | 479 | If NULL is specified, the EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed.\r |
9095d37b LG |
480 | @param FvInfo Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume.\r |
481 | The format of this buffer is specific to the FvFormat. For memory-mapped firmware volumes,\r | |
b75a165d | 482 | this typically points to the first byte of the firmware volume.\r |
9095d37b | 483 | @param FvInfoSize The size, in bytes, of FvInfo. For memory-mapped firmware volumes,\r |
b75a165d | 484 | this is typically the size of the firmware volume.\r |
9095d37b | 485 | @param ParentFvName If the new firmware volume originated from a file in a different firmware volume,\r |
b75a165d LG |
486 | then this parameter specifies the GUID name of the originating firmware volume.\r |
487 | Otherwise, this parameter must be NULL.\r | |
9095d37b | 488 | @param ParentFileName If the new firmware volume originated from a file in a different firmware volume,\r |
b75a165d LG |
489 | then this parameter specifies the GUID file name of the originating firmware file.\r |
490 | Otherwise, this parameter must be NULL.\r | |
f26f70ad | 491 | **/\r |
492 | VOID\r | |
493 | EFIAPI\r | |
494 | PeiServicesInstallFvInfoPpi (\r | |
495 | IN CONST EFI_GUID *FvFormat, OPTIONAL\r | |
496 | IN CONST VOID *FvInfo,\r | |
497 | IN UINT32 FvInfoSize,\r | |
498 | IN CONST EFI_GUID *ParentFvName, OPTIONAL\r | |
499 | IN CONST EFI_GUID *ParentFileName OPTIONAL\r | |
500 | );\r | |
b0d803fe | 501 | \r |
c7935105 SZ |
502 | /**\r |
503 | Install a EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI instance so the PEI Core will be notified about a new firmware volume.\r | |
504 | \r | |
505 | This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI using\r | |
506 | the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI instance.\r | |
507 | If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI, then ASSERT().\r | |
508 | If the EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI can not be installed, then ASSERT().\r | |
509 | \r | |
510 | @param FvFormat Unique identifier of the format of the memory-mapped\r | |
511 | firmware volume. This parameter is optional and\r | |
512 | may be NULL. If NULL is specified, the\r | |
513 | EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed.\r | |
514 | @param FvInfo Points to a buffer which allows the\r | |
515 | EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume.\r | |
516 | The format of this buffer is specific to the FvFormat.\r | |
517 | For memory-mapped firmware volumes, this typically\r | |
518 | points to the first byte of the firmware volume.\r | |
519 | @param FvInfoSize The size, in bytes, of FvInfo. For memory-mapped\r | |
520 | firmware volumes, this is typically the size of\r | |
521 | the firmware volume.\r | |
522 | @param ParentFvName If the new firmware volume originated from a file\r | |
523 | in a different firmware volume, then this parameter\r | |
524 | specifies the GUID name of the originating firmware\r | |
525 | volume. Otherwise, this parameter must be NULL.\r | |
526 | @param ParentFileName If the new firmware volume originated from a file\r | |
527 | in a different firmware volume, then this parameter\r | |
528 | specifies the GUID file name of the originating\r | |
529 | firmware file. Otherwise, this parameter must be NULL.\r | |
530 | @param AuthenticationStatus Authentication Status\r | |
531 | **/\r | |
532 | VOID\r | |
533 | EFIAPI\r | |
534 | PeiServicesInstallFvInfo2Ppi (\r | |
535 | IN CONST EFI_GUID *FvFormat, OPTIONAL\r | |
536 | IN CONST VOID *FvInfo,\r | |
537 | IN UINT32 FvInfoSize,\r | |
538 | IN CONST EFI_GUID *ParentFvName, OPTIONAL\r | |
539 | IN CONST EFI_GUID *ParentFileName, OPTIONAL\r | |
540 | IN UINT32 AuthenticationStatus\r | |
541 | );\r | |
542 | \r | |
dacf87e8 MK |
543 | /**\r |
544 | Resets the entire platform.\r | |
545 | \r | |
546 | @param[in] ResetType The type of reset to perform.\r | |
547 | @param[in] ResetStatus The status code for the reset.\r | |
548 | @param[in] DataSize The size, in bytes, of ResetData.\r | |
549 | @param[in] ResetData For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown\r | |
550 | the data buffer starts with a Null-terminated string, optionally\r | |
551 | followed by additional binary data. The string is a description\r | |
552 | that the caller may use to further indicate the reason for the\r | |
553 | system reset. ResetData is only valid if ResetStatus is something\r | |
554 | other than EFI_SUCCESS unless the ResetType is EfiResetPlatformSpecific\r | |
555 | where a minimum amount of ResetData is always required.\r | |
556 | \r | |
557 | **/\r | |
558 | VOID\r | |
559 | EFIAPI\r | |
560 | PeiServicesResetSystem2 (\r | |
561 | IN EFI_RESET_TYPE ResetType,\r | |
562 | IN EFI_STATUS ResetStatus,\r | |
563 | IN UINTN DataSize,\r | |
564 | IN VOID *ResetData OPTIONAL\r | |
565 | );\r | |
566 | \r | |
fb3df220 | 567 | #endif\r |