BaseTools/GenFds: cleanup GenFds

[mirror_edk2.git] / BaseTools / Source / Python / GenFds / Vtf.py

## @file\r
# process VTF generation\r
#\r
#  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
#\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
# Import Modules\r
#\r
from __future__ import absolute_import\r
from .GenFdsGlobalVariable import GenFdsGlobalVariable\r
import Common.LongFilePathOs as os\r
from Common.LongFilePathSupport import OpenLongFilePath as open\r
from Common.DataType import TAB_LINE_BREAK\r
\r
## generate VTF\r
#\r
#\r
class Vtf (object):\r
\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        self.KeyArch = None\r
        self.ArchList = None\r
        self.UiName = None\r
        self.ResetBin = None\r
        self.ComponentStatementList = []\r
\r
    ## GenVtf() method\r
    #\r
    #   Generate VTF\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  FdAddressDict   dictionary contains FV name and its base address\r
    #   @retval Dict        FV and corresponding VTF file name\r
    #\r
    def GenVtf(self, FdAddressDict) :\r
        self.GenBsfInf()\r
        BaseAddArg = self.GetBaseAddressArg(FdAddressDict)\r
        OutputArg, VtfRawDict = self.GenOutputArg()\r
\r
        Cmd = (\r
            'GenVtf',\r
            ) + OutputArg + (\r
            '-f', self.BsfInfName,\r
            ) + BaseAddArg\r
\r
        GenFdsGlobalVariable.CallExternalTool(Cmd, "GenFv -Vtf Failed!")\r
        GenFdsGlobalVariable.SharpCounter = 0\r
\r
        return VtfRawDict\r
\r
    ## GenBsfInf() method\r
    #\r
    #   Generate inf used to generate VTF\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def GenBsfInf (self):\r
        FvList = self.GetFvList()\r
        self.BsfInfName = os.path.join(GenFdsGlobalVariable.FvDir, self.UiName + '.inf')\r
        BsfInf = open(self.BsfInfName, 'w+')\r
        if self.ResetBin:\r
            BsfInf.writelines ("[OPTIONS]" + TAB_LINE_BREAK)\r
            BsfInf.writelines ("IA32_RST_BIN" + \\r
                               " = " + \\r
                               GenFdsGlobalVariable.MacroExtend(GenFdsGlobalVariable.ReplaceWorkspaceMacro(self.ResetBin)) + \\r
                               TAB_LINE_BREAK)\r
            BsfInf.writelines (TAB_LINE_BREAK)\r
\r
        BsfInf.writelines ("[COMPONENTS]" + TAB_LINE_BREAK)\r
\r
        for ComponentObj in self.ComponentStatementList :\r
            BsfInf.writelines ("COMP_NAME" + \\r
                               " = " + \\r
                               ComponentObj.CompName + \\r
                               TAB_LINE_BREAK)\r
            if ComponentObj.CompLoc.upper() == 'NONE':\r
                BsfInf.writelines ("COMP_LOC" + \\r
                                   " = " + \\r
                                   'N' + \\r
                                   TAB_LINE_BREAK)\r
\r
            elif ComponentObj.FilePos:\r
                BsfInf.writelines ("COMP_LOC" + \\r
                                   " = " + \\r
                                   ComponentObj.FilePos + \\r
                                   TAB_LINE_BREAK)\r
            else:\r
                Index = FvList.index(ComponentObj.CompLoc.upper())\r
                if Index == 0:\r
                    BsfInf.writelines ("COMP_LOC" + \\r
                                       " = " + \\r
                                       'F' + \\r
                                       TAB_LINE_BREAK)\r
                elif Index == 1:\r
                    BsfInf.writelines ("COMP_LOC" + \\r
                                       " = " + \\r
                                       'S' + \\r
                                       TAB_LINE_BREAK)\r
\r
            BsfInf.writelines ("COMP_TYPE" + \\r
                               " = " + \\r
                               ComponentObj.CompType + \\r
                               TAB_LINE_BREAK)\r
            BsfInf.writelines ("COMP_VER" + \\r
                               " = " + \\r
                               ComponentObj.CompVer + \\r
                               TAB_LINE_BREAK)\r
            BsfInf.writelines ("COMP_CS" + \\r
                               " = " + \\r
                               ComponentObj.CompCs + \\r
                               TAB_LINE_BREAK)\r
\r
            BinPath = ComponentObj.CompBin\r
            if BinPath != '-':\r
                BinPath = GenFdsGlobalVariable.MacroExtend(GenFdsGlobalVariable.ReplaceWorkspaceMacro(BinPath))\r
            BsfInf.writelines ("COMP_BIN" + \\r
                               " = " + \\r
                               BinPath + \\r
                               TAB_LINE_BREAK)\r
\r
            SymPath = ComponentObj.CompSym\r
            if SymPath != '-':\r
                SymPath = GenFdsGlobalVariable.MacroExtend(GenFdsGlobalVariable.ReplaceWorkspaceMacro(SymPath))\r
            BsfInf.writelines ("COMP_SYM" + \\r
                               " = " + \\r
                               SymPath + \\r
                               TAB_LINE_BREAK)\r
            BsfInf.writelines ("COMP_SIZE" + \\r
                               " = " + \\r
                               ComponentObj.CompSize + \\r
                               TAB_LINE_BREAK)\r
            BsfInf.writelines (TAB_LINE_BREAK)\r
\r
        BsfInf.close()\r
\r
    ## GenFvList() method\r
    #\r
    #   Get FV list referenced by VTF components\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def GetFvList(self):\r
        FvList = []\r
        for component in self.ComponentStatementList :\r
            if component.CompLoc.upper() != 'NONE' and not (component.CompLoc.upper() in FvList):\r
                FvList.append(component.CompLoc.upper())\r
\r
        return FvList\r
\r
    ## GetBaseAddressArg() method\r
    #\r
    #   Get base address arguments for GenVtf\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def GetBaseAddressArg(self, FdAddressDict):\r
        FvList = self.GetFvList()\r
        CmdStr = tuple()\r
        for i in FvList:\r
            (BaseAddress, Size) = FdAddressDict.get(i)\r
            CmdStr += (\r
                '-r', '0x%x' % BaseAddress,\r
                '-s', '0x%x' % Size,\r
                )\r
        return CmdStr\r
\r
    ## GenOutputArg() method\r
    #\r
    #   Get output arguments for GenVtf\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def GenOutputArg(self):\r
        FvVtfDict = {}\r
        OutputFileName = ''\r
        FvList = self.GetFvList()\r
        Index = 0\r
        Arg = tuple()\r
        for FvObj in FvList:\r
            Index = Index + 1\r
            OutputFileName = 'Vtf%d.raw' % Index\r
            OutputFileName = os.path.join(GenFdsGlobalVariable.FvDir, OutputFileName)\r
            Arg += ('-o', OutputFileName)\r
            FvVtfDict[FvObj.upper()] = OutputFileName\r
\r
        return Arg, FvVtfDict\r
\r