Description
Get a list of external ports.
Syntax
get_ports [-regexp] [-filter <arg>] [-of_objects <args>] [-quiet] [-verbose] [<patterns>...] Returns
Port objects. Returns nothing if the command fails.
Usage
| Name | Description |
|---|---|
[-regexp] |
Patterns are full regular expressions |
[-filter] |
Filter list with expression |
[-of_objects] |
Get 'port' objects of these types: 'hw_design 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 port objects in the current hardware design that match a specified search pattern. The default command gets a list of all ports in the hardware design.
The external connections in an hardware 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_pins and
get_intf_pins commands to select the pin objects.
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 "".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
||).
For IP subsystem ports, "DIRECTION", "TYPE", and "SENSITIVITY" are some of the properties you can use to filter results.
-of_objects <arg> - (optional)
Get the ports connected to the specified IP subsystem nets returned by
get_nets.
-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 hardware subsystem net:
hsi::get_ports -of_objects [get_nets bridge_1_apb_m] -filter {DIRECTION==I}