Video and Image Processing Suite User Guide

ID 683416
Date 4/04/2022
Public
Document Table of Contents

23.3.3. TCL Shell Commands

You can control the Trace System IP core components from the TCL scripting interface using trace service.

Table 76.  Trace System Commands
Command Arguments Function
get_service_paths

trace

Returns the System Console names for all the Trace System IP core components which are currently visible.
claim_service

trace

<service_path>

<library_name>

Opens a connection to the specified trace service so it can be used. Returns a new path to the opened service.
close_service

trace

<open_service>

Closes the service so that its resources can be reused.
trace_get_monitors <open_service> Returns a list of monitor IDs—one for each monitor that is available on this trace system.
trace_get_monitor_info

<open_service>

<monitor_id>

Returns a serialized array containing information about the specified monitor. You can use the array set command to convert this into a TCL array.
trace_read_monitor

<open_service>

<monitor_id>

<index>

Reads a 32-bit value from configuration space within the specified monitor.

trace_write_monitor

<open_service>

<monitor_id>

<index>

<value>

Writes a 32-bit value from configuration space within the specified monitor.

trace_get_max_db_size

<open_service>

Gets the maximum (in memory) trace database size set for this trace system. If the trace database size exceeds this value, then the oldest values are discarded.
trace_set_max_db_size

<open_service>

<size>

Returns the current maximum trace database size. Trace database sizes are approximate but can be used to prevent a high data rate monitor from using up all available memory.
trace_start

<open_service>

fifo

Starts capturing with the specified trace system in real time (FIFO) mode.
trace_stop

<open_service>

Stops capturing with the specified trace system.
trace_get_status

<open_service>

Returns the current status (idle or running) of the trace system. In future, new status values may be added.
trace_get_db_size

<open_service>

Returns the approximate size of the database for the specified trace system.
trace_save

<open_service>

<filename>

Saves the trace database to disk.
trace_load

<filename>

Loads a trace database from disk. This returns a new service path, which can be viewed as if it is a trace system. However, at this point, the start, stop and other commands will obviously not work on a file-based node.

If you load a new trace database with the trace_load command, the trace user interface becomes visible if it was previously hidden.