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

Merge pull request #254 from mehnadnerd/docs-generators-change

Browse Source 
[docs] [ci skip] Update generators and quick start so it is clear how…
This commit is contained in:
Abraham Gonzalez
2019-09-25 20:04:03 -07:00
committed by GitHub
parent 7420841f24 5c553309f0
commit 0241a324b6
2 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/Generators/index.rst
View File

@@ -1,12 +1,19 @@
.. _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 the build system will cache results if they have not changed),
so changes to the generators themselves will automatically be used when building with Chipyard and propagate to software simulation, FPGA-accelerated simulation, and VLSI flows.
.. 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.
* If you intend to build one of the vanilla Chipyard examples, go to :ref:`build-a-chip` and follow the instructions. * If you intend to build one of the vanilla Chipyard examples, go to :ref:`build-a-chip` and follow the instructions.
* If you intend to run a VLSI flow using one of the vanilla Chipyard examples, go to <> and follow the instructions. * If you intend to run a VLSI flow using one of the vanilla Chipyard examples, go to <> and follow the instructions.
* If you intend to change the generators (BOOM, Rocket, etc) themselves, see :ref:`generator-index`.