BaseTools: Move OverrideAttribs to OptRomInfStatement.py

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

## @file\r
# process OptionROM generation from INF statement\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 . import RuleSimpleFile\r
from . import RuleComplexFile\r
from . import Section\r
import Common.GlobalData as GlobalData\r
\r
from Common.DataType import *\r
from Common.StringUtils import *\r
from .FfsInfStatement import FfsInfStatement\r
from .GenFdsGlobalVariable import GenFdsGlobalVariable\r
\r
##\r
#\r
#\r
class OptRomInfStatement (FfsInfStatement):\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        FfsInfStatement.__init__(self)\r
        self.OverrideAttribs = None\r
\r
    ## __GetOptRomParams() method\r
    #\r
    #   Parse inf file to get option ROM related parameters\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __GetOptRomParams(self):\r
        if self.OverrideAttribs is None:\r
            self.OverrideAttribs = OverrideAttribs()\r
\r
        if self.OverrideAttribs.NeedCompress is None:\r
            self.OverrideAttribs.NeedCompress = self.OptRomDefs.get ('PCI_COMPRESS')\r
            if self.OverrideAttribs.NeedCompress is not None:\r
                if self.OverrideAttribs.NeedCompress.upper() not in ('TRUE', 'FALSE'):\r
                    GenFdsGlobalVariable.ErrorLogger( "Expected TRUE/FALSE for PCI_COMPRESS: %s" %self.InfFileName)\r
                self.OverrideAttribs.NeedCompress = \\r
                    self.OverrideAttribs.NeedCompress.upper() == 'TRUE'\r
\r
        if self.OverrideAttribs.PciVendorId is None:\r
            self.OverrideAttribs.PciVendorId = self.OptRomDefs.get ('PCI_VENDOR_ID')\r
\r
        if self.OverrideAttribs.PciClassCode is None:\r
            self.OverrideAttribs.PciClassCode = self.OptRomDefs.get ('PCI_CLASS_CODE')\r
\r
        if self.OverrideAttribs.PciDeviceId is None:\r
            self.OverrideAttribs.PciDeviceId = self.OptRomDefs.get ('PCI_DEVICE_ID')\r
\r
        if self.OverrideAttribs.PciRevision is None:\r
            self.OverrideAttribs.PciRevision = self.OptRomDefs.get ('PCI_REVISION')\r
\r
#        InfObj = GenFdsGlobalVariable.WorkSpace.BuildObject[self.PathClassObj, self.CurrentArch]\r
#        RecordList = InfObj._RawData[MODEL_META_DATA_HEADER, InfObj._Arch, InfObj._Platform]\r
#        for Record in RecordList:\r
#            Record = ReplaceMacros(Record, GlobalData.gEdkGlobal, False)\r
#            Name = Record[0]\r
    ## GenFfs() method\r
    #\r
    #   Generate FFS\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval string      Generated .efi file name\r
    #\r
    def GenFfs(self, IsMakefile=False):\r
        #\r
        # Parse Inf file get Module related information\r
        #\r
\r
        self.__InfParse__()\r
        self.__GetOptRomParams()\r
        #\r
        # Get the rule of how to generate Ffs file\r
        #\r
        Rule = self.__GetRule__()\r
        GenFdsGlobalVariable.VerboseLogger( "Packing binaries from inf file : %s" %self.InfFileName)\r
        #\r
        # For the rule only has simpleFile\r
        #\r
        if isinstance (Rule, RuleSimpleFile.RuleSimpleFile) :\r
            EfiOutputList = self.__GenSimpleFileSection__(Rule, IsMakefile=IsMakefile)\r
            return EfiOutputList\r
        #\r
        # For Rule has ComplexFile\r
        #\r
        elif isinstance(Rule, RuleComplexFile.RuleComplexFile):\r
            EfiOutputList = self.__GenComplexFileSection__(Rule, IsMakefile=IsMakefile)\r
            return EfiOutputList\r
\r
    ## __GenSimpleFileSection__() method\r
    #\r
    #   Get .efi files according to simple rule.\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Rule        The rule object used to generate section\r
    #   @retval string      File name of the generated section file\r
    #\r
    def __GenSimpleFileSection__(self, Rule, IsMakefile = False):\r
        #\r
        # Prepare the parameter of GenSection\r
        #\r
\r
        OutputFileList = []\r
        if Rule.FileName is not None:\r
            GenSecInputFile = self.__ExtendMacro__(Rule.FileName)\r
            OutputFileList.append(GenSecInputFile)\r
        else:\r
            OutputFileList, IsSect = Section.Section.GetFileList(self, '', Rule.FileExtension)\r
\r
        return OutputFileList\r
\r
\r
    ## __GenComplexFileSection__() method\r
    #\r
    #   Get .efi by sections in complex Rule\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Rule        The rule object used to generate section\r
    #   @retval string      File name of the generated section file\r
    #\r
    def __GenComplexFileSection__(self, Rule, IsMakefile=False):\r
\r
        OutputFileList = []\r
        for Sect in Rule.SectionList:\r
            if Sect.SectionType == BINARY_FILE_TYPE_PE32:\r
                if Sect.FileName is not None:\r
                    GenSecInputFile = self.__ExtendMacro__(Sect.FileName)\r
                    OutputFileList.append(GenSecInputFile)\r
                else:\r
                    FileList, IsSect = Section.Section.GetFileList(self, '', Sect.FileExtension)\r
                    OutputFileList.extend(FileList)\r
\r
        return OutputFileList\r
\r
class OverrideAttribs:\r
\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
\r
        self.PciVendorId = None\r
        self.PciClassCode = None\r
        self.PciDeviceId = None\r
        self.PciRevision = None\r
        self.NeedCompress = None\r