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