github-mirrors/vortex
1
0
Fork 0
mirror of https://github.com/vortexgpgpu/vortex.git synced 2025-04-24 05:47:35 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc update

Browse source
This commit is contained in:
Blaise Tine 2021-06-29 09:00:00 -07:00
parent eca20a5283
commit e0812ebcc2
1 changed files with 10 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

14
doc/debugging.md
View file

@ -5,7 +5,7 @@
SimX cycle-approximate simulator allows faster debugging of Vortex kernels' execution.
The recommended method to enable debugging is to pass the `--debug` flag to `blackbox` tool when running a program.
// Running demo program using SimX in debug mode
// Running demo program on SimX in debug mode
$ ./ci/blackbox.sh --driver=simx --app=demo --debug
A debug trace `run.log` is generated in the current directory during the program execution. The trace includes important states of the simulated processor (decoded instruction, register states, pipeline states, etc..). You can increase the verbosity level of the trace by changing the `DEBUG_LEVEL` variable to a value [1-5] (default is 3).
@ -19,10 +19,10 @@ To debug the processor RTL, you need to use VLSIM or RTLSIM driver. VLSIM simula
The recommended method to enable debugging is to pass the `--debug` flag to `blackbox` tool when running a program.
// Running demo program using vlsim in debug mode
// Running demo program on vlsim in debug mode
$ ./ci/blackbox.sh --driver=vlsim --app=demo --debug
// Running demo program using rtlsim in debug mode
// Running demo program on rtlsim in debug mode
$ ./ci/blackbox.sh --driver=rtlsim --app=demo --debug
A debug trace `run.log` is generated in the current directory during the program execution. The trace includes important states of the simulated processor (memory, caches, pipeline, stalls, etc..). A waveform trace `trace.vcd` is also generated in the current directory during the program execution. You can visualize the waveform trace using any tool that can open VCD files (Modelsim, Quartus, Vivado, etc..). [GTKwave] (http://gtkwave.sourceforge.net) is a great open-source scope analyzer that also works with VCD files.
@ -34,4 +34,10 @@ Debugging the FPGA directly may be necessary to investigate runtime bugs that th
& cd /hw/syn/opae
$ CONFIGS=-DSCOPE=1 make fpga-4c
When running the program on the FPGA, you need to pass the `--scope` flag to the `blackbox` tool. A waveform trace `trace.vcd` will be generated in the current directory during the program execution
When running the program on the FPGA, you need to pass the `--scope` flag to the `blackbox` tool.
// Running demo program on FPGA with scope enabled
$ ./ci/blackbox.sh --driver=fpga --app=demo --scope
A waveform trace `trace.vcd` will be generated in the current directory during the program execution. This trace includes a limited set of signals that are defined in `/hw/scripts/scope.json`. You can expand your signals' selection by updating the json file.