Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 9/26/2022
Public

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

Document Table of Contents

4.1.3.11. get_port_by_type (::quartus::chip_planner)

The following table displays information for the get_port_by_type Tcl command:

Tcl Package and Version

Belongs to ::quartus::chip_planner

Syntax get_port_by_type [-h | -help] [-long_help] [-as_gen_id] [-gen_id <gen id> ] [-literal_index <literal index> ] [-node <node id> ] -port_type <port type> -type <iport|oport>
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-as_gen_id Option to return result as generic ID
-gen_id <gen id> Node generic id
-literal_index <literal index> Literal index
-node <node id> Node id
-port_type <port type> Port type
-type <iport|oport> Option to specify the port as an input or output port
Description
Returns the port index for the specified port type on
the specified node.

Returns -1 if the port is not in use or is invalid for
the specified node.
Example Usage
get_port_by_type -node 0 -port_type SLOAD -type iport
get_port_by_type -node 0 -port_type EXTCLK -literal_index 2 -type oport
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_ERROR 1 ERROR: Unable to find port type: <string>. Specify a different port type.
TCL_ERROR 1 ERROR: Conflicting arguments. Consult help for the Tcl command for details.
TCL_ERROR 1 ERROR: Illegal node generic ID: %u. Specify a legal node generic ID.
TCL_ERROR 1 ERROR: Illegal node ID: %u. Specify a legal node ID.
TCL_ERROR 1 ERROR: Illegal port type: <string>. Specify a legal port type.
TCL_ERROR 1 ERROR: The node you specified is a legalization node. Modification of legalization nodes is not supported.
TCL_ERROR 1 ERROR: Unable to find Chip Planner netlist. Read the netlist by using the read_netlist command.