]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/GenFds/EfiSection.py
BaseTools:Make BaseTools support new rules to generate RAW FFS FILE
[mirror_edk2.git] / BaseTools / Source / Python / GenFds / EfiSection.py
index 5419e11fce9a8062ac6a97da6602ff098068c0ba..74f176cfef2f9833169f1c2b7994ee1c2385ff71 100644 (file)
@@ -1,31 +1,28 @@
 ## @file\r
 # process rule section generation\r
 #\r
-#  Copyright (c) 2007, Intel Corporation. All rights reserved.<BR>\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
+#  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 #\r
 \r
 ##\r
 # Import Modules\r
 #\r
+from __future__ import absolute_import\r
 from struct import *\r
-import Section\r
-from GenFdsGlobalVariable import GenFdsGlobalVariable\r
+from . import Section\r
+from .GenFdsGlobalVariable import GenFdsGlobalVariable\r
 import subprocess\r
-from Ffs import Ffs\r
-import os\r
+from .Ffs import SectionSuffix\r
+import Common.LongFilePathOs as os\r
 from CommonDataClass.FdfClass import EfiSectionClassObject\r
-import shutil\r
 from Common import EdkLogger\r
 from Common.BuildToolError import *\r
 from Common.Misc import PeImageClass\r
+from Common.LongFilePathSupport import OpenLongFilePath as open\r
+from Common.LongFilePathSupport import CopyLongFilePath\r
+from Common.DataType import *\r
 \r
 ## generate rule section\r
 #\r
@@ -52,100 +49,108 @@ class EfiSection (EfiSectionClassObject):
     #   @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, FfsInf = None, Dict = {}) :\r
-        \r
-        if self.FileName != None and self.FileName.startswith('PCD('):\r
+    def GenSection(self, OutputPath, ModuleName, SecNum, KeyStringList, FfsInf = None, Dict = {}, IsMakefile = False) :\r
+\r
+        if self.FileName is not None and self.FileName.startswith('PCD('):\r
             self.FileName = GenFdsGlobalVariable.GetPcdValue(self.FileName)\r
         """Prepare the parameter of GenSection"""\r
-        if FfsInf != None :\r
+        if FfsInf is not None :\r
             InfFileName = FfsInf.InfFileName\r
             SectionType = FfsInf.__ExtendMacro__(self.SectionType)\r
             Filename = FfsInf.__ExtendMacro__(self.FileName)\r
             BuildNum = FfsInf.__ExtendMacro__(self.BuildNum)\r
             StringData = FfsInf.__ExtendMacro__(self.StringData)\r
+            ModuleNameStr = FfsInf.__ExtendMacro__('$(MODULE_NAME)')\r
             NoStrip = True\r
-            if FfsInf.ModuleType in ('SEC', 'PEI_CORE', 'PEIM') and SectionType in ('TE', 'PE32'):\r
-                if FfsInf.KeepReloc != None:\r
+            if FfsInf.ModuleType in (SUP_MODULE_SEC, SUP_MODULE_PEI_CORE, SUP_MODULE_PEIM, SUP_MODULE_MM_CORE_STANDALONE) and SectionType in (BINARY_FILE_TYPE_TE, BINARY_FILE_TYPE_PE32):\r
+                if FfsInf.KeepReloc is not None:\r
                     NoStrip = FfsInf.KeepReloc\r
-                elif FfsInf.KeepRelocFromRule != None:\r
+                elif FfsInf.KeepRelocFromRule is not None:\r
                     NoStrip = FfsInf.KeepRelocFromRule\r
-                elif self.KeepReloc != None:\r
+                elif self.KeepReloc is not None:\r
                     NoStrip = self.KeepReloc\r
-                elif FfsInf.ShadowFromInfFile != None:\r
+                elif FfsInf.ShadowFromInfFile is not None:\r
                     NoStrip = FfsInf.ShadowFromInfFile\r
         else:\r
             EdkLogger.error("GenFds", GENFDS_ERROR, "Module %s apply rule for None!" %ModuleName)\r
 \r
         """If the file name was pointed out, add it in FileList"""\r
         FileList = []\r
