get_bd_pins - 2023.2 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2023.2 English

Get a list of pins


get_bd_pins [‑regexp] [‑hierarchical] [‑filter <arg>] [‑of_objects <args>]
    [‑quiet] [‑verbose] [<patterns>]


List of pin objects, "" if failed.


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, nets or interface 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: *




Gets a list of pin objects on the current IP subsystem design that match a specified search pattern. The default command gets a list of all pins in the subsystem design.

The external connections in 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.

Note: To improve memory and performance, the 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.


-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 for help with regular expression syntax.
Note: The Tcl built-in command regexp is not anchored, and works as a standard Tcl command. For more information refer to

-hierarchical - (Optional) Get pins from all levels of the IP integrator subsystem design hierarchy. Without this argument, the command will only get 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 pins with /bridge_1/ in the name. This may not return the intended results.

Note: When used with -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_pins based on property values on the block design pins. You can find the properties on an object with the report_property or list_property commands. In the case of the block design pins object, "DIR" and "TYPE" are some of the properties that can be used to filter results.

The filter search pattern should be quoted to avoid having to escape special characters. String matching is case-sensitive and is always anchored to the start and to the end of the search string. The wildcard “*” character can be used at the beginning or at the end of a search string to widen the search to include a substring of the property value.
Note: The filter returns an object if a specified property exists on the object, and the specified pattern matches the property value on the object. In the case of the "*" wildcard character, this will match a property with a defined value of "".
For string comparison, the specific operators that can be used in filter expressions are "equal" (==), "not-equal" (!=), "match" (=~), and "not-match" (!~). Numeric comparison operators <, >, <=, and >= can also be used. Multiple filter expressions can be joined by AND and OR (&& and ||). The following gets input pins that do NOT contain the “RESET” substring within their name:
get_pins * -filter {DIRECTION == IN && NAME !~ "*RESET*"}
Boolean (bool) type properties can be directly evaluated in filter expressions as true or not true:
-of_objects <arg> - (Optional) Get the pins connected to the specified IP subsystem interface pins, bd_intf_pin, bd_ cell, or bd_net.
Note: The -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.
Note: Any errors encountered on the command-line, while launching the command, will be returned. Only errors occurring inside the command will be trapped.
-verbose - (Optional) Temporarily override any message limits and return all messages from this command.
Note: Message limits can be defined with the set_msg_config command.

<patterns> - (Optional) Match IP integrator subsystem pins against the specified patterns. You must specify the search pattern using the name convention of <bd_cell_name> /<bd_pin_name>. In this case, using the wildcard '*/*' would return all of the bd_pin objects on all of the bd_cells in the diagram.

Note: More than one pattern can be specified to find multiple pins based on different search criteria. You must enclose multiple search patterns in braces {} to present the list as a single element.


The following example gets a list of pins attached to the specified cell:

get_bd_pins -of [get_bd_cells new_vidOut_1]
Note: If there are no pins matching the pattern, the tool will return a warning.

The following example gets a list of all pins, throughout the hierarchy of the IP integrator subsystem design, which match the specified name pattern:

get_bd_pins -hierarchical LMB*

The following example gets a list of pins attached to the specified subsystem net:

get_bd_pins -of [get_bd_nets vidout_1_vtg_ce]