Update MdePkg/Include/Ppi according to code review comments.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5818 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
xli24
@@ -21,10 +21,9 @@
|
||||
|
||||
///
|
||||
/// The GUID for this PPI is the same as the firmware volume format GUID.
|
||||
/// 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.
|
||||
/// 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 struct _EFI_PEI_FIRMWARE_VOLUME_PPI EFI_PEI_FIRMWARE_VOLUME_PPI;
|
||||
|
||||
|
||||
@@ -40,26 +39,25 @@ typedef struct _EFI_PEI_FIRMWARE_VOLUME_PPI EFI_PEI_FIRMWARE_VOLUME_PPI;
|
||||
from the EFI_FIRMWARE_VOLUME_INFO_PPI.
|
||||
|
||||
|
||||
@param This Points to this instance of the
|
||||
EFI_PEI_FIRMWARE_VOLUME_PPI
|
||||
@param Buffer Points to the start of the buffer.
|
||||
@param BufferSize Size of the buffer.
|
||||
@param FvHandle Points to the returned firmware volume
|
||||
handle. The firmware volume handle must
|
||||
be unique within the system.
|
||||
@param This Points to this instance of the
|
||||
EFI_PEI_FIRMWARE_VOLUME_PPI.
|
||||
@param Buffer Points to the start of the buffer.
|
||||
@param BufferSize Size of the buffer.
|
||||
@param FvHandle Points to the returned firmware volume
|
||||
handle. The firmware volume handle must
|
||||
be unique within the system.
|
||||
|
||||
|
||||
@retval EFI_SUCCESS Firmware volume handle.
|
||||
@retval EFI_SUCCESS Firmware volume handle created.
|
||||
@retval EFI_VOLUME_CORRUPTED Volume was corrupt.
|
||||
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_PEI_FV_PROCESS_FV)(
|
||||
IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This,
|
||||
IN CONST VOID *Buffer,
|
||||
IN CONST UINTN BufferSize,
|
||||
OUT EFI_PEI_FV_HANDLE *FvHandle
|
||||
IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This,
|
||||
IN VOID *Buffer,
|
||||
IN UINTN BufferSize,
|
||||
OUT EFI_PEI_FV_HANDLE *FvHandle
|
||||
);
|
||||
|
||||
/**
|
||||
@@ -68,29 +66,29 @@ EFI_STATUS
|
||||
This service enables PEI modules to discover additional firmware files.
|
||||
The FileHandle must be unique within the system.
|
||||
|
||||
@param 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.
|
||||
@param FvHandle Handle of firmware volume in which to
|
||||
search.
|
||||
|
||||
@param 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.
|
||||
|
||||
@param This Points to this instance of the
|
||||
EFI_PEI_FIRMWARE_VOLUME_PPI.
|
||||
@param SearchType A filter to find only files of this type. Type
|
||||
EFI_FV_FILETYPE_ALL causes no filtering to be
|
||||
done.
|
||||
@param FvHandle Handle of firmware volume in which to
|
||||
search.
|
||||
@param 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.
|
||||
|
||||
@retval EFI_SUCCESS The file was found.
|
||||
@retval EFI_NOT_FOUND The file was not found. FileHandle contains NULL.
|
||||
|
||||
**/
|
||||
typedef EFI_STATUS
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_PEI_FV_FIND_FILE_TYPE)(
|
||||
IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This,
|
||||
IN CONST EFI_FV_FILETYPE SearchType,
|
||||
IN CONST EFI_PEI_FV_HANDLE FvHandle,
|
||||
IN OUT EFI_PEI_FILE_HANDLE *FileHandle
|
||||
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
|
||||
);
|
||||
|
||||
|
||||
@@ -100,26 +98,21 @@ typedef EFI_STATUS
|
||||
This service searches for files with a specific name, within
|
||||
either the specified firmware volume or all firmware volumes.
|
||||
|
||||
@param This Points to this instance of the
|
||||
EFI_PEI_FIRMWARE_VOLUME_PPI.
|
||||
@param This Points to this instance of the
|
||||
EFI_PEI_FIRMWARE_VOLUME_PPI.
|
||||
@param FileName A pointer to the name of the file to find
|
||||
within the firmware volume.
|
||||
@param 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.
|
||||
@param FileHandle Upon exit, points to the found file's
|
||||
handle or NULL if it could not be found.
|
||||
|
||||
@param FileName A pointer to the name of the file to find
|
||||
within the firmware volume.
|
||||
|
||||
@param 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.
|
||||
|
||||
@param FileHandle Upon exit, points to the found file's
|
||||
handle or NULL if it could not be found.
|
||||
|
||||
@retval EFI_SUCCESS File was found.
|
||||
|
||||
@param EFI_NOT_FOUND File was not found.
|
||||
|
||||
@param EFI_INVALID_PARAMETER FvHandle or FileHandle or
|
||||
@retval EFI_SUCCESS File was found.
|
||||
@retval EFI_NOT_FOUND File was not found.
|
||||
@retval EFI_INVALID_PARAMETER FvHandle or FileHandle or
|
||||
FileName was NULL.
|
||||
|
||||
|
||||
@@ -127,10 +120,10 @@ typedef EFI_STATUS
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_PEI_FV_FIND_FILE_NAME)(
|
||||
IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This,
|
||||
IN CONST EFI_GUID *FileName,
|
||||
IN CONST EFI_PEI_FV_HANDLE FvHandle,
|
||||
OUT EFI_PEI_FILE_HANDLE *FileHandle
|
||||
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
|
||||
);
|
||||
|
||||
|
||||
@@ -141,109 +134,105 @@ EFI_STATUS
|
||||
file, including its file name, type, attributes, starting
|
||||
address and size.
|
||||
|
||||
@param This Points to this instance of the
|
||||
EFI_PEI_FIRMWARE_VOLUME_PPI.
|
||||
|
||||
@param FileHandle Handle of the file.
|
||||
|
||||
@param FileInfo Upon exit, points to the file????s
|
||||
information.
|
||||
@param This Points to this instance of the
|
||||
EFI_PEI_FIRMWARE_VOLUME_PPI.
|
||||
@param FileHandle Handle of the file.
|
||||
@param FileInfo Upon exit, points to the file's
|
||||
information.
|
||||
|
||||
@retval EFI_SUCCESS File information returned.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER If FileHandle does not
|
||||
represent a valid file.
|
||||
EFI_INVALID_PARAMETER If
|
||||
FileInfo is NULL
|
||||
@retval EFI_INVALID_PARAMETER If FileInfo is NULL.
|
||||
|
||||
**/
|
||||
|
||||
typedef
|
||||
EFI_STATUS (EFIAPI *EFI_PEI_FV_GET_FILE_INFO)(
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_PEI_FV_GET_FILE_INFO)(
|
||||
IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This,
|
||||
IN CONST EFI_PEI_FILE_HANDLE FileHandle,
|
||||
OUT EFI_FV_FILE_INFO *FileInfo
|
||||
IN EFI_PEI_FILE_HANDLE FileHandle,
|
||||
OUT EFI_FV_FILE_INFO *FileInfo
|
||||
);
|
||||
|
||||
/**
|
||||
This function returns information about the firmware
|
||||
volume.
|
||||
This function returns information about the firmware volume.
|
||||
|
||||
@param This Points to this instance of the
|
||||
EFI_PEI_FIRMWARE_VOLUME_PPI.
|
||||
|
||||
@param FvHandle Handle to the firmware handle.
|
||||
|
||||
@param VolumeInfo Points to the returned firmware volume
|
||||
information.
|
||||
|
||||
|
||||
@retval EFI_SUCCESS Information returned
|
||||
successfully.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER FvHandle does not indicate a
|
||||
valid firmware volume or VolumeInfo is NULL
|
||||
@param This Points to this instance of the
|
||||
EFI_PEI_FIRMWARE_VOLUME_PPI.
|
||||
@param FvHandle Handle to the firmware handle.
|
||||
@param VolumeInfo Points to the returned firmware volume
|
||||
information.
|
||||
|
||||
@retval EFI_SUCCESS Information returned successfully.
|
||||
@retval EFI_INVALID_PARAMETER FvHandle does not indicate a valid
|
||||
firmware volume or VolumeInfo is NULL.
|
||||
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS (EFIAPI *EFI_PEI_FV_GET_INFO)(
|
||||
IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This,
|
||||
IN CONST EFI_PEI_FV_HANDLE FvHandle,
|
||||
OUT EFI_FV_INFO *VolumeInfo
|
||||
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
|
||||
);
|
||||
|
||||
/**
|
||||
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.
|
||||
This service enables PEI modules to discover sections
|
||||
of a given type within a valid file.
|
||||
|
||||
@param This Points to this instance of the
|
||||
EFI_PEI_FIRMWARE_VOLUME_PPI.
|
||||
|
||||
@param SearchType A filter to find only sections of this
|
||||
type.
|
||||
|
||||
@param FileHandle Handle of firmware file in which to
|
||||
search.
|
||||
|
||||
@param SectionData Updated upon return to point to the
|
||||
section found.
|
||||
@param This Points to this instance of the
|
||||
EFI_PEI_FIRMWARE_VOLUME_PPI.
|
||||
@param SearchType A filter to find only sections of this
|
||||
type.
|
||||
@param FileHandle Handle of firmware file in which to
|
||||
search.
|
||||
@param SectionData Updated upon return to point to the
|
||||
section found.
|
||||
|
||||
@retval EFI_SUCCESS Section was found.
|
||||
|
||||
@retval EFI_NOT_FOUND Section of the specified type was not
|
||||
found. SectionData contains NULL.
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
(EFIAPI *EFI_PEI_FV_FIND_SECTION)(
|
||||
IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This,
|
||||
IN CONST EFI_SECTION_TYPE SearchType,
|
||||
IN CONST EFI_PEI_FILE_HANDLE FileHandle,
|
||||
OUT VOID **SectionData
|
||||
IN CONST EFI_PEI_FIRMWARE_VOLUME_PPI *This,
|
||||
IN EFI_SECTION_TYPE SearchType,
|
||||
IN EFI_PEI_FILE_HANDLE FileHandle,
|
||||
OUT VOID **SectionData
|
||||
);
|
||||
|
||||
|
||||
|
||||
/*
|
||||
@par Ppi Description:
|
||||
This PPI provides functions for accessing a memory-mapped firmware volume of a specific format.
|
||||
|
||||
@param ProcessVolume Process a firmware volume and create a volume handle.
|
||||
@param FindFileByType Find all files of a specific type.
|
||||
@param FindFileByName Find the file with a specific name.
|
||||
@param GetFileInfo Return the information about a specific file
|
||||
@param GetVolumeInfo Return the firmware volume attributes.
|
||||
@param FindSectionByType Find all sections of a specific type.
|
||||
|
||||
**/
|
||||
///
|
||||
/// This PPI provides functions for accessing a memory-mapped firmware volume of a specific format.
|
||||
///
|
||||
struct _EFI_PEI_FIRMWARE_VOLUME_PPI {
|
||||
///
|
||||
/// Process a firmware volume and create a volume handle.
|
||||
///
|
||||
EFI_PEI_FV_PROCESS_FV ProcessVolume;
|
||||
///
|
||||
/// Find all files of a specific type.
|
||||
///
|
||||
EFI_PEI_FV_FIND_FILE_TYPE FindFileByType;
|
||||
///
|
||||
/// Find the file with a specific name.
|
||||
///
|
||||
EFI_PEI_FV_FIND_FILE_NAME FindFileByName;
|
||||
///
|
||||
/// Return the information about a specific file.
|
||||
///
|
||||
EFI_PEI_FV_GET_FILE_INFO GetFileInfo;
|
||||
///
|
||||
/// Return the firmware volume attributes.
|
||||
///
|
||||
EFI_PEI_FV_GET_INFO GetVolumeInfo;
|
||||
///
|
||||
/// Find all sections of a specific type.
|
||||
///
|
||||
EFI_PEI_FV_FIND_SECTION FindSectionByType;
|
||||
} ;
|
||||
};
|
||||
|
||||
extern EFI_GUID gEfiPeiFirmwareVolumePpiGuid;
|
||||
|
||||
|
||||
Reference in New Issue
Block a user