From 857ce9dd9b19d8b308ff30eefd2a9b2aa2656eb9 Mon Sep 17 00:00:00 2001 From: David Biancolin Date: Sun, 8 Sep 2019 15:33:27 -0700 Subject: [PATCH 1/7] [docs] Tell users to source env.sh in quick start --- docs/Quick-Start.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/Quick-Start.rst b/docs/Quick-Start.rst index 936597e6..fac3f8ab 100644 --- a/docs/Quick-Start.rst +++ b/docs/Quick-Start.rst @@ -28,6 +28,11 @@ To build the toolchains, you should run: .. Note:: If you are planning to use the Hwacha vector unit, or other RoCC-based accelerators, you should build the esp-tools toolchains by adding the ``esp-tools`` argument to the script above. If you are running on an Amazon Web Services EC2 instance, intending to use FireSim, you can also use the ``--ec2fast`` flag for an expedited installation of a pre-compiled toolchain. +Finally, set up Chipyard environment varibles and put the newly built toolchain on your path: + +.. code-block:: shell + + source ./env.sh What's Next? ------------------------------------------- From d0b00d4ddf9a883c0d159e78e8d7c397bb714a9e Mon Sep 17 00:00:00 2001 From: David Biancolin Date: Sun, 8 Sep 2019 15:33:58 -0700 Subject: [PATCH 2/7] [docs] gitignore build files --- docs/.gitignore | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/.gitignore diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..e35d8850 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +_build From a0d009b8e4c9fbd5cca696dcfadd9c8bcf0429b5 Mon Sep 17 00:00:00 2001 From: David Biancolin Date: Sun, 8 Sep 2019 15:41:12 -0700 Subject: [PATCH 3/7] [docs] Make _What's Next_ more succinct --- docs/Quick-Start.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/Quick-Start.rst b/docs/Quick-Start.rst index fac3f8ab..fc022ca0 100644 --- a/docs/Quick-Start.rst +++ b/docs/Quick-Start.rst @@ -39,16 +39,16 @@ What's Next? This depends on what you are planning to do with Chipyard. -* If you want to learn about the structure of Chipyard, go to :ref:`chipyard-components`. +* To learn about the structure of Chipyard, see :ref:`chipyard-components`. -* If you intend to build one of the vanilla Chipyard examples, go to :ref:`build-a-chip` and follow the instructions. +* To build one of the vanilla Chipyard examples, see :ref:`build-a-chip`. -* If you intend to add a new accelerator, go to :ref:`adding-an-accelerator` and follow the instructions. +* To add a new accelerator, see :ref:`adding-an-accelerator`. -* If you intend to run a simulation of one of the vanilla Chipyard examples, go to :ref:`sw-rtl-sim-intro` and follow the instructions. +* To run a simulation of one of the Chipyard examples, see :ref:`sw-rtl-sim-intro`. -* If you intend to run a simulation of a custom Chipyard SoC Configuration, go to <> and follow the instructions. +* To run a simulation of a custom Chipyard SoC Configuration, see <>. -* If you intend to run a full-system FireSim simulation, go to :ref:`firesim-sim-intro` and follow the instructions. +* To run a FPGA-accelerated simulation using FireSim, see :ref:`firesim-sim-intro`. -* If you intend to run a VLSI flow using one of the vanilla Chipyard examples, go to <> and follow the instructions. +* To run a VLSI flow using one of the vanilla Chipyard examples, see <>. From 2cba47b6972dd9e2713744c8d469346e55f44fa1 Mon Sep 17 00:00:00 2001 From: David Biancolin Date: Sun, 8 Sep 2019 21:37:02 -0700 Subject: [PATCH 4/7] [docs] A couple spelling fixes in Quick Start [skip ci] --- docs/Quick-Start.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Quick-Start.rst b/docs/Quick-Start.rst index fc022ca0..86d62b11 100644 --- a/docs/Quick-Start.rst +++ b/docs/Quick-Start.rst @@ -28,7 +28,7 @@ To build the toolchains, you should run: .. Note:: If you are planning to use the Hwacha vector unit, or other RoCC-based accelerators, you should build the esp-tools toolchains by adding the ``esp-tools`` argument to the script above. If you are running on an Amazon Web Services EC2 instance, intending to use FireSim, you can also use the ``--ec2fast`` flag for an expedited installation of a pre-compiled toolchain. -Finally, set up Chipyard environment varibles and put the newly built toolchain on your path: +Finally, set up Chipyard's environment variables and put the newly built toolchain on your path: .. code-block:: shell From fc0e86d74417d73e713a7846b381d7464ddf8f4f Mon Sep 17 00:00:00 2001 From: Albert Magyar Date: Wed, 25 Sep 2019 13:37:59 -0700 Subject: [PATCH 5/7] Fix typo in tutorial config --- generators/example/src/main/scala/RocketConfigs.scala | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/generators/example/src/main/scala/RocketConfigs.scala b/generators/example/src/main/scala/RocketConfigs.scala index 2275549f..dcd2d01c 100644 --- a/generators/example/src/main/scala/RocketConfigs.scala +++ b/generators/example/src/main/scala/RocketConfigs.scala @@ -50,7 +50,7 @@ class PWMRocketConfig extends Config( new freechips.rocketchip.system.BaseConfig) // DOC include end: PWMRocketConfig -class PWMRAXI4ocketConfig extends Config( +class PWMAXI4RocketConfig extends Config( new WithPWMAXI4Top ++ // use top with axi4-controlled PWM new WithBootROM ++ new freechips.rocketchip.subsystem.WithInclusiveCache ++ From 38fef1782f48f8870c27594431294990ca792a5f Mon Sep 17 00:00:00 2001 From: abejgonzalez Date: Wed, 25 Sep 2019 13:50:22 -0700 Subject: [PATCH 6/7] add firrtl interpreter to the docs [ci skip] --- docs/Tools/Treadle.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/Tools/Treadle.rst b/docs/Tools/Treadle.rst index 19df75de..9e3d6154 100644 --- a/docs/Tools/Treadle.rst +++ b/docs/Tools/Treadle.rst @@ -1,5 +1,7 @@ -Treadle +Treadle and FIRRTL Interpreter ============================== -`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. +`Treadle `__ and `FIRRTL Interpreter `__ +are circuit simulators that directly execute FIRRTL (specifically low-firrtl IR). +They are especially useful for interactive debugging and many of projects within Chipyard +use them for a low-overhead simulator. From beae2cfcf9de642a1d8ed58254c6157f41855780 Mon Sep 17 00:00:00 2001 From: abejgonzalez Date: Wed, 25 Sep 2019 16:38:09 -0700 Subject: [PATCH 7/7] emphasize that firrtl-interpreter is deprecated | mention smaller modules [ci skip] --- docs/Tools/Treadle.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/Tools/Treadle.rst b/docs/Tools/Treadle.rst index 9e3d6154..4c6d016c 100644 --- a/docs/Tools/Treadle.rst +++ b/docs/Tools/Treadle.rst @@ -1,7 +1,9 @@ Treadle and FIRRTL Interpreter ============================== -`Treadle `__ and `FIRRTL Interpreter `__ +`Treadle `__ and +`FIRRTL Interpreter `__ are circuit simulators that directly execute FIRRTL (specifically low-firrtl IR). -They are especially useful for interactive debugging and many of projects within Chipyard -use them for a low-overhead simulator. +Treadle is the replacement for FIRRTL Interpreter but FIRRTL Interpreter is still used within some +projects. Treadle is useful for simulating modules in a larger SoC design. Many projects +use Treadle for interactive debugging and a low-overhead simulator.