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