vitis command
Launch the Vitis Unified IDE using the
vitis
command with the following syntax:
vitis -w <workspace>
You can also use a number of other modes when working with the Vitis tool. You can use -h
or
--help
to show the supported modes of the vitis
command.
vitis -h
Syntax: vitis [-g (default) | -a | -w | -i | -s | -h | -v]
Options:
Launches New Vitis IDE (default option).
-a/--analyze [<summary file | folder | waveform file: *.[wdb|wcfg]>]
Open the summary file in the Analysis view.
Opening a folder opens the summary files found in the folder.
Open the waveform file in a waveform view tab.
If no file or folder is specified, opens the Analysis view.
-w/--workspace <workspace_location>
Launches Vitis IDE with the given workspace location.
-i/--interactive
Launches Vitis python interactive shell.
-s/--source <python_script>
Runs the given python script.
-j/--jupyter
Launches Vitis Jupyter Web UI.
-h/--help
Display help message.
-v/--version
Display Vitis version.
The Vitis Unified IDE launches either the
v++ -c --mode hls
command to synthesize the HLS
component, or launches the vitis-run
command to run C
Simulation, Code Analyzer, C/RTL Co-Simulation, Package, and Implementation as described in
Creating HLS Components from the Command Line. These commands are explained below.
v++ Command
The v++ -c --mode hls
command is used to
synthesize the HLS component for either the Vivado IP or Vitis kernel flow targets as described in Target Flow Overview, or compile the HLS component for use in software emulation of
the System Project in the Vitis Unified IDE as described
in Building and Running an HLS Component.
When using the v++ command in HLS component mode, the configuration file specifies a number of options for the tool and optimization directives for the source code as described in HLS Config File Commands. You can see some of these options by running the following command:
v++ -c --mode hls -h
usage: v++ [options] <input file...>
Options allowed only on a command line:
-c [ --compile ] Run a compile flow
-h [ --help ] Display usage message
-m [ --mode ] arg [aie|hls] Specify a mode. Must be used with
--compile/-c option
-v [ --version ] Display version information
--config arg Config file
--work_dir arg Specify a working directory for output files and
directories
Options allowed in a config file or a command line:
-f [ --platform ] arg Specify path to a platform specification(XPFM) or
hardware specification(XSA)
--freqhz arg Specify a PL clock frequency in Hz or MHz
--part arg Specify a part
[hls] section:
--hls.* arg Specify hls section options. For more information,
see: <https://docs.amd.com/r/en-US/ug1702-vitis-accel
erated-reference/v-Mode-HLS>
vitis-run Command
The vitis-run
command is used to run process steps on the HLS
component using the --mode hls
option. To see what command options
are supported for the vitis-run
command use the following
command:
vitis-run --mode hls -h
usage: vitis-run [options] <input file...>
Options allowed only on a command line:
-h [ --help ] Display usage message
-v [ --version ] Display version information
--config arg Config file
--cosim Specify hls run option cosim
--csim Specify hls run option csim
--impl Specify hls run option impl for vivado ooc
--input_file arg Specify input Tcl file; input file can also be
specified positionally without using the --input_file
option
--itcl Interactive hls Tcl shell
--mode arg (=hls) [hls] Specify a mode
--package Specify hls run package option
--tcl Evaluate hls Tcl file
--work_dir arg Specify a working directory for output files and
directories
Options allowed in a config file or a command line:
-f [ --platform ] arg Specify path to a platform specification(XPFM) or
hardware specification(XSA)
--freqhz arg Specify a PL clock frequency in Hz or MHz
--part arg Specify a part
[hls] section:
--hls.* arg Specify hls section options. For more information,
see: <https://docs.amd.com/r/en-US/ug1702-vitis-accel
erated-reference/vitis-run-Command>