forked from M-Labs/artiq
manual: revamp developing section
This commit is contained in:
parent
62bfccc264
commit
2a60914cb9
@ -2,307 +2,24 @@ Developing ARTIQ
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
.. warning::
|
||||
This section is only for software or FPGA developers who want to modify ARTIQ. The steps described here are not required if you simply want to run experiments with ARTIQ.
|
||||
|
||||
.. note::
|
||||
Developing ARTIQ is currently only possible on Linux.
|
||||
|
||||
We describe two different approaches to creating a development environment for ARTIQ.
|
||||
|
||||
The first method uses existing pre-compiled Anaconda packages and the ``artiq-dev`` meta-package for the development environment.
|
||||
This is fast and convenient because it avoids compiling the entire toolchain.
|
||||
Consequently, some ARTIQ developers as well as the buildbot that's used for continuous integration all employ this method to build the ``artiq`` Anaconda packages and the bitstreams.
|
||||
It is completely sufficient to develop and tweak the ARTIQ code and to build
|
||||
bitstreams.
|
||||
|
||||
But with the meta-pakage developing individual components within the toolchain requires extra care.
|
||||
Consequently, the second method builds most components in the toolchain from their sources.
|
||||
This takes time and care to reproduce accurately but it gives absolute control over the components and an immediate handle at developing them.
|
||||
Some ARTIQ developers use this second method of building the entire toolchain
|
||||
from sources.
|
||||
It is only recommended for developers and advanced users.
|
||||
|
||||
.. _develop-from-conda:
|
||||
|
||||
ARTIQ Anaconda development environment
|
||||
======================================
|
||||
|
||||
1. Install ``git`` as recommended for your operating system and distribution.
|
||||
2. Obtain ARTIQ::
|
||||
|
||||
$ git clone --recursive https://github.com/m-labs/artiq ~/artiq-dev/artiq
|
||||
$ cd ~/artiq-dev/artiq
|
||||
|
||||
Add ``-b release-X`` to the ``git clone`` command if you are building a stable branch of ARTIQ. Replace ``X`` with the major release. The default will fetch the development ``master`` branch.
|
||||
3. :ref:`Install Anaconda or Miniconda <install-anaconda>`
|
||||
4. Create and activate a conda environment named ``artiq-dev`` and install the ``artiq-dev`` package which pulls in all the packages required to develop ARTIQ::
|
||||
|
||||
$ conda env create -f conda/artiq-dev.yaml
|
||||
$ source activate artiq-dev
|
||||
5. Add the ARTIQ source tree to the environment's search path::
|
||||
|
||||
$ pip install -e .
|
||||
6. :ref:`Install Vivado <install-xilinx>`
|
||||
7. :ref:`Configure OpenOCD <setup-openocd>`
|
||||
8. :ref:`Build target binaries <build-target-binaries>`
|
||||
9. :ref:`Flash target binaries <flash-target-binaries>`
|
||||
|
||||
.. _install-from-source:
|
||||
|
||||
Installing ARTIQ from source
|
||||
============================
|
||||
|
||||
Preparing the build environment for the core device
|
||||
---------------------------------------------------
|
||||
|
||||
These steps are required to generate code that can run on the core
|
||||
device. They are necessary both for building the firmware
|
||||
and the ARTIQ kernels.
|
||||
|
||||
* Install required host packages: ::
|
||||
|
||||
$ sudo apt-get install python3.5 pip3 build-essential cmake cargo
|
||||
|
||||
* Create a development directory: ::
|
||||
|
||||
$ mkdir ~/artiq-dev
|
||||
|
||||
* Clone ARTIQ repository: ::
|
||||
|
||||
$ cd ~/artiq-dev
|
||||
$ git clone --recursive https://github.com/m-labs/artiq
|
||||
|
||||
Add ``-b release-X`` to the ``git clone`` command if you are building a stable branch of ARTIQ (the default will fetch the development ``master`` branch).
|
||||
|
||||
* Install OpenRISC binutils (or1k-linux-...): ::
|
||||
|
||||
$ cd ~/artiq-dev
|
||||
$ wget https://ftp.gnu.org/gnu/binutils/binutils-2.27.tar.bz2
|
||||
$ tar xvf binutils-2.27.tar.bz2
|
||||
$ cd binutils-2.27
|
||||
$ curl -L 'https://raw.githubusercontent.com/m-labs/conda-recipes/c3effbc26e96c6e246d6e8035f8a07bc52d8ded1/conda/binutils-or1k-linux/fix-R_OR1K_GOTOFF-relocations.patch' | patch -p1
|
||||
|
||||
$ mkdir build
|
||||
$ cd build
|
||||
$ ../configure --target=or1k-linux --prefix=/usr/local
|
||||
$ make -j4
|
||||
$ sudo make install
|
||||
|
||||
.. note::
|
||||
We're using an ``or1k-linux`` target because it is necessary to enable
|
||||
shared library support in ``ld``, not because Linux is involved.
|
||||
|
||||
* Install LLVM and Clang: ::
|
||||
|
||||
$ cd ~/artiq-dev
|
||||
$ git clone -b artiq-6.0 https://github.com/m-labs/llvm-or1k
|
||||
$ cd llvm-or1k
|
||||
$ git clone -b artiq-6.0 https://github.com/m-labs/clang-or1k tools/clang
|
||||
|
||||
$ mkdir build
|
||||
$ cd build
|
||||
$ cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local/llvm-or1k -DLLVM_TARGETS_TO_BUILD=X86 -DLLVM_EXPERIMENTAL_TARGETS_TO_BUILD=OR1K -DLLVM_ENABLE_ASSERTIONS=ON -DLLVM_INSTALL_UTILS=ON -DCLANG_ENABLE_ARCMT=OFF -DCLANG_ENABLE_STATIC_ANALYZER=OFF
|
||||
$ make -j4
|
||||
$ sudo make install
|
||||
|
||||
* Install Rust: ::
|
||||
|
||||
$ cd ~/artiq-dev
|
||||
$ git clone -b artiq-1.28.0 https://github.com/m-labs/rust
|
||||
$ cd rust
|
||||
$ git submodule update --init --recursive
|
||||
$ mkdir build
|
||||
$ cd build
|
||||
$ ../configure --prefix=/usr/local/rust-or1k --llvm-root=/usr/local/llvm-or1k --disable-manage-submodules --disable-docs
|
||||
$ sudo mkdir /usr/local/rust-or1k
|
||||
$ sudo chown $USER.$USER /usr/local/rust-or1k
|
||||
$ make install
|
||||
$ cd ..
|
||||
|
||||
$ destdir="/usr/local/rust-or1k/lib/rustlib/or1k-unknown-none/lib/"
|
||||
$ rustc="rustc --out-dir ${destdir} -L ${destdir} --target or1k-unknown-none -g -C target-feature=+mul,+div,+ffl1,+cmov,+addc -C opt-level=s --crate-type rlib"
|
||||
$ mkdir -p ${destdir}
|
||||
$ ${rustc} --crate-name core src/libcore/lib.rs
|
||||
$ ${rustc} --crate-name compiler_builtins src/libcompiler_builtins/src/lib.rs --cfg $ 'feature="compiler-builtins"' --cfg 'feature="mem"'
|
||||
$ ${rustc} --crate-name std_unicode src/libstd_unicode/lib.rs
|
||||
$ ${rustc} --crate-name alloc src/liballoc/lib.rs
|
||||
$ ${rustc} --crate-name libc src/liblibc_mini/lib.rs
|
||||
$ ${rustc} --crate-name unwind src/libunwind/lib.rs
|
||||
$ ${rustc} -Cpanic=abort --crate-name panic_abort src/libpanic_abort/lib.rs
|
||||
$ ${rustc} -Cpanic=unwind --crate-name panic_unwind src/libpanic_unwind/lib.rs \
|
||||
--cfg llvm_libunwind
|
||||
|
||||
.. note::
|
||||
Compilation of LLVM can take more than 30 min on some machines. Compilation of Rust can take more than two hours.
|
||||
|
||||
Preparing the core device FPGA board
|
||||
------------------------------------
|
||||
|
||||
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`.
|
||||
|
||||
.. _install-xilinx:
|
||||
|
||||
* Install the FPGA vendor tools (i.e. Vivado):
|
||||
|
||||
* Get Vivado from http://www.xilinx.com/support/download/index.htm.
|
||||
|
||||
* The "appropriate" Vivado version to use for building the bitstream can
|
||||
vary. Some versions contain bugs that lead to hidden or visible failures,
|
||||
others work fine.
|
||||
Refer to the `M-Labs buildbot logs <http://buildbot.m-labs.hk/>`_ to
|
||||
determine which version is currently used when building the binary
|
||||
packages.
|
||||
|
||||
* During the Vivado installation, uncheck ``Install cable drivers`` (they are not required as we use better and open source alternatives).
|
||||
|
||||
* Install Migen: ::
|
||||
|
||||
$ cd ~/artiq-dev
|
||||
$ git clone https://github.com/m-labs/migen
|
||||
$ cd migen
|
||||
$ python3 setup.py develop --user
|
||||
|
||||
.. note::
|
||||
The options ``develop`` and ``--user`` are for setup.py to install Migen in ``~/.local/lib/python3.5``.
|
||||
|
||||
.. _install-bscan-spi:
|
||||
|
||||
* Install the required flash proxy gateware bitstreams:
|
||||
|
||||
The purpose of the flash proxy gateware bitstream is to give programming software fast JTAG access to the flash connected to the FPGA.
|
||||
|
||||
* KC705:
|
||||
|
||||
::
|
||||
|
||||
$ cd ~/artiq-dev
|
||||
$ wget https://raw.githubusercontent.com/jordens/bscan_spi_bitstreams/master/bscan_spi_xc7k325t.bit
|
||||
|
||||
Then move ``~/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 ``asyncserial``: ::
|
||||
|
||||
$ cd ~/artiq-dev
|
||||
$ git clone https://www.github.com/m-labs/asyncserial
|
||||
$ cd asyncserial
|
||||
$ python3 setup.py develop --user
|
||||
|
||||
* Download and install MiSoC: ::
|
||||
|
||||
$ cd ~/artiq-dev
|
||||
$ git clone --recursive https://github.com/m-labs/misoc
|
||||
$ cd misoc
|
||||
$ python3 setup.py develop --user
|
||||
|
||||
* Download and install ``pythonparser``: ::
|
||||
|
||||
$ cd ~/artiq-dev
|
||||
$ git clone https://www.github.com/m-labs/pythonparser
|
||||
$ cd pythonparser
|
||||
$ python3 setup.py develop --user
|
||||
|
||||
* Download and install ARTIQ: ::
|
||||
|
||||
$ cd ~/artiq-dev
|
||||
$ git clone --recursive https://github.com/m-labs/artiq
|
||||
$ cd artiq
|
||||
$ python3 setup.py develop --user
|
||||
|
||||
.. note::
|
||||
If you have any trouble during ARTIQ setup about ``pygit2`` installation,
|
||||
refer to the section dealing with
|
||||
:ref:`installing the host-side software <installing-the-host-side-software>`.
|
||||
|
||||
|
||||
* Build the gateware bitstream, BIOS and runtime by running:
|
||||
::
|
||||
|
||||
$ cd ~/artiq-dev
|
||||
$ export PATH=/usr/local/llvm-or1k/bin:$PATH
|
||||
|
||||
.. note:: Make sure that ``/usr/local/llvm-or1k/bin`` is first in your ``PATH``, so that the ``clang`` command you just built is found instead of the system one, if any.
|
||||
|
||||
.. _build-target-binaries:
|
||||
|
||||
* For Kasli::
|
||||
|
||||
$ python3 -m artiq.gateware.targets.kasli -V <your_variant>
|
||||
|
||||
* For KC705::
|
||||
|
||||
$ python3 -m artiq.gateware.targets.kc705 -V nist_clock # or nist_qc2
|
||||
|
||||
.. note:: Add ``--toolchain ise`` if you wish to use ISE instead of Vivado. ISE needs a separate installation step.
|
||||
|
||||
.. _flash-target-binaries:
|
||||
|
||||
* Then, flash the binaries: ::
|
||||
|
||||
$ artiq_flash --srcbuild artiq_kasli -V <your_variant>
|
||||
|
||||
* 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): ::
|
||||
|
||||
$ flterm /dev/ttyUSB1
|
||||
MiSoC BIOS http://m-labs.hk
|
||||
[...]
|
||||
Booting from flash...
|
||||
Loading xxxxx bytes from flash...
|
||||
Executing booted program.
|
||||
ARTIQ runtime built <date/time>
|
||||
|
||||
.. note:: flterm is part of MiSoC. If you installed MiSoC with ``setup.py develop --user``, the flterm launcher is in ``~/.local/bin``.
|
||||
|
||||
The communication parameters are 115200 8-N-1. Ensure that your user has access
|
||||
to the serial device (``sudo adduser $USER dialout`` assuming standard setup).
|
||||
|
||||
.. _installing-the-host-side-software:
|
||||
|
||||
Installing the host-side software
|
||||
---------------------------------
|
||||
|
||||
* Install the llvmlite Python bindings: ::
|
||||
|
||||
$ cd ~/artiq-dev
|
||||
$ git clone https://github.com/m-labs/llvmlite
|
||||
$ cd llvmlite
|
||||
$ git checkout artiq-3.9
|
||||
$ LLVM_CONFIG=/usr/local/llvm-or1k/bin/llvm-config python3 setup.py install --user
|
||||
|
||||
* Install ARTIQ: ::
|
||||
|
||||
$ cd ~/artiq-dev
|
||||
$ git clone --recursive https://github.com/m-labs/artiq # if not already done
|
||||
$ cd artiq
|
||||
$ python3 setup.py develop --user
|
||||
|
||||
.. note::
|
||||
If you have any trouble during ARTIQ setup about ``pygit2`` installation,
|
||||
you can install it by using ``pip``:
|
||||
|
||||
On Ubuntu 14.04::
|
||||
|
||||
$ python3 `which pip3` install --user pygit2==0.19.1
|
||||
|
||||
On Ubuntu 14.10::
|
||||
|
||||
$ python3 `which pip3` install --user pygit2==0.20.3
|
||||
|
||||
On Ubuntu 15.04 and 15.10::
|
||||
|
||||
$ python3 `which pip3` install --user pygit2==0.22.1
|
||||
|
||||
On Ubuntu 16.04::
|
||||
|
||||
$ python3 `which pip3` install --user pygit2==0.24.1
|
||||
|
||||
The rationale behind this is that pygit2 and libgit2 must have the same
|
||||
major.minor version numbers.
|
||||
|
||||
See http://www.pygit2.org/install.html#version-numbers
|
||||
|
||||
* Build the documentation: ::
|
||||
|
||||
$ cd ~/artiq-dev/artiq/doc/manual
|
||||
$ make html
|
||||
This section is only for software or FPGA developers who want to modify ARTIQ. The steps described here are not required if you simply want to run experiments with ARTIQ. If you purchased a system from M-Labs or QUARTIQ, we normally provide board binaries for you.
|
||||
|
||||
The easiest way to obtain an ARTIQ development environment is via the Nix package manager on Linux. The Nix system is used on the `M-Labs Hydra server <https://nixbld.m-labs.hk/>`_ to build ARTIQ and its dependencies continuously; it ensures that all build instructions are up-to-date and allows binary packages to be used on developers' machines, in particular for large tools such as the Rust compiler.
|
||||
ARTIQ itself does not depend on Nix, and it is also possible to compile everything from source (look into the ``.nix`` files from the ``nix-scripts`` repository and run the commands manually) - but Nix makes the process a lot easier.
|
||||
|
||||
* Install the `Nix package manager <http://nixos.org/nix/>`_ and Git (e.g. ``nix-shell -p git``).
|
||||
* Set up the M-Labs Hydra channels (:ref:`same procedure as the user section <installing-nix-users>`) to allow binaries to be downloaded. Otherwise, tools such as LLVM and the Rust compiler will be compiled on your machine, which uses a lot of CPU time, memory, and disk space. Simply setting up the channels is sufficient, Nix will automatically detect when a binary can be downloaded instead of being compiled locally.
|
||||
* Clone the repositories https://github.com/m-labs/artiq and https://github.com/m-labs/nix-scripts.
|
||||
* Run ``nix-shell -I artiqSrc=path_to_artiq_sources shell-dev.nix`` to obtain an environment containing all the required development tools (e.g. Migen, MiSoC, Clang, Rust, OpenOCD...) in addition to the ARTIQ user environment. ``artiqSrc`` should point to the root of the cloned ``artiq`` repository, and ``shell-dev.nix`` can be found in the ``artiq`` folder of the ``nix-scripts`` repository.
|
||||
* This enters a FHS chroot environment that simplifies the installation and patching of Xilinx Vivado.
|
||||
* Download Vivado from Xilinx and install it (by running the official installer in the FHS chroot environment). If you do not want to write to ``/opt``, you can install it in a folder of your home directory. The "appropriate" Vivado version to use for building the bitstream can vary. Some versions contain bugs that lead to hidden or visible failures, others work fine. Refer to the `M-Labs Hydra logs <https://nixbld.m-labs.hk/>`_ to determine which version is currently used when building the binary packages.
|
||||
* During the Vivado installation, uncheck ``Install cable drivers`` (they are not required as we use better and open source alternatives).
|
||||
* You can then build the firmware and gateware with a command such as ``python -m artiq.gateware.targets.kasli``.
|
||||
* If you did not install Vivado in ``/opt``, add a command line option such as ``--gateware-toolchain-path ~/Xilinx/Vivado``.
|
||||
* Flash the binaries into the FPGA board with a command such as ``artiq_flash --srcbuild artiq_kasli -V <your_variant>``. You need to configure OpenOCD as explained :ref:`in the user section <configuring-openocd>`. OpenOCD is already part of the shell started by ``shell-dev.nix``.
|
||||
* Check that the board boots and examine the UART messages by running a serial terminal program, e.g. ``flterm /dev/ttyUSB1`` (``flterm`` is part of MiSoC and installed by ``shell-dev.nix``). Leave the terminal running while you are flashing the board, so that you see the startup messages when the board boots immediately after flashing. You can also restart the board (without reflashing it) with ``artiq_flash start``.
|
||||
* The communication parameters are 115200 8-N-1. Ensure that your user has access to the serial device (``sudo adduser $USER dialout`` assuming standard setup).
|
||||
* If you are modifying a dependency of ARTIQ, in addition to updating the relevant part of ``nix-scripts``, rebuild and upload the corresponding Conda packages manually, and update their version numbers in ``conda-artiq.nix``. For Conda, only the main ARTIQ package and the board packages are handled automatically on Hydra.
|
||||
|
||||
.. warning::
|
||||
Nix will make a read-only copy of the ARTIQ source to use in the shell environment. Therefore, any modifications that you make to the source after the shell is started will not be taken into account. A solution applicable to ARTIQ (and several other Python packages such as Migen and MiSoC) is to set the ``PYTHONPATH`` environment variable in the shell to the root of the ARTIQ source. If you want this to be done by default, edit ``profile`` in ``artiq-dev.nix``.
|
||||
|
||||
@ -9,6 +9,8 @@ Conda has a more traditional approach to package management, is much more limite
|
||||
|
||||
In the current state of affairs, we recommend that Linux users install ARTIQ via Nix and Windows users install it via Conda.
|
||||
|
||||
.. _installing-nix-users:
|
||||
|
||||
Installing via Nix (Linux)
|
||||
--------------------------
|
||||
|
||||
@ -157,6 +159,8 @@ With Conda, the ``artiq`` package installs ``openocd`` automatically but it can
|
||||
|
||||
$ conda install openocd
|
||||
|
||||
.. _configuring-openocd:
|
||||
|
||||
Configuring OpenOCD
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user