Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 10/04/2021

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents get_pin_info (::quartus::sta)

The following table displays information for the get_pin_info Tcl command:

Tcl Package and Version

Belongs to ::quartus::sta

Syntax get_pin_info [-h | -help] [-long_help] [-is_clock_pin] [-is_in_pin] [-is_out_pin] [-name] [-net] [-parent_cell] [-suffix] [-type] <pin_object>
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-is_clock_pin Return true if it is a clock pin, or false otherwise
-is_in_pin Return true if it is an input pin, or false otherwise
-is_out_pin Return true if it is an output pin, or false otherwise
-name Return the pin name
-net Return the net ID if this is an output pin
-parent_cell Return the parent cell ID
-suffix Return the suffix of the pin
-type Return the pin type
<pin_object> Pin object

Gets information about the specified pin (referenced by pin ID). Pin ID's can be obtained by Tcl commands such as get_pins. The -type option returns "pin". Options -name, -type, -parent_cell, -net, -suffix, -is_clock_pin, -is_in_pin and -is_out_pin are mutually exclusive.

Example Usage
project_open chiptrip
set pins [get_pins]
foreach_in_collection pin $pins {
	set pin_name [get_pin_info $pin -name]
	set parent_cell [get_pin_info $pin -parent_cell]
	puts "Pin $pin_name belongs to cell [get_cell_info -name $parent_cell]"
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_ERROR 1 ERROR: Options are mutually exclusive: <string>. Specify only one of the these options.
TCL_ERROR 1 ERROR: Object with ID <string> is not an object of type <string>. Specify the ID of an object with the correct type.
TCL_ERROR 1 ERROR: Cannot find object of ID <string>. Specify an existing object ID.