]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/GenFds/Region.py
BaseTools: Clean some coding style issues
[mirror_edk2.git] / BaseTools / Source / Python / GenFds / Region.py
index ed16c6fa98da99eb3d2cb17dd744fd017f78fbb2..01e998e54c6fb6c5fa2ec1aa5c4d0f8e47622c54 100644 (file)
@@ -1,9 +1,9 @@
 ## @file\r
 # process FD Region generation\r
 #\r
-#  Copyright (c) 2007, Intel Corporation\r
+#  Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.<BR>\r
 #\r
-#  All rights reserved. This program and the accompanying materials\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
@@ -19,10 +19,12 @@ from struct import *
 from GenFdsGlobalVariable import GenFdsGlobalVariable\r
 import StringIO\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
-\r
+from Common.LongFilePathSupport import OpenLongFilePath as open\r
+from Common.MultipleWorkspace import MultipleWorkspace as mws\r
 \r
 ## generate Region\r
 #\r
@@ -52,110 +54,184 @@ class Region(RegionClassObject):
     #   @retval string      Generated FV file path\r
     #\r
 \r
-    def AddToBuffer(self, Buffer, BaseAddress, BlockSizeList, ErasePolarity, FvBinDict, vtfDict = None, MacroDict = {}):\r
+    def AddToBuffer(self, Buffer, BaseAddress, BlockSizeList, ErasePolarity, ImageBinDict, vtfDict=None, MacroDict={}):\r
         Size = self.Size\r
-        GenFdsGlobalVariable.InfLogger('Generate Region at Offset 0x%X' % self.Offset)\r
-        GenFdsGlobalVariable.InfLogger("   Region Size = 0x%X" %Size)\r
+        GenFdsGlobalVariable.InfLogger('\nGenerate Region at Offset 0x%X' % self.Offset)\r
+        GenFdsGlobalVariable.InfLogger("   Region Size = 0x%X" % Size)\r
         GenFdsGlobalVariable.SharpCounter = 0\r
 \r
         if self.RegionType == 'FV':\r
             #\r
             # Get Fv from FvDict\r
             #\r
-            FvBuffer = StringIO.StringIO('')\r
-            RegionBlockSize = self.BlockSizeOfRegion(BlockSizeList)\r
-            RegionBlockNum = self.BlockNumOfRegion(RegionBlockSize)\r
-\r
             self.FvAddress = int(BaseAddress, 16) + self.Offset\r
-            FvBaseAddress = '0x%X' %self.FvAddress\r
-\r
+            FvBaseAddress = '0x%X' % self.FvAddress\r
+            FvOffset = 0\r
             for RegionData in self.RegionDataList:\r
-\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
+                    GenFdsGlobalVariable.InfLogger('   Region FV File Name = .fv : %s' % RegionData)\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
 \r
