The --advanced.param and --advanced.prop options specify parameters and properties
for use by the v++ command. When compiling or
linking, these options offer fine-grain control over the hardware generated by the
Vitis core development kit, and the hardware
emulation process.
The arguments for the --advanced.xxx
options are specified as <param_name>=<param_value>. For example:
v++ --link -–advanced.param compiler.enableXSAIntegrityCheck=true
-–advanced.prop kernel.foo.kernel_flags="-std=c++0x"--config option,
as discussed in Vitis Compiler Configuration File. For example, the
--platform option can be specified in a
configuration file without a section head using the following syntax:
platform=xilinx_u200_gen3x16_xdma_2_202110_1--advanced.param
--advanced.param <param_name>=<param_value>Specifies advanced parameters as described in the table below.
Param Options
| Parameter Name | Valid Values | Description |
|---|---|---|
compiler.acceleratorBinaryContent
|
Type: String Default Value:
|
Design content to insert in the generated
xclbin file. Valid options
include bitstream, pdi, or dcp.
Tip:
You can specify two values to have This parameter is used while building the hardware target, this option applies to:
|
compiler.addOutputTypes
|
Type: String Default Value:
|
Additional output types produced by the
Vitis compiler. Valid
values include: xclbin and
hw_export. Use hw_export to create a fixed XSA from
dynamic hardware platforms for use in the Embedded Software
Development Flow.Applies to:
|
compiler.axiDeadLockFree
|
Type: Boolean Default Value: TRUE |
Avoid dead locks. This option is enabled by default for Vitis HLS. |
compiler.deadlockDetection
|
Type: Boolean Default Value: FALSE |
Enables detection of kernel deadlocks during the simulation run as
part of hardware emulation. The tool posts an Error message to the
console and the log file when the application is
deadlocked:The message is repeated until the deadlock is terminated. You must manually terminate the application to end the deadlock condition. Tip: When
deadlocks are encountered during simulation, you can open the
kernel code in Vitis HLS
for additional deadlock detection and debug capability.
Applies to:
|
compiler.emulationMode=<mode>
|
Type: String func | rtl |
Indicates that the kernel should be compiled as
RTL code for use in hardware emulation and hardware design, or as a
C functional model with a SystemC wrapper for use in hardware
emulation as described in Working with Functional Model of the HLS Kernel. This option
applies to |
compiler.enableIncrHwEmu
|
Type: Boolean Default Value: FALSE |
Use to enable incremental compilation of the
hardware emulation xclbin
when there are minor changes made to the platform. This enables a
quick rebuild of the device binary for hardware emulation when the
platform has been updated. Applies to:
|
compiler.errorOnHoldViolation
|
Type: Boolean Default Value: TRUE |
After the last step of Vivado implementation, during
timing analysis check, and clock scaling if needed. If hold
violations are found, v++ quits
and returns an error by default, and does not generate an xclbin. This parameter lets you over
ride the default behavior.Applies to:
|
compiler.fsanitize
|
Type: String Default Value:
|
Enables additional memory access checks for
OpenCL kernels as
described in Debugging OpenCL Kernels.
Valid values include: address, memory. Applies to Software Emulation and Debug. |
compiler.interfaceRdBurstLen
|
Type: Int Range Default
Value: |
Specifies the expected length of AXI read
bursts on the kernel AXI interface. This is used with option compiler.interfaceRdOutstanding to
determine the hardware buffer sizes. Values are 1 through 256.Applies to:
|
compiler.interfaceWrBurstLen
|
Type: Int Range Default
Value: |
Specifies the expected length of AXI write
bursts on the kernel AXI interface. This is used with option compiler.interfaceWrOutstanding to
determine the hardware buffer sizes. Values are 1 through 256.Applies to:
|
compiler.interfaceRdOutstanding
|
Type: Int Range Default
Value: |
Specifies how many outstanding reads to buffer
are on the kernel AXI interface. Values are 1 through 256. Applies to:
|
compiler.interfaceWrOutstanding
|
Type: Int Range Default
Value: |
Specifies how many outstanding writes to buffer
are on the kernel AXI interface. Values are 1 through 256. Applies to:
|
compiler.maxComputeUnits
|
Type: Int Default Value:
|
Maximum compute units allowed in the system.
The default is 60 compute units, or is specified in the hardware
platform (.xsa) with the
numComputeUnits property. The specified value overrides the default value or the hardware platform. The default value of -1 preserves the default. Applies to
|
compiler.skipTimingCheckAndFrequencyScaling
|
Type: Boolean Default Value: FALSE |
This parameter causes the Vivado tool to skip the timing
check and optional clock frequency scaling that occurs after the
last step of implementation process, which is either route_design or post-route phys_opt_design.Applies to:
|
compiler.userPreCreateProjectTcl
|
Type: String Default Value:
|
Specifies a Tcl script to run before creating
the Vivado project in the
Vitis build process. Applies to:
|
compiler.userPreSysLinkOverlayTcl
|
Type: String Default Value:
|
Specifies a Tcl script to run after opening the
Vivado IP integrator block
design, before running the compiler-generated dr.bd.tcl script in the Vitis build process. Applies to:
|
compiler.userPostSysLinkOverlayTcl
|
Type: String Default Value:
|
Specifies a Tcl script to run after running the
compiler-generated dr.bd.tcl
script. Applies to:
|
compiler.userPostDebugProfileOverlayTcl
|
Type: String Default Value:
|
Specifies a Tcl script to run after debug
profile overlay insertion in Vivado IP integrator block design in the vpl.update_bd step. Applies to:
|
compiler.worstNegativeSlack
|
Type: Float Default Value: 0 |
During timing analysis check, this specifies
the worst acceptable negative slack for the design, specified in
nanoseconds (ns). When negative slack exceeds the specified value,
the tool might try to scale the clock frequency to achieve timing
results. This specifies an acceptable negative slack value instead
of zero slack. Applies to:
|
compiler.xclDataflowFifoDepth
|
Type: Int Default Value:
|
Specifies the depth of FIFOs used in kernel
data flow region. Applies to:
|
hw_emu.aie_shim_sol_path
|
Type: String Default Value:
|
For use by Versal platforms, this option specifies the path to
the AI Engine SHIM Solution
constraints file which is generated by the aiecompiler. Used during simulation, compilation, and elaboration, the file provides a logical mapping to the physical interface. This is needed for third-party simulators like Mentor Graphics Questa Advanced Simulator or Cadence Xcelium Logic Simulation. |
hw_emu.compiledLibs
|
Type: String Default Value:
|
Uses mentioned clibs for the specified simulator.Applies to Hardware Emulation and Debug. |
hw_emu.debugMode
|
wdb Default Value: |
The default value is WDB and runs simulation in
waveform mode. This option only works in
combination with the Applies to Hardware Emulation and Debug. |
hw_emu.enableProtocolChecker
|
Type: Boolean Default Value: FALSE |
Enables the lightweight AXI protocol checker
(lapc) during HW emulation. This is used to confirm the accuracy of
any AXI interfaces in the design. Applies to Hardware Emulation and Debug. |
hw_emu.json_device_file_path
|
Type: String Default Value:
|
For use by Versal platforms, this option specifies the path to
the AI Engine JSON Device file
located in the Vitis software
installation area. Used during simulation, compilation, and elaboration, the file specifies the size of the AI Engine array. This is needed for third-party simulators like Mentor Graphics Questa Advanced Simulator or Cadence Xcelium Logic Simulation. |
hw_emu.platformPath
|
Type: String Default Value:
|
Specifies the path to the custom platform
directory. The <platformPath> directory should meet the
following requirements to be used in platform creation:
Applies to Hardware Emulation and Debug. |
hw_emu.post_sim_settings
|
Type: String | Specifies the path to a Tcl script that is used
to configure the settings of the Vivado simulator prior to running hardware emulation.
This script is run after the default configuration of the tool, but
prior to launching simulation. You can use the Tcl script to
override specific settings, or to custom configure the simulator as
needed. Applies to Hardware Emulation and Debug. |
hw_emu.reduceHwEmuCompileTime
|
Type: Boolean Default Value: FALSE |
Move the generation of the top-level block
design into the Generate Targets step of v++ --link.Applies to Hardware Emulation and Debug. |
hw_emu.scDebugLevel
|
none | waveform | log | waveform_and_log Default Value: waveform_and_log |
Sets the TLM transaction debug level of the
Vivado logic simulator
(xsim).
Applies to Hardware Emulation and Debug. |
hw_emu.simulator
|
XSIM | QUESTA Default Value: XSIM |
Uses the specified simulator for the hardware
emulation run. Applies to Hardware Emulation and Debug. |
--advanced.param compiler.addOutputTypes="hw_export"[advanced] section
head using the following
format:[advanced]
param=compiler.addOutputTypes="hw_export"
--advanced.prop
--advanced.prop <arg>Specifies advanced kernel or solution properties for kernel
compilation where <arg> is one of the
values described in the table below.
| Property Name | Valid Values | Description |
|---|---|---|
kernel.<kernel_name>.kernel_flags
|
Type: String Default Value:
|
Sets specific compile flags on the kernel
<kernel_name>. |
solution.device_repo_path
|
Type: String Default Value:
|
Specifies the path to a repository of hardware
platforms. The --platform option
with full path to the .xpfm
platform file should be used instead. |
solution.kernel_compiler_margin
|
Type: Float Default Value: 12.5% of the kernel clock period. |
The clock margin (in ns) for the kernel. This value is subtracted from the kernel clock period prior to synthesis to provide some margin for place and route delays. |
--advanced.misc
--advanced.misc <arg>Specifies advanced tool directives for kernel compilation.