-        if Filename != None:\r
+        if Filename is not None:\r
             Filename = GenFdsGlobalVariable.MacroExtend(Filename, Dict)\r
-            # check if the path is absolute or relative
-            if os.path.isabs(Filename):
-                Filename = os.path.normpath(Filename)
-            else:
-                Filename = os.path.normpath(os.path.join(FfsInf.EfiOutputPath, Filename))
+            # check if the path is absolute or relative\r
+            if os.path.isabs(Filename):\r
+                Filename = os.path.normpath(Filename)\r
+            else:\r
+                Filename = os.path.normpath(os.path.join(FfsInf.EfiOutputPath, Filename))\r
 \r
             if not self.Optional:\r
                 FileList.append(Filename)\r
             elif os.path.exists(Filename):\r
                 FileList.append(Filename)\r
+            elif IsMakefile:\r
+                SuffixMap = FfsInf.GetFinalTargetSuffixMap()\r
+                if '.depex' in SuffixMap:\r
+                    FileList.append(Filename)\r
         else:\r
-            FileList, IsSect = Section.Section.GetFileList(FfsInf, self.FileType, self.FileExtension, Dict)\r
+            FileList, IsSect = Section.Section.GetFileList(FfsInf, self.FileType, self.FileExtension, Dict, IsMakefile=IsMakefile, SectionType=SectionType)\r
             if IsSect :\r
                 return FileList, self.Alignment\r
 \r
         Index = 0\r
+        Align = self.Alignment\r
 \r
         """ If Section type is 'VERSION'"""\r
         OutputFileList = []\r
         if SectionType == 'VERSION':\r
 \r
             InfOverrideVerString = False\r
-            if FfsInf.Version != None:\r
+            if FfsInf.Version is not None:\r
                 #StringData = FfsInf.Version\r
                 BuildNum = FfsInf.Version\r
                 InfOverrideVerString = True\r
 \r
             if InfOverrideVerString:\r
                 #VerTuple = ('-n', '"' + StringData + '"')\r
-                if BuildNum != None and BuildNum != '':\r
+                if BuildNum is not None and BuildNum != '':\r
                     BuildNumTuple = ('-j', BuildNum)\r
                 else:\r
                     BuildNumTuple = tuple()\r
 \r
                 Num = SecNum\r
-                OutputFile = os.path.join( OutputPath, ModuleName + 'SEC' + str(Num) + Ffs.SectionSuffix.get(SectionType))\r
+                OutputFile = os.path.join( OutputPath, ModuleName + SUP_MODULE_SEC + str(Num) + SectionSuffix.get(SectionType))\r
                 GenFdsGlobalVariable.GenerateSection(OutputFile, [], 'EFI_SECTION_VERSION',\r
-                                                     #Ui=StringData, \r
-                                                     Ver=BuildNum)\r
+                                                    #Ui=StringData,\r
+                                                    Ver=BuildNum,\r
+                                                    IsMakefile=IsMakefile)\r
                 OutputFileList.append(OutputFile)\r
 \r
             elif FileList != []:\r
                 for File in FileList:\r
                     Index = Index + 1\r
-                    Num = '%s.%d' %(SecNum , Index)\r
-                    OutputFile = os.path.join(OutputPath, ModuleName + 'SEC' + Num + Ffs.SectionSuffix.get(SectionType))\r
+                    Num = '%s.%d' %(SecNum, Index)\r
+                    OutputFile = os.path.join(OutputPath, ModuleName + SUP_MODULE_SEC + Num + SectionSuffix.get(SectionType))\r
                     f = open(File, 'r')\r
                     VerString = f.read()\r
                     f.close()\r
                     BuildNum = VerString\r
-                    if BuildNum != None and BuildNum != '':\r
+                    if BuildNum is not None and BuildNum != '':\r
                         BuildNumTuple = ('-j', BuildNum)\r
                     GenFdsGlobalVariable.GenerateSection(OutputFile, [], 'EFI_SECTION_VERSION',\r
-                                                         #Ui=VerString, \r
-                                                         Ver=BuildNum)\r
+                                                        #Ui=VerString,\r
+                                                        Ver=BuildNum,\r
+                                                        IsMakefile=IsMakefile)\r
                     OutputFileList.append(OutputFile)\r
 \r
             else:\r
                 BuildNum = StringData\r
