]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/GenFds/GenFds.py
BaseTools: Fix the bug for CArray PCD override in command line
[mirror_edk2.git] / BaseTools / Source / Python / GenFds / GenFds.py
index a0beff039132a8eee79073c28b473ac5a72dce01..277da357af0164b75584c347ddc570eb51f4853b 100644 (file)
@@ -1,7 +1,7 @@
 ## @file\r
 # generate flash image\r
 #\r
-#  Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.<BR>\r
+#  Copyright (c) 2007 - 2017, 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
@@ -30,21 +30,23 @@ from EfiSection import EfiSection
 import StringIO\r
 import Common.TargetTxtClassObject as TargetTxtClassObject\r
 import Common.ToolDefClassObject as ToolDefClassObject\r
-import Common.DataType\r
+from Common.DataType import *\r
 import Common.GlobalData as GlobalData\r
 from Common import EdkLogger\r
 from Common.String import *\r
-from Common.Misc import DirCache,PathClass\r
+from Common.Misc import DirCache, PathClass\r
 from Common.Misc import SaveFileOnChange\r
 from Common.Misc import ClearDuplicatedInf\r
 from Common.Misc import GuidStructureStringToGuidString\r
+from Common.Misc import CheckPcdDatum\r
+from Common.Misc import BuildOptionPcdValueFormat\r
 from Common.BuildVersion import gBUILD_VERSION\r
 from Common.MultipleWorkspace import MultipleWorkspace as mws\r
 \r
 ## Version and Copyright\r
 versionNumber = "1.0" + ' ' + gBUILD_VERSION\r
 __version__ = "%prog Version " + versionNumber\r
-__copyright__ = "Copyright (c) 2007 - 2014, Intel Corporation  All rights reserved."\r
+__copyright__ = "Copyright (c) 2007 - 2017, Intel Corporation  All rights reserved."\r
 \r
 ## Tool entrance method\r
 #\r
@@ -93,7 +95,7 @@ def main():
             if 'EDK_SOURCE' in os.environ.keys():\r
                 GenFdsGlobalVariable.EdkSourceDir = os.path.normcase(os.environ['EDK_SOURCE'])\r
             if (Options.debug):\r
-                GenFdsGlobalVariable.VerboseLogger( "Using Workspace:" + Workspace)\r
+                GenFdsGlobalVariable.VerboseLogger("Using Workspace:" + Workspace)\r
         os.chdir(GenFdsGlobalVariable.WorkSpaceDir)\r
         \r
         # set multiple workspace\r
@@ -106,7 +108,7 @@ def main():
 \r
             if FdfFilename[0:2] == '..':\r
                 FdfFilename = os.path.realpath(FdfFilename)\r
-            if not os.path.isabs (FdfFilename):\r
+            if not os.path.isabs(FdfFilename):\r
                 FdfFilename = mws.join(GenFdsGlobalVariable.WorkSpaceDir, FdfFilename)\r
             if not os.path.exists(FdfFilename):\r
                 EdkLogger.error("GenFds", FILE_NOT_FOUND, ExtraData=FdfFilename)\r
@@ -118,13 +120,9 @@ def main():
 \r
         if (Options.BuildTarget):\r
             GenFdsGlobalVariable.TargetName = Options.BuildTarget\r
-        else:\r
-            EdkLogger.error("GenFds", OPTION_MISSING, "Missing build target")\r
 \r
         if (Options.ToolChain):\r
             GenFdsGlobalVariable.ToolChainTag = Options.ToolChain\r
-        else:\r
-            EdkLogger.error("GenFds", OPTION_MISSING, "Missing tool chain tag")\r
 \r
         if (Options.activePlatform):\r
             ActivePlatform = Options.activePlatform\r
@@ -138,18 +136,10 @@ def main():
 \r
             if not os.path.exists(ActivePlatform)  :\r
                 EdkLogger.error("GenFds", FILE_NOT_FOUND, "ActivePlatform doesn't exist!")\r
