21.8.15 get_pins

Description

Returns an object representing the pin(s) that match those specified in the pattern argument. Wildcards can be used to select multiple pins at once. If no objects match the criteria, the empty string is returned.

get_pins pattern

Arguments

ParameterTypeDescription
patternstringSpecifies the pattern to match the pins to return. For example, get_pins clock_gen* returns all pins starting with the characters clock_gen, where * is a wildcard that represents any character string. This is mandatory.
Return TypeDescription
objectReturns an object representing the pin(s) that match those specified in the pattern argument.

Error Codes

Error CodeDescription
NoneRequired parameter _AtclParam0_ is missing.

Supported Families

PolarFire®
PolarFire SoC
SmartFusion® 2
IGLOO® 2
RTG4

Example

The following example creates a clock on pin clock_gen/reg2:Q with a period of 10 ns.

create_clock -period 10 [get_pins clock_gen/reg2:Q]

Related Examples on GitHub

See Also