sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update MdePkg/Include/Ppi according to code review comments.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5818 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
xli24
2008-09-04 09:15:21 +00:00
parent e6422a369a
commit dafa11b191
9 changed files with 414 additions and 473 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
MdePkg/Include/Ppi/FirmwareVolumeInfo.h
View File

@@ -26,39 +26,40 @@
typedef struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI EFI_PEI_FIRMWARE_VOLUME_INFO_PPI;
/**
@par Ppi Description:
This PPI describes the location and format of a firmware volume.
The FvFormat 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.
@param FvFormat Unique identifier of the format of the memory-mapped firmware volume.
@param 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.
@param FvInfoSize Size of the data provided by FvInfo. For memory-mapped firmware volumes,
this is typically the size of the firmware volume.
@param ParentFvName If the firmware volume originally came from a firmware file,
then these point to the parent firmware volume
name and firmware volume file. If it did not originally come
from a firmware file, these should be NULL.
@param ParentFileName If the firmware volume originally came from a firmware file,
then these point to the parent firmware volume
name and firmware volume file. If it did not originally come
from a firmware file, these should be NULL.
**/
///
/// This PPI describes the location and format of a firmware volume.
/// The FvFormat 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.
///
struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI {
///
/// Unique identifier of the format of the memory-mapped firmware volume.
///
EFI_GUID FvFormat;
///
/// 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.
///
VOID *FvInfo;
///
/// Size of the data provided by FvInfo. For memory-mapped firmware volumes,
/// this is typically the size of the firmware volume.
///
UINT32 FvInfoSize;
///
/// If the firmware volume originally came from a firmware file, then these
/// point to the parent firmware volume name and firmware volume file.
/// If it did not originally come from a firmware file, these should be NULL.
///
EFI_GUID *ParentFvName;
///
/// If the firmware volume originally came from a firmware file, then these
/// point to the parent firmware volume name and firmware volume file.
/// If it did not originally come from a firmware file, these should be NULL.
///
EFI_GUID *ParentFileName;
};