Go to file
tangxifan c220438c42 [doc] adding new syntax that supports separated clocks for multi-head configuration chains 2023-04-21 15:21:34 +08:00
.github [script] now split make checkout and make compile 2023-04-19 11:19:27 +08:00
cmake [script] added missing paths to include for swig 2022-12-01 13:29:03 -08:00
dev [script] debugging check format script 2022-10-06 19:13:13 -07:00
docker [script] correct paths related to yosys in docker image and ci 2023-02-04 13:18:42 -08:00
docs [doc] adding new syntax that supports separated clocks for multi-head configuration chains 2023-04-21 15:21:34 +08:00
libs [core] format 2023-03-05 22:32:05 -08:00
openfpga [core] code format 2023-04-20 15:07:54 +08:00
openfpga_flow [test] deploy new test to regression tests 2023-04-20 15:06:47 +08:00
vtr-verilog-to-routing@d70659f424 [core] update vtr 2023-04-18 16:46:43 +08:00
yosys@a9c792dcee Bump yosys from `1010756` to `a9c792d` 2023-04-17 07:00:11 +00:00
yosys-plugins@96a0853eba Bump yosys-plugins from `794ff73` to `96a0853` 2023-04-18 06:58:49 +00:00
.clang-format [ci] add C/C++ code format style file 2022-10-06 16:44:05 -07:00
.dockerignore [CiFix] Docker image 2022-08-29 00:40:37 -06:00
.gitignore [script] enable shared library for openfpga 2022-12-01 11:42:25 -08:00
.gitmodules [yosys] update to v0.22 2022-10-21 16:57:00 -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 xt_clk_arch 2023-04-19 22:17:33 +08:00
Dockerfile Updated docker version 2023-02-12 12:36:53 -07:00
LICENSE Create LICENSE 2018-06-26 21:52:08 -07:00
Makefile [script] revert back the old make all recipe 2023-04-19 11:11:24 +08:00
README.md [doc] add references 2022-12-06 15:40:03 -08:00
VERSION.md Updated Patch Count 2023-04-21 00:02:29 +00:00
openfpga.sh Update openfpga.sh 2023-04-04 14:11:26 +03:00
requirements.txt [test] adding a new test to show how to automate generation of bus group files 2023-01-11 16:59:54 -08:00

README.md

Getting Started with OpenFPGA

Test Cell Library Tests Code style: black Documentation Status Binder

Version: see VERSION.md

Introduction

The award-winning OpenFPGA framework is the first open-source FPGA IP generator with silicon proofs supporting highly-customizable FPGA architectures. OpenFPGA provides complete 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 your first time working with OpenFPGA, we strongly recommend you watch the introduction video about OpenFPGA

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

Before asking for help, please checkout the Frequently Asked Questions

Compilation

A tutorial video about how to compile can be found here

Detailed guidelines are available at compilation guidelines. Before starting, we strongly recommend you read the required dependencies and ensure that they are correctly installed. It also includes detailed information about the docker image.

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 for various purposes.

Backward Compatibility

If you were using an old version of OpenFPGA and are now interested to move to the latest version, please check out the developer guidelines.

License

All the codes are under MIT license, with the exception of submodules, e.g., VTR, Yosys and Yosys-plugin, which are distributed under its own (permissive) terms. See their full license for details.

How to Cite

Please use the following paper as a general citation for OpenFPGA:

X. Tang, E. Giacomin, B. Chauviere, A. Alacchi and P. -E. Gaillardon, "OpenFPGA: An Open-Source Framework for Agile Prototyping Customizable FPGAs," in IEEE Micro, vol. 40, no. 4, pp. 41-48, 1 July-Aug. 2020, doi: 10.1109/MM.2020.2995854.

Bibtex:

@ARTICLE{9098028,  author={Tang, Xifan and Giacomin, Edouard and Chauviere, Baudouin and Alacchi, Aurélien and Gaillardon, Pierre-Emmanuel},  journal={IEEE Micro},   title={OpenFPGA: An Open-Source Framework for Agile Prototyping Customizable FPGAs},   year={2020},  volume={40},  number={4},  pages={41-48},  doi={10.1109/MM.2020.2995854}}

A list of related publications can be found here.

Contributing to OpenFPGA

Please read the contributor guidelines if you would like to contribute to OpenFPGA.