Start adding Altera Quartus tools to VDT plugin

Quartus tools submenu has been added to MainDesignMenu. Tcl shell
invocation works but causes an error during launch. This is Quartus
issue as the same error appears when the shell is started from
conventional Linux console.

tools/Altera_Quartus/quartus_interface.xml

+<?xml version="1.0" encoding="UTF-8"?>
+<!-- 
+ /*******************************************************************************
+ * Copyright (c) 2015 Elphel, Inc.
+ * This file is a part of VDT plug-in.
+ * VDT plug-in is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * VDT plug-in 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ *  Additional permission under GNU GPL version 3 section 7:
+ * If you modify this Program, or any covered work, by linking or combining it
+ * with Eclipse or Eclipse plugins (or a modified version of those libraries),
+ * containing parts covered by the terms of EPL/CPL, the licensors of this
+ * Program grant you additional permission to convey the resulting work.
+ * {Corresponding Source for a non-source form of such a combination shall
+ * include the source code for the parts of Eclipse or Eclipse plugins used
+ * as well as that of the covered work.}
+ *******************************************************************************/
+ -->
+<vdt-project>
+	<interface name="QuartusInterface" extends="FPGAPprojectInterface">
+		<syntax name="GrepFilterProblemSyntax"        format='| grep --line-buffered -v  "\[%%ParamName"' />
+		<syntax name="GrepFilterProblemOtherSyntax"   format='%(| grep --line-buffered -v  "\[%%ParamValue"%|\n%)' />
+	    <typedef name="ParserModeType">
+      		<paramtype kind= "enum" base="String">
+      			<item value="0"   label="Tool output is parsed immediately"/>
+      			<item value="1"   label="Tool output is delayed by not more than 1 line when consolidating bits"/>
+      			<item value="2"   label="As '1', but do not show same bits again"/>
+      			<item value="3"   label="All tool output containg hierarchical output is delayed to the very end"/>
+      		</paramtype>
+    	</typedef>
+	</interface>
+	<!--  Abstract tools to be inherited by instances used for various Quartus tools -->	
+	<!--  Restore tool for Quartus -->
+	<tool name="RestoreQuartus" label="Restore state after Quartus tool"
+	    project="FPGA_project"
+		interface="QuartusInterface"
+		package="FPGA_package"
+		shell="/bin/bash"
+		abstract="true">
+		<output>
+			<line name="quartus_pre_restore">
+				"-c"
+				<!-- Create project directory on remote server if it did not exist -->
+				"ssh"
+				"-oBatchMode=yes"
+				"-l %RemoteUser %RemoteHost"
+				"'"
+				"mkdir -p"
+				"%QuartusProjectRoot"
+				"' ;"
+				<!-- Copy snapshot generated after synthesis from local to remote -->
+				"rsync -avr -e ssh"
+				<!--  from: -->
+				"%QuartusLocalDir/%%StateFile"
+				<!-- to: -->
+				"%RemoteUser@%RemoteHost:%QuartusProjectRoot"
+				";"
+			</line>
+			
+			<line name="quartus_restore"
+			      dest="QuartusConsole"
+			      mark="``" 
+			      sep=" "
+			      failure="ERROR"
+			      prompt="@@FINISH@@"
+			      log="">
+			      "cd ~/%QuartusProjectRoot\n"
+			      "set outputDir ~/%QuartusProjectRoot/%QuartusRemoteDir\n"			      
+			      "file mkdir $outputDir\n"
+		          "open_checkpoint %QuartusRemoteDir/%%StateFile\n"
+		          "puts \"@@FINISH@@\"\n"
+		    </line>
+		</output>
+	</tool>
+
+	<!--  Save tool for Quartus tool -->
+	<tool name="SaveQuartus"
+	    label="SaveQuartus"
+	    project="FPGA_project"
+		interface="QuartusInterface"
+		package="FPGA_package"
+		shell="/bin/bash"
+		abstract="true">
+		<output>
+			<line name="quartus_save"
+			      dest="QuartusConsole"
+			      mark="``" 
+			      sep=" "
+			      prompt="@@FINISH@@"
+			      failure="ERROR"
+			      log="">
+			      "cd ~/%QuartusProjectRoot\n"
+			      "set outputDir ~/%QuartusProjectRoot/%QuartusRemoteDir\n"			      
+			      "file mkdir $outputDir\n"
+	      		  "write_checkpoint -force %QuartusRemoteDir/%%StateFile\n"
+	      		  "puts \"@@FINISH@@\"\n"
+			</line>
+			<line name="quartus_copy_after_save">
+					"-c"
+					"mkdir -p %QuartusLocalDir ;"
+					"rsync -avr -e ssh"
+					"%RemoteUser@%RemoteHost:%QuartusProjectRoot/%QuartusRemoteDir/%%StateFile"
+					"%%StateDir/"
+			</line>
+		</output>		
+	</tool>
+	
+</vdt-project>

