]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/GenFds/Region.py
BaseTools: refactor and remove un-needed use of .keys() on dictionaries
[mirror_edk2.git] / BaseTools / Source / Python / GenFds / Region.py
index bfa65c805484c9f40569128d264612309b8121d8..44f122a712168b4153919f1164843a99aa150975 100644 (file)
@@ -1,7 +1,7 @@
 ## @file\r
 # process FD Region generation\r
 #\r
-#  Copyright (c) 2007 - 2010, 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
 from struct import *\r
 from GenFdsGlobalVariable import GenFdsGlobalVariable\r
 import StringIO\r
+import string\r
 from CommonDataClass.FdfClass import RegionClassObject\r
-import os\r
+import Common.LongFilePathOs as os\r
 from stat import *\r
 from Common import EdkLogger\r
 from Common.BuildToolError import *\r
+from Common.LongFilePathSupport import OpenLongFilePath as open\r
+from Common.MultipleWorkspace import MultipleWorkspace as mws\r
 \r
 ## generate Region\r
 #\r
@@ -37,6 +40,25 @@ class Region(RegionClassObject):
         RegionClassObject.__init__(self)\r
 \r
 \r
+    ## PadBuffer()\r
+    #\r
+    #   Add padding bytes to the Buffer\r
+    #\r
+    #   @param Buffer         The buffer the generated region data will be put\r
+    #                         in\r
+    #   @param ErasePolarity  Flash erase polarity\r
+    #   @param Size           Number of padding bytes requested\r
+    #\r
+\r
+    def PadBuffer(self, Buffer, ErasePolarity, Size):\r
+        if Size > 0:\r
+            if (ErasePolarity == '1') :\r
+                PadByte = pack('B', 0xFF)\r
+            else:\r
+                PadByte = pack('B', 0)\r
+            PadData = ''.join(PadByte for i in xrange(0, Size))\r
+            Buffer.write(PadData)\r
+\r
     ## AddToBuffer()\r
     #\r
     #   Add region data to the Buffer\r
@@ -52,43 +74,49 @@ class Region(RegionClassObject):
     #   @retval string      Generated FV file path\r
     #\r
 \r
-    def AddToBuffer(self, Buffer, BaseAddress, BlockSizeList, ErasePolarity, ImageBinDict, vtfDict = None, MacroDict = {}):\r
+    def AddToBuffer(self, Buffer, BaseAddress, BlockSizeList, ErasePolarity, ImageBinDict, vtfDict=None, MacroDict={}, Flag=False):\r
         Size = self.Size\r
-        GenFdsGlobalVariable.InfLogger('\nGenerate Region at Offset 0x%X' % self.Offset)\r
-        GenFdsGlobalVariable.InfLogger("   Region Size = 0x%X" %Size)\r
+        if not Flag:\r
+            GenFdsGlobalVariable.InfLogger('\nGenerate Region at Offset 0x%X' % self.Offset)\r
+            GenFdsGlobalVariable.InfLogger("   Region Size = 0x%X" % Size)\r
         GenFdsGlobalVariable.SharpCounter = 0\r
+        if Flag and (self.RegionType != 'FV'):\r
+            return\r
 \r
         if self.RegionType == 'FV':\r
             #\r
             # Get Fv from FvDict\r
             #\r
             self.FvAddress = int(BaseAddress, 16) + self.Offset\r
-            FvBaseAddress  = '0x%X' %self.FvAddress\r
-            FvOffset       = 0\r
+            FvBaseAddress = '0x%X' % self.FvAddress\r
+            FvOffset = 0\r
             for RegionData in self.RegionDataList:\r
                 FileName = None\r
                 if RegionData.endswith(".fv"):\r
                     RegionData = GenFdsGlobalVariable.MacroExtend(RegionData, MacroDict)\r
-                    GenFdsGlobalVariable.InfLogger('   Region FV File Name = .fv : %s'%RegionData)\r
+                    if not Flag:\r
+                        GenFdsGlobalVariable.InfLogger('   Region FV File Name = .fv : %s' % RegionData)\r
                     if RegionData[1] != ':' :\r
