vivado_timing_proto.xml 15.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
<?xml version="1.0" encoding="UTF-8"?>
<!-- 
 /*******************************************************************************
 * Copyright (c) 2014 Elphel, Inc.
 * This file is a part of Eclipse/VDT plug-in.
 * Eclipse/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.
 *
 * Eclipse/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/>.
Andrey Filippov's avatar
Andrey Filippov committed
18 19 20 21 22 23 24 25 26
 * 
 *  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.}
27 28 29
 *******************************************************************************/
 -->
<vdt-project>
Andrey Filippov's avatar
Andrey Filippov committed
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
	<interface name="VivadoReportTimingInterface" extends="VivadoInterface">
	    <typedef name = "Cardinal_0_3">
            <paramtype kind="number" lo="0" hi="3" format="%d" />
        </typedef>
		<typedef name="DelayTypeType">
      		<paramtype kind= "enum" base="String">
      			<item value="min"      label="Analyse minimal delays"/>
      			<item value="max"      label="Analyze maximal maximal"/>
      			<item value="min_max"  label="Analyze both minimal and maximal delays"/>
      			<item value="max_rise" label="Analyze maximal delays for rising fronts"/>
      			<item value="max_fall" label="Analyze maximal delays for falling fronts"/>
      			<item value="min_rise" label="Analyze minimal delays for rising fronts"/>
      			<item value="min_fall" label="Analyze minimal delays for falling fronts"/>
      		</paramtype>
    	</typedef>
	    <typedef name="PathTypeType">
      		<paramtype kind= "enum" base="String">
      			<item value="end"                 label="Shows the endpoint of the path only, with calculated timing values."/>
      			<item value="summary"             label="Displays the startpoints and endpoints with slack calculation."/>
      			<item value="short"               label="Displays the startpoints and endpoints with calculated timing values."/>
      			<item value="full"                label="Displays the full timing path, including startpoints, through points, and endpoints."/>
      			<item value="full_clock"          label="Displays full clock paths in addition to the full timing path."/>
      			<item value="full_clock_expanded" label="Displays full clock paths between a master clock and generated clocks in addition to the full_clock timing path."/>
      		</paramtype>
    	</typedef>
	    <typedef name="SortByType">
      		<paramtype kind= "enum" base="String">
      			<item value="slack"             label="Sort results by slack value."/>
      			<item value="group"             label="Sort results by path groups."/>
      		</paramtype>
    	</typedef>
	    <typedef name="MatchStyleType">
      		<paramtype kind= "enum" base="String">
      			<item value="sdc"             label="Pattern matching style - SDC."/>
      			<item value="ucf"             label="Pattern matching style UCF (obsolete, but default)."/>
      		</paramtype>
    	</typedef>
	
	</interface>

	<tool name="VivadoReportTiming" label="Report Timimg"
	    project="FPGA_project"
		interface="VivadoReportTimingInterface"
		package="FPGA_package"
		shell="/bin/bash"
		description="Report timing"
		log-dir="VivadoLogDir"
		state-dir="VivadoLocalDir"
		disable="DisableVivadoTiming"
		abstract="true"
Andrey Filippov's avatar
Andrey Filippov committed
80 81
		inherits="VivadoToolPrototype"
		priority="0.5"
Andrey Filippov's avatar
Andrey Filippov committed
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
		>
		<action-menu>
			<action label="Report timing" resource="" icon="clock.png" />
		</action-menu>
		<parameter id="DisableVivadoTiming" label="Disable" tooltip="Disable timing report"
		           default="false" type= "Boolean" format="None"/>

		<parameter id="SkipTCL" label="Skip TCL commands" tooltip="Do not run pre-timing summary TCL commands"
		           default="false" type= "Boolean" format="None"/>
                   
		<parameter id="PreTCL" label="Pre timing summary TCL commands" tooltip="TCL commands to run before timing summary"
			type="Stringlist" format="ProgramSyntax" default="" omit=""
			readonly="false" visible="true" />
  
