From cadf29022ebea8dcbb97d659ba133a95d5aeb6a0 Mon Sep 17 00:00:00 2001 From: tangxifan Date: Tue, 28 Jul 2020 13:44:06 -0600 Subject: [PATCH] add README to explain the organization of regression tests --- openfpga_flow/tasks/README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 openfpga_flow/tasks/README.md diff --git a/openfpga_flow/tasks/README.md b/openfpga_flow/tasks/README.md new file mode 100644 index 000000000..930a2d4dd --- /dev/null +++ b/openfpga_flow/tasks/README.md @@ -0,0 +1,23 @@ +# Regression tests for OpenFPGA +The regression tests are grouped in category of OpenFPGA tools as well as integrated flows. +The principle is that each OpenFPGA tool should have a set of regression tests. + +- compilation\_verfication: a quicktest after compilation + +- Basic regression tests should focus on fundamental flow integration, such as + + - Yosys + VPR + OpenFPGA for a Verilog-to-Verification flow-run + +- FPGA-Verilog regression tests should focus on testing fabric correctness, such as + + - VPR + OpenFPGA integration for a BLIF-to-Verification flow-run + + +- FPGA-Bitstream regression tests should focus on testing bitstream correctness and runtime on large devices and benchmark suites + +- FPGA-SDC regression test should focus on SDC file generation and necessary syntax check + +- FPGA-SPICE regression test should focus on SPICE netlist generation / compilation and SPICE simulations qwith QoR checks. + + +Please keep this README up-to-date on the OpenFPGA tools