|
MdePkg[all]
1.08
|
|
MdePkg[all]
1.08
|
Data Structures | |
| struct | EFI_PEI_PPI_DESCRIPTOR |
| struct | _EFI_PEI_NOTIFY_DESCRIPTOR |
| union | EFI_PEI_DESCRIPTOR |
| struct | EFI_FV_FILE_INFO |
| struct | EFI_FV_FILE_INFO2 |
| struct | EFI_FV_INFO |
| struct | _EFI_PEI_SERVICES |
| struct | _EFI_SEC_PEI_HAND_OFF |
Macros | |
| #define | EFI_PEI_PPI_DESCRIPTOR_PIC 0x00000001 |
| #define | EFI_PEI_PPI_DESCRIPTOR_PPI 0x00000010 |
| #define | EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK 0x00000020 |
| #define | EFI_PEI_PPI_DESCRIPTOR_NOTIFY_DISPATCH 0x00000040 |
| #define | EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES 0x00000060 |
| #define | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST 0x80000000 |
| #define | PEI_SPECIFICATION_MAJOR_REVISION 1 |
| #define | PEI_SPECIFICATION_MINOR_REVISION 70 |
| #define | PEI_SERVICES_SIGNATURE 0x5652455320494550ULL |
| #define | PEI_SERVICES_REVISION ((PEI_SPECIFICATION_MAJOR_REVISION<<16) | (PEI_SPECIFICATION_MINOR_REVISION)) |
Functions | |
| typedef | EFI_STATUS (EFIAPI *EFI_PEI_FREE_PAGES)(IN CONST EFI_PEI_SERVICES **PeiServices |
| typedef | VOID (EFIAPI *EFI_PEI_RESET2_SYSTEM)(IN EFI_RESET_TYPE ResetType |
PI PEI master include file. This file should match the PI spec.
Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
| #define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK 0x00000020 |
| #define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_DISPATCH 0x00000040 |
| #define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES 0x00000060 |
| #define EFI_PEI_PPI_DESCRIPTOR_PIC 0x00000001 |
| #define EFI_PEI_PPI_DESCRIPTOR_PPI 0x00000010 |
| #define EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST 0x80000000 |
| #define PEI_SERVICES_REVISION ((PEI_SPECIFICATION_MAJOR_REVISION<<16) | (PEI_SPECIFICATION_MINOR_REVISION)) |
Specification inconsistency here: In the PI1.0 specification, there is a typo error in PEI_SERVICES_REVISION. In the specification the defintion is #define ((PEI_SPECIFICATION_MAJOR_REVISION<<16) |(PEI_SPECIFICATION_MINOR_REVISION)) and it should be as follows:
| #define PEI_SERVICES_SIGNATURE 0x5652455320494550ULL |
Specification inconsistency here: In the PI1.0 spec, PEI_SERVICES_SIGNATURE is defined as 0x5652455320494550. But to pass a multiple tool chain, it appends an ULL.
| #define PEI_SPECIFICATION_MAJOR_REVISION 1 |
| #define PEI_SPECIFICATION_MINOR_REVISION 70 |
| typedef EFI_STATUS(EFIAPI * EFI_PEI_ALLOCATE_PAGES)(IN CONST EFI_PEI_SERVICES **PeiServices, IN EFI_MEMORY_TYPE MemoryType, IN UINTN Pages, OUT EFI_PHYSICAL_ADDRESS *Memory) |
The purpose of the service is to publish an interface that allows PEIMs to allocate memory ranges that are managed by the PEI Foundation.
Prior to InstallPeiMemory() being called, PEI will allocate pages from the heap. After InstallPeiMemory() is called, PEI will allocate pages within the region of memory provided by InstallPeiMemory() service in a best-effort fashion. Location-specific allocations are not managed by the PEI foundation code.
| PeiServices | An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. |
| MemoryType | The type of memory to allocate. |
| Pages | The number of contiguous 4 KB pages to allocate. |
| Memory | A pointer to a physical address. On output, the address is set to the base of the page range that was allocated. |
| EFI_SUCCESS | The memory range was successfully allocated. |
| EFI_OUT_OF_RESOURCES | The pages could not be allocated. |
| EFI_INVALID_PARAMETER | The type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode, EfiRuntimeServicesData, EfiBootServicesCode, EfiBootServicesData, EfiACPIReclaimMemory, EfiReservedMemoryType, or EfiACPIMemoryNVS. |
| typedef EFI_STATUS(EFIAPI * EFI_PEI_ALLOCATE_POOL)(IN CONST EFI_PEI_SERVICES **PeiServices, IN UINTN Size, OUT VOID **Buffer) |
The purpose of this service is to publish an interface that allows PEIMs to allocate memory ranges that are managed by the PEI Foundation.
| PeiServices | An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. |
| Size | The number of bytes to allocate from the pool. |
| Buffer | If the call succeeds, a pointer to a pointer to the allocated buffer; undefined otherwise. |
| EFI_SUCCESS | The allocation was successful. |
| EFI_OUT_OF_RESOURCES | There is not enough heap to allocate the requested size. |
This service copies the contents of one buffer to another buffer.
| Destination | The pointer to the destination buffer of the memory copy. |
| Source | The pointer to the source buffer of the memory copy. |
| Length | The number of bytes to copy from Source to Destination. |
| typedef VOID(EFIAPI * EFI_PEI_CORE_ENTRY_POINT)(IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData, IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList) |
The entry point of PEI Foundation.
This function is the entry point for the PEI Foundation, which allows the SEC phase to pass information about the stack, temporary RAM and the Boot Firmware Volume. In addition, it also allows the SEC phase to pass services and data forward for use during the PEI phase in the form of one or more PPIs. These PPI's will be installed and/or immediately signaled if they are notification type. There is no limit to the number of additional PPIs that can be passed from SEC into the PEI Foundation. As part of its initialization phase, the PEI Foundation will add these SEC-hosted PPIs to its PPI database such that both the PEI Foundation and any modules can leverage the associated service calls and/or code in these early PPIs.
| SecCoreData | Points to a data structure containing information about the PEI core's operating environment, such as the size and location of temporary RAM, the stack location and the BFV location. |
| PpiList | Points to a list of one or more PPI descriptors to be installed initially by the PEI core. An empty PPI list consists of a single descriptor with the end-tag EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST. As part of its initialization phase, the PEI Foundation will add these SEC-hosted PPIs to its PPI database such that both the PEI Foundation and any modules can leverage the associated service calls and/or code in these early PPIs. |
| typedef EFI_STATUS(EFIAPI * EFI_PEI_CREATE_HOB)(IN CONST EFI_PEI_SERVICES **PeiServices, IN UINT16 Type, IN UINT16 Length, IN OUT VOID **Hob) |
This service, published by the PEI Foundation, abstracts the creation of a Hand-Off Block's (HOB's) headers.
| PeiServices | An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. |
| Type | The type of HOB to be installed. |
| Length | The length of the HOB to be added. |
| Hob | The address of a pointer that will contain the HOB header. |
| EFI_SUCCESS | The HOB was successfully created. |
| EFI_OUT_OF_RESOURCES | There is no additional space for HOB creation. |
| typedef EFI_STATUS(EFIAPI * EFI_PEI_FFS_FIND_BY_NAME)(IN CONST EFI_GUID *FileName, IN EFI_PEI_FV_HANDLE VolumeHandle, OUT EFI_PEI_FILE_HANDLE *FileHandle) |
Find a file within a volume by its name.
This service searches for files with a specific name, within either the specified firmware volume or all firmware volumes. The service returns a file handle of type EFI_PEI_FILE_HANDLE, which must be unique within the system.
| FileName | A pointer to the name of the file to find within the firmware volume. |
| VolumeHandle | The firmware volume to search. |
| FileHandle | Upon exit, points to the found file's handle or NULL if it could not be found. |
| EFI_SUCCESS | The file was found. |
| EFI_NOT_FOUND | The file was not found. |
| EFI_INVALID_PARAMETER | VolumeHandle or FileHandle or FileName was NULL. |
| typedef EFI_STATUS(EFIAPI * EFI_PEI_FFS_FIND_NEXT_FILE2)(IN CONST EFI_PEI_SERVICES **PeiServices, IN EFI_FV_FILETYPE SearchType, IN CONST EFI_PEI_FV_HANDLE FvHandle, IN OUT EFI_PEI_FILE_HANDLE *FileHandle) |
Searches for the next matching file in the firmware volume.
This service enables PEIMs to discover firmware files within a specified volume. To find the first instance of a firmware file, pass a FileHandle value of NULL into the service. The service returns a file handle of type EFI_PEI_FILE_HANDLE, which must be unique within the system.
| PeiServices | An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. |
| SearchType | A filter to find files only of this type. |
| FvHandle | Handle of firmware volume in which to search. |
| FileHandle | On entry, points to the current handle from which to begin searching or NULL to start at the beginning of the firmware volume. On exit, points the file handle of the next file in the volume or NULL if there are no more files. |
| EFI_SUCCESS | The file was found. |
| EFI_NOT_FOUND | The file was not found. |
| EFI_NOT_FOUND | The header checksum was not zero. |
| typedef EFI_STATUS(EFIAPI * EFI_PEI_FFS_FIND_NEXT_VOLUME2)(IN CONST EFI_PEI_SERVICES **PeiServices, IN UINTN Instance, OUT EFI_PEI_FV_HANDLE *VolumeHandle) |
The purpose of the service is to abstract the capability of the PEI Foundation to discover instances of firmware volumes in the system.
This service enables PEIMs to discover additional firmware volumes. The PEI Foundation uses this service to abstract the locations and formats of various firmware volumes. These volumes include the Boot Firmware Volume and any other volumes exposed by EFI_PEI_FV_PPI. The service returns a volume handle of type EFI_PEI_FV_HANDLE, which must be unique within the system.
| PeiServices | An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. |
| Instance | This instance of the firmware volume to find. The value 0 is the Boot Firmware Volume (BFV). |
| VolumeHandle | On exit, points to the next volumn handle or NULL if it does not exist. |
| EFI_SUCCESS | The volume was found. |
| EFI_NOT_FOUND | The volume was not found. |
| EFI_INVALID_PARAMETER | VolumeHandle is NULL. |
| typedef EFI_STATUS(EFIAPI * EFI_PEI_FFS_FIND_SECTION_DATA2)(IN CONST EFI_PEI_SERVICES **PeiServices, IN EFI_SECTION_TYPE SectionType, IN EFI_PEI_FILE_HANDLE FileHandle, OUT VOID **SectionData) |
Searches for the next matching section within the specified file.
This service enables PEI modules to discover the first section of a given type within a valid file. This service will search within encapsulation sections (compression and GUIDed) as well. It will search inside of a GUIDed section or a compressed section, but may not, for example, search a GUIDed section inside a GUIDes section. This service will not search within compression sections or GUIDed sections that require extraction if memory is not present.
| PeiServices | An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. |
| SectionType | The value of the section type to find. |
| FileHandle | Handle of the firmware file to search. |
| SectionData | A pointer to the discovered section, if successful. |
| EFI_SUCCESS | The section was found. |
| EFI_NOT_FOUND | The section was not found. |
| typedef EFI_STATUS(EFIAPI * EFI_PEI_FFS_FIND_SECTION_DATA3)(IN CONST EFI_PEI_SERVICES **PeiServices, IN EFI_SECTION_TYPE SectionType, IN UINTN SectionInstance, IN EFI_PEI_FILE_HANDLE FileHandle, OUT VOID **SectionData, OUT UINT32 *AuthenticationStatus) |
Searches for the next matching section within the specified file.
This service enables PEI modules to discover the section of a given type within a valid file. This service will search within encapsulation sections (compression and GUIDed) as well. It will search inside of a GUIDed section or a compressed section, but may not, for example, search a GUIDed section inside a GUIDes section. This service will not search within compression sections or GUIDed sections that require extraction if memory is not present.
| PeiServices | An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. |
| SectionType | The value of the section type to find. |
| SectionInstance | Section instance to find. |
| FileHandle | Handle of the firmware file to search. |
| SectionData | A pointer to the discovered section, if successful. |
| AuthenticationStatus | A pointer to the authentication status for this section. |
| EFI_SUCCESS | The section was found. |
| EFI_NOT_FOUND | The section was not found. |
| typedef EFI_STATUS(EFIAPI * EFI_PEI_FFS_GET_FILE_INFO)(IN EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_FV_FILE_INFO *FileInfo) |
Returns information about a specific file.
This function returns information about a specific file, including its file name, type, attributes, starting address and size. If the firmware volume is not memory mapped, then the Buffer member will be NULL.
| FileHandle | The handle of the file. |
| FileInfo | Upon exit, points to the file's information. |
| EFI_SUCCESS | File information was returned. |
| EFI_INVALID_PARAMETER | FileHandle does not represent a valid file. |
| EFI_INVALID_PARAMETER | FileInfo is NULL. |
| typedef EFI_STATUS(EFIAPI * EFI_PEI_FFS_GET_FILE_INFO2)(IN EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_FV_FILE_INFO2 *FileInfo) |
Returns information about a specific file.
This function returns information about a specific file, including its file name, type, attributes, starting address, size and authentication status. If the firmware volume is not memory mapped, then the Buffer member will be NULL.
| FileHandle | The handle of the file. |
| FileInfo | Upon exit, points to the file's information. |
| EFI_SUCCESS | File information was returned. |
| EFI_INVALID_PARAMETER | FileHandle does not represent a valid file. |
| EFI_INVALID_PARAMETER | FileInfo is NULL. |
| typedef EFI_STATUS(EFIAPI * EFI_PEI_FFS_GET_VOLUME_INFO)(IN EFI_PEI_FV_HANDLE VolumeHandle, OUT EFI_FV_INFO *VolumeInfo) |
Returns information about the specified volume.
This function returns information about a specific firmware volume, including its name, type, attributes, starting address and size.
| VolumeHandle | Handle of the volume. |
| VolumeInfo | Upon exit, points to the volume's information. |
| EFI_SUCCESS | The volume information returned. |
| EFI_INVALID_PARAMETER | If VolumeHandle does not represent a valid volume. |
| EFI_INVALID_PARAMETER | If VolumeHandle is NULL. |
| EFI_SUCCESS | Information was successfully returned. |
| EFI_INVALID_PARAMETER | The volume designated by the VolumeHandle is not available. |
| typedef VOID* EFI_PEI_FILE_HANDLE |
The handles of EFI FFS.
| typedef VOID* EFI_PEI_FV_HANDLE |
The handles of EFI FV.
| typedef EFI_STATUS(EFIAPI * EFI_PEI_GET_BOOT_MODE)(IN CONST EFI_PEI_SERVICES **PeiServices, OUT EFI_BOOT_MODE *BootMode) |
This function returns the present value of the boot mode.
| PeiServices | An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. |
| BootMode | A pointer to contain the value of the boot mode. |
| EFI_SUCCESS | The boot mode returned successfully. |
| typedef EFI_STATUS(EFIAPI * EFI_PEI_GET_HOB_LIST)(IN CONST EFI_PEI_SERVICES **PeiServices, OUT VOID **HobList) |
This function returns the pointer to the list of Hand-Off Blocks (HOBs) in memory.
| PeiServices | An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation |
| HobList | A pointer to the list of HOBs that the PEI Foundation will initialize |
| EFI_SUCCESS | The list was successfully returned. |
| EFI_NOT_AVAILABLE_YET | The HOB list is not yet published. |
| typedef EFI_STATUS(EFIAPI * EFI_PEI_INSTALL_PEI_MEMORY)(IN CONST EFI_PEI_SERVICES **PeiServices, IN EFI_PHYSICAL_ADDRESS MemoryBegin, IN UINT64 MemoryLength) |
This function registers the found memory configuration with the PEI Foundation.
| PeiServices | An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. |
| MemoryBegin | The value of a region of installed memory. |
| MemoryLength | The corresponding length of a region of installed memory. |
| EFI_SUCCESS | The region was successfully installed in a HOB. |
| EFI_INVALID_PARAMETER | MemoryBegin and MemoryLength are illegal for this system. |
| EFI_OUT_OF_RESOURCES | There is no additional space for HOB creation. |
| typedef EFI_STATUS(EFIAPI * EFI_PEI_INSTALL_PPI)(IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList) |
This service is the first one provided by the PEI Foundation. This function installs an interface in the PEI PPI database by GUID. The purpose of the service is to publish an interface that other parties can use to call additional PEIMs.
| PeiServices | An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. |
| PpiList | A pointer to the list of interfaces that the caller shall install. |
| EFI_SUCCESS | The interface was successfully installed. |
| EFI_INVALID_PARAMETER | The PpiList pointer is NULL or Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field. |
| EFI_OUT_OF_RESOURCES | There is no additional space in the PPI database. |
| typedef EFI_STATUS(EFIAPI * EFI_PEI_LOCATE_PPI)(IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_GUID *Guid, IN UINTN Instance, IN OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor, IN OUT VOID **Ppi) |
This function locates an interface in the PEI PPI database by GUID.
| PeiServices | An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation. |
| Guid | A pointer to the GUID whose corresponding interface needs to be found. |
| Instance | The N-th instance of the interface that is required. |
| PpiDescriptor | A pointer to instance of the EFI_PEI_PPI_DESCRIPTOR. |
| Ppi | A pointer to the instance of the interface. |
| EFI_SUCCESS | The interface was successfully returned. |
| EFI_NOT_FOUND | The PPI descriptor is not found in the database. |
| typedef struct _EFI_PEI_NOTIFY_DESCRIPTOR EFI_PEI_NOTIFY_DESCRIPTOR |
Declare the forward reference data structure for EFI_PEI_NOTIFY_DESCRIPTOR.
| typedef EFI_STATUS(EFIAPI * EFI_PEI_NOTIFY_PPI)(IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_NOTIFY_DESCRIPTOR *NotifyList) |
This function installs a notification service to be called back when a given interface is installed or reinstalled. The purpose of the service is to publish an interface that other parties can use to call additional PPIs that may materialize later.
| PeiServices | An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation |
| NotifyList | A pointer to the list of notification interfaces that the caller shall install. |
| EFI_SUCCESS | The interface was successfully installed. |
| EFI_INVALID_PARAMETER | The PpiList pointer is NULL, or any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES bit set in the Flags field. |
| EFI_OUT_OF_RESOURCES | There is no additional space in the PPI database. |
| typedef EFI_STATUS(EFIAPI * EFI_PEI_REGISTER_FOR_SHADOW)(IN EFI_PEI_FILE_HANDLE FileHandle) |
Register a PEIM so that it will be shadowed and called again.
This service registers a file handle so that after memory is available, the PEIM will be re-loaded into permanent memory and re-initialized. The PEIM registered this way will always be initialized twice. The first time, this function call will return EFI_SUCCESS. The second time, this function call will return EFI_ALREADY_STARTED. Depending on the order in which PEIMs are dispatched, the PEIM making this call may be initialized after permanent memory is installed, even the first time.
| FileHandle | PEIM's file handle. Must be the currently executing PEIM. |
| EFI_SUCCESS | The PEIM was successfully registered for shadowing. |
| EFI_ALREADY_STARTED | The PEIM was previously registered for shadowing. |
| EFI_NOT_FOUND | The FileHandle does not refer to a valid file handle. |
| typedef EFI_STATUS(EFIAPI * EFI_PEI_REINSTALL_PPI)(IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_PPI_DESCRIPTOR *OldPpi, IN CONST EFI_PEI_PPI_DESCRIPTOR *NewPpi) |
This function reinstalls an interface in the PEI PPI database by GUID. The purpose of the service is to publish an interface that other parties can use to replace a same-named interface in the protocol database with a different interface.
| PeiServices | An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. |
| OldPpi | A pointer to the former PPI in the database. |
| NewPpi | A pointer to the new interfaces that the caller shall install. |
| EFI_SUCCESS | The interface was successfully installed. |
| EFI_INVALID_PARAMETER | The PpiList pointer is NULL or Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field. |
| EFI_OUT_OF_RESOURCES | There is no additional space in the PPI database. |
| EFI_NOT_FOUND | The PPI for which the reinstallation was requested has not been installed. |
| typedef EFI_STATUS(EFIAPI * EFI_PEI_REPORT_STATUS_CODE)(IN CONST EFI_PEI_SERVICES **PeiServices, IN EFI_STATUS_CODE_TYPE Type, IN EFI_STATUS_CODE_VALUE Value, IN UINT32 Instance, IN CONST EFI_GUID *CallerId, IN CONST EFI_STATUS_CODE_DATA *Data) |
This service publishes an interface that allows PEIMs to report status codes.
ReportStatusCode() is called by PEIMs that wish to report status information on their progress. The principal use model is for a PEIM to emit one of the standard 32-bit error codes. This will allow a platform owner to ascertain the state of the system, especially under conditions where the full consoles might not have been installed.
| PeiServices | An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. |
| Type | Indicates the type of status code being reported. |
| Value | Describes the current status of a hardware or software entity. This includes information about the class and subclass that is used to classify the entity as well as an operation. For progress codes, the operation is the current activity. For error codes, it is the exception.For debug codes,it is not defined at this time. |
| Instance | The enumeration of a hardware or software entity within the system. A system may contain multiple entities that match a class/subclass pairing. The instance differentiates between them. An instance of 0 indicates that instance information is unavailable, not meaningful, or not relevant. Valid instance numbers start with 1. |
| CallerId | This optional parameter may be used to identify the caller. This parameter allows the status code driver to apply different rules to different callers. |
| Data | This optional parameter may be used to pass additional data. |
| EFI_SUCCESS | The function completed successfully. |
| EFI_NOT_AVAILABLE_YET | No progress code provider has installed an interface in the system. |
| typedef EFI_STATUS(EFIAPI * EFI_PEI_RESET_SYSTEM)(IN CONST EFI_PEI_SERVICES **PeiServices) |
Resets the entire platform.
This service resets the entire platform, including all processors and devices, and reboots the system. This service will never return EFI_SUCCESS.
| PeiServices | An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. |
| EFI_NOT_AVAILABLE_YET | The service has not been installed yet. |
| typedef struct _EFI_PEI_SERVICES EFI_PEI_SERVICES |
Declare the forward reference data structure for EFI_PEI_SERVICE.
| typedef EFI_STATUS(EFIAPI * EFI_PEI_SET_BOOT_MODE)(IN CONST EFI_PEI_SERVICES **PeiServices, IN EFI_BOOT_MODE BootMode) |
This function sets the value of the boot mode.
| PeiServices | An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation |
| BootMode | The value of the boot mode to set. |
| EFI_SUCCESS | The boot mode returned successfully. |
The service fills a buffer with a specified value.
| Buffer | The pointer to the buffer to fill. |
| Size | The number of bytes in Buffer to fill. |
| Value | The value to fill Buffer with. |
| typedef EFI_STATUS(EFIAPI * EFI_PEIM_ENTRY_POINT2)(IN EFI_PEI_FILE_HANDLE FileHandle, IN CONST EFI_PEI_SERVICES **PeiServices) |
The PEI Dispatcher will invoke each PEIM one time. During this pass, the PEI Dispatcher will pass control to the PEIM at the AddressOfEntryPoint in the PE Header.
| FileHandle | Pointer to the FFS file header. |
| PeiServices | Describes the list of possible PEI Services. |
| EFI_SUCCESS | The PEI completed successfully. |
| !EFI_SUCCESS | There is error in PEIM. |
| typedef EFI_STATUS(EFIAPI * EFI_PEIM_NOTIFY_ENTRY_POINT)(IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor, IN VOID *Ppi) |
Entry point of the notification callback function itself within the PEIM.
| PeiServices | Indirect reference to the PEI Services Table. |
| NotifyDescriptor | Address of the notification descriptor data structure. |
| Ppi | Address of the PPI that was installed. |
| typedef struct _EFI_SEC_PEI_HAND_OFF EFI_SEC_PEI_HAND_OFF |
EFI_SEC_PEI_HAND_OFF structure holds information about PEI core's operating environment, such as the size of location of temporary RAM, the stack location and BFV location.
| typedef IN EFI_PHYSICAL_ADDRESS Memory |
| typedef IN EFI_PHYSICAL_ADDRESS IN UINTN Pages |
| typedef IN EFI_STATUS ResetStatus |
| typedef EFI_STATUS | ( | EFIAPI * | EFI_PEI_FREE_PAGES | ) |
Frees memory pages.
| [in] | PeiServices | An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. |
| [in] | Memory | The base physical address of the pages to be freed. |
| [in] | Pages | The number of contiguous 4 KB pages to free. |
| EFI_SUCCESS | The requested pages were freed. |
| EFI_INVALID_PARAMETER | Memory is not a page-aligned address or Pages is invalid. |
| EFI_NOT_FOUND | The requested memory pages were not allocated with AllocatePages(). |
| typedef VOID | ( | EFIAPI * | EFI_PEI_RESET2_SYSTEM | ) |
Resets the entire platform.
| [in] | ResetType | The type of reset to perform. |
| [in] | ResetStatus | The status code for the reset. |
| [in] | DataSize | The size, in bytes, of ResetData. |
| [in] | ResetData | For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown the data buffer starts with a Null-terminated string, optionally followed by additional binary data. The string is a description that the caller may use to further indicate the reason for the system reset. |
Enables the page break output mode.
1.8.6 