-                if BuildNum != None and BuildNum != '':\r
+                if BuildNum is not None and BuildNum != '':\r
                     BuildNumTuple = ('-j', BuildNum)\r
                 else:\r
                     BuildNumTuple = tuple()\r
                 BuildNumString = ' ' + ' '.join(BuildNumTuple)\r
 \r
-                #if VerString == '' and \r
+                #if VerString == '' and\r
                 if BuildNumString == '':\r
                     if self.Optional == True :\r
                         GenFdsGlobalVariable.VerboseLogger( "Optional Section don't exist!")\r
@@ -153,42 +158,47 @@ class EfiSection (EfiSectionClassObject):
                     else:\r
                         EdkLogger.error("GenFds", GENFDS_ERROR, "File: %s miss Version Section value" %InfFileName)\r
                 Num = SecNum\r
-                OutputFile = os.path.join( OutputPath, ModuleName + 'SEC' + str(Num) + Ffs.SectionSuffix.get(SectionType))\r
+                OutputFile = os.path.join( OutputPath, ModuleName + SUP_MODULE_SEC + str(Num) + SectionSuffix.get(SectionType))\r
                 GenFdsGlobalVariable.GenerateSection(OutputFile, [], 'EFI_SECTION_VERSION',\r
-                                                     #Ui=VerString, \r
-                                                     Ver=BuildNum)\r
+                                                    #Ui=VerString,\r
+                                                    Ver=BuildNum,\r
+                                                    IsMakefile=IsMakefile)\r
                 OutputFileList.append(OutputFile)\r
 \r
         #\r
-        # If Section Type is 'UI'\r
+        # If Section Type is BINARY_FILE_TYPE_UI\r
         #\r
-        elif SectionType == 'UI':\r
+        elif SectionType == BINARY_FILE_TYPE_UI:\r
 \r
             InfOverrideUiString = False\r
-            if FfsInf.Ui != None:\r
+            if FfsInf.Ui is not None:\r
                 StringData = FfsInf.Ui\r
                 InfOverrideUiString = True\r
 \r
             if InfOverrideUiString:\r
                 Num = SecNum\r
-                OutputFile = os.path.join( OutputPath, ModuleName + 'SEC' + str(Num) + Ffs.SectionSuffix.get(SectionType))\r
+                if IsMakefile and StringData == ModuleNameStr:\r
+                    StringData = "$(MODULE_NAME)"\r
+                OutputFile = os.path.join( OutputPath, ModuleName + SUP_MODULE_SEC + str(Num) + SectionSuffix.get(SectionType))\r
                 GenFdsGlobalVariable.GenerateSection(OutputFile, [], 'EFI_SECTION_USER_INTERFACE',\r
-                                                     Ui=StringData)\r
+                                                     Ui=StringData, IsMakefile=IsMakefile)\r
                 OutputFileList.append(OutputFile)\r
 \r
             elif FileList != []:\r
                 for File in FileList:\r
                     Index = Index + 1\r
-                    Num = '%s.%d' %(SecNum , Index)\r
-                    OutputFile = os.path.join(OutputPath, ModuleName + 'SEC' + Num + Ffs.SectionSuffix.get(SectionType))\r
+                    Num = '%s.%d' %(SecNum, Index)\r
+                    OutputFile = os.path.join(OutputPath, ModuleName + SUP_MODULE_SEC + Num + SectionSuffix.get(SectionType))\r
                     f = open(File, 'r')\r
                     UiString = f.read()\r
                     f.close()\r
+                    if IsMakefile and UiString == ModuleNameStr:\r
+                        UiString = "$(MODULE_NAME)"\r
                     GenFdsGlobalVariable.GenerateSection(OutputFile, [], 'EFI_SECTION_USER_INTERFACE',\r
-                                                         Ui=UiString)\r
+                                                        Ui=UiString, IsMakefile=IsMakefile)\r
                     OutputFileList.append(OutputFile)\r
             else:\r
