Go to file
tangxifan e7a245c2c4
Merge branch 'master' into yosys_update
2021-06-23 10:40:07 -06:00
.github Merge branch 'master' into yosys_update 2021-06-23 09:16:52 -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 Removing cmake file which is no longer required 2021-04-14 05:50:21 -07:00
docker Fixing regression errors 2021-04-14 05:35:04 -07:00
docs Merge branch 'master' into tutorials 2021-06-16 14:00:31 -06:00
libopenfpga [Tool] Add postfix removal support in write_io_mapping command 2021-06-18 16:13:50 -06:00
libs [Tool] Patch to remove compiler warnings 2021-02-04 16:54:04 -07:00
openfpga Merge branch 'master' into dev 2021-06-23 09:15:03 -06:00
openfpga_flow Merge branch 'master' into yosys_update 2021-06-23 09:16:52 -06:00
vpr [Tool] Add illustrative comments to tileable rr_graph generator 2021-04-26 11:57:17 -06:00
yosys@40d9e120fa Updating yosys submodule to mainstream yosys 2021-04-14 05:35:04 -07:00
yosys-plugins@9e969e29c7 Updating yosys-plugins with the latest checkins 2021-04-14 05:50:21 -07:00
.dockerignore Updating yosys install path 2021-04-14 05:35:05 -07:00
.gitignore Github action optimizations 2020-12-10 14:35:19 -07:00
.gitmodules Adding yosys-symbiflow-plugins to support QuickLogic devices in yosys 2021-04-14 05:35:04 -07:00
.readthedocs.yml Support SVG in Sphinx Latex building (#220) 2021-02-07 18:53:16 -07:00
CMakeLists.txt Merge branch 'master' into yosys_update 2021-06-23 09:16:52 -06:00
LICENSE Create LICENSE 2018-06-26 21:52:08 -07:00
Makefile Adding target compile in Makefile that just compiles without updating submodules 2020-12-14 09:25:50 -08:00
README.md Update README.md 2021-04-14 05:50:21 -07:00
openfpga.sh Updating script to fix CI issue 2021-04-14 05:47:16 -07:00
requirements.txt [Cleanup] Removed deadcode 2021-02-03 10:35:14 -07:00

README.md

Getting Started with OpenFPGA

linux build Documentation Status

Introduction

The award-winning 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.

If this is the first time you learn OpenFPGA, we strongly recommend you to watch the introduction video about OpenFPGA

A quick overview of OpenFPGA tools can be found here. We also recommend potential users to checkout the summary of technical capabilities before compiling.

Compilation

A tutorial video about how-to-compile can be found here

Before start, we strongly recommend you to read the required dependencies at compilation guidelines. It also includes detailed information about docker image.


Compilation Steps:

# Clone the repository and go inside it
git clone https://github.com/LNIS-Projects/OpenFPGA.git && cd OpenFPGA
source openfpga.sh
make all

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 a set of tutorials, with which you get familiar with the tool and use OpenFPGA in various purposes.