[mirror_edk2.git] / BaseTools / Source / Python / Common / VpdInfoFile.py

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