From af3cb7cf1991cb940c75d14c23b96e6cf0b45dab Mon Sep 17 00:00:00 2001 From: Paul Rigge Date: Fri, 2 Aug 2019 23:21:59 -0700 Subject: [PATCH] Add some documentation for dsptools et al --- docs/Tools/Chisel-Testers.rst | 6 ++++++ docs/Tools/Dsptools.rst | 15 +++++++++++++++ docs/Tools/Treadle.rst | 5 +++++ docs/Tools/index.rst | 3 +++ 4 files changed, 29 insertions(+) create mode 100644 docs/Tools/Chisel-Testers.rst create mode 100644 docs/Tools/Dsptools.rst create mode 100644 docs/Tools/Treadle.rst diff --git a/docs/Tools/Chisel-Testers.rst b/docs/Tools/Chisel-Testers.rst new file mode 100644 index 00000000..7a9ebf22 --- /dev/null +++ b/docs/Tools/Chisel-Testers.rst @@ -0,0 +1,6 @@ +Chisel Testers +============================== + +`Chisel testers `__ is a library for writing tests for Chisel designs. +It provides a Scala API for interacting with a DUT. +It can use multiple backends, including :ref:`Treadle` and Verilator. diff --git a/docs/Tools/Dsptools.rst b/docs/Tools/Dsptools.rst new file mode 100644 index 00000000..ed946b55 --- /dev/null +++ b/docs/Tools/Dsptools.rst @@ -0,0 +1,15 @@ +Dsptools +=============================== + +`Dsptools `__ is a Chisel library for writing custom signal processing hardware. +Additionally, dsptools is useful for integrating custom signal processing hardware into an SoC (especially a Rocket-based SoC). + +Some features: + +* Complex type +* Typeclasses for writing polymorphic hardware generators + * For example, write one FIR filter generator that works for real or complex inputs +* Extensions to Chisel testers for fixed point and floating point types +* A diplomatic implementation of AXI4-Stream +* Models for verifying APB, AXI-4, and TileLink interfaces with chisel-testers +* DSP building blocks diff --git a/docs/Tools/Treadle.rst b/docs/Tools/Treadle.rst new file mode 100644 index 00000000..19df75de --- /dev/null +++ b/docs/Tools/Treadle.rst @@ -0,0 +1,5 @@ +Treadle +============================== + +`Treadle `__ is a circuit simulator that directly executes FIRRTL. +It is especially useful for interactive debugging and small unit tests that benefit from a low-overhead simulator. diff --git a/docs/Tools/index.rst b/docs/Tools/index.rst index d73d4072..efe38e34 100644 --- a/docs/Tools/index.rst +++ b/docs/Tools/index.rst @@ -10,5 +10,8 @@ The following pages will introduce them, and how we can use them in order to gen Chisel FIRRTL + Treadle + Chisel-Testers + Dsptools Barstools