BaseTools: Replace BSD License with BSD+Patent License

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

## @file\r
# process FFS generation from FILE statement\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
from io import BytesIO\r
from struct import pack\r
from CommonDataClass.FdfClass import FileStatementClassObject\r
from Common import EdkLogger\r
from Common.BuildToolError import GENFDS_ERROR\r
from Common.Misc import GuidStructureByteArrayToGuidString, SaveFileOnChange\r
import Common.LongFilePathOs as os\r
from .GuidSection import GuidSection\r
from .FvImageSection import FvImageSection\r
from .Ffs import FdfFvFileTypeToFileType\r
from .GenFdsGlobalVariable import GenFdsGlobalVariable\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
        self.CurrentLineNum = None\r
        self.CurrentLineContent = None\r
        self.FileName = None\r
        self.InfFileName = None\r
        self.SubAlignment = None\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, IsMakefile=False, FvName=None):\r
\r
        if self.NameGuid 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
        Str = self.NameGuid\r
        if FvName:\r
            Str += FvName\r
        OutputDir = os.path.join(GenFdsGlobalVariable.FfsDir, Str)\r
        if not os.path.exists(OutputDir):\r
            os.makedirs(OutputDir)\r
\r
        Dict.update(self.DefineVarDict)\r
        SectionAlignments = None\r
        if self.FvName:\r
            Buffer = BytesIO()\r
            if self.FvName.upper() not in GenFdsGlobalVariable.FdfParser.Profile.FvDict:\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:\r
            if self.FdName.upper() not in GenFdsGlobalVariable.FdfParser.Profile.FdDict:\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:\r
            if hasattr(self, 'FvFileType') and self.FvFileType == 'RAW':\r
                if isinstance(self.FileName, list) and isinstance(self.SubAlignment, list) and len(self.FileName) == len(self.SubAlignment):\r
                    FileContent = BytesIO()\r
                    MaxAlignIndex = 0\r
                    MaxAlignValue = 1\r
                    for Index, File in enumerate(self.FileName):\r
                        try:\r
                            f = open(File, 'rb')\r
                        except:\r
                            GenFdsGlobalVariable.ErrorLogger("Error opening RAW file %s." % (File))\r
                        Content = f.read()\r
                        f.close()\r
                        AlignValue = 1\r
                        if self.SubAlignment[Index]:\r
                            AlignValue = GenFdsGlobalVariable.GetAlignment(self.SubAlignment[Index])\r
                        if AlignValue > MaxAlignValue:\r
                            MaxAlignIndex = Index\r
                            MaxAlignValue = AlignValue\r
                        FileContent.write(Content)\r
                        if len(FileContent.getvalue()) % AlignValue != 0:\r
                            Size = AlignValue - len(FileContent.getvalue()) % AlignValue\r
                            for i in range(0, Size):\r
                                FileContent.write(pack('B', 0xFF))\r
\r
                    if FileContent.getvalue() != b'':\r
                        OutputRAWFile = os.path.join(GenFdsGlobalVariable.FfsDir, self.NameGuid, self.NameGuid + '.raw')\r
                        SaveFileOnChange(OutputRAWFile, FileContent.getvalue(), True)\r
                        self.FileName = OutputRAWFile\r
                        self.SubAlignment = self.SubAlignment[MaxAlignIndex]\r
\r
                if self.Alignment and self.SubAlignment:\r
                    if GenFdsGlobalVariable.GetAlignment (self.Alignment) < GenFdsGlobalVariable.GetAlignment (self.SubAlignment):\r
                        self.Alignment = self.SubAlignment\r
                elif self.SubAlignment:\r
                    self.Alignment = self.SubAlignment\r
\r
            self.FileName = GenFdsGlobalVariable.ReplaceWorkspaceMacro(self.FileName)\r
            #Replace $(SAPCE) with real space\r
            self.FileName = self.FileName.replace('$(SPACE)', ' ')\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 and isinstance(section, GuidSection):\r
                    section.FvParentAddr = FvParentAddr\r
\r
                if self.KeepReloc == False:\r
                    section.KeepReloc = False\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
                                         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