Output Options
The package.output options are used to specify the nature of the exported files generated from the synthesized RTL design. These options include the following:
- package.output.file
- Specifies the output file path and name for the exported
file. When not specified the Vitis unified IDE will name the
output file after the HLS component. An example command would be:
package.output.file=../kernel.xo - package.output.format
- Specifies the exported format of the output generated after
synthesis. The supported values are:
-
package.output.format=ip_catalog: A format suitable for adding to the Vivado IP catalog. -
package.output.format=xo: A format accepted by thev++compiler for linking in the Vitis application acceleration flow. -
package.output.format=syn_dcp: Synthesized checkpoint file for Vivado Design Suite. If this option is used, RTL synthesis is automatically executed. Vivado implementation can be optionally added usingvivado.flow=impl -
package.output.format=sysgen: Generate an IP and .zip archive for use in System Generator. -
package.output.format=rtl: Outputs the RTL files that are generated by C synthesis, and does not package the IP or XO used for downstream processes.Tip: The RTL format is useful for development, analysis, and debug of the HLS component. However, to export files you must specify one of the other output formats.
-
- package.output.syn
- Enables the running of the Package step as part of the C synthesis step to generate the required export files during synthesis.
IP Options
The package.ip commands specify details of
the IP being generated by the HLS component. These are settings to define the IP
Vendor, Library, Name, and Version (VLNV) for example to identify it in the IP
catalog.
- package.ip.description
-
Provides a description for the catalog entry for the generated IP, used when packaging the IP.
package.ip.description=details of IP - package.ip.display_name
-
Provides a display name for the catalog entry for the generated IP, used when packaging the IP.
package.ip.display_name=randy1 - package.ip.library
-
Provides the library component of the
<Vendor>:<Library>:<Name>:<Version>(VLNV) identifier for generated IP.package.ip.library=testLib - package.ip.name
-
Provides the name component of the
<Vendor>:<Library>:<Name>:<Version>(VLNV) identifier for the generated IP.package.ip.name=randy1 - package.ip.taxonomy
-
Specifies the taxonomy for the catalog entry for the generated IP, used when packaging the IP. Taxonomy is a category to help identify the purpose or application of the IP.
package.ip.taxonomy=video - package.ip.vendor
-
Provides the vendor component of the
<Vendor>:<Library>:<Name>:<Version>(VLNV) identifier for generated IP.package.ip.vendor=randyCom - package.ip.version
-
Provides the version component of the
<Vendor>:<Library>:<Name>:<Version>(VLNV) identifier for generated IP.package.ip.version=2.3 - package.ip.xdc_file
-
Specify an XDC file whose contents will be included in the packaged IP for use during implementation in the Vivado tool.
package.ip.xdc_file=../../ip.xdc - package.ip.xdc_ooc_file
-
Specify an out-of-context (OOC) XDC file whose contents will be included in packaged IP and used during out-of-context Vivado synthesis for the exported IP.
package.ip.xdc_ooc_file=../../ooc,xdc