riscv
/
OpenFPGA
mirror of https://github.com/lnis-uofu/OpenFPGA.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

update tutorial about architecture to synchronize with latest file organization

This commit is contained in:
tangxifan 2020-06-24 10:51:26 -06:00
parent 161d1474c1
commit db5397fa75
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/source/tutorials/arch_modeling/quick_start.rst
View File

@ -4,8 +4,9 @@ A Quick Start
------------- -------------
In this tutorial, we will consider a simple but representative FPGA architecture to show you how to In this tutorial, we will consider a simple but representative FPGA architecture to show you how to
- Adapt the VPR architecture XML file to OpenFPGA acceptable format - Adapt a VPR architecture XML file to OpenFPGA acceptable format
- Create the OpenFPGA architecture XMl file to customize the primitive circuits - Create an OpenFPGA architecture XML file to customize the primitive circuits
- Create a simulation setting XML file to specify the simulation settings
Through this quick example, we will introduce the key steps to build your own FPGA based on a VPR architecture template. Through this quick example, we will introduce the key steps to build your own FPGA based on a VPR architecture template.
@ -128,6 +129,7 @@ Craft OpenFPGA Architecture
OpenFPGA needs another XML file which contains detailed modeling on the physical design of FPGA architecture. OpenFPGA needs another XML file which contains detailed modeling on the physical design of FPGA architecture.
This is designed to minimize the modification on the original VPR architecture file, so that it can be reused. This is designed to minimize the modification on the original VPR architecture file, so that it can be reused.
You may create an XML file `k4_n4_openfpga_arch.xml` and then add contents shown as follows.
Overview on the Structure Overview on the Structure
^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^
@ -136,7 +138,6 @@ An OpenFPGA architecture including the following parts.
- Architecture modeling with a focus on circuit-level description - Architecture modeling with a focus on circuit-level description
- Configuration protocol definition - Configuration protocol definition
- Annotation on the VPR architecture modules - Annotation on the VPR architecture modules
- Simulation settings
These parts are organized as follows in the XML file. These parts are organized as follows in the XML file.
@ -173,10 +174,6 @@ These parts are organized as follows in the XML file.
</pb_type_annotations> </pb_type_annotations>
</openfpga_architecture> </openfpga_architecture>
<openfpga_simulation_setting>
...
</openfpga_simulation_setting>
Technology Library Definition Technology Library Definition
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Technology information are all stored under the ``<technology_library>`` node, which contains transistor-level information to build the FPGA. Technology information are all stored under the ``<technology_library>`` node, which contains transistor-level information to build the FPGA.
@ -474,10 +471,13 @@ The complete annotation is shown as follows:
See details in :ref:`annotate_vpr_arch`. See details in :ref:`annotate_vpr_arch`.
Simulation Settings Simulation Settings
^^^^^^^^^^^^^^^^^^^ ~~~~~~~~~~~~~~~~~~~
OpenFPGA needs an XML file where detailed simulation settings are defined.
The simulation settings contain critical parameters to build testbenches for verify the FPGA fabric. The simulation settings contain critical parameters to build testbenches for verify the FPGA fabric.
You may create an XML file `k4_n4_openfpga_simulation.xml` and then add contents shown as follows.
The complete annotation is shown as follows: The complete annotation is shown as follows:
.. code-block:: xml .. code-block:: xml