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