-                    BinFile = open (RegionData, 'r+b')\r
-                    FvBuffer.write(BinFile.read())\r
-                    if FvBuffer.len > Size:\r
+                    FileName = RegionData\r
+                elif RegionData.upper() + 'fv' in ImageBinDict.keys():\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
+\r
+                    if FvObj != None :\r
+                        GenFdsGlobalVariable.InfLogger('   Region Name = FV')\r
+                        #\r
+                        # Call GenFv tool\r
+                        #\r
+                        self.BlockInfoOfRegion(BlockSizeList, FvObj)\r
+                        self.FvAddress = self.FvAddress + FvOffset\r
+                        FvAlignValue = self.GetFvAlignValue(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
+                        FvBaseAddress = '0x%X' % self.FvAddress\r
+                        BlockSize = None\r
+                        BlockNum = None\r
+                        FvObj.AddToBuffer(FvBuffer, FvBaseAddress, BlockSize, BlockNum, ErasePolarity, vtfDict)\r
+                        if FvBuffer.len > 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
+                        #\r
+                        # Put the generated image into FD buffer.\r
+                        #\r
+                        Buffer.write(FvBuffer.getvalue())\r
+                        FvBuffer.close()\r
+                        FvOffset = FvOffset + FvBuffer.len\r
+                        Size = Size - FvBuffer.len\r
+                        continue\r
+                    else:\r
+                        EdkLogger.error("GenFds", GENFDS_ERROR, "FV (%s) is NOT described in FDF file!" % (RegionData))\r
+                #\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
-                    break\r
-\r
-                if RegionData.upper() in FvBinDict.keys():\r
-                    continue\r
+                    BinFile = open(FileName, 'r+b')\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
 \r
-                FvObj = None\r
-                if RegionData.upper() in GenFdsGlobalVariable.FdfParser.Profile.FvDict.keys():\r
-                    FvObj = GenFdsGlobalVariable.FdfParser.Profile.FvDict.get(RegionData.upper())\r
+        if self.RegionType == 'CAPSULE':\r
+            #\r
+            # Get Capsule from Capsule Dict\r
+            #\r
+            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
+                    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
 \r
-                if FvObj != None :\r
-                    GenFdsGlobalVariable.InfLogger('   Region Name = FV')\r
+                    FileName = RegionData\r
+                elif RegionData.upper() + 'cap' in ImageBinDict.keys():\r
+                    GenFdsGlobalVariable.InfLogger('   Region Name = CAPSULE')\r
+                    FileName = ImageBinDict[RegionData.upper() + 'cap']\r
+                else:\r
                     #\r
-                    # Call GenFv tool\r
+                    # Generate Capsule image and Put it into FD buffer\r
                     #\r
-                    BlockSize = RegionBlockSize\r
-                    BlockNum = RegionBlockNum\r
-                    if FvObj.BlockSizeList != []:\r
-                        if FvObj.BlockSizeList[0][0] != None:\r
-                            BlockSize = FvObj.BlockSizeList[0][0]\r
-                        if FvObj.BlockSizeList[0][1] != None:\r
-                            BlockNum = FvObj.BlockSizeList[0][1]\r
-                    self.FvAddress = self.FvAddress + FvBuffer.len\r
-                    FvAlignValue = self.GetFvAlignValue(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
-                    FvBaseAddress = '0x%X' %self.FvAddress\r
-                    FileName = FvObj.AddToBuffer(FvBuffer, FvBaseAddress, BlockSize, BlockNum, ErasePolarity, vtfDict)\r
-\r
-                    if FvBuffer.len > Size:\r
-                        EdkLogger.error("GenFds", GENFDS_ERROR,\r
-                                        "Size of FV (%s) is larger than Region Size 0x%X specified." % (RegionData, Size))\r
-                else:\r
-                    EdkLogger.error("GenFds", GENFDS_ERROR, "FV (%s) is NOT described in FDF file!" % (RegionData))\r
+                    CapsuleObj = None\r
+                    if RegionData.upper() in GenFdsGlobalVariable.FdfParser.Profile.CapsuleDict.keys():\r
+                        CapsuleObj = GenFdsGlobalVariable.FdfParser.Profile.CapsuleDict[RegionData.upper()]\r
 \r
+                    if CapsuleObj != None :\r
+                        CapsuleObj.CapsuleName = RegionData.upper()\r
+                        GenFdsGlobalVariable.InfLogger('   Region Name = CAPSULE')\r
+                        #\r
+                        # Call GenFv tool to generate Capsule Image\r
+                        #\r
+                        FileName = CapsuleObj.GenCapsule()\r
+                        CapsuleObj.CapsuleName = None\r
+                    else:\r
+                        EdkLogger.error("GenFds", GENFDS_ERROR, "Capsule (%s) is NOT described in FDF file!" % (RegionData))\r
 \r
-            if FvBuffer.len > 0:\r
-                Buffer.write(FvBuffer.getvalue())\r
-            else:\r
-                BinFile = open (FileName, 'rb')\r
+                #\r
+                # Add the capsule image into FD buffer\r
+                #\r
+                FileLength = os.stat(FileName)[ST_SIZE]\r
+                if FileLength > Size:\r
+                    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
                 Buffer.write(BinFile.read())\r
-\r
-            FvBuffer.close()\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
 \r
         if self.RegionType == 'FILE':\r
-            FvBuffer = StringIO.StringIO('')\r
             for RegionData in self.RegionDataList:\r
                 RegionData = GenFdsGlobalVariable.MacroExtend(RegionData, MacroDict)\r
-                GenFdsGlobalVariable.InfLogger('   Region File Name = FILE: %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
-                BinFile = open (RegionData, 'r+b')\r
-                FvBuffer.write(BinFile.read())\r
-                if FvBuffer.len > Size :\r
+                #\r
+                # Add the file image into FD buffer\r
+                #\r
+                FileLength = os.stat(RegionData)[ST_SIZE]\r
+                if FileLength > Size:\r
                     EdkLogger.error("GenFds", GENFDS_ERROR,\r
-                                    "Size of File (%s) large than Region Size " % RegionData)\r
-\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, 'rb')\r
+                Buffer.write(BinFile.read())\r
+                BinFile.close()\r
+                Size = Size - FileLength\r
             #\r
-            # If File contents less than region size, append "0xff" after it\r
+            # Pad the left buffer\r
             #\r
-            if FvBuffer.len < Size:\r
-                for index in range(0, (Size-FvBuffer.len)):\r
-                    if (ErasePolarity == '1'):\r
-                        FvBuffer.write(pack('B', int('0xFF', 16)))\r
-                    else:\r
-                        FvBuffer.write(pack('B', int('0x00', 16)))\r
-            Buffer.write(FvBuffer.getvalue())\r
-            FvBuffer.close()\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
 \r
         if self.RegionType == 'DATA' :\r
             GenFdsGlobalVariable.InfLogger('   Region Name = DATA')\r
@@ -168,12 +244,16 @@ class Region(RegionClassObject):
                 else:\r
                     for item in Data :\r
                         Buffer.write(pack('B', int(item, 16)))\r
-            if DataSize < Size:\r
-                if (ErasePolarity == '1'):\r
+                Size = Size - DataSize\r
+            #\r
+            # Pad the left buffer\r
+            #\r
+            if Size > 0:\r
+                if (ErasePolarity == '1') :\r
                     PadData = 0xFF\r
-                else:\r
+                else :\r
                     PadData = 0\r
-                for i in range(Size - DataSize):\r
+                for i in range(0, Size):\r
                     Buffer.write(pack('B', PadData))\r
 \r
         if self.RegionType == None:\r
@@ -193,48 +273,84 @@ 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
     ## BlockSizeOfRegion()\r
     #\r
     #   @param  BlockSizeList        List of block information\r
-    #   @retval int                  Block size of region\r
-    #\r
-    def BlockSizeOfRegion(self, BlockSizeList):\r
-        Offset = 0x00\r
-        BlockSize = 0\r
-        for item in BlockSizeList:\r
-            Offset = Offset + item[0]  * item[1]\r
-            GenFdsGlobalVariable.VerboseLogger ("Offset = 0x%X" %Offset)\r
-            GenFdsGlobalVariable.VerboseLogger ("self.Offset 0x%X" %self.Offset)\r
-\r
-            if self.Offset < Offset :\r
-                if Offset - self.Offset < self.Size:\r
-                    EdkLogger.error("GenFds", GENFDS_ERROR,\r
-                                    "Region at Offset 0x%X can NOT fit into Block array with BlockSize %X" \\r
-                                    % (self.Offset, item[0]))\r
-                BlockSize = item[0]\r
-                GenFdsGlobalVariable.VerboseLogger ("BlockSize = %X" %BlockSize)\r
-                return BlockSize\r
-        return BlockSize\r
-\r
-    ## BlockNumOfRegion()\r
-    #\r
-    #   @param  BlockSize            block size of region\r
-    #   @retval int                  Block number of region\r
+    #   @param  FvObj                The object for FV\r
     #\r
-    def BlockNumOfRegion (self, BlockSize):\r
-        if BlockSize == 0 :\r
-            EdkLogger.error("GenFds", GENFDS_ERROR, "Region: %s is not in the FD address scope!" % self.Offset)\r
-        BlockNum = self.Size / BlockSize\r
-        GenFdsGlobalVariable.VerboseLogger ("BlockNum = 0x%X" %BlockNum)\r
-        return BlockNum\r
+    def BlockInfoOfRegion(self, BlockSizeList, FvObj):\r
+        Start = 0\r
+        End = 0\r
+        RemindingSize = self.Size\r
+        ExpectedList = []\r
+        for (BlockSize, BlockNum, pcd) in BlockSizeList:\r
+            End = Start + BlockSize * BlockNum\r
+            # region not started yet\r
+            if self.Offset >= End:\r
+                Start = End\r
+                continue\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
+                    break\r
+                # region not ended yet\r
+                else:\r
+                    # region not started in middle of current blocks\r
+                    if self.Offset <= Start:\r
+                        UsedBlockNum = BlockNum\r
+                    # region started in middle of current blocks\r
+                    else:\r
+                        UsedBlockNum = (End - self.Offset) / BlockSize\r
+                    Start = End\r
+                    ExpectedList.append((BlockSize, UsedBlockNum))\r
+                    RemindingSize -= BlockSize * UsedBlockNum\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
+                    FvObj.BlockSizeList = ExpectedList\r
+                    break\r
+            # make sure region size is no smaller than the summed block size in FV\r
+            Sum = 0\r
+            for Item in FvObj.BlockSizeList:\r
+                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
+            # 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
+            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
+                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
+                else:\r
+                    Index += 1\r
+\r
+            \r
 \r