]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/GenFds/FdfParser.py
Sync BaseTool trunk (version r2640) into EDKII BaseTools.
[mirror_edk2.git] / BaseTools / Source / Python / GenFds / FdfParser.py
index a468a5ec995d082539320c190724043606a288c2..f1e03f4c3f7820e519bcf05dd741fc0ca7c1256e 100644 (file)
@@ -1,7 +1,7 @@
 ## @file\r
 # parse FDF file\r
 #\r
-#  Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
+#  Copyright (c) 2007 - 2014, 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
@@ -77,6 +77,7 @@ SEPERATOR_TUPLE = ('=', '|', ',', '{', '}')
 \r
 RegionSizePattern = re.compile("\s*(?P<base>(?:0x|0X)?[a-fA-F0-9]+)\s*\|\s*(?P<size>(?:0x|0X)?[a-fA-F0-9]+)\s*")\r
 RegionSizeGuidPattern = re.compile("\s*(?P<base>\w+\.\w+)\s*\|\s*(?P<size>\w+\.\w+)\s*")\r
+RegionOffsetPcdPattern = re.compile("\s*(?P<base>\w+\.\w+)\s*$")\r
 ShortcutPcdPattern = re.compile("\s*\w+\s*=\s*(?P<value>(?:0x|0X)?[a-fA-F0-9]+)\s*\|\s*(?P<name>\w+\.\w+)\s*")\r
 \r
 IncludeFileList = []\r
@@ -1423,7 +1424,15 @@ class FdfParser:
         if not Status:\r
             raise Warning("FD name error", self.FileName, self.CurrentLineNumber)\r
 \r
-        self.__GetTokenStatements(FdObj)\r
+        while self.__GetTokenStatements(FdObj):\r
+            pass\r
+        for Attr in ("BaseAddress", "Size", "ErasePolarity"):\r
+            if getattr(FdObj, Attr) == None:\r
+                self.__GetNextToken()\r
+                raise Warning("Keyword %s missing" % Attr, self.FileName, self.CurrentLineNumber)\r
+\r
+        if not FdObj.BlockSizeList:\r
+            FdObj.BlockSizeList.append((1, FdObj.Size, None))\r
 \r
         self.__GetDefineStatements(FdObj)\r
 \r
@@ -1480,58 +1489,54 @@ class FdfParser:
     #   @param  Obj         for whom token statement is got\r
     #\r
     def __GetTokenStatements(self, Obj):\r
-        if not self.__IsKeyword( "BaseAddress"):\r
-            raise Warning("BaseAddress missing", self.FileName, self.CurrentLineNumber)\r
-\r
-        if not self.__IsToken( "="):\r
-            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
-\r
-        if not self.__GetNextHexNumber():\r
-            raise Warning("expected Hex base address", self.FileName, self.CurrentLineNumber)\r
-\r
-        Obj.BaseAddress = self.__Token\r
-\r
-        if self.__IsToken( "|"):\r
-            pcdPair = self.__GetNextPcdName()\r
-            Obj.BaseAddressPcd = pcdPair\r
-            self.Profile.PcdDict[pcdPair] = Obj.BaseAddress\r
-            FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
-            self.Profile.PcdFileLineDict[pcdPair] = FileLineTuple\r
-\r
-        if not self.__IsKeyword( "Size"):\r
-            raise Warning("Size missing", self.FileName, self.CurrentLineNumber)\r
-\r
-        if not self.__IsToken( "="):\r
-            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
-\r
-        if not self.__GetNextHexNumber():\r
-            raise Warning("expected Hex size", self.FileName, self.CurrentLineNumber)\r
-\r
-\r
-        Size = self.__Token\r
-        if self.__IsToken( "|"):\r
-            pcdPair = self.__GetNextPcdName()\r
-            Obj.SizePcd = pcdPair\r
-            self.Profile.PcdDict[pcdPair] = Size\r
-            FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
-            self.Profile.PcdFileLineDict[pcdPair] = FileLineTuple\r
-        Obj.Size = long(Size, 0)\r
-\r
-        if not self.__IsKeyword( "ErasePolarity"):\r
-            raise Warning("ErasePolarity missing", self.FileName, self.CurrentLineNumber)\r
-\r
-        if not self.__IsToken( "="):\r
-            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
+        if self.__IsKeyword( "BaseAddress"):\r
+            if not self.__IsToken( "="):\r
+                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
+    \r
+            if not self.__GetNextHexNumber():\r
+                raise Warning("expected Hex base address", self.FileName, self.CurrentLineNumber)\r
+    \r
+            Obj.BaseAddress = self.__Token\r
+    \r
+            if self.__IsToken( "|"):\r
+                pcdPair = self.__GetNextPcdName()\r
+                Obj.BaseAddressPcd = pcdPair\r
+                self.Profile.PcdDict[pcdPair] = Obj.BaseAddress\r
+                FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
+                self.Profile.PcdFileLineDict[pcdPair] = FileLineTuple\r
+            return True\r
 \r
