]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - BaseTools/Source/Python/Common/VpdInfoFile.py
CorebootPayloadPkg: Conditionally add DebugAgentLib for DXE drivers
[mirror_edk2.git] / BaseTools / Source / Python / Common / VpdInfoFile.py
... / ...
CommitLineData
1## @file\r
2# \r
3# This package manage the VPD PCD information file which will be generated\r
4# by build tool's autogen.\r
5# The VPD PCD information file will be input for third-party BPDG tool which\r
6# is pointed by *_*_*_VPD_TOOL_GUID in conf/tools_def.txt \r
7#\r
8#\r
9# Copyright (c) 2010 - 2016, Intel Corporation. All rights reserved.<BR>\r
10# This program and the accompanying materials\r
11# are licensed and made available under the terms and conditions of the BSD License\r
12# which accompanies this distribution. The full text of the license may be found at\r
13# http://opensource.org/licenses/bsd-license.php\r
14#\r
15# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
16# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
17#\r
18import Common.LongFilePathOs as os\r
19import re\r
20import Common.EdkLogger as EdkLogger\r
21import Common.BuildToolError as BuildToolError\r
22import subprocess\r
23import Common.GlobalData as GlobalData\r
24from Common.LongFilePathSupport import OpenLongFilePath as open\r
25from Common.Misc import SaveFileOnChange\r
26\r
27FILE_COMMENT_TEMPLATE = \\r
28"""\r
29## @file\r
30#\r
31# THIS IS AUTO-GENERATED FILE BY BUILD TOOLS AND PLEASE DO NOT MAKE MODIFICATION.\r
32#\r
33# This file lists all VPD informations for a platform collected by build.exe.\r
34# \r
35# Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>\r
36# This program and the accompanying materials\r
37# are licensed and made available under the terms and conditions of the BSD License\r
38# which accompanies this distribution. The full text of the license may be found at\r
39# http://opensource.org/licenses/bsd-license.php\r
40#\r
41# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
42# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
43#\r
44\r
45"""\r
46\r
47## The class manage VpdInfoFile.\r
48#\r
49# This file contains an ordered (based on position in the DSC file) list of the PCDs specified in the platform description file (DSC). The Value field that will be assigned to the PCD comes from the DSC file, INF file (if not defined in the DSC file) or the DEC file (if not defined in the INF file). This file is used as an input to the BPDG tool.\r
50# Format for this file (using EBNF notation) is:\r
51# <File> :: = [<CommentBlock>]\r
52# [<PcdEntry>]*\r
53# <CommentBlock> ::= ["#" <String> <EOL>]*\r
54# <PcdEntry> ::= <PcdName> "|" <Offset> "|" <Size> "|" <Value> <EOL>\r
55# <PcdName> ::= <TokenSpaceCName> "." <PcdCName>\r
56# <TokenSpaceCName> ::= C Variable Name of the Token Space GUID\r
57# <PcdCName> ::= C Variable Name of the PCD\r
58# <Offset> ::= {"*"} {<HexNumber>}\r
59# <HexNumber> ::= "0x" (a-fA-F0-9){1,8}\r
60# <Size> ::= <HexNumber>\r
61# <Value> ::= {<HexNumber>} {<NonNegativeInt>} {<QString>} {<Array>}\r
62# <NonNegativeInt> ::= (0-9)+\r
63# <QString> ::= ["L"] <DblQuote> <String> <DblQuote>\r
64# <DblQuote> ::= 0x22\r
65# <Array> ::= {<CArray>} {<NList>}\r
66# <CArray> ::= "{" <HexNumber> ["," <HexNumber>]* "}"\r
67# <NList> ::= <HexNumber> ["," <HexNumber>]*\r
68#\r
69class VpdInfoFile:\r
70 \r
71 ## The mapping dictionary from datum type to size string.\r
72 _MAX_SIZE_TYPE = {"BOOLEAN":"1", "UINT8":"1", "UINT16":"2", "UINT32":"4", "UINT64":"8"}\r
73 _rVpdPcdLine = None \r
74 ## Constructor\r
75 def __init__(self):\r
76 ## Dictionary for VPD in following format\r
77 #\r
78 # Key : PcdClassObject instance. \r
79 # @see BuildClassObject.PcdClassObject\r
80 # Value : offset in different SKU such as [sku1_offset, sku2_offset]\r
81 self._VpdArray = {}\r
82 self._VpdInfo = {}\r
83 \r
84 ## Add a VPD PCD collected from platform's autogen when building.\r
85 #\r
86 # @param vpds The list of VPD PCD collected for a platform.\r
87 # @see BuildClassObject.PcdClassObject\r
88 #\r
89 # @param offset integer value for VPD's offset in specific SKU.\r
90 #\r
91 def Add(self, Vpd, skuname,Offset):\r
92 if (Vpd == None):\r
93 EdkLogger.error("VpdInfoFile", BuildToolError.ATTRIBUTE_UNKNOWN_ERROR, "Invalid VPD PCD entry.")\r
94 \r
95 if not (Offset >= 0 or Offset == "*"):\r
96 EdkLogger.error("VpdInfoFile", BuildToolError.PARAMETER_INVALID, "Invalid offset parameter: %s." % Offset)\r
97 \r
98 if Vpd.DatumType == "VOID*":\r
99 if Vpd.MaxDatumSize <= 0:\r
100 EdkLogger.error("VpdInfoFile", BuildToolError.PARAMETER_INVALID, \r
101 "Invalid max datum size for VPD PCD %s.%s" % (Vpd.TokenSpaceGuidCName, Vpd.TokenCName))\r
102 elif Vpd.DatumType in ["BOOLEAN", "UINT8", "UINT16", "UINT32", "UINT64"]: \r
103 if Vpd.MaxDatumSize == None or Vpd.MaxDatumSize == "":\r
104 Vpd.MaxDatumSize = VpdInfoFile._MAX_SIZE_TYPE[Vpd.DatumType]\r
105 else:\r
106 if Vpd.MaxDatumSize <= 0:\r
107 EdkLogger.error("VpdInfoFile", BuildToolError.PARAMETER_INVALID,\r
108 "Invalid max datum size for VPD PCD %s.%s" % (Vpd.TokenSpaceGuidCName, Vpd.TokenCName))\r
109 \r
110 if Vpd not in self._VpdArray.keys():\r
111 #\r
112 # If there is no Vpd instance in dict, that imply this offset for a given SKU is a new one \r
113 #\r
114 self._VpdArray[Vpd] = {}\r
115\r
116 self._VpdArray[Vpd].update({skuname:Offset})\r
117 \r
118 \r
119 ## Generate VPD PCD information into a text file\r
120 # \r
121 # If parameter FilePath is invalid, then assert.\r
122 # If \r
123 # @param FilePath The given file path which would hold VPD information\r
124 def Write(self, FilePath):\r
125 if not (FilePath != None or len(FilePath) != 0):\r
126 EdkLogger.error("VpdInfoFile", BuildToolError.PARAMETER_INVALID, \r
127 "Invalid parameter FilePath: %s." % FilePath) \r
128\r
129 Content = FILE_COMMENT_TEMPLATE\r
130 Pcds = self._VpdArray.keys()\r
131 Pcds.sort()\r
132 for Pcd in Pcds:\r
133 i = 0\r
134 PcdTokenCName = Pcd.TokenCName\r
135 for PcdItem in GlobalData.MixedPcd:\r
136 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
137 PcdTokenCName = PcdItem[0]\r
138 for skuname in self._VpdArray[Pcd]:\r
139 PcdValue = str(Pcd.SkuInfoList[skuname].DefaultValue).strip()\r
140 if PcdValue == "" :\r
141 PcdValue = Pcd.DefaultValue\r
142\r
143 Content += "%s.%s|%s|%s|%s|%s \n" % (Pcd.TokenSpaceGuidCName, PcdTokenCName, skuname,str(self._VpdArray[Pcd][skuname]).strip(), str(Pcd.MaxDatumSize).strip(),PcdValue)\r
144 i += 1\r
145\r
146 return SaveFileOnChange(FilePath, Content, False)\r
147\r
148 ## Read an existing VPD PCD info file.\r
149 #\r
150 # This routine will read VPD PCD information from existing file and construct\r
151 # internal PcdClassObject array.\r
152 # This routine could be used by third-party tool to parse VPD info file content.\r
153 #\r
154 # @param FilePath The full path string for existing VPD PCD info file.\r
155 def Read(self, FilePath):\r
156 try:\r
157 fd = open(FilePath, "r")\r
158 except:\r
159 EdkLogger.error("VpdInfoFile", \r
160 BuildToolError.FILE_OPEN_FAILURE, \r
161 "Fail to open file %s for written." % FilePath)\r
162 Lines = fd.readlines()\r
163 for Line in Lines:\r
164 Line = Line.strip()\r
165 if len(Line) == 0 or Line.startswith("#"):\r
166 continue\r
167 \r
168 #\r
169 # the line must follow output format defined in BPDG spec.\r
170 #\r
171 try:\r
172 PcdName, SkuId,Offset, Size, Value = Line.split("#")[0].split("|")\r
173 PcdName, SkuId,Offset, Size, Value = PcdName.strip(), SkuId.strip(),Offset.strip(), Size.strip(), Value.strip()\r
174 TokenSpaceName, PcdTokenName = PcdName.split(".")\r
175 except:\r
176 EdkLogger.error("BPDG", BuildToolError.PARSER_ERROR, "Fail to parse VPD information file %s" % FilePath)\r
177 \r
178 Found = False\r
179 \r
180 if (TokenSpaceName, PcdTokenName) not in self._VpdInfo:\r
181 self._VpdInfo[(TokenSpaceName, PcdTokenName)] = []\r
182 self._VpdInfo[(TokenSpaceName, PcdTokenName)].append((SkuId,Offset, Value))\r
183 for VpdObject in self._VpdArray.keys():\r
184 VpdObjectTokenCName = VpdObject.TokenCName\r
185 for PcdItem in GlobalData.MixedPcd:\r
186 if (VpdObject.TokenCName, VpdObject.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
187 VpdObjectTokenCName = PcdItem[0]\r
188 for sku in VpdObject.SkuInfoList.keys():\r
189 if VpdObject.TokenSpaceGuidCName == TokenSpaceName and VpdObjectTokenCName == PcdTokenName.strip() and sku == SkuId:\r
190 if self._VpdArray[VpdObject][sku] == "*":\r
191 if Offset == "*":\r
192 EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID, "The offset of %s has not been fixed up by third-party BPDG tool." % PcdName) \r
193 self._VpdArray[VpdObject][sku] = Offset\r
194 Found = True\r
195 if not Found:\r
196 EdkLogger.error("BPDG", BuildToolError.PARSER_ERROR, "Can not find PCD defined in VPD guid file.")\r
197 \r
198 ## Get count of VPD PCD collected from platform's autogen when building.\r
199 #\r
200 # @return The integer count value \r
201 def GetCount(self):\r
202 Count = 0\r
203 for OffsetList in self._VpdArray.values():\r
204 Count += len(OffsetList)\r
205 \r
206 return Count\r
207 \r
208 ## Get an offset value for a given VPD PCD\r
209 #\r
210 # Because BPDG only support one Sku, so only return offset for SKU default. \r
211 #\r
212 # @param vpd A given VPD PCD \r
213 def GetOffset(self, vpd):\r
214 if not self._VpdArray.has_key(vpd):\r
215 return None\r
216 \r
217 if len(self._VpdArray[vpd]) == 0:\r
218 return None\r
219 \r
220 return self._VpdArray[vpd]\r
221 def GetVpdInfo(self,(PcdTokenName,TokenSpaceName)):\r
222 return self._VpdInfo.get((TokenSpaceName, PcdTokenName))\r
223 \r
224## Call external BPDG tool to process VPD file\r
225# \r
226# @param ToolPath The string path name for BPDG tool\r
227# @param VpdFileName The string path name for VPD information guid.txt\r
228# \r
229def CallExtenalBPDGTool(ToolPath, VpdFileName):\r
230 assert ToolPath != None, "Invalid parameter ToolPath"\r
231 assert VpdFileName != None and os.path.exists(VpdFileName), "Invalid parameter VpdFileName"\r
232 \r
233 OutputDir = os.path.dirname(VpdFileName)\r
234 FileName = os.path.basename(VpdFileName)\r
235 BaseName, ext = os.path.splitext(FileName)\r
236 OutputMapFileName = os.path.join(OutputDir, "%s.map" % BaseName)\r
237 OutputBinFileName = os.path.join(OutputDir, "%s.bin" % BaseName)\r
238 \r
239 try:\r
240 PopenObject = subprocess.Popen(' '.join([ToolPath,\r
241 '-o', OutputBinFileName, \r
242 '-m', OutputMapFileName,\r
243 '-q',\r
244 '-f',\r
245 VpdFileName]),\r
246 stdout=subprocess.PIPE, \r
247 stderr= subprocess.PIPE,\r
248 shell=True)\r
249 except Exception, X:\r
250 EdkLogger.error("BPDG", BuildToolError.COMMAND_FAILURE, ExtraData="%s" % (str(X)))\r
251 (out, error) = PopenObject.communicate()\r
252 print out\r
253 while PopenObject.returncode == None :\r
254 PopenObject.wait()\r
255 \r
256 if PopenObject.returncode != 0:\r
257 if PopenObject.returncode != 0:\r
258 EdkLogger.debug(EdkLogger.DEBUG_1, "Fail to call BPDG tool", str(error))\r
259 EdkLogger.error("BPDG", BuildToolError.COMMAND_FAILURE, "Fail to execute BPDG tool with exit code: %d, the error message is: \n %s" % \\r
260 (PopenObject.returncode, str(error)))\r
261 \r
262 return PopenObject.returncode\r