Skip to content

Latest commit

 

History

History
526 lines (363 loc) · 11.9 KB

README.md

File metadata and controls

526 lines (363 loc) · 11.9 KB
Raw

Project bel_projects

GSI Timing Gateware and Tools

Table of Contents

Build Instructions

Checkout

Just clone our project.

git clone https://github.com/GSI-CS-CO/bel_projects.git

First Steps

Make will take care of all submodules and additional toolchains.

make

Important: Please don't mess around using the "git submodule --fancy option" command!

Kernel Drivers

This will build VME and PCI(e) drivers.

make driver
(optional) make driver-install
(optional - build wishbone-serial.ko) make driver/driver-install WISHBONE_SERIAL=y

Etherbone

Builds basic Etherbone tools and library.

make etherbone
(optional) make etherbone-install

Tools (Monitoring and EB-Tools)

Additional tools like eb-console and eb-flash.

make tools
(optional) make tools-install

Saftlib

Builds basic Saftlib tools and library.

make saftlib
(optional) make saftlib-install

For detailed information check ip_cores/saftlib/CompileAndConfigureSaftlib.md.

Build Gateware(s)

Currently we support a few different form factors.

make scu2               # Arria II
make scu3               # Arria II
make vetar2a            # Arria II
make vetar2a-ee-butis   # Arria II
make ftm                # Arria V
make pexarria5          # Arria V
make exploder5          # Arria V
make pmc                # Arria V
make microtca           # Arria V
make pexp               # Arria V
make scu4               # Arria 10
make scu4slim           # Arria 10
make pexarria10         # Arria 10
make ftm10              # Arria 10
make ftm4               # Arria 10 - optional FTM4 development
make ftm4dp             # Arria 10 - optional FTM4 dual port development
make a10gx_pcie         # Arria 10 - Intel evaluation board

Additional Targets

Check Timing Constraints

make $device-check
make exploder5-check # example

Sort QSF Files

make $device-sort
make exploder5-sort # example

LM32 Cluster Testbench

make lm32-cluster-testbench-run

Click here for additional information.

FAQ and Common Problems

Synthesis

Quartus Version

Question: Which Version of Quartus Do I Need?

Answer: We recommend to use Quartus 18.1.0 (Build 625 09/12/2018 SJ)

Library libpng12

Error: Quartus error while loading shared libraries: libpng12-0.0: ... [Ubuntu/Mint/...]

Solution: Install the missing package

Ubuntu

Get the package from here: https://packages.ubuntu.com/xenial/amd64/libpng12-0/download

Mint

sudo add-apt-repository ppa:linuxuprising/libpng12
sudo apt update
sudo apt install libpng12-0

Backup Plan

You can use a copy from here:

  • Ubuntu: res/ubuntu
  • Rocky-9: res/rocky-9

Tool qmegawiz

Error: Executing qmegawiz: child process exited abnormally + Time value XXX,YYYMbps and time unit are illegal

Solution: Change your LC_NUMERIC setting:

export LC_NUMERIC="en_US.UTF-8"

Tool qsys-generate

Error: (23035) Tcl error: couldn't execute "qsys-generate": no such file or directory

Solution: Adjust your PATH variable like this:

export QUARTUS=/opt/quartus/
export QSYS_ROOTDIR=$QUARTUS/sopc_builder/bin
export PATH=$PATH:$QUARTUS_ROOTDIR:$QSYS_ROOTDIR

Permission denied

Error: /bin/sh: 1: cannot create /ramsize_pkg.vhd: Permission denied

Solution: Check all your (changed) Manifest.py files.

Build Flow

Required Packages

Question: Which packages are required?

Answer: You need to have installed the following packages before you can configure and build Etherbone and Saftlib:

  • docbook-utils
  • libglib2.0-dev
  • autotools-dev
  • autoconf
  • libtool (glibtoolize)
  • build-essential
  • automake
  • libreadline-dev
  • libsigc++ (saftlib) ‡
  • libboost-dev (saftlib)
  • pkgconfig (saftlib) †
  • xsltproc (saftlib)
  • libz-dev (saftlib)

† Ubuntu 22.04 and later: pkg-config

‡ Ubuntu 22.04 and later: libsigc++-2.0-dev

Library libmpfr

Error: error while loading shared libraries: libmpfr.so.4: cannot open shared object file: No such file or directory [Ubuntu/Mint/...]

Error: lm32-* permission denied /dev/stdout

Solution: Create a new symlink:

sudo ln -s /usr/lib/x86_64-linux-gnu/libmpfr.so.6 /usr/lib/x86_64-linux-gnu/libmpfr.so.4

Tool hdlmake

Error: hdlmake AttributeError: module object has no attribute vendor or hdlmake not found

Solution: In case a simple "make" does not fix this:

make hdlmake_install

Tool hdlmake not found (for both Python 2.7 & Python 3.x)

Error: /bin/sh: 1: hdlmake: not found

Solution: You should run "make" to install hdlmake locally and adjust your PATH variable:

export PATH=$PATH:$HOME/.local/bin

Python not found

Error: cd ip_cores/hdlmake/ && python setup.py install --user /bin/sh: 1: python: not found

Solution: In case you are running Ubuntu:

sudo apt-get install python-is-python3

Optional (python-is-python3 not found):

sudo ln -s /usr/bin/python3 /etc/python
sudo apt-get install python-setuptools

In case you have no sudo rights:

ln -s /usr/bin/python3 python
export PATH=$PATH:$(pwd)

We recommend to use at least Python3.7.

No module named pkg_resources

Error: ImportError: No module named pkg_resources

Solution:

sudo apt-get install python-pkg-resources
sudo apt-get install --reinstall python-pkg-resources # if already installed

Setuptools not found

Error: ModuleNotFoundError: No module named 'setuptools'

Solution: Just install the right setuptools:

sudo apt-get install python3-setuptools # Python 3.X
sudo apt-get install python-setuptools # Python 2.X

Compiling Saftlib

Error: Compilation: "Error message: ./configure: line 16708: syntax error near unexpected token 0.23' ./configure: line 16708: PKG_PROG_PKG_CONFIG(0.23)'"

Solution:

sudo apt-get install pkg-config
export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig

Error: Compillation: "saftbus/process.cpp:14:10: fatal error: linux/ioprio.h: No such file or directory"

Solution:

  1. In Makefile.am
  • line 405: delete 'saft-roundtrip-latency saft-standalone-roundtrip-latency'
  • delete lines 486-490
saft_roundtrip_latency_LDADD = $(EB_LIBS)  $(SIGCPP_LIBS) libsaftbus.la libsaft-proxy.la -ldl #-lltdl
saft_roundtrip_latency_SOURCES = src/saft-roundtrip-latency.cpp

saft_standalone_roundtrip_latency_LDADD = $(EB_LIBS)  $(SIGCPP_LIBS) libsaftbus.la libsaft-service.la  -ldl #-lltdl
saft_standalone_roundtrip_latency_SOURCES = src/saft-standalone-roundtrip-latency.cpp
  1. In saftbus/process.cpp, replace the entire code by
#include "process.hpp"

#include <iostream>
#include <sstream>
#include <cstring>

bool set_realtime_scheduling(std::string argvi, char *prio) {
  return true;
}

bool set_cpu_affinity(std::string argvi, char *affinity) {
  return true;
}

bool set_ioprio(char *ioprio) {
  return true;
}

CC not found

Error: make[1]: cc: No such file or directory

Solution:

which cc # cc: Command not found.
update-alternatives --list cc
which cc # /usr/bin/cc

Rocky-9

Click here for additional information.

Yocto

Etherbone & Saftlib

unset LD_LIBRARY_PATH
source /common/usr/embedded/yocto/sdk/environment-setup-core2-64-ffos-linux
make etherbone YOCTO_BUILD=yes
make saftlib YOCTO_BUILD=yes

Check the Rocky-9 subsection, if you get lsb_release related errors.

Etherbone Tools

See tools/yocto-build.sh

Package Requirements Etherbone

Error: configure: error: Package requirements (etherbone >= x.y.z) were not met:

Solution:

export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig

Git

CAfile

Error: Cloning into 'dir'... - fatal: unable to access 'https://ohwr.org/project/generic_project.git/': server certificate verification failed. CAfile: none CRLfile: none

Solution: Systems with outdated trust databases (root CA certificate Let's Encrypt) will be unable to validate the certificate of the site. Update ca-certificates to fix this:

sudo apt update
sudo apt upgrade ca-certificates

JTAG and Programming

USB-Blaster Issues

Error: quartus: USB-Blaster can't find FPGA [Ubuntu/Mint/...]

Solution: Create a new symlink:

sudo ln -sf /lib/x86_64-linux-gnu/libudev.so.1 /lib/x86_64-linux-gnu/libudev.so.0

Altera/Intel USB Blaster

See doc/usbblaster/readme.md

Xilinx Platform Cable II

See doc/platform_cable/readme.md

Arrow USB Programmer

See doc/arrow_usb_programmer/readme.md

Altera/Intel Ethernet Blaster

Default user: admin
Default password: password
Default server port (programmer GUI): 1309

Timing Receiver

Commissioning

Configure the SPI flash chip:

eb-config-nv $device 10 4

Format the 1-wire EEPROM:

cd bel_projects/ip_cores/wrpc-sw/tools
eb-w1-write $device 0 320 < sdb-wrpc.bin

Program FPGA from command line:

quartus_pgm -c 1 -m jtag -o 'p;device.sof'

Flashing

Problem: Flashing might fail sometimes on certain devices and host combinations.

Solution: If you have such a device please use eb-flash (with additional arguments) to flash the timing receiver:

Optional (BEFORE using eb-flash):

eb-reset $device wddisable # disable watchdog timer
eb-reset $device cpuhalt 0xff # stop all embedded CPUs

Optional (AFTER using eb-flash):

eb-reset $device fpgareset # reset FPGA

Arria2 Devices

(problematic devices) eb-flash -s 0x40000 -w 3 $device $gateware.rpd # <VETAR2A/VETAR2A-EE-BUTIS/SCU2/SCU3>
(unproblematic devices) eb-flash $device $gateware.rpd # <VETAR2A/VETAR2A-EE-BUTIS/SCU2/SCU3>

ArriaV Devices

(problematic devices) eb-flash -s 0x10000 -w 3 $device $gateware.rpd # <PEXP/PEXARRIA5/PMC/MICROTCA/EXPLODER5>
(unproblematic devices) eb-flash $device $gateware.rpd # <PEXP/PEXARRIA5/PMC/MICROTCA/EXPLODER5>

Arria10 Devices

eb-asmi $device -w $gateware.rpd (write)
eb-asmi $device -v $gateware.rpd (verify)