]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/GenFds/Fv.py
BaseTools: Replace StringIO.StringIO with io.BytesIO
[mirror_edk2.git] / BaseTools / Source / Python / GenFds / Fv.py
index a69abb300cfa10d66117c7b93c62bb72216e04d6..d980020680f869e84aee691681c845e85b716fc3 100644 (file)
@@ -1,7 +1,7 @@
 ## @file\r
 # process FV 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
@@ -17,7 +17,7 @@
 #\r
 import Common.LongFilePathOs as os\r
 import subprocess\r
-import StringIO\r
+from io import BytesIO\r
 from struct import *\r
 \r
 import Ffs\r
@@ -26,11 +26,11 @@ import FfsFileStatement
 from GenFdsGlobalVariable import GenFdsGlobalVariable\r
 from GenFds import GenFds\r
 from CommonDataClass.FdfClass import FvClassObject\r
-from Common.Misc import SaveFileOnChange\r
+from Common.Misc import SaveFileOnChange, PackGUID\r
 from Common.LongFilePathSupport import CopyLongFilePath\r
 from Common.LongFilePathSupport import OpenLongFilePath as open\r
+from Common.DataType import *\r
 \r
-T_CHAR_LF = '\n'\r
 FV_UI_EXT_ENTY_GUID = 'A67DF1FA-8DE8-4E98-AF09-4BDF2EFFBC7C'\r
 \r
 ## generate FV\r
@@ -70,22 +70,21 @@ class FV (FvClassObject):
     #\r
     def AddToBuffer (self, Buffer, BaseAddress=None, BlockSize= None, BlockNum=None, ErasePloarity='1', VtfDict=None, MacroDict = {}, Flag=False) :\r
 \r
-        if BaseAddress == None and self.UiFvName.upper() + 'fv' in GenFds.ImageBinDict.keys():\r
+        if BaseAddress is None and self.UiFvName.upper() + 'fv' in GenFds.ImageBinDict:\r
             return GenFds.ImageBinDict[self.UiFvName.upper() + 'fv']\r
         \r
         #\r
         # Check whether FV in Capsule is in FD flash region.\r
         # If yes, return error. Doesn't support FV in Capsule image is also in FD flash region.\r
         #\r
-        if self.CapsuleName != None:\r
-            for FdName in GenFdsGlobalVariable.FdfParser.Profile.FdDict.keys():\r
-                FdObj = GenFdsGlobalVariable.FdfParser.Profile.FdDict[FdName]\r
+        if self.CapsuleName is not None:\r
+            for FdObj in GenFdsGlobalVariable.FdfParser.Profile.FdDict.values():\r
                 for RegionObj in FdObj.RegionList:\r
-                    if RegionObj.RegionType == 'FV':\r
+                    if RegionObj.RegionType == BINARY_FILE_TYPE_FV:\r
                         for RegionData in RegionObj.RegionDataList:\r
                             if RegionData.endswith(".fv"):\r
                                 continue\r
-                            elif RegionData.upper() + 'fv' in GenFds.ImageBinDict.keys():\r
+                            elif RegionData.upper() + 'fv' in GenFds.ImageBinDict:\r
                                 continue\r
                             elif self.UiFvName.upper() == RegionData.upper():\r
                                 GenFdsGlobalVariable.ErrorLogger("Capsule %s in FD region can't contain a FV %s in FD region." % (self.CapsuleName, self.UiFvName.upper()))\r
@@ -94,7 +93,7 @@ class FV (FvClassObject):
         GenFdsGlobalVariable.LargeFileInFvFlags.append(False)\r
         FFSGuid = None\r
         \r
-        if self.FvBaseAddress != None:\r
+        if self.FvBaseAddress is not None:\r
             BaseAddress = self.FvBaseAddress\r
         if not Flag:\r
             self.__InitializeInf__(BaseAddress, BlockSize, BlockNum, ErasePloarity, VtfDict)\r
@@ -112,7 +111,7 @@ class FV (FvClassObject):
             if not Flag:\r
                 self.FvInfFile.writelines("EFI_FILE_NAME = " + \\r
                                             FileName          + \\r
-                                            T_CHAR_LF)\r
+                                            TAB_LINE_BREAK)\r
 \r
         # Process Modules in FfsList\r
         for FfsFile in self.FfsList :\r
