wu-arch/chipyard
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

[docs] [ci skip] Update generators and quick start so it is clear how to edit the generators to get changed outputs (You just edit the source)

Browse Source
This commit is contained in:
Brendan Sweeney
2019-09-25 13:45:21 -07:00
parent 62f5623225
commit a3a05ec988
2 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/Generators/index.rst
View File

@@ -1,12 +1,18 @@
.. _generator-index:
Generators 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`). 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. 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. 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. 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:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Generators: :caption: Generators:

2
docs/Quick-Start.rst
View File

@@ -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 FPGA-accelerated simulation using FireSim, see :ref:`firesim-sim-intro`.
* To run a VLSI flow using one of the vanilla Chipyard examples, see <>. * 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`.