3 # This package manage the VPD PCD information file which will be generated
4 # by build tool's autogen.
5 # The VPD PCD information file will be input for third-party BPDG tool which
6 # is pointed by *_*_*_VPD_TOOL_GUID in conf/tools_def.txt
9 # Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>
10 # This program and the accompanying materials
11 # are licensed and made available under the terms and conditions of the BSD License
12 # which accompanies this distribution. The full text of the license may be found at
13 # http://opensource.org/licenses/bsd-license.php
15 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
16 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 import Common
.LongFilePathOs
as os
20 import Common
.EdkLogger
as EdkLogger
21 import Common
.BuildToolError
as BuildToolError
23 from Common
.LongFilePathSupport
import OpenLongFilePath
as open
25 FILE_COMMENT_TEMPLATE
= \
29 # THIS IS AUTO-GENERATED FILE BY BUILD TOOLS AND PLEASE DO NOT MAKE MODIFICATION.
31 # This file lists all VPD informations for a platform collected by build.exe.
33 # Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
34 # This program and the accompanying materials
35 # are licensed and made available under the terms and conditions of the BSD License
36 # which accompanies this distribution. The full text of the license may be found at
37 # http://opensource.org/licenses/bsd-license.php
39 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
40 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
45 ## The class manage VpdInfoFile.
47 # 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.
48 # Format for this file (using EBNF notation) is:
49 # <File> :: = [<CommentBlock>]
51 # <CommentBlock> ::= ["#" <String> <EOL>]*
52 # <PcdEntry> ::= <PcdName> "|" <Offset> "|" <Size> "|" <Value> <EOL>
53 # <PcdName> ::= <TokenSpaceCName> "." <PcdCName>
54 # <TokenSpaceCName> ::= C Variable Name of the Token Space GUID
55 # <PcdCName> ::= C Variable Name of the PCD
56 # <Offset> ::= {"*"} {<HexNumber>}
57 # <HexNumber> ::= "0x" (a-fA-F0-9){1,8}
58 # <Size> ::= <HexNumber>
59 # <Value> ::= {<HexNumber>} {<NonNegativeInt>} {<QString>} {<Array>}
60 # <NonNegativeInt> ::= (0-9)+
61 # <QString> ::= ["L"] <DblQuote> <String> <DblQuote>
63 # <Array> ::= {<CArray>} {<NList>}
64 # <CArray> ::= "{" <HexNumber> ["," <HexNumber>]* "}"
65 # <NList> ::= <HexNumber> ["," <HexNumber>]*
69 ## The mapping dictionary from datum type to size string.
70 _MAX_SIZE_TYPE
= {"BOOLEAN":"1", "UINT8":"1", "UINT16":"2", "UINT32":"4", "UINT64":"8"}
74 ## Dictionary for VPD in following format
76 # Key : PcdClassObject instance.
77 # @see BuildClassObject.PcdClassObject
78 # Value : offset in different SKU such as [sku1_offset, sku2_offset]
81 ## Add a VPD PCD collected from platform's autogen when building.
83 # @param vpds The list of VPD PCD collected for a platform.
84 # @see BuildClassObject.PcdClassObject
86 # @param offset integer value for VPD's offset in specific SKU.
88 def Add(self
, Vpd
, Offset
):
90 EdkLogger
.error("VpdInfoFile", BuildToolError
.ATTRIBUTE_UNKNOWN_ERROR
, "Invalid VPD PCD entry.")
92 if not (Offset
>= 0 or Offset
== "*"):
93 EdkLogger
.error("VpdInfoFile", BuildToolError
.PARAMETER_INVALID
, "Invalid offset parameter: %s." % Offset
)
95 if Vpd
.DatumType
== "VOID*":
96 if Vpd
.MaxDatumSize
<= 0:
97 EdkLogger
.error("VpdInfoFile", BuildToolError
.PARAMETER_INVALID
,
98 "Invalid max datum size for VPD PCD %s.%s" % (Vpd
.TokenSpaceGuidCName
, Vpd
.TokenCName
))
99 elif Vpd
.DatumType
in ["BOOLEAN", "UINT8", "UINT16", "UINT32", "UINT64"]:
100 if Vpd
.MaxDatumSize
== None or Vpd
.MaxDatumSize
== "":
101 Vpd
.MaxDatumSize
= VpdInfoFile
._MAX
_SIZE
_TYPE
[Vpd
.DatumType
]
103 EdkLogger
.error("VpdInfoFile", BuildToolError
.PARAMETER_INVALID
,
104 "Invalid DatumType %s for VPD PCD %s.%s" % (Vpd
.DatumType
, Vpd
.TokenSpaceGuidCName
, Vpd
.TokenCName
))
106 if Vpd
not in self
._VpdArray
.keys():
108 # If there is no Vpd instance in dict, that imply this offset for a given SKU is a new one
110 self
._VpdArray
[Vpd
] = [Offset
]
113 # If there is an offset for a specific SKU in dict, then append this offset for other sku to array.
115 self
._VpdArray
[Vpd
].append(Offset
)
118 ## Generate VPD PCD information into a text file
120 # If parameter FilePath is invalid, then assert.
122 # @param FilePath The given file path which would hold VPD information
123 def Write(self
, FilePath
):
124 if not (FilePath
!= None or len(FilePath
) != 0):
125 EdkLogger
.error("VpdInfoFile", BuildToolError
.PARAMETER_INVALID
,
126 "Invalid parameter FilePath: %s." % FilePath
)
128 fd
= open(FilePath
, "w")
130 EdkLogger
.error("VpdInfoFile",
131 BuildToolError
.FILE_OPEN_FAILURE
,
132 "Fail to open file %s for written." % FilePath
)
136 fd
.write(FILE_COMMENT_TEMPLATE
)
138 # write each of PCD in VPD type
139 Pcds
= self
._VpdArray
.keys()
143 for Offset
in self
._VpdArray
[Pcd
]:
144 PcdValue
= str(Pcd
.SkuInfoList
[Pcd
.SkuInfoList
.keys()[i
]].DefaultValue
).strip()
146 PcdValue
= Pcd
.DefaultValue
148 fd
.write("%s.%s|%s|%s|%s|%s \n" % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
, str(Pcd
.SkuInfoList
.keys()[i
]),str(Offset
).strip(), str(Pcd
.MaxDatumSize
).strip(),PcdValue
))
151 EdkLogger
.error("VpdInfoFile",
152 BuildToolError
.FILE_WRITE_FAILURE
,
153 "Fail to write file %s" % FilePath
)
156 ## Read an existing VPD PCD info file.
158 # This routine will read VPD PCD information from existing file and construct
159 # internal PcdClassObject array.
160 # This routine could be used by third-party tool to parse VPD info file content.
162 # @param FilePath The full path string for existing VPD PCD info file.
163 def Read(self
, FilePath
):
165 fd
= open(FilePath
, "r")
167 EdkLogger
.error("VpdInfoFile",
168 BuildToolError
.FILE_OPEN_FAILURE
,
169 "Fail to open file %s for written." % FilePath
)
170 Lines
= fd
.readlines()
173 if len(Line
) == 0 or Line
.startswith("#"):
177 # the line must follow output format defined in BPDG spec.
180 PcdName
, SkuId
,Offset
, Size
, Value
= Line
.split("#")[0].split("|")
181 PcdName
, SkuId
,Offset
, Size
, Value
= PcdName
.strip(), SkuId
.strip(),Offset
.strip(), Size
.strip(), Value
.strip()
182 TokenSpaceName
, PcdTokenName
= PcdName
.split(".")
184 EdkLogger
.error("BPDG", BuildToolError
.PARSER_ERROR
, "Fail to parse VPD information file %s" % FilePath
)
188 for VpdObject
in self
._VpdArray
.keys():
189 for sku
in VpdObject
.SkuInfoList
.keys():
190 if VpdObject
.TokenSpaceGuidCName
== TokenSpaceName
and VpdObject
.TokenCName
== PcdTokenName
.strip() and sku
== SkuId
:
191 if self
._VpdArray
[VpdObject
][VpdObject
.SkuInfoList
.keys().index(sku
)] == "*":
193 EdkLogger
.error("BPDG", BuildToolError
.FORMAT_INVALID
, "The offset of %s has not been fixed up by third-party BPDG tool." % PcdName
)
194 self
._VpdArray
[VpdObject
][VpdObject
.SkuInfoList
.keys().index(sku
)] = Offset
197 EdkLogger
.error("BPDG", BuildToolError
.PARSER_ERROR
, "Can not find PCD defined in VPD guid file.")
199 ## Get count of VPD PCD collected from platform's autogen when building.
201 # @return The integer count value
204 for OffsetList
in self
._VpdArray
.values():
205 Count
+= len(OffsetList
)
209 ## Get an offset value for a given VPD PCD
211 # Because BPDG only support one Sku, so only return offset for SKU default.
213 # @param vpd A given VPD PCD
214 def GetOffset(self
, vpd
):
215 if not self
._VpdArray
.has_key(vpd
):
218 if len(self
._VpdArray
[vpd
]) == 0:
221 return self
._VpdArray
[vpd
]
223 ## Call external BPDG tool to process VPD file
225 # @param ToolPath The string path name for BPDG tool
226 # @param VpdFileName The string path name for VPD information guid.txt
228 def CallExtenalBPDGTool(ToolPath
, VpdFileName
):
229 assert ToolPath
!= None, "Invalid parameter ToolPath"
230 assert VpdFileName
!= None and os
.path
.exists(VpdFileName
), "Invalid parameter VpdFileName"
232 OutputDir
= os
.path
.dirname(VpdFileName
)
233 FileName
= os
.path
.basename(VpdFileName
)
234 BaseName
, ext
= os
.path
.splitext(FileName
)
235 OutputMapFileName
= os
.path
.join(OutputDir
, "%s.map" % BaseName
)
236 OutputBinFileName
= os
.path
.join(OutputDir
, "%s.bin" % BaseName
)
239 PopenObject
= subprocess
.Popen([ToolPath
,
240 '-o', OutputBinFileName
,
241 '-m', OutputMapFileName
,
245 stdout
=subprocess
.PIPE
,
246 stderr
= subprocess
.PIPE
)
248 EdkLogger
.error("BPDG", BuildToolError
.COMMAND_FAILURE
, ExtraData
="%s" % (str(X
)))
249 (out
, error
) = PopenObject
.communicate()
251 while PopenObject
.returncode
== None :
254 if PopenObject
.returncode
!= 0:
255 if PopenObject
.returncode
!= 0:
256 EdkLogger
.debug(EdkLogger
.DEBUG_1
, "Fail to call BPDG tool", str(error
))
257 EdkLogger
.error("BPDG", BuildToolError
.COMMAND_FAILURE
, "Fail to execute BPDG tool with exit code: %d, the error message is: \n %s" % \
258 (PopenObject
.returncode
, str(error
)))
260 return PopenObject
.returncode