BaseTools: Generate a binary file and list it in Binary section of As Built INF.

This binary file contains offset of VFR and UNI data.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Yingke Liu <yingke.d.liu@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@17622 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/BaseTools/Source/Python/AutoGen/AutoGen.py b/BaseTools/Source/Python/AutoGen/AutoGen.py
index a2a8e7e5a36b096c36f9c184a98d7ad236e44926..996b654943cccc544dd54d8309e5be8037c897e3 100644 (file)
--- a/BaseTools/Source/Python/AutoGen/AutoGen.py
+++ b/BaseTools/Source/Python/AutoGen/AutoGen.py
@@ -3116,6 +3116,76 @@ class ModuleAutoGen(AutoGen):
 \r
         return HiiExPcds\r
 \r
+    def _GenOffsetBin(self):\r
+        VfrUniBaseName = {}\r
+        for SourceFile in self.Module.Sources:\r
+            if SourceFile.Type.upper() == ".VFR" :\r
+                #\r
+                # search the .map file to find the offset of vfr binary in the PE32+/TE file. \r
+                #\r
+                VfrUniBaseName[SourceFile.BaseName] = (SourceFile.BaseName + "Bin")\r
+            if SourceFile.Type.upper() == ".UNI" :\r
+                #\r
+                # search the .map file to find the offset of Uni strings binary in the PE32+/TE file. \r
+                #\r
+                VfrUniBaseName["UniOffsetName"] = (self.Name + "Strings")\r
+\r
+        if len(VfrUniBaseName) == 0:\r
+            return None\r
+        MapFileName = os.path.join(self.OutputDir, self.Name + ".map")\r
+        EfiFileName = os.path.join(self.OutputDir, self.Name + ".efi")\r
+        VfrUniOffsetList = GetVariableOffset(MapFileName, EfiFileName, VfrUniBaseName.values())\r
+        if not VfrUniOffsetList:\r
+            return None\r
+\r
+        OutputName = '%sOffset.bin' % self.Name\r
+        UniVfrOffsetFileName    =  os.path.join( self.OutputDir, OutputName)\r
+\r
+        try:\r
+            fInputfile = open(UniVfrOffsetFileName, "wb+", 0)\r
+        except:\r
+            EdkLogger.error("build", FILE_OPEN_FAILURE, "File open failed for %s" % UniVfrOffsetFileName,None)\r
+\r
+        # Use a instance of StringIO to cache data\r
+        fStringIO = StringIO('')  \r
+\r
+        for Item in VfrUniOffsetList:\r
+            if (Item[0].find("Strings") != -1):\r
+                #\r
+                # UNI offset in image.\r
+                # GUID + Offset\r
+                # { 0x8913c5e0, 0x33f6, 0x4d86, { 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66 } }\r
+                #\r
+                UniGuid = [0xe0, 0xc5, 0x13, 0x89, 0xf6, 0x33, 0x86, 0x4d, 0x9b, 0xf1, 0x43, 0xef, 0x89, 0xfc, 0x6, 0x66]\r
+                UniGuid = [chr(ItemGuid) for ItemGuid in UniGuid]\r
+                fStringIO.write(''.join(UniGuid))            \r
+                UniValue = pack ('Q', int (Item[1], 16))\r
+                fStringIO.write (UniValue)\r
+            else:\r
+                #\r
+                # VFR binary offset in image.\r
+                # GUID + Offset\r
+                # { 0xd0bc7cb4, 0x6a47, 0x495f, { 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2 } };\r
+                #\r
+                VfrGuid = [0xb4, 0x7c, 0xbc, 0xd0, 0x47, 0x6a, 0x5f, 0x49, 0xaa, 0x11, 0x71, 0x7, 0x46, 0xda, 0x6, 0xa2]\r
+                VfrGuid = [chr(ItemGuid) for ItemGuid in VfrGuid]\r
+                fStringIO.write(''.join(VfrGuid))                   \r
+                type (Item[1]) \r
+                VfrValue = pack ('Q', int (Item[1], 16))\r
+                fStringIO.write (VfrValue)\r
+        #\r
+        # write data into file.\r
+        #\r
+        try :  \r
+            fInputfile.write (fStringIO.getvalue())\r
+        except:\r
+            EdkLogger.error("build", FILE_WRITE_FAILURE, "Write data to file %s failed, please check whether the "\r
+                            "file been locked or using by other applications." %UniVfrOffsetFileName,None)\r
+\r
+        fStringIO.close ()\r
+        fInputfile.close ()\r
+        return OutputName\r
+\r
     ## Create AsBuilt INF file the module\r
     #\r
     def CreateAsBuiltInf(self):\r
@@ -3270,6 +3340,10 @@ class ModuleAutoGen(AutoGen):
             if self.ModuleType in ['DXE_SMM_DRIVER']:\r
               AsBuiltInfDict['binary_item'] += ['SMM_DEPEX|' + self.Name + '.depex']\r
 \r
+        Bin = self._GenOffsetBin()\r
+        if Bin:\r
+            AsBuiltInfDict['binary_item'] += ['BIN|%s' % Bin]\r
+\r
         for Root, Dirs, Files in os.walk(OutputDir):\r
             for File in Files:\r
                 if File.lower().endswith('.pdb'):\r