Get a list of debug cores in the current design
Syntax
get_debug_cores [‑filter <arg>] [‑of_objects <args>] [‑regexp] [‑nocase]
[‑quiet] [‑verbose] [<patterns>]
Returns
List of debug_core objects.
Usage
Name | Description |
---|---|
[-filter]
|
Filter list with expression |
[-of_objects]
|
Get cores of these debug ports or nets |
[-regexp]
|
Patterns are full regular expressions |
[-nocase]
|
Perform case-insensitive matching (valid only when -regexp specified) |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
[<patterns>]
|
Match debug cores against patterns Default: * |
Description
Gets a list of AMD Vivado™ Lab Edition debug cores in the current project that match a specified search pattern. The default command gets a list of all debug cores in the project.
Debug cores are added to the project with the create_debug_core
command. When a
ILA debug core (labtools_ila_v3
) is added to the project, it is
contained within a Debug Hub core (labtools_xsdbmasterlib_v2), and includes a CLK
port and a PROBE port as a default. Additional ports can be added to the debug core
with the use of the create_debug_port
command.
get_*
commands return a container list of a single type of objects (e.g. cells, nets, pins, or ports). You can add new objects to the list (using lappend
for instance), but you can only add the same type of object that is currently in the list. Adding a different type of object, or string, to the list is not permitted and will result in a Tcl error.
Arguments
-filter
<args> - (Optional) Filter the results list with the specified expression. The -filter
argument filters the list of objects returned by get_debug_cores
based on property values on the debug cores. You can find the properties on an object with the report_property
or list_property
commands.
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}
-of_objects
<args> - (Optional) Get the ILA debug cores associated with the specified debug ports, or nets.
-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.
-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 debug cores against the specified patterns. The default pattern is the wildcard '*' which gets all debug cores. More than one pattern can be specified to find multiple debug cores based on different search criteria.
Examples
The following command gets a list of the Vivado Lab Edition debug cores in the current project:
get_debug_cores
The following example gets the properties of the specified debug core:
report_property [get_debug_cores myCore]