BaseTools: Supported FMP capsule image.

[mirror_edk2.git] / BaseTools / Source / Python / GenFds / Capsule.py

diff --git a/BaseTools/Source/Python/GenFds/Capsule.py b/BaseTools/Source/Python/GenFds/Capsule.py
index 85f95a69c1f050036dd2daf3bca052187cd56613..1683433e43429065a5e36be7e7b1410833a9ab4e 100644 (file)
--- a/BaseTools/Source/Python/GenFds/Capsule.py
+++ b/BaseTools/Source/Python/GenFds/Capsule.py
@@ -22,6 +22,9 @@ import subprocess
 import StringIO\r
 from Common.Misc import SaveFileOnChange\r
 from GenFds import GenFds\r
+from Common.Misc import PackRegistryFormatGuid\r
+import uuid\r
+from struct import pack\r
 \r
 \r
 T_CHAR_LF = '\n'\r
@@ -42,6 +45,88 @@ class Capsule (CapsuleClassObject) :
         self.BlockNum = None\r
         self.CapsuleName = None\r
 \r
+    ## Generate FMP capsule\r
+    #\r
+    #   @retval string      Generated Capsule file path\r
+    #\r
+    def GenFmpCapsule(self):\r
+        #\r
+        # Generate capsule header\r
+        # typedef struct {\r
+        #     EFI_GUID          CapsuleGuid;\r
+        #     UINT32            HeaderSize;\r
+        #     UINT32            Flags;\r
+        #     UINT32            CapsuleImageSize;\r
+        # } EFI_CAPSULE_HEADER;\r
+        #\r
+        Header = StringIO.StringIO()\r
+        #\r
+        # Use FMP capsule GUID: 6DCBD5ED-E82D-4C44-BDA1-7194199AD92A\r
+        #\r
+        Header.write(PackRegistryFormatGuid('6DCBD5ED-E82D-4C44-BDA1-7194199AD92A'))\r
+        HdrSize = 0\r
+        if 'CAPSULE_HEADER_SIZE' in self.TokensDict:\r
+            Header.write(pack('=I', int(self.TokensDict['CAPSULE_HEADER_SIZE'], 16)))\r
+            HdrSize = int(self.TokensDict['CAPSULE_HEADER_SIZE'], 16)\r
+        else:\r
+            Header.write(pack('=I', 0x20))\r
+            HdrSize = 0x20\r
+        Flags = 0\r
+        if 'CAPSULE_FLAGS' in self.TokensDict:\r
+            for flag in self.TokensDict['CAPSULE_FLAGS'].split(','):\r
+                flag = flag.strip()\r
+                if flag == 'PopulateSystemTable':\r
+                    Flags |= 0x00010000 | 0x00020000\r
+                elif flag == 'PersistAcrossReset':\r
+                    Flags |= 0x00010000\r
+                elif flag == 'InitiateReset':\r
+                    Flags |= 0x00040000\r
+        Header.write(pack('=I', Flags))\r
+        #\r
+        # typedef struct {\r
+        #     UINT32 Version;\r
+        #     UINT16 EmbeddedDriverCount;\r
+        #     UINT16 PayloadItemCount;\r
+        #     // UINT64 ItemOffsetList[];\r
+        # } EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER;\r
+        #\r
+        FwMgrHdr = StringIO.StringIO()\r
+        if 'CAPSULE_HEADER_INIT_VERSION' in self.TokensDict:\r
+            FwMgrHdr.write(pack('=I', int(self.TokensDict['CAPSULE_HEADER_INIT_VERSION'], 16)))\r
+        else:\r
+            FwMgrHdr.write(pack('=I', 0x00000001))\r
+        FwMgrHdr.write(pack('=HH', len(self.CapsuleDataList), len(self.FmpPayloadList)))\r
+        FwMgrHdrSize = 4+2+2+8*(len(self.CapsuleDataList)+len(self.FmpPayloadList))\r
+\r
+        PreSize = FwMgrHdrSize\r
+        Content = StringIO.StringIO()\r
+        for driver in self.CapsuleDataList:\r
+            FileName = driver.GenCapsuleSubItem()\r
+            FwMgrHdr.write(pack('=Q', PreSize))\r
+            PreSize += os.path.getsize(FileName)\r
+            File = open(FileName, 'rb')\r
+            Content.write(File.read())\r
+            File.close()\r
+        for fmp in self.FmpPayloadList:\r
+            payload = fmp.GenCapsuleSubItem()\r
+            FwMgrHdr.write(pack('=Q', PreSize))\r
+            PreSize += len(payload)\r
+            Content.write(payload)\r
+        BodySize = len(FwMgrHdr.getvalue()) + len(Content.getvalue())\r
+        Header.write(pack('=I', HdrSize + BodySize))\r
+        #\r
+        # The real capsule header structure is 28 bytes\r
+        #\r
+        Header.write('\x00'*(HdrSize-28))\r
+        Header.write(FwMgrHdr.getvalue())\r
+        Header.write(Content.getvalue())\r
+        #\r
+        # Generate FMP capsule file\r
+        #\r
+        CapOutputFile = os.path.join(GenFdsGlobalVariable.FvDir, self.UiCapsuleName) + '.Cap'\r
+        SaveFileOnChange(CapOutputFile, Header.getvalue(), True)\r
+        return CapOutputFile\r
+\r
     ## Generate capsule\r
     #\r
     #   @param  self        The object pointer\r
@@ -52,6 +137,10 @@ class Capsule (CapsuleClassObject) :
             return GenFds.ImageBinDict[self.UiCapsuleName.upper() + 'cap']\r
 \r
         GenFdsGlobalVariable.InfLogger( "\nGenerate %s Capsule" %self.UiCapsuleName)\r
+        if ('CAPSULE_GUID' in self.TokensDict and \r
+            uuid.UUID(self.TokensDict['CAPSULE_GUID']) == uuid.UUID('6DCBD5ED-E82D-4C44-BDA1-7194199AD92A')):\r
+            return self.GenFmpCapsule()\r
+\r
         CapInfFile = self.GenCapInf()\r
         CapInfFile.writelines("[files]" + T_CHAR_LF)\r
         CapFileList = []\r