export_data_log (::quartus::stp)

Tcl Package and Version

Syntax

export_data_log [-h | -help] [-long_help] [-clock_period <clock period> ] [-data_log <data log> ] -filename <export file name> [-format <export format> ] [-instance <instance> ] [-signal_set <signal set> ] [-trigger <trigger> ]

Arguments

-h | -help

Short help

-long_help

Long help with examples and possible return values

-clock_period <clock period>

The file name of the exported file

-data_log <data log>

Name of data log to be exported

-filename <export file name>

The file name of the exported file

-format <export format>

File format of the exported file

-instance <instance>

Name of instance that defines data log

-signal_set <signal set>

Name of signal set that defines data log

-trigger <trigger>

Name of trigger that defines data log

Description

		Exports the specified data log from the current open
		session into another file in different format.

If a data log is not explicitly specified, the last
		active one is used.

The supported file formats are Comma Separated Value
file (.csv), Value Change Dump file (.vcd), and Table
file (.tbl).

Example Usage

#opens signaltap session
open_session -name stp1.stp

#capture data to log named log1, timeout after 5 seconds if no trigger occurs
#NOTE: Use this to replicate how SignalTap GUI works.
#      Only one acquisition is saved into the .stp file upon close_session next.
if { [catch {run -instance auto_signaltap_0 -timeout 5} err_msg} {
	# Timeout event is thrown as TCL exception
	puts "ERROR: $err_msg"
}

#export last capture data into a VCD file
export_data_log -instance auto_signaltap_0 -filename log.vcd -format vcd

#capture data to log named log1, timeout after 5 seconds if no trigger occurs
#signal_set_1 and trigger_1 must exist in the data log tree as saved in the .stp file. 
#log_1 will be created to hold the acquired data. if -data_log is not specified, a log name is generated automatically.
#NOTE: Use this to save multiple acquisition data logs by executing this command in a loop.
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"
}

#export specified log entry in the data log tree into a VCD file
#signal_set_1, trigger_1, and log_1 must exist 
export_data_log -instance auto_signaltap_0 -signal_set signal_set_1 -trigger trigger_1 -data_log log_1 -filename log_1.vcd -format vcd

#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: Error occured when the specified data log was exported to a file.

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 Package and Version	Belongs to ::quartus::stp 1.0
Syntax	`export_data_log [-h \| -help] [-long_help]` `[-clock_period` <clock period> `]` `[-data_log` <data log> `]` `-filename` <export file name> `[-format` <export format> `]` `[-instance` <instance> `]` `[-signal_set` <signal set> `]` `[-trigger` <trigger> `]`
Arguments	`-h \| -help`		Short help
	`-long_help`		Long help with examples and possible return values
	`-clock_period` <clock period>		The file name of the exported file
	`-data_log` <data log>		Name of data log to be exported
	`-filename` <export file name>		The file name of the exported file
	`-format` <export format>		File format of the exported file
	`-instance` <instance>		Name of instance that defines data log
	`-signal_set` <signal set>		Name of signal set that defines data log
	`-trigger` <trigger>		Name of trigger that defines data log
Description	Exports the specified data log from the current open session into another file in different format. If a data log is not explicitly specified, the last active one is used. The supported file formats are Comma Separated Value file (.csv), Value Change Dump file (.vcd), and Table file (.tbl).
Example Usage	#opens signaltap session open_session -name stp1.stp #capture data to log named log1, timeout after 5 seconds if no trigger occurs #NOTE: Use this to replicate how SignalTap GUI works. # Only one acquisition is saved into the .stp file upon close_session next. if { [catch {run -instance auto_signaltap_0 -timeout 5} err_msg} { # Timeout event is thrown as TCL exception puts "ERROR: $err_msg" } #export last capture data into a VCD file export_data_log -instance auto_signaltap_0 -filename log.vcd -format vcd #capture data to log named log1, timeout after 5 seconds if no trigger occurs #signal_set_1 and trigger_1 must exist in the data log tree as saved in the .stp file. #log_1 will be created to hold the acquired data. if -data_log is not specified, a log name is generated automatically. #NOTE: Use this to save multiple acquisition data logs by executing this command in a loop. 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" } #export specified log entry in the data log tree into a VCD file #signal_set_1, trigger_1, and log_1 must exist export_data_log -instance auto_signaltap_0 -signal_set signal_set_1 -trigger trigger_1 -data_log log_1 -filename log_1.vcd -format vcd #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: Error occured when the specified data log was exported to a file.
	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.