Address PR comments for FireSim docs

This commit is contained in:
David Biancolin
2019-07-16 07:43:27 -07:00
parent 9f83b3a3d2
commit 870c7d53d3
3 changed files with 12 additions and 19 deletions

View File

@@ -8,29 +8,26 @@ FireSim
FireSim allows RTL-level simulation at orders-of-magnitude faster speeds than software RTL simulators.
FireSim also provides additional device models to allow full-system simulation, including memory models and network models.
FireSim currently supports running only on Amazon EC2 F1 FPGA-enabled virtual instances on the public cloud.
FireSim currently supports running only on Amazon EC2 F1 FPGA-enabled virtual instances.
In order to simulate your Chipyard design using FireSim, if you have not
already, follow the initial EC2 setup instructions as detailed in the `FireSim
documentation <http://docs.fires.im/en/latest/Initial-Setup/index.html>`__.
Then clone your full Chipyard repository onto your Amazon EC2 FireSim manager
Then clone Chipyard onto your FireSim manager
instance, and setup your Chipyard repository as you would normally.
When you are ready to use FireSim, initalize it as library in Chipyard by running:
Next, initalize FireSim as library in Chipyard by running:
.. code-block:: shell
# At the root of your chipyard repo
./scripts/firesim-setup.sh --fast
``firesim-setup.sh`` initializes additional submodules and then invokes
firesim's ``build-setup.sh`` script. ``firesim-setup.sh`` accepts all of the same arguments and
passes them through to ``build-setup.sh``, adding ``--library`` to properly
firesim's ``build-setup.sh`` script adding ``--library`` to properly
initialize FireSim as a library submodule in chipyard. You may run
``./sims/firesim/build-setup.sh --help`` to see more options.
In order to build bitstreams, run simulations, or to generate MIDAS-transformed RTL for your
simulator, you'll need to source one of the following three environments:
Finally, source the following environment at the root of the firesim directory:
.. code-block:: shell
@@ -38,21 +35,17 @@ simulator, you'll need to source one of the following three environments:
# (Recommended) The default manager environment (includes env.sh)
source sourceme-f1-manager.sh
# OR A minimal environment to run recipes out of sim/ (to invoke MIDAS; run MIDAS-level RTL simulation)generate RTL; transform At the root of your chipyard repo
source env.sh
# OR A complete environment to run local FPGA builds with Vivado
source sourceme-f1-full.sh
`Every time you want to use FireSim with a fresh shell, you must source this sourceme.sh`
At this point you're ready to use FireSim with Chipyard. If you're not already
familiar with FireSim, please refer to the `FireSim Docs <http://docs.fires.im/>`__, and proceed
through the rest of the tutorial.
familiar with FireSim, please return to the `FireSim Docs
<https://docs.fires.im/en/latest/Initial-Setup/Setting-up-your-Manager-Instance.html#completing-setup-using-the-manager>`__,
and proceed with the rest of the tutorial.
Current Limitations:
++++++++++++++++++++
FireSim integration in chipyard is still a work in progress. Presently, you
FireSim integration in Chipyard is still a work in progress. Presently, you
cannot build a FireSim simulator from any generator project in Chipyard except ``firechip``,
which properly invokes MIDAS on the target RTL.

View File

@@ -9,12 +9,12 @@ Chipyard supports two classes of simulation:
Software RTL simulators of Chipyard designs run at O(1 KHz), but compile
quickly and provide full waveforms. Conversly, FPGA-accelerated simulators run
at O(100 MHz), making them appropriate for booting an operating system and
running a complete workload, but have long compile time and poorer debug
running a complete workload, but have multi-hour compile times and poorer debug
visability.
.. toctree::
:maxdepth: 2
:caption: Simulators:
SW-RTL-Simulators
Software-RTL-Simulators
FPGA-Accelerated-Simulators