System Console and Toolkit Tcl Command Reference Manual

ID 683101
Date 6/26/2023
Public

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

Document Table of Contents

1.1. Command Summary

Returns Command Arguments
no return value add_help <command> <help-text>
various add_service <service-type> <node-name>
no return value autosweep_add_input_parameter <autosweep-inst-id> <toolkit-inst-id> <param-name> <range>
no return value autosweep_add_output_metric <autosweep-inst-id> <toolkit-inst-id> <param-name>
no return value autosweep_apply_bestcase <autosweep-inst-id>
no return value autosweep_apply_case <autosweep-inst-id> <case-number>
String autosweep_create_instance [-id <autosweep-inst-id>]
no return value autosweep_destroy_instance <autosweep-inst-id>
int autosweep_get_best_case <autosweep-inst-id>
int autosweep_get_case_count <autosweep-inst-id>
String autosweep_get_case_description <autosweep-inst-id> <case-number>
String autosweep_get_case_result <autosweep-inst-id> <toolkit-inst-id> <metric-name> <case-number>
String autosweep_get_data [-outputfile <filename>] [-format <format>] <autosweep-inst-id>
String[] autosweep_get_input_parameter_range <autosweep-inst-id> <toolkit-inst-id> <param-name>
String[] autosweep_get_input_parameters <autosweep-inst-id>
String[] autosweep_get_instances
String[] autosweep_get_output_metrics <autosweep-inst-id>
int autosweep_get_progress <autosweep-inst-id>
no return value autosweep_remove_input_paramater <autosweep-inst-id> <toolkit-inst-id> <param-name>
no return value autosweep_remove_output_metric <autosweep-inst-id> <toolkit-inst-id> <param-name>
no return value autosweep_set_input_parameter_range <autosweep-inst-id> <toolkit-inst-id> <param-name> <range>
no return value autosweep_start [-background <background>] <autosweep-inst-id>
no return value autosweep_stop <autosweep-inst-id>
String[] bytestream_receive <service-path> <length>
no return value bytestream_send <service-path> <values>
String claim_service <serviceType> <servicePath> <libraryName> [<claims>]
no return value close_service <service-type> <service-path>
String[] debug_get_commands <flags>
String[] debug_get_legacy_service_types
String debug_print_filesystem <service-path>
no return value design_extract_debug_files <service-path> <String>
no return value design_extract_dotty <service-path> <String> [<List>]
String[] design_get_warnings <service-path>
String design_instantiate <service-path> [<String>]
no return value design_link <String> <String>
various design_load [-legacy <Boolean>] <String>
no return value design_update_debug_files <service-path> <List>
no return value device_download_sof <service-path> <String>
String device_get_board <service-path>
String[] device_get_connections <service-path>
String device_get_design <service-path>
int etile_eye_background_scan_done <service-path> <channel>
no return value etile_eye_cancel_background_scan <service-path> <channel>
String etile_eye_get_attribute <service-path> <load_id> <attribute_name>
String[][] etile_eye_get_data <service-path> <load_id>
int etile_eye_scan_and_load [-timeout <channel>] <service-path>
no return value etile_eye_unload <service-path> <load_id>
String[] etile_get_actions <service-path>
String etile_get_parameter [-timeout <channel>] <service-path> <parameter>
String[] etile_get_parameters <service-path>
String etile_read_register <service-path> <channel> <offset>
various etile_run_action [-timeout <channel>] <service-path> <action>
no return value etile_set_parameter [-timeout <channel>] <service-path> <parameter> <value>
no return value etile_write_register <service-path> <channel> <offset> <value>
boolean executor_cancel <service-path> <int>
no return value executor_clean_directory [-delete <Boolean>] <service-path>
String executor_get_directory <service-path>
Map executor_get_environment [-inherited_only <Boolean>] <service-path>
int executor_get_exit_value <service-path> <int>
String executor_get_stderr <service-path> <int>
String executor_get_stdout <service-path> <int>
boolean executor_is_cancelled <service-path> <int>
boolean executor_is_done <service-path> <int>
int executor_run [-clean_directory_before <Boolean>] [-clean_directory_after <Boolean>] <service-path> <String> <List>
no return value executor_set_environment <service-path> <String> <String>
no return value executor_unset_environment <service-path> <String>
boolean executor_wait_for <service-path> <int> <int>
String eye_create_instance [-id <eye-inst-id>] <toolkit-inst-id> <channel-name>
no return value eye_destroy_instance <eye-inst-id>
String eye_get_channel <eye-inst-id>
String eye_get_data [-outputfile <filename>] <eye-inst-id>
String[] eye_get_instances
int eye_get_progress <eye-inst-id>
String eye_get_toolkit_instance <eye-inst-id>
no return value eye_start [-background <background>] <eye-inst-id>
no return value eye_stop <eye-inst-id>
String[] get_claimed_services <claim-group>
String[] get_service_paths [-device <device-path>] [-hpath <hpath-prefix>] [-type <component-type>] <service-type>
Set get_service_types
String[] get_services_to_add
String[] get_version
String help [<command>]
String[] io_bus_access <service-path> <address> <write> <read_count>
Protocol io_bus_get_protocol <service-path>
boolean is_plugin_enabled <plugin-path>
boolean is_service_open <service-type> <service-path>
Boolean is_service_path <service-type> <service-path>
String[] issp_get_instance_info <service-path>
String issp_read_probe_data <service-path>
String issp_read_source_data <service-path>
no return value issp_write_source_data <service-path> <value>
String[] jtag_debug_loop <service-path> <list-of-byte-values>
no return value jtag_debug_reset_system <service-path>
int jtag_debug_sample_clock <service-path>
int jtag_debug_sample_reset <service-path>
boolean jtag_debug_sense_clock <service-path>
no return value log_command_start [-file <file>] [-append <append>]
no return value log_command_stop
String loopback_get <service-path> <key>
no return value loopback_set <service-path> <key> <value>
no return value loopback_start <service-path>
no return value loopback_stop <service-path>
Map marker_get_assignments <service-path>
Map marker_get_info <service-path>
String marker_get_type <service-path>
String[] marker_get_types <service-path>
Map marker_node_info <service-path>
String[] master_get_register_names <service-path>
String[] master_get_slaves <service-path>
int master_get_timeout <service-path>
String[] master_read_16 <service-path> <address> <size>
String[] master_read_32 <service-path> <address> <size>
ByteBuffer master_read_8 <service-path> <address> <size>
various master_read_memory <service-path> <address> <size>
no return value master_read_to_file <service-path> <filename> <address> <count>
no return value master_set_timeout <service-path> <seconds>
no return value master_write_16 <service-path> <address> <values>
no return value master_write_32 <service-path> <address> <values>
no return value master_write_8 <service-path> <address> <values>
no return value master_write_from_file <service-path> <filename> <address>
no return value master_write_memory <service-path> <address> <values>
String[] module_get_children <service-path>
String[] module_get_keys <service-path> [<key...>]
String module_get_parent <service-path>
String[] module_get_values <service-path> <key> [<key...>]
no return value monitor_add_range <service-path> <target path> <address> <size>
String[] monitor_get_all_read_intervals <service-path> <target path> <address> <size>
long monitor_get_interval <service-path>
int monitor_get_missing_event_count <service-path>
long monitor_get_read_interval <service-path> <target path> <address> <size>
String[] monitor_read_all_data <service-path> <target path> <address> <size>
ByteBuffer monitor_read_data <service-path> <target path> <address> <size>
no return value monitor_set_callback <service-path> <tcl command>
no return value monitor_set_enabled <service-path> <activated>
no return value monitor_set_interval <service-path> <interval>
no return value open_service <service-type> <service-path>
various packet_send_command [-format <format>] [-timeout <command>] <service-path>
no return value plugin_disable <plugin-path>
no return value plugin_enable <plugin_path>
no return value processor_clear_breakpoint <service-path> <String>
no return value processor_download_elf [-multiverify <multiverify>] [-noverify <noverify>] [-reset <reset>] <service-path> <elfPath> [<switches>]
int processor_gdbserver [-timeout <int>] [-verbosity <int>] [-port <int>] [-semihosting <BOOLEAN_OPTIONAL>] <service-path>
int processor_gdbserver_start [-timeout <int>] [-verbosity <int>] [-port <int>] [-semihosting <BOOLEAN_OPTIONAL>] <service-path>
no return value processor_gdbserver_stop <service-path>
String processor_get_register <service-path> <String>
String[] processor_get_register_names <service-path>
boolean processor_in_debug_mode <service-path>
no return value processor_reset <service-path>
no return value processor_run <service-path>
String processor_semihosting_start [-file <String>] [-stdout <Boolean>] [-noconsole <Boolean>] [-messages <Boolean>] <service-path>
no return value processor_semihosting_stop <service-path>
no return value processor_set_breakpoint [-hardware <BOOLEAN_OPTIONAL>] <service-path> <String>
no return value processor_set_register <service-path> <String> <int>
no return value processor_step <service-path>
no return value processor_stop <service-path>
Map processor_stop_reason <service-path>
no return value processor_verify_elf [-multiverify <Boolean>] [-nodata <BOOLEAN_OPTIONAL>] [-norodata <BOOLEAN_OPTIONAL>] [-norwdata <BOOLEAN_OPTIONAL>] [-notext <BOOLEAN_OPTIONAL>] [-noentry <BOOLEAN_OPTIONAL>] [-noexceptions <BOOLEAN_OPTIONAL>] [-reset <BOOLEAN_OPTIONAL>] <service-path> <String>
no return value refresh_connections
no return value remove_service <service-type> <service-path>
no return value semiConsoleNew [-severAddress <String>] [-name <String>] <int>
no return value semihosting_start [-severAddress <String>] [-name <String>] [-file <String>] [-stdout <Boolean>] [-noconsole <Boolean>] [-messages <Boolean>] <int>
no return value semihosting_stop <int>
no return value send_message <level> <message>
String[] sld_access_dr [-write_only <BOOLEAN_OPTIONAL>] <service-path> <length> <delay> <values>
String sld_access_ir [-ir <BOOLEAN_OPTIONAL>] [-length <length>] <service-path> <ir-value> <delay>
int sld_lock <service-path> <timeout>
no return value sld_run_test_idle <service-path> <clocks>
no return value sld_send_program <service-path> <streamPath>
no return value sld_test_logic_reset <service-path>
int sld_unlock <service-path>
no return value stp_run <service-path> <signal_set> <trigger> <data_log> <timeout>
String[] system_get_keys <service-path> [<key...>]
String[] system_get_values <service-path> <key> [<key...>]
String[] toolkit_get_toolkit_actions <inst-id> [<channel>]
String[] toolkit_get_toolkit_autosweep_input_parameters <inst-id> [<channel>]
String[] toolkit_get_toolkit_autosweep_output_metrics <inst-id> [<channel>]
String[] toolkit_get_toolkit_channel_properties
String[] toolkit_get_toolkit_channels <inst-id>
String toolkit_get_toolkit_display_hint <inst-id> <parameter-name> <display-hint>
String[] toolkit_get_toolkit_display_id_to_name <inst-id> [<channel>]
various toolkit_get_toolkit_display_item_property <inst-id> <display-item-id> <display-item-property>
String[] toolkit_get_toolkit_eye_channels <inst-id>
String[] toolkit_get_toolkit_eye_input_parameters <inst-id> [<channel>]
String[] toolkit_get_toolkit_eye_output_metrics <inst-id> [<channel>]
String[] toolkit_get_toolkit_matching_modules [-requirement <requirement-id>] [-recursive <BOOLEAN_OPTIONAL>] [-hpath <hpath>] [-module_name <module-name>] [-version <version>] <service-path>
String[] toolkit_get_toolkit_matching_services [-requirement <requirement-id>] [-recursive <BOOLEAN_OPTIONAL>] [-hpath <hpath>] [-type <type>] [-agent_type_name <agent-type-name>] <service-path>
String[] toolkit_get_toolkit_matching_systems [-requirement <requirement-id>] [-hpath <hpath>] [-design_id <design-id>] <service-path>
String[] toolkit_get_toolkit_parameter_properties
various toolkit_get_toolkit_parameter_property <inst-id> <parameter-name> <parameter-property>
String toolkit_get_toolkit_parameter_value <inst-id> <parameter-name>
String[] toolkit_get_toolkit_parameters <inst-id> [<channel>]
String[] toolkit_get_toolkit_properties <service-path>
String toolkit_get_toolkit_property <service-path> <property>
String[] toolkit_get_toolkit_requirement_ids <service-path>
String[] toolkit_get_toolkit_requirement_properties <service-path> <requirement-id>
String[] toolkit_get_toolkit_requirement_property <service-path> <requirement-id> <property>
String toolkit_load_toolkit_instance [-id <inst-id>] [-log <log-flag>] [-output-file-path <output-file-path>] <toolkit-name> <version> <requirements>
no return value toolkit_log_toolkit_command_start <id> [<file> <append>]
no return value toolkit_log_toolkit_command_stop <id>
no return value toolkit_run_toolkit_action <inst-id> <display-item-id>
no return value toolkit_set_toolkit_parameter_value <inst-id>
no return value toolkit_unload_toolkit_instance <inst-id>
no return value trace_db_delete_snapshot <service-path> <snapshot-id>
int trace_db_get_snapshot [-start-time <start-time>] [-end-time <end-time>] [-monitor-ids <monitor-ids>] <service-path>
String trace_db_snapshot_get_event_data <service-path> <snapshot-id> <event-id> <field>
Set trace_db_snapshot_get_event_fields <service-path> <snapshot-id> <event-id>
Kind trace_db_snapshot_get_event_kind <service-path> <snapshot-id> <event-id>
long trace_db_snapshot_get_event_timestamp <service-path> <snapshot-id> <event-id>
String[] trace_db_snapshot_get_events <service-path> <snapshot-id>
String trace_decoder_add_key_result <field> <parent> <name> <value>
String trace_decoder_add_result <parent> <name> <value>
no return value trace_decoder_define_key <name> <display_name>
int trace_decoder_get_config <regNum>
int trace_decoder_get_data_16 <offset>
int trace_decoder_get_data_16be <offset>
int trace_decoder_get_data_32 <offset>
int trace_decoder_get_data_32be <offset>
BigInteger trace_decoder_get_data_64 <offset>
BigInteger trace_decoder_get_data_64be <offset>
int trace_decoder_get_data_8 <offset>
int trace_decoder_get_length
BigInteger trace_decoder_get_timestamp
no return value trace_decoder_set_callback <callback>
no return value trace_decoder_set_config_regs <regs>
no return value trace_decoder_set_summary <value>
long trace_get_db_size <service-path>
long trace_get_max_db_size <service-path>
Map trace_get_monitor_info <service-path> <String>
String[] trace_get_monitors <service-path>
Status trace_get_status <service-path>
String trace_load <filename>
String trace_read_monitor <service-path> <String> <int>
no return value trace_save <service-path> <String>
no return value trace_set_max_db_size <service-path> <long>
no return value trace_set_trigger_mode <service-path> <TriggerMode>
no return value trace_start <service-path> <CaptureMode>
no return value trace_stop <service-path>
no return value trace_write_monitor <service-path> <String> <int> <String>