-                        RegionData = os.path.join (GenFdsGlobalVariable.WorkSpaceDir, RegionData)\r
+                        RegionData = mws.join (GenFdsGlobalVariable.WorkSpaceDir, RegionData)\r
                     if not os.path.exists(RegionData):\r
                         EdkLogger.error("GenFds", FILE_NOT_FOUND, ExtraData=RegionData)\r
 \r
                     FileName = RegionData\r
-                elif RegionData.upper() + 'fv' in ImageBinDict.keys():\r
-                    GenFdsGlobalVariable.InfLogger('   Region Name = FV')\r
+                elif RegionData.upper() + 'fv' in ImageBinDict:\r
+                    if not Flag:\r
+                        GenFdsGlobalVariable.InfLogger('   Region Name = FV')\r
                     FileName = ImageBinDict[RegionData.upper() + 'fv']\r
                 else:\r
                     #\r
                     # Generate FvImage.\r
                     #\r
                     FvObj = None\r
-                    if RegionData.upper() in GenFdsGlobalVariable.FdfParser.Profile.FvDict.keys():\r
-                        FvObj = GenFdsGlobalVariable.FdfParser.Profile.FvDict.get(RegionData.upper())\r
+                    if RegionData.upper() in GenFdsGlobalVariable.FdfParser.Profile.FvDict:\r
+                        FvObj = GenFdsGlobalVariable.FdfParser.Profile.FvDict[RegionData.upper()]\r
 \r
-                    if FvObj != None :\r
-                        GenFdsGlobalVariable.InfLogger('   Region Name = FV')\r
+                    if FvObj is not None :\r
+                        if not Flag:\r
+                            GenFdsGlobalVariable.InfLogger('   Region Name = FV')\r
                         #\r
                         # Call GenFv tool\r
                         #\r
@@ -99,10 +127,13 @@ class Region(RegionClassObject):
                             EdkLogger.error("GenFds", GENFDS_ERROR,\r
                                             "FV (%s) is NOT %s Aligned!" % (FvObj.UiFvName, FvObj.FvAlignment))\r
                         FvBuffer = StringIO.StringIO('')\r
-                        FvBaseAddress = '0x%X' %self.FvAddress\r
+                        FvBaseAddress = '0x%X' % self.FvAddress\r
                         BlockSize = None\r
                         BlockNum = None\r
