Tcl Command Migration - 2024.1 English

ISE to Vivado Design Suite Migration Guide (UG911)

Document ID
UG911
Release Date
2024-05-30
Version
2024.1 English

The following table lists the ISE™ Simulator (ISim) Tcl commands and the equivalent Tcl commands in the AMD Vivado™ simulator.

Table 1. ISE Simulator Tcl to Vivado Tcl Mappings
ISim Tcl Vivado Design Suite Tcl
bp add <file_name> <line_number> add_bp file_name line_number
bp clear remove_bps
bp del <index> [<index>…] remove_bp indexlist…
bp list report_bps
bp remove <file_name> <line_number> remove_bps [get_bps -filter {file_name==<file_name> && line_number == <line_number>}]
describe <name> describe name
dump report_values
dump -p <process_scope_name> report_values process_scope_name/*
isim condition add <condition_expression> <command> [-label <label_name>] add_condition [-label name] <condition_expression> <command>
isim condition remove [<label_names>…] [<indexlist>…] [-all] remove_conditions [names_indices_objects…]
isim condition list report_conditions
isim force add <object_name> <value> [-radix <radix>] [-time <time_offset>] { [ -value <value> [-radix <radix>] -time <time_offset>] } <[-cancel <time_offset>] [-repeat <time_offset>] add_force [-radix radix] [-cancel_after <time_offset>] [-repeat_every <time_duration>] <object_name> {<value> [<time>] } [{ <value> <time>}…]
isim force remove remove_force
isim get <property> Properties: arraydisplaylength, radix, userunit, maxtraceablesize, ltrace, ptrace get_property property_name [current_sim] Properties: array_display_limit, radix, time_unit, trace_limit, line_tracing, process_tracing
isim set <property> <value> properties: arraydisplaylength, radix, userunit, maxtraceablesize, ltrace, ptrace set_property property_name property_value [current_sim] Properties: array_display_limit, radix, time_unit, trace_limit, line_tracing, process_tracing
onerror {tcl_commands} onerror {tcl_commands}
put [-radix <radix>] name value set_value [-radix radix] Design_object value
quit [-f|-force] [-s|-sim] quit [-f|-force]
restart restart
resume resume
run [all | continue | <time> <unit>] run [-all] [time unit]
saif open [-scope <path_name>] [-file <file_name>] [-level <nesting_level>] [-allnets] open_saif file_name; log_saif hdl_objects
saif_close close_saif [SaifObj]
scope [<path>] current_scope hdl_scope
sdfanno SDF annotation an option for the simulation xelab (elaborator) command. sdfanno is no longer supported.
show time current_time
show port report_objects [get_objects * -filter {type == port}]
show scope report_scope
show signal report_objects [get_objects * -filter {type == signal}]
show variable report_objects [get_objects * -filter {type == variable}]
show constant report_objects [get_objects * -filter {type == constant}]
show child [-r] report_scopes [get scopes -r *]
show driver <hdl_object_name> report_drivers hdl_object (not supported)
show load <hdl_object_name> report_readers hdl_object (not supported)
show value [-radix <radix>] <hdl_object_name> report_value [-radix radix] hdl_object
step step [-over]
test [-radix radix] <hdl_object_name> <test_value> No longer supported. Use Tcl built-in command as follows: expr {[get_value -radix radix hdl_object] == test_value}
vcd dumpfile <file_name> open_vcd file_name
vcd dumpvars -m <hdl_scope_name> [-l <level>] log_vcd hdl_objects
vcd dumplimit <size> limit_vcd [VCDObject] filesize
vcd dumpon start_vcd [VCDObject]
vcd dumpoff stop_vcd [VCDObject]
vcd dumpflush flush_vcd [VCDObject]
wave log [-r] name log_wave hdl_objects