TianoCore EDK2 master
PiPeiCis.h File Reference
#include <Uefi/UefiMultiPhase.h>
#include <Pi/PiMultiPhase.h>
#include <Ppi/CpuIo.h>
#include <Ppi/PciCfg2.h>

Go to the source code of this file.

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))
 

Typedefs

typedef VOIDEFI_PEI_FV_HANDLE
 
typedef VOIDEFI_PEI_FILE_HANDLE
 
typedef struct _EFI_PEI_SERVICES EFI_PEI_SERVICES
 
typedef struct _EFI_PEI_NOTIFY_DESCRIPTOR EFI_PEI_NOTIFY_DESCRIPTOR
 
typedef EFI_STATUS(EFIAPIEFI_PEIM_ENTRY_POINT2) (IN EFI_PEI_FILE_HANDLE FileHandle, IN CONST EFI_PEI_SERVICES **PeiServices)
 
typedef EFI_STATUS(EFIAPIEFI_PEIM_NOTIFY_ENTRY_POINT) (IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor, IN VOID *Ppi)
 
typedef EFI_STATUS(EFIAPIEFI_PEI_INSTALL_PPI) (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList)
 
typedef EFI_STATUS(EFIAPIEFI_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(EFIAPIEFI_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(EFIAPIEFI_PEI_NOTIFY_PPI) (IN CONST EFI_PEI_SERVICES **PeiServices, IN CONST EFI_PEI_NOTIFY_DESCRIPTOR *NotifyList)
 
typedef EFI_STATUS(EFIAPIEFI_PEI_GET_BOOT_MODE) (IN CONST EFI_PEI_SERVICES **PeiServices, OUT EFI_BOOT_MODE *BootMode)
 
typedef EFI_STATUS(EFIAPIEFI_PEI_SET_BOOT_MODE) (IN CONST EFI_PEI_SERVICES **PeiServices, IN EFI_BOOT_MODE BootMode)
 
typedef EFI_STATUS(EFIAPIEFI_PEI_GET_HOB_LIST) (IN CONST EFI_PEI_SERVICES **PeiServices, OUT VOID **HobList)
 
typedef EFI_STATUS(EFIAPIEFI_PEI_CREATE_HOB) (IN CONST EFI_PEI_SERVICES **PeiServices, IN UINT16 Type, IN UINT16 Length, IN OUT VOID **Hob)
 
typedef EFI_STATUS(EFIAPIEFI_PEI_FFS_FIND_NEXT_VOLUME2) (IN CONST EFI_PEI_SERVICES **PeiServices, IN UINTN Instance, OUT EFI_PEI_FV_HANDLE *VolumeHandle)
 
typedef EFI_STATUS(EFIAPIEFI_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(EFIAPIEFI_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(EFIAPIEFI_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(EFIAPIEFI_PEI_INSTALL_PEI_MEMORY) (IN CONST EFI_PEI_SERVICES **PeiServices, IN EFI_PHYSICAL_ADDRESS MemoryBegin, IN UINT64 MemoryLength)
 
typedef EFI_STATUS(EFIAPIEFI_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(EFIAPIEFI_PEI_FREE_PAGES) (IN CONST EFI_PEI_SERVICES **PeiServices, IN EFI_PHYSICAL_ADDRESS Memory, IN UINTN Pages)
 
typedef EFI_STATUS(EFIAPIEFI_PEI_ALLOCATE_POOL) (IN CONST EFI_PEI_SERVICES **PeiServices, IN UINTN Size, OUT VOID **Buffer)
 
typedef VOID(EFIAPIEFI_PEI_COPY_MEM) (IN VOID *Destination, IN VOID *Source, IN UINTN Length)
 
typedef VOID(EFIAPIEFI_PEI_SET_MEM) (IN VOID *Buffer, IN UINTN Size, IN UINT8 Value)
 
typedef EFI_STATUS(EFIAPIEFI_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(EFIAPIEFI_PEI_RESET_SYSTEM) (IN CONST EFI_PEI_SERVICES **PeiServices)
 
typedef VOID(EFIAPIEFI_PEI_RESET2_SYSTEM) (IN EFI_RESET_TYPE ResetType, IN EFI_STATUS ResetStatus, IN UINTN DataSize, IN VOID *ResetData OPTIONAL)
 
typedef EFI_STATUS(EFIAPIEFI_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(EFIAPIEFI_PEI_FFS_GET_FILE_INFO) (IN EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_FV_FILE_INFO *FileInfo)
 
typedef EFI_STATUS(EFIAPIEFI_PEI_FFS_GET_FILE_INFO2) (IN EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_FV_FILE_INFO2 *FileInfo)
 
typedef EFI_STATUS(EFIAPIEFI_PEI_FFS_GET_VOLUME_INFO) (IN EFI_PEI_FV_HANDLE VolumeHandle, OUT EFI_FV_INFO *VolumeInfo)
 
typedef EFI_STATUS(EFIAPIEFI_PEI_REGISTER_FOR_SHADOW) (IN EFI_PEI_FILE_HANDLE FileHandle)
 
typedef struct _EFI_SEC_PEI_HAND_OFF EFI_SEC_PEI_HAND_OFF
 
typedef VOID(EFIAPIEFI_PEI_CORE_ENTRY_POINT) (IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData, IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList)
 

Detailed Description

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.7.

Definition in file PiPeiCis.h.

Macro Definition Documentation

◆ EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK

#define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK   0x00000020

Definition at line 82 of file PiPeiCis.h.

◆ EFI_PEI_PPI_DESCRIPTOR_NOTIFY_DISPATCH

#define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_DISPATCH   0x00000040

Definition at line 83 of file PiPeiCis.h.

◆ EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES

#define EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES   0x00000060

Definition at line 84 of file PiPeiCis.h.

◆ EFI_PEI_PPI_DESCRIPTOR_PIC

#define EFI_PEI_PPI_DESCRIPTOR_PIC   0x00000001

Definition at line 80 of file PiPeiCis.h.

◆ EFI_PEI_PPI_DESCRIPTOR_PPI

#define EFI_PEI_PPI_DESCRIPTOR_PPI   0x00000010

Definition at line 81 of file PiPeiCis.h.

◆ EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST

#define EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST   0x80000000

Definition at line 85 of file PiPeiCis.h.

◆ PEI_SERVICES_REVISION

#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:

Definition at line 866 of file PiPeiCis.h.

◆ PEI_SERVICES_SIGNATURE

#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.

Definition at line 859 of file PiPeiCis.h.

◆ PEI_SPECIFICATION_MAJOR_REVISION

#define PEI_SPECIFICATION_MAJOR_REVISION   1

Definition at line 849 of file PiPeiCis.h.

◆ PEI_SPECIFICATION_MINOR_REVISION

#define PEI_SPECIFICATION_MINOR_REVISION   70

Definition at line 850 of file PiPeiCis.h.

Typedef Documentation

◆ EFI_PEI_ALLOCATE_PAGES

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.

Parameters
PeiServicesAn indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
MemoryTypeThe type of memory to allocate.
PagesThe number of contiguous 4 KB pages to allocate.
MemoryA pointer to a physical address. On output, the address is set to the base of the page range that was allocated.
Return values
EFI_SUCCESSThe memory range was successfully allocated.
EFI_OUT_OF_RESOURCESThe pages could not be allocated.
EFI_INVALID_PARAMETERThe type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode, EfiRuntimeServicesData, EfiBootServicesCode, EfiBootServicesData, EfiACPIReclaimMemory, EfiReservedMemoryType, or EfiACPIMemoryNVS.

Definition at line 465 of file PiPeiCis.h.

◆ EFI_PEI_ALLOCATE_POOL

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.

Parameters
PeiServicesAn indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
SizeThe number of bytes to allocate from the pool.
BufferIf the call succeeds, a pointer to a pointer to the allocated buffer; undefined otherwise.
Return values
EFI_SUCCESSThe allocation was successful.
EFI_OUT_OF_RESOURCESThere is not enough heap to allocate the requested size.

Definition at line 507 of file PiPeiCis.h.

◆ EFI_PEI_COPY_MEM

typedef VOID(EFIAPI * EFI_PEI_COPY_MEM) (IN VOID *Destination, IN VOID *Source, IN UINTN Length)

This service copies the contents of one buffer to another buffer.

Parameters
DestinationThe pointer to the destination buffer of the memory copy.
SourceThe pointer to the source buffer of the memory copy.
LengthThe number of bytes to copy from Source to Destination.

Definition at line 523 of file PiPeiCis.h.

◆ EFI_PEI_CORE_ENTRY_POINT

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.

Parameters
SecCoreDataPoints 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.
PpiListPoints 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.

◆ EFI_PEI_CREATE_HOB

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.

Parameters
PeiServicesAn indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
TypeThe type of HOB to be installed.
LengthThe length of the HOB to be added.
HobThe address of a pointer that will contain the HOB header.
Return values
EFI_SUCCESSThe HOB was successfully created.
EFI_OUT_OF_RESOURCESThere is no additional space for HOB creation.

Definition at line 297 of file PiPeiCis.h.

◆ EFI_PEI_FFS_FIND_BY_NAME

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.

Parameters
FileNameA pointer to the name of the file to find within the firmware volume.
VolumeHandleThe firmware volume to search.
FileHandleUpon exit, points to the found file's handle or NULL if it could not be found.
Return values
EFI_SUCCESSThe file was found.
EFI_NOT_FOUNDThe file was not found.
EFI_INVALID_PARAMETERVolumeHandle or FileHandle or FileName was NULL.

Definition at line 648 of file PiPeiCis.h.

◆ EFI_PEI_FFS_FIND_NEXT_FILE2

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.

Parameters
PeiServicesAn indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
SearchTypeA filter to find files only of this type.
FvHandleHandle of firmware volume in which to search.
FileHandleOn 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_SUCCESSThe file was found.
EFI_NOT_FOUNDThe file was not found.
EFI_NOT_FOUNDThe header checksum was not zero.

Definition at line 354 of file PiPeiCis.h.

◆ EFI_PEI_FFS_FIND_NEXT_VOLUME2

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.

Parameters
PeiServicesAn indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
InstanceThis instance of the firmware volume to find. The value 0 is the Boot Firmware Volume (BFV).
VolumeHandleOn exit, points to the next volumn handle or NULL if it does not exist.
Return values
EFI_SUCCESSThe volume was found.
EFI_NOT_FOUNDThe volume was not found.
EFI_INVALID_PARAMETERVolumeHandle is NULL.

Definition at line 325 of file PiPeiCis.h.

◆ EFI_PEI_FFS_FIND_SECTION_DATA2

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.

Parameters
PeiServicesAn indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
SectionTypeThe value of the section type to find.
FileHandleHandle of the firmware file to search.
SectionDataA pointer to the discovered section, if successful.
Return values
EFI_SUCCESSThe section was found.
EFI_NOT_FOUNDThe section was not found.

Definition at line 382 of file PiPeiCis.h.

◆ EFI_PEI_FFS_FIND_SECTION_DATA3

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.

Parameters
PeiServicesAn indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
SectionTypeThe value of the section type to find.
SectionInstanceSection instance to find.
FileHandleHandle of the firmware file to search.
SectionDataA pointer to the discovered section, if successful.
AuthenticationStatusA pointer to the authentication status for this section.
Return values
EFI_SUCCESSThe section was found.
EFI_NOT_FOUNDThe section was not found.

Definition at line 412 of file PiPeiCis.h.

◆ EFI_PEI_FFS_GET_FILE_INFO

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.

Parameters
FileHandleThe handle of the file.
FileInfoUpon exit, points to the file's information.
Return values
EFI_SUCCESSFile information was returned.
EFI_INVALID_PARAMETERFileHandle does not represent a valid file.
EFI_INVALID_PARAMETERFileInfo is NULL.

Definition at line 734 of file PiPeiCis.h.

◆ EFI_PEI_FFS_GET_FILE_INFO2

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.

Parameters
FileHandleThe handle of the file.
FileInfoUpon exit, points to the file's information.
Return values
EFI_SUCCESSFile information was returned.
EFI_INVALID_PARAMETERFileHandle does not represent a valid file.
EFI_INVALID_PARAMETERFileInfo is NULL.

Definition at line 758 of file PiPeiCis.h.

◆ EFI_PEI_FFS_GET_VOLUME_INFO

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.

Parameters
VolumeHandleHandle of the volume.
VolumeInfoUpon exit, points to the volume's information.
Return values
EFI_SUCCESSThe volume information returned.
EFI_INVALID_PARAMETERIf VolumeHandle does not represent a valid volume.
EFI_INVALID_PARAMETERIf VolumeHandle is NULL.
EFI_SUCCESSInformation was successfully returned.
EFI_INVALID_PARAMETERThe volume designated by the VolumeHandle is not available.

Definition at line 810 of file PiPeiCis.h.

◆ EFI_PEI_FILE_HANDLE

The handles of EFI FFS.

Definition at line 26 of file PiPeiCis.h.

◆ EFI_PEI_FREE_PAGES

typedef EFI_STATUS(EFIAPI * EFI_PEI_FREE_PAGES) (IN CONST EFI_PEI_SERVICES **PeiServices, IN EFI_PHYSICAL_ADDRESS Memory, IN UINTN Pages)

Frees memory pages.

Parameters
[in]PeiServicesAn indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
[in]MemoryThe base physical address of the pages to be freed.
[in]PagesThe number of contiguous 4 KB pages to free.
Return values
EFI_SUCCESSThe requested pages were freed.
EFI_INVALID_PARAMETERMemory is not a page-aligned address or Pages is invalid.
EFI_NOT_FOUNDThe requested memory pages were not allocated with AllocatePages().

Definition at line 487 of file PiPeiCis.h.

◆ EFI_PEI_FV_HANDLE

The handles of EFI FV.

Definition at line 21 of file PiPeiCis.h.

◆ EFI_PEI_GET_BOOT_MODE

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.

Parameters
PeiServicesAn indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
BootModeA pointer to contain the value of the boot mode.
Return values
EFI_SUCCESSThe boot mode returned successfully.

Definition at line 245 of file PiPeiCis.h.

◆ EFI_PEI_GET_HOB_LIST

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.

Parameters
PeiServicesAn indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
HobListA pointer to the list of HOBs that the PEI Foundation will initialize
Return values
EFI_SUCCESSThe list was successfully returned.
EFI_NOT_AVAILABLE_YETThe HOB list is not yet published.

Definition at line 278 of file PiPeiCis.h.

◆ EFI_PEI_INSTALL_PEI_MEMORY

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.

Parameters
PeiServicesAn indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
MemoryBeginThe value of a region of installed memory.
MemoryLengthThe corresponding length of a region of installed memory.
Return values
EFI_SUCCESSThe region was successfully installed in a HOB.
EFI_INVALID_PARAMETERMemoryBegin and MemoryLength are illegal for this system.
EFI_OUT_OF_RESOURCESThere is no additional space for HOB creation.

Definition at line 435 of file PiPeiCis.h.

◆ EFI_PEI_INSTALL_PPI

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.

Parameters
PeiServicesAn indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
PpiListA pointer to the list of interfaces that the caller shall install.
Return values
EFI_SUCCESSThe interface was successfully installed.
EFI_INVALID_PARAMETERThe 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_RESOURCESThere is no additional space in the PPI database.

Definition at line 158 of file PiPeiCis.h.

◆ EFI_PEI_LOCATE_PPI

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)

This function locates an interface in the PEI PPI database by GUID.

Parameters
PeiServicesAn indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation.
GuidA pointer to the GUID whose corresponding interface needs to be found.
InstanceThe N-th instance of the interface that is required.
PpiDescriptorA pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.
PpiA pointer to the instance of the interface.
Return values
EFI_SUCCESSThe interface was successfully returned.
EFI_NOT_FOUNDThe PPI descriptor is not found in the database.

Definition at line 204 of file PiPeiCis.h.

◆ EFI_PEI_NOTIFY_DESCRIPTOR

Declare the forward reference data structure for EFI_PEI_NOTIFY_DESCRIPTOR.

Definition at line 36 of file PiPeiCis.h.

◆ EFI_PEI_NOTIFY_PPI

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.

Parameters
PeiServicesAn indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
NotifyListA pointer to the list of notification interfaces that the caller shall install.
Return values
EFI_SUCCESSThe interface was successfully installed.
EFI_INVALID_PARAMETERThe 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_RESOURCESThere is no additional space in the PPI database.

Definition at line 229 of file PiPeiCis.h.

◆ EFI_PEI_REGISTER_FOR_SHADOW

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.

Parameters
FileHandlePEIM's file handle. Must be the currently executing PEIM.
Return values
EFI_SUCCESSThe PEIM was successfully registered for shadowing.
EFI_ALREADY_STARTEDThe PEIM was previously registered for shadowing.
EFI_NOT_FOUNDThe FileHandle does not refer to a valid file handle.

Definition at line 841 of file PiPeiCis.h.

◆ EFI_PEI_REINSTALL_PPI

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.

Parameters
PeiServicesAn indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
OldPpiA pointer to the former PPI in the database.
NewPpiA pointer to the new interfaces that the caller shall install.
Return values
EFI_SUCCESSThe interface was successfully installed.
EFI_INVALID_PARAMETERThe 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_RESOURCESThere is no additional space in the PPI database.
EFI_NOT_FOUNDThe PPI for which the reinstallation was requested has not been installed.

Definition at line 183 of file PiPeiCis.h.

◆ EFI_PEI_REPORT_STATUS_CODE

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)

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.

Parameters
PeiServicesAn indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
TypeIndicates the type of status code being reported.
ValueDescribes 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.
InstanceThe 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.
CallerIdThis optional parameter may be used to identify the caller. This parameter allows the status code driver to apply different rules to different callers.
DataThis optional parameter may be used to pass additional data.
Return values
EFI_SUCCESSThe function completed successfully.
EFI_NOT_AVAILABLE_YETNo progress code provider has installed an interface in the system.

Definition at line 576 of file PiPeiCis.h.

◆ EFI_PEI_RESET2_SYSTEM

typedef VOID(EFIAPI * EFI_PEI_RESET2_SYSTEM) (IN EFI_RESET_TYPE ResetType, IN EFI_STATUS ResetStatus, IN UINTN DataSize, IN VOID *ResetData OPTIONAL)

Resets the entire platform.

Parameters
[in]ResetTypeThe type of reset to perform.
[in]ResetStatusThe status code for the reset.
[in]DataSizeThe size, in bytes, of ResetData.
[in]ResetDataFor 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.

Definition at line 619 of file PiPeiCis.h.

◆ EFI_PEI_RESET_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.

Parameters
PeiServicesAn indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
Return values
EFI_NOT_AVAILABLE_YETThe service has not been installed yet.

Definition at line 600 of file PiPeiCis.h.

◆ EFI_PEI_SERVICES

Declare the forward reference data structure for EFI_PEI_SERVICE.

Definition at line 31 of file PiPeiCis.h.

◆ EFI_PEI_SET_BOOT_MODE

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.

Parameters
PeiServicesAn indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
BootModeThe value of the boot mode to set.
Return values
EFI_SUCCESSThe boot mode returned successfully.

Definition at line 261 of file PiPeiCis.h.

◆ EFI_PEI_SET_MEM

typedef VOID(EFIAPI * EFI_PEI_SET_MEM) (IN VOID *Buffer, IN UINTN Size, IN UINT8 Value)

The service fills a buffer with a specified value.

Parameters
BufferThe pointer to the buffer to fill.
SizeThe number of bytes in Buffer to fill.
ValueThe value to fill Buffer with.

Definition at line 539 of file PiPeiCis.h.

◆ EFI_PEIM_ENTRY_POINT2

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.

Parameters
FileHandlePointer to the FFS file header.
PeiServicesDescribes the list of possible PEI Services.
Return values
EFI_SUCCESSThe PEI completed successfully.
!EFI_SUCCESSThere is error in PEIM.

Definition at line 53 of file PiPeiCis.h.

◆ EFI_PEIM_NOTIFY_ENTRY_POINT

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.

Parameters
PeiServicesIndirect reference to the PEI Services Table.
NotifyDescriptorAddress of the notification descriptor data structure.
PpiAddress of the PPI that was installed.
Returns
Status of the notification. The status code returned from this function is ignored.

Definition at line 70 of file PiPeiCis.h.

◆ 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.