<!-- report_timing arguments -->
        <parameter 	id="from" label="From"
                    tooltip= "The starting points of the timing paths to be analyzed."
        			default="" visible="true" omit="" type="String" format="Dash"/>

        <parameter 	id="rise_from" label="From (rise only)"
                    tooltip= "As -from, but only rising edges analyzed."
        			default="" visible="true" omit="" type="String" format="Dash"/>

        <parameter 	id="fall_from" label="From (fall only)"
                    tooltip= "As -from, but only falling edges analyzed."
        			default="" visible="true" omit="" type="String" format="Dash"/>

        <parameter 	id="to" label="To"
                    tooltip= "The end points of the timing paths to be analyzed."
        			default="" visible="true" omit="" type="String" format="Dash"/>

        <parameter 	id="rise_to" label="To (rise only)"
                    tooltip= "As -to, but only rising edges analyzed."
        			default="" visible="true" omit="" type="String" format="Dash"/>

        <parameter 	id="fall_to" label="To (fall only)"
                    tooltip= "As -to, but only falling edges analyzed."
        			default="" visible="true" omit="" type="String" format="Dash"/>

        <parameter 	id="through" label="Through points"
                    tooltip= "The through points of the timing paths to be analyzed. Each line may have multiple points in order"
        			default="" visible="true" omit="" type="Stringlist" format="DashListIndividual"/>

        <parameter 	id="rise_through" label="Through points (rise only)"
                    tooltip= "As -to, but only rising edges analyzed."
        			default="" visible="true" omit="" type="Stringlist" format="DashListIndividual"/>

        <parameter 	id="fall_through" label="Through points (fall only)"
                    tooltip= "As -to, but only falling edges analyzed."
        			default="" visible="true" omit="" type="Stringlist" format="DashListIndividual"/>
        <parameter	id="delay_type" label="Delay type" tooltip= "Delay types to analyze."
        			default="max" visible="true" omit="max" type="DelayTypeType" format="Dash"/>

        <parameter 	id="setup" label="Check for setup violations" tooltip= "Same as -delay_type max."
        			default="false" visible="true" omit="false" type="Boolean" format="DashName"/>

        <parameter 	id="hold" label="Check for hold violations" tooltip= "Same as -delay_type min."
        			default="false" visible="true" omit="false" type="Boolean" format="DashName"/>

        <parameter	id="max_paths"  label="Number of paths per group"
                    tooltip= "Maximal number of paths to report per group."
        			default="1"  visible="true" omit="1" type="Cardinal_1" format="Dash"/>

        <parameter	id="nworst" label="Number of paths" tooltip= "Maximal number of paths per endpoint."
        			default="1"  visible="true" omit="1" type="Cardinal_1" format="Dash"/>

        <parameter 	id="unique_pins" label="One path per unique set"
                    tooltip= "Only report timing paths through each unique set of pins,  reporting one path per path group."
        			default="false" visible="true" omit="false" type="Boolean" format="DashName"/>

        <parameter	id="path_type" label="Path type" tooltip= "Specify the path data to output in the timing summary report."
        			default="full_clock_expanded" visible="true" omit="full_clock_expanded" type="PathTypeType" format="Dash"/>

        <parameter 	id="input_pins" label="Show input pins" tooltip= "Show input pins in the timing path report."
        			default="false" visible="true" omit="false" type="Boolean" format="DashName"/>

        <parameter 	id="no_header" label="No header" tooltip= "Do not add header information to the report."
        			default="false" visible="true" omit="false" type="Boolean" format="DashName"/>

        <parameter 	id="slack_lesser_than" label="Slack lesser than"
                    tooltip= "Report timing on paths with a calculated slack value less than the specified value."
        			default="" visible="true" omit="" type="String" format="Dash"/>

        <parameter 	id="slack_greater_than" label="Slack greater than"
                    tooltip= "Report timing on paths with a calculated slack value greater than the specified value."
        			default="" visible="true" omit="" type="String" format="Dash"/>

        <parameter 	id="group" label="Report paths for groups"
                    tooltip= "Report timing for paths in the specified path groups."
        			default="" visible="true" omit="" type="String" format="Dash"/>

        <parameter	id="sort_by" label="Sort by" tooltip= "Sort timing paths in the report."
        			default="slack" visible="true" omit="slack" type="SortByType" format="Dash"/>

        <parameter 	id="no_report_unconstrained" label="Do not report unconstrained paths."
                    tooltip= "Do not report timing on unconstrained paths in the design  (mutually exclusive with -user_ignored)."
        			default="false" visible="true" omit="false" type="Boolean" format="DashName"/>

        <parameter 	id="user_ignored" label="Report only ignored paths."
                    tooltip= "Report only paths that are usually ignored (mutually exclusive with -no_report_unconstrained)."
        			default="false" visible="true" omit="false" type="Boolean" format="DashName"/>

        <parameter	id="match_style" label="Pattern match style" tooltip= "Pattern matching style."
        			default="ucf" visible="true" omit="ucf" type="MatchStyleType" format="Dash"/>

        <parameter 	id="of_objects" label="Report timing objects"
                    tooltip= "Report timing for paths in the specified timing objects. Not compatible with -from*, -to* and -through* options."
        			default="" visible="true" omit="" type="String" format="Dash"/>

        <parameter	id="significant_digits" label="Number of digits" tooltip= "Number of significat digits ion the output."
        			default="3"  visible="true" omit="3" type="Cardinal_0_3" format="Dash"/>

        <parameter 	id="rawfile" label="Result filename" tooltip= "Write report to the specified file."
        			default="%%ProjectName.timing" visible="true" omit="" type="String" format="CopyValue"/>

        <parameter 	id="append" label="Append to file" tooltip= "Append to the output file."
        			default="false" visible="true" omit="false" type="Boolean" format="DashName"/>

        <parameter 	id="return_string" label="Return string" tooltip= "Write result to TCL to be captured into variable."
        			default="" visible="true" omit="" type="String" format="Dash"/>

        <parameter	id="quiet" outid="quiet" label="Quiet" tooltip= "Ignore errors, return TCL_OK in any case"
        			default="false" visible="true" omit="false" type="Boolean" format="DashName"/>

        <parameter	id="verbose" outid="verbose" label="Verbose" tooltip= "Temporarily override message limits set with set_msg_config"
        			default="false" visible="true" omit="false" type="Boolean" format="DashName"/>

