## @file\r
# generate flash image\r
#\r
-# Copyright (c) 2007 - 2016, 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
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 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
+import FfsFileStatement\r
+import glob\r
+from struct import unpack\r
\r
## Version and Copyright\r
versionNumber = "1.0" + ' ' + gBUILD_VERSION\r
__version__ = "%prog Version " + versionNumber\r
-__copyright__ = "Copyright (c) 2007 - 2016, Intel Corporation All rights reserved."\r
+__copyright__ = "Copyright (c) 2007 - 2017, Intel Corporation All rights reserved."\r
\r
## Tool entrance method\r
#\r
GenFdsGlobalVariable.EdkSourceDir = os.path.normcase(os.environ['EDK_SOURCE'])\r
if (Options.debug):\r
GenFdsGlobalVariable.VerboseLogger("Using Workspace:" + Workspace)\r
+ if Options.GenfdsMultiThread:\r
+ GenFdsGlobalVariable.EnableGenfdsMultiThread = True\r
os.chdir(GenFdsGlobalVariable.WorkSpaceDir)\r
\r
# set multiple workspace\r
\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
# 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
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
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
"""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
"""Generate GUID cross reference file"""\r
- GenFds.GenerateGuidXRefFile(BuildWorkSpace, ArchList)\r
+ GenFds.GenerateGuidXRefFile(BuildWorkSpace, ArchList, FdfParserObj)\r
\r
"""Display FV space info."""\r
GenFds.DisplayFvSpaceInfo(FdfParserObj)\r
\r
GlobalData.BuildOptionPcd[i] = (TokenSpaceGuidCName, TokenCName, NewValue)\r
\r
-def BuildOptionPcdValueFormat(TokenSpaceGuidCName, TokenCName, PcdDatumType, Value):\r
- if PcdDatumType == 'VOID*':\r
- if Value.startswith('L'):\r
- if not Value[1]:\r
- EdkLogger.error('GenFds', OPTION_VALUE_INVALID, 'For Void* type PCD, when specify the Value in the command line, please use the following format: "string", L"string", B"{...}"')\r
- Value = Value[0] + '"' + Value[1:] + '"'\r
- elif Value.startswith('B'):\r
- if not Value[1]:\r
- EdkLogger.error('GenFds', OPTION_VALUE_INVALID, 'For Void* type PCD, when specify the Value in the command line, please use the following format: "string", L"string", B"{...}"')\r
- Value = Value[1:]\r
- else:\r
- if not Value[0]:\r
- EdkLogger.error('GenFds', OPTION_VALUE_INVALID, 'For Void* type PCD, when specify the Value in the command line, please use the following format: "string", L"string", B"{...}"')\r
- Value = '"' + Value + '"'\r
-\r
- IsValid, Cause = CheckPcdDatum(PcdDatumType, Value)\r
- if not IsValid:\r
- EdkLogger.error('build', FORMAT_INVALID, Cause, ExtraData="%s.%s" % (TokenSpaceGuidCName, TokenCName))\r
- if PcdDatumType == 'BOOLEAN':\r
- Value = Value.upper()\r
- if Value == 'TRUE' or Value == '1':\r
- Value = '1'\r
- elif Value == 'FALSE' or Value == '0':\r
- Value = '0'\r
- return Value\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
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
+ Parser.add_option("--genfds-multi-thread", action="store_true", dest="GenfdsMultiThread", default=False, help="Enable GenFds multi thread to generate ffs file.")\r
\r
(Options, args) = Parser.parse_args()\r
return Options\r
for DriverName in GenFdsGlobalVariable.FdfParser.Profile.OptRomDict.keys():\r
OptRomObj = GenFdsGlobalVariable.FdfParser.Profile.OptRomDict[DriverName]\r
OptRomObj.AddToBuffer(None)\r
+ @staticmethod\r
+ def GenFfsMakefile(OutputDir, FdfParser, WorkSpace, ArchList, GlobalData):\r
+ GenFdsGlobalVariable.SetEnv(FdfParser, WorkSpace, ArchList, GlobalData)\r
+ for FdName in GenFdsGlobalVariable.FdfParser.Profile.FdDict.keys():\r
+ FdObj = GenFdsGlobalVariable.FdfParser.Profile.FdDict[FdName]\r
+ FdObj.GenFd(Flag=True)\r
+\r
+ for FvName in GenFdsGlobalVariable.FdfParser.Profile.FvDict.keys():\r
+ FvObj = GenFdsGlobalVariable.FdfParser.Profile.FvDict[FvName]\r
+ FvObj.AddToBuffer(Buffer=None, Flag=True)\r
+\r
+ if GenFdsGlobalVariable.FdfParser.Profile.OptRomDict != {}:\r
+ for DriverName in GenFdsGlobalVariable.FdfParser.Profile.OptRomDict.keys():\r
+ OptRomObj = GenFdsGlobalVariable.FdfParser.Profile.OptRomDict[DriverName]\r
+ OptRomObj.AddToBuffer(Buffer=None, Flag=True)\r
+\r
+ return GenFdsGlobalVariable.FfsCmdDict\r
\r
## GetFvBlockSize()\r
#\r
ModuleObj = BuildDb.BuildObject[Key, 'COMMON', GenFdsGlobalVariable.TargetName, GenFdsGlobalVariable.ToolChainTag]\r
print ModuleObj.BaseName + ' ' + ModuleObj.ModuleType\r
\r
- def GenerateGuidXRefFile(BuildDb, ArchList):\r
+ def GenerateGuidXRefFile(BuildDb, ArchList, FdfParserObj):\r
GuidXRefFileName = os.path.join(GenFdsGlobalVariable.FvDir, "Guid.xref")\r
GuidXRefFile = StringIO.StringIO('')\r
GuidDict = {}\r
+ ModuleList = []\r
+ FileGuidList = []\r
for Arch in ArchList:\r
PlatformDataBase = BuildDb.BuildObject[GenFdsGlobalVariable.ActivePlatform, Arch, GenFdsGlobalVariable.TargetName, GenFdsGlobalVariable.ToolChainTag]\r
for ModuleFile in PlatformDataBase.Modules:\r
Module = BuildDb.BuildObject[ModuleFile, Arch, GenFdsGlobalVariable.TargetName, GenFdsGlobalVariable.ToolChainTag]\r
+ if Module in ModuleList:\r
+ continue\r
+ else:\r
+ ModuleList.append(Module)\r
GuidXRefFile.write("%s %s\n" % (Module.Guid, Module.BaseName))\r
for key, item in Module.Protocols.items():\r
GuidDict[key] = item\r
GuidDict[key] = item\r
for key, item in Module.Ppis.items():\r
GuidDict[key] = item\r
+ for FvName in FdfParserObj.Profile.FvDict:\r
+ for FfsObj in FdfParserObj.Profile.FvDict[FvName].FfsList:\r
+ if not isinstance(FfsObj, FfsFileStatement.FileStatement):\r
+ InfPath = PathClass(NormPath(mws.join(GenFdsGlobalVariable.WorkSpaceDir, FfsObj.InfFileName)))\r
+ FdfModule = BuildDb.BuildObject[InfPath, Arch, GenFdsGlobalVariable.TargetName, GenFdsGlobalVariable.ToolChainTag]\r
+ if FdfModule in ModuleList:\r
+ continue\r
+ else:\r
+ ModuleList.append(FdfModule)\r
+ GuidXRefFile.write("%s %s\n" % (FdfModule.Guid, FdfModule.BaseName))\r
+ for key, item in FdfModule.Protocols.items():\r
+ GuidDict[key] = item\r
+ for key, item in FdfModule.Guids.items():\r
+ GuidDict[key] = item\r
+ for key, item in FdfModule.Ppis.items():\r
+ GuidDict[key] = item\r
+ else:\r
+ FileStatementGuid = FfsObj.NameGuid\r
+ if FileStatementGuid in FileGuidList:\r
+ continue\r
+ else:\r
+ FileGuidList.append(FileStatementGuid)\r
+ Name = []\r
+ FfsPath = os.path.join(GenFdsGlobalVariable.FvDir, 'Ffs')\r
+ FfsPath = glob.glob(os.path.join(FfsPath, FileStatementGuid) + '*')\r
+ if not FfsPath:\r
+ continue\r
+ if not os.path.exists(FfsPath[0]):\r
+ continue\r
+ MatchDict = {}\r
+ ReFileEnds = re.compile('\S+(.ui)$|\S+(fv.sec.txt)$|\S+(.pe32.txt)$|\S+(.te.txt)$|\S+(.pic.txt)$|\S+(.raw.txt)$|\S+(.ffs.txt)$')\r
+ FileList = os.listdir(FfsPath[0])\r
+ for File in FileList:\r
+ Match = ReFileEnds.search(File)\r
+ if Match:\r
+ for Index in range(1, 8):\r
+ if Match.group(Index) and Match.group(Index) in MatchDict:\r
+ MatchDict[Match.group(Index)].append(File)\r
+ elif Match.group(Index):\r
+ MatchDict[Match.group(Index)] = [File]\r
+ if not MatchDict:\r
+ continue\r
+ if '.ui' in MatchDict:\r
+ for File in MatchDict['.ui']:\r
+ with open(os.path.join(FfsPath[0], File), 'rb') as F:\r
+ F.read()\r
+ length = F.tell()\r
+ F.seek(4)\r
+ TmpStr = unpack('%dh' % ((length - 4) / 2), F.read())\r
+ Name = ''.join([chr(c) for c in TmpStr[:-1]])\r
+ else:\r
+ FileList = []\r
+ if 'fv.sec.txt' in MatchDict:\r
+ FileList = MatchDict['fv.sec.txt']\r
+ elif '.pe32.txt' in MatchDict:\r
+ FileList = MatchDict['.pe32.txt']\r
+ elif '.te.txt' in MatchDict:\r
+ FileList = MatchDict['.te.txt']\r
+ elif '.pic.txt' in MatchDict:\r
+ FileList = MatchDict['.pic.txt']\r
+ elif '.raw.txt' in MatchDict:\r
+ FileList = MatchDict['.raw.txt']\r
+ elif '.ffs.txt' in MatchDict:\r
+ FileList = MatchDict['.ffs.txt']\r
+ else:\r
+ pass\r
+ for File in FileList:\r
+ with open(os.path.join(FfsPath[0], File), 'r') as F:\r
+ Name.append((F.read().split()[-1]))\r
+ if not Name:\r
+ continue\r
+\r
+ Name = ' '.join(Name) if type(Name) == type([]) else Name\r
+ GuidXRefFile.write("%s %s\n" %(FileStatementGuid, Name))\r
+\r
# Append GUIDs, Protocols, and PPIs to the Xref file\r
GuidXRefFile.write("\n")\r
for key, item in GuidDict.items():\r