diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 00000000..e35d8850 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +_build diff --git a/docs/Quick-Start.rst b/docs/Quick-Start.rst index 0c76f369..570b841f 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's environment variables and put the newly built toolchain on your path: + +.. code-block:: shell + + source ./env.sh What's Next? ------------------------------------------- diff --git a/docs/Tools/Treadle.rst b/docs/Tools/Treadle.rst index 19df75de..4c6d016c 100644 --- a/docs/Tools/Treadle.rst +++ b/docs/Tools/Treadle.rst @@ -1,5 +1,9 @@ -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). +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. diff --git a/generators/example/src/main/scala/RocketConfigs.scala b/generators/example/src/main/scala/RocketConfigs.scala index a50ad4a7..db3f7c2c 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 ++