GenPcdDb.py 71 KB

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