2 PI PEI master include file. This file should match the PI spec.
4 Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials are licensed and made available under
6 the terms and conditions of the BSD License that accompanies this distribution.
7 The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php.
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14 @par Revision Reference:
19 #ifndef __PI_PEICIS_H__
20 #define __PI_PEICIS_H__
22 #include <Uefi/UefiMultiPhase.h>
23 #include <Pi/PiMultiPhase.h>
26 /// The handles of EFI FV.
28 typedef VOID
*EFI_PEI_FV_HANDLE
;
31 /// The handles of EFI FFS.
33 typedef VOID
*EFI_PEI_FILE_HANDLE
;
36 /// Declare the forward reference data structure for EFI_PEI_SERVICE.
38 typedef struct _EFI_PEI_SERVICES EFI_PEI_SERVICES
;
41 /// Declare the forward reference data structure for EFI_PEI_NOTIFY_DESCRIPTOR.
43 typedef struct _EFI_PEI_NOTIFY_DESCRIPTOR EFI_PEI_NOTIFY_DESCRIPTOR
;
46 #include <Ppi/CpuIo.h>
47 #include <Ppi/PciCfg2.h>
51 The PEI Dispatcher will invoke each PEIM one time. During this pass, the PEI
52 Dispatcher will pass control to the PEIM at the AddressOfEntryPoint in the PE Header.
54 @param FileHandle Pointer to the FFS file header.
55 @param PeiServices Describes the list of possible PEI Services.
57 @retval EFI_SUCCESS The PEI completed successfully.
58 @retval !EFI_SUCCESS There is error in PEIM.
63 (EFIAPI
*EFI_PEIM_ENTRY_POINT2
)(
64 IN EFI_PEI_FILE_HANDLE FileHandle
,
65 IN CONST EFI_PEI_SERVICES
**PeiServices
69 Entry point of the notification callback function itself within the PEIM.
71 @param PeiServices Indirect reference to the PEI Services Table.
72 @param NotifyDescriptor Address of the notification descriptor data structure.
73 @param Ppi Address of the PPI that was installed.
75 @return Status of the notification.
79 (EFIAPI
*EFI_PEIM_NOTIFY_ENTRY_POINT
)(
80 IN EFI_PEI_SERVICES
**PeiServices
,
81 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDescriptor
,
86 // PEI Ppi Services List Descriptors
88 #define EFI_PEI_PPI_DESCRIPTOR_PIC 0x00000001
89 #define EFI_PEI_PPI_DESCRIPTOR_PPI 0x00000010
90 #define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK 0x00000020
91 #define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_DISPATCH 0x00000040
92 #define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES 0x00000060
93 #define EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST 0x80000000
96 /// The data structure through which a PEIM describes available services to the PEI Foundation.
100 /// This field is a set of flags describing the characteristics of this imported table entry.
101 /// All flags are defined as EFI_PEI_PPI_DESCRIPTOR_***, which can also be combined into one.
105 /// The address of the EFI_GUID that names the interface.
109 /// A pointer to the PPI. It contains the information necessary to install a service.
112 } EFI_PEI_PPI_DESCRIPTOR
;
115 /// The data structure in a given PEIM that tells the PEI
116 /// Foundation where to invoke the notification service.
118 struct _EFI_PEI_NOTIFY_DESCRIPTOR
{
120 /// Details if the type of notification are callback or dispatch.
124 /// The address of the EFI_GUID that names the interface.
128 /// Address of the notification callback function itself within the PEIM.
130 EFI_PEIM_NOTIFY_ENTRY_POINT Notify
;
134 /// This data structure is the means by which callable services are installed and
135 /// notifications are registered in the PEI phase.
139 /// The typedef structure of the notification descriptor.
141 EFI_PEI_NOTIFY_DESCRIPTOR Notify
;
143 /// The typedef structure of the PPI descriptor.
145 EFI_PEI_PPI_DESCRIPTOR Ppi
;
146 } EFI_PEI_DESCRIPTOR
;
149 This service is the first one provided by the PEI Foundation. This function
150 installs an interface in the PEI PPI database by GUID. The purpose of the
151 service is to publish an interface that other parties can use to call
154 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table
155 published by the PEI Foundation.
156 @param PpiList A pointer to the list of interfaces that the caller shall install.
158 @retval EFI_SUCCESS The interface was successfully installed.
159 @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI
160 descriptors in the list do not have the
161 EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
162 @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.
167 (EFIAPI
*EFI_PEI_INSTALL_PPI
)(
168 IN CONST EFI_PEI_SERVICES
**PeiServices
,
169 IN CONST EFI_PEI_PPI_DESCRIPTOR
*PpiList
173 This function reinstalls an interface in the PEI PPI database by GUID.
174 The purpose of the service is to publish an interface that other parties
175 can use to replace a same-named interface in the protocol database
176 with a different interface.
178 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table
179 published by the PEI Foundation.
180 @param OldPpi A pointer to the former PPI in the database.
181 @param NewPpi A pointer to the new interfaces that the caller shall install.
183 @retval EFI_SUCCESS The interface was successfully installed.
184 @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the
185 list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
186 @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.
187 @retval EFI_NOT_FOUND The PPI for which the reinstallation was requested has not been installed.
192 (EFIAPI
*EFI_PEI_REINSTALL_PPI
)(
193 IN CONST EFI_PEI_SERVICES
**PeiServices
,
194 IN CONST EFI_PEI_PPI_DESCRIPTOR
*OldPpi
,
195 IN CONST EFI_PEI_PPI_DESCRIPTOR
*NewPpi
199 This function locates an interface in the PEI PPI database by GUID.
201 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation.
202 @param Guid A pointer to the GUID whose corresponding interface needs to be found.
203 @param Instance The N-th instance of the interface that is required.
204 @param PpiDescriptor A pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.
205 @param Ppi A pointer to the instance of the interface.
207 @retval EFI_SUCCESS The interface was successfully returned.
208 @retval EFI_NOT_FOUND The PPI descriptor is not found in the database.
213 (EFIAPI
*EFI_PEI_LOCATE_PPI
)(
214 IN CONST EFI_PEI_SERVICES
**PeiServices
,
215 IN CONST EFI_GUID
*Guid
,
217 IN OUT EFI_PEI_PPI_DESCRIPTOR
**PpiDescriptor OPTIONAL
,
222 This function installs a notification service to be called back when a
223 given interface is installed or reinstalled. The purpose of the service
224 is to publish an interface that other parties can use to call additional PPIs
225 that may materialize later.
227 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
228 @param NotifyList A pointer to the list of notification interfaces that the caller shall install.
230 @retval EFI_SUCCESS The interface was successfully installed.
231 @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL, or any of the PEI PPI descriptors in the
232 list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
233 @retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.
238 (EFIAPI
*EFI_PEI_NOTIFY_PPI
)(
239 IN CONST EFI_PEI_SERVICES
**PeiServices
,
240 IN CONST EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyList
244 This function returns the present value of the boot mode.
246 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
247 @param BootMode A pointer to contain the value of the boot mode.
249 @retval EFI_SUCCESS The boot mode returned successfully.
254 (EFIAPI
*EFI_PEI_GET_BOOT_MODE
)(
255 IN CONST EFI_PEI_SERVICES
**PeiServices
,
256 OUT EFI_BOOT_MODE
*BootMode
260 This function sets the value of the boot mode.
262 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
263 @param BootMode The value of the boot mode to set.
265 @retval EFI_SUCCESS The boot mode returned successfully.
270 (EFIAPI
*EFI_PEI_SET_BOOT_MODE
)(
271 IN CONST EFI_PEI_SERVICES
**PeiServices
,
272 IN EFI_BOOT_MODE BootMode
276 This function returns the pointer to the list of Hand-Off Blocks (HOBs) in memory.
278 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
279 @param HobList A pointer to the list of HOBs that the PEI Foundation will initialize
281 @retval EFI_SUCCESS The list was successfully returned.
282 @retval EFI_NOT_AVAILABLE_YET The HOB list is not yet published.
287 (EFIAPI
*EFI_PEI_GET_HOB_LIST
)(
288 IN CONST EFI_PEI_SERVICES
**PeiServices
,
293 This service, published by the PEI Foundation, abstracts the creation of a Hand-Off Block's (HOB's) headers.
295 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
296 @param Type The type of HOB to be installed.
297 @param Length The length of the HOB to be added.
298 @param Hob The address of a pointer that will contain the HOB header.
300 @retval EFI_SUCCESS The HOB was successfully created.
301 @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.
306 (EFIAPI
*EFI_PEI_CREATE_HOB
)(
307 IN CONST EFI_PEI_SERVICES
**PeiServices
,
314 The purpose of the service is to abstract the capability of the PEI
315 Foundation to discover instances of firmware volumes in the system.
317 This service enables PEIMs to discover additional firmware volumes. The PEI Foundation uses this
318 service to abstract the locations and formats of various firmware volumes. These volumes include
319 the Boot Firmware Volume and any other volumes exposed by EFI_PEI_FV_PPI. The service
320 returns a volume handle of type EFI_PEI_FV_HANDLE, which must be unique within the system.
322 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
323 @param Instance This instance of the firmware volume to find.
324 The value 0 is the Boot Firmware Volume (BFV).
325 @param VolumeHandle On exit, points to the next volumn handle or NULL if it does not exist.
327 @retval EFI_SUCCESS The volume was found.
328 @retval EFI_NOT_FOUND The volume was not found.
329 @retval EFI_INVALID_PARAMETER VolumeHandle is NULL.
334 (EFIAPI
*EFI_PEI_FFS_FIND_NEXT_VOLUME2
)(
335 IN CONST EFI_PEI_SERVICES
**PeiServices
,
337 OUT EFI_PEI_FV_HANDLE
*VolumeHandle
341 Searches for the next matching file in the firmware volume.
343 This service enables PEIMs to discover firmware files within a specified volume.
344 To find the first instance of a firmware file, pass a FileHandle value of NULL into the service.
345 The service returns a file handle of type EFI_PEI_FILE_HANDLE, which must be unique within
348 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
349 @param SearchType A filter to find files only of this type.
350 @param FvHandle Handle of firmware volume in which to search.
351 @param FileHandle On entry, points to the current handle from which to begin searching
352 or NULL to start at the beginning of the firmware volume.
353 On exit, points the file handle of the next file in the volume or NULL
354 if there are no more files.
356 @retval EFI_SUCCESS The file was found.
357 @retval EFI_NOT_FOUND The file was not found.
358 @retval EFI_NOT_FOUND The header checksum was not zero.
363 (EFIAPI
*EFI_PEI_FFS_FIND_NEXT_FILE2
)(
364 IN CONST EFI_PEI_SERVICES
**PeiServices
,
365 IN EFI_FV_FILETYPE SearchType
,
366 IN CONST EFI_PEI_FV_HANDLE FvHandle
,
367 IN OUT EFI_PEI_FILE_HANDLE
*FileHandle
371 Searches for the next matching section within the specified file.
373 This service enables PEI modules to discover the first section of a given type within a valid file.
374 This service will search within encapsulation sections (compression and GUIDed) as well. It will
375 search inside of a GUIDed section or a compressed section, but may not, for example, search a
376 GUIDed section inside a GUIDes section.
377 This service will not search within compression sections or GUIDed sections that require
378 extraction if memory is not present.
380 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
381 @param SectionType The value of the section type to find.
382 @param FileHandle Handle of the firmware file to search.
383 @param SectionData A pointer to the discovered section, if successful.
385 @retval EFI_SUCCESS The section was found.
386 @retval EFI_NOT_FOUND The section was not found.
391 (EFIAPI
*EFI_PEI_FFS_FIND_SECTION_DATA2
)(
392 IN CONST EFI_PEI_SERVICES
**PeiServices
,
393 IN EFI_SECTION_TYPE SectionType
,
394 IN EFI_PEI_FILE_HANDLE FileHandle
,
395 OUT VOID
**SectionData
399 Searches for the next matching section within the specified file.
401 This service enables PEI modules to discover the section of a given type within a valid file.
402 This service will search within encapsulation sections (compression and GUIDed) as well. It will
403 search inside of a GUIDed section or a compressed section, but may not, for example, search a
404 GUIDed section inside a GUIDes section.
405 This service will not search within compression sections or GUIDed sections that require
406 extraction if memory is not present.
408 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
409 @param SectionType The value of the section type to find.
410 @param SectionInstance Section instance to find.
411 @param FileHandle Handle of the firmware file to search.
412 @param SectionData A pointer to the discovered section, if successful.
413 @param AuthenticationStatus A pointer to the authentication status for this section.
415 @retval EFI_SUCCESS The section was found.
416 @retval EFI_NOT_FOUND The section was not found.
421 (EFIAPI
*EFI_PEI_FFS_FIND_SECTION_DATA3
)(
422 IN CONST EFI_PEI_SERVICES
**PeiServices
,
423 IN EFI_SECTION_TYPE SectionType
,
424 IN UINTN SectionInstance
,
425 IN EFI_PEI_FILE_HANDLE FileHandle
,
426 OUT VOID
**SectionData
,
427 OUT UINT32
*AuthenticationStatus
431 This function registers the found memory configuration with the PEI Foundation.
433 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
434 @param MemoryBegin The value of a region of installed memory.
435 @param MemoryLength The corresponding length of a region of installed memory.
437 @retval EFI_SUCCESS The region was successfully installed in a HOB.
438 @retval EFI_INVALID_PARAMETER MemoryBegin and MemoryLength are illegal for this system.
439 @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.
444 (EFIAPI
*EFI_PEI_INSTALL_PEI_MEMORY
)(
445 IN CONST EFI_PEI_SERVICES
**PeiServices
,
446 IN EFI_PHYSICAL_ADDRESS MemoryBegin
,
447 IN UINT64 MemoryLength
451 The purpose of the service is to publish an interface that allows
452 PEIMs to allocate memory ranges that are managed by the PEI Foundation.
454 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
455 @param MemoryType The type of memory to allocate.
456 @param Pages The number of contiguous 4 KB pages to allocate.
457 @param Memory A pointer to a physical address. On output, the address is set to the base
458 of the page range that was allocated.
460 @retval EFI_SUCCESS The memory range was successfully allocated.
461 @retval EFI_OUT_OF_RESOURCES The pages could not be allocated.
462 @retval EFI_INVALID_PARAMETER The type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode,
463 EfiRuntimeServicesData, EfiBootServicesCode, EfiBootServicesData,
464 EfiACPIReclaimMemory, EfiReservedMemoryType, or EfiACPIMemoryNVS.
469 (EFIAPI
*EFI_PEI_ALLOCATE_PAGES
)(
470 IN CONST EFI_PEI_SERVICES
**PeiServices
,
471 IN EFI_MEMORY_TYPE MemoryType
,
473 OUT EFI_PHYSICAL_ADDRESS
*Memory
477 The purpose of this service is to publish an interface that
478 allows PEIMs to allocate memory ranges that are managed by the PEI Foundation.
480 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
481 @param Size The number of bytes to allocate from the pool.
482 @param Buffer If the call succeeds, a pointer to a pointer to the allocated buffer; undefined otherwise.
484 @retval EFI_SUCCESS The allocation was successful.
485 @retval EFI_OUT_OF_RESOURCES There is not enough heap to allocate the requested size.
490 (EFIAPI
*EFI_PEI_ALLOCATE_POOL
)(
491 IN CONST EFI_PEI_SERVICES
**PeiServices
,
497 This service copies the contents of one buffer to another buffer.
499 @param Destination The pointer to the destination buffer of the memory copy.
500 @param Source The pointer to the source buffer of the memory copy.
501 @param Length The number of bytes to copy from Source to Destination.
506 (EFIAPI
*EFI_PEI_COPY_MEM
)(
507 IN VOID
*Destination
,
513 The service fills a buffer with a specified value.
515 @param Buffer The pointer to the buffer to fill.
516 @param Size The number of bytes in Buffer to fill.
517 @param Value The value to fill Buffer with.
522 (EFIAPI
*EFI_PEI_SET_MEM
)(
529 This service publishes an interface that allows PEIMs to report status codes.
531 ReportStatusCode() is called by PEIMs that wish to report status information on their
532 progress. The principal use model is for a PEIM to emit one of the standard 32-bit error codes. This
533 will allow a platform owner to ascertain the state of the system, especially under conditions where
534 the full consoles might not have been installed.
536 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
537 @param Type Indicates the type of status code being reported.
538 @param Value Describes the current status of a hardware or
539 software entity. This includes information about the class and
540 subclass that is used to classify the entity as well as an operation.
541 For progress codes, the operation is the current activity.
542 For error codes, it is the exception.For debug codes,it is not defined at this time.
543 @param Instance The enumeration of a hardware or software entity within
544 the system. A system may contain multiple entities that match a class/subclass
545 pairing. The instance differentiates between them. An instance of 0 indicates
546 that instance information is unavailable, not meaningful, or not relevant.
547 Valid instance numbers start with 1.
548 @param CallerId This optional parameter may be used to identify the caller.
549 This parameter allows the status code driver to apply different rules to
551 @param Data This optional parameter may be used to pass additional data.
553 @retval EFI_SUCCESS The function completed successfully.
554 @retval EFI_NOT_AVAILABLE_YET No progress code provider has installed an interface in the system.
559 (EFIAPI
*EFI_PEI_REPORT_STATUS_CODE
)(
560 IN CONST EFI_PEI_SERVICES
**PeiServices
,
561 IN EFI_STATUS_CODE_TYPE Type
,
562 IN EFI_STATUS_CODE_VALUE Value
,
564 IN CONST EFI_GUID
*CallerId OPTIONAL
,
565 IN CONST EFI_STATUS_CODE_DATA
*Data OPTIONAL
569 Resets the entire platform.
571 This service resets the entire platform, including all processors
572 and devices, and reboots the system.
573 This service will never return EFI_SUCCESS.
575 @param PeiServices An indirect pointer to the EFI_PEI_SERVICES
576 table published by the PEI Foundation.
578 @retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.
583 (EFIAPI
*EFI_PEI_RESET_SYSTEM
)(
584 IN CONST EFI_PEI_SERVICES
**PeiServices
588 Resets the entire platform.
590 @param[in] ResetType The type of reset to perform.
591 @param[in] ResetStatus The status code for the reset.
592 @param[in] DataSize The size, in bytes, of WatchdogData.
593 @param[in] ResetData For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown
594 the data buffer starts with a Null-terminated string, optionally
595 followed by additional binary data. The string is a description
596 that the caller may use to further indicate the reason for the
597 system reset. ResetData is only valid if ResetStatus is something
598 other than EFI_SUCCESS unless the ResetType is EfiResetPlatformSpecific
599 where a minimum amount of ResetData is always required.
604 (EFIAPI
*EFI_PEI_RESET2_SYSTEM
) (
605 IN EFI_RESET_TYPE ResetType
,
606 IN EFI_STATUS ResetStatus
,
608 IN VOID
*ResetData OPTIONAL
612 Find a file within a volume by its name.
614 This service searches for files with a specific name, within
615 either the specified firmware volume or all firmware volumes.
616 The service returns a file handle of type EFI_PEI_FILE_HANDLE,
617 which must be unique within the system.
619 @param FileName A pointer to the name of the file to
620 find within the firmware volume.
621 @param VolumeHandle The firmware volume to search.
622 @param FileHandle Upon exit, points to the found file's
623 handle or NULL if it could not be found.
625 @retval EFI_SUCCESS The file was found.
626 @retval EFI_NOT_FOUND The file was not found.
627 @retval EFI_INVALID_PARAMETER VolumeHandle or FileHandle or
633 (EFIAPI
*EFI_PEI_FFS_FIND_BY_NAME
)(
634 IN CONST EFI_GUID
*FileName
,
635 IN EFI_PEI_FV_HANDLE VolumeHandle
,
636 OUT EFI_PEI_FILE_HANDLE
*FileHandle
640 /// The information of the FV file.
644 /// Name of the file.
650 EFI_FV_FILETYPE FileType
;
652 /// Attributes of the file.
654 EFI_FV_FILE_ATTRIBUTES FileAttributes
;
656 /// Points to the file's data (not the header).
657 /// Not valid if EFI_FV_FILE_ATTRIB_MEMORY_MAPPED
662 /// Size of the file's data.
668 /// The information with authentication status of the FV file.
672 /// Name of the file.
678 EFI_FV_FILETYPE FileType
;
680 /// Attributes of the file.
682 EFI_FV_FILE_ATTRIBUTES FileAttributes
;
684 /// Points to the file's data (not the header).
685 /// Not valid if EFI_FV_FILE_ATTRIB_MEMORY_MAPPED
690 /// Size of the file's data.
694 /// Authentication status for this file.
696 UINT32 AuthenticationStatus
;
700 Returns information about a specific file.
702 This function returns information about a specific file,
703 including its file name, type, attributes, starting address and
704 size. If the firmware volume is not memory mapped, then the
705 Buffer member will be NULL.
707 @param FileHandle The handle of the file.
708 @param FileInfo Upon exit, points to the file's
711 @retval EFI_SUCCESS File information was returned.
712 @retval EFI_INVALID_PARAMETER FileHandle does not
713 represent a valid file.
714 @retval EFI_INVALID_PARAMETER FileInfo is NULL.
719 (EFIAPI
*EFI_PEI_FFS_GET_FILE_INFO
)(
720 IN EFI_PEI_FILE_HANDLE FileHandle
,
721 OUT EFI_FV_FILE_INFO
*FileInfo
725 Returns information about a specific file.
727 This function returns information about a specific file,
728 including its file name, type, attributes, starting address, size and authentication status.
729 If the firmware volume is not memory mapped, then the Buffer member will be NULL.
731 @param FileHandle The handle of the file.
732 @param FileInfo Upon exit, points to the file's
735 @retval EFI_SUCCESS File information was returned.
736 @retval EFI_INVALID_PARAMETER FileHandle does not
737 represent a valid file.
738 @retval EFI_INVALID_PARAMETER FileInfo is NULL.
743 (EFIAPI
*EFI_PEI_FFS_GET_FILE_INFO2
)(
744 IN EFI_PEI_FILE_HANDLE FileHandle
,
745 OUT EFI_FV_FILE_INFO2
*FileInfo
749 /// The information of the FV volume.
753 /// Attributes of the firmware volume.
755 EFI_FVB_ATTRIBUTES_2 FvAttributes
;
757 /// Format of the firmware volume.
761 /// Name of the firmware volume.
765 /// Points to the first byte of the firmware
766 /// volume, if bit EFI_FVB_MEMORY_MAPPED is
767 /// set in FvAttributes.
771 /// Size of the firmware volume.
777 Returns information about the specified volume.
779 This function returns information about a specific firmware
780 volume, including its name, type, attributes, starting address
783 @param VolumeHandle Handle of the volume.
784 @param VolumeInfo Upon exit, points to the volume's information.
786 @retval EFI_SUCCESS The volume information returned.
787 @retval EFI_INVALID_PARAMETER If VolumeHandle does not represent a valid volume.
788 @retval EFI_INVALID_PARAMETER If VolumeHandle is NULL.
789 @retval EFI_SUCCESS Information was successfully returned.
790 @retval EFI_INVALID_PARAMETER The volume designated by the VolumeHandle is not available.
795 (EFIAPI
*EFI_PEI_FFS_GET_VOLUME_INFO
)(
796 IN EFI_PEI_FV_HANDLE VolumeHandle
,
797 OUT EFI_FV_INFO
*VolumeInfo
801 Register a PEIM so that it will be shadowed and called again.
803 This service registers a file handle so that after memory is
804 available, the PEIM will be re-loaded into permanent memory and
805 re-initialized. The PEIM registered this way will always be
806 initialized twice. The first time, this function call will
807 return EFI_SUCCESS. The second time, this function call will
808 return EFI_ALREADY_STARTED. Depending on the order in which
809 PEIMs are dispatched, the PEIM making this call may be
810 initialized after permanent memory is installed, even the first
813 @param FileHandle PEIM's file handle. Must be the currently
816 @retval EFI_SUCCESS The PEIM was successfully registered for
818 @retval EFI_ALREADY_STARTED The PEIM was previously
819 registered for shadowing.
820 @retval EFI_NOT_FOUND The FileHandle does not refer to a
826 (EFIAPI
*EFI_PEI_REGISTER_FOR_SHADOW
)(
827 IN EFI_PEI_FILE_HANDLE FileHandle
832 // PEI Specification Revision information
834 #define PEI_SPECIFICATION_MAJOR_REVISION 1
835 #define PEI_SPECIFICATION_MINOR_REVISION 40
837 /// Specification inconsistency here:
838 /// In the PI1.0 spec, PEI_SERVICES_SIGNATURE is defined as 0x5652455320494550. But
839 /// to pass a multiple tool chain, it appends an ULL.
842 // PEI Services Table
844 #define PEI_SERVICES_SIGNATURE 0x5652455320494550ULL
846 /// Specification inconsistency here:
847 /// In the PI1.0 specification, there is a typo error in PEI_SERVICES_REVISION. In the specification the defintion is
848 /// #define ((PEI_SPECIFICATION_MAJOR_REVISION<<16) |(PEI_SPECIFICATION_MINOR_REVISION))
849 /// and it should be as follows:
851 #define PEI_SERVICES_REVISION ((PEI_SPECIFICATION_MAJOR_REVISION<<16) | (PEI_SPECIFICATION_MINOR_REVISION))
854 /// EFI_PEI_SERVICES is a collection of functions whose implementation is provided by the PEI
855 /// Foundation. These services fall into various classes, including the following:
856 /// - Managing the boot mode
857 /// - Allocating both early and permanent memory
858 /// - Supporting the Firmware File System (FFS)
859 /// - Abstracting the PPI database abstraction
860 /// - Creating Hand-Off Blocks (HOBs).
862 struct _EFI_PEI_SERVICES
{
864 /// The table header for the PEI Services Table.
866 EFI_TABLE_HEADER Hdr
;
871 EFI_PEI_INSTALL_PPI InstallPpi
;
872 EFI_PEI_REINSTALL_PPI ReInstallPpi
;
873 EFI_PEI_LOCATE_PPI LocatePpi
;
874 EFI_PEI_NOTIFY_PPI NotifyPpi
;
877 // Boot Mode Functions
879 EFI_PEI_GET_BOOT_MODE GetBootMode
;
880 EFI_PEI_SET_BOOT_MODE SetBootMode
;
885 EFI_PEI_GET_HOB_LIST GetHobList
;
886 EFI_PEI_CREATE_HOB CreateHob
;
889 // Firmware Volume Functions
891 EFI_PEI_FFS_FIND_NEXT_VOLUME2 FfsFindNextVolume
;
892 EFI_PEI_FFS_FIND_NEXT_FILE2 FfsFindNextFile
;
893 EFI_PEI_FFS_FIND_SECTION_DATA2 FfsFindSectionData
;
896 // PEI Memory Functions
898 EFI_PEI_INSTALL_PEI_MEMORY InstallPeiMemory
;
899 EFI_PEI_ALLOCATE_PAGES AllocatePages
;
900 EFI_PEI_ALLOCATE_POOL AllocatePool
;
901 EFI_PEI_COPY_MEM CopyMem
;
902 EFI_PEI_SET_MEM SetMem
;
907 EFI_PEI_REPORT_STATUS_CODE ReportStatusCode
;
912 EFI_PEI_RESET_SYSTEM ResetSystem
;
915 // (the following interfaces are installed by publishing PEIM)
918 EFI_PEI_CPU_IO_PPI
*CpuIo
;
919 EFI_PEI_PCI_CFG2_PPI
*PciCfg
;
922 // Future Installed Services
924 EFI_PEI_FFS_FIND_BY_NAME FfsFindFileByName
;
925 EFI_PEI_FFS_GET_FILE_INFO FfsGetFileInfo
;
926 EFI_PEI_FFS_GET_VOLUME_INFO FfsGetVolumeInfo
;
927 EFI_PEI_REGISTER_FOR_SHADOW RegisterForShadow
;
928 EFI_PEI_FFS_FIND_SECTION_DATA3 FindSectionData3
;
929 EFI_PEI_FFS_GET_FILE_INFO2 FfsGetFileInfo2
;
930 EFI_PEI_RESET2_SYSTEM ResetSystem2
;
935 /// EFI_SEC_PEI_HAND_OFF structure holds information about
936 /// PEI core's operating environment, such as the size of location of
937 /// temporary RAM, the stack location and BFV location.
939 typedef struct _EFI_SEC_PEI_HAND_OFF
{
941 /// Size of the data structure.
946 /// Points to the first byte of the boot firmware volume,
947 /// which the PEI Dispatcher should search for
950 VOID
*BootFirmwareVolumeBase
;
953 /// Size of the boot firmware volume, in bytes.
955 UINTN BootFirmwareVolumeSize
;
958 /// Points to the first byte of the temporary RAM.
960 VOID
*TemporaryRamBase
;
963 /// Size of the temporary RAM, in bytes.
965 UINTN TemporaryRamSize
;
968 /// Points to the first byte of the temporary RAM
969 /// available for use by the PEI Foundation. The area
970 /// described by PeiTemporaryRamBase and PeiTemporaryRamSize
971 /// must not extend outside beyond the area described by
972 /// TemporaryRamBase & TemporaryRamSize. This area should not
973 /// overlap with the area reported by StackBase and
976 VOID
*PeiTemporaryRamBase
;
979 /// The size of the available temporary RAM available for
980 /// use by the PEI Foundation, in bytes.
982 UINTN PeiTemporaryRamSize
;
985 /// Points to the first byte of the stack.
986 /// This are may be part of the memory described by
987 /// TemporaryRamBase and TemporaryRamSize
988 /// or may be an entirely separate area.
993 /// Size of the stack, in bytes.
996 } EFI_SEC_PEI_HAND_OFF
;
1000 The entry point of PEI Foundation.
1002 This function is the entry point for the PEI Foundation, which
1003 allows the SEC phase to pass information about the stack,
1004 temporary RAM and the Boot Firmware Volume. In addition, it also
1005 allows the SEC phase to pass services and data forward for use
1006 during the PEI phase in the form of one or more PPIs. There is
1007 no limit to the number of additional PPIs that can be passed
1008 from SEC into the PEI Foundation. As part of its initialization
1009 phase, the PEI Foundation will add these SEC-hosted PPIs to its
1010 PPI database such that both the PEI Foundation and any modules
1011 can leverage the associated service calls and/or code in these
1014 @param SecCoreData Points to a data structure containing
1015 information about the PEI core's
1016 operating environment, such as the size
1017 and location of temporary RAM, the stack
1018 location and the BFV location.
1020 @param PpiList Points to a list of one or more PPI
1021 descriptors to be installed initially by
1022 the PEI core. An empty PPI list consists
1023 of a single descriptor with the end-tag
1024 EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.
1025 As part of its initialization phase, the
1026 PEI Foundation will add these SEC-hosted
1027 PPIs to its PPI database such that both
1028 the PEI Foundation and any modules can
1029 leverage the associated service calls
1030 and/or code in these early PPIs.
1036 (EFIAPI
*EFI_PEI_CORE_ENTRY_POINT
)(
1037 IN CONST EFI_SEC_PEI_HAND_OFF
*SecCoreData
,
1038 IN CONST EFI_PEI_PPI_DESCRIPTOR
*PpiList