tools/Altera_Quartus/quartus_launch.xml

+<?xml version="1.0" encoding="UTF-8"?>
+<!-- 
+ /*******************************************************************************
+ * Copyright (c) 2015 Elphel, Inc.
+ * This file is a part of VDT plug-in.
+ * VDT plug-in is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * VDT plug-in 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ *  Additional permission under GNU GPL version 3 section 7:
+ * If you modify this Program, or any covered work, by linking or combining it
+ * with Eclipse or Eclipse plugins (or a modified version of those libraries),
+ * containing parts covered by the terms of EPL/CPL, the licensors of this
+ * Program grant you additional permission to convey the resulting work.
+ * {Corresponding Source for a non-source form of such a combination shall
+ * include the source code for the parts of Eclipse or Eclipse plugins used
+ * as well as that of the covered work.}
+ *******************************************************************************/
+ -->
+<vdt-project>
+	<tool name="Quartus"
+		label="Launch Quartus"
+		project="FPGA_project"
+		package="FPGA_package"
+		shell="/bin/bash" interface="QuartusInterface" description="Launching remote Quartus in console">	
+		<action-menu>
+			<action label="Launch Quartus" resource="" icon="door_in.png" />
+			<action label="Generate public key" resource="" icon="key.png" />
+			<action label="Setup connection to" resource="%RemoteUser@%RemoteHost"
+			        check-extension="false" check-existence="false" icon="setup.png" />
+		</action-menu>
+		<parameter   id="command" label="Shell command" default="bash"
+					type="String" format="CopyValue" visible="true" readonly="false"  />
+
+		<parameter   id="actionIndex" default="%%ChosenActionIndex"
+					type="String" format="CopyValue" visible="false"  />
+		
+		<input>
+			<group name="General">
+ 				"RemoteCommand"
+			</group>
+			<group name="Shell">
+		 		"command"
+			</group>
+		</input>
+
+		<output>
+			<if actionIndex="0">
+				<line name="Quartus"
+				      timeout="1"
+				      keep-open= "true">
+					"%QuartusShellSwitches"
+					"%QuartusPreSSH"
+					"ssh"
+					"-oBatchMode=yes"
+					<if TerminalMode = "true">
+					  "-t -t"
+					</if>
+					"%QuartusSSHSwitches"
+					"-l"
+					"%RemoteUser"
+					"%RemoteHost"
+					"'"
+					"%QuartusRemoteCommand"
+					"'"
+					"%QuartusSSHExtra"
+					"|| { echo '*** ssh connection to the server %RemoteUser@%RemoteHost failed ***';"
+					"echo 'You may need to configure connection - it is done in \"Package Setup\"';"
+					"echo 'Then generate a public key (if it is not done already), and post it to';"
+					"echo 'the remote server (currently set as %RemoteUser@%RemoteHost)';"
+					"exit 1; } ;"
+				</line>
+				<line name="quartus_check"
+					dest="QuartusConsole"
+					mark="``" 
+					sep=""
+					success="All Rights Reserved."
+					prompt="@@FINISH@@">
+					<!--success="Finished parsing RTL primitives"-->
+					"puts \"@@FINISH@@\"\n"
+				</line>
+				
+			</if>
+			<if actionIndex="1">
+				<line name="Keygen">
+					"%QuartusShellSwitches"
+					"echo \"Generating public key with command:\";"
+					"echo \"ssh-keygen -t rsa -q -f ~/.ssh/id_rsa -N ''\";"
+					"ssh-keygen -t rsa -q -f ~/.ssh/id_rsa -N ''"
+				</line>
+			</if>
+			<if actionIndex="2">
+				<line name="SSHCopyID">
+					"%QuartusShellSwitches"
+					"echo \"*********************************************\";"
+					"echo \"**                                         **\";"
+					"echo \"** This command requires you to be able    **\";"
+					"echo \"** to login to the remote system and enter **\";"
+					"echo \"** a password once to post your public key **\";"
+					"echo \"** there.                                  **\";"
+					"echo \"**                                         **\";"
+					"echo \"** For this you need 'ssh-askpass' to be   **\";"
+					"echo \"** installed in your system.               **\";"
+					"echo \"**                                         **\";"
+					"echo \"** If the command  will fail, you need to  **\";"
+					"echo \"** install 'ssh-askpass' and try again or  **\";"
+					"echo \"** just manually run:                      **\";"
+					"echo \"\n   ssh-copy-id %RemoteUser@%RemoteHost\n\";"
+					"echo \"** from the system terminal and enter your **\";"
+					"echo \"** password when prompted.                 **\";"
+					"echo \"**                                         **\";"
+					"echo \"** If you see nothing below this box, that **\";"
+					"echo \"** likely means that Eclipse is launched   **\";"
+					"echo \"** from the terminal, and the system asks  **\";"
+					"echo \"** your password (or permission to add     **\";"
+					"echo \"** key of the remote host first) in that   **\";"
+					"echo \"** terminal - just switch to it and        **\";"
+					"echo \"** complete the setup.                     **\";"
+					"echo \"**                                         **\";"
+					"echo \"*********************************************\";"
+					"ssh-copy-id %RemoteUser@%RemoteHost;"
+				</line>
+			</if>
+		</output>
+	</tool>
+</vdt-project>