-        if not self.__GetNextToken():\r
-            raise Warning("expected Erase Polarity", self.FileName, self.CurrentLineNumber)\r
+        if self.__IsKeyword( "Size"):\r
+            if not self.__IsToken( "="):\r
+                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
+    \r
+            if not self.__GetNextHexNumber():\r
+                raise Warning("expected Hex size", self.FileName, self.CurrentLineNumber)\r
 \r
-        if self.__Token != "1" and self.__Token != "0":\r
-            raise Warning("expected 1 or 0 Erase Polarity", self.FileName, self.CurrentLineNumber)\r
+            Size = self.__Token\r
+            if self.__IsToken( "|"):\r
+                pcdPair = self.__GetNextPcdName()\r
+                Obj.SizePcd = pcdPair\r
+                self.Profile.PcdDict[pcdPair] = Size\r
+                FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
+                self.Profile.PcdFileLineDict[pcdPair] = FileLineTuple\r
+            Obj.Size = long(Size, 0)\r
+            return True\r
 \r
-        Obj.ErasePolarity = self.__Token\r
+        if self.__IsKeyword( "ErasePolarity"):\r
+            if not self.__IsToken( "="):\r
+                raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
+    \r
+            if not self.__GetNextToken():\r
+                raise Warning("expected Erase Polarity", self.FileName, self.CurrentLineNumber)\r
+    \r
+            if self.__Token != "1" and self.__Token != "0":\r
+                raise Warning("expected 1 or 0 Erase Polarity", self.FileName, self.CurrentLineNumber)\r
+    \r
+            Obj.ErasePolarity = self.__Token\r
+            return True\r
 \r
-        self.__GetBlockStatements(Obj)\r
+        return self.__GetBlockStatements(Obj)\r
 \r
     ## __GetAddressStatements() method\r
     #\r
@@ -1572,18 +1577,14 @@ class FdfParser:
     #   @param  Obj         for whom block statement is got\r
     #\r
     def __GetBlockStatements(self, Obj):\r
-\r
-        if not self.__GetBlockStatement(Obj):\r
-            #set default block size is 1\r
-            Obj.BlockSizeList.append((1, Obj.Size, None))\r
-            return\r
-\r
+        IsBlock = False\r
         while self.__GetBlockStatement(Obj):\r
-            pass\r
+            IsBlock = True\r
         \r
-        for Item in Obj.BlockSizeList:\r
+            Item = Obj.BlockSizeList[-1]\r
             if Item[0] == None or Item[1] == None:\r
                 raise Warning("expected block statement", self.FileName, self.CurrentLineNumber)\r
+        return IsBlock\r
 \r
     ## __GetBlockStatement() method\r
     #\r
@@ -1732,8 +1733,7 @@ class FdfParser:
         try:\r
             return long(\r
                 ValueExpression(Expr,\r
-                                dict(['%s.%s' % (Pcd[1], Pcd[0]), Val] \r
-                                     for Pcd, Val in self.Profile.PcdDict.iteritems())\r
+                                self.__CollectMacroPcd()\r
                                 )(True),0)\r
         except Exception:\r
             self.SetFileBufferPos(StartPos)\r
@@ -1769,16 +1769,26 @@ class FdfParser:
             return True\r
 \r
         if not self.__Token in ("SET", "FV", "FILE", "DATA", "CAPSULE"):\r
+            #\r
+            # If next token is a word which is not a valid FV type, it might be part of [PcdOffset[|PcdSize]]\r
+            # Or it might be next region's offset described by an expression which starts with a PCD.\r
+            #    PcdOffset[|PcdSize] or OffsetPcdExpression|Size\r
+            #\r
             self.__UndoToken()\r
