fix ECC tool's warning

[mirror_edk2.git] / MdeModulePkg / Include / WorkingBlockHeader.h

diff --git a/MdeModulePkg/Include/WorkingBlockHeader.h b/MdeModulePkg/Include/WorkingBlockHeader.h
index 3946b45a960f3f900e40c6d0f25477047c062905..93a0c8d934d52e12e02815c82994ce392fcd8e42 100644 (file)
--- a/MdeModulePkg/Include/WorkingBlockHeader.h
+++ b/MdeModulePkg/Include/WorkingBlockHeader.h
@@ -1,7 +1,5 @@
 /** @file\r
 \r
-  Defines data structure that is the headers found at the runtime\r
-  updatable firmware volumes.\r
   The header structure of FTW working block region.\r
 \r
 Copyright (c) 2006 - 2008, Intel Corporation\r
@@ -18,23 +16,37 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #ifndef __EFI_WORKING_BLOCK_HEADER_H__\r
 #define __EFI_WORKING_BLOCK_HEADER_H__\r
 \r
-//\r
-// EFI Fault tolerant working block header\r
-// The header is immediately followed by the write queue.\r
-//\r
+#define WORKING_BLOCK_VALID   0x1\r
+#define WORKING_BLOCK_INVALID 0x2\r
+\r
+///\r
+/// EFI Fault tolerant working block header\r
+/// The header is immediately followed by the write queue.\r
+///\r
 typedef struct {\r
+  ///\r
+  /// System Non Volatile FV Guid\r
+  ///\r
   EFI_GUID  Signature;\r
+  ///\r
+  /// 32bit CRC caculated for this header\r
+  ///\r
   UINT32    Crc;\r
+  ///\r
+  /// Working block valid bit\r
+  ///\r
   UINT8     WorkingBlockValid : 1;\r
   UINT8     WorkingBlockInvalid : 1;\r
-#define WORKING_BLOCK_VALID   0x1\r
-#define WORKING_BLOCK_INVALID 0x2\r
   UINT8     Reserved : 6;\r
   UINT8     Reserved3[3];\r
-  UINT32    WriteQueueSize;\r
-  //\r
-  // UINT8                WriteQueue[WriteQueueSize];\r
-  //\r
+  ///\r
+  /// Total size of the following write queue range.\r
+  ///\r
+  UINT64    WriteQueueSize;\r
+  ///\r
+  /// Write Queue data\r
+  /// UINT8                WriteQueue[WriteQueueSize];\r
+  ///\r
 } EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER;\r
 \r
 #endif\r