Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 12/13/2021

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

Document Table of Contents set_power_file_assignment (::quartus::project)

The following table displays information for the set_power_file_assignment Tcl command:

Tcl Package and Version

Belongs to ::quartus::project

Syntax set_power_file_assignment [-h | -help] [-long_help] [-remove] [-saf_file <saf_file> ] [-section_id <section_id> ] [-to <to> ] [-vcd_end_time <vcd_end_time> ] [-vcd_file <vcd_file> ] [-vcd_start_time <vcd_start_time> ]
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-remove Option to remove assignment
-saf_file <saf_file> SAF file name
-section_id <section_id> Section id
-to <to> Entity to which to apply power input file
-vcd_end_time <vcd_end_time> End time for VCD file parsing
-vcd_file <vcd_file> VCD file name
-vcd_start_time <vcd_start_time> Start time for VCD file parsing
Sets or removes a power input file assignment. Power input file
assignments are specified using multiple global assignments, and
a single instance assignment as illustrated in the following

set_global_assignment -name POWER_INPUT_FILE_NAME "test.vcd" -section_id test.vcd
set_global_assignment -name POWER_INPUT_FILE_TYPE VCD -section_id test.vcd
set_global_assignment -name POWER_VCD_FILE_START_TIME "10 ns" -section_id test.vcd
set_global_assignment -name POWER_VCD_FILE_END_TIME "1000 ns" -section_id test.vcd
set_instance_assignment -name POWER_READ_INPUT_FILE test.vcd -to test_design

The power input file assignment serves as a wrapper for all of the
above assignments. If the "-remove" setting is not set, the
set_power_file_assignment will also make the following assignment
to enable the use of input files:

set_global_assignment -name POWER_USE_INPUT_FILES ON

If you do not specify a "-section_id", a new section identifier is
created for the input file assignment. If a "-section_id" is
specified and it does not already exist, it is used as the new
section identifier. If a "-section_id" is specified and it does
exist, the existing input file assignments are removed and a new
input file assignment is created using the given parameters and 
section identifier.

If an entity name given by "-to" is not specified, the input file
assignment applys to the top level design entity.

If the "-remove" setting is used, the input file assignment given
by the "-section_id", "-vcd_file", or "-saf_file" is removed
from the project.

Assignments created or modified by using this Tcl command are
saved to the Quartus Prime Settings File (.qsf).
Example Usage
## Specify an input SAF file applied to the top level entity
## A default section will be created
set_power_file_assignment -saf_file test.saf

## Specify an input VCD file applied to design_top|counter1
## Use the given section_id to create a new section
set_power_file_assignment -vcd_file test.vcd -to design_top|counter1 -section_id test.vcd

## Update the previous input VCD file assignment to specify a
## start and end time
set_power_file_assignment -vcd_file test.vcd -to design_top|counter1 -vcd_start_time 10ns -vcd_end_time 100ns -section_id test.vcd

## Remove the input SAF file assignment using the file name
set_power_file_assignment -saf_file test.saf -remove

## Remove the input VCD file assignment using the section identifier
set_power_file_assignment -section_id test.vcd -remove
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_ERROR 1 ERROR: Can't find active revision name. Make sure there is an open, active revision name.
TCL_ERROR 1 ERROR: Compiler database does not exist for revision name: <string>. At the minimum, run Analysis and Synthesis (quartus_map) with the specified revision name before using this Tcl command.
TCL_ERROR 1 ERROR: Exactly one of the following file name options must be specified: -<string> or -<string>.
TCL_ERROR 1 ERROR: If -<string> is set, exactly one of the following options must be specified: -<string>, -<string> or -<string>. All other options must not be set.
TCL_ERROR 1 ERROR: You must open a project before you can use this command.
TCL_ERROR 1 ERROR: -<string> and -<string> cannot be used with -<string> option.