Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 6/20/2022
Public

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

Document Table of Contents

3.1.29.22. get_instance_assignment (::quartus::project)

The following table displays information for the get_instance_assignment Tcl command:

Tcl Package and Version

Belongs to ::quartus::project

Syntax get_instance_assignment [-h | -help] [-long_help] [-entity <entity_name> ] [-fall] [-from <source> ] [-front] -name <name> [-rise] [-section_id <section id> ] [-tag <data> ] [-to <destination> ]
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-entity <entity_name> Entity to which assignment belongs
-fall Option applies to falling edge
-from <source> Source of assignment
-front Option to return the first assignment if there is more than one assignment found
-name <name> Assignment name
-rise Option applies to rising edge
-section_id <section id> Section id
-tag <data> Option to tag data to this assignment
-to <destination> Destination of assignment
Description
Returns the value of the instance assignment.

The "-name" option is not case sensitive.  The
"-entity", "-to", and "-from" options are case
sensitive.

For entity-specific assignments, use the "-entity"
option to retrieve the assignment from the specified
entity. If the "-entity" option is not specified, the
value for the FOCUS_ENTITY_NAME assignment is used. If
the FOCUS_ENTITY_NAME value is not found, the revision
name is used.
Example Usage
## Get the TSU_REQUIREMENT from mypin to any register
set value [get_instance_assignment -from "mypin" -to * -name TSU_REQUIREMENT]
puts "TSU_REQUIREMENT(mypin->*) = $value"
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_ERROR 1 ERROR: Assignment is not an instance assignment: <string> -- it is a global assignment. Specify an instance assignment name or use the global assignment commands.
TCL_ERROR 1 ERROR: Can't find file(s) associated with assignment. Specify a different assignment name.
TCL_ERROR 1 ERROR: Can't find section information for assignment. Specify a different assignment name.
TCL_ERROR 1 ERROR: Can't find active revision name. Make sure there is an open, active revision name.
TCL_ERROR 1 ERROR: Entity does not exist or uses illegal name characters: <string>. Specify a legal entity name.
TCL_ERROR 1 ERROR: Value <string> for the -<string> option is illegal. Specify a legal value.
TCL_ERROR 1 ERROR: Options cannot be specified together: -<string>, -<string> and -<string>. Specify only one or two of the three options.
TCL_ERROR 1 ERROR: Missing destination for assignment. Specify the destination for the assignment.
TCL_ERROR 1 ERROR: You must open a project before you can use this command.
TCL_ERROR 1 ERROR: Ignored assignment: <string>. The assignment is no longer supported.
TCL_ERROR 1 ERROR: Found two options: -<string> and -<string>. Choose one of the options.
TCL_ERROR 1 ERROR: Illegal assignment name: <string>. Specify a legal assignment name. To view the list of legal assignment names, run get_all_assignment_names.
TCL_ERROR 1 ERROR: An unknown error has occured.
TCL_ERROR 1 ERROR: Assignment <string> has multiple values. Use the <string> command to get all values or use the <string> -front command to get the first value.