MdeModulePkg/Include/Guid/SystemNvDataGuid.h

   1 /** @file
   2   This file defines NvDataFv GUID and FTW working block structures.
   3   The NvDataFv GUID can be used as FileSystemGuid in EFI_FIRMWARE_VOLUME_HEADER if
   4   this FV image contains NV data, such as NV variable data.
   5   This file also defines WorkingBlockSignature GUID for FTW working block signature.
   6
   7 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
   8 SPDX-License-Identifier: BSD-2-Clause-Patent
   9
  10 **/
  11
  12 #ifndef __SYSTEM_NV_DATA_GUID_H__
  13 #define __SYSTEM_NV_DATA_GUID_H__
  14
  15 #define EFI_SYSTEM_NV_DATA_FV_GUID \
  16   {0xfff12b8d, 0x7696, 0x4c8b, {0xa9, 0x85, 0x27, 0x47, 0x7, 0x5b, 0x4f, 0x50} }
  17
  18 #define EDKII_WORKING_BLOCK_SIGNATURE_GUID \
  19   {0x9e58292b, 0x7c68, 0x497d, {0xa0, 0xce, 0x65,  0x0, 0xfd, 0x9f, 0x1b, 0x95} }
  20
  21 extern EFI_GUID gEfiSystemNvDataFvGuid;
  22 extern EFI_GUID gEdkiiWorkingBlockSignatureGuid;
  23
  24 #define WORKING_BLOCK_VALID   0x1
  25 #define WORKING_BLOCK_INVALID 0x2
  26
  27 ///
  28 /// The EDKII Fault tolerant working block header.
  29 /// The header is immediately followed by the write queue data.
  30 ///
  31 typedef struct {
  32   ///
  33   /// FTW working block signature.
  34   /// Its value has be updated from gEfiSystemNvDataFvGuid to gEdkiiWorkingBlockSignatureGuid,
  35   /// because its write queue data format has been updated to support the crossing archs.
  36   ///
  37   EFI_GUID  Signature;
  38   ///
  39   /// 32bit CRC calculated for this header.
  40   ///
  41   UINT32    Crc;
  42   ///
  43   /// Working block valid bit.
  44   ///
  45   UINT8     WorkingBlockValid : 1;
  46   UINT8     WorkingBlockInvalid : 1;
  47   UINT8     Reserved : 6;
  48   UINT8     Reserved3[3];
  49   ///
  50   /// Total size of the following write queue range.
  51   ///
  52   UINT64    WriteQueueSize;
  53   ///
  54   /// Write Queue data.
  55   ///
  56   /// EFI_FAULT_TOLERANT_WRITE_HEADER FtwHeader;
  57   /// EFI_FAULT_TOLERANT_WRITE_RECORD FtwRecord[FtwHeader.NumberOfWrites]
  58   /// EFI_FAULT_TOLERANT_WRITE_HEADER FtwHeader2;
  59   /// EFI_FAULT_TOLERANT_WRITE_RECORD FtwRecord2[FtwHeader2.NumberOfWrites]
  60   /// ...
  61   ///
  62 } EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER;
  63
  64 #define FTW_VALID_STATE     0
  65 #define FTW_INVALID_STATE   1
  66
  67 //
  68 // EFI Fault tolerant block update write queue entry.
  69 //
  70 typedef struct {
  71   UINT8     HeaderAllocated : 1;
  72   UINT8     WritesAllocated : 1;
  73   UINT8     Complete : 1;
  74   UINT8     Reserved : 5;
  75   EFI_GUID  CallerId;
  76   UINT64    NumberOfWrites;
  77   UINT64    PrivateDataSize;
  78 } EFI_FAULT_TOLERANT_WRITE_HEADER;
  79
  80 //
  81 // EFI Fault tolerant block update write queue record.
  82 //
  83 typedef struct {
  84   UINT8   BootBlockUpdate : 1;
  85   UINT8   SpareComplete : 1;
  86   UINT8   DestinationComplete : 1;
  87   UINT8   Reserved : 5;
  88   EFI_LBA Lba;
  89   UINT64  Offset;
  90   UINT64  Length;
  91   //
  92   // Relative offset to spare block.
  93   //
  94   INT64   RelativeOffset;
  95   //
  96   // UINT8    PrivateData[PrivateDataSize]
  97   //
  98 } EFI_FAULT_TOLERANT_WRITE_RECORD;
  99
 100 #define FTW_RECORD_SIZE(PrivateDataSize)  (sizeof (EFI_FAULT_TOLERANT_WRITE_RECORD) + (UINTN) PrivateDataSize)
 101
 102 #define FTW_RECORD_TOTAL_SIZE(NumberOfWrites, PrivateDataSize) \
 103     ((UINTN) (NumberOfWrites) * (sizeof (EFI_FAULT_TOLERANT_WRITE_RECORD) + (UINTN) PrivateDataSize))
 104
 105 #define FTW_WRITE_TOTAL_SIZE(NumberOfWrites, PrivateDataSize) \
 106     ( \
 107       sizeof (EFI_FAULT_TOLERANT_WRITE_HEADER) + (UINTN) (NumberOfWrites) * \
 108       (sizeof (EFI_FAULT_TOLERANT_WRITE_RECORD) + (UINTN) PrivateDataSize) \
 109     )
 110
 111 #endif