os-fpga / yosys_verific_rs

Yosys + (Optional) Verific Integration

Introduction

This repository is designed for the Yosys + (Optional) Verific support. The open-source Yosys has extensive Verilog-2005 support while Verific adds complete support for SystemVerilog IEEE-1800, UPF IEEE-1801 and VHDL IEEE-1076 standards. The repository contains yosys_rs, and open-source HDL projects as submodules, which are going to be used for the Synthesis and Verification. It also contains Yosys template scripts which can be used in the OpenFPGA tasks for the yosys_vpr flow. These scripts are designed to be used only with Yosys with Verific enabled. Contact Verific directly to subscribe the optional Verific License. Contact [e-mail] for support with the Verific integration in this repo.

Requirements

The list of dependencies:

• Ubuntu
• Centos
• MacOS

Repository Structure

.
|-- analyze
|-- RTL_Benchmark
|-- benchmarks
|-- logic_synthesis-rs
|-- scripts
|-- suites
|-- Raptor_Tools
|-- yosys
|-- yosys-plugins
`-- yosys-rs-plugin
    

The repository has the following submodules:

• yosys
• yosys-plugins
• yosys-rs-plugin
• Raptor_Tools
• logic_synthesis-rs
• RTL_Benchmark

The directory structure is the following:

• analyze directory contains analyze tool and it's unit tests.
• benchmarks directory contains benchmark open-source designs - SHOULD BE REMOVED:
  • verilog holds Verilog language desings.
  • mixed_languages holds mixed language desings.
  • vhdl holds VHDL submodule designs.
• suites directory contains benchmark suites which can be automatically run by the automation scripts available at scripts/synth.
• scripts directory contains automation scripts:
  • benchmarks holds Yosys synthesis scripts for the available benchmarks.
  • log_automation holds the automation scripts to extract metrics from tools output log files.
  • synth holds the automation scripts to run synthesis on different tools.
  • task_generator holds the OpenFPGA tasks generator script and it's default settings JSON file.
  • yosys_templates holds the OpenFPGA Yosys template scripts which are written to use the verific frontend.
• Raptor_Tools directory contains Raptor_Tools submodule which has Flex_LM library and verific_rs submodule.
• yosys directory contains Yosys submodule.
• yosys-plugins directory contains yosys-symbiflow-plugins submodule.
• yosys-rs-plugin directory contains yosys-rs-plugin submodule.
• logic_synthesis-rs directory contains logic_synthesis-rs submodule which has DE and abc_rs submodule.
• RTL_Benchmark directory contains RTL_Benchmark submodule.

Build

Run release Makefile target to build Yosys with Verific enabled:

make release

Provide PRODUCTION_BUILD=ON option to build in production mode:

make release PRODUCTION_BUILD=ON

Run install Makefile target to build and install Yosys with Verific enabled:

make install PREFIX=<INSTALL_DIR>

All available Makefile targets can be seen running help target:

make help

Note: If you would like to update your local repository and build, then run the following commands.

  cd yosys_verific_rs
  git pull
  make UPDATE_SUBMODULES=ON

Running tests

Initialize/update RTL_Benchmark submodule:

git submodule update --init --recursive --progress RTL_Benchmark

Execute python script to run suite of benchmarks:

python3 scripts/synth/synthesis.py --config_files suites/Golden/Golden_synth_rs_ade_with_bram_with_dsp.json

How to generate yosys+verific OpenFPGA tasks

To generate tasks with default configurations/settings the following command should be run:

python3 scripts/task_generator/run_task_generator.py PATH_TO_OPENFPGA_ROOT --debug

To generate tasks with specific configurations/settings the following command should be run:

python3 scripts/task_generator/run_task_generator.py PATH_TO_OPENFPGA_ROOT --settings_file SPECIFIC_SETTINGS.json --debug

Detailed information regarding OpenFPGA tasks generation can be found here.