-                if StringData != None and len(StringData) > 0:\r
+                if StringData is not None and len(StringData) > 0:\r
                     UiTuple = ('-n', '"' + StringData + '"')\r
                 else:\r
                     UiTuple = tuple()\r
@@ -200,75 +210,114 @@ class EfiSection (EfiSectionClassObject):
                         EdkLogger.error("GenFds", GENFDS_ERROR, "File: %s miss UI Section value" %InfFileName)\r
 \r
                 Num = SecNum\r
-                OutputFile = os.path.join( OutputPath, ModuleName + 'SEC' + str(Num) + Ffs.SectionSuffix.get(SectionType))\r
+                if IsMakefile and StringData == ModuleNameStr:\r
+                    StringData = "$(MODULE_NAME)"\r
+                OutputFile = os.path.join( OutputPath, ModuleName + SUP_MODULE_SEC + str(Num) + SectionSuffix.get(SectionType))\r
                 GenFdsGlobalVariable.GenerateSection(OutputFile, [], 'EFI_SECTION_USER_INTERFACE',\r
-                                                     Ui=StringData)\r
+                                                     Ui=StringData, IsMakefile=IsMakefile)\r
                 OutputFileList.append(OutputFile)\r
 \r
+        #\r
+        # If Section Type is BINARY_FILE_TYPE_RAW\r
+        #\r
+        elif SectionType == BINARY_FILE_TYPE_RAW:\r
+            """If File List is empty"""\r
+            if FileList == []:\r
+                if self.Optional == True:\r
+                    GenFdsGlobalVariable.VerboseLogger("Optional Section don't exist!")\r
+                    return [], None\r
+                else:\r
+                    EdkLogger.error("GenFds", GENFDS_ERROR, "Output file for %s section could not be found for %s" % (SectionType, InfFileName))\r
+\r
+            elif len(FileList) > 1:\r
+                EdkLogger.error("GenFds", GENFDS_ERROR,\r
+                                "Files suffixed with %s are not allowed to have more than one file in %s[Binaries] section" % (\r
+                                self.FileExtension, InfFileName))\r
+            else:\r
+                for File in FileList:\r
+                    File = GenFdsGlobalVariable.MacroExtend(File, Dict)\r
+                    OutputFileList.append(File)\r
 \r
         else:\r
             """If File List is empty"""\r
             if FileList == [] :\r
                 if self.Optional == True:\r
-                     GenFdsGlobalVariable.VerboseLogger( "Optional Section don't exist!")\r
-                     return [], None\r
+                    GenFdsGlobalVariable.VerboseLogger("Optional Section don't exist!")\r
+                    return [], None\r
                 else:\r
-                     EdkLogger.error("GenFds", GENFDS_ERROR, "Output file for %s section could not be found for %s" % (SectionType, InfFileName))\r
+                    EdkLogger.error("GenFds", GENFDS_ERROR, "Output file for %s section could not be found for %s" % (SectionType, InfFileName))\r
 \r
             else:\r
                 """Convert the File to Section file one by one """\r
                 for File in FileList:\r
                     """ Copy Map file to FFS output path """\r
                     Index = Index + 1\r
-                    Num = '%s.%d' %(SecNum , Index)\r
-                    OutputFile = os.path.join( OutputPath, ModuleName + 'SEC' + Num + Ffs.SectionSuffix.get(SectionType))\r
+                    Num = '%s.%d' %(SecNum, Index)\r
+                    OutputFile = os.path.join( OutputPath, ModuleName + SUP_MODULE_SEC + Num + SectionSuffix.get(SectionType))\r
                     File = GenFdsGlobalVariable.MacroExtend(File, Dict)\r
-                    \r
+\r
                     #Get PE Section alignment when align is set to AUTO\r
