Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 9/26/2022
Public

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

Document Table of Contents

4.1.20.3. generate_project_ip_files (::quartus::ipgen)

The following table displays information for the generate_project_ip_files Tcl command:

Tcl Package and Version

Belongs to ::quartus::ipgen

Syntax generate_project_ip_files [-h | -help] [-long_help] [-clean] [-clear_ip_generation_dirs] [-parallel <on|off> ] [-simulation <verilog|vhdl> ] [-simulator <modelsim|vcs|vcsmx|riviera|xcelium> ] [-synthesis <verilog|vhdl> ]
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-clean Specify whether pre-existing generation directories should be cleared before generation.
-clear_ip_generation_dirs Specify whether pre-existing generation directories should be cleared before generation.
-parallel <on|off> Specify whether to allow parallel IP generation. Specify off to disable parallel
-simulation <verilog|vhdl> Set the simulation target type. Valid values are verilog or vhdl.
-simulator <modelsim|vcs|vcsmx|riviera|xcelium> Set the simulator target type. Valid values are modelsim, vcs, vcsmx, riviera, and/or xcelium.
-synthesis <verilog|vhdl> Set the synthesis target type. Valid values are verilog or vhdl.
Description
This command generates the files for all Platform Designer IP in the opened project.
        If no option is specified, this command generates the verilog synthesis target only.

        --synthesis <value>:         Specify the synthesis target type. Valid values are verilog or vhdl. 
                                     This is not a required option. When not specified, it defaults to verilog.

        --simulation <value>:        Specify the simulation target type. Valid values are verilog or vhdl. 
                                     This is not a required option. When not specified, no simulation files are generated.

        --simulator <value>:        Specify the simulator target type. Valid values are modelsim, vcs, vcsmx, riviera, and/or xcelium. 
                                     This is not a required option. When not specified, simulation files for all simulators are generated.

        --clear_ip_generation_dirs:  Specify whether pre-existing generation directories should be cleared before generation.
                                     This is not a required option. When not specified, the generation directories will not be cleared.

        --clean:                    Specify whether pre-existing generation directories should be cleared before generation.
                                     This option is a short version of the clear_ip_generation_dirs option.
                                     This is not a required option. When not specified, the generation directories will not be cleared.

        --parallel <on,off>:         Specify whether to allow parallel IP generation. When this is on, parallel
                                      processing will be enable if project or global Quartus setting is enabled. 
                                      When this setting is off, parallel is disabled regardless of project or global 
                                      Quartus settings.
Example Usage
  # generate all the Platform Designer IP in the project with the specified targets. Clear any pre-existing 
          # generation directories before performing the generation.
project_open my_project
generate_project_ip_files -synthesis verilog -simulation verilog -simulator modelsim -clear_ip_generation_dirs
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_ERROR 1 ERROR: The file <string> does not exist in project.
TCL_ERROR 1 ERROR: You must open a project before you can use this command.
TCL_ERROR 1 ERROR: The command failed with an unknown error.