Installing ARTIQ ================ The preferred way of installing ARTIQ is through the use of the conda package manager. The conda package contains pre-built binaries that you can directly flash to your board. But you can also :ref:`install from sources `. .. note:: Only the linux-64 and linux-32 conda packages contain the FPGA/BIOS/runtime pre-built binaries. Installing using conda ---------------------- Installing Anaconda or Miniconda ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * You can either install Anaconda (chose Python 3.4) from https://store.continuum.io/cshop/anaconda/ * Or install the more minimalistic Miniconda (chose Python3.4) from http://conda.pydata.org/miniconda.html After installing either Anaconda or Miniconda, open a new terminal and make sure the following command works:: $ conda If it prints the help of the ``conda`` command, your install is OK. If not, then make sure your ``$PATH`` environment variable contains the path to anaconda3/bin (or miniconda3/bin):: $ echo $PATH /home/fallen/miniconda3/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games If your ``$PATH`` misses reference the miniconda3/bin or anaconda3/bin you can fix this by typing:: $ export PATH=$HOME/miniconda3:$PATH Installing the host side software ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ For this, you need to add our binstar repository to your conda configuration:: $ conda config --add channels http://conda.binstar.org/fallen/channel/dev Then you can install the ARTIQ package, it will pull all the necessary dependencies:: $ conda install artiq Preparing the core device FPGA board ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ You now need to flash 3 things on the FPGA board: 1. The FPGA bitstream 2. The BIOS 3. The ARTIQ runtime * First, install the :ref:`Flash proxy ` for your board. * Then, on Pipistrello board:: $ artiq_flash.sh -t pipistrello * or on KC705 board:: $ artiq_flash.sh Next step (for KC705) is to flash MAC and IP addresses to the board: * See :ref:`those instructions ` to flash MAC and IP addresses. .. _install-from-sources: Installing from source ---------------------- You can skip this if you already installed from conda. Preparing the core device FPGA board ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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`. * Install the FPGA vendor tools (e.g. Xilinx ISE and/or Vivado): * 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. * The Pipistrello is supported by Webpack, the KC705 is not. * During the Xilinx toolchain installation, uncheck ``Install cable drivers`` (they are not required as we use better and open source alternatives). * Create a development directory: :: $ mkdir ~/artiq-dev * Install Migen: :: $ cd ~/artiq-dev $ git clone https://github.com/m-labs/migen $ cd ~/artiq-dev/migen $ python3 setup.py develop --user .. note:: The options ``develop`` and ``--user`` are for setup.py to install Migen in ``~/.local/lib/python3.4``. * Install OpenRISC GCC/binutils toolchain (or1k-elf-...): :: $ mkdir ~/artiq-dev $ cd ~/artiq-dev $ git clone https://github.com/openrisc/or1k-src $ mkdir ~/artiq-dev/or1k-src/build $ cd ~/artiq-dev/or1k-src/build $ ../configure --target=or1k-elf --enable-shared --disable-itcl \ --disable-tk --disable-tcl --disable-winsup \ --disable-gdbtk --disable-libgui --disable-rda \ --disable-sid --disable-sim --disable-gdb \ --disable-newlib --disable-libgloss --disable-werror $ make -j4 $ sudo make install $ cd ~/artiq-dev $ git clone https://github.com/openrisc/or1k-gcc $ mkdir ~/artiq-dev/or1k-gcc/build $ cd ~/artiq-dev/or1k-gcc/build $ ../configure --target=or1k-elf --enable-languages=c \ --disable-shared --disable-libssp $ make -j4 $ sudo make install * Install JTAG tools needed to program the Pipistrello and KC705: :: $ cd ~/artiq-dev $ svn co https://xc3sprog.svn.sourceforge.net/svnroot/xc3sprog/trunk xc3sprog $ cd ~/artiq-dev/xc3sprog $ cmake . && make $ sudo make install .. note:: It is safe to ignore the message "Could NOT find LIBFTD2XX" (libftd2xx is different from libftdi, and is not required). .. _install-flash-proxy: * Install the required flash proxy bitstreams: The purpose of the flash proxy bitstream is to give programming software fast JTAG access to the flash connected to the FPGA. * Pipistrello: :: $ cd ~/artiq-dev $ wget http://www.phys.ethz.ch/~robertjo/bscan_spi_lx45_csg324.bit Then copy ``~/artiq-dev/bscan_spi_lx45_csg324.bit`` to ``~/.migen``, ``/usr/local/share/migen`` or ``/usr/share/migen``. * KC705: :: $ cd ~/artiq-dev $ git clone https://github.com/m-labs/bscan_spi_kc705 Build the bitstream and copy it to one of the folders above. * Download MiSoC: :: $ cd ~/artiq-dev $ git clone --recursive https://github.com/m-labs/misoc $ export MSCDIR=~/artiq-dev/misoc # append this line to .bashrc * Download and install ARTIQ: :: $ cd ~/artiq-dev $ git clone https://github.com/m-labs/artiq $ python3 setup.py develop --user * Build and flash the bitstream and BIOS by running `from the MiSoC top-level directory`: :: $ cd ~/artiq-dev/misoc * For Pipistrello:: $ ./make.py -X ~/artiq-dev/artiq/soc -t artiq_pipistrello all * For KC705:: $ ./make.py -X ~/artiq-dev/artiq/soc -t artiq_kc705 all * Then, build and flash the ARTIQ runtime: :: $ cd ~/artiq-dev/artiq/soc/runtime && make runtime.fbi $ ~/artiq-dev/artiq/artiq/frontend/artiq_flash.sh -t pipistrello -d $PWD -r .. note:: The `-t` option specifies the board your are targeting. Available options are ``kc705`` and ``pipistrello``. * 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): :: $ make -C ~/artiq-dev/misoc/tools # do only once $ ~/artiq-dev/misoc/tools/flterm --port /dev/ttyUSB1 MiSoC BIOS http://m-labs.hk [...] Booting from flash... Loading xxxxx bytes from flash... Executing booted program. ARTIQ runtime built The communication parameters are 115200 8-N-1. .. _flash-mac-ip-addr: * Set the MAC and IP address in the :ref:`core device configuration flash storage `: * You can either set it by generating a flash storage image and then flash it: :: $ artiq_mkfs flash_storage.img -s mac xx:xx:xx:xx:xx:xx -s ip xx.xx.xx.xx $ ~/artiq-dev/artiq/frontend/artiq_flash.sh -f flash_storage.img * Or you can set it via the runtime test mode command line * Boot the board. * Quickly run flterm (in ``path/to/misoc/tools``) to access the serial console. * If you weren't quick enough to see anything in the serial console, press the reset button. * Wait for "Press 't' to enter test mode..." to appear and hit the ``t`` key. * Enter the following commands (which will erase the flash storage content). :: test> fserase test> fswrite ip xx.xx.xx.xx test> fswrite mac xx:xx:xx:xx:xx:xx * Then reboot. You should see something like this in the serial console: :: ~/dev/misoc$ ./tools/flterm --port /dev/ttyUSB1 [FLTERM] Starting... MiSoC BIOS http://m-labs.hk (c) Copyright 2007-2014 Sebastien Bourdeauducq [...] Press 't' to enter test mode... Entering test mode. test> fserase test> fswrite ip 192.168.10.2 test> fswrite mac 11:22:33:44:55:66 .. note:: The reset button of the KC705 board is the "CPU_RST" labeled button. .. warning:: Both those instructions will result in the flash storage being wiped out. However you can use the test mode to change the IP/MAC without erasing everything if you skip the "fserase" command. * (optional) Flash the ``idle`` kernel The ``idle`` kernel is the kernel (some piece of code running on the core device) which the core device runs whenever it is not connected to a PC via ethernet. This kernel is therefore stored in the :ref:`core device configuration flash storage `. To flash the ``idle`` kernel: * Compile the ``idle`` experiment: The ``idle`` experiment's ``run()`` method must be a kernel: it must be decorated with the ``@kernel`` decorator (see :ref:`next topic ` for more information about kernels). Since the core device is not connected to the PC, RPCs (calling Python code running on the PC from the kernel) are forbidden in the ``idle`` experiment. :: $ artiq_compile idle.py * Write it into the core device configuration flash storage: :: $ artiq_coreconfig -f idle_kernel idle.elf .. note:: You can find more information about how to use the ``artiq_coreconfig`` tool on the :ref:`Utilities ` page. Installing the host-side software ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * Install LLVM and the llvmlite Python bindings: :: $ cd ~/artiq-dev $ git clone https://github.com/openrisc/llvm-or1k $ cd ~/artiq-dev/llvm-or1k/tools $ git clone https://github.com/openrisc/clang-or1k clang $ cd ~/artiq-dev/llvm-or1k $ mkdir build $ cd ~/artiq-dev/llvm-or1k/build $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr/local/llvm-or1k -DLLVM_TARGETS_TO_BUILD=OR1K -DCMAKE_BUILD_TYPE=Debug -DBUILD_SHARED_LIBS=ON $ make -j4 $ sudo make install $ cd ~/artiq-dev $ git clone https://github.com/numba/llvmlite $ cd ~/artiq-dev/llvmlite $ patch -p1 < ~/artiq-dev/artiq/misc/llvmlite-add-all-targets.patch $ PATH=/usr/local/llvm-or1k/bin:$PATH sudo -E python3 setup.py install .. note:: llvmlite is in development and its API is not stable yet. Commit ID ``11a8303d02e3d6dd2d1e0e9065701795cd8a979f`` is known to work. .. note:: Compilation of LLVM can take more than 30 min on some machines. * Install ARTIQ: :: $ cd ~/artiq-dev $ git clone https://github.com/m-labs/artiq # if not already done $ cd artiq $ python3 setup.py develop --user * Build the documentation: :: $ cd ~/artiq-dev/artiq/doc/manual $ make html Ubuntu 14.04 specific instructions ---------------------------------- This command installs all the required packages: :: $ sudo apt-get install build-essential autotools-dev file git patch perl xutils-devs python3-pip texinfo flex bison libmpc-dev python3-serial python3-dateutil python3-prettytable python3-setuptools python3-numpy python3-scipy python3-sphinx python3-h5py python3-dev python-dev subversion cmake libusb-dev libftdi-dev pkg-config Note that ARTIQ requires Python 3.4 or above. To set user permissions on the JTAG and serial ports of the Pipistrello, create a ``/etc/udev/rules.d/30-usb-papilio.rules`` file containing the following: :: SUBSYSTEM=="usb", ATTRS{idVendor}=="0403", ATTRS{idProduct}=="6010", GROUP="dialout" Then reload ``udev``, add your user to the ``dialout`` group, and log out and log in again: :: $ sudo invoke-rc.d udev reload $ sudo adduser dialout $ logout