-\r
-            if os.path.normcase (ActivePlatform).find(Workspace) == 0:\r
-                ActivePlatform = mws.relpath(ActivePlatform, Workspace)\r
-            if len(ActivePlatform) > 0 :\r
-                if ActivePlatform[0] == '\\' or ActivePlatform[0] == '/':\r
-                    ActivePlatform = ActivePlatform[1:]\r
-            else:\r
-                EdkLogger.error("GenFds", FILE_NOT_FOUND, "ActivePlatform doesn't exist!")\r
         else:\r
             EdkLogger.error("GenFds", OPTION_MISSING, "Missing active platform")\r
 \r
-        GenFdsGlobalVariable.ActivePlatform = PathClass(NormPath(ActivePlatform), Workspace)\r
+        GenFdsGlobalVariable.ActivePlatform = PathClass(NormPath(ActivePlatform))\r
 \r
         if (Options.ConfDirectory):\r
             # Get alternate Conf location, if it is absolute, then just use the absolute directory name\r
@@ -163,12 +153,31 @@ def main():
                 # This also handles someone specifying the Conf directory in the workspace. Using --conf=Conf\r
                 ConfDirectoryPath = os.path.join(GenFdsGlobalVariable.WorkSpaceDir, ConfDirectoryPath)\r
         else:\r
-            # Get standard WORKSPACE/Conf, use the absolute path to the WORKSPACE/Conf\r
-            ConfDirectoryPath = mws.join(GenFdsGlobalVariable.WorkSpaceDir, 'Conf')\r
+            if "CONF_PATH" in os.environ.keys():\r
+                ConfDirectoryPath = os.path.normcase(os.environ["CONF_PATH"])\r
+            else:\r
+                # Get standard WORKSPACE/Conf, use the absolute path to the WORKSPACE/Conf\r
+                ConfDirectoryPath = mws.join(GenFdsGlobalVariable.WorkSpaceDir, 'Conf')\r
         GenFdsGlobalVariable.ConfDir = ConfDirectoryPath\r
         BuildConfigurationFile = os.path.normpath(os.path.join(ConfDirectoryPath, "target.txt"))\r
         if os.path.isfile(BuildConfigurationFile) == True:\r
-            TargetTxtClassObject.TargetTxtClassObject(BuildConfigurationFile)\r
+            TargetTxt = TargetTxtClassObject.TargetTxtClassObject()\r
+            TargetTxt.LoadTargetTxtFile(BuildConfigurationFile)\r
+            # if no build target given in command line, get it from target.txt\r
+            if not GenFdsGlobalVariable.TargetName:\r
+                BuildTargetList = TargetTxt.TargetTxtDictionary[DataType.TAB_TAT_DEFINES_TARGET]\r
+                if len(BuildTargetList) != 1:\r
+                    EdkLogger.error("GenFds", OPTION_VALUE_INVALID, ExtraData="Only allows one instance for Target.")\r
+                GenFdsGlobalVariable.TargetName = BuildTargetList[0]\r
+\r
+            # if no tool chain given in command line, get it from target.txt\r
+            if not GenFdsGlobalVariable.ToolChainTag:\r
+                ToolChainList = TargetTxt.TargetTxtDictionary[DataType.TAB_TAT_DEFINES_TOOL_CHAIN_TAG]\r
+                if ToolChainList == None or len(ToolChainList) == 0:\r
+                    EdkLogger.error("GenFds", RESOURCE_NOT_AVAILABLE, ExtraData="No toolchain given. Don't know how to build.")\r
+                if len(ToolChainList) != 1:\r
+                    EdkLogger.error("GenFds", OPTION_VALUE_INVALID, ExtraData="Only allows one instance for ToolChain.")\r
+                GenFdsGlobalVariable.ToolChainTag = ToolChainList[0]\r
         else:\r
             EdkLogger.error("GenFds", FILE_NOT_FOUND, ExtraData=BuildConfigurationFile)\r
 \r
@@ -183,6 +192,8 @@ def main():
                     Pair = Pair[:-1]\r
                 List = Pair.split('=')\r
                 if len(List) == 2:\r
+                    if not List[1].strip():\r
+                        EdkLogger.error("GenFds", OPTION_VALUE_INVALID, ExtraData="No Value given for Macro %s" %List[0])\r
                     if List[0].strip() == "EFI_SOURCE":\r
                         GlobalData.gEfiSource = List[1].strip()\r
                         GlobalData.gGlobalDefines["EFI_SOURCE"] = GlobalData.gEfiSource\r
