Add comments for enumeration, structure data members those are referred by UefiServic...

[mirror_edk2.git] / MdePkg / Include / Pi / PiFirmwareVolume.h

diff --git a/MdePkg/Include/Pi/PiFirmwareVolume.h b/MdePkg/Include/Pi/PiFirmwareVolume.h
index 64c1144bb6196c4724073fbca4ee13187a69ebe0..d5614745fba25a4afd97562083674a40251f7b5b 100644 (file)
--- a/MdePkg/Include/Pi/PiFirmwareVolume.h
+++ b/MdePkg/Include/Pi/PiFirmwareVolume.h
@@ -91,7 +91,13 @@ typedef UINT32  EFI_FVB_ATTRIBUTES_2;
 \r
 \r
 typedef struct {\r
+  ///\r
+  /// The number of sequential blocks which are of the same size.\r
+  ///\r
   UINT32 NumBlocks;\r
+  ///\r
+  /// The size of the blocks.\r
+  ///\r
   UINT32 Length;\r
 } EFI_FV_BLOCK_MAP_ENTRY;\r
 \r
@@ -99,16 +105,53 @@ typedef struct {
 /// Describes the features and layout of the firmware volume.\r
 ///\r
 typedef struct {\r
+  ///\r
+  /// The first 16 bytes are reserved to allow for the reset vector of \r
+  /// processors whose reset vector is at address 0.\r
+  ///\r
   UINT8                     ZeroVector[16];\r
+  ///\r
+  /// Declares the file system with which the firmware volume is formatted.\r
+  ///\r
   EFI_GUID                  FileSystemGuid;\r
+  ///\r
+  /// Length in bytes of the complete firmware volume, including the header.\r
+  ///\r
   UINT64                    FvLength;\r
+  ///\r
+  /// Set to EFI_FVH_SIGNATURE\r
+  ///\r
   UINT32                    Signature;\r
+  ///\r
+  /// Declares capabilities and power-on defaults for the firmware volume.\r
+  ///\r
   EFI_FVB_ATTRIBUTES_2      Attributes;\r
+  ///\r
+  /// Length in bytes of the complete firmware volume header.\r
+  ///\r
   UINT16                    HeaderLength;\r
+  ///\r
+  /// A 16-bit checksum of the firmware volume header. A valid header sums to zero.\r
+  ///\r
   UINT16                    Checksum;\r
+  ///\r
+  /// Offset, relative to the start of the header, of the extended header\r
+  /// (EFI_FIRMWARE_VOLUME_EXT_HEADER) or zero if there is no extended header.\r
+  ///\r
   UINT16                    ExtHeaderOffset;\r
+  ///\r
+  /// This field must always be set to zero.\r
+  ///\r
   UINT8                     Reserved[1];\r
+  ///\r
+  /// Set to 2. Future versions of this specification may define new header fields and will\r
+  /// increment the Revision field accordingly.\r
+  ///\r
   UINT8                     Revision;\r
+  ///\r
+  /// An array of run-length encoded FvBlockMapEntry structures. The array is\r
+  /// terminated with an entry of {0,0}.\r
+  ///\r
   EFI_FV_BLOCK_MAP_ENTRY    BlockMap[1];\r
 } EFI_FIRMWARE_VOLUME_HEADER;\r
 \r
@@ -123,7 +166,13 @@ typedef struct {
 /// Extension header pointed by ExtHeaderOffset of volume header.\r
 /// \r
 typedef struct {\r
+  ///\r
+  /// Firmware volume name.\r
+  ///\r
   EFI_GUID  FvName;\r
+  ///\r
+  /// Size of the rest of the extension header, including this structure.\r
+  ///\r
   UINT32    ExtHeaderSize;\r
 } EFI_FIRMWARE_VOLUME_EXT_HEADER;\r
 \r
@@ -131,7 +180,13 @@ typedef struct {
 /// Entry struture for describing FV extension header\r
 /// \r
 typedef struct {\r
+  ///\r
+  /// Size of this header extension.\r
+  ///\r
   UINT16    ExtEntrySize;\r
+  ///\r
+  /// Type of the header.\r
+  ///\r
   UINT16    ExtEntryType;\r
 } EFI_FIRMWARE_VOLUME_EXT_ENTRY;\r
 \r
@@ -140,13 +195,18 @@ typedef struct {
 /// This extension header provides a mapping between a GUID and an OEM file type.\r
 /// \r
 typedef struct {\r
+  ///\r
+  /// Standard extension entry, with the type EFI_FV_EXT_TYPE_OEM_TYPE.\r
+  ///\r
   EFI_FIRMWARE_VOLUME_EXT_ENTRY Hdr;\r
+  ///\r
+  /// A bit mask, one bit for each file type between 0xC0 (bit 0) and 0xDF (bit 31). If a bit\r
+  /// is '1', then the GUID entry exists in Types. If a bit is '0' then no GUID entry exists in Types.\r
+  ///\r
   UINT32    TypeMask;\r
-\r
-  //\r
-  // Array of GUIDs. \r
-  // Each GUID represents an OEM file type.\r
-  // \r
+  ///\r
+  /// An array of GUIDs, each GUID representing an OEM file type.\r
+  /// \r
   EFI_GUID  Types[1];\r
 } EFI_FIRMWARE_VOLUME_EXT_ENTRY_OEM_TYPE;\r
 \r