MdePkg/Include/Ppi/FirmwareVolume.h File Reference


Data Structures

struct  _EFI_PEI_FIRMWARE_VOLUME_PPI

Defines

#define EFI_PEI_FIRMWARE_VOLUME_PPI_SIGNATURE   SIGNATURE_32 ('P', 'F', 'V', 'P')
#define EFI_PEI_FIRMWARE_VOLUME_PPI_REVISION   0x00010030

Typedefs

typedef struct
_EFI_PEI_FIRMWARE_VOLUME_PPI 
EFI_PEI_FIRMWARE_VOLUME_PPI
typedef EFI_STATUS(EFIAPIEFI_PEI_FV_PROCESS_FV )(IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, IN VOID *Buffer, IN UINTN BufferSize, OUT EFI_PEI_FV_HANDLE *FvHandle)
typedef EFI_STATUS(EFIAPIEFI_PEI_FV_FIND_FILE_TYPE )(IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, IN EFI_FV_FILETYPE SearchType, IN EFI_PEI_FV_HANDLE FvHandle, IN OUT EFI_PEI_FILE_HANDLE *FileHandle)
typedef EFI_STATUS(EFIAPIEFI_PEI_FV_FIND_FILE_NAME )(IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, IN CONST EFI_GUID *FileName, IN EFI_PEI_FV_HANDLE *FvHandle, OUT EFI_PEI_FILE_HANDLE *FileHandle)
typedef EFI_STATUS(EFIAPIEFI_PEI_FV_GET_FILE_INFO )(IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, IN EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_FV_FILE_INFO *FileInfo)
typedef EFI_STATUS(EFIAPIEFI_PEI_FV_GET_FILE_INFO2 )(IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, IN EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_FV_FILE_INFO2 *FileInfo)
typedef EFI_STATUS(EFIAPIEFI_PEI_FV_GET_INFO )(IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, IN EFI_PEI_FV_HANDLE FvHandle, OUT EFI_FV_INFO *VolumeInfo)
typedef EFI_STATUS(EFIAPIEFI_PEI_FV_FIND_SECTION )(IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, IN EFI_SECTION_TYPE SearchType, IN EFI_PEI_FILE_HANDLE FileHandle, OUT VOID **SectionData)
typedef EFI_STATUS(EFIAPIEFI_PEI_FV_FIND_SECTION2 )(IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, IN EFI_SECTION_TYPE SearchType, IN UINTN SearchInstance, IN EFI_PEI_FILE_HANDLE FileHandle, OUT VOID **SectionData, OUT UINT32 *AuthenticationStatus)

Variables

EFI_GUID gEfiPeiFirmwareVolumePpiGuid

Detailed Description

This file provides functions for accessing a memory-mapped firmware volume of a specific format.

Copyright (c) 2006 - 2013, 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.

Revision Reference:
This PPI is from PI Version 1.0 errata.

Define Documentation

#define EFI_PEI_FIRMWARE_VOLUME_PPI_REVISION   0x00010030

#define EFI_PEI_FIRMWARE_VOLUME_PPI_SIGNATURE   SIGNATURE_32 ('P', 'F', 'V', 'P')


Typedef Documentation

The GUID for this PPI is the same as the firmware volume format GUID. The FV format can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for a user-defined format. The EFI_FIRMWARE_FILE_SYSTEM2_GUID is the PI Firmware Volume format.