@@ -199,6 +210,14 @@ def main():
                     GlobalData.gCommandLineDefines[List[0].strip()] = "TRUE"\r
         os.environ["WORKSPACE"] = Workspace\r
 \r
+        # Use the -t and -b option as gGlobalDefines's TOOLCHAIN and TARGET if they are not defined\r
+        if "TARGET" not in GlobalData.gGlobalDefines.keys():\r
+            GlobalData.gGlobalDefines["TARGET"] = GenFdsGlobalVariable.TargetName\r
+        if "TOOLCHAIN" not in GlobalData.gGlobalDefines.keys():\r
+            GlobalData.gGlobalDefines["TOOLCHAIN"] = GenFdsGlobalVariable.ToolChainTag\r
+        if "TOOL_CHAIN_TAG" not in GlobalData.gGlobalDefines.keys():\r
+            GlobalData.gGlobalDefines['TOOL_CHAIN_TAG'] = GenFdsGlobalVariable.ToolChainTag\r
+\r
         """call Workspace build create database"""\r
         GlobalData.gDatabasePath = os.path.normpath(os.path.join(ConfDirectoryPath, GlobalData.gDatabasePath))\r
         BuildWorkSpace = WorkspaceDatabase(GlobalData.gDatabasePath)\r
@@ -274,9 +293,36 @@ def main():
                 EdkLogger.error("GenFds", OPTION_VALUE_INVALID,\r
                                 "No such a Capsule in FDF file: %s" % Options.uiCapName)\r
 \r
+        GenFdsGlobalVariable.WorkSpace = BuildWorkSpace\r
+        if ArchList != None:\r
+            GenFdsGlobalVariable.ArchList = ArchList\r
+\r
+        if Options.OptionPcd:\r
+            GlobalData.BuildOptionPcd = Options.OptionPcd\r
+            CheckBuildOptionPcd()\r
+\r
         """Modify images from build output if the feature of loading driver at fixed address is on."""\r
         if GenFdsGlobalVariable.FixedLoadAddress:\r
             GenFds.PreprocessImage(BuildWorkSpace, GenFdsGlobalVariable.ActivePlatform)\r
+\r
+        # Record the FV Region info that may specific in the FD\r
+        if FdfParserObj.Profile.FvDict and FdfParserObj.Profile.FdDict:\r
+            for Fv in FdfParserObj.Profile.FvDict:\r
+                FvObj = FdfParserObj.Profile.FvDict[Fv]\r
+                for Fd in FdfParserObj.Profile.FdDict:\r
+                    FdObj = FdfParserObj.Profile.FdDict[Fd]\r
+                    for RegionObj in FdObj.RegionList:\r
+                        if RegionObj.RegionType != 'FV':\r
+                            continue\r
+                        for RegionData in RegionObj.RegionDataList:\r
+                            if FvObj.UiFvName.upper() == RegionData.upper():\r
+                                if FvObj.FvRegionInFD:\r
+                                    if FvObj.FvRegionInFD != RegionObj.Size:\r
+                                        EdkLogger.error("GenFds", FORMAT_INVALID, "The FV %s's region is specified in multiple FD with different value." %FvObj.UiFvName)\r
+                                else:\r
+                                    FvObj.FvRegionInFD = RegionObj.Size\r
+                                    RegionObj.BlockInfoOfRegion(FdObj.BlockSizeList, FvObj)\r
+\r
         """Call GenFds"""\r
         GenFds.GenFd('', FdfParserObj, BuildWorkSpace, ArchList)\r
 \r
@@ -287,7 +333,7 @@ def main():
         GenFds.DisplayFvSpaceInfo(FdfParserObj)\r
 \r
     except FdfParser.Warning, X:\r
-        EdkLogger.error(X.ToolName, FORMAT_INVALID, File=X.FileName, Line=X.LineNumber, ExtraData=X.Message, RaiseError = False)\r
+        EdkLogger.error(X.ToolName, FORMAT_INVALID, File=X.FileName, Line=X.LineNumber, ExtraData=X.Message, RaiseError=False)\r
         ReturnCode = FORMAT_INVALID\r
     except FatalError, X:\r
         if Options.debug != None:\r
