Intel® Quartus® Prime Pro Edition User Guide Scripting Updated for Intel® Quartus® Prime Design Suite: 21.1 Subscribe UG-20144 | 2021.03.29 Send Feedback Latest document on the web: PDF | HTML Contents Contents 1. Command Line Scripting................................................................................................. 5 1.1. Benefits of Command-Line Executables.....................................................................5 1.2. Command-Line Scripting Help................................................................................. 6 1.3. Project Settings with Command-Line Options.............................................................6 1.3.1. Option Precedence..................................................................................... 7 1.4. Compilation with quartus_sh --flow.......................................................................... 8 1.4.1. Resuming a Compilation with quartus_sh --flow............................................. 9 1.5. Text-Based Report Files.......................................................................................... 9 1.6. Using Command-Line Executables in Scripts............................................................ 10 1.7. Common Scripting Examples................................................................................ 10 1.7.1. Create a Project and Apply Constraints....................................................... 10 1.7.2. Check Design File Syntax.......................................................................... 11 1.7.3. Create a Project and Synthesize a Netlist Using Netlist Optimizations.............. 11 1.7.4. Archive and Restore Projects..................................................................... 12 1.7.5. Update Memory Contents Without Recompiling............................................ 12 1.7.6. Create Device Configuration Files............................................................... 13 1.7.7. Fit a Design Using Multiple Seeds............................................................... 14 1.8. The QFlow Script................................................................................................. 14 1.8.1. --partition Option.....................................................................................15 1.9. Command-Line Scripting Revision History................................................................16 2. Tcl Scripting..................................................................................................................18 2.1. Tool Command Language...................................................................................... 18 2.2. The Intel Quartus Prime Tcl Console Window............................................................19 2.3. Intel Quartus Prime Tcl Packages........................................................................... 19 2.3.1. Loading Tcl Packages................................................................................ 21 2.3.2. Intel Quartus Prime Tcl API Help................................................................ 21 2.4. Tcl Design Flow Controls....................................................................................... 24 2.4.1. Creating Projects and Making Assignments.................................................. 24 2.4.2. Compiling Designs................................................................................... 25 2.4.3. Reporting................................................................................................25 2.4.4. Timing Analysis....................................................................................... 27 2.5. Automating Script Execution..................................................................................27 2.5.1. Execution Example...................................................................................28 2.5.2. Controlling Processing.............................................................................. 29 2.5.3. Displaying Messages.................................................................................29 2.6. Other Scripting Features....................................................................................... 29 2.6.1. Natural Bus Naming................................................................................. 29 2.6.2. Short Option Names................................................................................. 30 2.6.3. Collection Commands............................................................................... 30 2.6.4. Node Finder Commands............................................................................31 2.6.5. The get_names Command.........................................................................38 2.6.6. The post_message Command.................................................................... 40 2.6.7. Accessing Command-Line Arguments..........................................................40 2.6.8. The quartus() Array..................................................................................42 2.7. The Intel Quartus Prime Tcl Shell in Interactive Mode Example................................... 42 2.8. The tclsh Shell.....................................................................................................43 Intel Quartus Prime Pro Edition User Guide: Scripting Send Feedback 2 Contents 2.9. Tcl Scripting Basic Examples..................................................................................43 2.9.1. Hello World Example................................................................................ 43 2.9.2. Variables................................................................................................ 44 2.9.3. Substitutions...........................................................................................44 2.9.4. Arithmetic...............................................................................................45 2.9.5. Lists.......................................................................................................45 2.9.6. Arrays.................................................................................................... 45 2.9.7. Control Structures....................................................................................46 2.9.8. Procedures..............................................................................................47 2.9.9. File I/O...................................................................................................47 2.9.10. Syntax and Comments............................................................................48 2.9.11. External References................................................................................49 2.10. Tcl Scripting Revision History............................................................................... 49 3. TCL Commands and Packages....................................................................................... 51 3.1. TCL Commands and Packages Summary................................................................. 51 3.1.1. ::quartus::backannotate...........................................................................67 3.1.2. ::quartus::bpps.......................................................................................70 3.1.3. ::quartus::chip_planner............................................................................90 3.1.4. ::quartus::design.................................................................................... 98 3.1.5. ::quartus::device...................................................................................111 3.1.6. ::quartus::dni_sdc................................................................................. 115 3.1.7. ::quartus::drc....................................................................................... 137 3.1.8. ::quartus::eco....................................................................................... 150 3.1.9. ::quartus::external_memif_toolkit............................................................163 3.1.10. ::quartus::fif....................................................................................... 186 3.1.11. ::quartus::flng.....................................................................................192 3.1.12. ::quartus::flow.................................................................................... 201 3.1.13. help....................................................................................................206 3.1.14. ::quartus::insystem_memory_edit......................................................... 208 3.1.15. ::quartus::insystem_source_probe......................................................... 215 3.1.16. ::quartus::interactive_synthesis.............................................................219 3.1.17. ::quartus::ipgen.................................................................................. 227 3.1.18. ::quartus::iptclgen............................................................................... 231 3.1.19. ::quartus::jtag.....................................................................................234 3.1.20. ::quartus::logic_analyzer_interface........................................................ 244 3.1.21. ::quartus::misc....................................................................................249 3.1.22. ::quartus::names.................................................................................261 3.1.23. ::quartus::periph................................................................................