Intel® Quartus® Prime Pro Edition User Guide: Platform Designer

ID 683609
Date 6/26/2023
Public

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

Document Table of Contents

8.10. Generate an IP Component or Platform Designer System with quartus_ipgenerate

The quartus_ipgenerate command allows you to generate IP components or a Platform Designer system in your Intel® Quartus® Prime project. Ensure that you include the IP component or the Platform Designer system you wish to generate in your Intel® Quartus® Prime project.
To run the quartus_ipgenerate command from the Intel® Quartus® Prime shell, type:
quartus_ipgenerate <project name> [<options>]
Use any of the following options with the quartus_ipgenerate utility:
Table 206.   quartus_ipgenerate Command-Line Options
Option Usage Description
<1st arg file> Required

Specifies the name of the Intel® Quartus® Prime project file (.qpf). This option generates all the .qsys and .ip files in the specified Intel® Quartus® Prime project (<project name>).

-f [<argument file>]

Optional

Specifies a file containing additional command-line arguments. Arguments that you specify after this option can conflict or override the options you specify in the argument file.

--rev[=<revision name>] or -c[=<revision name>]

Optional

Specifies the Intel® Quartus® Prime project revision and the associated .qsf file to use. If you omit this option, Platform Designer uses the same revision name as your Intel® Quartus® Prime project.

--clear_ip_generation_dirs or --clean

Optional

Clears the generation directories of all the .qsys or the .ip files in the specified Intel® Quartus® Prime project. For example, to clear the generation directories in the project test, run the following command:
quartus_ipgenerate --clear_ip_generation_dirs test

or

quartus_ipgenerate --clean test
--generate_ip_file --ip_file[=<ip file name>]

Optional

Generates the files for <file name>.ip file in the specified Intel® Quartus® Prime project.

Use the following optional flags with --generate_ip_file:
  • -synthesis[=<value>]—optional argument that specifies the synthesis target type. Specify the value as either verilog or vhdl. The default value is verilog.
  • -simulation[=<value>]—optional argument that specifies the simulation target type. Specify the value as either verilog or vhdl. If you omit this flag, Platform Designer does not generate any simulation files.
  • --clear_ip_generation_dirs—clears the preexisting generation directories before generation. If you omit this command, Platform Designer does not clear the generation directories.
For example, to generate the files for a test.qsys file within the project, test:
 quartus_ipgenerate --generate_ip_file --synthesis=vhdl --simulation=verilog --clear_ip_generation_dirs --ip_file=test.qsys test
--generate_project_ip_files [<project name>]

Optional

Generates the files for all the .qsys and .ip files in the specified Intel® Quartus® Prime project.

Use any of the following optional flags with --generate_project_ip_files:
  • -synthesis[=<value>]—optional argument that specifies the synthesis target type. Specify the value as either verilog or vhdl. The default value is verilog.
  • -simulation[=<value>]—optional argument that specifies the simulation target type. Specify the value as either verilog or vhdl. If you omit this flag, Platform Designer does not generate any simulation files.
  • --clear_ip_generation_dirs—clears the preexisting generation directories before generation. If you omit this command, Platform Designer does not clear the generation directories.
For example, to generate all the .qsys and .ip files within the project, test:
quartus_ipgenerate --generate_project_ip_files --synthesis=vhdl --simulation=verilog --clear_ip_generation_dirs test
--get_project_ip_files

Optional

Returns a list of the .qsys or .ip files in the specified Intel® Quartus® Prime project. This option displays each file in a separate Intel® Quartus® Prime message line. For example, to get a list of .qsys files in the project test, and revision rev:
quartus_ipgenerate --get_project_ip_files test -c rev
--lower_priority

Optional

Allows you to lower the priority of the current process. This option is useful if you use a single-processor computer, allowing you to use other applications more easily while the Intel® Quartus® Prime software runs the command in the background.