@@ -300,7 +346,7 @@ def main():
                     "\nPython",\r
                     CODE_ERROR,\r
                     "Tools code failure",\r
-                    ExtraData="Please send email to edk2-devel@lists.sourceforge.net for help, attaching following call stack trace!\n",\r
+                    ExtraData="Please send email to edk2-devel@lists.01.org for help, attaching following call stack trace!\n",\r
                     RaiseError=False\r
                     )\r
         EdkLogger.quiet(traceback.format_exc())\r
@@ -316,7 +362,146 @@ def SingleCheckCallback(option, opt_str, value, parser):
         gParamCheck.append(option)\r
     else:\r
         parser.error("Option %s only allows one instance in command line!" % option)\r
-        \r
+\r
+def CheckBuildOptionPcd():\r
+    for Arch in GenFdsGlobalVariable.ArchList:\r
+        PkgList  = GenFdsGlobalVariable.WorkSpace.GetPackageList(GenFdsGlobalVariable.ActivePlatform, Arch, GenFdsGlobalVariable.TargetName, GenFdsGlobalVariable.ToolChainTag)\r
+        for i, pcd in enumerate(GlobalData.BuildOptionPcd):\r
+            if type(pcd) is tuple:\r
+                continue\r
+            (pcdname, pcdvalue) = pcd.split('=')\r
+            if not pcdvalue:\r
+                EdkLogger.error('GenFds', OPTION_MISSING, "No Value specified for the PCD %s." % (pcdname))\r
+            if '.' in pcdname:\r
+                (TokenSpaceGuidCName, TokenCName) = pcdname.split('.')\r
+                HasTokenSpace = True\r
+            else:\r
+                TokenCName = pcdname\r
+                TokenSpaceGuidCName = ''\r
+                HasTokenSpace = False\r
+            TokenSpaceGuidCNameList = []\r
+            FoundFlag = False\r
+            PcdDatumType = ''\r
+            NewValue = ''\r
+            for package in PkgList:\r
+                for key in package.Pcds:\r
+                    PcdItem = package.Pcds[key]\r
+                    if HasTokenSpace:\r
+                        if (PcdItem.TokenCName, PcdItem.TokenSpaceGuidCName) == (TokenCName, TokenSpaceGuidCName):\r
+                            PcdDatumType = PcdItem.DatumType\r
+                            NewValue = BuildOptionPcdValueFormat(TokenSpaceGuidCName, TokenCName, PcdDatumType, pcdvalue)\r
+                            FoundFlag = True\r
+                    else:\r
+                        if PcdItem.TokenCName == TokenCName:\r
+                            if not PcdItem.TokenSpaceGuidCName in TokenSpaceGuidCNameList:\r
+                                if len (TokenSpaceGuidCNameList) < 1:\r
+                                    TokenSpaceGuidCNameList.append(PcdItem.TokenSpaceGuidCName)\r
+                                    PcdDatumType = PcdItem.DatumType\r
+                                    TokenSpaceGuidCName = PcdItem.TokenSpaceGuidCName\r
+                                    NewValue = BuildOptionPcdValueFormat(TokenSpaceGuidCName, TokenCName, PcdDatumType, pcdvalue)\r
+                                    FoundFlag = True\r
+                                else:\r
+                                    EdkLogger.error(\r
+                                            'GenFds',\r
+                                            PCD_VALIDATION_INFO_ERROR,\r
+                                            "The Pcd %s is found under multiple different TokenSpaceGuid: %s and %s." % (TokenCName, PcdItem.TokenSpaceGuidCName, TokenSpaceGuidCNameList[0])\r
+                                            )\r
+\r
+            GlobalData.BuildOptionPcd[i] = (TokenSpaceGuidCName, TokenCName, NewValue)\r
+\r
+\r
+## FindExtendTool()\r
+#\r
+#  Find location of tools to process data\r
+#\r
+#  @param  KeyStringList    Filter for inputs of section generation\r
+#  @param  CurrentArchList  Arch list\r
+#  @param  NameGuid         The Guid name\r
+#\r
+def FindExtendTool(KeyStringList, CurrentArchList, NameGuid):\r
+    ToolDb = ToolDefClassObject.ToolDefDict(GenFdsGlobalVariable.ConfDir).ToolsDefTxtDatabase\r
+    # if user not specify filter, try to deduce it from global data.\r
+    if KeyStringList == None or KeyStringList == []:\r
+        Target = GenFdsGlobalVariable.TargetName\r
+        ToolChain = GenFdsGlobalVariable.ToolChainTag\r
+        if ToolChain not in ToolDb['TOOL_CHAIN_TAG']:\r
+            EdkLogger.error("GenFds", GENFDS_ERROR, "Can not find external tool because tool tag %s is not defined in tools_def.txt!" % ToolChain)\r
+        KeyStringList = [Target + '_' + ToolChain + '_' + CurrentArchList[0]]\r
+        for Arch in CurrentArchList:\r
+            if Target + '_' + ToolChain + '_' + Arch not in KeyStringList:\r
+                KeyStringList.append(Target + '_' + ToolChain + '_' + Arch)\r
+\r
+    if GenFdsGlobalVariable.GuidToolDefinition:\r
+        if NameGuid in GenFdsGlobalVariable.GuidToolDefinition.keys():\r
+            return GenFdsGlobalVariable.GuidToolDefinition[NameGuid]\r
+\r
+    ToolDefinition = ToolDefClassObject.ToolDefDict(GenFdsGlobalVariable.ConfDir).ToolsDefTxtDictionary\r
+    ToolPathTmp = None\r
+    ToolOption = None\r
+    ToolPathKey = None\r
+    ToolOptionKey = None\r
+    KeyList = None\r
+    for ToolDef in ToolDefinition.items():\r
+        if NameGuid == ToolDef[1]:\r
+            KeyList = ToolDef[0].split('_')\r
+            Key = KeyList[0] + \\r
+                  '_' + \\r
+                  KeyList[1] + \\r
+                  '_' + \\r
+                  KeyList[2]\r
+            if Key in KeyStringList and KeyList[4] == 'GUID':\r
+                ToolPathKey   = Key + '_' + KeyList[3] + '_PATH'\r
+                ToolOptionKey = Key + '_' + KeyList[3] + '_FLAGS'\r
+                ToolPath = ToolDefinition.get(ToolPathKey)\r
+                ToolOption = ToolDefinition.get(ToolOptionKey)\r
+                if ToolPathTmp == None:\r
+                    ToolPathTmp = ToolPath\r
+                else:\r
+                    if ToolPathTmp != ToolPath:\r
+                        EdkLogger.error("GenFds", GENFDS_ERROR, "Don't know which tool to use, %s or %s ?" % (ToolPathTmp, ToolPath))\r
+\r
+    BuildOption = {}\r
+    for Arch in CurrentArchList:\r
+        Platform = GenFdsGlobalVariable.WorkSpace.BuildObject[GenFdsGlobalVariable.ActivePlatform, Arch, GenFdsGlobalVariable.TargetName, GenFdsGlobalVariable.ToolChainTag]\r
+        # key is (ToolChainFamily, ToolChain, CodeBase)\r
+        for item in Platform.BuildOptions:\r
+            if '_PATH' in item[1] or '_FLAGS' in item[1] or '_GUID' in item[1]:\r
+                if not item[0] or (item[0] and GenFdsGlobalVariable.ToolChainFamily== item[0]):\r
+                    if item[1] not in BuildOption:\r
+                        BuildOption[item[1]] = Platform.BuildOptions[item]\r
+        if BuildOption:\r
+            ToolList = [TAB_TOD_DEFINES_TARGET, TAB_TOD_DEFINES_TOOL_CHAIN_TAG, TAB_TOD_DEFINES_TARGET_ARCH]\r
+            for Index in range(2, -1, -1):\r
+                for Key in dict(BuildOption):\r
+                    List = Key.split('_')\r
+                    if List[Index] == '*':\r
+                        for String in ToolDb[ToolList[Index]]:\r
+                            if String in [Arch, GenFdsGlobalVariable.TargetName, GenFdsGlobalVariable.ToolChainTag]:\r
+                                List[Index] = String\r
+                                NewKey = '%s_%s_%s_%s_%s' % tuple(List)\r
+                                if NewKey not in BuildOption:\r
+                                    BuildOption[NewKey] = BuildOption[Key]\r
+                                    continue\r
+                                del BuildOption[Key]\r
+                    elif List[Index] not in ToolDb[ToolList[Index]]:\r
+                        del BuildOption[Key]\r
+    if BuildOption:\r
+        if not KeyList:\r
+            for Op in BuildOption:\r
+                if NameGuid == BuildOption[Op]:\r
+                    KeyList = Op.split('_')\r
+                    Key = KeyList[0] + '_' + KeyList[1] +'_' + KeyList[2]\r
+                    if Key in KeyStringList and KeyList[4] == 'GUID':\r
+                        ToolPathKey   = Key + '_' + KeyList[3] + '_PATH'\r
+                        ToolOptionKey = Key + '_' + KeyList[3] + '_FLAGS'\r
+        if ToolPathKey in BuildOption.keys():\r
+            ToolPathTmp = BuildOption.get(ToolPathKey)\r
+        if ToolOptionKey in BuildOption.keys():\r
+            ToolOption = BuildOption.get(ToolOptionKey)\r
+\r
+    GenFdsGlobalVariable.GuidToolDefinition[NameGuid] = (ToolPathTmp, ToolOption)\r
+    return ToolPathTmp, ToolOption\r
+\r
 ## Parse command line options\r
 #\r
 # Using standard Python module optparse to parse command line option of this tool.\r