-                        FvObj.AddToBuffer(FvBuffer, FvBaseAddress, BlockSize, BlockNum, ErasePolarity, vtfDict)\r
+                        FvObj.AddToBuffer(FvBuffer, FvBaseAddress, BlockSize, BlockNum, ErasePolarity, vtfDict, Flag=Flag)\r
+                        if Flag:\r
+                            continue\r
+\r
                         if FvBuffer.len > Size:\r
                             FvBuffer.close()\r
                             EdkLogger.error("GenFds", GENFDS_ERROR,\r
@@ -120,26 +151,22 @@ class Region(RegionClassObject):
                 #\r
                 # Add the exist Fv image into FD buffer\r
                 #\r
-                if FileName != None:\r
-                    FileLength = os.stat(FileName)[ST_SIZE]\r
-                    if FileLength > Size:\r
-                        EdkLogger.error("GenFds", GENFDS_ERROR,\r
-                                        "Size of FV File (%s) is larger than Region Size 0x%X specified." \\r
-                                        % (RegionData, Size))\r
-                    BinFile = open (FileName, 'r+b')\r
-                    Buffer.write(BinFile.read())\r
-                    BinFile.close()\r
-                    Size = Size - FileLength\r
+                if not Flag:\r
+                    if FileName is not None:\r
+                        FileLength = os.stat(FileName)[ST_SIZE]\r
+                        if FileLength > Size:\r
+                            EdkLogger.error("GenFds", GENFDS_ERROR,\r
+                                            "Size of FV File (%s) is larger than Region Size 0x%X specified." \\r
+                                            % (RegionData, Size))\r
+                        BinFile = open(FileName, 'rb')\r
+                        Buffer.write(BinFile.read())\r
+                        BinFile.close()\r
+                        Size = Size - FileLength\r
             #\r
             # Pad the left buffer\r
             #\r
-            if Size > 0:\r
-                if (ErasePolarity == '1') :\r
-                    PadData = 0xFF\r
-                else :\r
-                    PadData = 0\r
-                for i in range(0, Size):\r
-                    Buffer.write(pack('B', PadData))\r
+            if not Flag:\r
+                self.PadBuffer(Buffer, ErasePolarity, Size)\r
 \r
         if self.RegionType == 'CAPSULE':\r
             #\r
@@ -148,14 +175,14 @@ class Region(RegionClassObject):
             for RegionData in self.RegionDataList:\r
                 if RegionData.endswith(".cap"):\r
                     RegionData = GenFdsGlobalVariable.MacroExtend(RegionData, MacroDict)\r
-                    GenFdsGlobalVariable.InfLogger('   Region CAPSULE Image Name = .cap : %s'%RegionData)\r
+                    GenFdsGlobalVariable.InfLogger('   Region CAPSULE Image Name = .cap : %s' % RegionData)\r
                     if RegionData[1] != ':' :\r
-                        RegionData = os.path.join (GenFdsGlobalVariable.WorkSpaceDir, RegionData)\r
+                        RegionData = mws.join (GenFdsGlobalVariable.WorkSpaceDir, RegionData)\r
                     if not os.path.exists(RegionData):\r
                         EdkLogger.error("GenFds", FILE_NOT_FOUND, ExtraData=RegionData)\r
 \r
                     FileName = RegionData\r
-                elif RegionData.upper() + 'cap' in ImageBinDict.keys():\r
+                elif RegionData.upper() + 'cap' in ImageBinDict:\r
                     GenFdsGlobalVariable.InfLogger('   Region Name = CAPSULE')\r
                     FileName = ImageBinDict[RegionData.upper() + 'cap']\r
                 else:\r
@@ -163,10 +190,10 @@ class Region(RegionClassObject):
                     # Generate Capsule image and Put it into FD buffer\r
                     #\r
                     CapsuleObj = None\r
-                    if RegionData.upper() in GenFdsGlobalVariable.FdfParser.Profile.CapsuleDict.keys():\r
+                    if RegionData.upper() in GenFdsGlobalVariable.FdfParser.Profile.CapsuleDict:\r
                         CapsuleObj = GenFdsGlobalVariable.FdfParser.Profile.CapsuleDict[RegionData.upper()]\r
 \r
-                    if CapsuleObj != None :\r
+                    if CapsuleObj is not None :\r
                         CapsuleObj.CapsuleName = RegionData.upper()\r
                         GenFdsGlobalVariable.InfLogger('   Region Name = CAPSULE')\r
                         #\r
@@ -185,28 +212,29 @@ class Region(RegionClassObject):
                     EdkLogger.error("GenFds", GENFDS_ERROR,\r
                                     "Size 0x%X of Capsule File (%s) is larger than Region Size 0x%X specified." \\r
                                     % (FileLength, RegionData, Size))\r
-                BinFile = open (FileName, 'r+b')\r
+                BinFile = open(FileName, 'rb')\r
                 Buffer.write(BinFile.read())\r
                 BinFile.close()\r
                 Size = Size - FileLength\r
             #\r
             # Pad the left buffer\r
             #\r
-            if Size > 0:\r
-                if (ErasePolarity == '1') :\r
-                    PadData = 0xFF\r
-                else :\r
-                    PadData = 0\r
-                for i in range(0, Size):\r
-                    Buffer.write(pack('B', PadData))\r
+            self.PadBuffer(Buffer, ErasePolarity, Size)\r
 \r
-        if self.RegionType == 'FILE':\r
+        if self.RegionType in ('FILE', 'INF'):\r
             for RegionData in self.RegionDataList:\r
-                RegionData = GenFdsGlobalVariable.MacroExtend(RegionData, MacroDict)\r
-                if RegionData[1] != ':' :\r
-                    RegionData = os.path.join (GenFdsGlobalVariable.WorkSpaceDir, RegionData)\r
-                if not os.path.exists(RegionData):\r
-                    EdkLogger.error("GenFds", FILE_NOT_FOUND, ExtraData=RegionData)\r
+                if self.RegionType == 'INF':\r
+                    RegionData.__InfParse__(None)\r
+                    if len(RegionData.BinFileList) != 1:\r
+                        EdkLogger.error('GenFds', GENFDS_ERROR, 'INF in FD region can only contain one binary: %s' % RegionData)\r
+                    File = RegionData.BinFileList[0]\r
+                    RegionData = RegionData.PatchEfiFile(File.Path, File.Type)\r
+                else:\r
+                    RegionData = GenFdsGlobalVariable.MacroExtend(RegionData, MacroDict)\r
+                    if RegionData[1] != ':' :\r
+                        RegionData = mws.join (GenFdsGlobalVariable.WorkSpaceDir, RegionData)\r
+                    if not os.path.exists(RegionData):\r
+                        EdkLogger.error("GenFds", FILE_NOT_FOUND, ExtraData=RegionData)\r
                 #\r
                 # Add the file image into FD buffer\r
                 #\r
@@ -215,21 +243,15 @@ class Region(RegionClassObject):
                     EdkLogger.error("GenFds", GENFDS_ERROR,\r
                                     "Size of File (%s) is larger than Region Size 0x%X specified." \\r
                                     % (RegionData, Size))\r
-                GenFdsGlobalVariable.InfLogger('   Region File Name = %s'%RegionData)\r
-                BinFile = open (RegionData, 'r+b')\r
+                GenFdsGlobalVariable.InfLogger('   Region File Name = %s' % RegionData)\r
+                BinFile = open(RegionData, 'rb')\r
                 Buffer.write(BinFile.read())\r
                 BinFile.close()\r
                 Size = Size - FileLength\r
             #\r
             # Pad the left buffer\r
             #\r
-            if Size > 0:\r
-                if (ErasePolarity == '1') :\r
-                    PadData = 0xFF\r
-                else :\r
-                    PadData = 0\r
-                for i in range(0, Size):\r
-                    Buffer.write(pack('B', PadData))\r
+            self.PadBuffer(Buffer, ErasePolarity, Size)\r
 \r
         if self.RegionType == 'DATA' :\r
             GenFdsGlobalVariable.InfLogger('   Region Name = DATA')\r
@@ -246,22 +268,11 @@ class Region(RegionClassObject):
             #\r
             # Pad the left buffer\r
             #\r
-            if Size > 0:\r
-                if (ErasePolarity == '1') :\r
-                    PadData = 0xFF\r
-                else :\r
-                    PadData = 0\r
-                for i in range(0, Size):\r
-                    Buffer.write(pack('B', PadData))\r
+            self.PadBuffer(Buffer, ErasePolarity, Size)\r
 \r
-        if self.RegionType == None:\r
+        if self.RegionType is None:\r
             GenFdsGlobalVariable.InfLogger('   Region Name = None')\r
-            if (ErasePolarity == '1') :\r
-                PadData = 0xFF\r
-            else :\r
-                PadData = 0\r
-            for i in range(0, Size):\r
-                Buffer.write(pack('B', PadData))\r
+            self.PadBuffer(Buffer, ErasePolarity, Size)\r
 \r
     def GetFvAlignValue(self, Str):\r
         AlignValue = 1\r
@@ -271,17 +282,17 @@ class Region(RegionClassObject):
             Granu = 1024\r
             Str = Str[:-1]\r
         elif Str.endswith('M'):\r
-            Granu = 1024*1024\r
+            Granu = 1024 * 1024\r
             Str = Str[:-1]\r
         elif Str.endswith('G'):\r
-            Granu = 1024*1024*1024\r
+            Granu = 1024 * 1024 * 1024\r
             Str = Str[:-1]\r
         else:\r
             pass\r
 \r
-        AlignValue = int(Str)*Granu\r
+        AlignValue = int(Str) * Granu\r
         return AlignValue\r
\r
+\r
     ## BlockSizeOfRegion()\r
     #\r
     #   @param  BlockSizeList        List of block information\r
@@ -302,7 +313,7 @@ class Region(RegionClassObject):
             else:\r
                 # region ended within current blocks\r
                 if self.Offset + self.Size <= End:\r
-                    ExpectedList.append((BlockSize, (RemindingSize + BlockSize - 1)/BlockSize))\r
+                    ExpectedList.append((BlockSize, (RemindingSize + BlockSize - 1) / BlockSize))\r
                     break\r
                 # region not ended yet\r
                 else:\r
@@ -311,18 +322,18 @@ class Region(RegionClassObject):
                         UsedBlockNum = BlockNum\r
                     # region started in middle of current blocks\r
                     else:\r
-                        UsedBlockNum = (End - self.Offset)/BlockSize\r
+                        UsedBlockNum = (End - self.Offset) / BlockSize\r
                     Start = End\r
                     ExpectedList.append((BlockSize, UsedBlockNum))\r
                     RemindingSize -= BlockSize * UsedBlockNum\r
-                   \r
+\r
         if FvObj.BlockSizeList == []:\r
             FvObj.BlockSizeList = ExpectedList\r
         else:\r
             # first check whether FvObj.BlockSizeList items have only "BlockSize" or "NumBlocks",\r
             # if so, use ExpectedList\r
             for Item in FvObj.BlockSizeList:\r
-                if Item[0] == None or Item[1] == None:\r
+                if Item[0] is None or Item[1] is None:\r
                     FvObj.BlockSizeList = ExpectedList\r
                     break\r
             # make sure region size is no smaller than the summed block size in FV\r
@@ -331,22 +342,22 @@ class Region(RegionClassObject):
                 Sum += Item[0] * Item[1]\r
             if self.Size < Sum:\r
                 EdkLogger.error("GenFds", GENFDS_ERROR, "Total Size of FV %s 0x%x is larger than Region Size 0x%x "\r
-                                %(FvObj.UiFvName, Sum, self.Size))\r
+                                % (FvObj.UiFvName, Sum, self.Size))\r
             # check whether the BlockStatements in FV section is appropriate\r
             ExpectedListData = ''\r
             for Item in ExpectedList:\r