@@ -126,7 +125,7 @@ class FV (FvClassObject):
             if not Flag:\r
                 self.FvInfFile.writelines("EFI_FILE_NAME = " + \\r
                                             FileName          + \\r
-                                            T_CHAR_LF)\r
+                                            TAB_LINE_BREAK)\r
         if not Flag:\r
             SaveFileOnChange(self.InfFileName, self.FvInfFile.getvalue(), False)\r
             self.FvInfFile.close()\r
@@ -136,7 +135,7 @@ class FV (FvClassObject):
         FvOutputFile = os.path.join(GenFdsGlobalVariable.FvDir, self.UiFvName)\r
         FvOutputFile = FvOutputFile + '.Fv'\r
         # BUGBUG: FvOutputFile could be specified from FDF file (FV section, CreateFile statement)\r
-        if self.CreateFileName != None:\r
+        if self.CreateFileName is not None:\r
             FvOutputFile = self.CreateFileName\r
 \r
         if Flag:\r
@@ -163,7 +162,7 @@ class FV (FvClassObject):
             NewFvInfo = None\r
             if os.path.exists (FvInfoFileName):\r
                 NewFvInfo = open(FvInfoFileName, 'r').read()\r
-            if NewFvInfo != None and NewFvInfo != OrigFvInfo:\r
+            if NewFvInfo is not None and NewFvInfo != OrigFvInfo:\r
                 FvChildAddr = []\r
                 AddFileObj = open(FvInfoFileName, 'r')\r
                 AddrStrings = AddFileObj.readlines()\r
@@ -179,7 +178,7 @@ class FV (FvClassObject):
                 if FvChildAddr != []:\r
                     # Update Ffs again\r
                     for FfsFile in self.FfsList :\r
-                        FileName = FfsFile.GenFfs(MacroDict, FvChildAddr, BaseAddress, IsMakefile=Flag)\r
+                        FileName = FfsFile.GenFfs(MacroDict, FvChildAddr, BaseAddress, IsMakefile=Flag, FvName=self.UiFvName)\r
 \r
                     if GenFdsGlobalVariable.LargeFileInFvFlags[-1]:\r
                         FFSGuid = GenFdsGlobalVariable.EFI_FIRMWARE_FILE_SYSTEM3_GUID;\r
@@ -235,10 +234,9 @@ class FV (FvClassObject):
         if self.BlockSizeList:\r
             return True\r
 \r
-        for FdName in GenFdsGlobalVariable.FdfParser.Profile.FdDict.keys():\r
-            FdObj = GenFdsGlobalVariable.FdfParser.Profile.FdDict[FdName]\r
+        for FdObj in GenFdsGlobalVariable.FdfParser.Profile.FdDict.values():\r
             for RegionObj in FdObj.RegionList:\r
-                if RegionObj.RegionType != 'FV':\r
+                if RegionObj.RegionType != BINARY_FILE_TYPE_FV:\r
                     continue\r
                 for RegionData in RegionObj.RegionDataList:\r
                     #\r
@@ -267,57 +265,57 @@ class FV (FvClassObject):
         #\r
         self.InfFileName = os.path.join(GenFdsGlobalVariable.FvDir,\r
                                    self.UiFvName + '.inf')\r
-        self.FvInfFile = StringIO.StringIO()\r
+        self.FvInfFile = BytesIO()\r
 \r
         #\r
         # Add [Options]\r
         #\r
-        self.FvInfFile.writelines("[options]" + T_CHAR_LF)\r
-        if BaseAddress != None :\r
+        self.FvInfFile.writelines("[options]" + TAB_LINE_BREAK)\r
+        if BaseAddress is not None :\r
             self.FvInfFile.writelines("EFI_BASE_ADDRESS = " + \\r
                                        BaseAddress          + \\r
-                                       T_CHAR_LF)\r
+                                       TAB_LINE_BREAK)\r
 \r
