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