-                    if self.Alignment == 'Auto' and (SectionType == 'PE32' or SectionType == 'TE'):\r
+                    if self.Alignment == 'Auto' and (SectionType == BINARY_FILE_TYPE_PE32 or SectionType == BINARY_FILE_TYPE_TE):\r
                         ImageObj = PeImageClass (File)\r
                         if ImageObj.SectionAlignment < 0x400:\r
-                            self.Alignment = str (ImageObj.SectionAlignment)\r
+                            Align = str (ImageObj.SectionAlignment)\r
+                        elif ImageObj.SectionAlignment < 0x100000:\r
+                            Align = str (ImageObj.SectionAlignment // 0x400) + 'K'\r
                         else:\r
-                            self.Alignment = str (ImageObj.SectionAlignment / 0x400) + 'K'\r
+                            Align = str (ImageObj.SectionAlignment // 0x100000) + 'M'\r
 \r
                     if File[(len(File)-4):] == '.efi':\r
                         MapFile = File.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 \\r
-                                (os.path.getmtime(MapFile) > os.path.getmtime(CopyMapFile)):\r
-                                shutil.copyfile(MapFile, CopyMapFile)\r
+                        CopyMapFile = os.path.join(OutputPath, ModuleName + '.map')\r
+                        if IsMakefile:\r
+                            if GenFdsGlobalVariable.CopyList == []:\r
+                                GenFdsGlobalVariable.CopyList = [(MapFile, CopyMapFile)]\r
+                            else:\r
+                                GenFdsGlobalVariable.CopyList.append((MapFile, CopyMapFile))\r
+                        else:\r
+                            if os.path.exists(MapFile):\r
+                                if not os.path.exists(CopyMapFile) or \\r
+                                       (os.path.getmtime(MapFile) > os.path.getmtime(CopyMapFile)):\r
+                                    CopyLongFilePath(MapFile, CopyMapFile)\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(File) > os.path.getmtime(FileBeforeStrip)):\r
-                            shutil.copyfile(File, FileBeforeStrip)\r
+                        if IsMakefile:\r
+                            if GenFdsGlobalVariable.CopyList == []:\r
+                                GenFdsGlobalVariable.CopyList = [(File, FileBeforeStrip)]\r
+                            else:\r
+                                GenFdsGlobalVariable.CopyList.append((File, FileBeforeStrip))\r
+                        else:\r
+                            if not os.path.exists(FileBeforeStrip) or \\r
+                                (os.path.getmtime(File) > os.path.getmtime(FileBeforeStrip)):\r
+                                CopyLongFilePath(File, FileBeforeStrip)\r
                         StrippedFile = os.path.join(OutputPath, ModuleName + '.stripped')\r
                         GenFdsGlobalVariable.GenerateFirmwareImage(\r
-                                                StrippedFile,\r
-                                                [File],\r
-                                                Strip=True\r
-                                                )\r
+                                StrippedFile,\r
+                                [File],\r
+                                Strip=True,\r
+                                IsMakefile = IsMakefile\r
+                            )\r
                         File = StrippedFile\r
-                    \r
+\r
                     """For TE Section call GenFw to generate TE image"""\r
 \r
-                    if SectionType == 'TE':\r
+                    if SectionType == BINARY_FILE_TYPE_TE:\r
                         TeFile = os.path.join( OutputPath, ModuleName + 'Te.raw')\r
                         GenFdsGlobalVariable.GenerateFirmwareImage(\r
-                                                TeFile,\r
-                                                [File],\r
-                                                Type='te'\r
-                                                )\r
+                                TeFile,\r
+                                [File],\r
+                                Type='te',\r
+                                IsMakefile = IsMakefile\r
+                            )\r
                         File = TeFile\r
 \r
                     """Call GenSection"""\r
                     GenFdsGlobalVariable.GenerateSection(OutputFile,\r
-                                                         [File],\r
-                                                         Section.Section.SectionType.get (SectionType)\r
-                                                         )\r
+                                                        [File],\r
+                                                        Section.Section.SectionType.get (SectionType),\r
+                                                        IsMakefile=IsMakefile\r
+                                                        )\r
                     OutputFileList.append(OutputFile)\r
 \r
-        return OutputFileList, self.Alignment\r
+        return OutputFileList, Align\r