]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/GenFds/Capsule.py
BaseTools: Move FindExtendTool to GenFdsGlobalVariable.py
[mirror_edk2.git] / BaseTools / Source / Python / GenFds / Capsule.py
index fb9213b467b383cd5719b3bcaed94422e9799b1d..8471cd5d0f7a813d30caec719996561eb949986b 100644 (file)
@@ -1,7 +1,7 @@
 ## @file\r
 # generate capsule\r
 #\r
-#  Copyright (c) 2007, 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
 ##\r
 # Import Modules\r
 #\r
-from GenFdsGlobalVariable import GenFdsGlobalVariable\r
+from __future__ import absolute_import\r
+from .GenFdsGlobalVariable import GenFdsGlobalVariable\r
+from .GenFdsGlobalVariable import FindExtendTool\r
 from CommonDataClass.FdfClass import CapsuleClassObject\r
-import os\r
+import Common.LongFilePathOs as os\r
 import subprocess\r
-import StringIO\r
+from io import BytesIO\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
+from Common import EdkLogger\r
+from Common.BuildToolError import *\r
 \r
 \r
 T_CHAR_LF = '\n'\r
+WIN_CERT_REVISION      = 0x0200\r
+WIN_CERT_TYPE_EFI_GUID = 0x0EF1\r
+EFI_CERT_TYPE_PKCS7_GUID = uuid.UUID('{4aafd29d-68df-49ee-8aa9-347d375665a7}')\r
+EFI_CERT_TYPE_RSA2048_SHA256_GUID = uuid.UUID('{a7717414-c616-4977-9420-844712a735bf}')\r
 \r
 ## create inf file describes what goes into capsule and call GenFv to generate capsule\r
 #\r
@@ -42,16 +52,164 @@ 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 = BytesIO()\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 = BytesIO()\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
+        #\r
+        # typedef struct _WIN_CERTIFICATE {\r
+        #   UINT32 dwLength;\r
+        #   UINT16 wRevision;\r
+        #   UINT16 wCertificateType;\r
+        # //UINT8 bCertificate[ANYSIZE_ARRAY];\r
+        # } WIN_CERTIFICATE;\r
+        #\r
+        # typedef struct _WIN_CERTIFICATE_UEFI_GUID {\r
+        #   WIN_CERTIFICATE Hdr;\r
+        #   EFI_GUID        CertType;\r
+        # //UINT8 CertData[ANYSIZE_ARRAY];\r
+        # } WIN_CERTIFICATE_UEFI_GUID;\r
+        #\r
+        # typedef struct {\r
+        #   UINT64                    MonotonicCount;\r
+        #   WIN_CERTIFICATE_UEFI_GUID AuthInfo;\r
+        # } EFI_FIRMWARE_IMAGE_AUTHENTICATION;\r
+        #\r
+        # typedef struct _EFI_CERT_BLOCK_RSA_2048_SHA256 {\r
+        #   EFI_GUID HashType;\r
+        #   UINT8 PublicKey[256];\r
+        #   UINT8 Signature[256];\r
+        # } EFI_CERT_BLOCK_RSA_2048_SHA256;\r
+        #\r
+\r
+        PreSize = FwMgrHdrSize\r
+        Content = BytesIO()\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
+            if fmp.Existed:\r
+                FwMgrHdr.write(pack('=Q', PreSize))\r
+                PreSize += len(fmp.Buffer)\r
+                Content.write(fmp.Buffer)\r
+                continue\r
+            if fmp.ImageFile:\r
+                for Obj in fmp.ImageFile:\r
+                    fmp.ImageFile = Obj.GenCapsuleSubItem()\r
+            if fmp.VendorCodeFile:\r
+                for Obj in fmp.VendorCodeFile:\r
+                    fmp.VendorCodeFile = Obj.GenCapsuleSubItem()\r
+            if fmp.Certificate_Guid:\r
+                ExternalTool, ExternalOption = FindExtendTool([], GenFdsGlobalVariable.ArchList, fmp.Certificate_Guid)\r
+                CmdOption = ''\r
+                CapInputFile = fmp.ImageFile\r
+                if not os.path.isabs(fmp.ImageFile):\r
+                    CapInputFile = os.path.join(GenFdsGlobalVariable.WorkSpaceDir, fmp.ImageFile)\r
+                CapOutputTmp = os.path.join(GenFdsGlobalVariable.FvDir, self.UiCapsuleName) + '.tmp'\r
+                if ExternalTool is None:\r
+                    EdkLogger.error("GenFds", GENFDS_ERROR, "No tool found with GUID %s" % fmp.Certificate_Guid)\r
+                else:\r
+                    CmdOption += ExternalTool\r
+                if ExternalOption:\r
+                    CmdOption = CmdOption + ' ' + ExternalOption\r
+                CmdOption += ' -e ' + ' --monotonic-count ' + str(fmp.MonotonicCount) + ' -o ' + CapOutputTmp + ' ' + CapInputFile\r
+                CmdList = CmdOption.split()\r
+                GenFdsGlobalVariable.CallExternalTool(CmdList, "Failed to generate FMP auth capsule")\r
+                if uuid.UUID(fmp.Certificate_Guid) == EFI_CERT_TYPE_PKCS7_GUID:\r
+                    dwLength = 4 + 2 + 2 + 16 + os.path.getsize(CapOutputTmp) - os.path.getsize(CapInputFile)\r
+                else:\r
+                    dwLength = 4 + 2 + 2 + 16 + 16 + 256 + 256\r
+                fmp.ImageFile = CapOutputTmp\r
+                AuthData = [fmp.MonotonicCount, dwLength, WIN_CERT_REVISION, WIN_CERT_TYPE_EFI_GUID, fmp.Certificate_Guid]\r
+                fmp.Buffer = fmp.GenCapsuleSubItem(AuthData)\r
+            else:\r
+                fmp.Buffer = fmp.GenCapsuleSubItem()\r
+            FwMgrHdr.write(pack('=Q', PreSize))\r
+            PreSize += len(fmp.Buffer)\r
+            Content.write(fmp.Buffer)\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
     #   @retval string      Generated Capsule file path\r
     #\r
     def GenCapsule(self):\r
-        if self.UiCapsuleName.upper() + 'cap' in GenFds.ImageBinDict.keys():\r
+        from .GenFds import GenFds\r
+        if self.UiCapsuleName.upper() + 'cap' in GenFds.ImageBinDict:\r
             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
@@ -90,15 +248,15 @@ class Capsule (CapsuleClassObject) :
     def GenCapInf(self):\r
         self.CapInfFileName = os.path.join(GenFdsGlobalVariable.FvDir,\r
                                    self.UiCapsuleName +  "_Cap" + '.inf')\r
-        CapInfFile = StringIO.StringIO() #open (self.CapInfFileName , 'w+')\r
+        CapInfFile = BytesIO() #open (self.CapInfFileName , 'w+')\r
 \r
         CapInfFile.writelines("[options]" + T_CHAR_LF)\r
 \r
-        for Item in self.TokensDict.keys():\r
+        for Item in self.TokensDict:\r
             CapInfFile.writelines("EFI_"                    + \\r
                                   Item                      + \\r
                                   ' = '                     + \\r
-                                  self.TokensDict.get(Item) + \\r
+                                  self.TokensDict[Item]     + \\r
                                   T_CHAR_LF)\r
 \r
         return CapInfFile\r