Get a list of debug ports in the current design
Syntax
get_debug_ports [‑filter <arg>] [‑of_objects <args>] [‑regexp] [‑nocase]
[‑quiet] [‑verbose] [<patterns>]
Returns
List of debug_port objects.
Usage
Name | Description |
---|---|
[-filter]
|
Filter list with expression |
[-of_objects]
|
Get ports of these debug cores |
[-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 ports against patterns Default: * |
Description
Gets a list of ports defined on ILA debug cores in the current project that match a specified search pattern. The default command gets a list of all debug ports in the project.
Debug ports are defined when ILA debug cores are created with the create_debug_core
command. Ports can be added to existing debug cores with 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_ports
based on property values on the debug ports. You can find the properties on an object with the report_property
or list_property
commands. Any property/value pair can be used as a filter. In the case of the debug_port object, "PORT_WIDTH", and "MATCH_TYPE" 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}
-of_objects
<args> - (Optional) Get the ChipScope debug ports associated with the specified debug cores.
-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 ports against the specified patterns. The default pattern is the wildcard '*' which gets all debug ports. More than one pattern can be specified to find multiple debug ports based on different search criteria.
Examples
The following command gets a list of the ports from the ILA debug cores in the current project, with a PORT_WIDTH property of 8:
get_debug_ports -filter {PORT_WIDTH==8}
The following example gets the properties attached to the specified debug port:
report_property [get_debug_ports myCore/PROBE1]