You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/src/quickstart/index.rst
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -2,22 +2,22 @@
2
2
VTR Quick Start
3
3
###############
4
4
5
-
This is a quick introduction to VTR which covers how to run VTR and some if its associated tools (:ref:`VPR`, :ref:`odin_ii`, :ref:`ABC`).
5
+
This is a quick introduction to VTR which covers how to run VTR and some of its associated tools (:ref:`VPR`, :ref:`odin_ii`, :ref:`ABC`).
6
6
7
7
Setting Up VTR
8
8
==============
9
9
10
10
Download VTR
11
11
------------
12
12
13
-
The first step is to `download VTR <https://verilogtorouting.org/download/>`_ and extract VTR on your local machine.
13
+
The first step is to `download VTR <https://verilogtorouting.org/download/>`_ and extract it on your local machine.
14
14
15
15
.. note:: Developers planning to modify VTR should clone the `VTR git repository <https://github.com/verilog-to-routing/vtr-verilog-to-routing/>`_.
16
16
17
17
18
18
Environment Setup
19
19
-----------------
20
-
If you cloned the repository you will need to set up the git submodules (if you downloaded and extracted a release, you can skip this step):
20
+
If you cloned the repository, you will need to set up the git submodules (if you downloaded and extracted a release, you can skip this step):
21
21
22
22
.. code-block:: bash
23
23
@@ -77,12 +77,12 @@ For more details on building VTR on various operating systems/platforms see :doc
77
77
Running VPR
78
78
===========
79
79
80
-
Lets now try taking a simple pre-synthesized circuit (consisting of LUTs and Flip-Flops) and use the VPR tool to implement it on a specific FPGA architecture.
80
+
Let's now try taking a simple pre-synthesized circuit (consisting of LUTs and Flip-Flops) and use the VPR tool to implement it on a specific FPGA architecture.
81
81
82
82
Running VPR on a Pre-Synthesized Circuit
83
83
----------------------------------------
84
84
85
-
First, lets make a directory in our home directory where we can work:
85
+
First, let's make a directory in our home directory where we can work:
86
86
87
87
.. code-block:: bash
88
88
@@ -211,13 +211,13 @@ Running the VTR Flow
211
211
In the previous section we have implemented a pre-synthesized circuit onto a pre-existing FPGA architecture using VPR, and visualized the result.
212
212
We now turn to how we can implement *our own circuit* on a pre-existing FPGA architecture.
213
213
214
-
To do this we begin by describing a circuit behaviourly using the Verilog Hardware Description Language (HDL).
214
+
To do this, we begin by describing a circuit behaviourally using the Verilog Hardware Description Language (HDL).
215
215
This allows us to quickly and consisely define the circuit's behaviour.
216
216
We will then use the VTR Flow to synthesize the behavioural Verilog description it into a circuit netlist, and implement it onto an FPGA.
217
217
218
218
Example Circuit
219
219
---------------
220
-
We will use the following simple example circuit, which causes it's output to toggle on and off:
220
+
We will use the following simple example circuit, which causes its output to toggle on and off:
221
221
222
222
.. literalinclude:: blink.v
223
223
:language: verilog
@@ -230,7 +230,7 @@ If the count is below ``16`` it drives the output (``o_led``) high, otherwise it
230
230
231
231
Manually Running the VTR Flow
232
232
-----------------------------
233
-
Lets start by making a fresh directory for us to work in:
233
+
Let's start by making a fresh directory for us to work in:
234
234
235
235
.. code-block:: bash
236
236
@@ -241,15 +241,15 @@ Next we need to run the three main sets of tools:
241
241
242
242
* :ref:`odin_ii` performs 'synthesis' which converts our behavioural Verilog (``.v`` file) into a circuit netlist (``.blif`` file) consisting of logic equations and FPGA architecture primitives (Flip-Flops, adders etc.),
243
243
* :ref:`ABC` performs 'logic optimization' which simplifies the circuit logic, and 'technology mapping' which converts logic equations into the Look-Up-Tables (LUTs) available on an FPGA, and
244
-
* :ref:`VPR` which performs packing, placement and routing of the circuit to implement it on the targetted FPGA architecture.
244
+
* :ref:`VPR` which performs packing, placement and routing of the circuit to implement it on the targeted FPGA architecture.
245
245
246
246
.. _synthesizing_with_odin_ii:
247
247
Synthesizing with ODIN II
248
248
~~~~~~~~~~~~~~~~~~~~~~~~~
249
249
250
250
First we'll run ODIN II on our Verilog file to synthesize it into a circuit netlist, providing the options:
251
251
252
-
* ``-a $VTR_ROOT/vtr_flow/arch/timing/EArch.xml`` which specifies what FPGA architecture we are targetting,
252
+
* ``-a $VTR_ROOT/vtr_flow/arch/timing/EArch.xml`` which specifies what FPGA architecture we are targeting,
253
253
* ``-V $VTR_ROOT/doc/src/quickstart/blink.v`` which specifies the verilog file we want to synthesize, and
254
254
* ``-o blink.odin.blif`` which specifies the name of the generated ``.blif`` circuit netlist.
255
255
@@ -400,7 +400,7 @@ Automatically Running the VTR Flow
400
400
Running each stage of the flow manually is time consuming (and potentially error prone).
401
401
For convenience, VTR provides a script (:ref:`run_vtr_flow`) which automates this process.
402
402
403
-
First, make sure you sure you have activated the Python virtual environment created at the beginning of this tutorial:
403
+
First, make sure you have activated the Python virtual environment created at the beginning of this tutorial:
0 commit comments