-                ExpectedListData += "BlockSize = 0x%x\n\tNumBlocks = 0x%x\n\t"%Item \r
+                ExpectedListData += "BlockSize = 0x%x\n\tNumBlocks = 0x%x\n\t" % Item\r
             Index = 0\r
             for Item in FvObj.BlockSizeList:\r
                 if Item[0] != ExpectedList[Index][0]:\r
                     EdkLogger.error("GenFds", GENFDS_ERROR, "BlockStatements of FV %s are not align with FD's, suggested FV BlockStatement"\r
-                                    %FvObj.UiFvName, ExtraData = ExpectedListData)\r
+                                    % FvObj.UiFvName, ExtraData=ExpectedListData)\r
                 elif Item[1] != ExpectedList[Index][1]:\r
                     if (Item[1] < ExpectedList[Index][1]) and (Index == len(FvObj.BlockSizeList) - 1):\r
                         break;\r
                     else:\r
                         EdkLogger.error("GenFds", GENFDS_ERROR, "BlockStatements of FV %s are not align with FD's, suggested FV BlockStatement"\r
-                                        %FvObj.UiFvName, ExtraData = ExpectedListData)\r
+                                        % FvObj.UiFvName, ExtraData=ExpectedListData)\r
                 else:\r
                     Index += 1\r
 \r