Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 12/13/2021
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.11.2. execute_module (::quartus::flow)

The following table displays information for the execute_module Tcl command:

Tcl Package and Version

Belongs to ::quartus::flow

Syntax execute_module [-h | -help] [-long_help] [-args <arguments> ] [-dont_export_assignments] [-tool <asm|cdb|drc|eda|fit|map|syn|pow|sta|stp|sim|si|cpf|ipg|pfg> ]
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-args <arguments> Option to specify arguments for the executable
-dont_export_assignments Option not to export assignments to file. By default, this command exports assignments before running command-line executables.
-tool <asm|cdb|drc|eda|fit|map|syn|pow|sta|stp|sim|si|cpf|ipg|pfg> Option to run the specified executable
Description
Runs one of the command-line executables, such as quartus_map or
quartus_fit. If the -args option is specified, the arguments are
passed to the command-line executable.

All assignments are exported automatically first, as if the
"export_assignments" command was called first, unless
-dont_export_assignments option is specified.

You must use the Tcl command "catch" to determine whether the
command-line executable ran successfully or not, as in the following
example:

if {[catch {execute_module -tool map} result]} {
	puts "\nResult: $result\n"
	puts "ERROR: Analysis and Synthesis failed. See the report file.\n"
} else {
	puts "\nINFO: Analysis and Synthesis was successful.\n"
}
Example Usage
# Run quartus_map using device family Stratix and device part EP1S10B672C6.
execute_module -tool map -args "--family=Stratix --part=EP1S10B672C6"

# Compile using a set of executables
execute_module -tool map
execute_module -tool fit
execute_module -tool sta
execute_module -tool asm
execute_module -tool eda

# To determine if Analysis and Synthesis was successful or not
# and print out a personalized message.
if {[catch {execute_module -tool map} result]} {
	puts "\nResult: $result\n"
	puts "ERROR: Analysis and Synthesis failed. See the report file.\n"
} else {
	puts "\nINFO: Analysis and Synthesis was successful.\n"
}
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_ERROR 1 ERROR: Can't run multiple flows simultaneously. Wait for current flow to complete.
TCL_ERROR 1 ERROR: Can't find active revision. Make sure there is an open, active revision name. Use the -revision option of project_open, project_new, or use set_current_revision.
TCL_ERROR 1 ERROR: No project is currently open. Open an existing project or create a new project.
TCL_ERROR 1 ERROR: Error(s) found while running an executable. See report file(s) for error message(s). Message log indicates which executable was run last.
TCL_ERROR 1 ERROR: Option is required: -tool. Specify the -tool option.

Did you find the information on this page useful?

Characters remaining: