Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 12/13/2021
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

3.1.30.4. run (::quartus::stp)

The following table displays information for the run Tcl command:

Tcl Package and Version

Belongs to ::quartus::stp

Syntax run [-h | -help] [-long_help] [-bridge <bridge> ] [-data_log <data log> ] [-device_name <device name> ] [-hardware_name <hardware name> ] [-instance <instance> ] [-signal_set <signal set> ] [-timeout <timeout> ] [-trigger <trigger> ]
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-bridge <bridge> Bridge to use instead of the one specified in the stp file
-data_log <data log> Name of data log to be recorded
-device_name <device name> Device to use instead of the one specified in the stp file. Tcl command, get_device_names, can be used to obtain the valid hardware names
-hardware_name <hardware name> JTAG programming hardware to use instead of the one specified in the stp file. Tcl command, get_hardware_names, can be used to obtain the valid hardware name
-instance <instance> Name of instance that defines data acquisition
-signal_set <signal set> Name of signal set that defines data acquisition
-timeout <timeout> Timeout period for data acquisition in seconds
-trigger <trigger> Name of trigger that defines data acquisition
Description

Starts data acquisition with the specified conditions in the session and saves data into the specified data log within the timeout period.

Example Usage
#opens signaltap session
open_session -name stp1.stp

#capture data to log named log1, timeout after 5 seconds if no trigger occurs
if { [catch {run -instance auto_signaltap_0 -signal_set signal_set_1 -trigger trigger_1 -data_log log_1 -timeout 5} err_msg} {
	# Timeout event is thrown as TCL exception
	puts "ERROR: $err_msg"
}

#close signaltap session
close_session
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_OK 0 INFO: Data has been acquired successfully
TCL_ERROR 1 ERROR: JTAG chain in use. Wait for JTAG communication to finish and run again.
TCL_ERROR 1 ERROR: Data acquisition stopped unexpectedly. Make sure device is stable and run again.
TCL_ERROR 1 ERROR: Trigger not compatible with device. Download a design with the current SRAM Object File after recompiling.
TCL_ERROR 1 ERROR: Instance, signal set, or trigger does not exist. Make sure the instance, signal set, and trigger exist in the Signal Tap File.
TCL_ERROR 1 ERROR: Session has not been opened. Make sure a session is open before attempting to close it.
TCL_ERROR 1 ERROR: Trigger did not occur in timeout period. Make sure trigger conditions are valid and/or increase timeout period.

Did you find the information on this page useful?