tools/DesignMenu.xml

@@ -82,8 +82,7 @@
                           icon="clock.png"
                           call="ISETraceMap"/>
                	<menuitem name="ISEPAR"
-                          label="Place &amp; route design"
-                          icon="route66.png"
+                          label="Place &amp; route design" icon="route66.png"
                           call="ISEPAR"/>
                	<menuitem name="ISETracePAR"
                           label="Report post-implementation timing"
@@ -178,9 +177,16 @@
                           label="Generate bitstream"
                           icon="bitstream.png"
                           call="VivadoBitstream"/>
-                          
-                          
         </menu>
+		<menu name="Quartus"
+			label="Quartus tools"
+			icon="xilinx.png">
+			<menuitem name="Quartus Server"
+				label="Start remote Quartus session"
+				icon="door_in.png"
+				call="Quartus"/>
+		</menu>
+                          
                           
     </menu>
     

tools/FPGA_project.xml

@@ -29,8 +29,6 @@
 <vdt-project>
 	<interface name="FPGAPprojectInterface">
 		<syntax name="RemoteRootSyntax" format="%%ParamValue/%%ProjectName" />
-<!-- 	<syntax name="SourceListSyntax" format="%(%%SourceList%| %)" />
-		<syntax name="FilteredSourceListSyntax" format="%(%%FilteredSourceList%| %)" />  -->
 		<syntax name="ProgramSyntax" format="%(%%ParamValue%|\n%)" />
 		<!-- typedef -->
 	</interface>
@@ -44,7 +42,7 @@
 		<parameter id="RemoteUser" label="Remote user name" tooltip="Remote user name" type="String"
 			format="CopyValue" default="%%UserName" readonly="false" visible="true" />
 
-<!-- Vivado options -->
+		<!-- Vivado options -->
 		<parameter id="VivadoRelease" label="Vivado release" tooltip="Vivado release number (part of the path)"
 			type="String" format="CopyValue" default="2013.4" readonly="false"
 			visible="true" />
@@ -53,7 +51,7 @@
 			type="String" format="CopyValue" default="/opt/Xilinx/Vivado" readonly="false"
 			visible="true" />
 
-<!-- ISE options -->
+		<!-- ISE options -->
 		<parameter id="ISERelease" label="ISE release" tooltip="ISE release number (part of the path)"
 			type="String" format="CopyValue" default="14.7" readonly="false"
 			visible="true" />
@@ -62,8 +60,16 @@
 			type="String" format="CopyValue" default="/opt/Xilinx" readonly="false"
 			visible="true" />
 
