Get a list of hardware ILA data objects.
Syntax
get_hw_ila_datas [‑of_objects <args>] [‑regexp] [‑nocase] [‑filter <arg>]
[‑quiet] [‑verbose] [<patterns>]Returns
Hardware ILA data.
Usage
| Name | Description |
|---|---|
[-of_objects]
|
Get 'hw_ila_data' objects of these types: 'hw_ila hw_device'. |
[-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_ila_data' objects against patterns. Default: * |
Description
Returns the ILA data objects in the Vivado™ logic analyzer.
The upload_hw_ila_data command creates a hw_ila_data object in the process of moving the captured data from the ILA debug core, hw_ila, on the physical FPGA device, hw_device. The read_hw_ila_data command can also create a hw_ila_data object when reading an ILA data file from disk.
The hw_ila_data object can be viewed in the waveform viewer of the Vivado logic analyzer by using the display_hw_ila_data command, and can be written to disk using the write_hw_ila_data command.
This command returns a list of available hardware ILA data objects, or returns an error if it fails.
Arguments
-of_objects <arg> - (Optional) Return the hw_ila_data objects of the specified hw_ila debug objects. The hw_ila cores must be specified as objects using the get_hw_ilas or the current_hw_ila commands.
-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_ila_datas based on property values on the hardware ILA data objects. You can find the properties on an object with the report_property or list_property commands. In the case of the "hw_ila_data" object, "NAME" and "TIMESTAMP" are two 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_ila_data objects against the specified patterns. The default pattern is the wildcard '*' which gets a list of all hw_ila_data objects available in the Vivado logic analyzer.
Example
The following example gets the data objects for all the hardware ILA debug cores on the current device:
get_hw_ila_datas -of_objects [get_hw_ilas]