Get list of hardware SIO links.
Syntax
get_hw_sio_links [‑of_objects <args>] [‑regexp] [‑nocase] [‑filter <arg>]
[‑quiet] [‑verbose] [<patterns>]
Returns
Hardware SIO links.
Usage
Name | Description |
---|---|
[-of_objects]
|
Get 'hw_sio_link' objects of these types: 'hw_server hw_target hw_device hw_sio_ibert hw_sio_gtgroup hw_sio_gt hw_sio_tx hw_sio_rx hw_sio_linkgroup'. |
[-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_sio_link' objects against patterns. Default: * |
Description
Returns the communication links between TX and RX objects on the GTs of the IBERT debug core defined on the current hardware device.
Vivado Serial I/O analyzer is a link-based analyzer, which lets you link between any transmitter and receiver within the IBERT design. The links define the communication paths and protocols between transmitters and receivers of the GigaBit transceivers on the device. You can configure the links by using the set_property
command to specify property values on the link object.
This command returns a list of link objects on the IBERT debug core, or returns an error if it fails.
Arguments
-of_objects <arg>
- (Optional) Return the hw_sio_link objects of the specified hw_server, hw_target, hw_device, hw_sio_ibert, hw_sio_gt, hw_sio_tx, hw_sio_rx, or hw_sio_linkgroup. The objects must be specified using the appropriate get_hw_*
command.
-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 http://perldoc.perl.org/perlre.html for help with regular expression syntax.
regexp
is not anchored, and works as a standard Tcl command. For more information refer to http://www.tcl.tk/man/tcl8.5/TclCmd/regexp.htm.
-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_sio_links
based on property values on the link objects. You can find the properties on an object with the report_property
or list_property
commands. In the case of the "hw_sio_link" object, "DESCRIPTION", "TX_ENDPOINT", and "RX_ENDPOINT" are some of the properties that can be used to filter results.
get_pins * -filter {DIRECTION == IN && NAME !~ "*RESET*"}
bool
) type properties can be directly evaluated in filter expressions as true or not true: -filter {IS_PRIMITIVE && !IS_LOC_FIXED}
-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.
-verbose
- (Optional) Temporarily override any message limits and return all messages from this command.
set_msg_config
command.<patterns> - (Optional) Match hw_sio_links against the specified patterns. The default pattern is the wildcard '*' which gets a list of all hw_sio_link objects available on the current hardware device.
Example
The following example returns links based on the DESCRIPTION property that can be specified when the link is created:
get_hw_sio_links -filter {DESCRIPTION == "Link4" || DESCRIPTION == "Link2"}