Update the copyright notice format

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

diff --git a/MdeModulePkg/Include/Guid/SystemNvDataGuid.h b/MdeModulePkg/Include/Guid/SystemNvDataGuid.h
index 946d4d8d03ba5525189a84b03ff23c11f3c18cbc..4e218883568cb378ba5e8847d81a426b8214f2d2 100644 (file)
--- a/MdeModulePkg/Include/Guid/SystemNvDataGuid.h
+++ b/MdeModulePkg/Include/Guid/SystemNvDataGuid.h
@@ -1,24 +1,19 @@
-/*++\r
-\r
-Copyright (c) 2006, 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
-http://opensource.org/licenses/bsd-license.php                                            \r
-                                                                                          \r
+/** @file  \r
+  This file defines NvDataFv GUID and FTW working block structure header.\r
+  This guid can be used as FileSystemGuid in EFI_FIRMWARE_VOLUME_HEADER if \r
+  this FV image contains NV data, such as NV variable data.\r
+  This guid can also be used as the signature of FTW working block header.\r
+\r
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php.                                            \r
+\r
 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
-    SystemNvDataGuid.h\r
-    \r
-Abstract:\r
-\r
-  GUIDs used for System Non Volatile HOB entries in the in the HOB list and FV Guids carrying\r
-  the System specific information.\r
-\r
---*/\r
+**/\r
 \r
 #ifndef __SYSTEM_NV_DATA_GUID_H__\r
 #define __SYSTEM_NV_DATA_GUID_H__\r
@@ -26,20 +21,42 @@ Abstract:
 #define EFI_SYSTEM_NV_DATA_FV_GUID \\r
   {0xfff12b8d, 0x7696, 0x4c8b, {0xa9, 0x85, 0x27, 0x47, 0x7, 0x5b, 0x4f, 0x50} }\r
 \r
-#define EFI_SYSTEM_NV_DATA_HOB_GUID \\r
-  {0xd6e5092d, 0xc7b2, 0x4872, {0xaf, 0x66, 0xfd, 0xc0, 0xe6, 0xf9, 0x5e, 0x78} }\r
+///\r
+/// An NvDataFv GUID used as the signature of FTW working block header.\r
+///\r
+extern EFI_GUID gEfiSystemNvDataFvGuid;\r
+\r
+#define WORKING_BLOCK_VALID   0x1\r
+#define WORKING_BLOCK_INVALID 0x2\r
 \r
+///\r
+/// The EDKII Fault tolerant working block header.\r
+/// The header is immediately followed by the write queue data.\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
-} NV_SYSTEM_DATA_GUID_TYPE;\r
-\r
-extern EFI_GUID gEfiSystemNvDataHobGuid;\r
-extern EFI_GUID gEfiSystemNvDataFvGuid;\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
+  UINT8     Reserved : 6;\r
+  UINT8     Reserved3[3];\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