-        if BlockSize != None:\r
+        if BlockSize is not None:\r
             self.FvInfFile.writelines("EFI_BLOCK_SIZE = " + \\r
                                       '0x%X' %BlockSize    + \\r
-                                      T_CHAR_LF)\r
-            if BlockNum != None:\r
+                                      TAB_LINE_BREAK)\r
+            if BlockNum is not None:\r
                 self.FvInfFile.writelines("EFI_NUM_BLOCKS   = "  + \\r
                                       ' 0x%X' %BlockNum    + \\r
-                                      T_CHAR_LF)\r
+                                      TAB_LINE_BREAK)\r
         else:\r
             if self.BlockSizeList == []:\r
                 if not self._GetBlockSize():\r
                     #set default block size is 1\r
-                    self.FvInfFile.writelines("EFI_BLOCK_SIZE  = 0x1" + T_CHAR_LF)\r
+                    self.FvInfFile.writelines("EFI_BLOCK_SIZE  = 0x1" + TAB_LINE_BREAK)\r
             \r
             for BlockSize in self.BlockSizeList :\r
-                if BlockSize[0] != None:\r
+                if BlockSize[0] is not None:\r
                     self.FvInfFile.writelines("EFI_BLOCK_SIZE  = "  + \\r
                                           '0x%X' %BlockSize[0]    + \\r
-                                          T_CHAR_LF)\r
+                                          TAB_LINE_BREAK)\r
 \r
-                if BlockSize[1] != None:\r
+                if BlockSize[1] is not None:\r
                     self.FvInfFile.writelines("EFI_NUM_BLOCKS   = "  + \\r
                                           ' 0x%X' %BlockSize[1]    + \\r
-                                          T_CHAR_LF)\r
+                                          TAB_LINE_BREAK)\r
 \r
-        if self.BsBaseAddress != None:\r
+        if self.BsBaseAddress is not None:\r
             self.FvInfFile.writelines('EFI_BOOT_DRIVER_BASE_ADDRESS = ' + \\r
                                        '0x%X' %self.BsBaseAddress)\r
-        if self.RtBaseAddress != None:\r
+        if self.RtBaseAddress is not None:\r
             self.FvInfFile.writelines('EFI_RUNTIME_DRIVER_BASE_ADDRESS = ' + \\r
                                       '0x%X' %self.RtBaseAddress)\r
         #\r
         # Add attribute\r
         #\r
-        self.FvInfFile.writelines("[attributes]" + T_CHAR_LF)\r
+        self.FvInfFile.writelines("[attributes]" + TAB_LINE_BREAK)\r
 \r
         self.FvInfFile.writelines("EFI_ERASE_POLARITY   = "       + \\r
                                           ' %s' %ErasePloarity    + \\r
-                                          T_CHAR_LF)\r
-        if not (self.FvAttributeDict == None):\r
+                                          TAB_LINE_BREAK)\r
+        if not (self.FvAttributeDict is None):\r
             for FvAttribute in self.FvAttributeDict.keys() :\r
                 if FvAttribute == "FvUsedSizeEnable":\r
                     if self.FvAttributeDict[FvAttribute].upper() in ('TRUE', '1') :\r
@@ -327,21 +325,20 @@ class FV (FvClassObject):
                                           FvAttribute       + \\r
                                           ' = '             + \\r
                                           self.FvAttributeDict[FvAttribute] + \\r
-                                          T_CHAR_LF )\r
-        if self.FvAlignment != None:\r
+                                          TAB_LINE_BREAK )\r
+        if self.FvAlignment is not None:\r
             self.FvInfFile.writelines("EFI_FVB2_ALIGNMENT_"     + \\r
                                        self.FvAlignment.strip() + \\r
                                        " = TRUE"                + \\r
-                                       T_CHAR_LF)\r
+                                       TAB_LINE_BREAK)\r
                                        \r
         #\r
         # Generate FV extension header file\r
         #\r
-        if self.FvNameGuid == None or self.FvNameGuid == '':\r
+        if not self.FvNameGuid:\r
             if len(self.FvExtEntryType) > 0 or self.UsedSizeEnable:\r
                 GenFdsGlobalVariable.ErrorLogger("FV Extension Header Entries declared for %s with no FvNameGuid declaration." % (self.UiFvName))\r
-        \r
-        if self.FvNameGuid <> None and self.FvNameGuid <> '':\r
+        else:\r
             TotalSize = 16 + 4\r
             Buffer = ''\r
             if self.UsedSizeEnable:\r
