Get a list of ports
Syntax
get_bd_ports [‑regexp] [‑filter <arg>] [‑of_objects <args>] [‑quiet]
[‑verbose] [<patterns>]
Returns
List of port objects, "" if failed.
Usage
Name | Description |
---|---|
[-regexp]
|
Patterns are full regular expressions |
[-filter]
|
Filter list with expression |
[-of_objects]
|
One or a list of nets or interface ports objects. |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
[<patterns>]
|
Match engine names against patterns Default: * |
Categories
Description
Gets a list of port objects in the current IP integrator subsystem design that match a specified search pattern. The default command gets a list of all ports in the subsystem design.
The external connections in an IP subsystem design are ports, or interface ports. The external connections in an IP integrator cell, or hierarchical module, are pins and interface pins. Use the get_bd_pins
and get_bd_intf_pins
commands to select the pin objects.
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.
-filter
<args> - (Optional) Filter the results list with the specified expression. The -filter
argument filters the list of objects returned by get_bd_ports
based on property values on the block design ports. You can find the properties on an object with the report_property
or list_property
commands. In the case of the IP subsystem port object, "DIR", "MODE", and "LOCATION" 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 <arg>
- (Optional) Get the ports connected to the specified IP subsystem nets returned by get_bd_nets
, or ports that are part of an interface port as returned by get_bd_intf_ports
.
-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 ports against the specified patterns. The default pattern is the wildcard '*' which gets a list of all ports in the subsystem design. More than one pattern can be specified to find multiple ports based on different search criteria.
Examples
The following example gets the ports connected to the specified IP subsystem net:
get_bd_ports -of_objects [get_bd_nets bridge_1_apb_m]