BaseTools/Source/Python/Common/VpdInfoFile.py

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