+		<!-- Quartus options -->
+		<parameter id="QuartusRelease" label="Quartus release" tooltip="Quartus release number (part of the path)"
+			type="String" format="CopyValue" default="15.0" readonly="false"
+			visible="true" />
+
+		<parameter id="QuartusInstallationRoot" label="Quartus root" tooltip="Quartus Installation Root"
+			type="String" format="CopyValue" default="/opt/Altera" readonly="false"
+			visible="true" />
 
-<!-- Vivado advanced parameters -->
+		<!-- Vivado advanced parameters -->
 		<parameter id="TerminalMode" type="BoolYesNo" format="None"
 			default="false" label="Force terminal mode" tooltip="Force terminal mode for the remote program" />
 
@@ -102,7 +108,7 @@
 			readonly="true"
 			visible="true" />
 
-<!-- ISE advanced parameters -->
+		<!-- ISE advanced parameters -->
 		<parameter id="ISETerminalMode" type="BoolYesNo" format="None"
 			default="false" label="Force terminal mode" tooltip="Force terminal mode for the remote program" />
 
@@ -147,9 +153,36 @@
 			readonly="true"
 			visible="true" />
 
+		<!-- Quartus advanced parameters -->
+		<parameter id="QuartusTerminalMode" type="BoolYesNo" format="None"
+			default="false" label="Force terminal mode" tooltip="Force terminal mode for the remote program" />
 
-<!-- /opt/Xilinx/Vivado/2013.4/bin/vivado -mode tcl -->
+		<parameter id="QuartusShellSwitches" label="Shell switch" tooltip="Shell switches" type="String"
+			format="CopyValue" default="-c" readonly="false" visible="true" />
+
+		<parameter id="QuartusPreSSH" label="pre-ssh" tooltip="pre-ssh shell parameters"
+			type="String" format="CopyValue" default="" readonly="false" visible="true" />
+
+		<parameter id="QuartusSSHSwitches" label="ssh switches" tooltip="Other ssh switches"
+			type="String" format="CopyValue" default="" readonly="false" visible="true" />
 
+		<parameter id="QuartusSSHExtra" label="ssh extra parameters" tooltip="ssh extra parameters" type="String"
+			format="CopyValue" default="" readonly="false" visible="true" />
+
+		<parameter id="QuartusConsole" default="Quartus" label="Quartus console name" tooltip="Quartus console name in Eclipse, used by other tools"
+			type="String" format="CopyValue" visible="true" readonly="false"/>
+
+		<parameter id="QuartusRelativeExeOptions" label="Quartus launch command" tooltip="Quartus relative executable path and command options"
+			type="String" format="CopyValue" default="quartus/bin/quartus_sh -s" readonly="false"
+			visible="true" />
+
+		<parameter id="QuartusRemoteCommand" label="Remote command" tooltip="Remote ssh command"
+			type="String" format="CopyValue"
+			default="%QuartusInstallationRoot/%QuartusRelease/%QuartusRelativeExeOptions"
+			readonly="true"
+			visible="true" />
+
+		<!-- /opt/Xilinx/Vivado/2013.4/bin/vivado -mode tcl -->
         <parameter 	id="NoBabyTalk" label="No Baby talk" tooltip= "Remove licensing baby talk from INFO messages."
         			default="true" visible="true" omit="false" type="Boolean" format="DashName"/>
 			
@@ -161,6 +194,8 @@
 				"VivadoInstallationRoot"
 				"ISERelease"
 				"ISEInstallationRoot"
+				"QuartusRelease"
+				"QuartusInstallationRoot"
 			</group>
 			<group name="AdvancedVivado" label="Vivado server advanced setup">
 				"TerminalMode"
@@ -186,6 +221,16 @@
 				"ISEBinDirectory"
 				"ISEUnisimsAbsolutePath"
 			</group>
+			<group name="AdvancedQuartus" label="Quartus server advanced setup">
+				"QuartusTerminalMode"
+				"QuartusShellSwitches"
+				"QuartusPreSSH"
+				"QuartusSSHSwitches"
+				"QuartusSSHExtra"
+				"QuartusConsole"
+				"QuartusRelativeExeOptions"
+				"QuartusRemoteCommand"
+			</group>
 		</input>
 	</package>
 
