Intel® Quartus® Prime Standard Edition User Guide: Scripting

Download PDF
ID 683325
Date 9/24/2018
Public
Document Table of Contents
Document Table of Contents x
1. Command Line Scripting 2. Tcl Scripting A. Intel® Quartus® Prime Standard Edition User Guides
1. Command Line Scripting x
1.1. Benefits of Command-Line Executables 1.2. Introductory Example 1.3. Command-Line Scripting Help 1.4. Project Settings with Command-Line Options 1.5. Compilation with quartus_sh --flow 1.6. Text-Based Report Files 1.7. Using Command-Line Executables in Scripts 1.8. Common Scripting Examples 1.9. The QFlow Script 1.10. Document Revision History
1.4. Project Settings with Command-Line Options x
1.4.1. Option Precedence
1.8. Common Scripting Examples x
1.8.1. Create a Project and Apply Constraints 1.8.2. Check Design File Syntax 1.8.3. Create a Project and Synthesize a Netlist Using Netlist Optimizations 1.8.4. Archive and Restore Projects 1.8.5. Perform I/O Assignment Analysis 1.8.6. Update Memory Contents Without Recompiling 1.8.7. Create a Compressed Configuration File 1.8.8. Fit a Design as Quickly as Possible 1.8.9. Fit a Design Using Multiple Seeds
2. Tcl Scripting x
2.1. Tool Command Language 2.2. Intel® Quartus® Prime Tcl Packages 2.3. Intel® Quartus® Prime Tcl API Help 2.4. End-to-End Design Flows 2.5. Creating Projects and Making Assignments 2.6. Compiling Designs 2.7. Reporting 2.8. Timing Analysis 2.9. Automating Script Execution 2.10. Other Scripting Features 2.11. The Intel® Quartus® Prime Tcl Shell in Interactive Mode Example 2.12. The tclsh Shell 2.13. Tcl Scripting Basics 2.14. Tcl Scripting Revision History
2.2. Intel® Quartus® Prime Tcl Packages x
2.2.1. Loading Packages
2.3. Intel® Quartus® Prime Tcl API Help x
2.3.1. Command-Line Options 2.3.2. The Intel® Quartus® Prime Tcl Console Window
2.3.1. Command-Line Options x
2.3.1.1. Run a Tcl Script 2.3.1.2. Interactive Shell Mode 2.3.1.3. Evaluate as Tcl
2.6. Compiling Designs x
2.6.1. The flow Package 2.6.2. Compile All Revisions
2.7. Reporting x
2.7.1. Saving Report Data in csv Format
2.9. Automating Script Execution x
2.9.1. Execution Example 2.9.2. Controlling Processing 2.9.3. Displaying Messages
2.10. Other Scripting Features x
2.10.1. Natural Bus Naming 2.10.2. Short Option Names 2.10.3. Collection Commands 2.10.4. The post_message Command 2.10.5. Accessing Command-Line Arguments 2.10.6. The quartus() Array
2.10.3. Collection Commands x
2.10.3.1. The foreach_in_collection Command 2.10.3.2. The get_collection_size Command
2.10.5. Accessing Command-Line Arguments x
2.10.5.1. The cmdline Package
2.13. Tcl Scripting Basics x
2.13.1. Hello World Example 2.13.2. Variables 2.13.3. Substitutions 2.13.4. Arithmetic 2.13.5. Lists 2.13.6. Arrays 2.13.7. Control Structures 2.13.8. Procedures 2.13.9. File I/O 2.13.10. Syntax and Comments 2.13.11. External References
2.13.3. Substitutions x
2.13.3.1. Variable Value Substitution 2.13.3.2. Nested Command Substitution 2.13.3.3. Backslash Substitution
1. Command Line Scripting
2. Tcl Scripting
A. Intel® Quartus® Prime Standard Edition User Guides

2.3. Intel® Quartus® Prime Tcl API Help

Intel® Quartus® Prime Tcl help allows easy access to information about the Intel® Quartus® Prime Tcl commands.
  • This command opens the Intel® Quartus® Prime Command-Line and Tcl API help browser, which documents all commands and options in the Intel® Quartus® Prime Tcl API. At a system command prompt, access the Intel® Quartus® Prime Tcl API Help by typing:
    quartus_sh --qhelp
  • The Tcl API Help can be accessed from the Tcl console as well. At a Tcl prompt, type 
    help
    to access the help information. The output is: 
    tcl> help
-------------------------------------------------------------------------
----------------------------------
Available 
               Intel® 
               Quartus® Prime Tcl Packages:
----------------------------------
Loaded              Not Loaded
------------------  ----------------------------------
::quartus::device   ::quartus::external_memif_toolkit
::quartus::misc     ::quartus::iptclgen
::quartus::project  ::quartus::design
                    ::quartus::rtm
                    ::quartus::partial_reconfiguration
                    ::quartus::report
                    ::quartus::names
                    ::quartus::incremental_compilation
                    ::quartus::flow
                    
* Type "help -tcl"
to get an overview on 
               Intel® 
               Quartus® Prime Tcl usages.
		
* Type "help <package name>"
  to view a list of Tcl commands available for
  the specified 
               Intel® 
               Quartus® Prime Tcl package.
The Tcl console provides help options that display specific information:
Table 5.  Help Options Available in the Intel® Quartus® Prime Tcl Environment
Help Command Description 
help
 Displays complete list of available Intel® Quartus® Prime Tcl packages. 
help -tcl
 Explains how to load Tcl packages and access command-line help. 
help -pkg <package_name -[-version <version number>]
 Displays help commands of the Intel® Quartus® Prime package that you specify, including the list of available Tcl commands.
  • If you do not specify -version, the Intel® Quartus® Prime software loads the latest version of the package.
  • If the package is not loaded, the Intel® Quartus® Prime software displays the help for the latest version of the package.
Examples:
help -pkg ::quartus::project
help -pkg project
help -pkg project -version 1.0
 
<command_name> -h
or
<command_name> -help
 Displays the short help of a Intel® Quartus® Prime Tcl command in a loaded package. Examples:
project_open -h
project_open -help
 
package require ::quartus::<package name>[<version>]
 Loads a specific version of an Intel® Quartus® Prime Tcl package. If you do not specify -version, the Intel® Quartus® Prime software loads the latest version of the package.

Example:

package require ::quartus::project 1.0

This command is similar to the load_package command 

load_package <package name> [-version <version number>]

Allows you to alternate between different versions of the same package.

Example:

load_package ::quartus::project -version 1.0
 
help -cmd <command_name>
	  -[-version <version>]

or

<command_name> -long_help
 Displays the complete help text for an Intel® Quartus® Prime Tcl command. If you do not specify -version, the Intel® Quartus® Prime software loads the latest version of the package.

Examples: 

project_open -long_help
help -cmd project_open
help -cmd project_open -version 1.0
 
help -examples
 Displays examples of Intel® Quartus® Prime Tcl usage. 
help -quartus
 To view help on the predefined global Tcl array that contains project information and information about the Intel® Quartus® Prime executable that is currently running. 
quartus_sh --qhelp
 Launches the Tk viewer for Intel® Quartus® Prime command-line help and display help for the command-line executables and Tcl API packages. 
help -timequestinfo
 To view help on the predefined global 
"TimeQuestInfo"
Tcl array that contains delay model information and speed grade information of a Timing Analyzer design that is currently running.

The Tcl API help is also available in Intel® Quartus® Prime online help. Search for the command or package name to find details about that command or package.


Section Content
Command-Line Options
The Intel Quartus Prime Tcl Console Window

Level Two Title