Note
We recommend you to watch a tutorial video about how-to-compile before getting started
.. only:: html .. youtube:: F9sMRmDewM0
OpenFPGA is continously tested with Ubuntu 22.04 and partially on Ubuntu 20.04 It might work with earlier versions and other distributions.
In addition to continous integration, our community users have tested OpenFPGA on their local machines using the following operating systems:
- CentOS 7.8
- CentOS 8
- Ubuntu 18.04
- Ubuntu 21.04
OpenFPGA uses CMake to generate the Makefile scripts. In general, please follow the steps to compile
git clone https://github.com/LNIS-Projects/OpenFPGA.git
cd OpenFPGA
make all
Note
OpenFPGA requires gcc/g++ version > 9 and clang version > 10.
Note
cmake3.12+ is recommended to compile OpenFPGA with GUI
Note
Recommend using make -j<int>
to accelerate the compilation, where <int>
denotes the number of cores to be used in compilation.
Note
VPR's GUI requires gtk-3, and can be enabled with make .. CMAKE_FLAGS="-DVPR_USE_EZGL=on"
Quick Compilation Verification
Note
Ensure that you install python dependences in :ref:`tutorial_compile_dependencies`.
To quickly verify the tool is well compiled, users can run the following command from OpenFPGA root repository
python3 openfpga_flow/scripts/run_fpga_task.py compilation_verification --debug --show_thread_logs
General build targets are available in the top-level makefile. Call help desk to see details
make help
The following options are available for a custom build
.. option:: BUILD_TYPE=<string> Specify the type of build. Can be either ``release`` or ``debug``. By default, release mode is selected (full optimization on runtime)
.. option:: CMAKE_FLAGS=<string> Force build flags to CMake. The following flags are available - ``DOPENFPGA_WITH_TEST=[ON|OFF]``: Enable/Disable the test build - ``DOPENFPGA_WITH_YOSYS=[ON|OFF]``: Enable/Disable the build of yosys. Note that when disabled, the build of yosys-plugin is also disabled - ``DOPENFPGA_WITH_YOSYS_PLUGIN=[ON|OFF]``: Enable/Disable the build of yosys-plugin. - ``DOPENFPGA_WITH_VERSION=[ON|OFF]``: Enable/Disable the build of version number. When disabled, version number will be displayed as an empty string. - ``DOPENFPGA_WITH_SWIG=[ON|OFF]``: Enable/Disable the build of SWIG, which is required for integrating to high-level interface. - ``OPENFPGA_ENABLE_STRICT_COMPILE=[ON|OFF]``: Specifies whether compiler warnings should be treated as errors (e.g. -Werror)
Warning
By default, only required modules in Verilog-to-Routing (VTR) is enabled. On other words, abc
, odin
, yosys
and other add-ons inside VTR are not built. If you want to enable them, please look into the dedicated options of CMake scripts.
.. option:: CMAKE_GOALS=<string> Specify the build target for CMake system. For example, ``cmake_goals=openfpga`` indicates that only openfpga binary will be compiled. For a detailed list of targets, use ``make list_cmake_targets`` to show. By default, all the build targets will be included.
Dependencies can be installed upon the use of OpenFPGA on different systems In general, OpenFPGA requires specific versions for the following dependencies:
cmake: | version >3.12 for graphical interface |
---|---|
iverilog: | version 10.3+ is required to run Verilog-to-Verification flow |
- Dependencies required to build the code base
- Dependencies required to run regression tests
Note
Python packages are also required
python3 -m pip install -r requirements.txt
- Dependencies required to build documentation
- Dependencies required to build the code base
- Dependencies required to run regression tests
Note
Python packages are also required
python3 -m pip install -r requirements.txt
- Dependencies required to build documentation
Users can skip the traditional installation process by using the Dockerized version of the OpenFPGA tool. The OpenFPGA project maintains the docker image/Github package of the latest stable version of OpenFPGA in the following repository openfpga-master. This image contains precompiled OpenFPGA binaries with all prerequisites installed.
# To get the docker image from the repository,
docker pull ghcr.io/lnis-uofu/openfpga-master:latest
# To invoke openfpga_shell
docker run -it ghcr.io/lnis-uofu/openfpga-master:latest openfpga/openfpga bash
# To run the task that already exists in the repository.
docker run -it ghcr.io/lnis-uofu/openfpga-master:latest bash -c "source openfpga.sh && run-task compilation_verification"
# To link the local directory wihth docker
mkdir work
docker run -it -v work:/opt/openfpga/ ghcr.io/lnis-uofu/openfpga-master:latest bash
# Inside container
source openfpga.sh
cd work
create_task _my_task yosys_vpr