Sopc2DTS.java

/*
sopc2dts - Devicetree generation for Altera systems

Copyright (C) 2011 - 2015 Walter Goossens <waltergoossens@home.nl>

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.FileWriter;
import java.io.IOException;
import java.util.Vector;

import javax.swing.JFrame;

import org.xml.sax.SAXException;

import sopc2dts.LogEntry;
import sopc2dts.LogListener;
import sopc2dts.Logger;
import sopc2dts.Logger.LogLevel;
import sopc2dts.generators.AbstractSopcGenerator;
import sopc2dts.generators.GeneratorFactory;
import sopc2dts.generators.SopcCreateHeaderFilesImitator;
import sopc2dts.gui.Sopc2DTSGui;
import sopc2dts.lib.AvalonSystem;
import sopc2dts.lib.BoardInfo;
import sopc2dts.lib.BoardInfo.AltrStyle;
import sopc2dts.lib.components.BasicComponent;
import sopc2dts.lib.components.base.SICBridge;
import sopc2dts.lib.SopcComponentLib;
import sopc2dts.parsers.BasicSystemLoader;


public class Sopc2DTS implements LogListener {
	private boolean useStdOutErr = true;
	protected Vector<CommandLineOption> vOptions = new Vector<CommandLineOption>();
	protected CLParameter excludeTimeStamp = new CLParameter("" + false);
	protected CLParameter showHelp = new CLParameter(""+false);
	protected CLParameter showVersion = new CLParameter("" + false);
	protected CLParameter verbose = new CLParameter("" + false);
	protected CLParameter mimicAlteraTools = new CLParameter("" + false);
	protected CLParameter inputFileName = new CLParameter("");
	protected CLParameter boardFileName = new CLParameter("");
	protected CLParameter bridgeRemoval = new CLParameter("balanced");
	protected CLParameter outputFileName = new CLParameter("");
	protected CLParameter outputType = new CLParameter("dts");
	protected CLParameter overlayTarget = new CLParameter("");
	protected CLParameter externalFpgaConfig = new CLParameter("");
	protected CLParameter firmwareName = new CLParameter("");
	protected CLParameter pov = new CLParameter("");
	protected CLParameter povType = new CLParameter("cpu");
	protected CLParameter bootargs = new CLParameter("");
	protected CLParameter sopcParameters = new CLParameter("none");
	protected CLParameter sort = new CLParameter("");
	protected CLParameter ranges = new CLParameter("");
	protected CLParameter forceALTR = new CLParameter("" + false);
	protected CLParameter forcealtr = new CLParameter("" + false);
	protected CLParameter gui = new CLParameter("" + false);
	protected CLParameter showClocks = new CLParameter(""+false);
	protected CLParameter showConduit = new CLParameter(""+false);
	protected CLParameter showReset = new CLParameter(""+false);
	protected CLParameter showStreaming = new CLParameter(""+false);
	protected CLParameter extraComponentLibs = new CLParameter("");

	protected static final String programName = "sopc2dts";
	private static String programVersion = Package.getPackage("sopc2dts").getImplementationVersion();;
	private Vector<String> vInfoFileNames = new Vector<String>();
	private Vector<String> vdtsiFileNames = new Vector<String>();
	private Vector<String> vExtraComponentLibs = new Vector<String>();

	/**
	 * @param args
	 */
	public static void main(String[] args) {
		Sopc2DTS s2d = new Sopc2DTS();
		int res = 1;
		try {
			if(s2d.parseCmdLine(args))
			{
				res = s2d.go();
			}
		} catch(Exception e) {
			Logger.logException(e);
			s2d.printUsage();
		}
		if(res>=0)
		{
			System.exit(res);			
		}
	}
	
	public Sopc2DTS() {
		Logger.addLogListener(this);
		vOptions.add(new CommandLineOption("board", 	"b", boardFileName, 	true, false,"board description file (can be used multiple times)", "boardinfo file"));
		vOptions.add(new CommandLineOption("bridge-ranges",	 null, ranges,		true, false,"What to describe in bridges address translations", "{none,bridge,child}"));
		vOptions.add(new CommandLineOption("bridge-removal", null, bridgeRemoval, 	true, false,"Bridge removal strategy", "{all,balanced,none}"));
		vOptions.add(new CommandLineOption("help",		"h", showHelp,			false,false,"Show this usage info and exit",null));
		vOptions.add(new CommandLineOption("verbose",	"v", verbose,			false,false,"Show Lots of debugging info", null));
		vOptions.add(new CommandLineOption("force-ALTR",null,forceALTR,			false,false,"Try to make sure all compatibles and property names use uppercase 'ALTR'", null));
		vOptions.add(new CommandLineOption("force-altr",null,forcealtr,			false,false,"Try to make sure all compatibles and property names use lowercase 'altr'", null));
		vOptions.add(new CommandLineOption("gui",		"g", gui,				false,false,"Run in gui mode", null));
		vOptions.add(new CommandLineOption("clocks",	"c", showClocks,		false,false,"Show clocks in Device Tree Source / graph", null));
		vOptions.add(new CommandLineOption("conduits",	null, showConduit,		false,false,"Show conduit interfaces in graph", null));
		vOptions.add(new CommandLineOption("version",	null,showVersion,		false,false,"Show version information and exit", null));
		vOptions.add(new CommandLineOption("mimic-sopc-create-header-files"	,"m", mimicAlteraTools,		false,false,"Try to (mis)behave like sopc-create-header-files does", null));
		vOptions.add(new CommandLineOption("no-timestamp", null, excludeTimeStamp, false, false, "Don't add a timestamp to generated files", null));
		vOptions.add(new CommandLineOption("input", 	"i", inputFileName, 	true, true, "The sopcinfo file (optional in gui mode)", "sopcinfo file"));
		vOptions.add(new CommandLineOption("output",	"o", outputFileName,	true, false,"The output filename","filename"));
		vOptions.add(new CommandLineOption("overlay-target",null, overlayTarget,true, false,"Target PATH for dt-overlay","node-label"));
		vOptions.add(new CommandLineOption("firmware-name",null, firmwareName,true, false,"DTS overlay FPGA configuration RBF name, if not specified we assume external configuration","node-label"));
		vOptions.add(new CommandLineOption("pov", 		"p", pov,		 		true, false,"The point of view to generate from. Defaults to the first cpu found", "component name"));
		vOptions.add(new CommandLineOption("pov-type", 	null, povType,			true, false,"The point of view device type", "{cpu,pci,overlay}"));
		vOptions.add(new CommandLineOption("reset",		null, showReset,		false,false,"Show reset interfaces in graph", null));
		vOptions.add(new CommandLineOption("sort", 		"s", sort,		 		true, false,"Sort components by", "{none,address,name,label}"));
		vOptions.add(new CommandLineOption("streaming",	null, showStreaming,	false,false,"Show streaming interfaces in graph", null));
		vOptions.add(new CommandLineOption("type", 		"t", outputType, 		true, false,"The type of output to generate", "{dtb,dtb-hex8,dtb-hex32,dtb-char-arr,dts,uboot,kernel}"));
		vOptions.add(new CommandLineOption("bootargs", 	null,bootargs,	 		true, false,"Default kernel arguments for the \"chosen\" section of the DTS", "kernel-args"));
		vOptions.add(new CommandLineOption("sopc-parameters", 	null,sopcParameters, true, false,"What sopc-parameters to include in DTS", "{node,cmacro,all}"));
		vOptions.add(new CommandLineOption("extra-component-libs",	"e", extraComponentLibs, 	true, false,"Extra component libraries (see source for examples) (can be used many times)", "sopc component xml file"));

		if(programVersion==null) {
			programVersion = "unknown-version";
		}
	}
	protected int go()
	{
		int res = 0;
		BoardInfo bInfo = null;
		Sopc2DTSGui s2dgui = null;
		File f;
		for(String fn : vExtraComponentLibs)
		{
			SopcComponentLib.getInstance().loadComponentLibFile(fn);
		}
		if(vInfoFileNames.size()>0)
		{

			bInfo = new BoardInfo();		
			for (String fn : vInfoFileNames) {
				try {
					bInfo.load(new File(fn));
				} catch (FileNotFoundException e) {
					Logger.logException(e);
				} catch (SAXException e) {
					Logger.logException(e);
				} catch (IOException e) {
					Logger.logException(e);
				}
			}
		}
		if(bInfo==null)
		{
			bInfo = new BoardInfo();
		}
		SICBridge.setRemovalStrategy(bridgeRemoval.value);
		bInfo.setOverlayTarget(overlayTarget.value);
		bInfo.setFirmwareName(firmwareName.value);
		if(pov.value.length()>0)
		{
			bInfo.setPov(pov.value);
		}
		bInfo.setPovType(povType.value);
		bInfo.setIncludeTime(!Boolean.parseBoolean(excludeTimeStamp.value));
		if(sort.value.length()>0) {
			bInfo.setSortType(sort.value);
		}
		if(ranges.value.length()>0) {
			bInfo.setRangesStyle(ranges.value);
		}
		if(sopcParameters.value.equalsIgnoreCase("none"))
		{
			bInfo.setDumpParameters(BasicComponent.parameter_action.NONE);
		} else if(sopcParameters.value.equalsIgnoreCase("cmacro"))
		{
			bInfo.setDumpParameters(BasicComponent.parameter_action.CMACRCO);
		} else if(sopcParameters.value.equalsIgnoreCase("all"))
		{
			bInfo.setDumpParameters(BasicComponent.parameter_action.ALL);
		}
		if (Boolean.parseBoolean(showClocks.value)) {
			bInfo.showClockTree();
		}
		if (Boolean.parseBoolean(showConduit.value)) {
			bInfo.showConduits();
		}
		if (Boolean.parseBoolean(showReset.value)) {
			bInfo.showResets();
		}
		if (Boolean.parseBoolean(showStreaming.value)) {
			bInfo.showStreaming();
		}
		if (Boolean.parseBoolean(forcealtr.value)) {
			bInfo.setAltrStyle(AltrStyle.FORCE_LOWER);
		} else if (Boolean.parseBoolean(forceALTR.value)) {
			bInfo.setAltrStyle(AltrStyle.FORCE_UPPER);			
		}
		if(Boolean.parseBoolean(gui.value))
		{
			if(!Boolean.parseBoolean(mimicAlteraTools.value))
			{
				s2dgui = new Sopc2DTSGui(inputFileName.value, bInfo);
				useStdOutErr = false;
				s2dgui.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
				s2dgui.setVisible(true);
				res = -1;
			} else {
				Logger.logln("GUI-Mode is not supported when mimic-sopc-create-header-files is set", 
						LogLevel.ERROR);
				res = 1;
			}
		} else {
			if(inputFileName.value.length()==0)
			{
				System.out.println("No input file specified!");
				printUsage();
				return 1;
			}
			f = new File(inputFileName.value);
			if(f.exists())
			{
				try {
					AvalonSystem sys = BasicSystemLoader.loadSystem(f);
					sys.setSopc2DtsVer(programVersion);
					if(bInfo.getPov().length()==0)
					{
						for(int i=0; (i<sys.getSystemComponents().size()) && (bInfo.getPov().length()==0); i++)
						{
							if(sys.getSystemComponents().get(i).getScd().getGroup().equalsIgnoreCase("cpu"))
							{
								bInfo.setPov(sys.getSystemComponents().get(i).getInstanceName());
							}
						}
					}
					if(Boolean.parseBoolean(mimicAlteraTools.value)) {
						SopcCreateHeaderFilesImitator fake = new SopcCreateHeaderFilesImitator(sys);
						Vector<BasicComponent> vMasters = sys.getMasterComponents();
						for(BasicComponent master : vMasters)
						{
							BufferedWriter out = new BufferedWriter(new FileWriter(master.getInstanceName()+".h"));
							bInfo.setPov(master.getInstanceName());
							out.write(fake.getTextOutput(bInfo));
							out.close();
						}
					} else {
						String generatedText = null;
						byte[] generatedBinary = null;
						if(bootargs.value.length()>0)
						{
							bInfo.setBootArgs(bootargs.value);
						}
						AbstractSopcGenerator gen = GeneratorFactory.createGeneratorFor(sys, outputType.value);
						if(gen == null)
						{
							Logger.logln("Unable to find generator for type '" + 
									outputType.value + "'", LogLevel.ERROR);
						} else {
							if(gen.isTextOutput())
							{
								generatedText = gen.getTextOutput(bInfo);
							} else {
								generatedBinary = gen.getBinaryOutput(bInfo);
							}
						}
						if(outputFileName.value.length()==0)
						{
							if(generatedText!=null)
							{
								System.out.println(generatedText);
							} else if(generatedBinary!=null)
							{
								Logger.logln("Generated data is binary. Unable to display. Please supply an outputfilename.", LogLevel.WARNING);
							} else {
								Logger.logln("Nothing was generated.", LogLevel.ERROR);
								res = 1;
							}
						} else {
							if(generatedText != null)
							{
								BufferedWriter out = new BufferedWriter(new FileWriter(outputFileName.value));
								out.write(generatedText);
								out.close();
							} else if(generatedBinary != null)
							{
								FileOutputStream out = new FileOutputStream(outputFileName.value);
								out.write(generatedBinary);
								out.close();
							} else {
								Logger.logln("Nothing was generated.", LogLevel.ERROR);
								res = 1;
							}
						}
					}
				} catch (FileNotFoundException e) {
					Logger.logException(e);
					res = 1;
				} catch (IOException e) {
					Logger.logException(e);
					res = 1;
				}
			} else {
				Logger.logln("Inputfile " + inputFileName.value + " not found", 
						LogLevel.ERROR);
				res = 1;
			}
		}
		return res;
	}
	protected String[] intelliSplit(String inp, int splitChar)
	{
		Vector<String> vRes = new Vector<String>();
		boolean escape=false;
		boolean quoted=false;
		String tmp = "";
		int i=0;
		while(i<inp.length())
		{
			if(inp.charAt(i) == '\"') {
				if(!escape) quoted = !quoted;
				tmp+=inp.charAt(i);
				escape=false;
			} else if(inp.charAt(i) == '\\') {
				escape=true;
				tmp += inp.charAt(i);
			} else if((inp.charAt(i) == splitChar)&& !escape && !quoted) {
				if(tmp.length()>0)
				{
					vRes.add(tmp);
					tmp = "";
				}
			} else {
				tmp += inp.charAt(i);
				escape=false;
			}		
			i++;
		}
		if(tmp.length()>0)
		{
			vRes.add(tmp);
		}
		return vRes.toArray(new String[0]);
	}
	protected boolean parseCmdLine(String[] args) throws Exception
	{
		int argPos = 0;
		int oldPos = 0;
		String cmdLine = "";
		while(argPos<args.length)
		{
			cmdLine += args[argPos++] + ' '; 
		}
		argPos=0;
		args=intelliSplit(cmdLine, ' ');
		while(argPos<args.length)
		{
			oldPos = argPos;
			for(int iHandler=0; (iHandler<vOptions.size()) && (argPos<args.length); iHandler++)
			{
				argPos = vOptions.get(iHandler).scanCmdLine(args, argPos);
			}
			if(oldPos == argPos)
			{
				//No parser found!!!
				System.out.println("Option " + args[argPos] +" not understood.");
				printUsage();
				return false;
			}
		}
		if(Boolean.parseBoolean(showHelp.value))
		{
			printUsage();
			return false;
		}
		if(Boolean.parseBoolean(showVersion.value))
		{
			printVersion();
			return false;
		}
		return true;
	}

	protected void printUsage()
	{
		printVersion();
		System.out.println("Usage: " + programName + " <arguments>");
		System.out.println("Required Arguments:");
		String longOpts = "";
		String shortOpts = "";
		for(int i=0; i<vOptions.size(); i++)
		{
			if(vOptions.get(i).isRequired())
			{
				longOpts += vOptions.get(i).getDesc();
				shortOpts += vOptions.get(i).getShortDesc();
			}
		}
		System.out.println(longOpts);
		System.out.println(shortOpts);
		System.out.println("Optional Arguments:");
		longOpts = "";
		shortOpts = "";
		for(int i=0; i<vOptions.size(); i++)
		{
			if(!vOptions.get(i).isRequired())
			{
				longOpts += vOptions.get(i).getDesc();
				shortOpts += vOptions.get(i).getShortDesc();
			}
		}
		System.out.println(longOpts);
		System.out.println(shortOpts);
	}
	
	public void printVersion()
	{
		System.out.println(programName + " - " + programVersion);
	}
	
	public void messageLogged(LogEntry log) {
		if(log.getLevel().compareTo(Logger.getVerbosity())<=0)
		{
			if(useStdOutErr)
			{
				if(log.getLevel().equals(LogLevel.ERROR))
				{
					System.err.println(log);
					StackTraceElement[] trace = log.getTrace();
					for(StackTraceElement ste : trace) {
						System.err.println("\tat " + ste.toString());
					}
				} else {
					System.out.println(log);
				}
			}
		}
	}	

	protected class CLParameter
	{
		public String value;
		public CLParameter(String val)
		{
			value = val;
		}
	}
	protected class CommandLineOption
	{
		String option;
		String shortOption;
		String helpDesc;
		CLParameter parameter;
		String parameterDesc;
		boolean isRequired;
		boolean hasValue;

		public CommandLineOption(String opt, String shortOpt, CLParameter param, boolean hasVal, boolean req, String help, String paramDesc)
		{
			option = opt;
			shortOption = shortOpt;
			helpDesc = help;
			parameter = param;
			parameterDesc = paramDesc;
			isRequired = req;
			hasValue = hasVal;
			if(isRequired)
			{
				helpDesc += (" (Required)");
			} else {
				helpDesc += (" (Optional)");
			}
		}
		int scanCmdLine(String[] opts, int index) throws Exception
		{
			if(opts[index].charAt(0)!='-')
			{
				//Assume it's the sopcinfo file
				inputFileName.value = opts[index];
				index++;
			} else {
				String[] tmpOpts = intelliSplit(opts[index],'=');
				if((tmpOpts[0].equals("--" + option)) || 
						((shortOption!=null)&&(tmpOpts[0].equals('-' + shortOption))))
				{
					if(parameter!=null)
					{
						if(hasValue)
						{
							String val;
							if(tmpOpts.length==1)
							{
								if(index<(opts.length-1))
								{
									index++;
								} else {
									throw new Exception("Missing argument");
								}
								val = opts[index];
							} else {
								val = tmpOpts[1];
							}
							parameter.value = val;
						} else {
							parameter.value = "" + true;
						}
					}
					if(parameter==verbose)
					{
						if(Boolean.parseBoolean(parameter.value))
						{
							Logger.increaseVerbosity();
						}
					} else if (parameter==boardFileName) {
						vInfoFileNames.add(parameter.value);
					} else if (parameter==extraComponentLibs) {
						vExtraComponentLibs.add(parameter.value);
					}
					Logger.logln("Scanned option " + option + '(' + shortOption + ") with" +
							(hasValue ? " value " + parameter.value : "out value."), 
							LogLevel.DEBUG);
					index++;
				}
			}
			return index;
		}
		boolean isRequired()
		{
			return isRequired;
		}
		
		String getDesc()
		{
			return "  --" + option + ((!hasValue ?"\t\t" : " <" + parameterDesc + ">\t")) + helpDesc + "\n";
		}
		String getShortDesc()
		{
			if(shortOption!=null)
			{
				return "  -" + shortOption + ((!hasValue ? "\t\t" : " <" + parameterDesc + ">\t")) + "Short for --" + option + "\n";
			} else {
				return "";
			}
		}
	}	
}