From f61410c95793a74a3efda631ace0399ecc59cb97 Mon Sep 17 00:00:00 2001 From: Abraham Gonzalez Date: Tue, 5 Oct 2021 21:54:13 -0700 Subject: [PATCH 1/3] Update docs --- docs/Advanced-Concepts/Debugging-RTL.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Advanced-Concepts/Debugging-RTL.rst b/docs/Advanced-Concepts/Debugging-RTL.rst index 6831cc4a..678ab33a 100644 --- a/docs/Advanced-Concepts/Debugging-RTL.rst +++ b/docs/Advanced-Concepts/Debugging-RTL.rst @@ -22,8 +22,8 @@ make target. For example: make CONFIG=CustomConfig debug -The ``run-binary-debug`` rule will also automatically build a simulator, -run it on a custom binary, and generate a waveform. For example, to run a +The ``run-binary-debug`` rule uses the prebuilt simulator to run a custom binary +and generate a waveform. For example, to run a test on ``helloworld.riscv``, use .. code-block:: shell From c0a60f50f974ff774b19a74b2a0d013c151a827f Mon Sep 17 00:00:00 2001 From: Abraham Gonzalez Date: Tue, 5 Oct 2021 21:54:52 -0700 Subject: [PATCH 2/3] Update docs --- docs/Customization/MMIO-Peripherals.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/Customization/MMIO-Peripherals.rst b/docs/Customization/MMIO-Peripherals.rst index 15ed5a00..bffe6f26 100644 --- a/docs/Customization/MMIO-Peripherals.rst +++ b/docs/Customization/MMIO-Peripherals.rst @@ -137,6 +137,7 @@ Now with all of that done, we can go ahead and run our simulation. .. code-block:: shell cd sims/verilator + make CONFIG=GCDTLRocketConfig make CONFIG=GCDTLRocketConfig BINARY=../../tests/gcd.riscv run-binary From e9642f5eba8fd6847aa34dd328f11d5b4e3bdfb3 Mon Sep 17 00:00:00 2001 From: Abraham Gonzalez Date: Tue, 5 Oct 2021 21:55:21 -0700 Subject: [PATCH 3/3] Update docs --- docs/Customization/Dsptools-Blocks.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/Customization/Dsptools-Blocks.rst b/docs/Customization/Dsptools-Blocks.rst index bdf68fc1..52109a75 100644 --- a/docs/Customization/Dsptools-Blocks.rst +++ b/docs/Customization/Dsptools-Blocks.rst @@ -120,6 +120,7 @@ Now we can run our simulation. .. code-block:: shell cd sims/verilator + make CONFIG=StreamingFIRRocketConfig make CONFIG=StreamingFIRRocketConfig BINARY=../../tests/streaming-fir.riscv run-binary .. [#] ``ReadQueue`` and ``WriteQueue`` are good illustrations of how to write a ``DspBlock`` and how they can be integrated into rocket, but in a real design a DMA engine would be preferred. ``ReadQueue`` will stall the processor if you try to read an empty queue, and ``WriteQueue`` will stall if you try to write to a full queue, which a DMA engine can more elegantly avoid. Furthermore, a DMA engine can do the work of moving data, freeing the processor to do other useful work (or sleep).