Sync EDKII BaseTools to BaseTools project r1903.
[efi/edk2/.git] / edk2 / BaseTools / Source / Python / GenFds / Fv.py
index 23ec582..8d2ef1d 100644 (file)
@@ -1,7 +1,7 @@
 ## @file\r
 # process FV generation\r
 #\r
-#  Copyright (c) 2007, Intel Corporation\r
+#  Copyright (c) 2007 - 2010, Intel Corporation\r
 #\r
 #  All rights reserved. This program and the accompanying materials\r
 #  are licensed and made available under the terms and conditions of the BSD License\r
@@ -19,6 +19,7 @@ import os
 import shutil\r
 import subprocess\r
 import StringIO\r
+from struct import *\r
 \r
 import Ffs\r
 import AprioriSection\r
@@ -62,7 +63,7 @@ class FV (FvClassObject):
     #\r
     def AddToBuffer (self, Buffer, BaseAddress=None, BlockSize= None, BlockNum=None, ErasePloarity='1', VtfDict=None, MacroDict = {}) :\r
 \r
-        if self.UiFvName.upper() + 'fv' in GenFds.ImageBinDict.keys():\r
+        if BaseAddress == None and self.UiFvName.upper() + 'fv' in GenFds.ImageBinDict.keys():\r
             return GenFds.ImageBinDict[self.UiFvName.upper() + 'fv']\r
         \r
         #\r
@@ -70,8 +71,8 @@ class FV (FvClassObject):
         # 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():
-                FdObj = GenFdsGlobalVariable.FdfParser.Profile.FdDict[FdName]
+            for FdName in GenFdsGlobalVariable.FdfParser.Profile.FdDict.keys():\r
+                FdObj = GenFdsGlobalVariable.FdfParser.Profile.FdDict[FdName]\r
                 for RegionObj in FdObj.RegionList:\r
                     if RegionObj.RegionType == 'FV':\r
                         for RegionData in RegionObj.RegionDataList:\r
@@ -102,7 +103,7 @@ class FV (FvClassObject):
 \r
         # Process Modules in FfsList\r
         for FfsFile in self.FfsList :\r
-            FileName = FfsFile.GenFfs(MacroDict)\r
+            FileName = FfsFile.GenFfs(MacroDict, FvParentAddr=BaseAddress)\r
             FfsFileList.append(FileName)\r
             self.FvInfFile.writelines("EFI_FILE_NAME = " + \\r
                                        FileName          + \\r
@@ -121,6 +122,9 @@ class FV (FvClassObject):
 \r
         FvInfoFileName = os.path.join(GenFdsGlobalVariable.FfsDir, self.UiFvName + '.inf')\r
         shutil.copy(GenFdsGlobalVariable.FvAddressFileName, FvInfoFileName)\r
+        OrigFvInfo = None\r
+        if os.path.exists (FvInfoFileName):\r
+            OrigFvInfo = open(FvInfoFileName, 'r').read()\r
         GenFdsGlobalVariable.GenerateFirmwareVolume(\r
                                 FvOutputFile,\r
                                 [self.InfFileName],\r
@@ -128,6 +132,35 @@ class FV (FvClassObject):
                                 FfsList=FfsFileList\r
                                 )\r
 \r
+        NewFvInfo = None\r
+        if os.path.exists (FvInfoFileName):\r
+            NewFvInfo = open(FvInfoFileName, 'r').read()\r
+        if NewFvInfo != None and NewFvInfo != OrigFvInfo:\r
+            FvChildAddr = []\r
+            AddFileObj = open(FvInfoFileName, 'r')\r
+            AddrStrings = AddFileObj.readlines()\r
+            AddrKeyFound = False\r
+            for AddrString in AddrStrings:\r
+                if AddrKeyFound:\r
+                    #get base address for the inside FvImage\r
+                    FvChildAddr.append (AddrString)\r
+                elif AddrString.find ("[FV_BASE_ADDRESS]") != -1:\r
+                    AddrKeyFound = True\r
+            AddFileObj.close()\r
+\r
+            if FvChildAddr != []:\r
+                # Update Ffs again\r
+                for FfsFile in self.FfsList :\r
+                    FileName = FfsFile.GenFfs(MacroDict, FvChildAddr, BaseAddress)\r
+                \r
+                #Update GenFv again\r
+                GenFdsGlobalVariable.GenerateFirmwareVolume(\r
+                                        FvOutputFile,\r
+                                        [self.InfFileName],\r
+                                        AddressFile=FvInfoFileName,\r
+                                        FfsList=FfsFileList\r
+                                        )\r
+\r
         #\r
         # Write the Fv contents to Buffer\r
         #\r
@@ -137,6 +170,21 @@ class FV (FvClassObject):
         GenFdsGlobalVariable.SharpCounter = 0\r
 \r
         Buffer.write(FvFileObj.read())\r
+        FvFileObj.seek(0)\r
+        # PI FvHeader is 0x48 byte\r
+        FvHeaderBuffer = FvFileObj.read(0x48)\r
+        # FV alignment position.\r
+        FvAlignmentValue = 1 << (ord (FvHeaderBuffer[0x2E]) & 0x1F)\r
+        # FvAlignmentValue is larger than or equal to 1K\r
+        if FvAlignmentValue >= 0x400:\r
+            if FvAlignmentValue >= 0x10000:\r
+                #The max alignment supported by FFS is 64K.\r
+                self.FvAlignment = "64K"\r
+            else:\r
+                self.FvAlignment = str (FvAlignmentValue / 0x400) + "K"\r
+        else:\r
+            # FvAlignmentValue is less than 1K\r
+            self.FvAlignment = str (FvAlignmentValue)\r
         FvFileObj.close()\r
         GenFds.ImageBinDict[self.UiFvName.upper() + 'fv'] = FvOutputFile\r
         return FvOutputFile\r
@@ -178,6 +226,10 @@ class FV (FvClassObject):
                                       ' 0x%X' %BlockNum    + \\r
                                       T_CHAR_LF)\r
         else:\r
