Quartus® Prime Software Scripting

Q: Quartus® II Tcl Scripting

Use the Tcl API for any of the following tasks:Creating and managing projectsMaking assignmentsCompiling designsExtracting report dataPerforming timing analysisFor example, the following Tcl script uses design files for the fir_filter tutorial design in the directory. The script creates a project, makes pin, clock, and timing assignments, and compiles the design.load_package flowproject_new fir_filter -revision filtref -overwriteset_global_assignment -name FAMILY Cycloneset_global_assignment -name DEVICE EP1C6F256C6set_global_assignment -name BDF_FILE filtref.bdfset_global_assignment -name TOP_LEVEL_ENTITY filtref# You could make other pin assignments hereset_location_assignment -to clk Pin_G1create_base_clock -fmax "100 MHz" -target clk clockacreate_relative_clock -base_clock clocka -divide 2 \\-offset "500 ps" -target clkx2 clockbset_multicycle_assignment -from clk -to clkx2 2execute_flow -compileproject_closeYou can use the Command-Line and Tcl API Help Utility for a complete list of Tcl API commands, descriptions, and examples. Run the utility by typing the following at a command prompt:quartus_sh --qhelp

Find information about the comprehensive scripting support for command-line and tool command language (TCL) script design flows.

Introduction Quartus® Prime Software Quartus® II Related Links

Introduction

The Quartus® Prime Software includes comprehensive scripting support for command-line and tool command language (Tcl) script design flows. Separate executables for each stage of the software design flow (synthesis, fitting, and timing analysis, for example) include options for making common settings and performing common tasks.

Quartus® Prime Software

Software Edition	Topic	Description	Resource
Pro	Command-Line Scripting	FPGA design software that easily integrates into your design flow saves time and improves productivity.	Quartus® Prime Pro Edition User Guide: Scripting
	Design Examples	Get started with FPGA products with ready-to-use design examples.	FPGA Design Store, Quartus® Prime Pro Edition
	Training	This class covers the command-line executables and how to use them in scripts and Makefiles. It also provides examples.	Command Line Scripting
		This class covers the command-line executables and how to use them in scripts and Makefiles. It also provides examples.	Introduction to Tcl
		This course presents the Tcl scripting capabilities in the Quartus® Prime software.	Quartus® Prime Software Tcl Scripting
Standard	Tcl Scripting	You can use Tcl scripts to control the Quartus® Prime software and to perform a wide range of functions, such as compiling a design or scripting common tasks.	Quartus® Prime Standard Edition User Guide: Scripting
	Design Examples	Get started with FPGA products with ready-to-use design examples.	FPGA Design Store, Quartus® Prime Standard Edition
	Training	This class covers the command-line executables and how to use them in scripts and Makefiles. It also provides examples.	Introduction to Tcl
	Training	This course presents the Tcl scripting capabilities in the Quartus® Prime software.	Quartus® Prime Software Tcl Scripting

Quartus® II

The Tcl scripting application program interface (API) includes commands covering basic to advanced functionality.

Expand All

Collapse All

Quartus® II Scripting Reference Manual lists and describes all QSF settings.

The Quartus® II Scripting Reference Manual (PDF) provides a complete reference covering all command-line options and Tcl commands. The Quartus® II Settings File Reference Manual (PDF) lists and describes all QSF settings.

Quartus® II Tcl Scripting

Use the Tcl API for any of the following tasks:

Creating and managing projects
Making assignments
Compiling designs
Extracting report data
Performing timing analysis

For example, the following Tcl script uses design files for the fir_filter tutorial design in the directory. The script creates a project, makes pin, clock, and timing assignments, and compiles the design.
load_package flow
project_new fir_filter -revision filtref -overwrite
set_global_assignment -name FAMILY Cyclone
set_global_assignment -name DEVICE EP1C6F256C6
set_global_assignment -name BDF_FILE filtref.bdf
set_global_assignment -name TOP_LEVEL_ENTITY filtref
# You could make other pin assignments here
set_location_assignment -to clk Pin_G1
create_base_clock -fmax "100 MHz" -target clk clocka
create_relative_clock -base_clock clocka -divide 2 \\

-offset "500 ps" -target clkx2 clockb

set_multicycle_assignment -from clk -to clkx2 2
execute_flow -compile
project_close
You can use the Command-Line and Tcl API Help Utility for a complete list of Tcl API commands, descriptions, and examples. Run the utility by typing the following at a command prompt:
quartus_sh --qhelp