Skip to content

Commit 8fa98f6

Browse files
committedFeb 29, 2016
doc: use term 'gateware'
FPGA newcomers are not used to the term 'bitstream'. To insist that this file is the result of the gateware compilation and thus the binary FPGA format, add the term 'gateware' as a prefix.
1 parent 6dd1eb2 commit 8fa98f6

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed
 

‎doc/manual/installing.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,11 @@ Preparing the core device FPGA board
9393

9494
You now need to flash 3 things on the FPGA board:
9595

96-
1. The FPGA bitstream
96+
1. The FPGA gateware bitstream
9797
2. The BIOS
9898
3. The ARTIQ runtime
9999

100-
They are all shipped in our Conda packages, along with the required flash proxy bitstreams.
100+
They are all shipped in our Conda packages, along with the required flash proxy gateware bitstreams.
101101

102102
First you need to install OpenOCD. Then, you can flash the board:
103103

@@ -169,11 +169,11 @@ and the ARTIQ kernels.
169169
Preparing the core device FPGA board
170170
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
171171

172-
These steps are required to generate bitstream (``.bit``) files, build the MiSoC BIOS and ARTIQ runtime, and flash FPGA boards. If the board is already flashed, you may skip those steps and go directly to `Installing the host-side software`.
172+
These steps are required to generate gateware bitstream (``.bit``) files, build the MiSoC BIOS and ARTIQ runtime, and flash FPGA boards. If the board is already flashed, you may skip those steps and go directly to `Installing the host-side software`.
173173

174174
* Install the FPGA vendor tools (e.g. Xilinx ISE and/or Vivado):
175175

176-
* Get Xilinx tools from http://www.xilinx.com/support/download/index.htm. ISE can build bitstreams both for boards using the Spartan-6 (Pipistrello) and 7-series devices (KC705), while Vivado supports only boards using 7-series devices.
176+
* Get Xilinx tools from http://www.xilinx.com/support/download/index.htm. ISE can build gateware bitstreams both for boards using the Spartan-6 (Pipistrello) and 7-series devices (KC705), while Vivado supports only boards using 7-series devices.
177177

178178
* The Pipistrello is supported by Webpack, the KC705 is not.
179179

@@ -208,9 +208,9 @@ These steps are required to generate bitstream (``.bit``) files, build the MiSoC
208208

209209
.. _install-flash-proxy:
210210

211-
* Install the required flash proxy bitstreams:
211+
* Install the required flash proxy gateware bitstreams:
212212

213-
The purpose of the flash proxy bitstream is to give programming software fast JTAG access to the flash connected to the FPGA.
213+
The purpose of the flash proxy gateware bitstream is to give programming software fast JTAG access to the flash connected to the FPGA.
214214

215215
* Pipistrello and KC705:
216216

@@ -243,7 +243,7 @@ These steps are required to generate bitstream (``.bit``) files, build the MiSoC
243243
:ref:`installing the host-side software <installing-the-host-side-software>`.
244244

245245

246-
* Build the bitstream, BIOS and runtime by running:
246+
* Build the gateware bitstream, BIOS and runtime by running:
247247
::
248248

249249
$ cd ~/artiq-dev
@@ -270,7 +270,7 @@ These steps are required to generate bitstream (``.bit``) files, build the MiSoC
270270

271271
.. note:: The `-t` option specifies the board your are targeting. Available options are ``kc705`` and ``pipistrello``.
272272

273-
* Check that the board boots by running a serial terminal program (you may need to press its FPGA reconfiguration button or power-cycle it to load the bitstream that was newly written into the flash): ::
273+
* Check that the board boots by running a serial terminal program (you may need to press its FPGA reconfiguration button or power-cycle it to load the gateware bitstream that was newly written into the flash): ::
274274

275275
$ make -C ~/artiq-dev/misoc/tools # do only once
276276
$ ~/artiq-dev/misoc/tools/flterm --port /dev/ttyUSB1

0 commit comments

Comments
 (0)
Please sign in to comment.