]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/GenFds/FdfParser.py
BaseTools/GenFds: Support FDF sections in any order
[mirror_edk2.git] / BaseTools / Source / Python / GenFds / FdfParser.py
index 56303e1694f8dc1c82c3f16407f103760d9d3993..5489df59a6edf8c3da9ed84d6ec78976629b9cf3 100644 (file)
@@ -52,11 +52,13 @@ import Common.GlobalData as GlobalData
 from Common.Expression import *\r
 from Common import GlobalData\r
 from Common.String import ReplaceMacro\r
-\r
+import uuid\r
 from Common.Misc import tdict\r
 \r
 import Common.LongFilePathOs as os\r
 from Common.LongFilePathSupport import OpenLongFilePath as open\r
+from Capsule import EFI_CERT_TYPE_PKCS7_GUID\r
+from Capsule import EFI_CERT_TYPE_RSA2048_SHA256_GUID\r
 \r
 ##define T_CHAR_SPACE                ' '\r
 ##define T_CHAR_NULL                 '\0'\r
@@ -231,6 +233,7 @@ class FileProfile :
 \r
         self.PcdDict = {}\r
         self.InfList = []\r
+        self.InfDict = {'ArchTBD':[]}\r
         # ECC will use this Dict and List information\r
         self.PcdFileLineDict = {}\r
         self.InfFileLineList = []\r
@@ -1123,6 +1126,26 @@ class FdfParser:
             self.__UndoToken()\r
             return False\r
 \r
+    def __Verify(self, Name, Value, Scope):\r
+        if Scope in ['UINT64', 'UINT8']:\r
+            ValueNumber = 0\r
+            try:\r
+                if Value.upper().startswith('0X'):\r
+                    ValueNumber = int (Value, 16)\r
+                else:\r
+                    ValueNumber = int (Value)\r
+            except:\r
+                EdkLogger.error("FdfParser", FORMAT_INVALID, "The value is not valid dec or hex number for %s." % Name)\r
+            if ValueNumber < 0:\r
+                EdkLogger.error("FdfParser", FORMAT_INVALID, "The value can't be set to negative value for %s." % Name)\r
+            if Scope == 'UINT64':\r
+                if ValueNumber >= 0x10000000000000000:\r
+                    EdkLogger.error("FdfParser", FORMAT_INVALID, "Too large value for %s." % Name)\r
+            if Scope == 'UINT8':\r
+                if ValueNumber >= 0x100:\r
+                    EdkLogger.error("FdfParser", FORMAT_INVALID, "Too large value for %s." % Name)\r
+            return True\r
+\r
     ## __UndoToken() method\r
     #\r
     #   Go back one token unit in file buffer\r
@@ -1362,25 +1385,10 @@ class FdfParser:
 \r
         try:\r
             self.Preprocess()\r
-            while self.__GetFd():\r
-                pass\r
-\r
-            while self.__GetFv():\r
-                pass\r
-\r
-            while self.__GetFmp():\r
-                pass\r
-\r
-            while self.__GetCapsule():\r
-                pass\r
-\r
-            while self.__GetVtf():\r
-                pass\r
-\r
-            while self.__GetRule():\r
-                pass\r
-            \r
-            while self.__GetOptionRom():\r
+            #\r
+            # Keep processing sections of the FDF until no new sections or a syntax error is found\r
+            #\r
+            while self.__GetFd() or self.__GetFv() or self.__GetFmp() or self.__GetCapsule() or self.__GetVtf() or self.__GetRule() or self.__GetOptionRom():\r
                 pass\r
 \r
         except Warning, X:\r
@@ -2472,6 +2480,13 @@ class FdfParser:
             self.Profile.InfList.append(ffsInf.InfFileName)\r
             FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
             self.Profile.InfFileLineList.append(FileLineTuple)\r
+            if ffsInf.UseArch:\r
+                if ffsInf.UseArch not in self.Profile.InfDict:\r
+                    self.Profile.InfDict[ffsInf.UseArch] = [ffsInf.InfFileName]\r
+                else:\r
+                    self.Profile.InfDict[ffsInf.UseArch].append(ffsInf.InfFileName)\r
+            else:\r
+                self.Profile.InfDict['ArchTBD'].append(ffsInf.InfFileName)\r
 \r
         if self.__IsToken('|'):\r
             if self.__IsKeyword('RELOCS_STRIPPED'):\r
@@ -3179,7 +3194,7 @@ class FdfParser:
 \r
         if not self.__GetNextToken():\r
             raise Warning("The FMP payload section is empty!", self.FileName, self.CurrentLineNumber)\r
-        FmpKeyList = ['IMAGE_HEADER_INIT_VERSION', 'IMAGE_TYPE_ID', 'IMAGE_INDEX', 'HARDWARE_INSTANCE']\r
+        FmpKeyList = ['IMAGE_HEADER_INIT_VERSION', 'IMAGE_TYPE_ID', 'IMAGE_INDEX', 'HARDWARE_INSTANCE', 'CERTIFICATE_GUID', 'MONOTONIC_COUNT']\r
         while self.__Token in FmpKeyList:\r
             Name = self.__Token\r
             FmpKeyList.remove(Name)\r