209 210 211
<!-- parser parameters - will have different values than the base tool -->
        <parameter id="parsers_path"/>
        <parameter id="parser_name"/>
Andrey Filippov's avatar
Andrey Filippov committed
212 213 214
        <parameter id="PatternErrors"/>
        <parameter id="PatternWarnings"/>
        <parameter id="PatternInfo"/>
215 216 217 218
        <parameter id="InstanceCapture"/>
        <parameter id="InstanceSeparator"/>
        <parameter id="InstanceSuffix"/>
        <parameter id="parser_mode"/>
Andrey Filippov's avatar
Andrey Filippov committed
219 220 221 222 223 224 225 226 227 228 229 230
        <parameter id="NoFileProblem"/>
        <parameter id="Drc"/>
        <parameter id="Vivado_Tcl"/>
        <parameter id="Route"/>
        <parameter id="Memdata"/>
        <parameter id="Synth"/>
        <parameter id="Netlist"/>
        <parameter id="Opt"/>
        <parameter id="Project"/>
        <parameter id="Timing"/>
        <parameter id="Pwropt"/>
        <parameter id="OtherProblems"/>
231 232 233 234 235
        <parameter id="ShowWarnings"/>
        <parameter id="ShowInfo"/>
        <parameter id="PreGrepW"/>
        <parameter id="PreGrepI"/>
        <parameter id="GrepEWI"/>
236
        <parameter id="MaxMsg"/>
237

Andrey Filippov's avatar
Andrey Filippov committed
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
		<!-- Invisible (calculated) parameters -->
		<!--  same value as %file, but will appear withou "-file" prefix --> 
        <parameter 	id="file" default="%VivadoRemoteDir/%rawfile" visible="false" omit="" type="String" format="Dash"/>
		<input>
			<group name="General">
				"DisableVivadoTiming"
				"SkipTCL"
			</group>
			<group name="TCL commands">
		        "PreTCL"
			</group>
			<group name="Timing Report">
				"from"
				"rise_from"
				"fall_from"
				"to"
				"rise_to"
				"fall_to"
				"through"
				"rise_through"
				"fall_through"
				"delay_type"
				"setup"
				"hold"
				"max_paths"
				"nworst"
				"unique_pins"
				"path_type"
				"input_pins"
				"no_header"
				"slack_lesser_than"
				"slack_greater_than"
				"group"
				"sort_by"
				"no_report_unconstrained"
				"user_ignored"
				"match_style"
				"of_objects"
				"significant_digits"
				"rawfile"
				"append"
				"return_string"
       			"---"
				"quiet"
				"verbose"
			</group>
		</input>
		<output>
			<line name="vivado_run_timing"
			      dest="VivadoConsole"
			      mark="``" 
			      sep=" "
			      prompt="@@FINISH@@"
			      failure="ERROR"
			      log=""
Andrey Filippov's avatar
Andrey Filippov committed
293
			      stdout="parser_Vivado">
Andrey Filippov's avatar
Andrey Filippov committed
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
			    "cd ~/%VivadoProjectRoot\n"
			    "set outputDir ~/%VivadoProjectRoot/%VivadoRemoteDir\n"			      
			    "file mkdir $outputDir\n"
		        <!-- Run pre-bitstream TCL commands (if specified) -->
			    <if SkipTCL="false">
				      <if-not PreTCL="">
				      		"%PreTCL\n"
				      </if-not>
				      <if PreTCL="">
				      		"puts \"No TCL commands specified\"\n"'
				      </if>
			    </if>
			    <!-- Run routing -->
			    "report_timing "
				"%from"
				"%rise_from"
				"%fall_from"
				"%to"
				"%rise_to"
				"%fall_to"
				"%through"
				"%rise_through"
				"%fall_through"
				"%delay_type"
				"%setup"
				"%hold"
				"%max_paths"
				"%nworst"
				"%unique_pins"
				"%path_type"
				"%input_pins"
				"%no_header"
				"%slack_lesser_than"
				"%slack_greater_than"
				"%group"
				"%sort_by"
				"%no_report_unconstrained"
				"%user_ignored"
				"%match_style"
				"%of_objects"
				"%significant_digits"
				"%file"
				"%append"
				"%return_string"
				"%quiet"
				"%verbose"
				"\n"
				"puts \"@@FINISH@@\"\n"
			</line>
			<line name="vivado_copy_after_timing">
				"-c"
				"mkdir -p %VivadoLocalResultDir ;"
				"rsync -avr -e ssh"
				"%RemoteUser@%RemoteHost:%VivadoProjectRoot/%VivadoRemoteDir/%rawfile"
				"%VivadoLocalResultDir/"
			</line>
		</output>
	</tool>
</vdt-project>