@@ -223,7 +268,7 @@
 
 		<parameter id="VivadoIgnoreSource" label="Ignore source files" tooltip="Pattern to ignore source files that match this regular expression"
 			type="String" default=".*unisims.*" format="CopyValue" readonly="false" />
-<!-- ISE parameters -->			
+		<!-- ISE parameters -->			
 		<parameter id="ISEProjectRoot" label="Workspace directory" tooltip="Relative (to user home directory) path of the workspace on ISE server"
 			type="String" default="vdt_ise" format="RemoteRootSyntax" readonly="false" />
 
@@ -242,12 +287,30 @@
 
 		<parameter id="ISEIgnoreSource" label="Ignore source files" tooltip="Pattern to ignore source files that match this regular expression"
 			type="String" default=".*unisims.*" format="CopyValue" readonly="false" />
+		<!--  Quartus parameters  -->
+		<parameter	id="part" label="Device" tooltip= "FPGA part number (device) to use"
+        		default="" visible="true" omit="" type="String" format="CopyValue"/>
+		<parameter id="QuartusProjectRoot" label="Workspace directory" tooltip="Relative (to user home directory) path of the workspace on Quartus server"
+			type="String" default="vdt" format="RemoteRootSyntax" readonly="false" />
 
+		<parameter id="QuartusRemoteDir" label="Remote Quartus directory" tooltip="Remote Quartus output subdirectroy for snapshot and result files"
+			type="Pathname" default="quartus_build" format="CopyValue" readonly="false" />
 
-<!-- Calculated -->
-<!-- 	<parameter id="VivadoProjectRoot" label="" tooltip="Relative (to user home directory) path of the project on Vivado server"
-			type="String" default="vdt" format="RemoteRootSyntax" readonly="false" /> -->
+		<parameter id="QuartusLocalDir" label="Local Quartus directory" tooltip="Local project subdirectroy for Quartus snapshot files"
+			type="Pathname" default="quartus_state" format="CopyValue" readonly="false" />
+
+		<parameter id="QuartusLocalResultDir" label="Local Quartus results directory"
+		    tooltip="Local project subdirectroy for Xilinx Quartus generated result files"
+			type="Pathname" default="quartus_results" format="CopyValue" readonly="false" />
 
+		<parameter id="QuartusLogDir" label="Local Quartus tool logs directory" tooltip="Local project subdirectroy for Quartus tools log files"
+			type="Pathname" default="quartus_logs" format="CopyValue" readonly="false" />
+
+		<parameter id="QuartusIgnoreSource" label="Ignore source files" tooltip="Pattern to ignore source files that match this regular expression"
+			type="String" default="" format="CopyValue" readonly="false" />
+			
+			
+<!-- Calculated -->
 		<parameter id="SnapshotSynth"
 			label="Synthesis snapshot" tooltip="Name of Vivado snapshot archive after synthesis"
 			default="%%ProjectName-synth.dcp"
@@ -324,7 +387,7 @@
 			type="Boolean" format="None" />
  				"" <!--  same as in project -->
 
-<!-- Invisible (calculated) project-wide parameters -->			
+		<!-- Invisible (calculated) project-wide parameters -->			
 		<parameter id="SimulDirSlash" type="Pathname" visible="false"
 			default="?%SimulDir=:,%SimulDir/" format="CopyValue"/>
 		<parameter id="VivadoSedPaths" type="String" format="CopyValue"
@@ -395,10 +458,8 @@
 			default="true" visible="true" type="Boolean" format="None"/>
 
 
-
-			
 		<input>
-			<group name="Genaral" label="General parameters">
+			<group name="General" label="General parameters">
 			    "part"
 				"ImplementationTopFile"
 			</group>
@@ -459,8 +520,14 @@
 				"ISESnapshotOptPhys"
 				"ISESnapshotRoute"
 			</group>
+			<group name="Quartus" label="Quartus general properties">
+				"QuartusProjectRoot"
+				"QuartusRemoteDir"
+				"QuartusLocalDir"
+				"QuartusLocalResultDir"
+				"QuartusLogDir"
+				"QuartusIgnoreSource"
+			</group>
 		</input>
-		<output>
-		</output>
 	</project>
 </vdt-project>