Enable Waveform Debugging with the Vitis Compiler Command - 2023.2 English - UG1393

Vitis Unified Software Platform Documentation: Application Acceleration Development (UG1393)
Document ID
UG1393
Release Date
2023-12-13
Version
2023.2 English
The waveform debugging process can be enabled through the v++ command using the following steps:
  1. Compile and Link the host code and System project for debugging by adding the -g option to the g++ command line as described in Building and Running the System.
  2. Create an xrt.ini file in the same directory as the host executable, as described in xrt.ini File, with the following contents: 
    [Emulation]
debug_mode=batch
    Tip: Use debug_mode=gui to run the Vivado simulator in GUI mode and enable displaying the waveform for interactive use, as described in Running Live Waveform Mode. This is especially useful when debugging a hw_emu hang issue, because you can interrupt the simulation process in the simulator and observe the waveform up to that time.

  3. Launch the hardware emulation using the launch_hw_emu.sh script that is generated during the v++ --package process.

    This script will launch the Vivado simulator and enable batch simulation to capture the simulation waveform database. The waveform database is written to a .wdb that can be opened in the Analysis view of the Vitis unified IDE as described in Working with the Analysis View (Vitis Analyzer).