Getting Started with OpenFPGA

Introduction

The OpenFPGA framework is the first open-source FPGA IP generator supporting highly-customizable homogeneous FPGA architectures. OpenFPGA provides a full set of EDA support for customized FPGAs, including Verilog-to-bitstream generation and self-testing verification testbenches/scripts. OpenFPGA opens the door to democratizing FPGA technology and EDA techniques, with agile prototyping approaches and constantly evolving EDA tools for chip designers and researchers.

Compilation

Dependencies and help using docker can be found at ./tutorials/building.md.

Compilation steps:

1. git clone https://github.com/LNIS-Projects/OpenFPGA.git && cd OpenFPGA # Clone the repository and go into it
2. mkdir build && cd build # Create a folder named build in OpenPFGA repository
3. cmake .. -DCMAKE_BUILD_TYPE=debug # Create Makefile in this folder using cmake
4. make # Compile the tool and its dependencies

We currently implemented OpenFPGA for:
1. Ubuntu 16.04
2. Red Hat 7.5
3. MacOS Mojave 10.13.4

Please note that those were the versions we tested the software for. It might work with earlier versions and other distributions.

Documentation

OpenFPGA's full documentation includes tutorials, descriptions of the design flow, and tool options.

Tutorial

You can find in the folder ./tutorials. This will help you get in touch with the software and test different configurations to see how OpenFPGA reacts to them.

Through this tutorial users can learn how to use the flow and set the dependancies.
The tutorial index will guide you through trainings and explain folder oraganization as well as referencing tips and used keywords.