BaseTools: Add a keyword FvNameString in FDF

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

## @file\r
# process data section generation\r
#\r
#  Copyright (c) 2007 - 2014, 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
import Section\r
from GenFdsGlobalVariable import GenFdsGlobalVariable\r
import subprocess\r
from Ffs import Ffs\r
import Common.LongFilePathOs as os\r
from CommonDataClass.FdfClass import DataSectionClassObject\r
from Common.Misc import PeImageClass\r
from Common.LongFilePathSupport import CopyLongFilePath\r
\r
## generate data section\r
#\r
#\r
class DataSection (DataSectionClassObject):\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        DataSectionClassObject.__init__(self)\r
\r
    ## GenSection() method\r
    #\r
    #   Generate compressed section\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  OutputPath  Where to place output file\r
    #   @param  ModuleName  Which module this section belongs to\r
    #   @param  SecNum      Index of section\r
    #   @param  KeyStringList  Filter for inputs of section generation\r
    #   @param  FfsInf      FfsInfStatement object that contains this section data\r
    #   @param  Dict        dictionary contains macro and its value\r
    #   @retval tuple       (Generated file name list, section alignment)\r
    #\r
    def GenSection(self, OutputPath, ModuleName, SecNum, keyStringList, FfsFile = None, Dict = {}):\r
        #\r
        # Prepare the parameter of GenSection\r
        #\r
        if FfsFile != None:\r
            self.SectFileName = GenFdsGlobalVariable.ReplaceWorkspaceMacro(self.SectFileName)\r
            self.SectFileName = GenFdsGlobalVariable.MacroExtend(self.SectFileName, Dict, FfsFile.CurrentArch)\r
        else:\r
            self.SectFileName = GenFdsGlobalVariable.ReplaceWorkspaceMacro(self.SectFileName)\r
            self.SectFileName = GenFdsGlobalVariable.MacroExtend(self.SectFileName, Dict)\r
\r
        """Check Section file exist or not !"""\r
\r
        if not os.path.exists(self.SectFileName):\r
            self.SectFileName = os.path.join (GenFdsGlobalVariable.WorkSpaceDir,\r
                                              self.SectFileName)\r
\r
        """Copy Map file to Ffs output"""\r
        Filename = GenFdsGlobalVariable.MacroExtend(self.SectFileName)\r
        if Filename[(len(Filename)-4):] == '.efi':\r
            MapFile = Filename.replace('.efi', '.map')\r
            if os.path.exists(MapFile):\r
                CopyMapFile = os.path.join(OutputPath, ModuleName + '.map')\r
                if not os.path.exists(CopyMapFile) or (os.path.getmtime(MapFile) > os.path.getmtime(CopyMapFile)):\r
                    CopyLongFilePath(MapFile, CopyMapFile)\r
\r
        #Get PE Section alignment when align is set to AUTO\r
        if self.Alignment == 'Auto' and self.SecType in ('TE', 'PE32'):\r
            ImageObj = PeImageClass (Filename)\r
            if ImageObj.SectionAlignment < 0x400:\r
                self.Alignment = str (ImageObj.SectionAlignment)\r
            else:\r
                self.Alignment = str (ImageObj.SectionAlignment / 0x400) + 'K'\r
\r
        NoStrip = True\r
        if self.SecType in ('TE', 'PE32'):\r
            if self.KeepReloc != None:\r
                NoStrip = self.KeepReloc\r
\r
        if not NoStrip:\r
            FileBeforeStrip = os.path.join(OutputPath, ModuleName + '.efi')\r
            if not os.path.exists(FileBeforeStrip) or \\r
                (os.path.getmtime(self.SectFileName) > os.path.getmtime(FileBeforeStrip)):\r
                CopyLongFilePath(self.SectFileName, FileBeforeStrip)\r
            StrippedFile = os.path.join(OutputPath, ModuleName + '.stripped')\r
            GenFdsGlobalVariable.GenerateFirmwareImage(\r
                                    StrippedFile,\r
                                    [GenFdsGlobalVariable.MacroExtend(self.SectFileName, Dict)],\r
                                    Strip=True\r
                                    )\r
            self.SectFileName = StrippedFile\r
\r
        if self.SecType == 'TE':\r
            TeFile = os.path.join( OutputPath, ModuleName + 'Te.raw')\r
            GenFdsGlobalVariable.GenerateFirmwareImage(\r
                                    TeFile,\r
                                    [GenFdsGlobalVariable.MacroExtend(self.SectFileName, Dict)],\r
                                    Type='te'\r
                                    )\r
            self.SectFileName = TeFile\r
\r
        OutputFile = os.path.join (OutputPath, ModuleName + 'SEC' + SecNum + Ffs.SectionSuffix.get(self.SecType))\r
        OutputFile = os.path.normpath(OutputFile)\r
\r
        GenFdsGlobalVariable.GenerateSection(OutputFile, [self.SectFileName], Section.Section.SectionType.get(self.SecType))\r
        FileList = [OutputFile]\r
        return FileList, self.Alignment\r