]> git.proxmox.com Git - mirror_edk2.git/blob - BaseTools/Source/Python/AutoGen/GenPcdDb.py
BaseTools: Various typo
[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / GenPcdDb.py
1 ## @file
2 # Routines for generating Pcd Database
3 #
4 # Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>
5 # This program and the accompanying materials
6 # are licensed and made available under the terms and conditions of the BSD License
7 # which accompanies this distribution. 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 from __future__ import absolute_import
14 from io import BytesIO
15 from Common.Misc import *
16 from Common.StringUtils import StringToArray
17 from struct import pack
18 from .ValidCheckingInfoObject import VAR_CHECK_PCD_VARIABLE_TAB_CONTAINER
19 from .ValidCheckingInfoObject import VAR_CHECK_PCD_VARIABLE_TAB
20 from .ValidCheckingInfoObject import GetValidationObject
21 from Common.VariableAttributes import VariableAttributes
22 import copy
23 from struct import unpack
24 from Common.DataType import *
25 from Common import GlobalData
26 from Common import EdkLogger
27 import Common.LongFilePathOs as os
28
29 DATABASE_VERSION = 7
30
31 gPcdDatabaseAutoGenC = TemplateString("""
32 //
33 // External PCD database debug information
34 //
35 #if 0
36 ${PHASE}_PCD_DATABASE_INIT g${PHASE}PcdDbInit = {
37 /* SkuIdTable */
38 { ${BEGIN}${SKUID_VALUE}, ${END} },
39 ${BEGIN} { ${INIT_VALUE_UINT64} }, /* ${INIT_CNAME_DECL_UINT64}_${INIT_GUID_DECL_UINT64}[${INIT_NUMSKUS_DECL_UINT64}] */
40 ${END}
41 ${BEGIN} ${VARDEF_VALUE_UINT64}, /* ${VARDEF_CNAME_UINT64}_${VARDEF_GUID_UINT64}_VariableDefault_${VARDEF_SKUID_UINT64} */
42 ${END}
43 ${BEGIN} { ${INIT_VALUE_UINT32} }, /* ${INIT_CNAME_DECL_UINT32}_${INIT_GUID_DECL_UINT32}[${INIT_NUMSKUS_DECL_UINT32}] */
44 ${END}
45 ${BEGIN} ${VARDEF_VALUE_UINT32}, /* ${VARDEF_CNAME_UINT32}_${VARDEF_GUID_UINT32}_VariableDefault_${VARDEF_SKUID_UINT32} */
46 ${END}
47 /* VPD */
48 ${BEGIN} { ${VPD_HEAD_VALUE} }, /* ${VPD_HEAD_CNAME_DECL}_${VPD_HEAD_GUID_DECL}[${VPD_HEAD_NUMSKUS_DECL}] */
49 ${END}
50 /* ExMapTable */
51 {
52 ${BEGIN} { ${EXMAPPING_TABLE_EXTOKEN}, ${EXMAPPING_TABLE_LOCAL_TOKEN}, ${EXMAPPING_TABLE_GUID_INDEX} },
53 ${END}
54 },
55 /* LocalTokenNumberTable */
56 {
57 ${BEGIN} offsetof(${PHASE}_PCD_DATABASE, ${TOKEN_INIT}.${TOKEN_CNAME}_${TOKEN_GUID}${VARDEF_HEADER}) | ${TOKEN_TYPE},
58 ${END}
59 },
60 /* GuidTable */
61 {
62 ${BEGIN} ${GUID_STRUCTURE},
63 ${END}
64 },
65 ${BEGIN} { ${STRING_HEAD_VALUE} }, /* ${STRING_HEAD_CNAME_DECL}_${STRING_HEAD_GUID_DECL}[${STRING_HEAD_NUMSKUS_DECL}] */
66 ${END}
67 ${BEGIN} /* ${VARIABLE_HEAD_CNAME_DECL}_${VARIABLE_HEAD_GUID_DECL}_Variable_Header[${VARIABLE_HEAD_NUMSKUS_DECL}] */
68 {
69 ${VARIABLE_HEAD_VALUE}
70 },
71 ${END}
72 /* SkuHead */
73 {
74 ${BEGIN} offsetof (${PHASE}_PCD_DATABASE, ${TOKEN_INIT}.${TOKEN_CNAME}_${TOKEN_GUID}${VARDEF_HEADER}) | ${TOKEN_TYPE}, /* */
75 offsetof (${PHASE}_PCD_DATABASE, ${TOKEN_INIT}.SkuHead) /* */
76 ${END}
77 },
78 /* StringTable */
79 ${BEGIN} ${STRING_TABLE_VALUE}, /* ${STRING_TABLE_CNAME}_${STRING_TABLE_GUID} */
80 ${END}
81 /* SizeTable */
82 {
83 ${BEGIN} ${SIZE_TABLE_MAXIMUM_LENGTH}, ${SIZE_TABLE_CURRENT_LENGTH}, /* ${SIZE_TABLE_CNAME}_${SIZE_TABLE_GUID} */
84 ${END}
85 },
86 ${BEGIN} { ${INIT_VALUE_UINT16} }, /* ${INIT_CNAME_DECL_UINT16}_${INIT_GUID_DECL_UINT16}[${INIT_NUMSKUS_DECL_UINT16}] */
87 ${END}
88 ${BEGIN} ${VARDEF_VALUE_UINT16}, /* ${VARDEF_CNAME_UINT16}_${VARDEF_GUID_UINT16}_VariableDefault_${VARDEF_SKUID_UINT16} */
89 ${END}
90 ${BEGIN} { ${INIT_VALUE_UINT8} }, /* ${INIT_CNAME_DECL_UINT8}_${INIT_GUID_DECL_UINT8}[${INIT_NUMSKUS_DECL_UINT8}] */
91 ${END}
92 ${BEGIN} ${VARDEF_VALUE_UINT8}, /* ${VARDEF_CNAME_UINT8}_${VARDEF_GUID_UINT8}_VariableDefault_${VARDEF_SKUID_UINT8} */
93 ${END}
94 ${BEGIN} { ${INIT_VALUE_BOOLEAN} }, /* ${INIT_CNAME_DECL_BOOLEAN}_${INIT_GUID_DECL_BOOLEAN}[${INIT_NUMSKUS_DECL_BOOLEAN}] */
95 ${END}
96 ${BEGIN} ${VARDEF_VALUE_BOOLEAN}, /* ${VARDEF_CNAME_BOOLEAN}_${VARDEF_GUID_BOOLEAN}_VariableDefault_${VARDEF_SKUID_BOOLEAN} */
97 ${END}
98 ${SYSTEM_SKU_ID_VALUE}
99 };
100 #endif
101 """)
102
103 ## Mapping between PCD driver type and EFI phase
104 gPcdPhaseMap = {
105 "PEI_PCD_DRIVER" : "PEI",
106 "DXE_PCD_DRIVER" : "DXE"
107 }
108
109 gPcdDatabaseAutoGenH = TemplateString("""
110 #define PCD_${PHASE}_SERVICE_DRIVER_VERSION ${SERVICE_DRIVER_VERSION}
111
112 //
113 // External PCD database debug information
114 //
115 #if 0
116 #define ${PHASE}_GUID_TABLE_SIZE ${GUID_TABLE_SIZE}
117 #define ${PHASE}_STRING_TABLE_SIZE ${STRING_TABLE_SIZE}
118 #define ${PHASE}_SKUID_TABLE_SIZE ${SKUID_TABLE_SIZE}
119 #define ${PHASE}_LOCAL_TOKEN_NUMBER_TABLE_SIZE ${LOCAL_TOKEN_NUMBER_TABLE_SIZE}
120 #define ${PHASE}_LOCAL_TOKEN_NUMBER ${LOCAL_TOKEN_NUMBER}
121 #define ${PHASE}_EXMAPPING_TABLE_SIZE ${EXMAPPING_TABLE_SIZE}
122 #define ${PHASE}_EX_TOKEN_NUMBER ${EX_TOKEN_NUMBER}
123 #define ${PHASE}_SIZE_TABLE_SIZE ${SIZE_TABLE_SIZE}
124 #define ${PHASE}_GUID_TABLE_EMPTY ${GUID_TABLE_EMPTY}
125 #define ${PHASE}_STRING_TABLE_EMPTY ${STRING_TABLE_EMPTY}
126 #define ${PHASE}_SKUID_TABLE_EMPTY ${SKUID_TABLE_EMPTY}
127 #define ${PHASE}_DATABASE_EMPTY ${DATABASE_EMPTY}
128 #define ${PHASE}_EXMAP_TABLE_EMPTY ${EXMAP_TABLE_EMPTY}
129
130 typedef struct {
131 UINT64 SkuIdTable[${PHASE}_SKUID_TABLE_SIZE];
132 ${BEGIN} UINT64 ${INIT_CNAME_DECL_UINT64}_${INIT_GUID_DECL_UINT64}[${INIT_NUMSKUS_DECL_UINT64}];
133 ${END}
134 ${BEGIN} UINT64 ${VARDEF_CNAME_UINT64}_${VARDEF_GUID_UINT64}_VariableDefault_${VARDEF_SKUID_UINT64};
135 ${END}
136 ${BEGIN} UINT32 ${INIT_CNAME_DECL_UINT32}_${INIT_GUID_DECL_UINT32}[${INIT_NUMSKUS_DECL_UINT32}];
137 ${END}
138 ${BEGIN} UINT32 ${VARDEF_CNAME_UINT32}_${VARDEF_GUID_UINT32}_VariableDefault_${VARDEF_SKUID_UINT32};
139 ${END}
140 ${BEGIN} VPD_HEAD ${VPD_HEAD_CNAME_DECL}_${VPD_HEAD_GUID_DECL}[${VPD_HEAD_NUMSKUS_DECL}];
141 ${END}
142 DYNAMICEX_MAPPING ExMapTable[${PHASE}_EXMAPPING_TABLE_SIZE];
143 UINT32 LocalTokenNumberTable[${PHASE}_LOCAL_TOKEN_NUMBER_TABLE_SIZE];
144 GUID GuidTable[${PHASE}_GUID_TABLE_SIZE];
145 ${BEGIN} STRING_HEAD ${STRING_HEAD_CNAME_DECL}_${STRING_HEAD_GUID_DECL}[${STRING_HEAD_NUMSKUS_DECL}];
146 ${END}
147 ${BEGIN} VARIABLE_HEAD ${VARIABLE_HEAD_CNAME_DECL}_${VARIABLE_HEAD_GUID_DECL}_Variable_Header[${VARIABLE_HEAD_NUMSKUS_DECL}];
148 ${BEGIN} UINT8 StringTable${STRING_TABLE_INDEX}[${STRING_TABLE_LENGTH}]; /* ${STRING_TABLE_CNAME}_${STRING_TABLE_GUID} */
149 ${END}
150 SIZE_INFO SizeTable[${PHASE}_SIZE_TABLE_SIZE];
151 ${BEGIN} UINT16 ${INIT_CNAME_DECL_UINT16}_${INIT_GUID_DECL_UINT16}[${INIT_NUMSKUS_DECL_UINT16}];
152 ${END}
153 ${BEGIN} UINT16 ${VARDEF_CNAME_UINT16}_${VARDEF_GUID_UINT16}_VariableDefault_${VARDEF_SKUID_UINT16};
154 ${END}
155 ${BEGIN} UINT8 ${INIT_CNAME_DECL_UINT8}_${INIT_GUID_DECL_UINT8}[${INIT_NUMSKUS_DECL_UINT8}];
156 ${END}
157 ${BEGIN} UINT8 ${VARDEF_CNAME_UINT8}_${VARDEF_GUID_UINT8}_VariableDefault_${VARDEF_SKUID_UINT8};
158 ${END}
159 ${BEGIN} BOOLEAN ${INIT_CNAME_DECL_BOOLEAN}_${INIT_GUID_DECL_BOOLEAN}[${INIT_NUMSKUS_DECL_BOOLEAN}];
160 ${END}
161 ${BEGIN} BOOLEAN ${VARDEF_CNAME_BOOLEAN}_${VARDEF_GUID_BOOLEAN}_VariableDefault_${VARDEF_SKUID_BOOLEAN};
162 ${END}
163 ${SYSTEM_SKU_ID}
164 } ${PHASE}_PCD_DATABASE_INIT;
165
166 typedef struct {
167 ${PCD_DATABASE_UNINIT_EMPTY}
168 ${BEGIN} UINT64 ${UNINIT_CNAME_DECL_UINT64}_${UNINIT_GUID_DECL_UINT64}[${UNINIT_NUMSKUS_DECL_UINT64}];
169 ${END}
170 ${BEGIN} UINT32 ${UNINIT_CNAME_DECL_UINT32}_${UNINIT_GUID_DECL_UINT32}[${UNINIT_NUMSKUS_DECL_UINT32}];
171 ${END}
172 ${BEGIN} UINT16 ${UNINIT_CNAME_DECL_UINT16}_${UNINIT_GUID_DECL_UINT16}[${UNINIT_NUMSKUS_DECL_UINT16}];
173 ${END}
174 ${BEGIN} UINT8 ${UNINIT_CNAME_DECL_UINT8}_${UNINIT_GUID_DECL_UINT8}[${UNINIT_NUMSKUS_DECL_UINT8}];
175 ${END}
176 ${BEGIN} BOOLEAN ${UNINIT_CNAME_DECL_BOOLEAN}_${UNINIT_GUID_DECL_BOOLEAN}[${UNINIT_NUMSKUS_DECL_BOOLEAN}];
177 ${END}
178 } ${PHASE}_PCD_DATABASE_UNINIT;
179
180 typedef struct {
181 //GUID Signature; // PcdDataBaseGuid
182 //UINT32 BuildVersion;
183 //UINT32 Length;
184 //SKU_ID SystemSkuId; // Current SkuId value.
185 //UINT32 LengthForAllSkus; // Length of all SKU PCD DB
186 //UINT32 UninitDataBaseSize;// Total size for PCD those default value with 0.
187 //TABLE_OFFSET LocalTokenNumberTableOffset;
188 //TABLE_OFFSET ExMapTableOffset;
189 //TABLE_OFFSET GuidTableOffset;
190 //TABLE_OFFSET StringTableOffset;
191 //TABLE_OFFSET SizeTableOffset;
192 //TABLE_OFFSET SkuIdTableOffset;
193 //TABLE_OFFSET PcdNameTableOffset;
194 //UINT16 LocalTokenCount; // LOCAL_TOKEN_NUMBER for all
195 //UINT16 ExTokenCount; // EX_TOKEN_NUMBER for DynamicEx
196 //UINT16 GuidTableCount; // The Number of Guid in GuidTable
197 //UINT8 Pad[6];
198 ${PHASE}_PCD_DATABASE_INIT Init;
199 ${PHASE}_PCD_DATABASE_UNINIT Uninit;
200 } ${PHASE}_PCD_DATABASE;
201
202 #define ${PHASE}_NEX_TOKEN_NUMBER (${PHASE}_LOCAL_TOKEN_NUMBER - ${PHASE}_EX_TOKEN_NUMBER)
203 #endif
204 """)
205
206
207 gEmptyPcdDatabaseAutoGenC = TemplateString("""
208 //
209 // External PCD database debug information
210 //
211 #if 0
212 ${PHASE}_PCD_DATABASE_INIT g${PHASE}PcdDbInit = {
213 /* SkuIdTable */
214 { 0 },
215 /* ExMapTable */
216 {
217 {0, 0, 0}
218 },
219 /* LocalTokenNumberTable */
220 {
221 0
222 },
223 /* GuidTable */
224 {
225 {0x00000000, 0x0000, 0x0000, {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}}
226 },
227 /* StringTable */
228 { 0 },
229 /* SkuHead */
230 {
231 0, 0
232 },
233 /* SizeTable */
234 {
235 0, 0
236 },
237 ${SYSTEM_SKU_ID_VALUE}
238 };
239 #endif
240 """)
241
242 ## DbItemList
243 #
244 # The class holds the Pcd database items. ItemSize if not zero should match the item datum type in the C structure.
245 # When the structure is changed, remember to check the ItemSize and the related PackStr in PackData()
246 # RawDataList is the RawData that may need some kind of calculation or transformation,
247 # the DataList corresponds to the data that need to be written to database. If DataList is not present, then RawDataList
248 # will be written to the database.
249 #
250 class DbItemList:
251 def __init__(self, ItemSize, DataList=None, RawDataList=None):
252 self.ItemSize = ItemSize
253 self.DataList = DataList if DataList else []
254 self.RawDataList = RawDataList if RawDataList else []
255 self.ListSize = 0
256
257 def GetInterOffset(self, Index):
258 Offset = 0
259 if self.ItemSize == 0:
260 #
261 # Variable length, need to calculate one by one
262 #
263 assert(Index < len(self.RawDataList))
264 for ItemIndex in range(Index):
265 Offset += len(self.RawDataList[ItemIndex])
266 else:
267 Offset = self.ItemSize * Index
268
269 return Offset
270
271 def GetListSize(self):
272 if self.ListSize:
273 return self.ListSize
274 if len(self.RawDataList) == 0:
275 self.ListSize = 0
276 return self.ListSize
277 if self.ItemSize == 0:
278 self.ListSize = self.GetInterOffset(len(self.RawDataList) - 1) + len(self.RawDataList[len(self.RawDataList)-1])
279 else:
280 self.ListSize = self.ItemSize * len(self.RawDataList)
281 return self.ListSize
282
283 def PackData(self):
284 ## PackGuid
285 #
286 # Pack the GUID value in C structure format into data array
287 #
288 # @param GuidStructureValue: The GUID value in C structure format
289 #
290 # @retval Buffer: a data array contains the Guid
291 #
292 def PackGuid(GuidStructureValue):
293 GuidString = GuidStructureStringToGuidString(GuidStructureValue)
294 return PackGUID(GuidString.split('-'))
295
296 PackStr = PACK_CODE_BY_SIZE[self.ItemSize]
297
298 Buffer = bytearray()
299 for Datas in self.RawDataList:
300 if type(Datas) in (list, tuple):
301 for Data in Datas:
302 if PackStr:
303 Buffer += pack(PackStr, GetIntegerValue(Data))
304 else:
305 Buffer += PackGuid(Data)
306 else:
307 if PackStr:
308 Buffer += pack(PackStr, GetIntegerValue(Datas))
309 else:
310 Buffer += PackGuid(Datas)
311
312 return Buffer
313
314 ## DbExMapTblItemList
315 #
316 # The class holds the ExMap table
317 #
318 class DbExMapTblItemList (DbItemList):
319 def __init__(self, ItemSize, DataList=None, RawDataList=None):
320 DbItemList.__init__(self, ItemSize, DataList, RawDataList)
321
322 def PackData(self):
323 Buffer = bytearray()
324 PackStr = "=LHH"
325 for Datas in self.RawDataList:
326 Buffer += pack(PackStr,
327 GetIntegerValue(Datas[0]),
328 GetIntegerValue(Datas[1]),
329 GetIntegerValue(Datas[2]))
330 return Buffer
331
332 ## DbComItemList
333 #
334 # The DbComItemList is a special kind of DbItemList in case that the size of the List can not be computed by the
335 # ItemSize multiply the ItemCount.
336 #
337 class DbComItemList (DbItemList):
338 def __init__(self, ItemSize, DataList=None, RawDataList=None):
339 DbItemList.__init__(self, ItemSize, DataList, RawDataList)
340
341 def GetInterOffset(self, Index):
342 Offset = 0
343 if self.ItemSize == 0:
344 #
345 # Variable length, need to calculate one by one
346 # The only variable table is stringtable, it is not Composite item, should not reach here
347 #
348 assert(False)
349 else:
350 assert(Index < len(self.RawDataList))
351 for ItemIndex in range(Index):
352 Offset += len(self.RawDataList[ItemIndex]) * self.ItemSize
353
354 return Offset
355
356 def GetListSize(self):
357 if self.ListSize:
358 return self.ListSize
359 if self.ItemSize == 0:
360 assert(False)
361 else:
362 if len(self.RawDataList) == 0:
363 self.ListSize = 0
364 else:
365 self.ListSize = self.GetInterOffset(len(self.RawDataList) - 1) + len(self.RawDataList[len(self.RawDataList)-1]) * self.ItemSize
366
367 return self.ListSize
368
369 def PackData(self):
370 PackStr = PACK_CODE_BY_SIZE[self.ItemSize]
371
372 Buffer = bytearray()
373 for DataList in self.RawDataList:
374 for Data in DataList:
375 if type(Data) in (list, tuple):
376 for SingleData in Data:
377 Buffer += pack(PackStr, GetIntegerValue(SingleData))
378 else:
379 Buffer += pack(PackStr, GetIntegerValue(Data))
380
381 return Buffer
382
383 ## DbVariableTableItemList
384 #
385 # The class holds the Variable header value table
386 #
387 class DbVariableTableItemList (DbComItemList):
388 def __init__(self, ItemSize, DataList=None, RawDataList=None):
389 DbComItemList.__init__(self, ItemSize, DataList, RawDataList)
390
391 def PackData(self):
392 PackStr = "=LLHHLHH"
393 Buffer = bytearray()
394 for DataList in self.RawDataList:
395 for Data in DataList:
396 Buffer += pack(PackStr,
397 GetIntegerValue(Data[0]),
398 GetIntegerValue(Data[1]),
399 GetIntegerValue(Data[2]),
400 GetIntegerValue(Data[3]),
401 GetIntegerValue(Data[4]),
402 GetIntegerValue(Data[5]),
403 GetIntegerValue(0))
404 return Buffer
405
406 class DbStringHeadTableItemList(DbItemList):
407 def __init__(self,ItemSize,DataList=None,RawDataList=None):
408 DbItemList.__init__(self, ItemSize, DataList, RawDataList)
409
410 def GetInterOffset(self, Index):
411 Offset = 0
412 if self.ItemSize == 0:
413 #
414 # Variable length, need to calculate one by one
415 #
416 assert(Index < len(self.RawDataList))
417 for ItemIndex in range(Index):
418 Offset += len(self.RawDataList[ItemIndex])
419 else:
420 for innerIndex in range(Index):
421 if type(self.RawDataList[innerIndex]) in (list, tuple):
422 Offset += len(self.RawDataList[innerIndex]) * self.ItemSize
423 else:
424 Offset += self.ItemSize
425
426 return Offset
427
428 def GetListSize(self):
429 if self.ListSize:
430 return self.ListSize
431 if len(self.RawDataList) == 0:
432 self.ListSize = 0
433 return self.ListSize
434 if self.ItemSize == 0:
435 self.ListSize = self.GetInterOffset(len(self.RawDataList) - 1) + len(self.RawDataList[len(self.RawDataList)-1])
436 else:
437 for Datas in self.RawDataList:
438 if type(Datas) in (list, tuple):
439 self.ListSize += len(Datas) * self.ItemSize
440 else:
441 self.ListSize += self.ItemSize
442 return self.ListSize
443
444 ## DbSkuHeadTableItemList
445 #
446 # The class holds the Sku header value table
447 #
448 class DbSkuHeadTableItemList (DbItemList):
449 def __init__(self, ItemSize, DataList=None, RawDataList=None):
450 DbItemList.__init__(self, ItemSize, DataList, RawDataList)
451
452 def PackData(self):
453 PackStr = "=LL"
454 Buffer = bytearray()
455 for Data in self.RawDataList:
456 Buffer += pack(PackStr,
457 GetIntegerValue(Data[0]),
458 GetIntegerValue(Data[1]))
459 return Buffer
460
461 ## DbSizeTableItemList
462 #
463 # The class holds the size table
464 #
465 class DbSizeTableItemList (DbItemList):
466 def __init__(self, ItemSize, DataList=None, RawDataList=None):
467 DbItemList.__init__(self, ItemSize, DataList, RawDataList)
468
469 def GetListSize(self):
470 length = 0
471 for Data in self.RawDataList:
472 length += (1 + len(Data[1]))
473 return length * self.ItemSize
474 def PackData(self):
475 PackStr = "=H"
476 Buffer = bytearray()
477 for Data in self.RawDataList:
478 Buffer += pack(PackStr,
479 GetIntegerValue(Data[0]))
480 for subData in Data[1]:
481 Buffer += pack(PackStr,
482 GetIntegerValue(subData))
483 return Buffer
484
485 ## DbStringItemList
486 #
487 # The class holds the string table
488 #
489 class DbStringItemList (DbComItemList):
490 def __init__(self, ItemSize, DataList=None, RawDataList=None, LenList=None):
491 if DataList is None:
492 DataList = []
493 if RawDataList is None:
494 RawDataList = []
495 if LenList is None:
496 LenList = []
497
498 assert(len(RawDataList) == len(LenList))
499 DataList = []
500 # adjust DataList according to the LenList
501 for Index in range(len(RawDataList)):
502 Len = LenList[Index]
503 RawDatas = RawDataList[Index]
504 assert(Len >= len(RawDatas))
505 ActualDatas = []
506 for i in range(len(RawDatas)):
507 ActualDatas.append(RawDatas[i])
508 for i in range(len(RawDatas), Len):
509 ActualDatas.append(0)
510 DataList.append(ActualDatas)
511 self.LenList = LenList
512 DbComItemList.__init__(self, ItemSize, DataList, RawDataList)
513 def GetInterOffset(self, Index):
514 Offset = 0
515
516 assert(Index < len(self.LenList))
517 for ItemIndex in range(Index):
518 Offset += self.LenList[ItemIndex]
519
520 return Offset
521
522 def GetListSize(self):
523 if self.ListSize:
524 return self.ListSize
525
526 if len(self.LenList) == 0:
527 self.ListSize = 0
528 else:
529 self.ListSize = self.GetInterOffset(len(self.LenList) - 1) + self.LenList[len(self.LenList)-1]
530
531 return self.ListSize
532
533 def PackData(self):
534 self.RawDataList = self.DataList
535 return DbComItemList.PackData(self)
536
537
538
539 ## Find the index in two list where the item matches the key separately
540 #
541 # @param Key1 The key used to search the List1
542 # @param List1 The list that Key1 will be searched
543 # @param Key2 The key used to search the List2
544 # @param List2 The list that Key2 will be searched
545 #
546 # @retval Index The position inside the list where list1[Index] == Key1 and list2[Index] == Key2
547 #
548 def GetMatchedIndex(Key1, List1, Key2, List2):
549 StartPos = 0
550 while StartPos < len(List1):
551 Index = List1.index(Key1, StartPos)
552 if List2[Index] == Key2:
553 return Index
554 else:
555 StartPos = Index + 1
556
557 return -1
558
559
560 ## convert StringArray like {0x36, 0x00, 0x34, 0x00, 0x21, 0x00, 0x36, 0x00, 0x34, 0x00, 0x00, 0x00}
561 # to List like [0x36, 0x00, 0x34, 0x00, 0x21, 0x00, 0x36, 0x00, 0x34, 0x00, 0x00, 0x00]
562 #
563 # @param StringArray A string array like {0x36, 0x00, 0x34, 0x00, 0x21, 0x00, 0x36, 0x00, 0x34, 0x00, 0x00, 0x00}
564 #
565 # @retval A list object of integer items
566 #
567 def StringArrayToList(StringArray):
568 StringArray = StringArray[1:-1]
569 StringArray = '[' + StringArray + ']'
570 return eval(StringArray)
571
572
573 ## Convert TokenType String like "PCD_DATUM_TYPE_UINT32 | PCD_TYPE_HII" to TokenType value
574 #
575 # @param TokenType A TokenType string like "PCD_DATUM_TYPE_UINT32 | PCD_TYPE_HII"
576 #
577 # @retval A integer representation of the TokenType
578 #
579 def GetTokenTypeValue(TokenType):
580 TokenTypeDict = {
581 "PCD_TYPE_SHIFT": 28,
582 "PCD_TYPE_DATA": (0x0 << 28),
583 "PCD_TYPE_HII": (0x8 << 28),
584 "PCD_TYPE_VPD": (0x4 << 28),
585 # "PCD_TYPE_SKU_ENABLED":(0x2 << 28),
586 "PCD_TYPE_STRING": (0x1 << 28),
587
588 "PCD_DATUM_TYPE_SHIFT": 24,
589 "PCD_DATUM_TYPE_POINTER": (0x0 << 24),
590 "PCD_DATUM_TYPE_UINT8": (0x1 << 24),
591 "PCD_DATUM_TYPE_UINT16": (0x2 << 24),
592 "PCD_DATUM_TYPE_UINT32": (0x4 << 24),
593 "PCD_DATUM_TYPE_UINT64": (0x8 << 24),
594
595 "PCD_DATUM_TYPE_SHIFT2": 20,
596 "PCD_DATUM_TYPE_UINT8_BOOLEAN": (0x1 << 20 | 0x1 << 24),
597 }
598 return eval(TokenType, TokenTypeDict)
599
600 ## construct the external Pcd database using data from Dict
601 #
602 # @param Dict A dictionary contains Pcd related tables
603 #
604 # @retval Buffer A byte stream of the Pcd database
605 #
606 def BuildExDataBase(Dict):
607 # init Db items
608 InitValueUint64 = Dict['INIT_DB_VALUE_UINT64']
609 DbInitValueUint64 = DbComItemList(8, RawDataList = InitValueUint64)
610 VardefValueUint64 = Dict['VARDEF_DB_VALUE_UINT64']
611 DbVardefValueUint64 = DbItemList(8, RawDataList = VardefValueUint64)
612 InitValueUint32 = Dict['INIT_DB_VALUE_UINT32']
613 DbInitValueUint32 = DbComItemList(4, RawDataList = InitValueUint32)
614 VardefValueUint32 = Dict['VARDEF_DB_VALUE_UINT32']
615 DbVardefValueUint32 = DbItemList(4, RawDataList = VardefValueUint32)
616 VpdHeadValue = Dict['VPD_DB_VALUE']
617 DbVpdHeadValue = DbComItemList(4, RawDataList = VpdHeadValue)
618 ExMapTable = list(zip(Dict['EXMAPPING_TABLE_EXTOKEN'], Dict['EXMAPPING_TABLE_LOCAL_TOKEN'], Dict['EXMAPPING_TABLE_GUID_INDEX']))
619 DbExMapTable = DbExMapTblItemList(8, RawDataList = ExMapTable)
620 LocalTokenNumberTable = Dict['LOCAL_TOKEN_NUMBER_DB_VALUE']
621 DbLocalTokenNumberTable = DbItemList(4, RawDataList = LocalTokenNumberTable)
622 GuidTable = Dict['GUID_STRUCTURE']
623 DbGuidTable = DbItemList(16, RawDataList = GuidTable)
624 StringHeadValue = Dict['STRING_DB_VALUE']
625 # DbItemList to DbStringHeadTableItemList
626 DbStringHeadValue = DbStringHeadTableItemList(4, RawDataList = StringHeadValue)
627 VariableTable = Dict['VARIABLE_DB_VALUE']
628 DbVariableTable = DbVariableTableItemList(20, RawDataList = VariableTable)
629 NumberOfSkuEnabledPcd = GetIntegerValue(Dict['SKU_HEAD_SIZE'])
630
631 Dict['STRING_TABLE_DB_VALUE'] = [StringArrayToList(x) for x in Dict['STRING_TABLE_VALUE']]
632
633 StringTableValue = Dict['STRING_TABLE_DB_VALUE']
634 # when calcute the offset, should use StringTableLen instead of StringTableValue, as string maximum len may be different with actual len
635 StringTableLen = Dict['STRING_TABLE_LENGTH']
636 DbStringTableLen = DbStringItemList(0, RawDataList = StringTableValue, LenList = StringTableLen)
637
638
639 PcdTokenTable = Dict['PCD_TOKENSPACE']
640 PcdTokenLen = Dict['PCD_TOKENSPACE_LENGTH']
641 PcdTokenTableValue = [StringArrayToList(x) for x in Dict['PCD_TOKENSPACE']]
642 DbPcdTokenTable = DbStringItemList(0, RawDataList = PcdTokenTableValue, LenList = PcdTokenLen)
643
644 PcdCNameTable = Dict['PCD_CNAME']
645 PcdCNameLen = Dict['PCD_CNAME_LENGTH']
646 PcdCNameTableValue = [StringArrayToList(x) for x in Dict['PCD_CNAME']]
647 DbPcdCNameTable = DbStringItemList(0, RawDataList = PcdCNameTableValue, LenList = PcdCNameLen)
648
649 PcdNameOffsetTable = Dict['PCD_NAME_OFFSET']
650 DbPcdNameOffsetTable = DbItemList(4, RawDataList = PcdNameOffsetTable)
651
652 SizeTableValue = list(zip(Dict['SIZE_TABLE_MAXIMUM_LENGTH'], Dict['SIZE_TABLE_CURRENT_LENGTH']))
653 DbSizeTableValue = DbSizeTableItemList(2, RawDataList = SizeTableValue)
654 InitValueUint16 = Dict['INIT_DB_VALUE_UINT16']
655 DbInitValueUint16 = DbComItemList(2, RawDataList = InitValueUint16)
656 VardefValueUint16 = Dict['VARDEF_DB_VALUE_UINT16']
657 DbVardefValueUint16 = DbItemList(2, RawDataList = VardefValueUint16)
658 InitValueUint8 = Dict['INIT_DB_VALUE_UINT8']
659 DbInitValueUint8 = DbComItemList(1, RawDataList = InitValueUint8)
660 VardefValueUint8 = Dict['VARDEF_DB_VALUE_UINT8']
661 DbVardefValueUint8 = DbItemList(1, RawDataList = VardefValueUint8)
662 InitValueBoolean = Dict['INIT_DB_VALUE_BOOLEAN']
663 DbInitValueBoolean = DbComItemList(1, RawDataList = InitValueBoolean)
664 VardefValueBoolean = Dict['VARDEF_DB_VALUE_BOOLEAN']
665 DbVardefValueBoolean = DbItemList(1, RawDataList = VardefValueBoolean)
666 SkuidValue = Dict['SKUID_VALUE']
667 DbSkuidValue = DbItemList(8, RawDataList = SkuidValue)
668
669
670
671 # Unit Db Items
672 UnInitValueUint64 = Dict['UNINIT_GUID_DECL_UINT64']
673 DbUnInitValueUint64 = DbItemList(8, RawDataList = UnInitValueUint64)
674 UnInitValueUint32 = Dict['UNINIT_GUID_DECL_UINT32']
675 DbUnInitValueUint32 = DbItemList(4, RawDataList = UnInitValueUint32)
676 UnInitValueUint16 = Dict['UNINIT_GUID_DECL_UINT16']
677 DbUnInitValueUint16 = DbItemList(2, RawDataList = UnInitValueUint16)
678 UnInitValueUint8 = Dict['UNINIT_GUID_DECL_UINT8']
679 DbUnInitValueUint8 = DbItemList(1, RawDataList = UnInitValueUint8)
680 UnInitValueBoolean = Dict['UNINIT_GUID_DECL_BOOLEAN']
681 DbUnInitValueBoolean = DbItemList(1, RawDataList = UnInitValueBoolean)
682 PcdTokenNumberMap = Dict['PCD_ORDER_TOKEN_NUMBER_MAP']
683
684 DbNameTotle = ["SkuidValue", "InitValueUint64", "VardefValueUint64", "InitValueUint32", "VardefValueUint32", "VpdHeadValue", "ExMapTable",
685 "LocalTokenNumberTable", "GuidTable", "StringHeadValue", "PcdNameOffsetTable", "VariableTable", "StringTableLen", "PcdTokenTable", "PcdCNameTable",
686 "SizeTableValue", "InitValueUint16", "VardefValueUint16", "InitValueUint8", "VardefValueUint8", "InitValueBoolean",
687 "VardefValueBoolean", "UnInitValueUint64", "UnInitValueUint32", "UnInitValueUint16", "UnInitValueUint8", "UnInitValueBoolean"]
688
689 DbTotal = [SkuidValue, InitValueUint64, VardefValueUint64, InitValueUint32, VardefValueUint32, VpdHeadValue, ExMapTable,
690 LocalTokenNumberTable, GuidTable, StringHeadValue, PcdNameOffsetTable, VariableTable, StringTableLen, PcdTokenTable, PcdCNameTable,
691 SizeTableValue, InitValueUint16, VardefValueUint16, InitValueUint8, VardefValueUint8, InitValueBoolean,
692 VardefValueBoolean, UnInitValueUint64, UnInitValueUint32, UnInitValueUint16, UnInitValueUint8, UnInitValueBoolean]
693 DbItemTotal = [DbSkuidValue, DbInitValueUint64, DbVardefValueUint64, DbInitValueUint32, DbVardefValueUint32, DbVpdHeadValue, DbExMapTable,
694 DbLocalTokenNumberTable, DbGuidTable, DbStringHeadValue, DbPcdNameOffsetTable, DbVariableTable, DbStringTableLen, DbPcdTokenTable, DbPcdCNameTable,
695 DbSizeTableValue, DbInitValueUint16, DbVardefValueUint16, DbInitValueUint8, DbVardefValueUint8, DbInitValueBoolean,
696 DbVardefValueBoolean, DbUnInitValueUint64, DbUnInitValueUint32, DbUnInitValueUint16, DbUnInitValueUint8, DbUnInitValueBoolean]
697
698 # VardefValueBoolean is the last table in the init table items
699 InitTableNum = DbNameTotle.index("VardefValueBoolean") + 1
700 # The FixedHeader length of the PCD_DATABASE_INIT, from Signature to Pad
701 FixedHeaderLen = 80
702
703 # Get offset of SkuId table in the database
704 SkuIdTableOffset = FixedHeaderLen
705 for DbIndex in range(len(DbTotal)):
706 if DbTotal[DbIndex] is SkuidValue:
707 break
708 SkuIdTableOffset += DbItemTotal[DbIndex].GetListSize()
709
710
711 # Get offset of SkuValue table in the database
712
713 # Fix up the LocalTokenNumberTable, SkuHeader table
714 for (LocalTokenNumberTableIndex, (Offset, Table)) in enumerate(LocalTokenNumberTable):
715 DbIndex = 0
716 DbOffset = FixedHeaderLen
717 for DbIndex in range(len(DbTotal)):
718 if DbTotal[DbIndex] is Table:
719 DbOffset += DbItemTotal[DbIndex].GetInterOffset(Offset)
720 break
721 DbOffset += DbItemTotal[DbIndex].GetListSize()
722 if DbIndex + 1 == InitTableNum:
723 if DbOffset % 8:
724 DbOffset += (8 - DbOffset % 8)
725 else:
726 assert(False)
727
728 TokenTypeValue = Dict['TOKEN_TYPE'][LocalTokenNumberTableIndex]
729 TokenTypeValue = GetTokenTypeValue(TokenTypeValue)
730 LocalTokenNumberTable[LocalTokenNumberTableIndex] = DbOffset|int(TokenTypeValue)
731 # if PCD_TYPE_SKU_ENABLED, then we need to fix up the SkuTable
732
733
734
735
736 # resolve variable table offset
737 for VariableEntries in VariableTable:
738 skuindex = 0
739 for VariableEntryPerSku in VariableEntries:
740 (VariableHeadGuidIndex, VariableHeadStringIndex, SKUVariableOffset, VariableOffset, VariableRefTable, VariableAttribute) = VariableEntryPerSku[:]
741 DbIndex = 0
742 DbOffset = FixedHeaderLen
743 for DbIndex in range(len(DbTotal)):
744 if DbTotal[DbIndex] is VariableRefTable:
745 DbOffset += DbItemTotal[DbIndex].GetInterOffset(VariableOffset)
746 break
747 DbOffset += DbItemTotal[DbIndex].GetListSize()
748 if DbIndex + 1 == InitTableNum:
749 if DbOffset % 8:
750 DbOffset += (8 - DbOffset % 8)
751 else:
752 assert(False)
753 if isinstance(VariableRefTable[0], list):
754 DbOffset += skuindex * 4
755 skuindex += 1
756 if DbIndex >= InitTableNum:
757 assert(False)
758 VarAttr, VarProp = VariableAttributes.GetVarAttributes(VariableAttribute)
759 VariableEntryPerSku[:] = (VariableHeadStringIndex, DbOffset, VariableHeadGuidIndex, SKUVariableOffset, VarAttr, VarProp)
760
761 # calculate various table offset now
762 DbTotalLength = FixedHeaderLen
763 for DbIndex in range(len(DbItemTotal)):
764 if DbItemTotal[DbIndex] is DbLocalTokenNumberTable:
765 LocalTokenNumberTableOffset = DbTotalLength
766 elif DbItemTotal[DbIndex] is DbExMapTable:
767 ExMapTableOffset = DbTotalLength
768 elif DbItemTotal[DbIndex] is DbGuidTable:
769 GuidTableOffset = DbTotalLength
770 elif DbItemTotal[DbIndex] is DbStringTableLen:
771 StringTableOffset = DbTotalLength
772 elif DbItemTotal[DbIndex] is DbSizeTableValue:
773 SizeTableOffset = DbTotalLength
774 elif DbItemTotal[DbIndex] is DbSkuidValue:
775 SkuIdTableOffset = DbTotalLength
776 elif DbItemTotal[DbIndex] is DbPcdNameOffsetTable:
777 DbPcdNameOffset = DbTotalLength
778
779
780 DbTotalLength += DbItemTotal[DbIndex].GetListSize()
781 if not Dict['PCD_INFO_FLAG']:
782 DbPcdNameOffset = 0
783 LocalTokenCount = GetIntegerValue(Dict['LOCAL_TOKEN_NUMBER'])
784 ExTokenCount = GetIntegerValue(Dict['EX_TOKEN_NUMBER'])
785 GuidTableCount = GetIntegerValue(Dict['GUID_TABLE_SIZE'])
786 SystemSkuId = GetIntegerValue(Dict['SYSTEM_SKU_ID_VALUE'])
787 Pad = 0xDA
788
789 UninitDataBaseSize = 0
790 for Item in (DbUnInitValueUint64, DbUnInitValueUint32, DbUnInitValueUint16, DbUnInitValueUint8, DbUnInitValueBoolean):
791 UninitDataBaseSize += Item.GetListSize()
792
793 if (DbTotalLength - UninitDataBaseSize) % 8:
794 DbTotalLength += (8 - (DbTotalLength - UninitDataBaseSize) % 8)
795 # Construct the database buffer
796 Guid = "{0x3c7d193c, 0x682c, 0x4c14, 0xa6, 0x8f, 0x55, 0x2d, 0xea, 0x4f, 0x43, 0x7e}"
797 Guid = StringArrayToList(Guid)
798 Buffer = PackByteFormatGUID(Guid)
799
800 b = pack("=L", DATABASE_VERSION)
801 Buffer += b
802
803 b = pack('=L', DbTotalLength - UninitDataBaseSize)
804
805 Buffer += b
806 b = pack('=Q', SystemSkuId)
807
808 Buffer += b
809 b = pack('=L', 0)
810
811 Buffer += b
812 b = pack('=L', UninitDataBaseSize)
813
814 Buffer += b
815 b = pack('=L', LocalTokenNumberTableOffset)
816
817 Buffer += b
818 b = pack('=L', ExMapTableOffset)
819
820 Buffer += b
821 b = pack('=L', GuidTableOffset)
822
823 Buffer += b
824 b = pack('=L', StringTableOffset)
825
826 Buffer += b
827 b = pack('=L', SizeTableOffset)
828
829 Buffer += b
830 b = pack('=L', SkuIdTableOffset)
831
832 Buffer += b
833 b = pack('=L', DbPcdNameOffset)
834
835 Buffer += b
836 b = pack('=H', LocalTokenCount)
837
838 Buffer += b
839 b = pack('=H', ExTokenCount)
840
841 Buffer += b
842 b = pack('=H', GuidTableCount)
843
844 Buffer += b
845 b = pack('=B', Pad)
846 Buffer += b
847 Buffer += b
848 Buffer += b
849 Buffer += b
850 Buffer += b
851 Buffer += b
852
853 Index = 0
854 for Item in DbItemTotal:
855 Index +=1
856 packdata = Item.PackData()
857 for i in range(len(packdata)):
858 Buffer += packdata[i:i + 1]
859 if Index == InitTableNum:
860 if len(Buffer) % 8:
861 for num in range(8 - len(Buffer) % 8):
862 b = pack('=B', Pad)
863 Buffer += b
864 break
865 return Buffer
866
867 ## Create code for PCD database
868 #
869 # @param Info The ModuleAutoGen object
870 # @param AutoGenC The TemplateString object for C code
871 # @param AutoGenH The TemplateString object for header file
872 #
873 def CreatePcdDatabaseCode (Info, AutoGenC, AutoGenH):
874 if Info.PcdIsDriver == "":
875 return
876 if Info.PcdIsDriver not in gPcdPhaseMap:
877 EdkLogger.error("build", AUTOGEN_ERROR, "Not supported PcdIsDriver type:%s" % Info.PcdIsDriver,
878 ExtraData="[%s]" % str(Info))
879
880 AdditionalAutoGenH, AdditionalAutoGenC, PcdDbBuffer = NewCreatePcdDatabasePhaseSpecificAutoGen (Info.PlatformInfo, 'PEI')
881 AutoGenH.Append(AdditionalAutoGenH.String)
882
883 Phase = gPcdPhaseMap[Info.PcdIsDriver]
884 if Phase == 'PEI':
885 AutoGenC.Append(AdditionalAutoGenC.String)
886
887 if Phase == 'DXE':
888 AdditionalAutoGenH, AdditionalAutoGenC, PcdDbBuffer = NewCreatePcdDatabasePhaseSpecificAutoGen (Info.PlatformInfo, Phase)
889 AutoGenH.Append(AdditionalAutoGenH.String)
890 AutoGenC.Append(AdditionalAutoGenC.String)
891
892 if Info.IsBinaryModule:
893 DbFileName = os.path.join(Info.PlatformInfo.BuildDir, TAB_FV_DIRECTORY, Phase + "PcdDataBase.raw")
894 else:
895 DbFileName = os.path.join(Info.OutputDir, Phase + "PcdDataBase.raw")
896 DbFile = BytesIO()
897 DbFile.write(PcdDbBuffer)
898 Changed = SaveFileOnChange(DbFileName, DbFile.getvalue(), True)
899 def CreatePcdDataBase(PcdDBData):
900 delta = {}
901 for skuname, skuid in PcdDBData:
902 if len(PcdDBData[(skuname, skuid)][1]) != len(PcdDBData[(TAB_DEFAULT, "0")][1]):
903 EdkLogger.ERROR("The size of each sku in one pcd are not same")
904 for skuname, skuid in PcdDBData:
905 if skuname == TAB_DEFAULT:
906 continue
907 delta[(skuname, skuid)] = [(index, data, hex(data)) for index, data in enumerate(PcdDBData[(skuname, skuid)][1]) if PcdDBData[(skuname, skuid)][1][index] != PcdDBData[(TAB_DEFAULT, "0")][1][index]]
908 databasebuff = PcdDBData[(TAB_DEFAULT, "0")][0]
909
910 for skuname, skuid in delta:
911 # 8 byte align
912 if len(databasebuff) % 8 > 0:
913 for i in range(8 - (len(databasebuff) % 8)):
914 databasebuff += pack("=B", 0)
915 databasebuff += pack('=Q', int(skuid))
916 databasebuff += pack('=Q', 0)
917 databasebuff += pack('=L', 8+8+4+4*len(delta[(skuname, skuid)]))
918 for item in delta[(skuname, skuid)]:
919 databasebuff += pack("=L", item[0])
920 databasebuff = databasebuff[:-1] + pack("=B", item[1])
921 totallen = len(databasebuff)
922 totallenbuff = pack("=L", totallen)
923 newbuffer = databasebuff[:32]
924 for i in range(4):
925 newbuffer += totallenbuff[i:i+1]
926 for i in range(36, totallen):
927 newbuffer += databasebuff[i:i+1]
928
929 return newbuffer
930
931 def CreateVarCheckBin(VarCheckTab):
932 return VarCheckTab[(TAB_DEFAULT, "0")]
933
934 def CreateAutoGen(PcdDriverAutoGenData):
935 autogenC = TemplateString()
936 for skuname, skuid in PcdDriverAutoGenData:
937 autogenC.Append("//SKUID: %s" % skuname)
938 autogenC.Append(PcdDriverAutoGenData[(skuname, skuid)][1].String)
939 return (PcdDriverAutoGenData[(skuname, skuid)][0], autogenC)
940 def NewCreatePcdDatabasePhaseSpecificAutoGen(Platform, Phase):
941 def prune_sku(pcd, skuname):
942 new_pcd = copy.deepcopy(pcd)
943 new_pcd.SkuInfoList = {skuname:pcd.SkuInfoList[skuname]}
944 new_pcd.isinit = 'INIT'
945 if new_pcd.DatumType in TAB_PCD_NUMERIC_TYPES:
946 for skuobj in pcd.SkuInfoList.values():
947 if skuobj.DefaultValue:
948 defaultvalue = int(skuobj.DefaultValue, 16) if skuobj.DefaultValue.upper().startswith("0X") else int(skuobj.DefaultValue, 10)
949 if defaultvalue != 0:
950 new_pcd.isinit = "INIT"
951 break
952 elif skuobj.VariableName:
953 new_pcd.isinit = "INIT"
954 break
955 else:
956 new_pcd.isinit = "UNINIT"
957 return new_pcd
958 DynamicPcds = Platform.DynamicPcdList
959 DynamicPcdSet_Sku = {(SkuName, skuobj.SkuId):[] for pcd in DynamicPcds for (SkuName, skuobj) in pcd.SkuInfoList.items() }
960 for skuname, skuid in DynamicPcdSet_Sku:
961 DynamicPcdSet_Sku[(skuname, skuid)] = [prune_sku(pcd, skuname) for pcd in DynamicPcds]
962 PcdDBData = {}
963 PcdDriverAutoGenData = {}
964 VarCheckTableData = {}
965 if DynamicPcdSet_Sku:
966 for skuname, skuid in DynamicPcdSet_Sku:
967 AdditionalAutoGenH, AdditionalAutoGenC, PcdDbBuffer, VarCheckTab = CreatePcdDatabasePhaseSpecificAutoGen (Platform, DynamicPcdSet_Sku[(skuname, skuid)], Phase)
968 final_data = ()
969 for item in range(len(PcdDbBuffer)):
970 final_data += unpack("B", PcdDbBuffer[item:item+1])
971 PcdDBData[(skuname, skuid)] = (PcdDbBuffer, final_data)
972 PcdDriverAutoGenData[(skuname, skuid)] = (AdditionalAutoGenH, AdditionalAutoGenC)
973 VarCheckTableData[(skuname, skuid)] = VarCheckTab
974 if Platform.Platform.VarCheckFlag:
975 dest = os.path.join(Platform.BuildDir, TAB_FV_DIRECTORY)
976 VarCheckTable = CreateVarCheckBin(VarCheckTableData)
977 VarCheckTable.dump(dest, Phase)
978 AdditionalAutoGenH, AdditionalAutoGenC = CreateAutoGen(PcdDriverAutoGenData)
979 else:
980 AdditionalAutoGenH, AdditionalAutoGenC, PcdDbBuffer, VarCheckTab = CreatePcdDatabasePhaseSpecificAutoGen (Platform, {}, Phase)
981 final_data = ()
982 for item in range(len(PcdDbBuffer)):
983 final_data += unpack("B", PcdDbBuffer[item:item + 1])
984 PcdDBData[(TAB_DEFAULT, "0")] = (PcdDbBuffer, final_data)
985
986 return AdditionalAutoGenH, AdditionalAutoGenC, CreatePcdDataBase(PcdDBData)
987 ## Create PCD database in DXE or PEI phase
988 #
989 # @param Platform The platform object
990 # @retval tuple Two TemplateString objects for C code and header file,
991 # respectively
992 #
993 def CreatePcdDatabasePhaseSpecificAutoGen (Platform, DynamicPcdList, Phase):
994 AutoGenC = TemplateString()
995 AutoGenH = TemplateString()
996
997 Dict = {
998 'PHASE' : Phase,
999 'SERVICE_DRIVER_VERSION' : DATABASE_VERSION,
1000 'GUID_TABLE_SIZE' : '1U',
1001 'STRING_TABLE_SIZE' : '1U',
1002 'SKUID_TABLE_SIZE' : '1U',
1003 'LOCAL_TOKEN_NUMBER_TABLE_SIZE' : '0U',
1004 'LOCAL_TOKEN_NUMBER' : '0U',
1005 'EXMAPPING_TABLE_SIZE' : '1U',
1006 'EX_TOKEN_NUMBER' : '0U',
1007 'SIZE_TABLE_SIZE' : '2U',
1008 'SKU_HEAD_SIZE' : '1U',
1009 'GUID_TABLE_EMPTY' : 'TRUE',
1010 'STRING_TABLE_EMPTY' : 'TRUE',
1011 'SKUID_TABLE_EMPTY' : 'TRUE',
1012 'DATABASE_EMPTY' : 'TRUE',
1013 'EXMAP_TABLE_EMPTY' : 'TRUE',
1014 'PCD_DATABASE_UNINIT_EMPTY' : ' UINT8 dummy; /* PCD_DATABASE_UNINIT is empty */',
1015 'SYSTEM_SKU_ID' : ' SKU_ID SystemSkuId;',
1016 'SYSTEM_SKU_ID_VALUE' : '0U'
1017 }
1018
1019 SkuObj = Platform.Platform.SkuIdMgr
1020 Dict['SYSTEM_SKU_ID_VALUE'] = 0 if SkuObj.SkuUsageType == SkuObj.SINGLE else Platform.Platform.SkuIds[SkuObj.SystemSkuId][0]
1021
1022 Dict['PCD_INFO_FLAG'] = Platform.Platform.PcdInfoFlag
1023
1024 for DatumType in TAB_PCD_NUMERIC_TYPES_VOID:
1025 Dict['VARDEF_CNAME_' + DatumType] = []
1026 Dict['VARDEF_GUID_' + DatumType] = []
1027 Dict['VARDEF_SKUID_' + DatumType] = []
1028 Dict['VARDEF_VALUE_' + DatumType] = []
1029 Dict['VARDEF_DB_VALUE_' + DatumType] = []
1030 for Init in ['INIT', 'UNINIT']:
1031 Dict[Init+'_CNAME_DECL_' + DatumType] = []
1032 Dict[Init+'_GUID_DECL_' + DatumType] = []
1033 Dict[Init+'_NUMSKUS_DECL_' + DatumType] = []
1034 Dict[Init+'_VALUE_' + DatumType] = []
1035 Dict[Init+'_DB_VALUE_'+DatumType] = []
1036
1037 for Type in ['STRING_HEAD', 'VPD_HEAD', 'VARIABLE_HEAD']:
1038 Dict[Type + '_CNAME_DECL'] = []
1039 Dict[Type + '_GUID_DECL'] = []
1040 Dict[Type + '_NUMSKUS_DECL'] = []
1041 Dict[Type + '_VALUE'] = []
1042
1043 Dict['STRING_DB_VALUE'] = []
1044 Dict['VPD_DB_VALUE'] = []
1045 Dict['VARIABLE_DB_VALUE'] = []
1046
1047 Dict['STRING_TABLE_INDEX'] = []
1048 Dict['STRING_TABLE_LENGTH'] = []
1049 Dict['STRING_TABLE_CNAME'] = []
1050 Dict['STRING_TABLE_GUID'] = []
1051 Dict['STRING_TABLE_VALUE'] = []
1052 Dict['STRING_TABLE_DB_VALUE'] = []
1053
1054 Dict['SIZE_TABLE_CNAME'] = []
1055 Dict['SIZE_TABLE_GUID'] = []
1056 Dict['SIZE_TABLE_CURRENT_LENGTH'] = []
1057 Dict['SIZE_TABLE_MAXIMUM_LENGTH'] = []
1058
1059 Dict['EXMAPPING_TABLE_EXTOKEN'] = []
1060 Dict['EXMAPPING_TABLE_LOCAL_TOKEN'] = []
1061 Dict['EXMAPPING_TABLE_GUID_INDEX'] = []
1062
1063 Dict['GUID_STRUCTURE'] = []
1064 Dict['SKUID_VALUE'] = [0] # init Dict length
1065 Dict['VARDEF_HEADER'] = []
1066
1067 Dict['LOCAL_TOKEN_NUMBER_DB_VALUE'] = []
1068 Dict['VARIABLE_DB_VALUE'] = []
1069
1070 Dict['PCD_TOKENSPACE'] = []
1071 Dict['PCD_CNAME'] = []
1072 Dict['PCD_TOKENSPACE_LENGTH'] = []
1073 Dict['PCD_CNAME_LENGTH'] = []
1074 Dict['PCD_TOKENSPACE_OFFSET'] = []
1075 Dict['PCD_CNAME_OFFSET'] = []
1076 Dict['PCD_TOKENSPACE_MAP'] = []
1077 Dict['PCD_NAME_OFFSET'] = []
1078
1079 Dict['PCD_ORDER_TOKEN_NUMBER_MAP'] = {}
1080 PCD_STRING_INDEX_MAP = {}
1081
1082 StringTableIndex = 0
1083 StringTableSize = 0
1084 NumberOfLocalTokens = 0
1085 NumberOfPeiLocalTokens = 0
1086 NumberOfDxeLocalTokens = 0
1087 NumberOfExTokens = 0
1088 NumberOfSizeItems = 0
1089 NumberOfSkuEnabledPcd = 0
1090 GuidList = []
1091 VarCheckTab = VAR_CHECK_PCD_VARIABLE_TAB_CONTAINER()
1092 i = 0
1093 ReorderedDynPcdList = GetOrderedDynamicPcdList(DynamicPcdList, Platform.PcdTokenNumber)
1094 for item in ReorderedDynPcdList:
1095 if item.DatumType not in [TAB_UINT8, TAB_UINT16, TAB_UINT32, TAB_UINT64, TAB_VOID, "BOOLEAN"]:
1096 item.DatumType = TAB_VOID
1097 for Pcd in ReorderedDynPcdList:
1098 VoidStarTypeCurrSize = []
1099 i += 1
1100 CName = Pcd.TokenCName
1101 TokenSpaceGuidCName = Pcd.TokenSpaceGuidCName
1102
1103 for PcdItem in GlobalData.MixedPcd:
1104 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:
1105 CName = PcdItem[0]
1106
1107 EdkLogger.debug(EdkLogger.DEBUG_3, "PCD: %s %s (%s : %s)" % (CName, TokenSpaceGuidCName, Pcd.Phase, Phase))
1108
1109 if Pcd.Phase == 'PEI':
1110 NumberOfPeiLocalTokens += 1
1111 if Pcd.Phase == 'DXE':
1112 NumberOfDxeLocalTokens += 1
1113 if Pcd.Phase != Phase:
1114 continue
1115
1116 #
1117 # TODO: need GetGuidValue() definition
1118 #
1119 TokenSpaceGuidStructure = Pcd.TokenSpaceGuidValue
1120 TokenSpaceGuid = GuidStructureStringToGuidValueName(TokenSpaceGuidStructure)
1121 if Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET:
1122 if TokenSpaceGuid not in GuidList:
1123 GuidList.append(TokenSpaceGuid)
1124 Dict['GUID_STRUCTURE'].append(TokenSpaceGuidStructure)
1125 NumberOfExTokens += 1
1126
1127 ValueList = []
1128 DbValueList = []
1129 StringHeadOffsetList = []
1130 StringDbOffsetList = []
1131 VpdHeadOffsetList = []
1132 VpdDbOffsetList = []
1133 VariableHeadValueList = []
1134 VariableDbValueList = []
1135 Pcd.InitString = 'UNINIT'
1136
1137 if Pcd.DatumType == TAB_VOID:
1138 if Pcd.Type not in [TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_EX_VPD]:
1139 Pcd.TokenTypeList = ['PCD_TYPE_STRING']
1140 else:
1141 Pcd.TokenTypeList = []
1142 elif Pcd.DatumType == 'BOOLEAN':
1143 Pcd.TokenTypeList = ['PCD_DATUM_TYPE_UINT8_BOOLEAN']
1144 else:
1145 Pcd.TokenTypeList = ['PCD_DATUM_TYPE_' + Pcd.DatumType]
1146
1147 if len(Pcd.SkuInfoList) > 1:
1148 NumberOfSkuEnabledPcd += 1
1149
1150 SkuIdIndex = 1
1151 VariableHeadList = []
1152 for SkuName in Pcd.SkuInfoList:
1153 Sku = Pcd.SkuInfoList[SkuName]
1154 SkuId = Sku.SkuId
1155 if SkuId is None or SkuId == '':
1156 continue
1157
1158
1159 SkuIdIndex += 1
1160
1161 if len(Sku.VariableName) > 0:
1162 VariableGuidStructure = Sku.VariableGuidValue
1163 VariableGuid = GuidStructureStringToGuidValueName(VariableGuidStructure)
1164 if Platform.Platform.VarCheckFlag:
1165 var_check_obj = VAR_CHECK_PCD_VARIABLE_TAB(VariableGuidStructure, StringToArray(Sku.VariableName))
1166 try:
1167 var_check_obj.push_back(GetValidationObject(Pcd, Sku.VariableOffset))
1168 VarAttr, _ = VariableAttributes.GetVarAttributes(Sku.VariableAttribute)
1169 var_check_obj.SetAttributes(VarAttr)
1170 var_check_obj.UpdateSize()
1171 VarCheckTab.push_back(var_check_obj)
1172 except Exception:
1173 ValidInfo = ''
1174 if Pcd.validateranges:
1175 ValidInfo = Pcd.validateranges[0]
1176 if Pcd.validlists:
1177 ValidInfo = Pcd.validlists[0]
1178 if ValidInfo:
1179 EdkLogger.error("build", PCD_VALIDATION_INFO_ERROR,
1180 "The PCD '%s.%s' Validation information defined in DEC file has incorrect format." % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
1181 ExtraData = "[%s]" % str(ValidInfo))
1182 else:
1183 EdkLogger.error("build", PCD_VALIDATION_INFO_ERROR,
1184 "The PCD '%s.%s' Validation information defined in DEC file has incorrect format." % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName))
1185 Pcd.TokenTypeList.append('PCD_TYPE_HII')
1186 Pcd.InitString = 'INIT'
1187 # Store all variable names of one HII PCD under different SKU to stringTable
1188 # and calculate the VariableHeadStringIndex
1189
1190 VariableNameStructure = StringToArray(Sku.VariableName)
1191
1192 # Make pointer of VaraibleName(HII PCD) 2 bytes aligned
1193 VariableNameStructureBytes = VariableNameStructure.lstrip("{").rstrip("}").split(",")
1194 if len(VariableNameStructureBytes) % 2:
1195 VariableNameStructure = "{%s,0x00}" % ",".join(VariableNameStructureBytes)
1196
1197 if VariableNameStructure not in Dict['STRING_TABLE_VALUE']:
1198 Dict['STRING_TABLE_CNAME'].append(CName)
1199 Dict['STRING_TABLE_GUID'].append(TokenSpaceGuid)
1200 if StringTableIndex == 0:
1201 Dict['STRING_TABLE_INDEX'].append('')
1202 else:
1203 Dict['STRING_TABLE_INDEX'].append('_%d' % StringTableIndex)
1204 VarNameSize = len(VariableNameStructure.replace(',', ' ').split())
1205 Dict['STRING_TABLE_LENGTH'].append(VarNameSize )
1206 Dict['STRING_TABLE_VALUE'].append(VariableNameStructure)
1207 StringHeadOffsetList.append(str(StringTableSize) + 'U')
1208 VarStringDbOffsetList = []
1209 VarStringDbOffsetList.append(StringTableSize)
1210 Dict['STRING_DB_VALUE'].append(VarStringDbOffsetList)
1211 StringTableIndex += 1
1212 StringTableSize += len(VariableNameStructure.replace(',', ' ').split())
1213 VariableHeadStringIndex = 0
1214 for Index in range(Dict['STRING_TABLE_VALUE'].index(VariableNameStructure)):
1215 VariableHeadStringIndex += Dict['STRING_TABLE_LENGTH'][Index]
1216 VariableHeadList.append(VariableHeadStringIndex)
1217
1218 VariableHeadStringIndex = VariableHeadList[SkuIdIndex - 2]
1219 # store VariableGuid to GuidTable and get the VariableHeadGuidIndex
1220
1221 if VariableGuid not in GuidList:
1222 GuidList.append(VariableGuid)
1223 Dict['GUID_STRUCTURE'].append(VariableGuidStructure)
1224 VariableHeadGuidIndex = GuidList.index(VariableGuid)
1225
1226 if "PCD_TYPE_STRING" in Pcd.TokenTypeList:
1227 VariableHeadValueList.append('%dU, offsetof(%s_PCD_DATABASE, Init.%s_%s), %dU, %sU' %
1228 (VariableHeadStringIndex, Phase, CName, TokenSpaceGuid,
1229 VariableHeadGuidIndex, Sku.VariableOffset))
1230 else:
1231 VariableHeadValueList.append('%dU, offsetof(%s_PCD_DATABASE, Init.%s_%s_VariableDefault_%s), %dU, %sU' %
1232 (VariableHeadStringIndex, Phase, CName, TokenSpaceGuid, SkuIdIndex,
1233 VariableHeadGuidIndex, Sku.VariableOffset))
1234 Dict['VARDEF_CNAME_'+Pcd.DatumType].append(CName)
1235 Dict['VARDEF_GUID_'+Pcd.DatumType].append(TokenSpaceGuid)
1236 Dict['VARDEF_SKUID_'+Pcd.DatumType].append(SkuIdIndex)
1237 if "PCD_TYPE_STRING" in Pcd.TokenTypeList:
1238 Dict['VARDEF_VALUE_' + Pcd.DatumType].append("%s_%s[%d]" % (Pcd.TokenCName, TokenSpaceGuid, SkuIdIndex))
1239 else:
1240 #
1241 # ULL (for UINT64) or U(other integer type) should be append to avoid
1242 # warning under linux building environment.
1243 #
1244 Dict['VARDEF_DB_VALUE_'+Pcd.DatumType].append(Sku.HiiDefaultValue)
1245
1246 if Pcd.DatumType == TAB_UINT64:
1247 Dict['VARDEF_VALUE_'+Pcd.DatumType].append(Sku.HiiDefaultValue + "ULL")
1248 elif Pcd.DatumType in (TAB_UINT32, TAB_UINT16, TAB_UINT8):
1249 Dict['VARDEF_VALUE_'+Pcd.DatumType].append(Sku.HiiDefaultValue + "U")
1250 elif Pcd.DatumType == "BOOLEAN":
1251 if eval(Sku.HiiDefaultValue) in [1, 0]:
1252 Dict['VARDEF_VALUE_'+Pcd.DatumType].append(str(eval(Sku.HiiDefaultValue)) + "U")
1253 else:
1254 Dict['VARDEF_VALUE_'+Pcd.DatumType].append(Sku.HiiDefaultValue)
1255
1256 # construct the VariableHeader value
1257 if "PCD_TYPE_STRING" in Pcd.TokenTypeList:
1258 VariableHeadValueList.append('%dU, %dU, %sU, offsetof(%s_PCD_DATABASE, Init.%s_%s)' %
1259 (VariableHeadGuidIndex, VariableHeadStringIndex, Sku.VariableOffset,
1260 Phase, CName, TokenSpaceGuid))
1261 # the Pcd default value will be filled later on
1262 VariableOffset = len(Dict['STRING_DB_VALUE'])
1263 VariableRefTable = Dict['STRING_DB_VALUE']
1264 else:
1265 VariableHeadValueList.append('%dU, %dU, %sU, offsetof(%s_PCD_DATABASE, Init.%s_%s_VariableDefault_%s)' %
1266 (VariableHeadGuidIndex, VariableHeadStringIndex, Sku.VariableOffset,
1267 Phase, CName, TokenSpaceGuid, SkuIdIndex))
1268 # the Pcd default value was filled before
1269 VariableOffset = len(Dict['VARDEF_DB_VALUE_' + Pcd.DatumType]) - 1
1270 VariableRefTable = Dict['VARDEF_DB_VALUE_' + Pcd.DatumType]
1271 VariableDbValueList.append([VariableHeadGuidIndex, VariableHeadStringIndex, Sku.VariableOffset, VariableOffset, VariableRefTable, Sku.VariableAttribute])
1272
1273 elif Sku.VpdOffset != '':
1274 Pcd.TokenTypeList.append('PCD_TYPE_VPD')
1275 Pcd.InitString = 'INIT'
1276 VpdHeadOffsetList.append(str(Sku.VpdOffset) + 'U')
1277 VpdDbOffsetList.append(Sku.VpdOffset)
1278 # Also add the VOID* string of VPD PCD to SizeTable
1279 if Pcd.DatumType == TAB_VOID:
1280 NumberOfSizeItems += 1
1281 # For VPD type of PCD, its current size is equal to its MAX size.
1282 VoidStarTypeCurrSize = [str(Pcd.MaxDatumSize) + 'U']
1283 continue
1284
1285 if Pcd.DatumType == TAB_VOID:
1286 Pcd.TokenTypeList.append('PCD_TYPE_STRING')
1287 Pcd.InitString = 'INIT'
1288 if Sku.HiiDefaultValue != '' and Sku.DefaultValue == '':
1289 Sku.DefaultValue = Sku.HiiDefaultValue
1290 if Sku.DefaultValue != '':
1291 NumberOfSizeItems += 1
1292 Dict['STRING_TABLE_CNAME'].append(CName)
1293 Dict['STRING_TABLE_GUID'].append(TokenSpaceGuid)
1294
1295 if StringTableIndex == 0:
1296 Dict['STRING_TABLE_INDEX'].append('')
1297 else:
1298 Dict['STRING_TABLE_INDEX'].append('_%d' % StringTableIndex)
1299 if Sku.DefaultValue[0] == 'L':
1300 DefaultValueBinStructure = StringToArray(Sku.DefaultValue)
1301 Size = len(DefaultValueBinStructure.replace(',', ' ').split())
1302 Dict['STRING_TABLE_VALUE'].append(DefaultValueBinStructure)
1303 elif Sku.DefaultValue[0] == '"':
1304 DefaultValueBinStructure = StringToArray(Sku.DefaultValue)
1305 Size = len(Sku.DefaultValue) - 2 + 1
1306 Dict['STRING_TABLE_VALUE'].append(DefaultValueBinStructure)
1307 elif Sku.DefaultValue[0] == '{':
1308 DefaultValueBinStructure = StringToArray(Sku.DefaultValue)
1309 Size = len(Sku.DefaultValue.split(","))
1310 Dict['STRING_TABLE_VALUE'].append(DefaultValueBinStructure)
1311
1312 StringHeadOffsetList.append(str(StringTableSize) + 'U')
1313 StringDbOffsetList.append(StringTableSize)
1314 if Pcd.MaxDatumSize != '':
1315 MaxDatumSize = int(Pcd.MaxDatumSize, 0)
1316 if MaxDatumSize < Size:
1317 if Pcd.MaxSizeUserSet:
1318 EdkLogger.error("build", AUTOGEN_ERROR,
1319 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
1320 ExtraData="[%s]" % str(Platform))
1321 else:
1322 MaxDatumSize = Size
1323 else:
1324 MaxDatumSize = Size
1325 StringTabLen = MaxDatumSize
1326 if StringTabLen % 2:
1327 StringTabLen += 1
1328 if Sku.VpdOffset == '':
1329 VoidStarTypeCurrSize.append(str(Size) + 'U')
1330 Dict['STRING_TABLE_LENGTH'].append(StringTabLen)
1331 StringTableIndex += 1
1332 StringTableSize += (StringTabLen)
1333 else:
1334 if "PCD_TYPE_HII" not in Pcd.TokenTypeList:
1335 Pcd.TokenTypeList.append('PCD_TYPE_DATA')
1336 if Sku.DefaultValue == 'TRUE':
1337 Pcd.InitString = 'INIT'
1338 else:
1339 Pcd.InitString = Pcd.isinit
1340 #
1341 # For UNIT64 type PCD's value, ULL should be append to avoid
1342 # warning under linux building environment.
1343 #
1344 if Pcd.DatumType == TAB_UINT64:
1345 ValueList.append(Sku.DefaultValue + "ULL")
1346 elif Pcd.DatumType in (TAB_UINT32, TAB_UINT16, TAB_UINT8):
1347 ValueList.append(Sku.DefaultValue + "U")
1348 elif Pcd.DatumType == "BOOLEAN":
1349 if Sku.DefaultValue in ["1", "0"]:
1350 ValueList.append(Sku.DefaultValue + "U")
1351 else:
1352 ValueList.append(Sku.DefaultValue)
1353
1354 DbValueList.append(Sku.DefaultValue)
1355
1356 Pcd.TokenTypeList = list(set(Pcd.TokenTypeList))
1357 if Pcd.DatumType == TAB_VOID:
1358 Dict['SIZE_TABLE_CNAME'].append(CName)
1359 Dict['SIZE_TABLE_GUID'].append(TokenSpaceGuid)
1360 Dict['SIZE_TABLE_MAXIMUM_LENGTH'].append(str(Pcd.MaxDatumSize) + 'U')
1361 Dict['SIZE_TABLE_CURRENT_LENGTH'].append(VoidStarTypeCurrSize)
1362
1363
1364
1365 if 'PCD_TYPE_HII' in Pcd.TokenTypeList:
1366 Dict['VARIABLE_HEAD_CNAME_DECL'].append(CName)
1367 Dict['VARIABLE_HEAD_GUID_DECL'].append(TokenSpaceGuid)
1368 Dict['VARIABLE_HEAD_NUMSKUS_DECL'].append(len(Pcd.SkuInfoList))
1369 Dict['VARIABLE_HEAD_VALUE'].append('{ %s }\n' % ' },\n { '.join(VariableHeadValueList))
1370 Dict['VARDEF_HEADER'].append('_Variable_Header')
1371 Dict['VARIABLE_DB_VALUE'].append(VariableDbValueList)
1372 else:
1373 Dict['VARDEF_HEADER'].append('')
1374 if 'PCD_TYPE_VPD' in Pcd.TokenTypeList:
1375 Dict['VPD_HEAD_CNAME_DECL'].append(CName)
1376 Dict['VPD_HEAD_GUID_DECL'].append(TokenSpaceGuid)
1377 Dict['VPD_HEAD_NUMSKUS_DECL'].append(len(Pcd.SkuInfoList))
1378 Dict['VPD_HEAD_VALUE'].append('{ %s }' % ' }, { '.join(VpdHeadOffsetList))
1379 Dict['VPD_DB_VALUE'].append(VpdDbOffsetList)
1380 if 'PCD_TYPE_STRING' in Pcd.TokenTypeList:
1381 Dict['STRING_HEAD_CNAME_DECL'].append(CName)
1382 Dict['STRING_HEAD_GUID_DECL'].append(TokenSpaceGuid)
1383 Dict['STRING_HEAD_NUMSKUS_DECL'].append(len(Pcd.SkuInfoList))
1384 Dict['STRING_HEAD_VALUE'].append(', '.join(StringHeadOffsetList))
1385 Dict['STRING_DB_VALUE'].append(StringDbOffsetList)
1386 PCD_STRING_INDEX_MAP[len(Dict['STRING_HEAD_CNAME_DECL']) -1 ] = len(Dict['STRING_DB_VALUE']) -1
1387 if 'PCD_TYPE_DATA' in Pcd.TokenTypeList:
1388 Dict[Pcd.InitString+'_CNAME_DECL_'+Pcd.DatumType].append(CName)
1389 Dict[Pcd.InitString+'_GUID_DECL_'+Pcd.DatumType].append(TokenSpaceGuid)
1390 Dict[Pcd.InitString+'_NUMSKUS_DECL_'+Pcd.DatumType].append(len(Pcd.SkuInfoList))
1391 if Pcd.InitString == 'UNINIT':
1392 Dict['PCD_DATABASE_UNINIT_EMPTY'] = ''
1393 else:
1394 Dict[Pcd.InitString+'_VALUE_'+Pcd.DatumType].append(', '.join(ValueList))
1395 Dict[Pcd.InitString+'_DB_VALUE_'+Pcd.DatumType].append(DbValueList)
1396
1397 if Phase == 'PEI':
1398 NumberOfLocalTokens = NumberOfPeiLocalTokens
1399 if Phase == 'DXE':
1400 NumberOfLocalTokens = NumberOfDxeLocalTokens
1401
1402 Dict['TOKEN_INIT'] = ['' for x in range(NumberOfLocalTokens)]
1403 Dict['TOKEN_CNAME'] = ['' for x in range(NumberOfLocalTokens)]
1404 Dict['TOKEN_GUID'] = ['' for x in range(NumberOfLocalTokens)]
1405 Dict['TOKEN_TYPE'] = ['' for x in range(NumberOfLocalTokens)]
1406 Dict['LOCAL_TOKEN_NUMBER_DB_VALUE'] = ['' for x in range(NumberOfLocalTokens)]
1407 Dict['PCD_CNAME'] = ['' for x in range(NumberOfLocalTokens)]
1408 Dict['PCD_TOKENSPACE_MAP'] = ['' for x in range(NumberOfLocalTokens)]
1409 Dict['PCD_CNAME_LENGTH'] = [0 for x in range(NumberOfLocalTokens)]
1410 SkuEnablePcdIndex = 0
1411 for Pcd in ReorderedDynPcdList:
1412 CName = Pcd.TokenCName
1413 TokenSpaceGuidCName = Pcd.TokenSpaceGuidCName
1414 if Pcd.Phase != Phase:
1415 continue
1416
1417 TokenSpaceGuid = GuidStructureStringToGuidValueName(Pcd.TokenSpaceGuidValue) #(Platform.PackageList, TokenSpaceGuidCName))
1418 GeneratedTokenNumber = Platform.PcdTokenNumber[CName, TokenSpaceGuidCName] - 1
1419 if Phase == 'DXE':
1420 GeneratedTokenNumber -= NumberOfPeiLocalTokens
1421
1422 if len(Pcd.SkuInfoList) > 1:
1423 Dict['PCD_ORDER_TOKEN_NUMBER_MAP'][GeneratedTokenNumber] = SkuEnablePcdIndex
1424 SkuEnablePcdIndex += 1
1425
1426 for PcdItem in GlobalData.MixedPcd:
1427 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:
1428 CName = PcdItem[0]
1429
1430 EdkLogger.debug(EdkLogger.DEBUG_1, "PCD = %s.%s" % (CName, TokenSpaceGuidCName))
1431 EdkLogger.debug(EdkLogger.DEBUG_1, "phase = %s" % Phase)
1432 EdkLogger.debug(EdkLogger.DEBUG_1, "GeneratedTokenNumber = %s" % str(GeneratedTokenNumber))
1433
1434 #
1435 # following four Dict items hold the information for LocalTokenNumberTable
1436 #
1437 Dict['TOKEN_INIT'][GeneratedTokenNumber] = 'Init'
1438 if Pcd.InitString == 'UNINIT':
1439 Dict['TOKEN_INIT'][GeneratedTokenNumber] = 'Uninit'
1440
1441 Dict['TOKEN_CNAME'][GeneratedTokenNumber] = CName
1442 Dict['TOKEN_GUID'][GeneratedTokenNumber] = TokenSpaceGuid
1443 Dict['TOKEN_TYPE'][GeneratedTokenNumber] = ' | '.join(Pcd.TokenTypeList)
1444
1445 if Platform.Platform.PcdInfoFlag:
1446 TokenSpaceGuidCNameArray = StringToArray('"' + TokenSpaceGuidCName + '"' )
1447 if TokenSpaceGuidCNameArray not in Dict['PCD_TOKENSPACE']:
1448 Dict['PCD_TOKENSPACE'].append(TokenSpaceGuidCNameArray)
1449 Dict['PCD_TOKENSPACE_LENGTH'].append( len(TokenSpaceGuidCNameArray.split(",")) )
1450 Dict['PCD_TOKENSPACE_MAP'][GeneratedTokenNumber] = Dict['PCD_TOKENSPACE'].index(TokenSpaceGuidCNameArray)
1451 CNameBinArray = StringToArray('"' + CName + '"' )
1452 Dict['PCD_CNAME'][GeneratedTokenNumber] = CNameBinArray
1453
1454 Dict['PCD_CNAME_LENGTH'][GeneratedTokenNumber] = len(CNameBinArray.split(","))
1455
1456
1457 Pcd.TokenTypeList = list(set(Pcd.TokenTypeList))
1458
1459 # search the Offset and Table, used by LocalTokenNumberTableOffset
1460 if 'PCD_TYPE_HII' in Pcd.TokenTypeList:
1461 # Find index by CName, TokenSpaceGuid
1462 Offset = GetMatchedIndex(CName, Dict['VARIABLE_HEAD_CNAME_DECL'], TokenSpaceGuid, Dict['VARIABLE_HEAD_GUID_DECL'])
1463 assert(Offset != -1)
1464 Table = Dict['VARIABLE_DB_VALUE']
1465 if 'PCD_TYPE_VPD' in Pcd.TokenTypeList:
1466 Offset = GetMatchedIndex(CName, Dict['VPD_HEAD_CNAME_DECL'], TokenSpaceGuid, Dict['VPD_HEAD_GUID_DECL'])
1467 assert(Offset != -1)
1468 Table = Dict['VPD_DB_VALUE']
1469 if 'PCD_TYPE_STRING' in Pcd.TokenTypeList and 'PCD_TYPE_HII' not in Pcd.TokenTypeList:
1470 # Find index by CName, TokenSpaceGuid
1471 Offset = GetMatchedIndex(CName, Dict['STRING_HEAD_CNAME_DECL'], TokenSpaceGuid, Dict['STRING_HEAD_GUID_DECL'])
1472 Offset = PCD_STRING_INDEX_MAP[Offset]
1473 assert(Offset != -1)
1474 Table = Dict['STRING_DB_VALUE']
1475 if 'PCD_TYPE_DATA' in Pcd.TokenTypeList:
1476 # need to store whether it is in init table or not
1477 Offset = GetMatchedIndex(CName, Dict[Pcd.InitString+'_CNAME_DECL_'+Pcd.DatumType], TokenSpaceGuid, Dict[Pcd.InitString+'_GUID_DECL_'+Pcd.DatumType])
1478 assert(Offset != -1)
1479 if Pcd.InitString == 'UNINIT':
1480 Table = Dict[Pcd.InitString+'_GUID_DECL_'+Pcd.DatumType]
1481 else:
1482 Table = Dict[Pcd.InitString+'_DB_VALUE_'+Pcd.DatumType]
1483 Dict['LOCAL_TOKEN_NUMBER_DB_VALUE'][GeneratedTokenNumber] = (Offset, Table)
1484
1485 #
1486 # Update VARDEF_HEADER
1487 #
1488 if 'PCD_TYPE_HII' in Pcd.TokenTypeList:
1489 Dict['VARDEF_HEADER'][GeneratedTokenNumber] = '_Variable_Header'
1490 else:
1491 Dict['VARDEF_HEADER'][GeneratedTokenNumber] = ''
1492
1493
1494 if Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET:
1495
1496 if Phase == 'DXE':
1497 GeneratedTokenNumber += NumberOfPeiLocalTokens
1498 #
1499 # Per, PCD architecture specification, PCD Token Number is 1 based and 0 is defined as invalid token number.
1500 # For each EX type PCD, a PCD Token Number is assigned. When the
1501 # PCD Driver/PEIM map EX_GUID and EX_TOKEN_NUMBER to the PCD Token Number,
1502 # the non-EX Protocol/PPI interface can be called to get/set the value. This assumption is made by
1503 # Pcd Driver/PEIM in MdeModulePkg.
1504 # Therefore, 1 is added to GeneratedTokenNumber to generate a PCD Token Number before being inserted
1505 # to the EXMAPPING_TABLE.
1506 #
1507
1508
1509 Dict['EXMAPPING_TABLE_EXTOKEN'].append(str(Pcd.TokenValue) + 'U')
1510 Dict['EXMAPPING_TABLE_LOCAL_TOKEN'].append(str(GeneratedTokenNumber + 1) + 'U')
1511 Dict['EXMAPPING_TABLE_GUID_INDEX'].append(str(GuidList.index(TokenSpaceGuid)) + 'U')
1512
1513 if Platform.Platform.PcdInfoFlag:
1514 for index in range(len(Dict['PCD_TOKENSPACE_MAP'])):
1515 TokenSpaceIndex = StringTableSize
1516 for i in range(Dict['PCD_TOKENSPACE_MAP'][index]):
1517 TokenSpaceIndex += Dict['PCD_TOKENSPACE_LENGTH'][i]
1518 Dict['PCD_TOKENSPACE_OFFSET'].append(TokenSpaceIndex)
1519 for index in range(len(Dict['PCD_TOKENSPACE'])):
1520 StringTableSize += Dict['PCD_TOKENSPACE_LENGTH'][index]
1521 StringTableIndex += 1
1522 for index in range(len(Dict['PCD_CNAME'])):
1523 Dict['PCD_CNAME_OFFSET'].append(StringTableSize)
1524 Dict['PCD_NAME_OFFSET'].append(Dict['PCD_TOKENSPACE_OFFSET'][index])
1525 Dict['PCD_NAME_OFFSET'].append(StringTableSize)
1526 StringTableSize += Dict['PCD_CNAME_LENGTH'][index]
1527 StringTableIndex += 1
1528 if GuidList != []:
1529 Dict['GUID_TABLE_EMPTY'] = 'FALSE'
1530 Dict['GUID_TABLE_SIZE'] = str(len(GuidList)) + 'U'
1531 else:
1532 Dict['GUID_STRUCTURE'] = [GuidStringToGuidStructureString('00000000-0000-0000-0000-000000000000')]
1533
1534 if StringTableIndex == 0:
1535 Dict['STRING_TABLE_INDEX'].append('')
1536 Dict['STRING_TABLE_LENGTH'].append(1)
1537 Dict['STRING_TABLE_CNAME'].append('')
1538 Dict['STRING_TABLE_GUID'].append('')
1539 Dict['STRING_TABLE_VALUE'].append('{ 0 }')
1540 else:
1541 Dict['STRING_TABLE_EMPTY'] = 'FALSE'
1542 Dict['STRING_TABLE_SIZE'] = str(StringTableSize) + 'U'
1543
1544 if Dict['SIZE_TABLE_CNAME'] == []:
1545 Dict['SIZE_TABLE_CNAME'].append('')
1546 Dict['SIZE_TABLE_GUID'].append('')
1547 Dict['SIZE_TABLE_CURRENT_LENGTH'].append(['0U'])
1548 Dict['SIZE_TABLE_MAXIMUM_LENGTH'].append('0U')
1549
1550 if NumberOfLocalTokens != 0:
1551 Dict['DATABASE_EMPTY'] = 'FALSE'
1552 Dict['LOCAL_TOKEN_NUMBER_TABLE_SIZE'] = NumberOfLocalTokens
1553 Dict['LOCAL_TOKEN_NUMBER'] = NumberOfLocalTokens
1554
1555 if NumberOfExTokens != 0:
1556 Dict['EXMAP_TABLE_EMPTY'] = 'FALSE'
1557 Dict['EXMAPPING_TABLE_SIZE'] = str(NumberOfExTokens) + 'U'
1558 Dict['EX_TOKEN_NUMBER'] = str(NumberOfExTokens) + 'U'
1559 else:
1560 Dict['EXMAPPING_TABLE_EXTOKEN'].append('0U')
1561 Dict['EXMAPPING_TABLE_LOCAL_TOKEN'].append('0U')
1562 Dict['EXMAPPING_TABLE_GUID_INDEX'].append('0U')
1563
1564 if NumberOfSizeItems != 0:
1565 Dict['SIZE_TABLE_SIZE'] = str(NumberOfSizeItems * 2) + 'U'
1566
1567 if NumberOfSkuEnabledPcd != 0:
1568 Dict['SKU_HEAD_SIZE'] = str(NumberOfSkuEnabledPcd) + 'U'
1569
1570 for AvailableSkuNumber in SkuObj.SkuIdNumberSet:
1571 if AvailableSkuNumber not in Dict['SKUID_VALUE']:
1572 Dict['SKUID_VALUE'].append(AvailableSkuNumber)
1573 Dict['SKUID_VALUE'][0] = len(Dict['SKUID_VALUE']) - 1
1574
1575 AutoGenH.Append(gPcdDatabaseAutoGenH.Replace(Dict))
1576 if NumberOfLocalTokens == 0:
1577 AutoGenC.Append(gEmptyPcdDatabaseAutoGenC.Replace(Dict))
1578 else:
1579 #
1580 # Update Size Table to the right order, it should be same with LocalTokenNumberTable
1581 #
1582 SizeCNameTempList = []
1583 SizeGuidTempList = []
1584 SizeCurLenTempList = []
1585 SizeMaxLenTempList = []
1586 ReOrderFlag = True
1587
1588 if len(Dict['SIZE_TABLE_CNAME']) == 1:
1589 if not (Dict['SIZE_TABLE_CNAME'][0] and Dict['SIZE_TABLE_GUID'][0]):
1590 ReOrderFlag = False
1591
1592 if ReOrderFlag:
1593 for Count in range(len(Dict['TOKEN_CNAME'])):
1594 for Count1 in range(len(Dict['SIZE_TABLE_CNAME'])):
1595 if Dict['TOKEN_CNAME'][Count] == Dict['SIZE_TABLE_CNAME'][Count1] and \
1596 Dict['TOKEN_GUID'][Count] == Dict['SIZE_TABLE_GUID'][Count1]:
1597 SizeCNameTempList.append(Dict['SIZE_TABLE_CNAME'][Count1])
1598 SizeGuidTempList.append(Dict['SIZE_TABLE_GUID'][Count1])
1599 SizeCurLenTempList.append(Dict['SIZE_TABLE_CURRENT_LENGTH'][Count1])
1600 SizeMaxLenTempList.append(Dict['SIZE_TABLE_MAXIMUM_LENGTH'][Count1])
1601
1602 for Count in range(len(Dict['SIZE_TABLE_CNAME'])):
1603 Dict['SIZE_TABLE_CNAME'][Count] = SizeCNameTempList[Count]
1604 Dict['SIZE_TABLE_GUID'][Count] = SizeGuidTempList[Count]
1605 Dict['SIZE_TABLE_CURRENT_LENGTH'][Count] = SizeCurLenTempList[Count]
1606 Dict['SIZE_TABLE_MAXIMUM_LENGTH'][Count] = SizeMaxLenTempList[Count]
1607
1608 AutoGenC.Append(gPcdDatabaseAutoGenC.Replace(Dict))
1609
1610
1611 # print Phase
1612 Buffer = BuildExDataBase(Dict)
1613 return AutoGenH, AutoGenC, Buffer, VarCheckTab
1614
1615 def GetOrderedDynamicPcdList(DynamicPcdList, PcdTokenNumberList):
1616 ReorderedDyPcdList = [None for i in range(len(DynamicPcdList))]
1617 for Pcd in DynamicPcdList:
1618 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in PcdTokenNumberList:
1619 ReorderedDyPcdList[PcdTokenNumberList[Pcd.TokenCName, Pcd.TokenSpaceGuidCName]-1] = Pcd
1620 return ReorderedDyPcdList
1621