Sync EDKII BaseTools to BaseTools project r1903.

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

## @file\r
# process FFS generation from FILE statement\r
#\r
#  Copyright (c) 2007 - 2010, Intel Corporation\r
#\r
#  All rights reserved. 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 Ffs\r
import Rule\r
import os\r
import StringIO\r
import subprocess\r
\r
from GenFdsGlobalVariable import GenFdsGlobalVariable\r
from CommonDataClass.FdfClass import FileStatementClassObject\r
from Common import EdkLogger\r
from Common.BuildToolError import *\r
from Common.Misc import GuidStructureByteArrayToGuidString\r
from GuidSection import GuidSection\r
from FvImageSection import FvImageSection\r
\r
## generate FFS from FILE\r
#\r
#\r
class FileStatement (FileStatementClassObject) :\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        FileStatementClassObject.__init__(self)\r
\r
    ## GenFfs() method\r
    #\r
    #   Generate FFS\r
    #\r
    #   @param  self         The object pointer\r
    #   @param  Dict         dictionary contains macro and value pair\r
    #   @param  FvChildAddr  Array of the inside FvImage base address\r
    #   @param  FvParentAddr Parent Fv base address\r
    #   @retval string       Generated FFS file name\r
    #\r
    def GenFfs(self, Dict = {}, FvChildAddr=[], FvParentAddr=None):\r
        \r
        if self.NameGuid != None and self.NameGuid.startswith('PCD('):\r
            PcdValue = GenFdsGlobalVariable.GetPcdValue(self.NameGuid)\r
            if len(PcdValue) == 0:\r
                EdkLogger.error("GenFds", GENFDS_ERROR, '%s NOT defined.' \\r
                            % (self.NameGuid))\r
            if PcdValue.startswith('{'):\r
                PcdValue = GuidStructureByteArrayToGuidString(PcdValue)\r
            RegistryGuidStr = PcdValue\r
            if len(RegistryGuidStr) == 0:\r
                EdkLogger.error("GenFds", GENFDS_ERROR, 'GUID value for %s in wrong format.' \\r
                            % (self.NameGuid))\r
            self.NameGuid = RegistryGuidStr\r
        \r
        OutputDir = os.path.join(GenFdsGlobalVariable.FfsDir, self.NameGuid)\r
        if not os.path.exists(OutputDir):\r
             os.makedirs(OutputDir)\r
\r
        Dict.update(self.DefineVarDict)\r
        SectionAlignments = None\r
        if self.FvName != None :\r
            Buffer = StringIO.StringIO('')\r
            if self.FvName.upper() not in GenFdsGlobalVariable.FdfParser.Profile.FvDict.keys():\r
                EdkLogger.error("GenFds", GENFDS_ERROR, "FV (%s) is NOT described in FDF file!" % (self.FvName))\r
            Fv = GenFdsGlobalVariable.FdfParser.Profile.FvDict.get(self.FvName.upper())\r
            FileName = Fv.AddToBuffer(Buffer)\r
            SectionFiles = [FileName]\r
\r
        elif self.FdName != None:\r
            if self.FdName.upper() not in GenFdsGlobalVariable.FdfParser.Profile.FdDict.keys():\r
                EdkLogger.error("GenFds", GENFDS_ERROR, "FD (%s) is NOT described in FDF file!" % (self.FdName))\r
            Fd = GenFdsGlobalVariable.FdfParser.Profile.FdDict.get(self.FdName.upper())\r
            FileName = Fd.GenFd()\r
            SectionFiles = [FileName]\r
\r
        elif self.FileName != None:\r
            self.FileName = GenFdsGlobalVariable.ReplaceWorkspaceMacro(self.FileName)\r
            SectionFiles = [GenFdsGlobalVariable.MacroExtend(self.FileName, Dict)]\r
\r
        else:\r
            SectionFiles = []\r
            Index = 0\r
            SectionAlignments = []\r
            for section in self.SectionList :\r
                Index = Index + 1\r
                SecIndex = '%d' %Index\r
                # process the inside FvImage from FvSection or GuidSection\r
                if FvChildAddr != []:\r
                    if isinstance(section, FvImageSection):\r
                        section.FvAddr = FvChildAddr.pop(0)\r
                    elif isinstance(section, GuidSection):\r
                        section.FvAddr = FvChildAddr\r
                if FvParentAddr != None and isinstance(section, GuidSection):\r
                    section.FvParentAddr = FvParentAddr\r
\r
                sectList, align = section.GenSection(OutputDir, self.NameGuid, SecIndex, self.KeyStringList, None, Dict)\r
                if sectList != []:\r
                    for sect in sectList:\r
                        SectionFiles.append(sect)\r
                        SectionAlignments.append(align)\r
\r
        #\r
        # Prepare the parameter\r
        #\r
        FfsFileOutput = os.path.join(OutputDir, self.NameGuid + '.ffs')\r
        GenFdsGlobalVariable.GenerateFfs(FfsFileOutput, SectionFiles,\r
                                         Ffs.Ffs.FdfFvFileTypeToFileType.get(self.FvFileType),\r
                                         self.NameGuid,\r
                                         Fixed=self.Fixed,\r
                                         CheckSum=self.CheckSum,\r
                                         Align=self.Alignment,\r
                                         SectionAlign=SectionAlignments\r
                                        )\r
\r
        return FfsFileOutput\r
\r
\r
\r