Get a list of nets
Syntax
get_bd_nets [‑regexp] [‑hierarchical] [‑filter <arg>]
[‑boundary_type <arg>] [‑of_objects <args>] [‑quiet] [‑verbose]
[<patterns>]
Returns
List of pin objects, "" if failed.
Usage
Name | Description |
---|---|
[-regexp]
|
Patterns are full regular expressions |
[-hierarchical]
|
Hierarchical cells included |
[-filter]
|
Filter list with expression |
[-boundary_type]
|
Used when source object is on a hierarchical block's pin. Valid values are 'upper', 'lower', or 'both'. If 'lower' boundary, searches from the lower level of hierarchy onwards. This option is only valid for connected_to relations. |
[-of_objects]
|
One or a list of cells or pins/ports objects. List must be of one object type. |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
[<patterns>]
|
Match engine names against patterns Default: * |
Categories
Description
Gets a list of nets in the current IP integrator subsystem design that match a specified search pattern. The default command gets a list of all nets in the subsystem design.
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
-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.
-hierarchical
- (Optional) Get nets from all levels of the IP integrator subsystem design hierarchy. Without this argument, the command will only get nets from the top of the subsystem design, or from the current subsystem instance. When using -hierarchical
, the search pattern should not contain a hierarchy separator because the search pattern is applied at each level of the hierarchy, not to the full hierarchical name. For instance, searching for /bridge_1/* searches each level of the hierarchy for nets with /bridge_1/ in the name. This may not return the intended results.
-regexp
, the specified search string is matched against the full hierarchical name, and the U1/* search pattern will work as intended.
-filter
<args> - (Optional) Filter the results list with the specified expression. The -filter
argument filters the list of objects returned by get_bd_nets
based on property values on the block design nets. You can find the properties on an object with the report_property
or list_property
commands. In the case of the IP integrator subsystem nets object, "NAME" and "PATH" 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}
-boundary_type [ upper | lower | both ]
- (Optional) Gets the net at the level (upper) of a specified hierarchical pin, at the level below (lower) the pin or port, or both the level of and the level below. Valid values are upper, lower, or both. The default value is upper.
-of_objects
argument to specify the hierarchical pin.-of_objects
<args> - (Optional) Get a list of the nets connected to the specified cell, pin, or port objects.
-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>
.
-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 IP subsystem nets against the specified patterns. The default pattern is the wildcard '*' which returns a list of all nets in the current IP integrator subsystem design. More than one pattern can be specified to find multiple nets based on different search criteria.
Examples
The following example gets the net attached to the specified pin of an IP integrator hierarchical module, and returns both the net at the level of the hierarchical module, and the net inside the hierarchical module:
get_bd_nets -boundary_type both -of_objects [get_bd_pins /newMod1/aclk]
The following example returns a list of all nets at all levels of the IP integrator subsystem design hierarchy:
get_bd_nets -hierarchical