Go to file
ganeshgore 487bcd6734
[Bugfix] failing docker build + push on master branch (#196)
* [Build] Added MAKE_FLAGS variable to Makefile
+ Mainly too provide -j parallel execution option

* [Yosys] Corrected output filename in QLyosys

* Revert "[Build] Added MAKE_FLAGS variable to Makefile"

This reverts commit c5e9da985a.

* [Shellrun] Added nested tasks to shortcuts

* Test on docker optimization pull request

* Optimized docekrfile.env

* Added parallel build option to cmake

* Reverted CMAKE parallel build

* Updated docker_regression_tests

* Corrected OPENFPGA_PATH in dockerfile

* Trying to merge  artifact_regression_tests and docker_distribution

* Revert "Trying to merge  artifact_regression_tests and docker_distribution"

This reverts commit fba6996d59.

* Added CI/CD documentation docs

* Code cleanup in flow and task script

* Saved regression artifcats in case of failure

* Logged exception in run command

* Checking failed regression test artifact upload

* Fixed yosys bug

* Removed travis and few unused local file

* Added -batch option in openfpga_flow script

* Upload artifacts for debug on failed regression test

* Added OpenFPGA shell info in logger print

* Updated docs

* [Backup] openfpga.sh backedup before pull request

* [CI/CD] Added extra runtime dependencies

* [CI/CD] Updated runtime enviroment to python3.8

* [CD/CD] Removed restalling depedencies, can be done by rebuilding images

* [Docs] Corrected typo

* [CI/CD] Moved pip installation to dockerfile

* [CI/CD] Running regression test with run-task

* [Python3.8] Added alternate python version

* [Bugfix] Fixed missing files/dir while building master docker image on origin/master branch

* Removed extra files

* Removed extra files 2
2021-01-27 11:17:32 -07:00
.github [Bugfix] failing docker build + push on master branch (#196) 2021-01-27 11:17:32 -07: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
docker [Regression] Upgraded runtime enviroment to python3.8 2021-01-26 16:40:45 -07:00
docs [Docs] Added CI/CD docs 2021-01-26 16:26:43 -07:00
libopenfpga [Lib] Now try to call undefined command will cause a error code to return 2021-01-24 17:44:51 -07:00
libs bug fixing to constant string to display interconnect names 2020-04-07 18:28:19 -06:00
openfpga [Tool] Enhance return code for openfpga shell 2021-01-24 14:48:27 -07:00
openfpga_flow [Regression] Upgraded runtime enviroment to python3.8 2021-01-26 16:40:45 -07:00
vpr [Tool] Tileable rr_graph now accept I/Os in center grid 2020-12-04 17:43:35 -07:00
yosys@e6ff764e49 Bumping the latest yosys changes related to soft_adder support 2021-01-27 03:40:17 -08:00
.dockerignore [Regression] Upgraded runtime enviroment to python3.8 2021-01-26 16:40:45 -07:00
.gitignore Github action optimizations 2020-12-10 14:35:19 -07:00
.gitmodules Removing yosys-symbiflow-plugins submodule and will be added separately later via another PR 2020-12-10 21:06:08 -08:00
.readthedocs.yml [Doc] Add readthedoc setting file 2020-11-12 19:43:43 -07:00
CMakeLists.txt Removing yosys-symbiflow-plugins compilation from CMakefile 2020-12-10 21:44:57 -08: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 Broken link patch to fontpage README 2020-12-21 11:33:36 -07:00
openfpga.sh Script cleanup 2020-09-23 14:06:33 -06:00
requirements.txt [Bug] Fixed variable file location 2020-11-25 22:44:40 -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.

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

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
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 some tutorials in the ./tutorials folder. This will help you get more familiar with the tool and use OpenFPGA under different configurations.