config_export

Description

Configures options for export_design which can either run downstream tools or package a Vivado IP or Vitis compiled kernel object (.xo).

Syntax

config_export [OPTIONS]

Options

-description <string>

Provides a description for the catalog entry for the generated IP, used when packaging the IP.

-display_name <string>

Provides a display name for the catalog entry for the generated IP, used when packaging the IP.

-format (ip_catalog | xo | syn_dcp | sysgen)

Specifies the format to package the IP. The supported formats are:

  • ip_catalog: A format suitable for adding to the Xilinx IP catalog.
  • xo: A format accepted by the v++ compiler for linking in the Vitis application acceleration flow.
  • 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.
  • sysgen: Generate a Vivado IP and .zip archive for use in System Generator.
-ipname <string>
Provides the name component of the Vendor:Library:Name:Version (VLNV) identifier for generated IP.
-library <string>
Provides the library component of the Vendor:Library:Name:Version (VLNV) identifier for generated IP.
-output <string>
Specifies the output location of the generated IP, .xo, or DCP files. The file is written to the solution/impl folder of the current project if no output path is specified.
-rtl (verilog | VHDL)
Specifies which HDL is used when the -flow option is executed. If not specified, Verilog is the default language for the Vivado synthesized netlist.
-taxonomy <string>
Specifies the taxonomy for the catalog entry for the generated IP, used when packaging the IP.
-vendor <string>
Provides the vendor component of the Vendor:Library:Name:Version (VLNV) identifier for generated IP.
-version <string>
Provides the version component of the Vendor:Library:Name:Version (VLNV) identifier for generated IP.
-vivado_impl_strategy <string>
Specifies Vivado implementation strategy name. The default name is 'default'.
-vivado_ip_cache <string>
Specifies path to Vivado IP cache. for use in out-of-context synthesis.
-vivado_optimization_level (0 | 1 | 2 | 3)
Vivado optimization level. This option sets other vivado_* options.
-vivado_phys_opt (none | place | route | all)
Specifies whether Vivado physical optimization should be run during Vivado implementation. Valid values are:
  • none: Do not run (default)
  • place: Run post-place
  • route: Run post-route
  • all: Run post-place and post-route
-vivado_report_level (0 | 1 | 2)
Specifies how many Vivado reports are generated, valid values and the associated reports are:
  • 0: Post-synthesis utilization, Post-impl utilization and timing (default)
  • 1: Post-synthesis utilization, timing and analysis, Post-impl utilization, timing and analysis
  • 2: Post-synthesis utilization, timing, analysis and failfast, Post-impl utilization, timing and failfast
-vivado_synth_design_args <string>
Specifies extra arguments to pass to the Vivado synth_design command. The default is -directive sdx_optimization_effort_high.
-vivado_synth_strategy <string>
Specifies Vivado synth strategy name. The default strategy is 'default'.

Examples

The following example exports the Vitis .xo to the specified file:
export_design -description "Kernel Export" -display_name kernel_export \
-flow impl -format xo -output "tmp/hls_tests/kernel.xo"