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