Get a list of intf_pins
Syntax
get_bd_intf_pins [‑regexp] [‑hierarchical] [‑filter <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 |
[-of_objects]
|
One or a list of cells, interface nets or pins 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 interface pin objects on the current IP subsystem design that match a specified search pattern. The default command gets a list of all interface pins in the subsystem design.
The external connections of an IP integrator cell, or hierarchical module, are pins and interface pins. The external connections in an IP subsystem design are ports, or interface ports. Use the get_bd_ports and get_bd_intf_ports commands to select the port 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.
-hierarchical - (Optional) Get interface pins from all levels of the IP integrator subsystem design hierarchy. Without this argument, the command will only get interface pins 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 interface pins with /bridge_1/ in the name. This may not return the intended results.
-regexpr, 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_intf_pins based on property values on the block design interface pins. You can find the properties on an object with the report_property or list_property commands. In the case of the IP integrator interface pins object, "DIR" and "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 <arg> - (Optional) Get the pins connected to the specified bd_pin, bd_cell, or bd_intf_net.
-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 integrator subsystem interface pins against the specified patterns. The default pattern is the wildcard '*' which gets a list of all interface pins in the current IP integrator subsystem design, or instance. More than one pattern can be specified to find multiple pins based on different search criteria.
Examples
The following example gets a list of interface pins attached to the specified cell:
get_bd_intf_pins -of [get_bd_cells new_vidOut_1]The following example gets a list of all interface pins, throughout the hierarchy of the IP integrator subsystem design, which match the specified name pattern:
get_bd_intf_pins -hierarchical m_apb*The following example gets a list of interface pins attached to the specified subsystem net:
get_bd_intf_pins -of [get_bd_intf_nets vidout_1_vtg_ce]