get_hw_axi_txns - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2024.1 English

Get a list of hardware AXI transactions.


get_hw_axi_txns [‑of_objects <args>] [‑regexp] [‑nocase] [‑filter <arg>]
    [‑quiet] [‑verbose] [<patterns>]




Name Description
[-of_objects] Get 'hw_axi_txn' objects of these types: 'hw_axi'.
[-regexp] Patterns are full regular expressions
[-nocase] Perform case-insensitive matching. (valid only when -regexp specified)
[-filter] Filter list with expression
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<patterns>] Match the 'hw_axi_txn' objects against patterns. Default: *


Hardware, Object


Returns the read or write transactions for the specified JTAG to AXI Master core, hw_axi object.

The JTAG to AXI Master is a customizable IP core that works as an AXI Master to drive AXI transactions and drive AXI signals that are internal to the hardware device. This IP can be used in Vivado™ IP integrator or can be instantiated in HDL in a Vivado project.

The JTAG-AXI core supports all memory-mapped AXI interfaces, except AXI4-Stream, and supports the AXI-Lite protocol. The AXI interface can be selected as a property of the core. The width of AXI data bus is customizable. This IP can drive any AXI4-Lite or Memory Mapped Slave directly, and can also be connected as the AXI Master to the interconnect. Run-time interaction with this core requires the use of the Vivado logic analyzer feature. Detailed documentation on the IP core can be found in the LogiCORE IP JTAG to AXI Master Product Guide (PG174). A tutorial showing its use can be found in the Vivado Design Suite Tutorial: Programming and Debugging (UG936).

The JTAG to AXI Master core must be instantiated in the RTL code, from the Xilinx™ IP catalog. AXI transactions are defined as complete READ or WRITE transactions between the AXI master and various slaves.

This command returns a list of hw_axi_txn objects on the hw_device, or returns an error if it fails.


-of_objects <arg> - (Optional) Return the AXI Master cores of the specified hardware devices. The devices must be specified as objects using the get_hw_devices or the current_hw_device commands.
Note: The -of_objects option requires objects to be specified using the get_* commands, such as get_cells or get_pins, rather than specifying objects by name. In addition, -of_objects cannot be used with a search <pattern>.
-regexp - (Optional) Specifies that the search <patterns> are written as regular expressions. Both search <patterns> and -filter expressions must be written as regular expressions when this argument is used. Xilinx® regular expression Tcl commands are always anchored to the start of the search string. You can add ".*" to the beginning or end of a search string to widen the search to include a substring. See for help with regular expression syntax.
Note: The Tcl built-in command regexp is not anchored, and works as a standard Tcl command. For more information refer to

-nocase - (Optional) Perform case-insensitive matching when a pattern has been specified. This argument applies to the use of -regexp only.

-filter <args> - (Optional) Filter the results list with the specified expression. The -filter argument filters the list of objects returned by get_hw_axi_txns based on property values on the AXI transactions. You can find the properties on an object with the report_property or list_property commands. In the case of the "hw_axi_txn" object, "NAME" and "TYPE" are two of the properties that can be used to filter results.

The filter search pattern should be quoted to avoid having to escape special characters. String matching is case-sensitive and is always anchored to the start and to the end of the search string. The wildcard “*” character can be used at the beginning or at the end of a search string to widen the search to include a substring of the property value.
Note: The filter returns an object if a specified property exists on the object, and the specified pattern matches the property value on the object. In the case of the "*" wildcard character, this will match a property with a defined value of "".
For string comparison, the specific operators that can be used in filter expressions are "equal" (==), "not-equal" (!=), "match" (=~), and "not-match" (!~). Numeric comparison operators <, >, <=, and >= can also be used. Multiple filter expressions can be joined by AND and OR (&& and ||). The following gets input pins that do NOT contain the “RESET” substring within their name:
get_pins * -filter {DIRECTION == IN && NAME !~ "*RESET*"}
Boolean (bool) type properties can be directly evaluated in filter expressions as true or not true:
-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.

<patterns> - (Optional) Match hw_axi objects against the specified patterns. The default pattern is the wildcard '*' which gets a list of all hw_axis available on the current hardware device.


The following example gets the ILA debug cores defined on the current hardware device:

get_hw_axi_txn -filter {TYPE==WRITE} [get_hw_axis]