@@ -369,10 +366,7 @@ class FV (FvClassObject):
                 #   FV UI name\r
                 #\r
                 Buffer += (pack('HH', (FvUiLen + 16 + 4), 0x0002)\r
-                           + pack('=LHHBBBBBBBB', int(Guid[0], 16), int(Guid[1], 16), int(Guid[2], 16),\r
-                                  int(Guid[3][-4:-2], 16), int(Guid[3][-2:], 16), int(Guid[4][-12:-10], 16),\r
-                                  int(Guid[4][-10:-8], 16), int(Guid[4][-8:-6], 16), int(Guid[4][-6:-4], 16),\r
-                                  int(Guid[4][-4:-2], 16), int(Guid[4][-2:], 16))\r
+                           + PackGUID(Guid)\r
                            + self.UiFvName)\r
 \r
             for Index in range (0, len(self.FvExtEntryType)):\r
@@ -385,8 +379,8 @@ class FV (FvClassObject):
                     # check if the file path exists or not\r
                     if not os.path.isfile(FileFullPath):\r
                         GenFdsGlobalVariable.ErrorLogger("Error opening FV Extension Header Entry file %s." % (self.FvExtEntryData[Index]))\r
-                    FvExtFile = open (FileFullPath,'rb')\r
-                    FvExtFile.seek(0,2)\r
+                    FvExtFile = open (FileFullPath, 'rb')\r
+                    FvExtFile.seek(0, 2)\r
                     Size = FvExtFile.tell()\r
                     if Size >= 0x10000:\r
                         GenFdsGlobalVariable.ErrorLogger("The size of FV Extension Header Entry file %s exceeds 0x10000." % (self.FvExtEntryData[Index]))\r
@@ -406,27 +400,14 @@ class FV (FvClassObject):
                         Buffer += pack('B', int(ByteList[Index1], 16))\r
 \r
             Guid = self.FvNameGuid.split('-')\r
-            Buffer = pack('=LHHBBBBBBBBL', \r
-                        int(Guid[0], 16), \r
-                        int(Guid[1], 16), \r
-                        int(Guid[2], 16), \r
-                        int(Guid[3][-4:-2], 16), \r
-                        int(Guid[3][-2:], 16),  \r
-                        int(Guid[4][-12:-10], 16),\r
-                        int(Guid[4][-10:-8], 16),\r
-                        int(Guid[4][-8:-6], 16),\r
-                        int(Guid[4][-6:-4], 16),\r
-                        int(Guid[4][-4:-2], 16),\r
-                        int(Guid[4][-2:], 16),\r
-                        TotalSize\r
-                        ) + Buffer\r
+            Buffer = PackGUID(Guid) + pack('=L', TotalSize) + Buffer\r
 \r
             #\r
             # Generate FV extension header file if the total size is not zero\r
             #\r
             if TotalSize > 0:\r
                 FvExtHeaderFileName = os.path.join(GenFdsGlobalVariable.FvDir, self.UiFvName + '.ext')\r
-                FvExtHeaderFile = StringIO.StringIO()\r
+                FvExtHeaderFile = BytesIO()\r
                 FvExtHeaderFile.write(Buffer)\r
                 Changed = SaveFileOnChange(FvExtHeaderFileName, FvExtHeaderFile.getvalue(), True)\r
                 FvExtHeaderFile.close()\r
@@ -435,14 +416,14 @@ class FV (FvClassObject):
                     os.remove (self.InfFileName)\r
                 self.FvInfFile.writelines("EFI_FV_EXT_HEADER_FILE_NAME = "      + \\r
                                            FvExtHeaderFileName                  + \\r
-                                           T_CHAR_LF)\r
+                                           TAB_LINE_BREAK)\r
 \r
          \r
         #\r
         # Add [Files]\r
         #\r
-        self.FvInfFile.writelines("[files]" + T_CHAR_LF)\r
-        if VtfDict != None and self.UiFvName in VtfDict.keys():\r
+        self.FvInfFile.writelines("[files]" + TAB_LINE_BREAK)\r
+        if VtfDict and self.UiFvName in VtfDict:\r
             self.FvInfFile.writelines("EFI_FILE_NAME = "                   + \\r
-                                       VtfDict.get(self.UiFvName)          + \\r
-                                       T_CHAR_LF)\r
+                                       VtfDict[self.UiFvName]              + \\r
+                                       TAB_LINE_BREAK)\r