MdePkg/Include/Library/PeiServicesLib.h File Reference
|
Functions |
EFI_STATUS EFIAPI | PeiServicesInstallPpi (IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList) |
EFI_STATUS EFIAPI | PeiServicesReInstallPpi (IN CONST EFI_PEI_PPI_DESCRIPTOR *OldPpi, IN CONST EFI_PEI_PPI_DESCRIPTOR *NewPpi) |
EFI_STATUS EFIAPI | PeiServicesLocatePpi (IN CONST EFI_GUID *Guid, IN UINTN Instance, IN OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor, IN OUT VOID **Ppi) |
EFI_STATUS EFIAPI | PeiServicesNotifyPpi (IN CONST EFI_PEI_NOTIFY_DESCRIPTOR *NotifyList) |
EFI_STATUS EFIAPI | PeiServicesGetBootMode (OUT EFI_BOOT_MODE *BootMode) |
EFI_STATUS EFIAPI | PeiServicesSetBootMode (IN EFI_BOOT_MODE BootMode) |
EFI_STATUS EFIAPI | PeiServicesGetHobList (OUT VOID **HobList) |
EFI_STATUS EFIAPI | PeiServicesCreateHob (IN UINT16 Type, IN UINT16 Length, OUT VOID **Hob) |
EFI_STATUS EFIAPI | PeiServicesFfsFindNextVolume (IN UINTN Instance, IN OUT EFI_PEI_FV_HANDLE *VolumeHandle) |
EFI_STATUS EFIAPI | PeiServicesFfsFindNextFile (IN EFI_FV_FILETYPE SearchType, IN EFI_PEI_FV_HANDLE VolumeHandle, IN OUT EFI_PEI_FILE_HANDLE *FileHandle) |
EFI_STATUS EFIAPI | PeiServicesFfsFindSectionData (IN EFI_SECTION_TYPE SectionType, IN EFI_PEI_FILE_HANDLE FileHandle, OUT VOID **SectionData) |
EFI_STATUS EFIAPI | PeiServicesFfsFindSectionData3 (IN EFI_SECTION_TYPE SectionType, IN UINTN SectionInstance, IN EFI_PEI_FILE_HANDLE FileHandle, OUT VOID **SectionData, OUT UINT32 *AuthenticationStatus) |
EFI_STATUS EFIAPI | PeiServicesInstallPeiMemory (IN EFI_PHYSICAL_ADDRESS MemoryBegin, IN UINT64 MemoryLength) |
EFI_STATUS EFIAPI | PeiServicesAllocatePages (IN EFI_MEMORY_TYPE MemoryType, IN UINTN Pages, OUT EFI_PHYSICAL_ADDRESS *Memory) |
EFI_STATUS EFIAPI | PeiServicesAllocatePool (IN UINTN Size, OUT VOID **Buffer) |
EFI_STATUS EFIAPI | PeiServicesResetSystem (VOID) |
EFI_STATUS EFIAPI | PeiServicesFfsFindFileByName (IN CONST EFI_GUID *FileName, IN CONST EFI_PEI_FV_HANDLE VolumeHandle, OUT EFI_PEI_FILE_HANDLE *FileHandle) |
EFI_STATUS EFIAPI | PeiServicesFfsGetFileInfo (IN CONST EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_FV_FILE_INFO *FileInfo) |
EFI_STATUS EFIAPI | PeiServicesFfsGetFileInfo2 (IN CONST EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_FV_FILE_INFO2 *FileInfo) |
EFI_STATUS EFIAPI | PeiServicesFfsGetVolumeInfo (IN EFI_PEI_FV_HANDLE VolumeHandle, OUT EFI_FV_INFO *VolumeInfo) |
EFI_STATUS EFIAPI | PeiServicesRegisterForShadow (IN EFI_PEI_FILE_HANDLE FileHandle) |
VOID EFIAPI | PeiServicesInstallFvInfoPpi (IN CONST EFI_GUID *FvFormat, IN CONST VOID *FvInfo, IN UINT32 FvInfoSize, IN CONST EFI_GUID *ParentFvName, IN CONST EFI_GUID *ParentFileName) |
VOID EFIAPI | PeiServicesInstallFvInfo2Ppi (IN CONST EFI_GUID *FvFormat, IN CONST VOID *FvInfo, IN UINT32 FvInfoSize, IN CONST EFI_GUID *ParentFvName, IN CONST EFI_GUID *ParentFileName, IN UINT32 AuthenticationStatus) |
Detailed Description
Provides library functions for all PEI Services.
Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Function Documentation
This service enables PEIMs to allocate memory after the permanent memory has been installed by a PEIM.
- Parameters:
-
| MemoryType | Type of memory to allocate. |
| Pages | Number of pages to allocate. |
| Memory | Pointer of memory allocated. |
- Return values:
-
| EFI_SUCCESS | The memory range was successfully allocated. |
| EFI_INVALID_PARAMETER | Type is not equal to AllocateAnyPages. |
| EFI_NOT_AVAILABLE_YET | Called with permanent memory not available. |
| EFI_OUT_OF_RESOURCES | The pages could not be allocated. |
EFI_STATUS EFIAPI PeiServicesAllocatePool |
( |
IN UINTN |
Size, |
|
|
OUT VOID ** |
Buffer | |
|
) |
| | |
This service allocates memory from the Hand-Off Block (HOB) heap.
- Parameters:
-
| Size | The number of bytes to allocate from the pool. |
| Buffer | If the call succeeds, a pointer to a pointer to the allocate buffer; undefined otherwise. |
- Return values:
-
| EFI_SUCCESS | The allocation was successful |
| EFI_OUT_OF_RESOURCES | There is not enough heap to allocate the requested size. |
EFI_STATUS EFIAPI PeiServicesCreateHob |
( |
IN UINT16 |
Type, |
|
|
IN UINT16 |
Length, |
|
|
OUT VOID ** |
Hob | |
|
) |
| | |
This service enables PEIMs to create various types of HOBs.
- Parameters:
-
| 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. |
- Return values:
-
| EFI_SUCCESS | The HOB was successfully created. |
| EFI_OUT_OF_RESOURCES | There is no additional space for HOB creation. |
This service is a wrapper for the PEI Service FfsFindByName(), except the pointer to the PEI Services Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface Specification for details.
- Parameters:
-
| 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. |
| FileHandle | Pointer to found file handle |
- Return values:
-
| EFI_SUCCESS | File was found. |
| EFI_NOT_FOUND | File was not found. |
| EFI_INVALID_PARAMETER | VolumeHandle or FileHandle or FileName was NULL. |
This service enables PEIMs to discover additional firmware files.
- Parameters:
-
| SearchType | A filter to find files only of this type. |
| VolumeHandle | Pointer to the firmware volume header of the volume to search. This parameter must point to a valid FFS volume. |
| FileHandle | Handle of the current file from which to begin searching. |
- 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. |
EFI_STATUS EFIAPI PeiServicesFfsFindNextVolume |
( |
IN UINTN |
Instance, |
|
|
IN OUT EFI_PEI_FV_HANDLE * |
VolumeHandle | |
|
) |
| | |
This service enables PEIMs to discover additional firmware volumes.
- Parameters:
-
| Instance | This instance of the firmware volume to find. The value 0 is the Boot Firmware Volume (BFV). |
| VolumeHandle | Handle of the firmware volume header of the volume to return. |
- Return values:
-
| EFI_SUCCESS | The volume was found. |
| EFI_NOT_FOUND | The volume was not found. |
| EFI_INVALID_PARAMETER | FwVolHeader is NULL. |
This service enables PEIMs to discover sections of a given type within a valid FFS file.
- Parameters:
-
| SectionType | The value of the section type to find. |
| FileHandle | A pointer to the file header that contains the set of sections to be searched. |
| 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. |
EFI_STATUS EFIAPI PeiServicesFfsFindSectionData3 |
( |
IN EFI_SECTION_TYPE |
SectionType, |
|
|
IN UINTN |
SectionInstance, |
|
|
IN EFI_PEI_FILE_HANDLE |
FileHandle, |
|
|
OUT VOID ** |
SectionData, |
|
|
OUT UINT32 * |
AuthenticationStatus | |
|
) |
| | |
This service enables PEIMs to discover sections of a given instance and type within a valid FFS file.
- Parameters:
-
| SectionType | The value of the section type to find. |
| SectionInstance | Section instance to find. |
| FileHandle | A pointer to the file header that contains the set of sections to be searched. |
| 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. |
This service is a wrapper for the PEI Service FfsGetFileInfo(), except the pointer to the PEI Services Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface Specification for details.
- Parameters:
-
| FileHandle | Handle of the file. |
| FileInfo | Upon exit, points to the file's information. |
- Return values:
-
| EFI_SUCCESS | File information returned. |
| EFI_INVALID_PARAMETER | If FileHandle does not represent a valid file. |
| EFI_INVALID_PARAMETER | If FileInfo is NULL. |
This service is a wrapper for the PEI Service FfsGetFileInfo2(), except the pointer to the PEI Services Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface Specification for details.
- Parameters:
-
| FileHandle | Handle of the file. |
| FileInfo | Upon exit, points to the file's information. |
- Return values:
-
| EFI_SUCCESS | File information returned. |
| EFI_INVALID_PARAMETER | If FileHandle does not represent a valid file. |
| EFI_INVALID_PARAMETER | If FileInfo is NULL. |
This service is a wrapper for the PEI Service FfsGetVolumeInfo(), except the pointer to the PEI Services Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface Specification for details.
- Parameters:
-
| VolumeHandle | Handle of the volume. |
| VolumeInfo | Upon exit, points to the volume's information. |
- Return values:
-
| EFI_SUCCESS | File information returned. |
| EFI_INVALID_PARAMETER | If FileHandle does not represent a valid file. |
| EFI_INVALID_PARAMETER | If FileInfo is NULL. |
EFI_STATUS EFIAPI PeiServicesGetBootMode |
( |
OUT EFI_BOOT_MODE * |
BootMode |
) |
|
This service enables PEIMs to ascertain the present value of the boot mode.
- Parameters:
-
| BootMode | A pointer to contain the value of the boot mode. |
- Return values:
-
| EFI_SUCCESS | The boot mode was returned successfully. |
| EFI_INVALID_PARAMETER | BootMode is NULL. |
EFI_STATUS EFIAPI PeiServicesGetHobList |
( |
OUT VOID ** |
HobList |
) |
|
This service enables a PEIM to ascertain the address of the list of HOBs in memory.
- Parameters:
-
| HobList | A pointer to the list of HOBs that the PEI Foundation will initialize. |
- Return values:
-
| EFI_SUCCESS | The list was successfully returned. |
| EFI_NOT_AVAILABLE_YET | The HOB list is not yet published. |
VOID EFIAPI PeiServicesInstallFvInfo2Ppi |
( |
IN CONST EFI_GUID * |
FvFormat, |
|
|
IN CONST VOID * |
FvInfo, |
|
|
IN UINT32 |
FvInfoSize, |
|
|
IN CONST EFI_GUID * |
ParentFvName, |
|
|
IN CONST EFI_GUID * |
ParentFileName, |
|
|
IN UINT32 |
AuthenticationStatus | |
|
) |
| | |
Install a EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI instance so the PEI Core will be notified about a new firmware volume.
This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI using the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI instance. If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI, then ASSERT(). If the EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI can not be installed, then ASSERT().
- Parameters:
-
| FvFormat | Unique identifier of the format of the memory-mapped firmware volume. This parameter is optional and may be NULL. If NULL is specified, the EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed. |
| FvInfo | Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume. The format of this buffer is specific to the FvFormat. For memory-mapped firmware volumes, this typically points to the first byte of the firmware volume. |
| FvInfoSize | The size, in bytes, of FvInfo. For memory-mapped firmware volumes, this is typically the size of the firmware volume. |
| ParentFvName | If the new firmware volume originated from a file in a different firmware volume, then this parameter specifies the GUID name of the originating firmware volume. Otherwise, this parameter must be NULL. |
| ParentFileName | If the new firmware volume originated from a file in a different firmware volume, then this parameter specifies the GUID file name of the originating firmware file. Otherwise, this parameter must be NULL. |
| AuthenticationStatus | Authentication Status |
VOID EFIAPI PeiServicesInstallFvInfoPpi |
( |
IN CONST EFI_GUID * |
FvFormat, |
|
|
IN CONST VOID * |
FvInfo, |
|
|
IN UINT32 |
FvInfoSize, |
|
|
IN CONST EFI_GUID * |
ParentFvName, |
|
|
IN CONST EFI_GUID * |
ParentFileName | |
|
) |
| | |
Install a EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance so the PEI Core will be notified about a new firmware volume.
This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO_PPI using the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance. If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO_PPI, then ASSERT(). If the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI can not be installed, then ASSERT().
- Parameters:
-
| FvFormat | Unique identifier of the format of the memory-mapped firmware volume. This parameter is optional and may be NULL. If NULL is specified, the EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed. |
| FvInfo | Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume. The format of this buffer is specific to the FvFormat. For memory-mapped firmware volumes, this typically points to the first byte of the firmware volume. |
| FvInfoSize | The size, in bytes, of FvInfo. For memory-mapped firmware volumes, this is typically the size of the firmware volume. |
| ParentFvName | If the new firmware volume originated from a file in a different firmware volume, then this parameter specifies the GUID name of the originating firmware volume. Otherwise, this parameter must be NULL. |
| ParentFileName | If the new firmware volume originated from a file in a different firmware volume, then this parameter specifies the GUID file name of the originating firmware file. Otherwise, this parameter must be NULL. |
This service enables PEIMs to register the permanent memory configuration that has been initialized with the PEI Foundation.
- Parameters:
-
| MemoryBegin | The value of a region of installed memory. |
| MemoryLength | The corresponding length of a region of installed memory. |
- Return values:
-
| 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. |
This service enables a given PEIM to register an interface into the PEI Foundation.
- Parameters:
-
| PpiList | A pointer to the list of interfaces that the caller shall install. |
- Return values:
-
| EFI_SUCCESS | The interface was successfully installed. |
| EFI_INVALID_PARAMETER | The PpiList pointer is NULL. |
| EFI_INVALID_PARAMETER | 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_STATUS EFIAPI PeiServicesLocatePpi |
( |
IN CONST EFI_GUID * |
Guid, |
|
|
IN UINTN |
Instance, |
|
|
IN OUT EFI_PEI_PPI_DESCRIPTOR ** |
PpiDescriptor, |
|
|
IN OUT VOID ** |
Ppi | |
|
) |
| | |
This service enables PEIMs to discover a given instance of an interface.
- Parameters:
-
| 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. |
- Return values:
-
| EFI_SUCCESS | The interface was successfully returned. |
| EFI_NOT_FOUND | The PPI descriptor is not found in the database. |
This service enables PEIMs to register a given service to be invoked when another service is installed or reinstalled.
- Parameters:
-
| NotifyList | A pointer to the list of notification interfaces that the caller shall install. |
- Return values:
-
| EFI_SUCCESS | The interface was successfully installed. |
| EFI_INVALID_PARAMETER | The NotifyList pointer is NULL. |
| EFI_INVALID_PARAMETER | Any of the PEI notify 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. |
This service is a wrapper for the PEI Service RegisterForShadow(), except the pointer to the PEI Services Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface Specification for details.
- 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. |
This service enables PEIMs to replace an entry in the PPI database with an alternate entry.
- Parameters:
-
| OldPpi | Pointer to the old PEI PPI Descriptors. |
| NewPpi | Pointer to the new PEI PPI Descriptors. |
- Return values:
-
| EFI_SUCCESS | The interface was successfully installed. |
| EFI_INVALID_PARAMETER | The OldPpi or NewPpi is NULL. |
| EFI_INVALID_PARAMETER | 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. |
EFI_STATUS EFIAPI PeiServicesResetSystem |
( |
VOID |
|
) |
|
Resets the entire platform.
- Return values:
-
| EFI_SUCCESS | The function completed successfully. |
| EFI_NOT_AVAILABLE_YET | The service has not been installed yet. |
EFI_STATUS EFIAPI PeiServicesSetBootMode |
( |
IN EFI_BOOT_MODE |
BootMode |
) |
|
This service enables PEIMs to update the boot mode variable.
- Parameters:
-
| BootMode | The value of the boot mode to set. |
- Return values:
-
| EFI_SUCCESS | The value was successfully updated |