diff --git a/docs/Generators/index.rst b/docs/Generators/index.rst index a01b5adc..8bd17024 100644 --- a/docs/Generators/index.rst +++ b/docs/Generators/index.rst @@ -1,12 +1,18 @@ +.. _generator-index: + Generators ============================ -Generator can be thought of as a generalized RTL design, written using a mix of meta-programming and standard RTL. +A Generator can be thought of as a generalized RTL design, written using a mix of meta-programming and standard RTL. This type of meta-programming is enabled by the Chisel hardware description language (see :ref:`Chisel`). A standard RTL design is essentially just a single instance of a design coming from a generator. However, by using meta-programming and parameter systems, generators can allow for integration of complex hardware designs in automated ways. The following pages introduce the generators integrated with the Chipyard framework. +Chipyard bundles the source code for the generators, under the ``generators`` directory. +It builds them from source each time (although ``sbt`` will cache results if they have not changed), +so changes to the generators themselves will automatically be used when building with Chipyard. + .. toctree:: :maxdepth: 2 :caption: Generators: diff --git a/docs/Quick-Start.rst b/docs/Quick-Start.rst index 86d62b11..8d45e436 100644 --- a/docs/Quick-Start.rst +++ b/docs/Quick-Start.rst @@ -52,3 +52,5 @@ This depends on what you are planning to do with Chipyard. * To run a FPGA-accelerated simulation using FireSim, see :ref:`firesim-sim-intro`. * To run a VLSI flow using one of the vanilla Chipyard examples, see <>. + +* To change the generators (BOOM, Rocket, &c) themselves, see :ref:`generator-index`.