Go to file
tangxifan e510e79c12 [Flow] Add openfpga shell example script to use fabric netlist option 2020-10-12 12:42:43 -06:00
.github/ISSUE_TEMPLATE Update bug_report.md 2020-09-20 17:24:29 -06:00
.travis [Regression test] Add new test case to CI 2020-10-10 20:29:00 -06:00
abc Add latest abc and update ace dependence 2019-05-03 18:56:03 -06:00
ace2 Now we use the ace from VTR 2019-07-16 17:00:09 -06:00
cmake copy missing cmake modules from vtr project 2020-01-03 21:57:19 -05:00
docs [Documentation] Update for new options in fpga-verilog 2020-10-12 12:36:24 -06:00
libopenfpga [OpenFPGA Tool] Add XML syntax for configurable regions 2020-09-28 13:51:43 -06:00
libs bug fixing to constant string to display interconnect names 2020-04-07 18:28:19 -06:00
openfpga [Tool] Now users can specify a different fabric netlist when generating Verilog testbench 2020-10-12 12:31:51 -06:00
openfpga_flow [Flow] Add openfpga shell example script to use fabric netlist option 2020-10-12 12:42:43 -06:00
vpr [OpenFPGA Tool] Bug Fix on the tileable RRG for multi segment 2020-09-22 12:47:02 -06:00
yosys use adapt yosys Makefile for OpenFPGA framework 2019-11-27 14:42:47 -07:00
.dockerignore Added dockerignore + minor changes in openfpga_flow script 2019-08-17 16:22:52 -06:00
.gitignore modify the git ignore list for ctags so that we only ignore those tags in specific folders 2020-01-03 21:17:40 -07:00
.travis.yml [Regression Tests] Add gcc-5 compatibility test to Travis CI 2020-09-14 20:14:16 -06:00
CMakeLists.txt remove obselete codes and update regression tests 2020-07-04 17:31:34 -06:00
Dockerfile [Documentation] Use release mode in Docker settings 2020-09-20 15:00:56 -06:00
LICENSE Create LICENSE 2018-06-26 21:52:08 -07:00
README.md [Documentation] Fix the path to OpenFPGA logo in the README 2020-10-10 21:44:18 -06:00
deploy_key.enc Updated Encrypt Key 2019-11-02 16:37:00 -06:00
openfpga.sh Script cleanup 2020-09-23 14:06:33 -06:00
run_local.bat Working lattice benchmark unclean commit 2019-08-08 18:08:39 -06:00
run_local.sh Added build files in .gitignore 2019-08-17 22:59:54 -06:00

README.md

Getting Started with OpenFPGA

Build Status Documentation Status

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. 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 here.

Compilation Steps:

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

cmake3.12 is recommended to compile OpenFPGA with GUI

Quick Compilation Verification To quickly verify the tool is well compiled, user can run the following command from OpenFPGA root repository.

python3 openfpga_flow/scripts/run_fpga_task.py compilation_verification --debug --show_thread_logs

Python3 and iVerilog v10.1+ are required. GUI will pop-up if enabled during compilation.

Supported Operating Systems We currently target OpenFPGA for:

  1. Ubuntu 18.04
  2. Red Hat 7.5

The tool was tested with these operating systems. It might work with earlier versions and other distributions.

Documentation

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

Tutorials

You can find some tutorials in the ./tutorials folder. This will help you get more familiar with the tool and use OpenFPGA under different configurations.