-            RegionObj.PcdOffset = self.__GetNextPcdName()\r
-            self.Profile.PcdDict[RegionObj.PcdOffset] = "0x%08X" % (RegionObj.Offset + long(Fd.BaseAddress, 0))\r
-            FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
-            self.Profile.PcdFileLineDict[RegionObj.PcdOffset] = FileLineTuple\r
-            if self.__IsToken( "|"):\r
-                RegionObj.PcdSize = self.__GetNextPcdName()\r
-                self.Profile.PcdDict[RegionObj.PcdSize] = "0x%08X" % RegionObj.Size\r
+            IsRegionPcd = (RegionSizeGuidPattern.match(self.__CurrentLine()[self.CurrentOffsetWithinLine:]) or\r
+                           RegionOffsetPcdPattern.match(self.__CurrentLine()[self.CurrentOffsetWithinLine:]))\r
+            if IsRegionPcd:\r
+                RegionObj.PcdOffset = self.__GetNextPcdName()\r
+                self.Profile.PcdDict[RegionObj.PcdOffset] = "0x%08X" % (RegionObj.Offset + long(Fd.BaseAddress, 0))\r
+                self.__PcdDict['%s.%s' % (RegionObj.PcdOffset[1], RegionObj.PcdOffset[0])] = "0x%x" % RegionObj.Offset\r
                 FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
-                self.Profile.PcdFileLineDict[RegionObj.PcdSize] = FileLineTuple\r
+                self.Profile.PcdFileLineDict[RegionObj.PcdOffset] = FileLineTuple\r
+                if self.__IsToken( "|"):\r
+                    RegionObj.PcdSize = self.__GetNextPcdName()\r
+                    self.Profile.PcdDict[RegionObj.PcdSize] = "0x%08X" % RegionObj.Size\r
+                    self.__PcdDict['%s.%s' % (RegionObj.PcdSize[1], RegionObj.PcdSize[0])] = "0x%x" % RegionObj.Size\r
+                    FileLineTuple = GetRealFileLine(self.FileName, self.CurrentLineNumber)\r
+                    self.Profile.PcdFileLineDict[RegionObj.PcdSize] = FileLineTuple\r
 \r
             if not self.__GetNextWord():\r
                 return True\r
@@ -1805,6 +1815,9 @@ class FdfParser:
             self.__UndoToken()\r
             self.__GetRegionDataType( RegionObj)\r
         else:\r
+            self.__UndoToken()\r
+            if self.__GetRegionLayout(Fd):\r
+                return True\r
             raise Warning("A valid region type was not found. "\r
                           "Valid types are [SET, FV, CAPSULE, FILE, DATA]. This error occurred",\r
                           self.FileName, self.CurrentLineNumber)\r
@@ -2038,27 +2051,16 @@ class FdfParser:
 \r
         self.__GetAddressStatements(FvObj)\r
 \r
-        while self.__GetBlockStatement(FvObj):\r
-            pass\r
-\r
-        self.__GetSetStatements(FvObj)\r
-        \r
-        self.__GetFvBaseAddress(FvObj)\r
-        \r
-        self.__GetFvForceRebase(FvObj)\r
-\r
-        self.__GetFvAlignment(FvObj)\r
-\r
-        self.__GetFvAttributes(FvObj)\r
-        \r
-        self.__GetFvNameGuid(FvObj)\r
-\r
         FvObj.FvExtEntryTypeValue = []\r
         FvObj.FvExtEntryType = []\r
         FvObj.FvExtEntryData = []\r
         while True:\r
-            isFvExtEntry = self.__GetFvExtEntryStatement(FvObj)\r
-            if not isFvExtEntry:\r
+            self.__GetSetStatements(FvObj)\r
+\r
+            if not (self.__GetBlockStatement(FvObj) or self.__GetFvBaseAddress(FvObj) or \r
+                self.__GetFvForceRebase(FvObj) or self.__GetFvAlignment(FvObj) or \r
+                self.__GetFvAttributes(FvObj) or self.__GetFvNameGuid(FvObj) or \r
+                self.__GetFvExtEntryStatement(FvObj)):\r
                 break\r
 \r
         self.__GetAprioriSection(FvObj, FvObj.DefineVarDict.copy())\r
@@ -2169,17 +2171,18 @@ class FdfParser:
     #   @retval None\r
     #\r
     def __GetFvAttributes(self, FvObj):\r
-\r
+        IsWordToken = False\r
         while self.__GetNextWord():\r
+            IsWordToken = True\r
             name = self.__Token\r
             if name not in ("ERASE_POLARITY", "MEMORY_MAPPED", \\r
                            "STICKY_WRITE", "LOCK_CAP", "LOCK_STATUS", "WRITE_ENABLED_CAP", \\r
                            "WRITE_DISABLED_CAP", "WRITE_STATUS", "READ_ENABLED_CAP", \\r
                            "READ_DISABLED_CAP", "READ_STATUS", "READ_LOCK_CAP", \\r
                            "READ_LOCK_STATUS", "WRITE_LOCK_CAP", "WRITE_LOCK_STATUS", \\r
-                           "WRITE_POLICY_RELIABLE"):\r
+                           "WRITE_POLICY_RELIABLE", "WEAK_ALIGNMENT"):\r
                 self.__UndoToken()\r
