]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/GenFds/Region.py
BaseTools: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / BaseTools / Source / Python / GenFds / Region.py
index c946758cf549cf7914d8af9c6d9468fb8064e5e6..7d5a3ab1737a52f77d0bf465df1073ef80cc4a3f 100644 (file)
@@ -1,44 +1,44 @@
 ## @file\r
 # process FD Region generation\r
 #\r
-#  Copyright (c) 2007 - 2017, 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
-from GenFdsGlobalVariable import GenFdsGlobalVariable\r
-import StringIO\r
+from .GenFdsGlobalVariable import GenFdsGlobalVariable\r
+from io import BytesIO\r
 import string\r
-from CommonDataClass.FdfClass import RegionClassObject\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
+from Common.DataType import BINARY_FILE_TYPE_FV\r
 \r
 ## generate Region\r
 #\r
 #\r
-class Region(RegionClassObject):\r
+class Region(object):\r
 \r
     ## The constructor\r
     #\r
     #   @param  self        The object pointer\r
     #\r
     def __init__(self):\r
-        RegionClassObject.__init__(self)\r
-\r
+        self.Offset = None       # The begin position of the Region\r
+        self.Size = None         # The Size of the Region\r
+        self.PcdOffset = None\r
+        self.PcdSize = None\r
+        self.SetVarDict = {}\r
+        self.RegionType = None\r
+        self.RegionDataList = []\r
 \r
     ## PadBuffer()\r
     #\r
@@ -56,8 +56,8 @@ class Region(RegionClassObject):
                 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
+            for i in range(0, Size):\r
+                Buffer.write(PadByte)\r
 \r
     ## AddToBuffer()\r
     #\r
@@ -69,21 +69,20 @@ class Region(RegionClassObject):
     #   @param  BlockSize   block size of region\r
     #   @param  BlockNum    How many blocks in region\r
     #   @param  ErasePolarity      Flash erase polarity\r
-    #   @param  VtfDict     VTF objects\r
     #   @param  MacroDict   macro value pair\r
     #   @retval string      Generated FV file path\r
     #\r
 \r
-    def AddToBuffer(self, Buffer, BaseAddress, BlockSizeList, ErasePolarity, ImageBinDict, vtfDict=None, MacroDict={}, Flag=False):\r
+    def AddToBuffer(self, Buffer, BaseAddress, BlockSizeList, ErasePolarity, ImageBinDict,  MacroDict={}, Flag=False):\r
         Size = self.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
+        if Flag and (self.RegionType != BINARY_FILE_TYPE_FV):\r
             return\r
 \r
-        if self.RegionType == 'FV':\r
+        if self.RegionType == BINARY_FILE_TYPE_FV:\r
             #\r
             # Get Fv from FvDict\r
             #\r
@@ -102,7 +101,7 @@ class Region(RegionClassObject):
                         EdkLogger.error("GenFds", FILE_NOT_FOUND, ExtraData=RegionData)\r
 \r
                     FileName = RegionData\r
-                elif RegionData.upper() + 'fv' in ImageBinDict.keys():\r
+                elif RegionData.upper() + 'fv' in ImageBinDict:\r
                     if not Flag:\r
                         GenFdsGlobalVariable.InfLogger('   Region Name = FV')\r
                     FileName = ImageBinDict[RegionData.upper() + 'fv']\r
@@ -111,10 +110,10 @@ class Region(RegionClassObject):
                     # 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
+                    if FvObj is not None :\r
                         if not Flag:\r
                             GenFdsGlobalVariable.InfLogger('   Region Name = FV')\r
                         #\r
@@ -122,19 +121,20 @@ class Region(RegionClassObject):
                         #\r
                         self.BlockInfoOfRegion(BlockSizeList, FvObj)\r
                         self.FvAddress = self.FvAddress + FvOffset\r