typedef EFI_STATUS(EFIAPI * EFI_PEI_FV_FIND_FILE_NAME)(IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, IN CONST EFI_GUID *FileName, IN EFI_PEI_FV_HANDLE *FvHandle, 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.

Parameters:
This Points to this instance of the EFI_PEI_FIRMWARE_VOLUME_PPI.
FileName A pointer to the name of the file to find within the firmware volume.
FvHandle Upon entry, the pointer to the firmware volume to search or NULL if all firmware volumes should be searched. Upon exit, the actual firmware volume in which the file was found.
FileHandle Upon exit, points to the found file's handle or NULL if it could not be found.
Return values:
EFI_SUCCESS File was found.
EFI_NOT_FOUND File was not found.
EFI_INVALID_PARAMETER FvHandle or FileHandle or FileName was NULL.

typedef EFI_STATUS(EFIAPI * EFI_PEI_FV_FIND_FILE_TYPE)(IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, IN EFI_FV_FILETYPE SearchType, IN EFI_PEI_FV_HANDLE FvHandle, IN OUT EFI_PEI_FILE_HANDLE *FileHandle)

Finds the next file of the specified type.

This service enables PEI modules to discover additional firmware files. The FileHandle must be unique within the system.

Parameters:
This Points to this instance of the EFI_PEI_FIRMWARE_VOLUME_PPI.
SearchType A filter to find only files of this type. Type EFI_FV_FILETYPE_ALL causes no filtering to be done.
FvHandle Handle of firmware volume in which to search.
FileHandle Points to the current handle from which to begin searching or NULL to start at the beginning of the firmware volume. Updated upon return to reflect the file found.
Return values:
EFI_SUCCESS The file was found.
EFI_NOT_FOUND The file was not found. FileHandle contains NULL.

typedef EFI_STATUS(EFIAPI * EFI_PEI_FV_FIND_SECTION)(IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, IN EFI_SECTION_TYPE SearchType, IN EFI_PEI_FILE_HANDLE FileHandle, OUT VOID **SectionData)

Find the next matching section in the firmware file.

This service enables PEI modules to discover sections of a given type within a valid file.

Parameters:
This Points to this instance of the EFI_PEI_FIRMWARE_VOLUME_PPI.
SearchType A filter to find only sections of this type.
FileHandle Handle of firmware file in which to search.
SectionData Updated upon return to point to the section found.
Return values:
EFI_SUCCESS Section was found.
EFI_NOT_FOUND Section of the specified type was not found. SectionData contains NULL.

typedef EFI_STATUS(EFIAPI * EFI_PEI_FV_FIND_SECTION2)(IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, IN EFI_SECTION_TYPE SearchType, IN UINTN SearchInstance, IN EFI_PEI_FILE_HANDLE FileHandle, OUT VOID **SectionData, OUT UINT32 *AuthenticationStatus)

Find the next matching section in the firmware file.

This service enables PEI modules to discover sections of a given instance and type within a valid file.

Parameters:
This Points to this instance of the EFI_PEI_FIRMWARE_VOLUME_PPI.
SearchType A filter to find only sections of this type.
SearchInstance A filter to find the specific instance of sections.
FileHandle Handle of firmware file in which to search.
SectionData Updated upon return to point to the section found.
AuthenticationStatus Updated upon return to point to the authentication status for this section.
Return values:
EFI_SUCCESS Section was found.
EFI_NOT_FOUND Section of the specified type was not found. SectionData contains NULL.

typedef EFI_STATUS(EFIAPI * EFI_PEI_FV_GET_FILE_INFO)(IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, 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.

Parameters:
This Points to this instance of the EFI_PEI_FIRMWARE_VOLUME_PPI.
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.

typedef EFI_STATUS(EFIAPI * EFI_PEI_FV_GET_FILE_INFO2)(IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, 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.

Parameters:
This Points to this instance of the EFI_PEI_FIRMWARE_VOLUME_PPI.
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.

typedef EFI_STATUS(EFIAPI * EFI_PEI_FV_GET_INFO)(IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, IN EFI_PEI_FV_HANDLE FvHandle, OUT EFI_FV_INFO *VolumeInfo)

This function returns information about the firmware volume.

Parameters:
This Points to this instance of the EFI_PEI_FIRMWARE_VOLUME_PPI.
FvHandle Handle to the firmware handle.
VolumeInfo Points to the returned firmware volume information.
Return values:
EFI_SUCCESS Information returned successfully.
EFI_INVALID_PARAMETER FvHandle does not indicate a valid firmware volume or VolumeInfo is NULL.

typedef EFI_STATUS(EFIAPI * EFI_PEI_FV_PROCESS_FV)(IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This, IN VOID *Buffer, IN UINTN BufferSize, OUT EFI_PEI_FV_HANDLE *FvHandle)

Process a firmware volume and create a volume handle.

Create a volume handle from the information in the buffer. For memory-mapped firmware volumes, Buffer and BufferSize refer to the start of the firmware volume and the firmware volume size. For non memory-mapped firmware volumes, this points to a buffer which contains the necessary information for creating the firmware volume handle. Normally, these values are derived from the EFI_FIRMWARE_VOLUME_INFO_PPI.

Parameters:
This Points to this instance of the EFI_PEI_FIRMWARE_VOLUME_PPI.
Buffer Points to the start of the buffer.
BufferSize Size of the buffer.
FvHandle Points to the returned firmware volume handle. The firmware volume handle must be unique within the system.
Return values:
EFI_SUCCESS Firmware volume handle created.
EFI_VOLUME_CORRUPTED Volume was corrupt.


Variable Documentation


Generated on Thu Sep 24 23:14:18 2015 for MdePkg[ALL] by  doxygen 1.5.7.1