Add additional comments for structure definition.

[mirror_edk2.git] / MdeModulePkg / Include / Guid / SystemNvDataGuid.h

diff --git a/MdeModulePkg/Include/Guid/SystemNvDataGuid.h b/MdeModulePkg/Include/Guid/SystemNvDataGuid.h
index 137ed230a1921651e93b185c363974fe2a5ea527..1f9e5e7987fd5df69dbc8a6e8f14adb80c2ee965 100644 (file)
--- a/MdeModulePkg/Include/Guid/SystemNvDataGuid.h
+++ b/MdeModulePkg/Include/Guid/SystemNvDataGuid.h
@@ -1,6 +1,7 @@
 /** @file\r
-  This file defines GUIDs used for System Non Volatile HOB entries in the HOB list,\r
-  and FV Guids that carrying the System specific information.\r
+  This file defines NvDataHob GUIDs for System Non Volatile HOB entries \r
+  in the HOB list and NV system hob entry structure. \r
+  It also defines NvDataFv GUID used as the signature of FTW working block header.\r
 \r
 Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -22,17 +23,24 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define EFI_SYSTEM_NV_DATA_HOB_GUID \\r
   {0xd6e5092d, 0xc7b2, 0x4872, {0xaf, 0x66, 0xfd, 0xc0, 0xe6, 0xf9, 0x5e, 0x78} }\r
 \r
+///\r
+/// Hob entry for NV data region\r
+///\r
 typedef struct {\r
-  EFI_GUID                  SystemNvDataHobGuid;\r
-  EFI_GUID                  SystemNvDataFvGuid;\r
-  EFI_LBA                   StartLba;    \r
-  UINTN                     StartLbaOffset;\r
-  EFI_LBA                   EndLba;    \r
-  UINTN                     EndLbaOffset;\r
-  UINT32                    DataTypeSignature;\r
+  EFI_GUID                  SystemNvDataHobGuid; /// EFI_SYSTEM_NV_DATA_HOB_GUID\r
+  EFI_GUID                  SystemNvDataFvGuid;  /// Guid specifies the NvData Fv for the specific purpose, such as FTW, Error Log.\r
+  EFI_LBA                   StartLba;            /// The starting logical block index.\r
+  UINTN                     StartLbaOffset;      /// Offset into the starting block at which to the start of NvData region.\r
+  EFI_LBA                   EndLba;              /// The last logical block index.\r
+  UINTN                     EndLbaOffset;        /// Offset into the last block at which to the end of Nvdata region.\r
+  UINT32                    DataTypeSignature;   /// NvData type in the specified NV range.\r
 } NV_SYSTEM_DATA_GUID_TYPE;\r
 \r
 extern EFI_GUID gEfiSystemNvDataHobGuid;\r
+\r
+///\r
+/// NvDataFv GUID used as the signature of FTW working block header.\r
+///\r
 extern EFI_GUID gEfiSystemNvDataFvGuid;\r
 \r
 #endif\r