]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/BPDG/GenVpd.py
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
BaseTools: Fix the bug to align VPD PCD based on value type
[mirror_edk2.git] / BaseTools / Source / Python / BPDG / GenVpd.py
CommitLineData
111be80f 1## @file\r
2# This file include GenVpd class for fix the Vpd type PCD offset, and PcdEntry for describe\r
3# and process each entry of vpd type PCD.\r
4#\r
86737681 5# Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
111be80f 6#\r
7# This program and the accompanying materials\r
8# are licensed and made available under the terms and conditions of the BSD License\r
9# which accompanies this distribution. The full text of the license may be found at\r
10# http://opensource.org/licenses/bsd-license.php\r
11#\r
12# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
13# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
14#\r
15\r
1be2ed90 16import Common.LongFilePathOs as os\r
111be80f 17import StringIO\r
18import StringTable as st\r
19import array\r
6780eef1 20import re\r
1be2ed90 21from Common.LongFilePathSupport import OpenLongFilePath as open\r
111be80f 22from struct import *\r
23import Common.EdkLogger as EdkLogger\r
24import Common.BuildToolError as BuildToolError\r
25\r
26_FORMAT_CHAR = {1: 'B',\r
27 2: 'H',\r
28 4: 'I',\r
29 8: 'Q'\r
30 }\r
31\r
08dd311f
LG		 32## The VPD PCD data structure for store and process each VPD PCD entry.\r
33#\r
34# This class contain method to format and pack pcd's value. \r
35#\r
111be80f 36class PcdEntry:\r
e8a47801 37 def __init__(self, PcdCName, SkuId,PcdOffset, PcdSize, PcdValue, Lineno=None, FileName=None, PcdUnpackValue=None, \r
86737681 38 PcdBinOffset=None, PcdBinSize=None, Alignment=None):\r
111be80f 39 self.PcdCName = PcdCName.strip()\r
e8a47801 40 self.SkuId = SkuId.strip()\r
111be80f 41 self.PcdOffset = PcdOffset.strip()\r
42 self.PcdSize = PcdSize.strip()\r
43 self.PcdValue = PcdValue.strip()\r
44 self.Lineno = Lineno.strip()\r
45 self.FileName = FileName.strip()\r
46 self.PcdUnpackValue = PcdUnpackValue\r
47 self.PcdBinOffset = PcdBinOffset\r
48 self.PcdBinSize = PcdBinSize\r
86737681 49 self.Alignment = Alignment\r
111be80f 50 \r
51 if self.PcdValue == '' :\r
47fea6af
YZ		 52 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
53 "Invalid PCD format(Name: %s File: %s line: %s) , no Value specified!" % (self.PcdCName, self.FileName, self.Lineno))\r
54\r
111be80f 55 if self.PcdOffset == '' :\r
47fea6af
YZ		 56 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
57 "Invalid PCD format(Name: %s File: %s Line: %s) , no Offset specified!" % (self.PcdCName, self.FileName, self.Lineno))\r
58\r
111be80f 59 if self.PcdSize == '' :\r
47fea6af
YZ		 60 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
61 "Invalid PCD format(Name: %s File: %s Line: %s), no PcdSize specified!" % (self.PcdCName, self.FileName, self.Lineno))\r
62\r
111be80f 63 self._GenOffsetValue ()\r
47fea6af 64\r
08dd311f
LG		 65 ## Analyze the string value to judge the PCD's datum type euqal to Boolean or not.\r
66 # \r
67 # @param ValueString PCD's value\r
68 # @param Size PCD's size\r
69 # \r
70 # @retval True PCD's datum type is Boolean\r
71 # @retval False PCD's datum type is not Boolean. \r
72 # \r
73 def _IsBoolean(self, ValueString, Size):\r
74 if (Size == "1"):\r
75 if ValueString.upper() in ["TRUE", "FALSE"]:\r
76 return True\r
77 elif ValueString in ["0", "1", "0x0", "0x1", "0x00", "0x01"]:\r
47fea6af
YZ		 78 return True\r
79\r
111be80f 80 return False\r
47fea6af 81\r
08dd311f
LG		 82 ## Convert the PCD's value from string to integer.\r
83 # \r
84 # This function will try to convert the Offset value form string to integer\r
85 # for both hexadecimal and decimal.\r
86 # \r
111be80f 87 def _GenOffsetValue(self):\r
88 if self.PcdOffset != "*" :\r
89 try:\r
90 self.PcdBinOffset = int (self.PcdOffset)\r
91 except:\r
92 try:\r
93 self.PcdBinOffset = int(self.PcdOffset, 16)\r
94 except:\r
47fea6af
YZ		 95 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
96 "Invalid offset value %s for PCD %s (File: %s Line: %s)" % (self.PcdOffset, self.PcdCName, self.FileName, self.Lineno))\r
97\r
08dd311f
LG		 98 ## Pack Boolean type VPD PCD's value form string to binary type.\r
99 # \r
100 # @param ValueString The boolean type string for pack.\r
101 # \r
102 # \r
111be80f 103 def _PackBooleanValue(self, ValueString):\r
08dd311f 104 if ValueString.upper() == "TRUE" or ValueString in ["1", "0x1", "0x01"]:\r
47fea6af
YZ		 105 try:\r
106 self.PcdValue = pack(_FORMAT_CHAR[1], 1)\r
111be80f 107 except:\r
47fea6af
YZ		 108 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
109 "Invalid size or value for PCD %s to pack(File: %s Line: %s)." % (self.PcdCName, self.FileName, self.Lineno))\r
111be80f 110 else:\r
111 try:\r
47fea6af 112 self.PcdValue = pack(_FORMAT_CHAR[1], 0)\r
111be80f 113 except:\r
47fea6af
YZ		 114 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
115 "Invalid size or value for PCD %s to pack(File: %s Line: %s)." % (self.PcdCName, self.FileName, self.Lineno))\r
116\r
08dd311f
LG		 117 ## Pack Integer type VPD PCD's value form string to binary type.\r
118 # \r
119 # @param ValueString The Integer type string for pack.\r
120 # \r
121 # \r
111be80f 122 def _PackIntValue(self, IntValue, Size):\r
123 if Size not in _FORMAT_CHAR.keys():\r
47fea6af
YZ		 124 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
125 "Invalid size %d for PCD %s in integer datum size(File: %s Line: %s)." % (Size, self.PcdCName, self.FileName, self.Lineno))\r
126\r
127 if Size == 1:\r
08dd311f 128 if IntValue < 0:\r
47fea6af 129 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
08dd311f
LG		 130 "PCD can't be set to negative value %d for PCD %s in UINT8 datum type(File: %s Line: %s)." % (IntValue, self.PcdCName, self.FileName, self.Lineno))\r
131 elif IntValue >= 0x100:\r
47fea6af
YZ		 132 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
133 "Too large PCD value %d for datum type UINT8 for PCD %s(File: %s Line: %s)." % (IntValue, self.PcdCName, self.FileName, self.Lineno))\r
08dd311f
LG		 134 elif Size == 2:\r
135 if IntValue < 0:\r
47fea6af 136 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
08dd311f
LG		 137 "PCD can't be set to negative value %d for PCD %s in UINT16 datum type(File: %s Line: %s)." % (IntValue, self.PcdCName, self.FileName, self.Lineno))\r
138 elif IntValue >= 0x10000:\r
47fea6af
YZ		 139 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
140 "Too large PCD value %d for datum type UINT16 for PCD %s(File: %s Line: %s)." % (IntValue, self.PcdCName, self.FileName, self.Lineno))\r
08dd311f
LG		 141 elif Size == 4:\r
142 if IntValue < 0:\r
47fea6af 143 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
08dd311f
LG		 144 "PCD can't be set to negative value %d for PCD %s in UINT32 datum type(File: %s Line: %s)." % (IntValue, self.PcdCName, self.FileName, self.Lineno))\r
145 elif IntValue >= 0x100000000:\r
47fea6af 146 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
08dd311f
LG		 147 "Too large PCD value %d for datum type UINT32 for PCD %s(File: %s Line: %s)." % (IntValue, self.PcdCName, self.FileName, self.Lineno))\r
148 elif Size == 8:\r
149 if IntValue < 0:\r
47fea6af 150 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
08dd311f
LG		 151 "PCD can't be set to negative value %d for PCD %s in UINT32 datum type(File: %s Line: %s)." % (IntValue, self.PcdCName, self.FileName, self.Lineno))\r
152 elif IntValue >= 0x10000000000000000:\r
47fea6af 153 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
08dd311f
LG		 154 "Too large PCD value %d for datum type UINT32 for PCD %s(File: %s Line: %s)." % (IntValue, self.PcdCName, self.FileName, self.Lineno))\r
155 else:\r
47fea6af
YZ		 156 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
157 "Invalid size %d for PCD %s in integer datum size(File: %s Line: %s)." % (Size, self.PcdCName, self.FileName, self.Lineno))\r
158\r
111be80f 159 try:\r
47fea6af 160 self.PcdValue = pack(_FORMAT_CHAR[Size], IntValue)\r
111be80f 161 except:\r
47fea6af
YZ		 162 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
163 "Invalid size or value for PCD %s to pack(File: %s Line: %s)." % (self.PcdCName, self.FileName, self.Lineno))\r
08dd311f
LG		 164\r
165 ## Pack VOID* type VPD PCD's value form string to binary type.\r
166 #\r
167 # The VOID* type of string divided into 3 sub-type:\r
168 # 1: L"String", Unicode type string.\r
169 # 2: "String", Ascii type string.\r
170 # 3: {bytearray}, only support byte-array.\r
171 #\r
172 # @param ValueString The Integer type string for pack.\r
173 # \r
111be80f 174 def _PackPtrValue(self, ValueString, Size):\r
175 if ValueString.startswith('L"'):\r
176 self._PackUnicode(ValueString, Size)\r
177 elif ValueString.startswith('{') and ValueString.endswith('}'):\r
178 self._PackByteArray(ValueString, Size)\r
179 elif ValueString.startswith('"') and ValueString.endswith('"'):\r
180 self._PackString(ValueString, Size)\r
181 else:\r
47fea6af
YZ		 182 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
183 "Invalid VOID* type PCD %s value %s (File: %s Line: %s)" % (self.PcdCName, ValueString, self.FileName, self.Lineno))\r
184\r
08dd311f
LG		 185 ## Pack an Ascii PCD value.\r
186 # \r
187 # An Ascii string for a PCD should be in format as "".\r
188 # \r
111be80f 189 def _PackString(self, ValueString, Size):\r
190 if (Size < 0):\r
47fea6af 191 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
111be80f 192 "Invalid parameter Size %s of PCD %s!(File: %s Line: %s)" % (self.PcdBinSize, self.PcdCName, self.FileName, self.Lineno))\r
193 if (ValueString == ""):\r
47fea6af 194 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID, "Invalid parameter ValueString %s of PCD %s!(File: %s Line: %s)" % (self.PcdUnpackValue, self.PcdCName, self.FileName, self.Lineno))\r
111be80f 195 if (len(ValueString) < 2):\r
196 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID, "For PCD: %s ,ASCII string %s at least contains two!(File: %s Line: %s)" % (self.PcdCName, self.PcdUnpackValue, self.FileName, self.Lineno))\r
47fea6af 197\r
111be80f 198 ValueString = ValueString[1:-1]\r
199 if len(ValueString) + 1 > Size:\r
47fea6af 200 EdkLogger.error("BPDG", BuildToolError.RESOURCE_OVERFLOW,\r
111be80f 201 "PCD value string %s is exceed to size %d(File: %s Line: %s)" % (ValueString, Size, self.FileName, self.Lineno))\r
202 try:\r
47fea6af 203 self.PcdValue = pack('%ds' % Size, ValueString)\r
111be80f 204 except:\r
47fea6af
YZ		 205 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
206 "Invalid size or value for PCD %s to pack(File: %s Line: %s)." % (self.PcdCName, self.FileName, self.Lineno))\r
207\r
08dd311f
LG		 208 ## Pack a byte-array PCD value.\r
209 # \r
210 # A byte-array for a PCD should be in format as {0x01, 0x02, ...}.\r
211 # \r
111be80f 212 def _PackByteArray(self, ValueString, Size):\r
47fea6af 213 if (Size < 0):\r
111be80f 214 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID, "Invalid parameter Size %s of PCD %s!(File: %s Line: %s)" % (self.PcdBinSize, self.PcdCName, self.FileName, self.Lineno))\r
215 if (ValueString == ""):\r
47fea6af
YZ		 216 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID, "Invalid parameter ValueString %s of PCD %s!(File: %s Line: %s)" % (self.PcdUnpackValue, self.PcdCName, self.FileName, self.Lineno))\r
217\r
111be80f 218 ValueString = ValueString.strip()\r
219 ValueString = ValueString.lstrip('{').strip('}')\r
220 ValueList = ValueString.split(',')\r
221 ValueList = [item.strip() for item in ValueList]\r
47fea6af 222\r
111be80f 223 if len(ValueList) > Size:\r
47fea6af 224 EdkLogger.error("BPDG", BuildToolError.RESOURCE_OVERFLOW,\r
111be80f 225 "The byte array %s is too large for size %d(File: %s Line: %s)" % (ValueString, Size, self.FileName, self.Lineno))\r
47fea6af 226\r
111be80f 227 ReturnArray = array.array('B')\r
47fea6af 228\r
111be80f 229 for Index in xrange(len(ValueList)):\r
230 Value = None\r
25918452 231 if ValueList[Index].lower().startswith('0x'):\r
111be80f 232 # translate hex value\r
233 try:\r
234 Value = int(ValueList[Index], 16)\r
235 except:\r
47fea6af 236 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
111be80f 237 "The value item %s in byte array %s is an invalid HEX value.(File: %s Line: %s)" % \\r
238 (ValueList[Index], ValueString, self.FileName, self.Lineno))\r
239 else:\r
240 # translate decimal value\r
241 try:\r
242 Value = int(ValueList[Index], 10)\r
243 except:\r
244 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
245 "The value item %s in byte array %s is an invalid DECIMAL value.(File: %s Line: %s)" % \\r
246 (ValueList[Index], ValueString, self.FileName, self.Lineno))\r
47fea6af 247\r
111be80f 248 if Value > 255:\r
47fea6af
YZ		 249 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
250 "The value item %s in byte array %s do not in range 0 ~ 0xFF(File: %s Line: %s)" % \\r
111be80f 251 (ValueList[Index], ValueString, self.FileName, self.Lineno))\r
47fea6af 252\r
111be80f 253 ReturnArray.append(Value)\r
47fea6af 254\r
111be80f 255 for Index in xrange(len(ValueList), Size):\r
256 ReturnArray.append(0)\r
47fea6af
YZ		 257\r
258 self.PcdValue = ReturnArray.tolist()\r
111be80f 259\r
260 ## Pack a unicode PCD value into byte array.\r
261 # \r
262 # A unicode string for a PCD should be in format as L"".\r
263 #\r
264 def _PackUnicode(self, UnicodeString, Size):\r
47fea6af
YZ		 265 if (Size < 0):\r
266 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID, "Invalid parameter Size %s of PCD %s!(File: %s Line: %s)" % \\r
111be80f 267 (self.PcdBinSize, self.PcdCName, self.FileName, self.Lineno))\r
268 if (len(UnicodeString) < 3):\r
47fea6af 269 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID, "For PCD: %s ,ASCII string %s at least contains two!(File: %s Line: %s)" % \\r
111be80f 270 (self.PcdCName, self.PcdUnpackValue, self.FileName, self.Lineno))\r
47fea6af 271\r
111be80f 272 UnicodeString = UnicodeString[2:-1]\r
47fea6af 273\r
111be80f 274 if (len(UnicodeString) + 1) * 2 > Size:\r
275 EdkLogger.error("BPDG", BuildToolError.RESOURCE_OVERFLOW,\r
276 "The size of unicode string %s is too larger for size %s(File: %s Line: %s)" % \\r
277 (UnicodeString, Size, self.FileName, self.Lineno))\r
47fea6af 278\r
111be80f 279 ReturnArray = array.array('B')\r
280 for Value in UnicodeString:\r
281 try:\r
282 ReturnArray.append(ord(Value))\r
283 ReturnArray.append(0)\r
284 except:\r
47fea6af 285 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID,\r
111be80f 286 "Invalid unicode character %s in unicode string %s(File: %s Line: %s)" % \\r
287 (Value, UnicodeString, self.FileName, self.Lineno))\r
47fea6af 288\r
e8a47801 289 for Index in xrange(len(UnicodeString) * 2, Size):\r
111be80f 290 ReturnArray.append(0)\r
47fea6af
YZ		 291\r
292 self.PcdValue = ReturnArray.tolist()\r
08dd311f
LG		 293\r
294\r
295\r
296## The class implementing the BPDG VPD PCD offset fix process\r
297#\r
298# The VPD PCD offset fix process includes:\r
299# 1. Parse the input guided.txt file and store it in the data structure;\r
300# 2. Format the input file data to remove unused lines;\r
301# 3. Fixed offset if needed;\r
302# 4. Generate output file, including guided.map and guided.bin file;\r
303# \r
47fea6af 304class GenVPD :\r
111be80f 305 ## Constructor of DscBuildData\r
306 #\r
307 # Initialize object of GenVPD\r
308 # @Param InputFileName The filename include the vpd type pcd information\r
309 # @param MapFileName The filename of map file that stores vpd type pcd information.\r
310 # This file will be generated by the BPDG tool after fix the offset\r
311 # and adjust the offset to make the pcd data aligned.\r
312 # @param VpdFileName The filename of Vpd file that hold vpd pcd information.\r
313 #\r
314 def __init__(self, InputFileName, MapFileName, VpdFileName):\r
315 self.InputFileName = InputFileName\r
316 self.MapFileName = MapFileName\r
317 self.VpdFileName = VpdFileName\r
318 self.FileLinesList = []\r
319 self.PcdFixedOffsetSizeList = []\r
320 self.PcdUnknownOffsetList = []\r
321 try:\r
322 fInputfile = open(InputFileName, "r", 0)\r
323 try:\r
324 self.FileLinesList = fInputfile.readlines()\r
325 except:\r
47fea6af 326 EdkLogger.error("BPDG", BuildToolError.FILE_READ_FAILURE, "File read failed for %s" % InputFileName, None)\r
111be80f 327 finally:\r
328 fInputfile.close()\r
329 except:\r
47fea6af
YZ		 330 EdkLogger.error("BPDG", BuildToolError.FILE_OPEN_FAILURE, "File open failed for %s" % InputFileName, None)\r
331\r
111be80f 332 ##\r
333 # Parser the input file which is generated by the build tool. Convert the value of each pcd's \r
334 # from string to it's real format. Also remove the useless line in the input file.\r
335 # \r
336 def ParserInputFile (self):\r
47fea6af 337 count = 0\r
111be80f 338 for line in self.FileLinesList:\r
339 # Strip "\r\n" generated by readlines ().\r
340 line = line.strip()\r
341 line = line.rstrip(os.linesep)\r
47fea6af 342\r
111be80f 343 # Skip the comment line\r
6780eef1
LG		 344 if (not line.startswith("#")) and len(line) > 1 :\r
345 #\r
346 # Enhanced for support "|" character in the string.\r
347 #\r
22061fab 348 ValueList = ['', '', '', '','']\r
47fea6af
YZ		 349\r
350 ValueRe = re.compile(r'\s*L?\".*\|.*\"\s*$')\r
6780eef1 351 PtrValue = ValueRe.findall(line)\r
47fea6af 352\r
6780eef1 353 ValueUpdateFlag = False\r
47fea6af 354\r
6780eef1
LG		 355 if len(PtrValue) >= 1:\r
356 line = re.sub(ValueRe, '', line)\r
47fea6af
YZ		 357 ValueUpdateFlag = True\r
358\r
6780eef1
LG		 359 TokenList = line.split('|')\r
360 ValueList[0:len(TokenList)] = TokenList\r
47fea6af 361\r
6780eef1 362 if ValueUpdateFlag:\r
22061fab 363 ValueList[4] = PtrValue[0]\r
6780eef1 364 self.FileLinesList[count] = ValueList\r
111be80f 365 # Store the line number\r
47fea6af 366 self.FileLinesList[count].append(str(count + 1))\r
111be80f 367 elif len(line) <= 1 :\r
368 # Set the blank line to "None"\r
369 self.FileLinesList[count] = None\r
370 else :\r
371 # Set the comment line to "None"\r
372 self.FileLinesList[count] = None\r
373 count += 1\r
47fea6af 374\r
111be80f 375 # The line count contain usage information\r
47fea6af 376 count = 0\r
111be80f 377 # Delete useless lines\r
378 while (True) :\r
379 try :\r
380 if (self.FileLinesList[count] == None) :\r
381 del(self.FileLinesList[count])\r
382 else :\r
383 count += 1\r
384 except :\r
47fea6af 385 break\r
111be80f 386 #\r
387 # After remove the useless line, if there are no data remain in the file line list,\r
388 # Report warning messages to user's.\r
389 # \r
390 if len(self.FileLinesList) == 0 :\r
47fea6af 391 EdkLogger.warn('BPDG', BuildToolError.RESOURCE_NOT_AVAILABLE,\r
111be80f 392 "There are no VPD type pcds defined in DSC file, Please check it.")\r
47fea6af 393\r
111be80f 394 # Process the pcds one by one base on the pcd's value and size\r
395 count = 0\r
47fea6af 396 for line in self.FileLinesList:\r
111be80f 397 if line != None :\r
e8a47801 398 PCD = PcdEntry(line[0], line[1], line[2], line[3], line[4],line[5], self.InputFileName) \r
111be80f 399 # Strip the space char\r
400 PCD.PcdCName = PCD.PcdCName.strip(' ')\r
e8a47801 401 PCD.SkuId = PCD.SkuId.strip(' ')\r
111be80f 402 PCD.PcdOffset = PCD.PcdOffset.strip(' ')\r
403 PCD.PcdSize = PCD.PcdSize.strip(' ')\r
22061fab 404 PCD.PcdValue = PCD.PcdValue.strip(' ')\r
111be80f 405 PCD.Lineno = PCD.Lineno.strip(' ')\r
22061fab 406\r
111be80f 407 #\r
408 # Store the original pcd value.\r
409 # This information will be useful while generate the output map file.\r
410 #\r
22061fab
YZ		 411 PCD.PcdUnpackValue = str(PCD.PcdValue)\r
412\r
53c13295
YZ		 413 #\r
414 # Translate PCD size string to an integer value.\r
415 PackSize = None\r
416 try:\r
417 PackSize = int(PCD.PcdSize, 10)\r
418 PCD.PcdBinSize = PackSize\r
419 except:\r
420 try:\r
421 PackSize = int(PCD.PcdSize, 16)\r
422 PCD.PcdBinSize = PackSize\r
423 except:\r
424 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID, "Invalid PCD size value %s at file: %s line: %s" % (PCD.PcdSize, self.InputFileName, PCD.Lineno))\r
425\r
22061fab
YZ		 426 #\r
427 # If value is Unicode string (e.g. L""), then use 2-byte alignment\r
428 # If value is byte array (e.g. {}), then use 8-byte alignment\r
429 #\r
53c13295 430 PCD.PcdOccupySize = PCD.PcdBinSize\r
22061fab
YZ		 431 if PCD.PcdUnpackValue.startswith("{"):\r
432 Alignment = 8\r
433 elif PCD.PcdUnpackValue.startswith("L"):\r
434 Alignment = 2\r
435 else:\r
436 Alignment = 1\r
815ada26 437\r
86737681 438 PCD.Alignment = Alignment\r
815ada26
YZ		 439 if PCD.PcdOffset != '*':\r
440 if PCD.PcdOccupySize % Alignment != 0:\r
441 if PCD.PcdUnpackValue.startswith("{"):\r
442 EdkLogger.warn("BPDG", "The offset value of PCD %s is not 8-byte aligned!" %(PCD.PcdCName), File=self.InputFileName)\r
443 else:\r
444 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID, 'The offset value of PCD %s should be %s-byte aligned.' % (PCD.PcdCName, Alignment))\r
445 else:\r
446 if PCD.PcdOccupySize % Alignment != 0:\r
447 PCD.PcdOccupySize = (PCD.PcdOccupySize / Alignment + 1) * Alignment\r
111be80f 448\r
86737681 449 PackSize = PCD.PcdOccupySize\r
08dd311f 450 if PCD._IsBoolean(PCD.PcdValue, PCD.PcdSize):\r
111be80f 451 PCD._PackBooleanValue(PCD.PcdValue)\r
452 self.FileLinesList[count] = PCD\r
453 count += 1\r
454 continue\r
455 #\r
456 # Try to translate value to an integer firstly.\r
457 #\r
458 IsInteger = True\r
47fea6af 459 PackValue = None\r
111be80f 460 try:\r
461 PackValue = int(PCD.PcdValue)\r
462 except:\r
463 try:\r
464 PackValue = int(PCD.PcdValue, 16)\r
465 except:\r
466 IsInteger = False\r
47fea6af 467\r
111be80f 468 if IsInteger:\r
469 PCD._PackIntValue(PackValue, PackSize)\r
470 else:\r
471 PCD._PackPtrValue(PCD.PcdValue, PackSize)\r
47fea6af 472\r
111be80f 473 self.FileLinesList[count] = PCD\r
474 count += 1\r
475 else :\r
476 continue\r
47fea6af 477\r
111be80f 478 ##\r
479 # This function used to create a clean list only contain useful information and reorganized to make it \r
480 # easy to be sorted\r
481 #\r
482 def FormatFileLine (self) :\r
47fea6af 483\r
111be80f 484 for eachPcd in self.FileLinesList :\r
485 if eachPcd.PcdOffset != '*' :\r
486 # Use pcd's Offset value as key, and pcd's Value as value \r
487 self.PcdFixedOffsetSizeList.append(eachPcd)\r
488 else :\r
489 # Use pcd's CName as key, and pcd's Size as value\r
490 self.PcdUnknownOffsetList.append(eachPcd)\r
47fea6af
YZ		 491\r
492\r
111be80f 493 ##\r
494 # This function is use to fix the offset value which the not specified in the map file.\r
495 # Usually it use the star (meaning any offset) character in the offset field\r
496 # \r
47fea6af 497 def FixVpdOffset (self):\r
111be80f 498 # At first, the offset should start at 0\r
499 # Sort fixed offset list in order to find out where has free spaces for the pcd's offset\r
500 # value is "*" to insert into. \r
47fea6af
YZ		 501\r
502 self.PcdFixedOffsetSizeList.sort(lambda x, y: cmp(x.PcdBinOffset, y.PcdBinOffset))\r
503\r
111be80f 504 #\r
505 # Sort the un-fixed pcd's offset by it's size.\r
506 #\r
47fea6af
YZ		 507 self.PcdUnknownOffsetList.sort(lambda x, y: cmp(x.PcdBinSize, y.PcdBinSize))\r
508\r
0b6c5954
LG		 509 index =0\r
510 for pcd in self.PcdUnknownOffsetList:\r
511 index += 1\r
512 if pcd.PcdCName == ".".join(("gEfiMdeModulePkgTokenSpaceGuid","PcdNvStoreDefaultValueBuffer")):\r
513 if index != len(self.PcdUnknownOffsetList):\r
514 for i in range(len(self.PcdUnknownOffsetList) - index):\r
515 self.PcdUnknownOffsetList[index+i -1 ] , self.PcdUnknownOffsetList[index+i] = self.PcdUnknownOffsetList[index+i] , self.PcdUnknownOffsetList[index+i -1]\r
516\r
111be80f 517 #\r
518 # Process all Offset value are "*"\r
519 #\r
520 if (len(self.PcdFixedOffsetSizeList) == 0) and (len(self.PcdUnknownOffsetList) != 0) :\r
521 # The offset start from 0\r
522 NowOffset = 0\r
47fea6af 523 for Pcd in self.PcdUnknownOffsetList :\r
86737681
YZ		 524 if NowOffset % Pcd.Alignment != 0:\r
525 NowOffset = (NowOffset/ Pcd.Alignment + 1) * Pcd.Alignment\r
111be80f 526 Pcd.PcdBinOffset = NowOffset\r
527 Pcd.PcdOffset = str(hex(Pcd.PcdBinOffset))\r
22061fab 528 NowOffset += Pcd.PcdOccupySize\r
111be80f 529 \r
530 self.PcdFixedOffsetSizeList = self.PcdUnknownOffsetList\r
531 return\r
47fea6af 532\r
111be80f 533 # Check the offset of VPD type pcd's offset start from 0. \r
47fea6af 534 if self.PcdFixedOffsetSizeList[0].PcdBinOffset != 0 :\r
111be80f 535 EdkLogger.warn("BPDG", "The offset of VPD type pcd should start with 0, please check it.",\r
47fea6af
YZ		 536 None)\r
537\r
111be80f 538 # Judge whether the offset in fixed pcd offset list is overlapped or not.\r
539 lenOfList = len(self.PcdFixedOffsetSizeList)\r
540 count = 0 \r
541 while (count < lenOfList - 1) :\r
542 PcdNow = self.PcdFixedOffsetSizeList[count]\r
543 PcdNext = self.PcdFixedOffsetSizeList[count+1]\r
544 # Two pcd's offset is same \r
545 if PcdNow.PcdBinOffset == PcdNext.PcdBinOffset :\r
47fea6af
YZ		 546 EdkLogger.error("BPDG", BuildToolError.ATTRIBUTE_GET_FAILURE,\r
547 "The offset of %s at line: %s is same with %s at line: %s in file %s" % \\r
111be80f 548 (PcdNow.PcdCName, PcdNow.Lineno, PcdNext.PcdCName, PcdNext.Lineno, PcdNext.FileName),\r
549 None)\r
47fea6af 550\r
111be80f 551 # Overlapped \r
22061fab 552 if PcdNow.PcdBinOffset + PcdNow.PcdOccupySize > PcdNext.PcdBinOffset :\r
47fea6af
YZ		 553 EdkLogger.error("BPDG", BuildToolError.ATTRIBUTE_GET_FAILURE,\r
554 "The offset of %s at line: %s is overlapped with %s at line: %s in file %s" % \\r
111be80f 555 (PcdNow.PcdCName, PcdNow.Lineno, PcdNext.PcdCName, PcdNext.Lineno, PcdNext.FileName),\r
556 None)\r
47fea6af 557\r
111be80f 558 # Has free space, raise a warning message \r
22061fab 559 if PcdNow.PcdBinOffset + PcdNow.PcdOccupySize < PcdNext.PcdBinOffset :\r
47fea6af
YZ		 560 EdkLogger.warn("BPDG", BuildToolError.ATTRIBUTE_GET_FAILURE,\r
561 "The offsets have free space of between %s at line: %s and %s at line: %s in file %s" % \\r
111be80f 562 (PcdNow.PcdCName, PcdNow.Lineno, PcdNext.PcdCName, PcdNext.Lineno, PcdNext.FileName),\r
563 None)\r
564 count += 1\r
565 \r
566 LastOffset = self.PcdFixedOffsetSizeList[0].PcdBinOffset\r
567 FixOffsetSizeListCount = 0\r
568 lenOfList = len(self.PcdFixedOffsetSizeList)\r
569 lenOfUnfixedList = len(self.PcdUnknownOffsetList)\r
570 \r
571 ##\r
572 # Insert the un-fixed offset pcd's list into fixed offset pcd's list if has free space between those pcds. \r
573 # \r
574 while (FixOffsetSizeListCount < lenOfList) :\r
575 \r
576 eachFixedPcd = self.PcdFixedOffsetSizeList[FixOffsetSizeListCount] \r
577 NowOffset = eachFixedPcd.PcdBinOffset\r
578 \r
579 # Has free space \r
580 if LastOffset < NowOffset :\r
581 if lenOfUnfixedList != 0 :\r
582 countOfUnfixedList = 0\r
47fea6af 583 while(countOfUnfixedList < lenOfUnfixedList) :\r
111be80f 584 eachUnfixedPcd = self.PcdUnknownOffsetList[countOfUnfixedList]\r
22061fab 585 needFixPcdSize = eachUnfixedPcd.PcdOccupySize\r
111be80f 586 # Not been fixed\r
587 if eachUnfixedPcd.PcdOffset == '*' :\r
86737681
YZ		 588 if LastOffset % eachUnfixedPcd.Alignment != 0:\r
589 LastOffset = (LastOffset / eachUnfixedPcd.Alignment + 1) * eachUnfixedPcd.Alignment\r
111be80f 590 # The offset un-fixed pcd can write into this free space\r
591 if needFixPcdSize <= (NowOffset - LastOffset) :\r
592 # Change the offset value of un-fixed pcd\r
593 eachUnfixedPcd.PcdOffset = str(hex(LastOffset))\r
594 eachUnfixedPcd.PcdBinOffset = LastOffset\r
595 # Insert this pcd into fixed offset pcd list.\r
596 self.PcdFixedOffsetSizeList.insert(FixOffsetSizeListCount,eachUnfixedPcd)\r
597 \r
598 # Delete the item's offset that has been fixed and added into fixed offset list\r
599 self.PcdUnknownOffsetList.pop(countOfUnfixedList)\r
600 \r
601 # After item added, should enlarge the length of fixed pcd offset list\r
602 lenOfList += 1 \r
603 FixOffsetSizeListCount += 1\r
604 \r
605 # Decrease the un-fixed pcd offset list's length\r
111be80f 606 lenOfUnfixedList -= 1\r
607 \r
608 # Modify the last offset value \r
6780eef1 609 LastOffset += needFixPcdSize \r
111be80f 610 else :\r
6780eef1 611 # It can not insert into those two pcds, need to check still has other space can store it.\r
22061fab 612 LastOffset = NowOffset + self.PcdFixedOffsetSizeList[FixOffsetSizeListCount].PcdOccupySize\r
111be80f 613 FixOffsetSizeListCount += 1\r
6780eef1
LG		 614 break\r
615 \r
111be80f 616 # Set the FixOffsetSizeListCount = lenOfList for quit the loop\r
617 else :\r
618 FixOffsetSizeListCount = lenOfList \r
619 \r
620 # No free space, smoothly connect with previous pcd. \r
621 elif LastOffset == NowOffset :\r
22061fab 622 LastOffset = NowOffset + eachFixedPcd.PcdOccupySize\r
111be80f 623 FixOffsetSizeListCount += 1\r
624 # Usually it will not enter into this thunk, if so, means it overlapped. \r
625 else :\r
47fea6af
YZ		 626 EdkLogger.error("BPDG", BuildToolError.ATTRIBUTE_NOT_AVAILABLE,\r
627 "The offset value definition has overlapped at pcd: %s, it's offset is: %s, in file: %s line: %s" % \\r
111be80f 628 (eachFixedPcd.PcdCName, eachFixedPcd.PcdOffset, eachFixedPcd.InputFileName, eachFixedPcd.Lineno),\r
629 None)\r
630 FixOffsetSizeListCount += 1\r
631 \r
632 # Continue to process the un-fixed offset pcd's list, add this time, just append them behind the fixed pcd's offset list. \r
633 lenOfUnfixedList = len(self.PcdUnknownOffsetList)\r
634 lenOfList = len(self.PcdFixedOffsetSizeList)\r
635 while (lenOfUnfixedList > 0) :\r
636 # Still has items need to process\r
637 # The last pcd instance\r
638 LastPcd = self.PcdFixedOffsetSizeList[lenOfList-1]\r
639 NeedFixPcd = self.PcdUnknownOffsetList[0]\r
640 \r
22061fab 641 NeedFixPcd.PcdBinOffset = LastPcd.PcdBinOffset + LastPcd.PcdOccupySize\r
86737681
YZ		 642 if NeedFixPcd.PcdBinOffset % NeedFixPcd.Alignment != 0:\r
643 NeedFixPcd.PcdBinOffset = (NeedFixPcd.PcdBinOffset / NeedFixPcd.Alignment + 1) * NeedFixPcd.Alignment\r
644\r
111be80f 645 NeedFixPcd.PcdOffset = str(hex(NeedFixPcd.PcdBinOffset))\r
646 \r
647 # Insert this pcd into fixed offset pcd list's tail.\r
648 self.PcdFixedOffsetSizeList.insert(lenOfList, NeedFixPcd)\r
649 # Delete the item's offset that has been fixed and added into fixed offset list\r
650 self.PcdUnknownOffsetList.pop(0)\r
651 \r
652 lenOfList += 1\r
653 lenOfUnfixedList -= 1 \r
654 ##\r
655 # Write the final data into output files.\r
656 # \r
657 def GenerateVpdFile (self, MapFileName, BinFileName):\r
658 #Open an VPD file to process\r
659\r
660 try:\r
47fea6af 661 fVpdFile = open(BinFileName, "wb", 0)\r
111be80f 662 except:\r
663 # Open failed\r
47fea6af
YZ		 664 EdkLogger.error("BPDG", BuildToolError.FILE_OPEN_FAILURE, "File open failed for %s" % self.VpdFileName, None)\r
665\r
111be80f 666 try :\r
47fea6af 667 fMapFile = open(MapFileName, "w", 0)\r
111be80f 668 except:\r
669 # Open failed\r
47fea6af
YZ		 670 EdkLogger.error("BPDG", BuildToolError.FILE_OPEN_FAILURE, "File open failed for %s" % self.MapFileName, None)\r
671\r
111be80f 672 # Use a instance of StringIO to cache data\r
47fea6af
YZ		 673 fStringIO = StringIO.StringIO('')\r
674\r
111be80f 675 # Write the header of map file.\r
676 try :\r
677 fMapFile.write (st.MAP_FILE_COMMENT_TEMPLATE + "\n")\r
678 except:\r
47fea6af
YZ		 679 EdkLogger.error("BPDG", BuildToolError.FILE_WRITE_FAILURE, "Write data to file %s failed, please check whether the file been locked or using by other applications." % self.MapFileName, None)\r
680\r
111be80f 681 for eachPcd in self.PcdFixedOffsetSizeList :\r
682 # write map file\r
683 try :\r
e8a47801 684 fMapFile.write("%s | %s | %s | %s | %s \n" % (eachPcd.PcdCName, eachPcd.SkuId,eachPcd.PcdOffset, eachPcd.PcdSize,eachPcd.PcdUnpackValue))\r
111be80f 685 except:\r
47fea6af
YZ		 686 EdkLogger.error("BPDG", BuildToolError.FILE_WRITE_FAILURE, "Write data to file %s failed, please check whether the file been locked or using by other applications." % self.MapFileName, None)\r
687\r
111be80f 688 # Write Vpd binary file\r
47fea6af 689 fStringIO.seek (eachPcd.PcdBinOffset)\r
111be80f 690 if isinstance(eachPcd.PcdValue, list):\r
691 ValueList = [chr(Item) for Item in eachPcd.PcdValue]\r
47fea6af
YZ		 692 fStringIO.write(''.join(ValueList))\r
693 else:\r
111be80f 694 fStringIO.write (eachPcd.PcdValue)\r
47fea6af
YZ		 695\r
696 try :\r
111be80f 697 fVpdFile.write (fStringIO.getvalue())\r
698 except:\r
47fea6af
YZ		 699 EdkLogger.error("BPDG", BuildToolError.FILE_WRITE_FAILURE, "Write data to file %s failed, please check whether the file been locked or using by other applications." % self.VpdFileName, None)\r
700\r
111be80f 701 fStringIO.close ()\r
702 fVpdFile.close ()\r
703 fMapFile.close ()\r
704 \r
EFI Development Kit II mirror for PVE