@@ -3187,32 +3202,55 @@ class FdfParser:
                 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
             if Name == 'IMAGE_TYPE_ID':\r
                 if not self.__GetNextGuid():\r
-                    raise Warning("expected GUID value for IMAGE_TYPE_ID", self.FileName, self.CurrentLineNumber)\r
+                    raise Warning("expected GUID value for IMAGE_TYPE_ID.", self.FileName, self.CurrentLineNumber)\r
                 FmpData.ImageTypeId = self.__Token\r
+            elif Name == 'CERTIFICATE_GUID':\r
+                if not self.__GetNextGuid():\r
+                    raise Warning("expected GUID value for CERTIFICATE_GUID.", self.FileName, self.CurrentLineNumber)\r
+                FmpData.Certificate_Guid = self.__Token\r
+                if uuid.UUID(FmpData.Certificate_Guid) != EFI_CERT_TYPE_RSA2048_SHA256_GUID and uuid.UUID(FmpData.Certificate_Guid) != EFI_CERT_TYPE_PKCS7_GUID:\r
+                    raise Warning("Only support EFI_CERT_TYPE_RSA2048_SHA256_GUID or EFI_CERT_TYPE_PKCS7_GUID for CERTIFICATE_GUID.", self.FileName, self.CurrentLineNumber)\r
             else:\r
                 if not self.__GetNextToken():\r
                     raise Warning("expected value of %s" % Name, self.FileName, self.CurrentLineNumber)\r
                 Value = self.__Token\r
                 if Name == 'IMAGE_HEADER_INIT_VERSION':\r
-                    FmpData.Version = Value\r
+                    if self.__Verify(Name, Value, 'UINT8'):\r
+                        FmpData.Version = Value\r
                 elif Name == 'IMAGE_INDEX':\r
-                    FmpData.ImageIndex = Value\r
+                    if self.__Verify(Name, Value, 'UINT8'):\r
+                        FmpData.ImageIndex = Value\r
                 elif Name == 'HARDWARE_INSTANCE':\r
-                    FmpData.HardwareInstance = Value\r
+                    if self.__Verify(Name, Value, 'UINT8'):\r
+                        FmpData.HardwareInstance = Value\r
+                elif Name == 'MONOTONIC_COUNT':\r
+                    if self.__Verify(Name, Value, 'UINT64'):\r
+                        FmpData.MonotonicCount = Value\r
+                        if FmpData.MonotonicCount.upper().startswith('0X'):\r
+                            FmpData.MonotonicCount = (long)(FmpData.MonotonicCount, 16)\r
+                        else:\r
+                            FmpData.MonotonicCount = (long)(FmpData.MonotonicCount)\r
             if not self.__GetNextToken():\r
                 break\r
         else:\r
             self.__UndoToken()\r
 \r
+        if (FmpData.MonotonicCount and not FmpData.Certificate_Guid) or (not FmpData.MonotonicCount and FmpData.Certificate_Guid):\r
+            EdkLogger.error("FdfParser", FORMAT_INVALID, "CERTIFICATE_GUID and MONOTONIC_COUNT must be work as a pair.")\r
+        # remove CERTIFICATE_GUID and MONOTONIC_COUNT from FmpKeyList, since these keys are optional\r
+        if 'CERTIFICATE_GUID' in FmpKeyList:\r
+            FmpKeyList.remove('CERTIFICATE_GUID')\r
+        if 'MONOTONIC_COUNT' in FmpKeyList:\r
+            FmpKeyList.remove('MONOTONIC_COUNT')\r
         if FmpKeyList:\r
-            raise Warning("Missing keywords %s in FMP payload section" % ', '.join(FmpKeyList), self.FileName, self.CurrentLineNumber)\r
-        ImageFile = self.__ParseRawFileStatement()\r
-        if not ImageFile:\r
-            raise Warning("Missing image file in FMP payload section", self.FileName, self.CurrentLineNumber)\r
-        FmpData.ImageFile = ImageFile\r
-        VendorCodeFile = self.__ParseRawFileStatement()\r
-        if VendorCodeFile:\r
-            FmpData.VendorCodeFile = VendorCodeFile\r
+            raise Warning("Missing keywords %s in FMP payload section." % ', '.join(FmpKeyList), self.FileName, self.CurrentLineNumber)\r
+        # get the Image file and Vendor code file\r
+        self.__GetFMPCapsuleData(FmpData)\r
+        if not FmpData.ImageFile:\r
+            raise Warning("Missing image file in FMP payload section.", self.FileName, self.CurrentLineNumber)\r
+        # check whether more than one Vendor code file\r
+        if len(FmpData.VendorCodeFile) > 1:\r
+            raise Warning("At most one Image file and one Vendor code file are allowed in FMP payload section.", self.FileName, self.CurrentLineNumber)\r
         self.Profile.FmpPayloadDict[FmpUiName] = FmpData\r
         return True\r
 \r