-                        FvAlignValue = self.GetFvAlignValue(FvObj.FvAlignment)\r
+                        FvAlignValue = GenFdsGlobalVariable.GetAlignment(FvObj.FvAlignment)\r
                         if self.FvAddress % FvAlignValue != 0:\r
                             EdkLogger.error("GenFds", GENFDS_ERROR,\r
                                             "FV (%s) is NOT %s Aligned!" % (FvObj.UiFvName, FvObj.FvAlignment))\r
-                        FvBuffer = StringIO.StringIO('')\r
+                        FvBuffer = BytesIO()\r
                         FvBaseAddress = '0x%X' % self.FvAddress\r
                         BlockSize = None\r
                         BlockNum = None\r
-                        FvObj.AddToBuffer(FvBuffer, FvBaseAddress, BlockSize, BlockNum, ErasePolarity, vtfDict, Flag=Flag)\r
+                        FvObj.AddToBuffer(FvBuffer, FvBaseAddress, BlockSize, BlockNum, ErasePolarity, Flag=Flag)\r
                         if Flag:\r
                             continue\r
 \r
-                        if FvBuffer.len > Size:\r
+                        FvBufferLen = len(FvBuffer.getvalue())\r
+                        if FvBufferLen > Size:\r
                             FvBuffer.close()\r
                             EdkLogger.error("GenFds", GENFDS_ERROR,\r
                                             "Size of FV (%s) is larger than Region Size 0x%X specified." % (RegionData, Size))\r
@@ -143,8 +143,8 @@ class Region(RegionClassObject):
                         #\r
                         Buffer.write(FvBuffer.getvalue())\r
                         FvBuffer.close()\r
-                        FvOffset = FvOffset + FvBuffer.len\r
-                        Size = Size - FvBuffer.len\r
+                        FvOffset = FvOffset + FvBufferLen\r
+                        Size = Size - FvBufferLen\r
                         continue\r
                     else:\r
                         EdkLogger.error("GenFds", GENFDS_ERROR, "FV (%s) is NOT described in FDF file!" % (RegionData))\r
@@ -152,7 +152,7 @@ class Region(RegionClassObject):
                 # Add the exist Fv image into FD buffer\r
                 #\r
                 if not Flag:\r
-                    if FileName != None:\r
+                    if FileName is not None:\r
                         FileLength = os.stat(FileName)[ST_SIZE]\r
                         if FileLength > Size:\r
                             EdkLogger.error("GenFds", GENFDS_ERROR,\r
@@ -182,7 +182,7 @@ class Region(RegionClassObject):
                         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
@@ -190,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
@@ -270,29 +270,10 @@ class Region(RegionClassObject):
             #\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
             self.PadBuffer(Buffer, ErasePolarity, Size)\r
 \r
-    def GetFvAlignValue(self, Str):\r
-        AlignValue = 1\r
-        Granu = 1\r
-        Str = Str.strip().upper()\r
-        if Str.endswith('K'):\r
-            Granu = 1024\r
-            Str = Str[:-1]\r
-        elif Str.endswith('M'):\r
-            Granu = 1024 * 1024\r
-            Str = Str[:-1]\r
-        elif Str.endswith('G'):\r
-            Granu = 1024 * 1024 * 1024\r
-            Str = Str[:-1]\r
-        else:\r
-            pass\r
-\r
-        AlignValue = int(Str) * Granu\r
-        return AlignValue\r
-\r
     ## BlockSizeOfRegion()\r
     #\r
     #   @param  BlockSizeList        List of block information\r
@@ -309,11 +290,11 @@ class Region(RegionClassObject):
             if self.Offset >= End:\r
                 Start = End\r
                 continue\r
-            # region located in current blocks \r
+            # region located in current blocks\r
             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
@@ -322,7 +303,7 @@ 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
@@ -333,7 +314,7 @@ class Region(RegionClassObject):
             # 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
@@ -361,5 +342,5 @@ class Region(RegionClassObject):
                 else:\r
                     Index += 1\r
 \r
-            \r
+\r
 \r