-                return\r
+                return False\r
 \r
             if not self.__IsToken( "="):\r
                 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
@@ -2189,7 +2192,7 @@ class FdfParser:
 \r
             FvObj.FvAttributeDict[name] = self.__Token\r
 \r
-        return\r
+        return IsWordToken\r
     \r
     ## __GetFvNameGuid() method\r
     #\r
@@ -2202,7 +2205,7 @@ class FdfParser:
     def __GetFvNameGuid(self, FvObj):\r
 \r
         if not self.__IsKeyword( "FvNameGuid"):\r
-            return\r
+            return False\r
 \r
         if not self.__IsToken( "="):\r
             raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
@@ -2212,7 +2215,7 @@ class FdfParser:
 \r
         FvObj.FvNameGuid = self.__Token\r
 \r
-        return\r
+        return True\r
 \r
     def __GetFvExtEntryStatement(self, FvObj):\r
 \r
@@ -2573,22 +2576,7 @@ class FdfParser:
             FfsFileObj.CurrentLineNum = self.CurrentLineNumber\r
             FfsFileObj.CurrentLineContent = self.__CurrentLine()\r
             FfsFileObj.FileName = self.__Token\r
-            if FfsFileObj.FileName.replace('$(WORKSPACE)', '').find('$') == -1:\r
-                #\r
-                # For file in OUTPUT_DIRECTORY will not check whether it exist or not at AutoGen phase.\r
-                #\r
-                if not GlobalData.gAutoGenPhase:\r
-                    #do case sensitive check for file path\r
-                    ErrorCode, ErrorInfo = PathClass(NormPath(FfsFileObj.FileName), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
-                    if ErrorCode != 0:\r
-                        EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
-                else:\r
-                    if not self.__GetMacroValue("OUTPUT_DIRECTORY") in FfsFileObj.FileName:\r
-                        #do case sensitive check for file path\r
-                        ErrorCode, ErrorInfo = PathClass(NormPath(FfsFileObj.FileName), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
-                        if ErrorCode != 0:\r
-                            EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)                    \r
-\r
+            self.__VerifyFile(FfsFileObj.FileName)\r
 \r
         if not self.__IsToken( "}"):\r
             raise Warning("expected '}'", self.FileName, self.CurrentLineNumber)\r
@@ -2834,11 +2822,7 @@ class FdfParser:
                 if not self.__GetNextToken():\r
                     raise Warning("expected section file path", self.FileName, self.CurrentLineNumber)\r
                 DataSectionObj.SectFileName = self.__Token\r
-                if DataSectionObj.SectFileName.replace('$(WORKSPACE)', '').find('$') == -1:\r
-                    #do case sensitive check for file path\r
-                    ErrorCode, ErrorInfo = PathClass(NormPath(DataSectionObj.SectFileName), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
-                    if ErrorCode != 0:\r
-                        EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
+                self.__VerifyFile(DataSectionObj.SectFileName)\r
             else:\r
                 if not self.__GetCglSection(DataSectionObj):\r
                     return False\r
@@ -2847,6 +2831,21 @@ class FdfParser:
 \r
         return True\r
 \r
+    ## __VerifyFile\r
+    #\r
+    #    Check if file exists or not:\r
+    #      If current phase if GenFds, the file must exist;\r
+    #      If current phase is AutoGen and the file is not in $(OUTPUT_DIRECTORY), the file must exist\r
+    #    @param FileName: File path to be verified.\r
+    #\r
+    def __VerifyFile(self, FileName):\r
+        if FileName.replace('$(WORKSPACE)', '').find('$') != -1:\r
+            return\r
+        if not GlobalData.gAutoGenPhase or not self.__GetMacroValue("OUTPUT_DIRECTORY") in FileName:\r
+            ErrorCode, ErrorInfo = PathClass(NormPath(FileName), GenFdsGlobalVariable.WorkSpaceDir).Validate()\r
+            if ErrorCode != 0:\r
+                EdkLogger.error("GenFds", ErrorCode, ExtraData=ErrorInfo)\r
+\r
     ## __GetCglSection() method\r
     #\r
     #   Get compressed or GUIDed section for Obj\r
@@ -3058,7 +3057,7 @@ class FdfParser:
     def __GetCapsuleTokens(self, Obj):\r
         if not self.__GetNextToken():\r
             return False\r
-        while self.__Token in ("CAPSULE_GUID", "CAPSULE_HEADER_SIZE", "CAPSULE_FLAGS"):\r
+        while self.__Token in ("CAPSULE_GUID", "CAPSULE_HEADER_SIZE", "CAPSULE_FLAGS", "OEM_CAPSULE_FLAGS"):\r
             Name = self.__Token.strip()\r
             if not self.__IsToken("="):\r
                 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
@@ -3075,6 +3074,17 @@ class FdfParser:
                     if not self.__Token in ("PersistAcrossReset", "PopulateSystemTable", "InitiateReset"):\r
                         raise Warning("expected PersistAcrossReset, PopulateSystemTable, or InitiateReset", self.FileName, self.CurrentLineNumber)\r
                     Value += self.__Token.strip()\r
+            elif Name == 'OEM_CAPSULE_FLAGS':\r
+                Value = self.__Token.strip()\r
+                if not Value.upper().startswith('0X'):\r
+                    raise Warning("expected hex value between 0x0000 and 0xFFFF", self.FileName, self.CurrentLineNumber)\r
+                try:\r
+                    Value = int(Value, 0)\r
+                except ValueError:\r
+                    raise Warning("expected hex value between 0x0000 and 0xFFFF", self.FileName, self.CurrentLineNumber)\r
+                if not 0x0000 <= Value <= 0xFFFF:\r
+                    raise Warning("expected hex value between 0x0000 and 0xFFFF", self.FileName, self.CurrentLineNumber)\r
+                Value = self.__Token.strip()\r
             else:\r
                 Value = self.__Token.strip()\r
             Obj.TokensDict[Name] = Value  \r
@@ -3097,7 +3107,8 @@ class FdfParser:
             IsFv = self.__GetFvStatement(Obj)\r
             IsFd = self.__GetFdStatement(Obj)\r
             IsAnyFile = self.__GetAnyFileStatement(Obj)\r
-            if not (IsInf or IsFile or IsFv or IsFd or IsAnyFile):\r
+            IsAfile = self.__GetAfileStatement(Obj)\r
+            if not (IsInf or IsFile or IsFv or IsFd or IsAnyFile or IsAfile):\r
                 break\r
 \r
     ## __GetFvStatement() method\r
@@ -3189,6 +3200,47 @@ class FdfParser:
         CapsuleAnyFile.FileName = AnyFileName\r
         CapsuleObj.CapsuleDataList.append(CapsuleAnyFile)\r
         return True\r
+    \r
+    ## __GetAfileStatement() method\r
+    #\r
+    #   Get Afile for capsule\r
+    #\r
+    #   @param  self        The object pointer\r
+    #   @param  CapsuleObj  for whom Afile is got\r
+    #   @retval True        Successfully find a Afile statement\r
+    #   @retval False       Not able to find a Afile statement\r
+    #\r
+    def __GetAfileStatement(self, CapsuleObj):\r
+\r
+        if not self.__IsKeyword("APPEND"):\r
+            return False\r
+\r
+        if not self.__IsToken("="):\r
+            raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
+\r
+        if not self.__GetNextToken():\r
+            raise Warning("expected Afile name", self.FileName, self.CurrentLineNumber)\r
+        \r
+        AfileName = self.__Token\r
+        AfileBaseName = os.path.basename(AfileName)\r
+        \r
+        if os.path.splitext(AfileBaseName)[1]  not in [".bin",".BIN",".Bin",".dat",".DAT",".Dat",".data",".DATA",".Data"]:\r
+            raise Warning('invalid binary file type, should be one of "bin","BIN","Bin","dat","DAT","Dat","data","DATA","Data"', \\r
+                          self.FileName, self.CurrentLineNumber)\r
+        \r
+        if not os.path.isabs(AfileName):\r
+            AfileName = GenFdsGlobalVariable.ReplaceWorkspaceMacro(AfileName)\r
+            self.__VerifyFile(AfileName)\r
+        else:\r
+            if not os.path.exists(AfileName):\r
+                raise Warning('%s does not exist' % AfileName, self.FileName, self.CurrentLineNumber)\r
+            else:\r
+                pass\r
+\r
+        CapsuleAfile = CapsuleData.CapsuleAfile()\r
+        CapsuleAfile.FileName = AfileName\r
+        CapsuleObj.CapsuleDataList.append(CapsuleAfile)\r
+        return True\r
 \r
     ## __GetRule() method\r
     #\r