Merge pull request #47 from riscv/debug-0.13

[riscv-tests.git] / debug / README.md

diff --git a/debug/README.md b/debug/README.md
index 829a285deb0ec7430164d4791423f559b95af046..04aa13a969d7304bc1d0d968063c61bf5f65a051 100644 (file)
--- a/debug/README.md
+++ b/debug/README.md
@@ -2,9 +2,9 @@ Debug Tests
 ===========
 
 Debugging requires many system components to all work together. The tests here
-perform an end-to-end test, communicating only with gdb. If a simulator or
-hardware passes all these tests, then you can be pretty confident that the
-actual debug interface is functioning correctly.
+perform an end-to-end test, communicating with gdb and OpenOCD.
+If a simulator or hardware passes all these tests, then you can be pretty
+confident that the actual debug interface is functioning correctly.
 
 Targets
 =======
@@ -12,23 +12,30 @@ Targets
 64-bit Spike
 ------------
 
-`./gdbserver.py --spike --cmd $RISCV/bin/spike`
+`./gdbserver.py --spike64 --cmd $RISCV/bin/spike`
 
 32-bit Spike
 ------------
 
 `./gdbserver.py --spike32 --cmd $RISCV/bin/spike`
 
-32-bit SiFive Core on Microsemi FPGA board
-------------------------------------------
+32-bit SiFive Core on Supported FPGA Boards &  Hardware
+-------------------------------------
 
-`./gdbserver.py --m2gl_m2s`
+`./gdbserver.py --freedom-e300`
+`./gdbserver.py --hifive1`
+
+
+32-bit rocket-chip core in Simulation
+-------------------------------------
+
+`./gdbserver.py --freedom-e300-sim`
 
 Debug Tips
 ==========
 
 You can run just a single test by specifying <class>.<function> on the command
-line, eg: `./gdbserver.py --spike --cmd $RISCV/bin/spike
+line, eg: `./gdbserver.py --spike64 --cmd $RISCV/bin/spike
 SimpleRegisterTest.test_s0`.
 Once that test has failed, you can look at gdb.log and (in this case) spike.log
 to get an idea of what might have gone wrong.
@@ -36,3 +43,6 @@ to get an idea of what might have gone wrong.
 You can see what spike is doing by add `-l` to the spike command, eg.:
 `./gdbserver.py --spike32 --cmd "$RISCV/bin/spike -l"
 DebugTest.test_breakpoint`. (Then look at spike.log.)
+
+You can run gdb under valgrind by passing --gdb, eg.: `./gdbserver.py --spike64
+--gdb "valgrind riscv64-unknown-elf-gdb" -- -v DownloadTest`.