BaseTools: Replace BSD License with BSD+Patent License

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

## @file\r
# process OptionROM generation\r
#\r
#  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
#\r
#  SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
\r
##\r
# Import Modules\r
#\r
from __future__ import absolute_import\r
import Common.LongFilePathOs as os\r
import subprocess\r
\r
from . import OptRomInfStatement\r
from .GenFdsGlobalVariable import GenFdsGlobalVariable\r
from CommonDataClass.FdfClass import OptionRomClassObject\r
from Common.Misc import SaveFileOnChange\r
from Common import EdkLogger\r
from Common.BuildToolError import *\r
\r
##\r
#\r
#\r
class OPTIONROM (OptionRomClassObject):\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self, Name = ""):\r
        OptionRomClassObject.__init__(self)\r
        self.DriverName = Name\r
\r
    ## AddToBuffer()\r
    #\r
    #   Generate Option ROM\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Buffer      The buffer generated OptROM data will be put\r
    #   @retval string      Generated OptROM file path\r
    #\r
    def AddToBuffer (self, Buffer, Flag=False) :\r
        if not Flag:\r
            GenFdsGlobalVariable.InfLogger( "\nGenerating %s Option ROM ..." %self.DriverName)\r
\r
        EfiFileList = []\r
        BinFileList = []\r
\r
        # Process Modules in FfsList\r
        for FfsFile in self.FfsList :\r
\r
            if isinstance(FfsFile, OptRomInfStatement.OptRomInfStatement):\r
                FilePathNameList = FfsFile.GenFfs(IsMakefile=Flag)\r
                if len(FilePathNameList) == 0:\r
                    EdkLogger.error("GenFds", GENFDS_ERROR, "Module %s not produce .efi files, so NO file could be put into option ROM." % (FfsFile.InfFileName))\r
                if FfsFile.OverrideAttribs is None:\r
                    EfiFileList.extend(FilePathNameList)\r
                else:\r
                    FileName = os.path.basename(FilePathNameList[0])\r
                    TmpOutputDir = os.path.join(GenFdsGlobalVariable.FvDir, self.DriverName, FfsFile.CurrentArch)\r
                    if not os.path.exists(TmpOutputDir) :\r
                        os.makedirs(TmpOutputDir)\r
                    TmpOutputFile = os.path.join(TmpOutputDir, FileName+'.tmp')\r
\r
                    GenFdsGlobalVariable.GenerateOptionRom(TmpOutputFile,\r
                                                           FilePathNameList,\r
                                                           [],\r
                                                           FfsFile.OverrideAttribs.NeedCompress,\r
                                                           FfsFile.OverrideAttribs.PciClassCode,\r
                                                           FfsFile.OverrideAttribs.PciRevision,\r
                                                           FfsFile.OverrideAttribs.PciDeviceId,\r
                                                           FfsFile.OverrideAttribs.PciVendorId,\r
                                                           IsMakefile = Flag)\r
                    BinFileList.append(TmpOutputFile)\r
            else:\r
                FilePathName = FfsFile.GenFfs(IsMakefile=Flag)\r
                if FfsFile.OverrideAttribs is not None:\r
                    FileName = os.path.basename(FilePathName)\r
                    TmpOutputDir = os.path.join(GenFdsGlobalVariable.FvDir, self.DriverName, FfsFile.CurrentArch)\r
                    if not os.path.exists(TmpOutputDir) :\r
                        os.makedirs(TmpOutputDir)\r
                    TmpOutputFile = os.path.join(TmpOutputDir, FileName+'.tmp')\r
\r
                    GenFdsGlobalVariable.GenerateOptionRom(TmpOutputFile,\r
                                                           [FilePathName],\r
                                                           [],\r
                                                           FfsFile.OverrideAttribs.NeedCompress,\r
                                                           FfsFile.OverrideAttribs.PciClassCode,\r
                                                           FfsFile.OverrideAttribs.PciRevision,\r
                                                           FfsFile.OverrideAttribs.PciDeviceId,\r
                                                           FfsFile.OverrideAttribs.PciVendorId,\r
                                                           IsMakefile=Flag)\r
                    BinFileList.append(TmpOutputFile)\r
                else:\r
                    if FfsFile.FileType == 'EFI':\r
                        EfiFileList.append(FilePathName)\r
                    else:\r
                        BinFileList.append(FilePathName)\r
\r
        #\r
        # Call EfiRom tool\r
        #\r
        OutputFile = os.path.join(GenFdsGlobalVariable.FvDir, self.DriverName)\r
        OutputFile = OutputFile + '.rom'\r
\r
        GenFdsGlobalVariable.GenerateOptionRom(\r
                                OutputFile,\r
                                EfiFileList,\r
                                BinFileList,\r
                                IsMakefile=Flag)\r
\r
        if not Flag:\r
            GenFdsGlobalVariable.InfLogger( "\nGenerate %s Option ROM Successfully" %self.DriverName)\r
        GenFdsGlobalVariable.SharpCounter = 0\r
\r
        return OutputFile\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