|
| typedef VOID * | EFI_PEI_FV_HANDLE |
| |
| typedef VOID * | EFI_PEI_FILE_HANDLE |
| |
| typedef struct _EFI_PEI_SERVICES | EFI_PEI_SERVICES |
| |
| typedef struct _EFI_PEI_NOTIFY_DESCRIPTOR | EFI_PEI_NOTIFY_DESCRIPTOR |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_PEIM_ENTRY_POINT2) (IN EFI_PEI_FILE_HANDLE FileHandle, IN CONST EFI_PEI_SERVICES **PeiServices) |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_PEIM_NOTIFY_ENTRY_POINT) (IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor, IN VOID *Ppi) |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_PEI_INSTALL_PPI) (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList) |
| |
| 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) |
| |
| 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 OPTIONAL, IN OUT VOID **Ppi) |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_PEI_NOTIFY_PPI) (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_NOTIFY_DESCRIPTOR *NotifyList) |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_PEI_GET_BOOT_MODE) (IN CONST EFI_PEI_SERVICES **PeiServices, OUT EFI_BOOT_MODE *BootMode) |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_PEI_SET_BOOT_MODE) (IN CONST EFI_PEI_SERVICES **PeiServices, IN EFI_BOOT_MODE BootMode) |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_PEI_GET_HOB_LIST) (IN CONST EFI_PEI_SERVICES **PeiServices, OUT VOID **HobList) |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_PEI_CREATE_HOB) (IN CONST EFI_PEI_SERVICES **PeiServices, IN UINT16 Type, IN UINT16 Length, IN OUT VOID **Hob) |
| |
| 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) |
| |
| 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) |
| |
| 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) |
| |
| 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) |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_PEI_INSTALL_PEI_MEMORY) (IN CONST EFI_PEI_SERVICES **PeiServices, IN EFI_PHYSICAL_ADDRESS MemoryBegin, IN UINT64 MemoryLength) |
| |
| 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) |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_PEI_FREE_PAGES) (IN CONST EFI_PEI_SERVICES **PeiServices, IN EFI_PHYSICAL_ADDRESS Memory, IN UINTN Pages) |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_PEI_ALLOCATE_POOL) (IN CONST EFI_PEI_SERVICES **PeiServices, IN UINTN Size, OUT VOID **Buffer) |
| |
| typedef VOID(EFIAPI * | EFI_PEI_COPY_MEM) (IN VOID *Destination, IN VOID *Source, IN UINTN Length) |
| |
| typedef VOID(EFIAPI * | EFI_PEI_SET_MEM) (IN VOID *Buffer, IN UINTN Size, IN UINT8 Value) |
| |
| 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 OPTIONAL, IN CONST EFI_STATUS_CODE_DATA *Data OPTIONAL) |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_PEI_RESET_SYSTEM) (IN CONST EFI_PEI_SERVICES **PeiServices) |
| |
| typedef VOID(EFIAPI * | EFI_PEI_RESET2_SYSTEM) (IN EFI_RESET_TYPE ResetType, IN EFI_STATUS ResetStatus, IN UINTN DataSize, IN VOID *ResetData OPTIONAL) |
| |
| 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) |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_PEI_FFS_GET_FILE_INFO) (IN EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_FV_FILE_INFO *FileInfo) |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_PEI_FFS_GET_FILE_INFO2) (IN EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_FV_FILE_INFO2 *FileInfo) |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_PEI_FFS_GET_VOLUME_INFO) (IN EFI_PEI_FV_HANDLE VolumeHandle, OUT EFI_FV_INFO *VolumeInfo) |
| |
| typedef EFI_STATUS(EFIAPI * | EFI_PEI_REGISTER_FOR_SHADOW) (IN EFI_PEI_FILE_HANDLE FileHandle) |
| |
| typedef struct _EFI_SEC_PEI_HAND_OFF | EFI_SEC_PEI_HAND_OFF |
| |
| typedef VOID(EFIAPI * | EFI_PEI_CORE_ENTRY_POINT) (IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData, IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList) |
| |
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
- Revision Reference:
- PI Version 1.8.A
Definition in file PiPeiCis.h.
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.
- Parameters
-
| 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. |
- Return values
-
| 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. |
Definition at line 465 of file PiPeiCis.h.
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.
- Parameters
-
| 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. |
Definition at line 1050 of file PiPeiCis.h.
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.
- Parameters
-
| 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. |
- Return values
-
| EFI_SUCCESS | The file was found. |
| EFI_NOT_FOUND | The file was not found. |
| EFI_NOT_FOUND | The header checksum was not zero. |
Definition at line 354 of file PiPeiCis.h.
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.
- Parameters
-
| 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. |
- Return values
-
| EFI_SUCCESS | The volume was found. |
| EFI_NOT_FOUND | The volume was not found. |
| EFI_INVALID_PARAMETER | VolumeHandle is NULL. |
Definition at line 325 of file PiPeiCis.h.
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.
- Parameters
-
| 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. |
- Return values
-
| EFI_SUCCESS | The section was found. |
| EFI_NOT_FOUND | The section was not found. |
Definition at line 382 of file PiPeiCis.h.
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.
- Parameters
-
| 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. |
- Return values
-
| EFI_SUCCESS | The section was found. |
| EFI_NOT_FOUND | The section was not found. |
Definition at line 412 of file PiPeiCis.h.
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.
- Parameters
-
| FileHandle | The handle of the file. |
| FileInfo | Upon exit, points to the file's information. |
- Return values
-
| EFI_SUCCESS | File information was returned. |
| EFI_INVALID_PARAMETER | FileHandle does not represent a valid file. |
| EFI_INVALID_PARAMETER | FileInfo is NULL. |
Definition at line 734 of file PiPeiCis.h.
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.
- Parameters
-
| FileHandle | The handle of the file. |
| FileInfo | Upon exit, points to the file's information. |
- Return values
-
| EFI_SUCCESS | File information was returned. |
| EFI_INVALID_PARAMETER | FileHandle does not represent a valid file. |
| EFI_INVALID_PARAMETER | FileInfo is NULL. |
Definition at line 758 of file PiPeiCis.h.
Returns information about the specified volume.
This function returns information about a specific firmware volume, including its name, type, attributes, starting address and size.
- Parameters
-
| VolumeHandle | Handle of the volume. |
| VolumeInfo | Upon exit, points to the volume's information. |
- Return values
-
| 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. |
Definition at line 810 of file PiPeiCis.h.
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.
- Parameters
-
| FileHandle | PEIM's file handle. Must be the currently executing PEIM. |
- Return values
-
| 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. |
Definition at line 841 of file PiPeiCis.h.
1.9.6