Altera Quartus II Scripting - Manual (Page 408)

3–278 Chapter 3: Tcl Packages & Commands
rtl
Quartus II Scripting Reference Manual © July 2013 Altera Corporation
get_rtl_pins
Usage
get_rtl_pins [-hierarchical] [-nocase] [-tcl_string] <filter>
Options
-hierarchical: Specifies use of a hierarchical searching method
-nocase: Specifies case-insensitive node name matching
-tcl_string: Specifies use of tcl string matching method
<filter>: Valid destinations (string patterns are matched using Tcl string matching)
Description
Returns a collection of pins in the design. All pin names in the collection match the specified pattern.
Wildcards can be used to select multiple pins at once.
There are two Tcl string matching schemes available with this command: the default method and the
-hierarchical option.
By default, pipe characters are used to separate one hierarchy level from the next. They are treated as
special characters and are taken into account when string matching with wildcards is performed. When
the default matching scheme is enabled, the specified pattern is matched against absolute pin names: the
names that include the entire hierarchical path. All hierarchy levels in the pattern are matched level by
level. Pin names of the form <absolute full cell name>|<pin suffix> are used for matching. Note that a full
cell name can contain multiple pipe characters in it to reflect the hierarchy. Any included wildcards refer to
only one hierarchical level. For example, "*|*" and "*|*|*" produce different collections since they refer to
the highest hierarchical level and second highest hierarchical level respectively.
When using the -hierarchical matching scheme, pipe characters are treated as special characters and are
taken into account when string matching with wildcards is performed. This matching scheme forces the
search to proceed recursively through the hierarchy. The specified pattern is matched against the relative
pin names: the immediate names that do not include any of the hierarchy information. Pin names of the
form <relative short cell name>|<pin suffix> are used for matching. Note that a short cell name cannot
contain pipe characters. Any included wildcards are expanded to match the relative pin names. For
example, "*" and "*|*" match exactly the same pins since the former is expanded into the latter.
The -tcl_string matching scheme uses the simple Tcl string matching on absolute cell names. Pipe
characters are not treated as special characters when used with wildcards.
The filter for the collection is a Tcl list of wildcards, and must follow standard Tcl substitution rules.
Example
# Get regout pin of "reg" cell
get_rtl_pins -nocase reg|regout
# Create a collection of all pins of "reg" cell
get_rtl_pins reg|*
# Create a collection of all pins on the highest hierarachical level
set mycollection [get_rtl_pins *]
# Output pin names.
foreach_in_collection pin $mycollection {
puts [get_rtl_pin_info -name $pin]
}
# Create a collection of all pins in the design
set fullcollection [get_rtl_pins -hierarchical *]
# Output pin IDs and names.
foreach_in_collection pin $fullcollection {
puts -nonewline $pin