modify_debug_ports - 2022.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2022.1 English

Modify routed probe connections to debug cores.


modify_debug_ports [‑probes <args>] [‑quiet] [‑verbose]


Name Description
[-probes] List of probes to be connected: debug core pin, channel index, and logical net for each probe connection.
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution




Modifies a routed design to connect nets to specified ports of debug cores. This command takes a list of connections to be made to specified debug probes. Each connection is defined as a Tcl list, enclosed in braces {}, specifying the following three elements separated by spaces:
  1. The logical pin of the debug core to be connected.
  2. The channel index of the specified probe.
  3. The logical net of the signal to be probed.
Multiple probe connections are specified as a list of lists, with each connection itself being a Tcl list as shown in the example.

The command performs all of the netlist modifications to disconnect existing net connections to the specified probe ports as needed, connecting each net to be probed to the specified probe port, and automatically routing the modified connections. Nets that become disconnected during the process are left unconnected.


-probes <args> - (Required) Specifies a list of probe connections as a Tcl list of lists. Each probe connection is defined as a triplet of three elements in the following order separated by spaces: 1) the logical pin of the debug core to be connected, 2) the probe channel index, and 3) the logical net of the signal to be probed. Multiple probe connections are specified as a list of lists as follows:
[list  \{probe1 channel1 net1}  \{probe2 channel1 net2} \{probe2 channel2  net3} ]
-quiet - (Optional) Execute the command quietly, returning no messages from the command. The command also returns TCL_OK regardless of any errors encountered during execution.
Note: Any errors encountered on the command-line, while launching the command, will be returned. Only errors occurring inside the command will be trapped.
-verbose - (Optional) Temporarily override any message limits and return all messages from this command.
Note: Message limits can be defined with the set_msg_config command.


The following example modifies 3 probe connections:
modify_debug_ports -probes [list {top/x_ila/probe0 0 top/inst_A/net_0} \
  {top/x_ila/probe1 1 top/inst_A/net_a} {top/x_ila/probe1 2 top/inst_A/net_b}]
Tip: The modify_debug_ports command moves a port probe from one signal to another.