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.2. export_data_log (::quartus::stp)

The following table displays information for the export_data_log Tcl command:

Tcl Package and Version

Belongs to ::quartus::stp

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
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 data into a VCD file
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.

Did you find the information on this page useful?

Characters remaining:

Feedback Message