From 8ffb44800976fa5d720b154da0f766f965d6a943 Mon Sep 17 00:00:00 2001 From: Michael Ren Date: Thu, 13 Oct 2022 01:43:08 -0700 Subject: [PATCH] Add run-binary-debug option to waveform docs --- docs/Simulation/Software-RTL-Simulation.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/Simulation/Software-RTL-Simulation.rst b/docs/Simulation/Software-RTL-Simulation.rst index d952c62c..fd26f465 100644 --- a/docs/Simulation/Software-RTL-Simulation.rst +++ b/docs/Simulation/Software-RTL-Simulation.rst @@ -176,6 +176,12 @@ Generating Waveforms If you would like to extract waveforms from the simulation, run the command ``make debug`` instead of just ``make``. +A special target that automatically generates the waveform file for a specific test is also available. + +.. code-block:: shell + + make run-binary-debug BINARY=test.riscv + For a Verilator simulation, this will generate a vcd file (vcd is a standard waveform representation file format) that can be loaded to any common waveform viewer. An open-source vcd-capable waveform viewer is `GTKWave `__.