[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
            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
            \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
2b8a6c44 LG	105	if Vpd.MaxDatumSize <= 0:\r
	106	EdkLogger.error("VpdInfoFile", BuildToolError.PARAMETER_INVALID,\r
	107	"Invalid max datum size for VPD PCD %s.%s" % (Vpd.TokenSpaceGuidCName, Vpd.TokenCName))\r
e56468c0	108	\r
	109	if Vpd not in self._VpdArray.keys():\r
	110	#\r
	111	# If there is no Vpd instance in dict, that imply this offset for a given SKU is a new one \r
	112	#\r
	113	self._VpdArray[Vpd] = [Offset]\r
	114	else:\r
	115	#\r
	116	# If there is an offset for a specific SKU in dict, then append this offset for other sku to array.\r
	117	#\r
	118	self._VpdArray[Vpd].append(Offset)\r
	119	\r
	120	\r
	121	## Generate VPD PCD information into a text file\r
	122	# \r
	123	# If parameter FilePath is invalid, then assert.\r
	124	# If \r
	125	# @param FilePath The given file path which would hold VPD information\r
	126	def Write(self, FilePath):\r
	127	if not (FilePath != None or len(FilePath) != 0):\r
	128	EdkLogger.error("VpdInfoFile", BuildToolError.PARAMETER_INVALID, \r
	129	"Invalid parameter FilePath: %s." % FilePath) \r
e56468c0	130	\r
e459de78 YZ	131	Content = FILE_COMMENT_TEMPLATE\r
	132	Pcds = self._VpdArray.keys()\r
	133	Pcds.sort()\r
	134	for Pcd in Pcds:\r
	135	i = 0\r
2a29017e YZ	136	PcdTokenCName = Pcd.TokenCName\r
	137	for PcdItem in GlobalData.MixedPcd:\r
	138	if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
	139	PcdTokenCName = PcdItem[0]\r
e459de78 YZ	140	for Offset in self._VpdArray[Pcd]:\r
	141	PcdValue = str(Pcd.SkuInfoList[Pcd.SkuInfoList.keys()[i]].DefaultValue).strip()\r
	142	if PcdValue == "" :\r
	143	PcdValue = Pcd.DefaultValue\r
	144	\r
2a29017e	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)\r
e459de78 YZ	146	i += 1\r
	147	\r
	148	return SaveFileOnChange(FilePath, Content, False)\r
e56468c0	149	\r
	150	## Read an existing VPD PCD info file.\r
	151	#\r
	152	# This routine will read VPD PCD information from existing file and construct\r
	153	# internal PcdClassObject array.\r
	154	# This routine could be used by third-party tool to parse VPD info file content.\r
	155	#\r
	156	# @param FilePath The full path string for existing VPD PCD info file.\r
	157	def Read(self, FilePath):\r
	158	try:\r
	159	fd = open(FilePath, "r")\r
	160	except:\r
	161	EdkLogger.error("VpdInfoFile", \r
	162	BuildToolError.FILE_OPEN_FAILURE, \r
	163	"Fail to open file %s for written." % FilePath)\r
	164	Lines = fd.readlines()\r
	165	for Line in Lines:\r
	166	Line = Line.strip()\r
	167	if len(Line) == 0 or Line.startswith("#"):\r
	168	continue\r
	169	\r
	170	#\r
	171	# the line must follow output format defined in BPDG spec.\r
	172	#\r
	173	try:\r
e8a47801 LG	174	PcdName, SkuId,Offset, Size, Value = Line.split("#")[0].split("\|")\r
e8a47801 LG	175	PcdName, SkuId,Offset, Size, Value = PcdName.strip(), SkuId.strip(),Offset.strip(), Size.strip(), Value.strip()\r
e56468c0	176	TokenSpaceName, PcdTokenName = PcdName.split(".")\r
	177	except:\r
	178	EdkLogger.error("BPDG", BuildToolError.PARSER_ERROR, "Fail to parse VPD information file %s" % FilePath)\r
	179	\r
	180	Found = False\r
