Description
Get a list of pins.
Syntax
get_pins [-regexp] [-filter <arg>] [-hierarchical] [-of_objects <args>] [-quiet] [-verbose] [<patterns>...] Returns
Pin objects. Returns nothing if the command fails.
Usage
| Name | Description |
|---|---|
[-regexp] |
Patterns are full regular expressions |
[-filter] |
Filter list with expression |
[-hierarchical] |
Get pins from all levels of hierarchical cells |
[-of_objects] |
Get 'port' objects of these types: 'hw_design cell bus_intf net'. |
[-quiet] |
Ignore command errors |
[-verbose] |
Suspend message limits during command execution |
[<patterns>] |
Match cell names against patterns Default: * |
Categories
Hardware
Description
Gets a list of pin objects on the current hardware design that match a specified search pattern. The default command gets a list of all pins in the subsystem design.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 this web page for help with regular expression
syntax.regexp is not anchored, and works as a standard Tcl
command. For more information, refer to this web page.
-filter <args> – (optional) Filter the
results list with the specified expression. The -filter
argument filters the list of objects returned based on property values on
the objects. You can find the properties on an object with the
report_property or list_property
commands.
*
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. * wildcard character, this matches a
property with a defined value of "".get_pins * -filter {DIRECTION == IN && NAME !~ "*RESET*"}
-hierarchical -
(optional) Get pins from all levels of hierarchical cells.
-of_objects
<arg> - (optional) Get the pins connected to the specified IP
subsystem cell or 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 hardware design pins against the specified patterns.
Examples
The following example gets a list of pins attached to the specified cell:
hsi::get_pins -of [get_cells axi_gpio_0]The following example gets a list of pins attached to the specified subsystem net:
hsi::get_pins -of [get_nets ps7_axi_interconnect_0_M_AXI_BRESP]