@@ -3344,6 +3382,22 @@ class FdfParser:
             if not (IsInf or IsFile or IsFv or IsFd or IsAnyFile or IsAfile or IsFmp):\r
                 break\r
 \r
+    ## __GetFMPCapsuleData() method\r
+    #\r
+    #   Get capsule data for FMP capsule\r
+    #\r
+    #   @param  self        The object pointer\r
+    #   @param  Obj         for whom capsule data are got\r
+    #\r
+    def __GetFMPCapsuleData(self, Obj):\r
+\r
+        while True:\r
+            IsFv = self.__GetFvStatement(Obj, True)\r
+            IsFd = self.__GetFdStatement(Obj, True)\r
+            IsAnyFile = self.__GetAnyFileStatement(Obj, True)\r
+            if not (IsFv or IsFd or IsAnyFile):\r
+                break\r
+\r
     ## __GetFvStatement() method\r
     #\r
     #   Get FV for capsule\r
@@ -3353,7 +3407,7 @@ class FdfParser:
     #   @retval True        Successfully find a FV statement\r
     #   @retval False       Not able to find a FV statement\r
     #\r
-    def __GetFvStatement(self, CapsuleObj):\r
+    def __GetFvStatement(self, CapsuleObj, FMPCapsule = False):\r
 \r
         if not self.__IsKeyword("FV"):\r
             return False\r
@@ -3369,7 +3423,13 @@ class FdfParser:
 \r
         CapsuleFv = CapsuleData.CapsuleFv()\r
         CapsuleFv.FvName = self.__Token\r
-        CapsuleObj.CapsuleDataList.append(CapsuleFv)\r
+        if FMPCapsule:\r
+            if not CapsuleObj.ImageFile:\r
+                CapsuleObj.ImageFile.append(CapsuleFv)\r
+            else:\r
+                CapsuleObj.VendorCodeFile.append(CapsuleFv)\r
+        else:\r
+            CapsuleObj.CapsuleDataList.append(CapsuleFv)\r
         return True\r
 \r
     ## __GetFdStatement() method\r
@@ -3381,7 +3441,7 @@ class FdfParser:
     #   @retval True        Successfully find a FD statement\r
     #   @retval False       Not able to find a FD statement\r
     #\r
-    def __GetFdStatement(self, CapsuleObj):\r
+    def __GetFdStatement(self, CapsuleObj, FMPCapsule = False):\r
 \r
         if not self.__IsKeyword("FD"):\r
             return False\r
@@ -3397,7 +3457,13 @@ class FdfParser:
 \r
         CapsuleFd = CapsuleData.CapsuleFd()\r
         CapsuleFd.FdName = self.__Token\r
-        CapsuleObj.CapsuleDataList.append(CapsuleFd)\r
+        if FMPCapsule:\r
+            if not CapsuleObj.ImageFile:\r
+                CapsuleObj.ImageFile.append(CapsuleFd)\r
+            else:\r
+                CapsuleObj.VendorCodeFile.append(CapsuleFd)\r
+        else:\r
+            CapsuleObj.CapsuleDataList.append(CapsuleFd)\r
         return True\r
 \r
     def __GetFmpStatement(self, CapsuleObj):\r
@@ -3448,14 +3514,20 @@ class FdfParser:
     #   @retval True        Successfully find a Anyfile statement\r
     #   @retval False       Not able to find a AnyFile statement\r
     #\r
-    def __GetAnyFileStatement(self, CapsuleObj):\r
+    def __GetAnyFileStatement(self, CapsuleObj, FMPCapsule = False):\r
         AnyFileName = self.__ParseRawFileStatement()\r
         if not AnyFileName:\r
             return False\r
 \r
         CapsuleAnyFile = CapsuleData.CapsuleAnyFile()\r
         CapsuleAnyFile.FileName = AnyFileName\r
-        CapsuleObj.CapsuleDataList.append(CapsuleAnyFile)\r
+        if FMPCapsule:\r
+            if not CapsuleObj.ImageFile:\r
+                CapsuleObj.ImageFile.append(CapsuleAnyFile)\r
+            else:\r
+                CapsuleObj.VendorCodeFile.append(CapsuleAnyFile)\r
+        else:\r
+            CapsuleObj.CapsuleDataList.append(CapsuleAnyFile)\r
         return True\r
     \r
     ## __GetAfileStatement() method\r
@@ -4351,6 +4423,13 @@ class FdfParser:
             self.Profile.InfList.append(ffsInf.InfFileName)\r
             FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
             self.Profile.InfFileLineList.append(FileLineTuple)\r
+            if ffsInf.UseArch:\r
+                if ffsInf.UseArch not in self.Profile.InfDict:\r
+                    self.Profile.InfDict[ffsInf.UseArch] = [ffsInf.InfFileName]\r
+                else:\r
+                    self.Profile.InfDict[ffsInf.UseArch].append(ffsInf.InfFileName)\r
+            else:\r
+                self.Profile.InfDict['ArchTBD'].append(ffsInf.InfFileName)\r
 \r
         \r
         self.__GetOptRomOverrides (ffsInf)\r