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