OpenFPGA/tutorials/tutorial.md

Tutorial

This tutorial purpose it to clarify how to use:

1. The full flow using fpga_flow.pl script
2. Architecture customization

Some keywords will be used during this tutorial:

• OPENFPGAPATHKEYWORD: refers to OpenFPGA folder full path

Folder organization

OpenFPGA repository is organized as follow:

• abc: open source synthesys tool
• ace2: abc extension generating .act files
• vpr7_x2p: sources of modified vpr
• yosys: opensource synthesys tool
• fpga_flow: scripts and dependencies to run the complete flow

1. FPGA flow

The folder is organized as follow:

• arch: contains architectures description files
• benchmarks: contains Verilog and blif benchmarks + lists
• configs: contains configuration files to run fpga_flow.pl
• scripts: contains all the scripts required to run the flow
• tech: contains xml tech files for power estimation

fpga_flow.pl is saved in OPENFPGAPATHKEYWORD/fpga_flow/scripts. If we look in this folder, we can find some other scripts as:

• pro_blif.pl: rewrite a blif which has only 3 members in a .latch module
• rewrite_path_in_file.pl: target a keyword in a file and replace it

Any script provides help if launch without argument

fpga_flow.pl has dependencies which need to be configured. They are:

• configuration file, which provides dependencies path and flow type
• benchmark list file

a. Configuration file

In this file paths have to be full path. Relative path could lead to errors.
The file is organized in 3 parts:

• dir_path: provides all the tools and repository path
• flow_conf: provides information on how the flow run
• csv_tags: to complete

While empty the file is as follow:

[dir_path]
script_base = OPENFPGAPATHKEYWORD/fpga_flow/scripts
benchmark_dir =
yosys_path = OPENFPGAPATHKEYWORD/yosys
odin2_path = not_used
cirkit_path = not_used
abc_path = OPENFPGAPATHKEYWORD/abc
abc_mccl_path = OPENFPGAPATHKEYWORD/abc
abc_with_bb_support_path = OPENFPGAPATHKEYWORD/abc
mpack1_path = not_used
m2net_path = not_used
mpack2_path = not_used
vpr_path = OPENFPGAPATHKEYWORD/vpr7_x2p/vpr
rpt_dir =
ace_path = OPENFPGAPATHKEYWORD/ace2

[flow_conf]
flow_type = yosys_vpr to use verilog input
vpr_arch =
mpack1_abc_stdlib = DRLC7T_SiNWFET.genlib # Use relative path under ABC folder is OK
m2net_conf = not_used
mpack2_arch = not_used
power_tech_xml =

[csv_tags] to complete
mpack1_tags = Global mapping efficiency:|efficiency:|occupancy wo buf:|efficiency wo buf:
mpack2_tags = BLE Number:|BLE Fill Rate:
vpr_tags = Netlist clb blocks:|Final critical path:|Total logic delay:|total net delay:|Total routing area:|Total used logic block area:|Total wirelength:|Packing took|Placement took|Routing took|Average net density:|Median net density:|Recommend no. of clock cycles:
vpr_power_tags = PB Types|Routing|Switch Box|Connection Box|Primitives|Interc Structures|lut6|ff

An example of this file can be found at OPENFPGAPATHKEYWORD/fpga_flow/configs/tutorial/tuto.conf

b. Benchmark list

The benchmark folder contains 3 sub-folders:

• Blif: contains .blif and .act of benchmarks
• List: contains all benchmark list files
• Verilog: contains Verilog designs

Blif and Verilog folders are organized by folders with the name of projects. Folder, top module and top module file must share the same name.
The benchmark list file can contain as many benchmarks as available in the same folder targetted by "benchmark_dir" variable from the configuration file. It's written as:
top_module/*.v,<int_value>; where <int_value> is the number of channel/wire between each block.

An example of this file can be found at OPENFPGAPATHKEYWORD/fpga_flow/benchmarks/List/tuto_benchmark.txt

c. Running fpga_flow.pl

Once the configuration is done, we can select which option we want to enable in fpga_flow. fpga_flow options don't exactly have the name of those listed in the documentation, which are used on the modifed version of vpr. Indeed, where vpr will take an option as "--fpga_XXX" fpgs_flow will call it "-vpr_fpga_XXX".
Few options are only in fpga_flow:

• -N: number of LUT per CLB
• -K: LUT size/ number of input
• -rpt : specifies wherever fpga_flow will write its report
• -ace_d <int_value>: specifies inputs average probability of switching
• -multi_thread <int_value>: specifies number of core to use
• -end_flow_with_test: uses Icarus Verilog to verify generated netlist

An script example can be found at OPENFPGAPATHKEYWORD/fpga_flow/tuto_fpga_flow.sh