MdeModulePkg/Include/Guid/PcdDataBaseSignatureGuid.h

   1 /** @file
   2   Guid for Pcd DataBase Signature.
   3
   4 Copyright (c) 2012 - 2016, Intel Corporation. All rights reserved.<BR>
   5 This program and the accompanying materials are licensed and made available under
   6 the terms and conditions of the BSD License that accompanies this distribution.
   7 The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php.
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _PCD_DATABASE_SIGNATURE_GUID_H_
  16 #define _PCD_DATABASE_SIGNATURE_GUID_H_
  17
  18 #define PCD_DATA_BASE_SIGNATURE_GUID \
  19 { 0x3c7d193c, 0x682c, 0x4c14, { 0xa6, 0x8f, 0x55, 0x2d, 0xea, 0x4f, 0x43, 0x7e } }
  20
  21 extern EFI_GUID gPcdDataBaseSignatureGuid;
  22
  23 //
  24 // Common definitions
  25 //
  26 typedef UINT64 SKU_ID;
  27
  28 #define PCD_TYPE_SHIFT        28
  29
  30 #define PCD_TYPE_DATA         (0x0U << PCD_TYPE_SHIFT)
  31 #define PCD_TYPE_HII          (0x8U << PCD_TYPE_SHIFT)
  32 #define PCD_TYPE_VPD          (0x4U << PCD_TYPE_SHIFT)
  33 #define PCD_TYPE_SKU_ENABLED  (0x2U << PCD_TYPE_SHIFT)
  34 #define PCD_TYPE_STRING       (0x1U << PCD_TYPE_SHIFT)
  35
  36 #define PCD_TYPE_ALL_SET      (PCD_TYPE_DATA | PCD_TYPE_HII | PCD_TYPE_VPD | PCD_TYPE_SKU_ENABLED | PCD_TYPE_STRING)
  37
  38 #define PCD_DATUM_TYPE_SHIFT  24
  39
  40 #define PCD_DATUM_TYPE_POINTER  (0x0U << PCD_DATUM_TYPE_SHIFT)
  41 #define PCD_DATUM_TYPE_UINT8    (0x1U << PCD_DATUM_TYPE_SHIFT)
  42 #define PCD_DATUM_TYPE_UINT16   (0x2U << PCD_DATUM_TYPE_SHIFT)
  43 #define PCD_DATUM_TYPE_UINT32   (0x4U << PCD_DATUM_TYPE_SHIFT)
  44 #define PCD_DATUM_TYPE_UINT64   (0x8U << PCD_DATUM_TYPE_SHIFT)
  45
  46 #define PCD_DATUM_TYPE_ALL_SET  (PCD_DATUM_TYPE_POINTER | \
  47                                  PCD_DATUM_TYPE_UINT8   | \
  48                                  PCD_DATUM_TYPE_UINT16  | \
  49                                  PCD_DATUM_TYPE_UINT32  | \
  50                                  PCD_DATUM_TYPE_UINT64)
  51
  52 #define PCD_DATUM_TYPE_SHIFT2 20
  53
  54 #define PCD_DATUM_TYPE_UINT8_BOOLEAN (0x1U << PCD_DATUM_TYPE_SHIFT2)
  55
  56 #define PCD_DATABASE_OFFSET_MASK (~(PCD_TYPE_ALL_SET | PCD_DATUM_TYPE_ALL_SET | PCD_DATUM_TYPE_UINT8_BOOLEAN))
  57
  58 typedef struct  {
  59   UINT32  ExTokenNumber;
  60   UINT16  TokenNumber;          // Token Number for Dynamic-Ex PCD.
  61   UINT16  ExGuidIndex;          // Index of GuidTable in units of GUID.
  62 } DYNAMICEX_MAPPING;
  63
  64 typedef struct {
  65   UINT32  StringIndex;          // Offset in String Table in units of UINT8.
  66   UINT32  DefaultValueOffset;   // Offset of the Default Value.
  67   UINT16  GuidTableIndex;       // Offset in Guid Table in units of GUID.
  68   UINT16  Offset;               // Offset in Variable.
  69   UINT32  Attributes;           // Variable attributes.
  70   UINT16  Property;             // Variable property.
  71   UINT16  Reserved;
  72 } VARIABLE_HEAD;
  73
  74 typedef struct {
  75   UINT32  Offset;
  76 } VPD_HEAD;
  77
  78 typedef UINT32 STRING_HEAD;
  79
  80 typedef UINT16 SIZE_INFO;
  81
  82 typedef struct {
  83   UINT32  TokenSpaceCNameIndex; // Offset in String Table in units of UINT8.
  84   UINT32  PcdCNameIndex;        // Offset in String Table in units of UINT8.
  85 } PCD_NAME_INDEX;
  86
  87 typedef UINT32 TABLE_OFFSET;
  88
  89 typedef struct {
  90     GUID                  Signature;            // PcdDataBaseGuid.
  91     UINT32                BuildVersion;
  92     UINT32                Length;               // Length of DEFAULT SKU PCD DB
  93     SKU_ID                SystemSkuId;          // Current SkuId value.
  94     UINT32                LengthForAllSkus;     // Length of all SKU PCD DB
  95     UINT32                UninitDataBaseSize;   // Total size for PCD those default value with 0.
  96     TABLE_OFFSET          LocalTokenNumberTableOffset;
  97     TABLE_OFFSET          ExMapTableOffset;
  98     TABLE_OFFSET          GuidTableOffset;
  99     TABLE_OFFSET          StringTableOffset;
 100     TABLE_OFFSET          SizeTableOffset;
 101     TABLE_OFFSET          SkuIdTableOffset;
 102     TABLE_OFFSET          PcdNameTableOffset;
 103     UINT16                LocalTokenCount;      // LOCAL_TOKEN_NUMBER for all.
 104     UINT16                ExTokenCount;         // EX_TOKEN_NUMBER for DynamicEx.
 105     UINT16                GuidTableCount;       // The Number of Guid in GuidTable.
 106     UINT8                 Pad[6];               // Pad bytes to satisfy the alignment.
 107
 108     //
 109     // Default initialized external PCD database binary structure
 110     //
 111     // Padding is needed to keep necessary alignment
 112     //
 113     //SKU_ID                         SkuIdTable[];            // SkuIds system supports.
 114     //UINT64                         ValueUint64[];
 115     //UINT32                         ValueUint32[];
 116     //VPD_HEAD                       VpdHead[];               // VPD Offset
 117     //DYNAMICEX_MAPPING              ExMapTable[];            // DynamicEx PCD mapped to LocalIndex in LocalTokenNumberTable. It can be accessed by the ExMapTableOffset.
 118     //UINT32                         LocalTokenNumberTable[]; // Offset | DataType | PCD Type. It can be accessed by LocalTokenNumberTableOffset.
 119     //GUID                           GuidTable[];             // GUID for DynamicEx and HII PCD variable Guid. It can be accessed by the GuidTableOffset.
 120     //STRING_HEAD                    StringHead[];            // String PCD
 121     //PCD_NAME_INDEX                 PcdNameTable[];          // PCD name index info. It can be accessed by the PcdNameTableOffset.
 122     //VARIABLE_HEAD                  VariableHead[];          // HII PCD
 123     //UINT8                          StringTable[];           // String for String PCD value and HII PCD Variable Name. It can be accessed by StringTableOffset.
 124     //SIZE_INFO                      SizeTable[];             // MaxSize and CurSize for String PCD. It can be accessed by SizeTableOffset.
 125     //UINT16                         ValueUint16[];
 126     //UINT8                          ValueUint8[];
 127     //BOOLEAN                        ValueBoolean[];
 128
 129 } PCD_DATABASE_INIT;
 130
 131 //
 132 // PEI and DXE Pcd driver use the same PCD database
 133 //
 134 typedef PCD_DATABASE_INIT  PEI_PCD_DATABASE;
 135 typedef PCD_DATABASE_INIT  DXE_PCD_DATABASE;
 136
 137
 138 typedef struct {
 139   PEI_PCD_DATABASE  *PeiDb;
 140   DXE_PCD_DATABASE  *DxeDb;
 141 } PCD_DATABASE;
 142
 143 typedef struct {
 144   UINT32 Offset:24;
 145   UINT32 Value:8;
 146 } PCD_DATA_DELTA;
 147
 148 typedef struct {
 149   SKU_ID SkuId;
 150   UINT16 DefaultId;
 151   UINT8  Reserved[6];
 152 } PCD_DEFAULT_INFO;
 153
 154 typedef struct {
 155   //
 156   // Full size, it must be at 8 byte alignment.
 157   //
 158   UINT32 DataSize;
 159   //
 160   // HeaderSize includes HeaderSize fields and DefaultInfo arrays
 161   //
 162   UINT32 HeaderSize;
 163   //
 164   // DefaultInfo arrays those have the same default setting.
 165   //
 166   PCD_DEFAULT_INFO DefaultInfo[1];
 167   //
 168   // Default data is stored as variable storage or the array of DATA_DELTA.
 169   //
 170 } PCD_DEFAULT_DATA;
 171
 172 #define PCD_NV_STORE_DEFAULT_BUFFER_SIGNATURE SIGNATURE_32('N', 'S', 'D', 'B')
 173
 174 typedef struct {
 175   //
 176   // PCD_NV_STORE_DEFAULT_BUFFER_SIGNATURE
 177   //
 178   UINT32    Signature;
 179   //
 180   // Length of the taken default buffer
 181   //
 182   UINT32    Length;
 183   //
 184   // Length of the total reserved buffer
 185   //
 186   UINT32    MaxLength;
 187   //
 188   // Reserved for 8 byte alignment
 189   //
 190   UINT32    Reserved;
 191   // one or more PCD_DEFAULT_DATA
 192 } PCD_NV_STORE_DEFAULT_BUFFER_HEADER;
 193
 194 //
 195 // NvStoreDefaultValueBuffer layout:
 196 // +-------------------------------------+
 197 // | PCD_NV_STORE_DEFAULT_BUFFER_HEADER  |
 198 // +-------------------------------------+
 199 // | PCD_DEFAULT_DATA (DEFAULT, Standard)|
 200 // +-------------------------------------+
 201 // | PCD_DATA_DELTA   (DEFAULT, Standard)|
 202 // +-------------------------------------+
 203 // | ......                              |
 204 // +-------------------------------------+
 205 // | PCD_DEFAULT_DATA (SKU A, Standard)  |
 206 // +-------------------------------------+
 207 // | PCD_DATA_DELTA   (SKU A, Standard)  |
 208 // +-------------------------------------+
 209 // | ......                              |
 210 // +-------------------------------------+
 211 //
 212
 213 #pragma pack(1)
 214 typedef struct {
 215   SKU_ID    SkuId;
 216   SKU_ID    SkuIdCompared;
 217   UINT32    Length;
 218   // PCD_DATA_DELTA   DeltaData[]
 219 } PCD_DATABASE_SKU_DELTA;
 220
 221 //
 222 // PCD database layout:
 223 // +---------------------------------+
 224 // | PCD_DATABASE_INIT (DEFAULT SKU) |
 225 // +---------------------------------+
 226 // | PCD_DATABASE_SKU_DELTA (SKU A)  |
 227 // +---------------------------------+
 228 // | PCD_DATABASE_SKU_DELTA (SKU B)  |
 229 // +---------------------------------+
 230 // | ......                          |
 231 // +---------------------------------+
 232 //
 233 #pragma pack()
 234
 235 #endif