import os

import re

import Common.EdkLogger as EdkLogger

import Common.BuildToolError as BuildToolError

import subprocess

FILE_COMMENT_TEMPLATE = \

class VpdInfoFile:

## The mapping dictionary from datum type to size string.

_MAX_SIZE_TYPE = {"BOOLEAN":"1", "UINT8":"1", "UINT16":"2", "UINT32":"4", "UINT64":"8"}

_rVpdPcdLine = None

## Constructor

def __init__(self):

## Dictionary for VPD in following format

#

# Key : PcdClassObject instance.

# @see BuildClassObject.PcdClassObject

# Value : offset in different SKU such as [sku1_offset, sku2_offset]

self._VpdArray = {}

## Add a VPD PCD collected from platform's autogen when building.

#

# @param vpds The list of VPD PCD collected for a platform.

# @see BuildClassObject.PcdClassObject

#

# @param offset integer value for VPD's offset in specific SKU.

#

def Add(self, Vpd, Offset):

if (Vpd == None):

EdkLogger.error("VpdInfoFile", BuildToolError.ATTRIBUTE_UNKNOWN_ERROR, "Invalid VPD PCD entry.")

if not (Offset >= 0 or Offset == "*"):

EdkLogger.error("VpdInfoFile", BuildToolError.PARAMETER_INVALID, "Invalid offset parameter: %s." % Offset)

if Vpd.DatumType == "VOID*":

if Vpd.MaxDatumSize <= 0:

EdkLogger.error("VpdInfoFile", BuildToolError.PARAMETER_INVALID,

"Invalid max datum size for VPD PCD %s.%s" % (Vpd.TokenSpaceGuidCName, Vpd.TokenCName))

elif Vpd.DatumType in ["BOOLEAN", "UINT8", "UINT16", "UINT32", "UINT64"]:

if Vpd.MaxDatumSize == None or Vpd.MaxDatumSize == "":

Vpd.MaxDatumSize = VpdInfoFile._MAX_SIZE_TYPE[Vpd.DatumType]

else:

EdkLogger.error("VpdInfoFile", BuildToolError.PARAMETER_INVALID,

"Invalid DatumType %s for VPD PCD %s.%s" % (Vpd.DatumType, Vpd.TokenSpaceGuidCName, Vpd.TokenCName))

if Vpd not in self._VpdArray.keys():

#

# If there is no Vpd instance in dict, that imply this offset for a given SKU is a new one

#

self._VpdArray[Vpd] = [Offset]

else:

#

# If there is an offset for a specific SKU in dict, then append this offset for other sku to array.

#

self._VpdArray[Vpd].append(Offset)

## Generate VPD PCD information into a text file

#

# If parameter FilePath is invalid, then assert.

# If

# @param FilePath The given file path which would hold VPD information

def Write(self, FilePath):

if not (FilePath != None or len(FilePath) != 0):

EdkLogger.error("VpdInfoFile", BuildToolError.PARAMETER_INVALID,

"Invalid parameter FilePath: %s." % FilePath)

try:

fd = open(FilePath, "w")

except:

EdkLogger.error("VpdInfoFile",

BuildToolError.FILE_OPEN_FAILURE,

"Fail to open file %s for written." % FilePath)

try:

# write file header

fd.write(FILE_COMMENT_TEMPLATE)

# write each of PCD in VPD type

Pcds = self._VpdArray.keys()

Pcds.sort()

for Pcd in Pcds:

for Offset in self._VpdArray[Pcd]:

PcdValue = str(Pcd.SkuInfoList[Pcd.SkuInfoList.keys()[0]].DefaultValue).strip()

if PcdValue == "" :

PcdValue = Pcd.DefaultValue

fd.write("%s.%s|%s|%s|%s \n" % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName, str(Offset).strip(), str(Pcd.MaxDatumSize).strip(),PcdValue))

except:

EdkLogger.error("VpdInfoFile",

BuildToolError.FILE_WRITE_FAILURE,

"Fail to write file %s" % FilePath)

fd.close()

## Read an existing VPD PCD info file.

#

# This routine will read VPD PCD information from existing file and construct

# internal PcdClassObject array.

# This routine could be used by third-party tool to parse VPD info file content.

#

# @param FilePath The full path string for existing VPD PCD info file.

def Read(self, FilePath):

try:

fd = open(FilePath, "r")

except:

EdkLogger.error("VpdInfoFile",

BuildToolError.FILE_OPEN_FAILURE,

"Fail to open file %s for written." % FilePath)

Lines = fd.readlines()

for Line in Lines:

Line = Line.strip()

if len(Line) == 0 or Line.startswith("#"):

continue

#

# the line must follow output format defined in BPDG spec.

#

try:

PcdName, Offset, Size, Value = Line.split("#")[0].split("|")

TokenSpaceName, PcdTokenName = PcdName.split(".")

except:

EdkLogger.error("BPDG", BuildToolError.PARSER_ERROR, "Fail to parse VPD information file %s" % FilePath)

Found = False

for VpdObject in self._VpdArray.keys():

if VpdObject.TokenSpaceGuidCName == TokenSpaceName and VpdObject.TokenCName == PcdTokenName.strip():

if self._VpdArray[VpdObject][0] == "*":

if Offset == "*":

EdkLogger.error("BPDG", BuildToolError.FORMAT_INVALID, "The offset of %s has not been fixed up by third-party BPDG tool." % PcdName)

self._VpdArray[VpdObject][0] = Offset

Found = True

break

if not Found:

EdkLogger.error("BPDG", BuildToolError.PARSER_ERROR, "Can not find PCD defined in VPD guid file.")

## Get count of VPD PCD collected from platform's autogen when building.

#

# @return The integer count value

def GetCount(self):

Count = 0

for OffsetList in self._VpdArray.values():

Count += len(OffsetList)

return Count

## Get an offset value for a given VPD PCD

#

# Because BPDG only support one Sku, so only return offset for SKU default.

#

# @param vpd A given VPD PCD

def GetOffset(self, vpd):

if not self._VpdArray.has_key(vpd):

return None

if len(self._VpdArray[vpd]) == 0:

return None

return self._VpdArray[vpd]

def CallExtenalBPDGTool(ToolPath, VpdFileName):

assert ToolPath != None, "Invalid parameter ToolPath"

assert VpdFileName != None and os.path.exists(VpdFileName), "Invalid parameter VpdFileName"

OutputDir = os.path.dirname(VpdFileName)

FileName = os.path.basename(VpdFileName)

BaseName, ext = os.path.splitext(FileName)

OutputMapFileName = os.path.join(OutputDir, "%s.map" % BaseName)

OutputBinFileName = os.path.join(OutputDir, "%s.bin" % BaseName)

try:

PopenObject = subprocess.Popen([ToolPath,

'-o', OutputBinFileName,

'-m', OutputMapFileName,

'-q',

'-f',

VpdFileName],

stdout=subprocess.PIPE,

stderr= subprocess.PIPE)

except Exception, X:

EdkLogger.error("BPDG", BuildToolError.COMMAND_FAILURE, ExtraData="%s" % (str(X)))

(out, error) = PopenObject.communicate()

print out

while PopenObject.returncode == None :

PopenObject.wait()

if PopenObject.returncode != 0:

if PopenObject.returncode != 0:

EdkLogger.debug(EdkLogger.DEBUG_1, "Fail to call BPDG tool", str(error))

EdkLogger.error("BPDG", BuildToolError.COMMAND_FAILURE, "Fail to execute BPDG tool with exit code: %d, the error message is: \n %s" % \

(PopenObject.returncode, str(error)))

return PopenObject.returncode