]>
Commit | Line | Data |
---|---|---|
419db80b BF |
1 | /** @file\r |
2 | Guid for Pcd DataBase Signature.\r | |
3 | \r | |
4 | Copyright (c) 2012 - 2013, Intel Corporation. All rights reserved.<BR>\r | |
5 | This program and the accompanying materials are licensed and made available under \r | |
6 | the terms and conditions of the BSD License that accompanies this distribution. \r | |
7 | The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php. \r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #ifndef _PCD_DATABASE_SIGNATURE_GUID_H_\r | |
16 | #define _PCD_DATABASE_SIGNATURE_GUID_H_\r | |
17 | \r | |
18 | #define PCD_DATA_BASE_SIGNATURE_GUID \\r | |
19 | { 0x3c7d193c, 0x682c, 0x4c14, { 0xa6, 0x8f, 0x55, 0x2d, 0xea, 0x4f, 0x43, 0x7e } }\r | |
20 | \r | |
21 | extern EFI_GUID gPcdDataBaseSignatureGuid;\r | |
22 | \r | |
23 | //\r | |
24 | // Common definitions\r | |
25 | //\r | |
26 | typedef UINT8 SKU_ID;\r | |
27 | \r | |
28 | #define PCD_TYPE_SHIFT 28\r | |
29 | \r | |
30 | #define PCD_TYPE_DATA (0x0U << PCD_TYPE_SHIFT)\r | |
31 | #define PCD_TYPE_HII (0x8U << PCD_TYPE_SHIFT)\r | |
32 | #define PCD_TYPE_VPD (0x4U << PCD_TYPE_SHIFT)\r | |
33 | #define PCD_TYPE_SKU_ENABLED (0x2U << PCD_TYPE_SHIFT)\r | |
34 | #define PCD_TYPE_STRING (0x1U << PCD_TYPE_SHIFT)\r | |
35 | \r | |
36 | #define PCD_TYPE_ALL_SET (PCD_TYPE_DATA | PCD_TYPE_HII | PCD_TYPE_VPD | PCD_TYPE_SKU_ENABLED | PCD_TYPE_STRING)\r | |
37 | \r | |
38 | #define PCD_DATUM_TYPE_SHIFT 24\r | |
39 | \r | |
40 | #define PCD_DATUM_TYPE_POINTER (0x0U << PCD_DATUM_TYPE_SHIFT)\r | |
41 | #define PCD_DATUM_TYPE_UINT8 (0x1U << PCD_DATUM_TYPE_SHIFT)\r | |
42 | #define PCD_DATUM_TYPE_UINT16 (0x2U << PCD_DATUM_TYPE_SHIFT)\r | |
43 | #define PCD_DATUM_TYPE_UINT32 (0x4U << PCD_DATUM_TYPE_SHIFT)\r | |
44 | #define PCD_DATUM_TYPE_UINT64 (0x8U << PCD_DATUM_TYPE_SHIFT)\r | |
45 | \r | |
46 | #define PCD_DATUM_TYPE_ALL_SET (PCD_DATUM_TYPE_POINTER | \\r | |
47 | PCD_DATUM_TYPE_UINT8 | \\r | |
48 | PCD_DATUM_TYPE_UINT16 | \\r | |
49 | PCD_DATUM_TYPE_UINT32 | \\r | |
50 | PCD_DATUM_TYPE_UINT64)\r | |
51 | \r | |
52 | #define PCD_DATUM_TYPE_SHIFT2 20\r | |
53 | \r | |
54 | #define PCD_DATUM_TYPE_UINT8_BOOLEAN (0x1U << PCD_DATUM_TYPE_SHIFT2)\r | |
55 | \r | |
56 | #define PCD_DATABASE_OFFSET_MASK (~(PCD_TYPE_ALL_SET | PCD_DATUM_TYPE_ALL_SET | PCD_DATUM_TYPE_UINT8_BOOLEAN))\r | |
57 | \r | |
58 | typedef struct {\r | |
59 | UINT32 ExTokenNumber;\r | |
60 | UINT16 TokenNumber; // Token Number for Dynamic-Ex PCD.\r | |
61 | UINT16 ExGuidIndex; // Index of GuidTable in units of GUID.\r | |
62 | } DYNAMICEX_MAPPING;\r | |
63 | \r | |
64 | typedef struct {\r | |
65 | UINT32 SkuDataStartOffset; // Offset(with TYPE info) from the PCD_DB.\r | |
66 | UINT32 SkuIdTableOffset; // Offset from the PCD_DB.\r | |
67 | } SKU_HEAD;\r | |
68 | \r | |
69 | typedef struct {\r | |
70 | UINT32 StringIndex; // Offset in String Table in units of UINT8.\r | |
71 | UINT32 DefaultValueOffset; // Offset of the Default Value.\r | |
72 | UINT16 GuidTableIndex; // Offset in Guid Table in units of GUID.\r | |
73 | UINT16 Offset; // Offset in Variable.\r | |
74 | } VARIABLE_HEAD;\r | |
75 | \r | |
76 | typedef struct {\r | |
77 | UINT32 Offset;\r | |
78 | } VPD_HEAD;\r | |
79 | \r | |
80 | typedef UINT32 STRING_HEAD;\r | |
81 | \r | |
82 | typedef UINT16 SIZE_INFO;\r | |
83 | \r | |
84 | typedef struct {\r | |
85 | UINT32 TokenSpaceCNameIndex; // Offset in String Table in units of UINT8.\r | |
86 | UINT32 PcdCNameIndex; // Offset in String Table in units of UINT8.\r | |
87 | } PCD_NAME_INDEX;\r | |
88 | \r | |
89 | typedef UINT32 TABLE_OFFSET;\r | |
90 | \r | |
91 | typedef struct {\r | |
92 | GUID Signature; // PcdDataBaseGuid.\r | |
93 | UINT32 BuildVersion;\r | |
94 | UINT32 Length;\r | |
95 | UINT32 UninitDataBaseSize; // Total size for PCD those default value with 0.\r | |
96 | TABLE_OFFSET LocalTokenNumberTableOffset;\r | |
97 | TABLE_OFFSET ExMapTableOffset;\r | |
98 | TABLE_OFFSET GuidTableOffset;\r | |
99 | TABLE_OFFSET StringTableOffset;\r | |
100 | TABLE_OFFSET SizeTableOffset;\r | |
101 | TABLE_OFFSET SkuIdTableOffset;\r | |
102 | TABLE_OFFSET PcdNameTableOffset;\r | |
103 | UINT16 LocalTokenCount; // LOCAL_TOKEN_NUMBER for all.\r | |
104 | UINT16 ExTokenCount; // EX_TOKEN_NUMBER for DynamicEx.\r | |
105 | UINT16 GuidTableCount; // The Number of Guid in GuidTable.\r | |
106 | SKU_ID SystemSkuId; // Current SkuId value.\r | |
107 | UINT8 Pad; // Pad bytes to satisfy the alignment.\r | |
108 | \r | |
109 | //\r | |
110 | // Default initialized external PCD database binary structure\r | |
111 | //\r | |
112 | // Padding is needed to keep necessary alignment\r | |
113 | //\r | |
114 | //UINT64 ValueUint64[];\r | |
115 | //UINT32 ValueUint32[];\r | |
116 | //VPD_HEAD VpdHead[]; // VPD Offset\r | |
117 | //DYNAMICEX_MAPPING ExMapTable[]; // DynamicEx PCD mapped to LocalIndex in LocalTokenNumberTable. It can be accessed by the ExMapTableOffset.\r | |
118 | //UINT32 LocalTokenNumberTable[]; // Offset | DataType | PCD Type. It can be accessed by LocalTokenNumberTableOffset.\r | |
119 | //GUID GuidTable[]; // GUID for DynamicEx and HII PCD variable Guid. It can be accessed by the GuidTableOffset.\r | |
120 | //STRING_HEAD StringHead[]; // String PCD \r | |
121 | //PCD_NAME_INDEX PcdNameTable[]; // PCD name index info. It can be accessed by the PcdNameTableOffset.\r | |
122 | //VARIABLE_HEAD VariableHead[]; // HII PCD\r | |
123 | //SKU_HEAD SkuHead[]; // Store SKU info for each PCD with SKU enable.\r | |
124 | //UINT8 StringTable[]; // String for String PCD value and HII PCD Variable Name. It can be accessed by StringTableOffset. \r | |
125 | //SIZE_INFO SizeTable[]; // MaxSize and CurSize for String PCD. It can be accessed by SizeTableOffset.\r | |
126 | //UINT16 ValueUint16[];\r | |
127 | //UINT8 ValueUint8[];\r | |
128 | //BOOLEAN ValueBoolean[];\r | |
129 | //UINT8 SkuIdTable[]; // SkuIds system supports.\r | |
130 | //UINT8 SkuIndexTable[]; // SkuIds for each PCD with SKU enable.\r | |
131 | \r | |
132 | } PCD_DATABASE_INIT;\r | |
133 | \r | |
134 | //\r | |
135 | // PEI and DXE Pcd driver use the same PCD database\r | |
136 | //\r | |
137 | typedef PCD_DATABASE_INIT PEI_PCD_DATABASE;\r | |
138 | typedef PCD_DATABASE_INIT DXE_PCD_DATABASE;\r | |
139 | \r | |
140 | \r | |
141 | typedef struct {\r | |
142 | PEI_PCD_DATABASE *PeiDb;\r | |
143 | DXE_PCD_DATABASE *DxeDb;\r | |
144 | } PCD_DATABASE;\r | |
145 | \r | |
146 | \r | |
147 | #endif\r |