Get a list of ports in the current design
Syntax
get_ports [‑regexp] [‑nocase] [‑filter <arg>] [‑of_objects <args>]
[‑match_style <arg>] [‑scoped_to_current_instance] [‑no_traverse]
[‑prop_thru_buffers] [‑quiet] [‑verbose] [<patterns>]Returns
List of port objects.
Usage
| Name | Description |
|---|---|
[-regexp]
|
Patterns are full regular expressions |
[-nocase]
|
Perform case-insensitive matching (valid only when -regexp specified) |
[-filter]
|
Filter list with expression |
[-of_objects]
|
Get ports of these nets, instances, sites, clocks, timing paths, io standards, io banks, package pins, drc violations |
[-match_style]
|
Style of pattern matching, valid values are ucf, sdc Default: sdc |
[-scoped_to_current_instance]
|
Match patterns on instance pins specified using current instance, and then find top level connected ports. |
[-no_traverse]
|
Do not traverse to find top level terminals. |
[-prop_thru_buffers]
|
Allow propagate through buffers when traversing to find top level terminals connected to pins of scoped instance. |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
[<patterns>]
|
Match port names against patterns Default: * |
Description
Gets a list of port objects in the current design that match a specified search pattern. The default command gets a list of all ports in the 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.
-nocase - (Optional) Perform case-insensitive matching when a pattern has been specified. This argument applies to the use of -regexp only.
-filter <args> - (Optional) Filter the results list with the specified expression. The -filter argument filters the list of objects returned by get_ports based on property values on the ports. You can find the properties on an object with the report_property or list_property commands. In the case of the "ports" object, "PARENT" 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 ports connected to the specified nets, bels, sites, clocks, timing paths, io_standards, iobanks, or package_pins; or ports associated with specified DRC violation 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>.
-match_style [sdc | ucf] - (Optional) Indicates that the search pattern matches UCF constraints or SDC constraints. The default is SDC.
-scoped_to_current_instance - (Optional) This returns the top-level pins of the current instance. Applies the specified search <patterns> to find the instance pins on the current instance.
-prop_thru_buffers - (Optional) This option returns the top-level ports connected to pins on the current instance. This option can be used with the -scoped_to_current_instance option to propagate the search from the pins of the current instance, through buffers, to the top-level ports of the design.
-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 project. More than one pattern can be specified to find multiple ports based on different search criteria.
Examples
The following example gets a list of pins attached to the specified cell:
get_ports -of_objects [lindex [get_cells] 1]The following example runs the report_drc command on the current design, returns the list of violations in the specified DRC report, and then returns the ports associated with any violations of the unspecified I/O Standard rule (NSTD):
report_drc -name drc_1
get_drc_violations -name drc_1
get_ports -of_objects [get_drc_violations -name drc_1 NSTD*]This example specifies a cell for the current instance, returns the pins scoped to the current instance, and returns the top-level ports connected to those pins:
current_instance [get_cells dac_spi*]
get_ports -scoped_to_current_instance
get_ports -scoped_to_current_instance -prop_thru_buffers