+            if self.BlockSizeList == []:\r
+                #set default block size is 1\r
+                self.FvInfFile.writelines("EFI_BLOCK_SIZE  = 0x1" + T_CHAR_LF)\r
+            \r
             for BlockSize in self.BlockSizeList :\r
                 if BlockSize[0] != None:\r
                     self.FvInfFile.writelines("EFI_BLOCK_SIZE  = "  + \\r
@@ -215,19 +267,85 @@ class FV (FvClassObject):
                                        self.FvAlignment.strip() + \\r
                                        " = TRUE"                + \\r
                                        T_CHAR_LF)\r
-            \r
-        if self.FvNameGuid != None:\r
-            self.FvInfFile.writelines("EFI_FVNAME_GUID"     + \\r
-                                       " = %s" % self.FvNameGuid + \\r
-                                       T_CHAR_LF)\r
+                                       \r
         #\r
-        # Add [Files]\r
+        # Generate FV extension header file\r
         #\r
+        if self.FvNameGuid == None or self.FvNameGuid == '':\r
+            if len(self.FvExtEntryType) > 0:\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
+            TotalSize = 16 + 4\r
+            Buffer = ''\r
+            for Index in range (0, len(self.FvExtEntryType)):\r
+                if self.FvExtEntryType[Index] == 'FILE':\r
+                    # check if the path is absolute or relative
+                    if os.path.isabs(self.FvExtEntryData[Index]):
+                        FileFullPath = os.path.normpath(self.FvExtEntryData[Index])
+                    else:
+                        FileFullPath = os.path.normpath(os.path.join(GenFdsGlobalVariable.WorkSpaceDir, self.FvExtEntryData[Index]))
+                    # check if the file path exists or not
+                    if not os.path.isfile(FileFullPath):
+                        GenFdsGlobalVariable.ErrorLogger("Error opening FV Extension Header Entry file %s." % (self.FvExtEntryData[Index]))\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
+                    TotalSize += (Size + 4)\r
+                    FvExtFile.seek(0)\r
+                    Buffer += pack('HH', (Size + 4), int(self.FvExtEntryTypeValue[Index], 16))\r
+                    Buffer += FvExtFile.read() \r
+                    FvExtFile.close()\r
+                if self.FvExtEntryType[Index] == 'DATA':\r
+                    ByteList = self.FvExtEntryData[Index].split(',')\r
+                    Size = len (ByteList)\r
+                    if Size >= 0x10000:\r
+                        GenFdsGlobalVariable.ErrorLogger("The size of FV Extension Header Entry data %s exceeds 0x10000." % (self.FvExtEntryData[Index]))\r
+                    TotalSize += (Size + 4)\r
+                    Buffer += pack('HH', (Size + 4), int(self.FvExtEntryTypeValue[Index], 16))\r
+                    for Index1 in range (0, Size):\r
+                        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
+\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.write(Buffer)\r
+                Changed = SaveFileOnChange(FvExtHeaderFileName, FvExtHeaderFile.getvalue(), True)\r
+                FvExtHeaderFile.close()\r
+                if Changed:\r
+                  if os.path.exists (self.InfFileName):\r
+                    os.remove (self.InfFileName)\r
+                self.FvInfFile.writelines("EFI_FV_EXT_HEADER_FILE_NAME = "      + \\r
+                                           FvExtHeaderFileName                  + \\r
+                                           T_CHAR_LF)\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("EFI_FILE_NAME = "                   + \\r
                                        VtfDict.get(self.UiFvName)          + \\r
                                        T_CHAR_LF)\r
-\r
-\r