Universal utility for programming FPGA
Loading README and project media…
Universal utility for programming FPGA
Current support kits:
Supported (tested) FPGA:
Supported cables:
This application uses libftdi1, so this library must be installed (and, depending of the distribution, headers too)
apt-get install libftdi1-2 libftdi1-dev libudev-dev cmake
libudev-dev is optional, may be replaced by eudev-dev or just not installed.
By default, (e)udev support is enabled (used to open a device by his /dev/xx node). If you don't want this option, use:
-DENABLE_UDEV=OFF
And if not already done, install pkg-config, make and g++.
Alternatively you can manually specify the location of libusb and libftdi1:
-DUSE_PKGCONFIG=OFF -DLIBUSB_LIBRARIES=<path_to_libusb> -DLIBFTDI_LIBRARIES=<path_to_libftdi> -DLIBFTDI_VERSION=<version> -DCMAKE_CXX_FLAGS="-I<libusb_include_dir> -I<libftdi1_include_dir>"
You may also need to add this if you see link errors between libusb and pthread:
-DLINK_CMAKE_THREADS=ON
To build the app:
$ mkdir build
$ cd build
$ cmake ../ # add -DBUILD_STATIC=ON to build a static version
# add -DENABLE_UDEV=OFF to disable udev support and -d /dev/xxx
$ cmake --build .
or
$ make -j$(nproc)
To install
$ sudo make install
The default install path is /usr/local, to change it, use
-DCMAKE_INSTALL_PREFIX=myInstallDir in cmake invokation.
By default, users have no access to converters. A rule file (99-openfpgaloader.rules) for udev is provided at the root directory of this repository. These rules set access right and group (plugdev) when a converter is plugged.
$ sudo cp 99-openfpgaloader.rules /etc/udev/rules.d/
$ sudo udevadm control --reload-rules && udevadm trigger # force udev to take new rule
$ sudo usermod -a YourUserName -G plugdev # add user to plugdev group
After that you need to unplug and replug your device.
openFPGALoader --help
Usage: openFPGALoader [OPTION...] BIT_FILE
openFPGALoader -- a program to flash cyclone10 LP FPGA
-b, --board=BOARD board name, may be used instead of cable
-c, --cable=CABLE jtag interface
-d, --device=DEVICE device to use (/dev/ttyUSBx)
--detect detect FPGA
--freq=FREQ jtag frequency (Hz)
-f, --write-flash write bitstream in flash (default: false, only for
Gowin and ECP5 devices)
--list-boards list all supported boards
--list-cables list all supported cables
--list-fpga list all supported FPGA
-m, --write-sram write bitstream in SRAM (default: true, only for
Gowin and ECP5 devices)
-o, --offset=OFFSET start offset in EEPROM
-r, --reset reset FPGA after operations
-v, --verbose Produce verbose output
-h, --help Give this help list
-V, --version Print program version
To have complete help
With board name:
openFPGALoader -b theBoard
(see openFPGALoader --list-boards)
With cable:
openFPGALoader -c theCable
(see openFPGALoader --list-cables)
With device node:
openFPGALoader -d /dev/ttyUSBX
Note: for some cable (like digilent adapters) signals from the converter are not just directly to the FPGA. For this case, the -c must be added.
Note: when -d is not provided, openFPGALoader will opens the first ftdi found, if more than one converter is connected to the computer, the -d option is the better solution
openFPGALoader [options] -r
openFPGALoader [options] /path/to/bitstream.ext
sof to svf generation:
quartus_cpf -c -q -g 3.3 -n 12.0MHz p project_name.sof project_name.svf
file load:
openFPGALoader -b cyc1000 project_name.svf
sof to rpd:
quartus_cpf -o auto_create_rpd=on -c -d EPCQ16A -s 10CL025YU256C8G project_name.svf project_name.jic
file load:
openFPGALoader -b cyc1000 -r project_name_auto.rpd
Note about SPI flash: svf file used to write in flash is just a bridge between FT2232 interfaceB configured in SPI mode and sfl primitive used to access EPCQ SPI flash.
Note about FT2232 interfaceB: This interface is used for SPI communication only when the dedicated svf is loaded in RAM, rest of the time, user is free to use for what he want.
To simplify further explanations, we consider the project is generated in the current directory.
Note: Spartan Edge Accelerator Board has only pinheader, so the cable must be provided
.bit file is the default format generated by vivado, so nothing special task must be done to generates this bitstream.
file load:
openFPGALoader -b arty *.runs/impl_1/*.bit
or
openFPGALoader -b spartanEdgeAccelBoard -c digilent_hs2 *.runs/impl_1/*.bit
.mcs must be generates through vivado with a tcl script like
set project [lindex $argv 0]
set bitfile "${project}.runs/impl_1/${project}.bit"
set mcsfile "${project}.runs/impl_1/${project}.mcs"
write_cfgmem -format mcs -interface spix4 -size 16 \
-loadbit "up 0x0 $bitfile" -loaddata "" \
-file $mcsfile -force
Note: -interface spix4 and -size 16 depends on SPI flash capability and size.
The tcl script is used with:
vivado -nolog -nojournal -mode batch -source script.tcl -tclargs myproject
file load:
openFPGALoader -b arty *.runs/impl_1/*.mcs
.jed file is the default format generated by Lattice Diamond, so nothing special must be done to generates this file.
file load:
openFPGALoader [-b yourboard] impl1/*.jed
where yourboard may be:
To generates .bit file Bitstream file must be checked under Exports Files in Lattice Diamond left panel.
file load:
openFPGALoader [-b yourboard] impl1/*.bit
where yourboard may be:
openFPGALoader [-b yourBoard] [-c yourCable] -m project_name/*.bit
By default, openFPGALoader load bitstream in memory, so the '-m' argument is optional
openFPGALoader [-b yourBoard] [-c yourCable] -f project_name/*.bit
To generates .mcs file PROM File must be checked under Exports Files in Lattice Diamond left panel.
openFPGALoader [-b yourBoard] [-c yourCable] project_name/*.mcs
.fs file is the default format generated by Gowin IDE, so nothing special must be done to generates this file.
Since the same file is used for SRAM and Flash a CLI argument is used to specify the destination.
with -m
file load (Trenz):
openFPGALoader -m -b littleBee impl/pnr/*.fs
file load (Tang Nano):
openFPGALoader -m -b tangnano impl/pnr/*.fs
with -f
file load:
openFPGALoader -f -b littleBee impl/pnr/*.fs