]>
git.proxmox.com Git - mirror_edk2.git/blob - BaseTools/Source/Python/Common/VpdInfoFile.py
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 - 2016, 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 import Common
. GlobalData
as GlobalData
24 from Common
. LongFilePathSupport
import OpenLongFilePath
as open
25 from Common
. Misc
import SaveFileOnChange
27 FILE_COMMENT_TEMPLATE
= \
31 # THIS IS AUTO-GENERATED FILE BY BUILD TOOLS AND PLEASE DO NOT MAKE MODIFICATION.
33 # This file lists all VPD informations for a platform collected by build.exe.
35 # Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
36 # This program and the accompanying materials
37 # are licensed and made available under the terms and conditions of the BSD License
38 # which accompanies this distribution. The full text of the license may be found at
39 # http://opensource.org/licenses/bsd-license.php
41 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
42 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
47 ## The class manage VpdInfoFile.
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.
50 # Format for this file (using EBNF notation) is:
51 # <File> :: = [<CommentBlock>]
53 # <CommentBlock> ::= ["#" <String> <EOL>]*
54 # <PcdEntry> ::= <PcdName> "|" <Offset> "|" <Size> "|" <Value> <EOL>
55 # <PcdName> ::= <TokenSpaceCName> "." <PcdCName>
56 # <TokenSpaceCName> ::= C Variable Name of the Token Space GUID
57 # <PcdCName> ::= C Variable Name of the PCD
58 # <Offset> ::= {"*"} {<HexNumber>}
59 # <HexNumber> ::= "0x" (a-fA-F0-9){1,8}
60 # <Size> ::= <HexNumber>
61 # <Value> ::= {<HexNumber>} {<NonNegativeInt>} {<QString>} {<Array>}
62 # <NonNegativeInt> ::= (0-9)+
63 # <QString> ::= ["L"] <DblQuote> <String> <DblQuote>
65 # <Array> ::= {<CArray>} {<NList>}
66 # <CArray> ::= "{" <HexNumber> ["," <HexNumber>]* "}"
67 # <NList> ::= <HexNumber> ["," <HexNumber>]*
71 ## The mapping dictionary from datum type to size string.
72 _MAX_SIZE_TYPE
= { "BOOLEAN" : "1" , "UINT8" : "1" , "UINT16" : "2" , "UINT32" : "4" , "UINT64" : "8" }
76 ## Dictionary for VPD in following format
78 # Key : PcdClassObject instance.
79 # @see BuildClassObject.PcdClassObject
80 # Value : offset in different SKU such as [sku1_offset, sku2_offset]
84 ## Add a VPD PCD collected from platform's autogen when building.
86 # @param vpds The list of VPD PCD collected for a platform.
87 # @see BuildClassObject.PcdClassObject
89 # @param offset integer value for VPD's offset in specific SKU.
91 def Add ( self
, Vpd
, skuname
, Offset
):
93 EdkLogger
. error ( "VpdInfoFile" , BuildToolError
. ATTRIBUTE_UNKNOWN_ERROR
, "Invalid VPD PCD entry." )
95 if not ( Offset
>= 0 or Offset
== "*" ):
96 EdkLogger
. error ( "VpdInfoFile" , BuildToolError
. PARAMETER_INVALID
, "Invalid offset parameter: %s ." % Offset
)
98 if Vpd
. DatumType
== "VOID*" :
99 if Vpd
. MaxDatumSize
<= 0 :
100 EdkLogger
. error ( "VpdInfoFile" , BuildToolError
. PARAMETER_INVALID
,
101 "Invalid max datum size for VPD PCD %s . %s " % ( Vpd
. TokenSpaceGuidCName
, Vpd
. TokenCName
))
102 elif Vpd
. DatumType
in [ "BOOLEAN" , "UINT8" , "UINT16" , "UINT32" , "UINT64" ]:
103 if Vpd
. MaxDatumSize
is None or Vpd
. MaxDatumSize
== "" :
104 Vpd
. MaxDatumSize
= VpdInfoFile
._ MAX
_ SIZE
_ TYPE
[ Vpd
. DatumType
]
106 if Vpd
. MaxDatumSize
<= 0 :
107 EdkLogger
. error ( "VpdInfoFile" , BuildToolError
. PARAMETER_INVALID
,
108 "Invalid max datum size for VPD PCD %s . %s " % ( Vpd
. TokenSpaceGuidCName
, Vpd
. TokenCName
))
110 if Vpd
not in self
._ VpdArray
. keys ():
112 # If there is no Vpd instance in dict, that imply this offset for a given SKU is a new one
114 self
._ VpdArray
[ Vpd
] = {}
116 self
._ VpdArray
[ Vpd
]. update ({ skuname
: Offset
})
119 ## Generate VPD PCD information into a text file
121 # If parameter FilePath is invalid, then assert.
123 # @param FilePath The given file path which would hold VPD information
124 def Write ( self
, FilePath
):
125 if not ( FilePath
is not None or len ( FilePath
) != 0 ):
126 EdkLogger
. error ( "VpdInfoFile" , BuildToolError
. PARAMETER_INVALID
,
127 "Invalid parameter FilePath: %s ." % FilePath
)
129 Content
= FILE_COMMENT_TEMPLATE
130 Pcds
= self
._ VpdArray
. keys ()
134 PcdTokenCName
= Pcd
. TokenCName
135 for PcdItem
in GlobalData
. MixedPcd
:
136 if ( Pcd
. TokenCName
, Pcd
. TokenSpaceGuidCName
) in GlobalData
. MixedPcd
[ PcdItem
]:
137 PcdTokenCName
= PcdItem
[ 0 ]
138 for skuname
in self
._ VpdArray
[ Pcd
]:
139 PcdValue
= str ( Pcd
. SkuInfoList
[ skuname
]. DefaultValue
). strip ()
141 PcdValue
= Pcd
. DefaultValue
143 Content
+= " %s . %s | %s | %s | %s | %s \n " % ( Pcd
. TokenSpaceGuidCName
, PcdTokenCName
, skuname
, str ( self
._ VpdArray
[ Pcd
][ skuname
]). strip (), str ( Pcd
. MaxDatumSize
). strip (), PcdValue
)
146 return SaveFileOnChange ( FilePath
, Content
, False )
148 ## Read an existing VPD PCD info file.
150 # This routine will read VPD PCD information from existing file and construct
151 # internal PcdClassObject array.
152 # This routine could be used by third-party tool to parse VPD info file content.
154 # @param FilePath The full path string for existing VPD PCD info file.
155 def Read ( self
, FilePath
):
157 fd
= open ( FilePath
, "r" )
159 EdkLogger
. error ( "VpdInfoFile" ,
160 BuildToolError
. FILE_OPEN_FAILURE
,
161 "Fail to open file %s for written." % FilePath
)
162 Lines
= fd
. readlines ()
165 if len ( Line
) == 0 or Line
. startswith ( "#" ):
169 # the line must follow output format defined in BPDG spec.
172 PcdName
, SkuId
, Offset
, Size
, Value
= Line
. split ( "#" )[ 0 ]. split ( "|" )
173 PcdName
, SkuId
, Offset
, Size
, Value
= PcdName
. strip (), SkuId
. strip (), Offset
. strip (), Size
. strip (), Value
. strip ()
174 TokenSpaceName
, PcdTokenName
= PcdName
. split ( "." )
176 EdkLogger
. error ( "BPDG" , BuildToolError
. PARSER_ERROR
, "Fail to parse VPD information file %s " % FilePath
)
180 if ( TokenSpaceName
, PcdTokenName
) not in self
._ VpdInfo
:
181 self
._ VpdInfo
[( TokenSpaceName
, PcdTokenName
)] = []
182 self
._ VpdInfo
[( TokenSpaceName
, PcdTokenName
)]. append (( SkuId
, Offset
, Value
))
183 for VpdObject
in self
._ VpdArray
. keys ():
184 VpdObjectTokenCName
= VpdObject
. TokenCName
185 for PcdItem
in GlobalData
. MixedPcd
:
186 if ( VpdObject
. TokenCName
, VpdObject
. TokenSpaceGuidCName
) in GlobalData
. MixedPcd
[ PcdItem
]:
187 VpdObjectTokenCName
= PcdItem
[ 0 ]
188 for sku
in VpdObject
. SkuInfoList
. keys ():
189 if VpdObject
. TokenSpaceGuidCName
== TokenSpaceName
and VpdObjectTokenCName
== PcdTokenName
. strip () and sku
== SkuId
:
190 if self
._ VpdArray
[ VpdObject
][ sku
] == "*" :
192 EdkLogger
. error ( "BPDG" , BuildToolError
. FORMAT_INVALID
, "The offset of %s has not been fixed up by third-party BPDG tool." % PcdName
)
193 self
._ VpdArray
[ VpdObject
][ sku
] = Offset
196 EdkLogger
. error ( "BPDG" , BuildToolError
. PARSER_ERROR
, "Can not find PCD defined in VPD guid file." )
198 ## Get count of VPD PCD collected from platform's autogen when building.
200 # @return The integer count value
203 for OffsetList
in self
._ VpdArray
. values ():
204 Count
+= len ( OffsetList
)
208 ## Get an offset value for a given VPD PCD
210 # Because BPDG only support one Sku, so only return offset for SKU default.
212 # @param vpd A given VPD PCD
213 def GetOffset ( self
, vpd
):
214 if not self
._ VpdArray
. has_key ( vpd
):
217 if len ( self
._ VpdArray
[ vpd
]) == 0 :
220 return self
._ VpdArray
[ vpd
]
221 def GetVpdInfo ( self
,( PcdTokenName
, TokenSpaceName
)):
222 return self
._ VpdInfo
. get (( TokenSpaceName
, PcdTokenName
))
224 ## Call external BPDG tool to process VPD file
226 # @param ToolPath The string path name for BPDG tool
227 # @param VpdFileName The string path name for VPD information guid.txt
229 def CallExtenalBPDGTool ( ToolPath
, VpdFileName
):
230 assert ToolPath
is not None , "Invalid parameter ToolPath"
231 assert VpdFileName
is not None and os
. path
. exists ( VpdFileName
), "Invalid parameter VpdFileName"
233 OutputDir
= os
. path
. dirname ( VpdFileName
)
234 FileName
= os
. path
. basename ( VpdFileName
)
235 BaseName
, ext
= os
. path
. splitext ( FileName
)
236 OutputMapFileName
= os
. path
. join ( OutputDir
, " %s .map" % BaseName
)
237 OutputBinFileName
= os
. path
. join ( OutputDir
, " %s .bin" % BaseName
)
240 PopenObject
= subprocess
. Popen ( ' ' . join ([ ToolPath
,
241 '-o' , OutputBinFileName
,
242 '-m' , OutputMapFileName
,
246 stdout
= subprocess
. PIPE
,
247 stderr
= subprocess
. PIPE
,
250 EdkLogger
. error ( "BPDG" , BuildToolError
. COMMAND_FAILURE
, ExtraData
= " %s " % ( str ( X
)))
251 ( out
, error
) = PopenObject
. communicate ()
253 while PopenObject
. returncode
is None :
256 if PopenObject
. returncode
!= 0 :
257 if PopenObject
. returncode
!= 0 :
258 EdkLogger
. debug ( EdkLogger
. DEBUG_1
, "Fail to call BPDG tool" , str ( error
))
259 EdkLogger
. error ( "BPDG" , BuildToolError
. COMMAND_FAILURE
, "Fail to execute BPDG tool with exit code: %d , the error message is: \n %s " % \
260 ( PopenObject
. returncode
, str ( error
)))
262 return PopenObject
. returncode