e8a47801	181	\r
e56468c0	182	for VpdObject in self._VpdArray.keys():\r
2a29017e YZ	183	VpdObjectTokenCName = VpdObject.TokenCName\r
	184	for PcdItem in GlobalData.MixedPcd:\r
	185	if (VpdObject.TokenCName, VpdObject.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
	186	VpdObjectTokenCName = PcdItem[0]\r
	187	for sku in VpdObject.SkuInfoList.keys():\r
	188	if VpdObject.TokenSpaceGuidCName == TokenSpaceName and VpdObjectTokenCName == PcdTokenName.strip() and sku == SkuId:\r
e8a47801 LG	189	if self._VpdArray[VpdObject][VpdObject.SkuInfoList.keys().index(sku)] == "*":\r
	190	if Offset == "*":\r
	191	EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID, "The offset of %s has not been fixed up by third-party BPDG tool." % PcdName) \r
	192	self._VpdArray[VpdObject][VpdObject.SkuInfoList.keys().index(sku)] = Offset\r
	193	Found = True\r
e56468c0	194	if not Found:\r
	195	EdkLogger.error("BPDG", BuildToolError.PARSER_ERROR, "Can not find PCD defined in VPD guid file.")\r
	196	\r
	197	## Get count of VPD PCD collected from platform's autogen when building.\r
	198	#\r
	199	# @return The integer count value \r
	200	def GetCount(self):\r
	201	Count = 0\r
	202	for OffsetList in self._VpdArray.values():\r
	203	Count += len(OffsetList)\r
	204	\r
	205	return Count\r
	206	\r
	207	## Get an offset value for a given VPD PCD\r
	208	#\r
	209	# Because BPDG only support one Sku, so only return offset for SKU default. \r
	210	#\r
	211	# @param vpd A given VPD PCD \r
	212	def GetOffset(self, vpd):\r
	213	if not self._VpdArray.has_key(vpd):\r
	214	return None\r
	215	\r
	216	if len(self._VpdArray[vpd]) == 0:\r
	217	return None\r
	218	\r
	219	return self._VpdArray[vpd]\r
	220	\r
	221	## Call external BPDG tool to process VPD file\r
	222	# \r
	223	# @param ToolPath The string path name for BPDG tool\r
	224	# @param VpdFileName The string path name for VPD information guid.txt\r
	225	# \r
08dd311f	226	def CallExtenalBPDGTool(ToolPath, VpdFileName):\r
e56468c0	227	assert ToolPath != None, "Invalid parameter ToolPath"\r
08dd311f	228	assert VpdFileName != None and os.path.exists(VpdFileName), "Invalid parameter VpdFileName"\r
e56468c0	229	\r
08dd311f LG	230	OutputDir = os.path.dirname(VpdFileName)\r
	231	FileName = os.path.basename(VpdFileName)\r
	232	BaseName, ext = os.path.splitext(FileName)\r
	233	OutputMapFileName = os.path.join(OutputDir, "%s.map" % BaseName)\r
	234	OutputBinFileName = os.path.join(OutputDir, "%s.bin" % BaseName)\r
e56468c0	235	\r
e56468c0	236	try:\r
71f5913e	237	PopenObject = subprocess.Popen(' '.join([ToolPath,\r
e56468c0	238	'-o', OutputBinFileName, \r
e56468c0	239	'-m', OutputMapFileName,\r
08dd311f	240	'-q',\r
e56468c0	241	'-f',\r
71f5913e	242	VpdFileName]),\r
e56468c0	243	stdout=subprocess.PIPE, \r
71f5913e LG	244	stderr= subprocess.PIPE,\r
71f5913e LG	245	shell=True)\r
e56468c0	246	except Exception, X:\r
	247	EdkLogger.error("BPDG", BuildToolError.COMMAND_FAILURE, ExtraData="%s" % (str(X)))\r
	248	(out, error) = PopenObject.communicate()\r
	249	print out\r
	250	while PopenObject.returncode == None :\r
	251	PopenObject.wait()\r
	252	\r
	253	if PopenObject.returncode != 0:\r
	254	if PopenObject.returncode != 0:\r
	255	EdkLogger.debug(EdkLogger.DEBUG_1, "Fail to call BPDG tool", str(error))\r
	256	EdkLogger.error("BPDG", BuildToolError.COMMAND_FAILURE, "Fail to execute BPDG tool with exit code: %d, the error message is: \n %s" % \\r
	257	(PopenObject.returncode, str(error)))\r
	258	\r
	259	return PopenObject.returncode\r