@@ -326,7 +511,7 @@ def SingleCheckCallback(option, opt_str, value, parser):
 #\r
 def myOptionParser():\r
     usage = "%prog [options] -f input_file -a arch_list -b build_target -p active_platform -t tool_chain_tag -D \"MacroName [= MacroValue]\""\r
-    Parser = OptionParser(usage=usage,description=__copyright__,version="%prog " + str(versionNumber))\r
+    Parser = OptionParser(usage=usage, description=__copyright__, version="%prog " + str(versionNumber))\r
     Parser.add_option("-f", "--file", dest="filename", type="string", help="Name of FDF file to convert", action="callback", callback=SingleCheckCallback)\r
     Parser.add_option("-a", "--arch", dest="archList", help="comma separated list containing one or more of: IA32, X64, IPF, ARM, AARCH64 or EBC which should be built, overrides target.txt?s TARGET_ARCH")\r
     Parser.add_option("-q", "--quiet", action="store_true", type=None, help="Disable all messages except FATAL ERRORS.")\r
@@ -349,6 +534,7 @@ def myOptionParser():
     Parser.add_option("-s", "--specifyaddress", dest="FixedAddress", action="store_true", type=None, help="Specify driver load address.")\r
     Parser.add_option("--conf", action="store", type="string", dest="ConfDirectory", help="Specify the customized Conf directory.")\r
     Parser.add_option("--ignore-sources", action="store_true", dest="IgnoreSources", default=False, help="Focus to a binary build and ignore all source files")\r
+    Parser.add_option("--pcd", action="append", dest="OptionPcd", help="Set PCD value by command line. Format: \"PcdName=Value\" ")\r
 \r
     (Options, args) = Parser.parse_args()\r
     return Options\r
@@ -503,8 +689,8 @@ class GenFds :
             if UsedSizeValue == TotalSizeValue:\r
                 Percentage = '100'\r
             else:\r
-                Percentage = str((UsedSizeValue+0.0)/TotalSizeValue)[0:4].lstrip('0.') \r
-            \r
+                Percentage = str((UsedSizeValue + 0.0) / TotalSizeValue)[0:4].lstrip('0.')\r
+\r
             GenFdsGlobalVariable.InfLogger(Name + ' ' + '[' + Percentage + '%Full] ' + str(TotalSizeValue) + ' total, ' + str(UsedSizeValue) + ' used, ' + str(FreeSizeValue) + ' free')\r
 \r
     ## PreprocessImage()\r