Add the missing PI capsule architecture protocol.

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

diff --git a/MdeModulePkg/Include/WorkingBlockHeader.h b/MdeModulePkg/Include/WorkingBlockHeader.h
index fc023ffe69a16440578d6c0eee9743dd4b6c857e..4298d5fe1808f2a75c1d99d949432a75506a78a8 100644 (file)
--- a/MdeModulePkg/Include/WorkingBlockHeader.h
+++ b/MdeModulePkg/Include/WorkingBlockHeader.h
@@ -1,6 +1,8 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2006, Intel Corporation\r
+  The header structure of FTW working block region.\r
+\r
+Copyright (c) 2006 - 2008, Intel Corporation\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -9,39 +11,42 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-Module Name:\r
-\r
-  EfiWorkingBlockHeader.h\r
-\r
-Abstract:\r
-\r
-  Defines data structure that is the headers found at the runtime\r
-  updatable firmware volumes, such as the FileSystemGuid of the\r
-  working block, the header structure of the variable block, FTW\r
-  working block, or event log block.\r
-\r
---*/\r
+**/\r
 \r
 #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
+/// EDKII Fault tolerant working block header\r
+/// The header is immediately followed by the write queue data.\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