diff options
Diffstat (limited to 'MdePkg/Include/Ppi/FirmwareVolumeInfo.h')
| -rw-r--r-- | MdePkg/Include/Ppi/FirmwareVolumeInfo.h | 57 |
1 files changed, 29 insertions, 28 deletions
diff --git a/MdePkg/Include/Ppi/FirmwareVolumeInfo.h b/MdePkg/Include/Ppi/FirmwareVolumeInfo.h index 1a7487bce..338b60ace 100644 --- a/MdePkg/Include/Ppi/FirmwareVolumeInfo.h +++ b/MdePkg/Include/Ppi/FirmwareVolumeInfo.h @@ -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;
};
|