]>
git.proxmox.com Git - mirror_edk2.git/blob - BaseTools/Source/Python/Common/VpdInfoFile.py
56161efe6ae0bd5846074ea63f1b72db8ff17837
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]
83 ## Add a VPD PCD collected from platform's autogen when building.
85 # @param vpds The list of VPD PCD collected for a platform.
86 # @see BuildClassObject.PcdClassObject
88 # @param offset integer value for VPD's offset in specific SKU.
90 def Add ( self
, Vpd
, Offset
):
92 EdkLogger
. error ( "VpdInfoFile" , BuildToolError
. ATTRIBUTE_UNKNOWN_ERROR
, "Invalid VPD PCD entry." )
94 if not ( Offset
>= 0 or Offset
== "*" ):
95 EdkLogger
. error ( "VpdInfoFile" , BuildToolError
. PARAMETER_INVALID
, "Invalid offset parameter: %s ." % Offset
)
97 if Vpd
. DatumType
== "VOID*" :
98 if Vpd
. MaxDatumSize
<= 0 :
99 EdkLogger
. error ( "VpdInfoFile" , BuildToolError
. PARAMETER_INVALID
,
100 "Invalid max datum size for VPD PCD %s . %s " % ( Vpd
. TokenSpaceGuidCName
, Vpd
. TokenCName
))
101 elif Vpd
. DatumType
in [ "BOOLEAN" , "UINT8" , "UINT16" , "UINT32" , "UINT64" ]:
102 if Vpd
. MaxDatumSize
== None or Vpd
. MaxDatumSize
== "" :
103 Vpd
. MaxDatumSize
= VpdInfoFile
._ MAX
_ SIZE
_ TYPE
[ Vpd
. DatumType
]
105 if Vpd
. MaxDatumSize
<= 0 :
106 EdkLogger
. error ( "VpdInfoFile" , BuildToolError
. PARAMETER_INVALID
,
107 "Invalid max datum size for VPD PCD %s . %s " % ( Vpd
. TokenSpaceGuidCName
, Vpd
. TokenCName
))
109 if Vpd
not in self
._ VpdArray
. keys ():
111 # If there is no Vpd instance in dict, that imply this offset for a given SKU is a new one
113 self
._ VpdArray
[ Vpd
] = [ Offset
]
116 # If there is an offset for a specific SKU in dict, then append this offset for other sku to array.
118 self
._ VpdArray
[ Vpd
]. append ( Offset
)
121 ## Generate VPD PCD information into a text file
123 # If parameter FilePath is invalid, then assert.
125 # @param FilePath The given file path which would hold VPD information
126 def Write ( self
, FilePath
):
127 if not ( FilePath
!= None or len ( FilePath
) != 0 ):
128 EdkLogger
. error ( "VpdInfoFile" , BuildToolError
. PARAMETER_INVALID
,
129 "Invalid parameter FilePath: %s ." % FilePath
)
131 Content
= FILE_COMMENT_TEMPLATE
132 Pcds
= self
._ VpdArray
. keys ()
136 PcdTokenCName
= Pcd
. TokenCName
137 for PcdItem
in GlobalData
. MixedPcd
:
138 if ( Pcd
. TokenCName
, Pcd
. TokenSpaceGuidCName
) in GlobalData
. MixedPcd
[ PcdItem
]:
139 PcdTokenCName
= PcdItem
[ 0 ]
140 for Offset
in self
._ VpdArray
[ Pcd
]:
141 PcdValue
= str ( Pcd
. SkuInfoList
[ Pcd
. SkuInfoList
. keys ()[ i
]]. DefaultValue
). strip ()
143 PcdValue
= Pcd
. DefaultValue
145 Content
+= " %s . %s | %s | %s | %s | %s \n " % ( Pcd
. TokenSpaceGuidCName
, PcdTokenCName
, str ( Pcd
. SkuInfoList
. keys ()[ i
]), str ( Offset
). strip (), str ( Pcd
. MaxDatumSize
). strip (), PcdValue
)
148 return SaveFileOnChange ( FilePath
, Content
, False )
150 ## Read an existing VPD PCD info file.
152 # This routine will read VPD PCD information from existing file and construct
153 # internal PcdClassObject array.
154 # This routine could be used by third-party tool to parse VPD info file content.
156 # @param FilePath The full path string for existing VPD PCD info file.
157 def Read ( self
, FilePath
):
159 fd
= open ( FilePath
, "r" )
161 EdkLogger
. error ( "VpdInfoFile" ,
162 BuildToolError
. FILE_OPEN_FAILURE
,
163 "Fail to open file %s for written." % FilePath
)
164 Lines
= fd
. readlines ()
167 if len ( Line
) == 0 or Line
. startswith ( "#" ):
171 # the line must follow output format defined in BPDG spec.
174 PcdName
, SkuId
, Offset
, Size
, Value
= Line
. split ( "#" )[ 0 ]. split ( "|" )
175 PcdName
, SkuId
, Offset
, Size
, Value
= PcdName
. strip (), SkuId
. strip (), Offset
. strip (), Size
. strip (), Value
. strip ()
176 TokenSpaceName
, PcdTokenName
= PcdName
. split ( "." )
178 EdkLogger
. error ( "BPDG" , BuildToolError
. PARSER_ERROR
, "Fail to parse VPD information file %s " % FilePath
)
182 for VpdObject
in self
._ VpdArray
. keys ():
183 VpdObjectTokenCName
= VpdObject
. TokenCName
184 for PcdItem
in GlobalData
. MixedPcd
:
185 if ( VpdObject
. TokenCName
, VpdObject
. TokenSpaceGuidCName
) in GlobalData
. MixedPcd
[ PcdItem
]:
186 VpdObjectTokenCName
= PcdItem
[ 0 ]
187 for sku
in VpdObject
. SkuInfoList
. keys ():
188 if VpdObject
. TokenSpaceGuidCName
== TokenSpaceName
and VpdObjectTokenCName
== PcdTokenName
. strip () and sku
== SkuId
:
189 if self
._ VpdArray
[ VpdObject
][ VpdObject
. SkuInfoList
. keys (). index ( sku
)] == "*" :
191 EdkLogger
. error ( "BPDG" , BuildToolError
. FORMAT_INVALID
, "The offset of %s has not been fixed up by third-party BPDG tool." % PcdName
)
192 self
._ VpdArray
[ VpdObject
][ VpdObject
. SkuInfoList
. keys (). index ( sku
)] = Offset
195 EdkLogger
. error ( "BPDG" , BuildToolError
. PARSER_ERROR
, "Can not find PCD defined in VPD guid file." )
197 ## Get count of VPD PCD collected from platform's autogen when building.
199 # @return The integer count value
202 for OffsetList
in self
._ VpdArray
. values ():
203 Count
+= len ( OffsetList
)
207 ## Get an offset value for a given VPD PCD
209 # Because BPDG only support one Sku, so only return offset for SKU default.
211 # @param vpd A given VPD PCD
212 def GetOffset ( self
, vpd
):
213 if not self
._ VpdArray
. has_key ( vpd
):
216 if len ( self
._ VpdArray
[ vpd
]) == 0 :
219 return self
._ VpdArray
[ vpd
]
221 ## Call external BPDG tool to process VPD file
223 # @param ToolPath The string path name for BPDG tool
224 # @param VpdFileName The string path name for VPD information guid.txt
226 def CallExtenalBPDGTool ( ToolPath
, VpdFileName
):
227 assert ToolPath
!= None , "Invalid parameter ToolPath"
228 assert VpdFileName
!= None and os
. path
. exists ( VpdFileName
), "Invalid parameter VpdFileName"
230 OutputDir
= os
. path
. dirname ( VpdFileName
)
231 FileName
= os
. path
. basename ( VpdFileName
)
232 BaseName
, ext
= os
. path
. splitext ( FileName
)
233 OutputMapFileName
= os
. path
. join ( OutputDir
, " %s .map" % BaseName
)
234 OutputBinFileName
= os
. path
. join ( OutputDir
, " %s .bin" % BaseName
)
237 PopenObject
= subprocess
. Popen ( ' ' . join ([ ToolPath
,
238 '-o' , OutputBinFileName
,
239 '-m' , OutputMapFileName
,
243 stdout
= subprocess
. PIPE
,
244 stderr
= subprocess
. PIPE
,
247 EdkLogger
. error ( "BPDG" , BuildToolError
. COMMAND_FAILURE
, ExtraData
= " %s " % ( str ( X
)))
248 ( out
, error
) = PopenObject
. communicate ()
250 while PopenObject
. returncode
== None :
253 if PopenObject
. returncode
!= 0 :
254 if PopenObject
. returncode
!= 0 :
255 EdkLogger
. debug ( EdkLogger
. DEBUG_1
, "Fail to call BPDG tool" , str ( error
))
256 EdkLogger
. error ( "BPDG" , BuildToolError
. COMMAND_FAILURE
, "Fail to execute BPDG tool with exit code: %d , the error message is: \n %s " % \
257 ( PopenObject
. returncode
, str ( error
)))
259 return PopenObject
. returncode