M-Labs
/
artiq
mirror of https://github.com/m-labs/artiq.git
2
0
Fork 2
Code Issues Projects Releases Wiki Activity

doc: correctly place the openocd section, link it, add explanation

This commit is contained in:
Robert Jördens 2016-03-20 20:19:12 +01:00
parent d069380f6b
commit 22cd12f721
1 changed files with 29 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
doc/manual/installing.rst
View File

@ -40,27 +40,6 @@ If your ``$PATH`` misses reference the ``miniconda3/bin`` or ``anaconda3/bin`` y
$ export PATH=$HOME/miniconda3/bin:$PATH $ export PATH=$HOME/miniconda3/bin:$PATH
.. _install-openocd:
Installing OpenOCD
^^^^^^^^^^^^^^^^^^^
The following instructions are for Ubuntu.
* Install JTAG tools needed to program the Pipistrello and KC705:
::
$ cd ~/artiq-dev
$ git clone https://github.com/ntfreak/openocd.git
$ cd openocd
$ sudo apt-get install build-essential libtool libusb-1.0-0-dev libftdi-dev automake
$ ./bootstrap
$ ./configure
$ make
$ sudo make install
$ sudo cp contrib/99-openocd.rules /etc/udev/rules.d
$ sudo adduser $USER plugdev
Installing the ARTIQ packages Installing the ARTIQ packages
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -120,7 +99,34 @@ You now need to flash 3 things on the FPGA board:
They are all shipped in our Conda packages, along with the required flash proxy gateware bitstreams. They are all shipped in our Conda packages, along with the required flash proxy gateware bitstreams.
First you need to install OpenOCD. Then, you can flash the board: .. _install-openocd:
Installing OpenOCD
..................
There are several tools that can be used to write the thee binaries into
the core device FPGA board's flash memory. Xilinx ISE (impact) or Vivado work, as does xc3sprog
sometimes. OpenOCD is the recommended and most reliable method. But
it is not currently packaged as a conda package.
The following instructions are for Ubuntu.
::
$ cd ~/artiq-dev
$ git clone https://github.com/ntfreak/openocd.git
$ cd openocd
$ sudo apt-get install build-essential libtool libusb-1.0-0-dev libftdi-dev automake
$ ./bootstrap
$ ./configure
$ make
$ sudo make install
$ sudo cp contrib/99-openocd.rules /etc/udev/rules.d
$ sudo adduser $USER plugdev
Then, you can flash the board:
* For the Pipistrello board:: * For the Pipistrello board::
@ -226,6 +232,7 @@ These steps are required to generate gateware bitstream (``.bit``) files, build
Then move both files ``~/artiq-dev/bscan_spi_xc6slx45.bit`` and ``~/artiq-dev/bscan_spi_xc7k325t.bit`` to ``~/.migen``, ``/usr/local/share/migen``, or ``/usr/share/migen``. Then move both files ``~/artiq-dev/bscan_spi_xc6slx45.bit`` and ``~/artiq-dev/bscan_spi_xc7k325t.bit`` to ``~/.migen``, ``/usr/local/share/migen``, or ``/usr/share/migen``.
* :ref:`Download and install OpenOCD <install-openocd>`.
* Download and install MiSoC: :: * Download and install MiSoC: ::