Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 10/04/2021

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

Document Table of Contents open_session (::quartus::stp)

The following table displays information for the open_session Tcl command:

Tcl Package and Version

Belongs to ::quartus::stp

Syntax open_session [-h | -help] [-long_help] -name <.stp file name>
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-name <.stp file name> Signal Tap File (.stp) name

Opens a session from the specified Signal Tap File (.stp).

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
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_OK 0 INFO: Session has been opened from Signal Tap File
TCL_ERROR 1 ERROR: Can't open Signal Tap File for reading. Make sure the Signal Tap File exists and has read permission.
TCL_ERROR 1 ERROR: Session already open. Close session before attempting to open it again.
TCL_ERROR 1 ERROR: Signal Tap File contains syntax error. Make sure the Signal Tap File is formatted correctly before opening. Intel recommends that you do not manually edit Signal Tap Files, but use the Signal Tap dialog boxes in the Quartus Prime GUI.