utils: tests: vlog: add README files Signed-off-by: Karol Gugala <kgugala@antmicro.com>
diff --git a/tests/carry/README.md b/tests/carry/README.md new file mode 100644 index 0000000..d4783f5 --- /dev/null +++ b/tests/carry/README.md
@@ -0,0 +1,15 @@ +## CARRY tests + +This directory contains test for the `v2x_to_model.py` and `v2x_to_pb_type` tools. +The tests use model defined in cblock tests. +Those tests should check the following features: + +## Blackbox detection + + - [ ] model of the leaf pb\_type is generated + - [ ] leaf pb\_type xml is generated + - [ ] all dependecy models and pb\_types are included in the output files + +## Carry chain interence + + - [ ] automatic inference of carry chains - carry chains defined on ports of included blocks should be propagated to top level module
diff --git a/tests/carry/cblock/README.md b/tests/carry/cblock/README.md new file mode 100644 index 0000000..b0c5b7b --- /dev/null +++ b/tests/carry/cblock/README.md
@@ -0,0 +1,23 @@ +## CARRY tests + +This directory contains test for the `v2x_to_model.py` and `v2x_to_pb_type` tools. +The tests use models from other dsp test. +Those tests should check the following features: + +## Blackbox detection + + - [ ] model of the leaf pb\_type is generated + - [ ] leaf pb\_type xml is generated + - [ ] all dependecy models and pb\_types are included in the output files + +## Combinational connections + + - [ ] automatic inferrence of combinational connections between input and output ports + +## Carry chain interence + + - [ ] carry chains inferrence - carry chains defined on wires with `carry` attribute should be propagated to pb\_type xml file + +## Timings + + - [ ] all the timings defined in Verilog should be propagated to result pb\_type file
diff --git a/tests/dsp_combinational/README.md b/tests/dsp_combinational/README.md new file mode 100644 index 0000000..d83bc78 --- /dev/null +++ b/tests/dsp_combinational/README.md
@@ -0,0 +1,16 @@ +## dsp\_combinational tests + +This directory contains test for the blackbox detection for the +`v2x_to_model.py` and `v2x_to_pb_type` tools. + +Model from this test is used by other dsp tests + +## Detection of combinational connections + + - [ ] output has combinational connection with input + +## Blackbox detection + + - [ ] model of the leaf pb\_type is generated + - [ ] leaf pb\_type xml is generated +
diff --git a/tests/dsp_in_registered/README.md b/tests/dsp_in_registered/README.md new file mode 100644 index 0000000..da416a6 --- /dev/null +++ b/tests/dsp_in_registered/README.md
@@ -0,0 +1,18 @@ +## dsp\_in\_registered tests + +This directory contains test for the `v2x_to_model.py` and `v2x_to_pb_type` tools. +The tests use model from fig42-dff and dps\_combinational tests. +Those tests should check the following features: + + +## Detection of combinational connections + + - [ ] output has combinational connection with input + - [ ] pack\_pattern defined on wire connections with `pack` attribute + +## Blackbox detection + + - [ ] model of the leaf pb\_type is generated + - [ ] leaf pb\_type xml is generated + - [ ] all dependecy models and pb\_types are included in the output files +
diff --git a/tests/dsp_inout_registered/README.md b/tests/dsp_inout_registered/README.md new file mode 100644 index 0000000..63c12f0 --- /dev/null +++ b/tests/dsp_inout_registered/README.md
@@ -0,0 +1,18 @@ +## dsp\_inout\_registered tests + +This directory contains test for the `v2x_to_model.py` and `v2x_to_pb_type` tools. +The tests use model from fig42-dff and dps\_combinational tests. +Those tests should check the following features: + + +## Detection of combinational connections + + - [ ] output has combinational connection with input + - [ ] pack\_pattern defined on wire connetions with `pack` attribute + +## Blackbox detection + + - [ ] model of the leaf pb\_type is generated + - [ ] leaf pb\_type xml is generated + - [ ] all dependecy models and pb\_types are included in the output files +
diff --git a/tests/dsp_inout_registered_dualclk/README.md b/tests/dsp_inout_registered_dualclk/README.md new file mode 100644 index 0000000..95d9a2d --- /dev/null +++ b/tests/dsp_inout_registered_dualclk/README.md
@@ -0,0 +1,18 @@ +## dsp\_inout\_registered\_dualclk tests + +This directory contains test for the `v2x_to_model.py` and `v2x_to_pb_type` tools. +The tests use model from fig42-dff and dps\_combinational tests. +Those tests should check the following features: + + +## Detection of combinational connections + + - [ ] output has combinational connection with input + - [ ] pack\_pattern defined on wire connections with `pack` attribute + +## Blackbox detection + + - [ ] model of the leaf pb\_type is generated + - [ ] leaf pb\_type xml is generated + - [ ] all dependecy models and pb\_types are included in the output files +
diff --git a/tests/dsp_modes/README.md b/tests/dsp_modes/README.md new file mode 100644 index 0000000..0400f62 --- /dev/null +++ b/tests/dsp_modes/README.md
@@ -0,0 +1,17 @@ +## dsp\_modes tests + +This directory contains test for the `v2x_to_model.py` and `v2x_to_pb_type` tools. +The tests use models from other dsp test. +Those tests should check the following features: + +## Blackbox detection + + - [ ] model of the leaf pb\_type is generated + - [ ] leaf pb\_type xml is generated + - [ ] all dependecy models and pb\_types are included in the output files + +## Modes generation + + - [ ] all the modes from list defined with `MODES` attribute + - [ ] mode setting is included in pb\_type generation (correct part of logic is used) + - [ ] modes connections are generated correctly
diff --git a/tests/dsp_out_registered/README.md b/tests/dsp_out_registered/README.md new file mode 100644 index 0000000..02bf1b8 --- /dev/null +++ b/tests/dsp_out_registered/README.md
@@ -0,0 +1,18 @@ +## dsp\_out\_registered tests + +This directory contains test for the `v2x_to_model.py` and `v2x_to_pb_type` tools. +The tests use model from fig42-dff and dps\_combinational tests. +Those tests should check the following features: + + +## Detection of combinational connections + + - [ ] output has combinational connection with input + - [ ] pack\_pattern defined on wire connections with `pack` attribute + +## Blackbox detection + + - [ ] model of the leaf pb\_type is generated + - [ ] leaf pb\_type xml is generated + - [ ] all dependecy models and pb\_types are included in the output files +
diff --git a/tests/dsp_partial_registered/README.md b/tests/dsp_partial_registered/README.md new file mode 100644 index 0000000..655750e --- /dev/null +++ b/tests/dsp_partial_registered/README.md
@@ -0,0 +1,18 @@ +## dsp\_partial\_registered tests + +This directory contains test for the `v2x_to_model.py` and `v2x_to_pb_type` tools. +The tests use model from fig42-dff and dps\_combinational tests. +Those tests should check the following features: + + +## Detection of combinational connections + + - [ ] output has combinational connection with input + - [ ] pack\_pattern defined on wire connections with `pack` attribute + +## Blackbox detection + + - [ ] model of the leaf pb\_type is generated + - [ ] leaf pb\_type xml is generated + - [ ] all dependecy models and pb\_types are included in the output files +
diff --git a/tests/fig28-lutff-pair/README.md b/tests/fig28-lutff-pair/README.md new file mode 100644 index 0000000..eb2c1bc --- /dev/null +++ b/tests/fig28-lutff-pair/README.md
@@ -0,0 +1,15 @@ +## PAIR tests + +This directory contains test for the `v2x_to_model.py` and `v2x_to_pb_type` tools. +The tests use models defined in ff, lut and omux tests. +Those tests should check the following features: + +## Blackbox detection + + - [ ] model of the leaf pb\_type is generated + - [ ] leaf pb\_type xml is generated + - [ ] all dependecy models and pb\_types are included in the output files + +## Carry chain interence + + - [ ] pack\_pattern inferrence - pack\_patterns defined on wires with `pack` attributes should be propagated to pb\_type xmls
diff --git a/tests/fig28-lutff-pair/lut/README.md b/tests/fig28-lutff-pair/lut/README.md new file mode 100644 index 0000000..b979a6f --- /dev/null +++ b/tests/fig28-lutff-pair/lut/README.md
@@ -0,0 +1,18 @@ +## LUT tests + +This directory contains test for the `v2x_to_model.py` and `v2x_to_pb_type` tools. +Those tests should check the following features: + +## Blackbox detection + + - [ ] model of the leaf pb\_type is generated + - [ ] leaf pb\_type xml is generated + - [ ] all dependecy models and pb\_types are included in the output files + +## Carry chain interence + + - [ ] pack\_pattern inferrence - pack\_patterns defined on wires with `pack` attributes should be propagated to pb\_type xmls + +## Timings + + - [ ] timings defined for wires with `DELAY_MATRIX` attribute should be propagated to pb\_type xml
diff --git a/tests/fig41-full-adder/README.md b/tests/fig41-full-adder/README.md new file mode 100644 index 0000000..2af60b0 --- /dev/null +++ b/tests/fig41-full-adder/README.md
@@ -0,0 +1,17 @@ +## Adder tests + +This directory contains test for the blackbox detection for the +`v2x_to_model.py` and `v2x_to_pb_type` tools. + +## Detection of combinational connections + + - [ ] output has combinational connection with input + +## Blackbox detection + + - [ ] model of the leaf pb\_type is generated + - [ ] leaf pb\_type xml is generated + +## Timings + + - [ ] all the timings defined for wires with attributes should be included in pb\_type xml
diff --git a/tests/fig42-dff/README.md b/tests/fig42-dff/README.md new file mode 100644 index 0000000..f412e7f --- /dev/null +++ b/tests/fig42-dff/README.md
@@ -0,0 +1,17 @@ +## Dff tests + +This directory contains tests for the `v2x_to_model.py` and `v2x_to_pb_type` tools. + +## Clock associations inferrence + + - [ ] automatic inferrence is signal is associated with any clock and include the info in the model + - [ ] automatic clock detection (signals named `clk` are considered as clocks) + +## Blackbox detection + + - [ ] model of the leaf pb\_type is generated + - [ ] leaf pb\_type xml is generated + +## Timings + + - [ ] all the timings defined for wires with attributes should be included in pb\_type xml
diff --git a/tests/logicbox/README.md b/tests/logicbox/README.md new file mode 100644 index 0000000..892bb73 --- /dev/null +++ b/tests/logicbox/README.md
@@ -0,0 +1,16 @@ +## Dff tests + +This directory contains tests for the `v2x_to_model.py` and `v2x_to_pb_type` tools. + +## Combinational connection inferrence + + - [ ] automatic inferrence of combinational connection between input and output signals + +## Blackbox detection + + - [ ] model of the leaf pb\_type is generated + - [ ] leaf pb\_type xml is generated + +## Timings + + - [ ] all the timings defined for wires with attributes should be included in pb\_type xml
diff --git a/tests/multiple_instance/README.md b/tests/multiple_instance/README.md new file mode 100644 index 0000000..d66ec3d --- /dev/null +++ b/tests/multiple_instance/README.md
@@ -0,0 +1,13 @@ +## Multiple instance tests + +This directory contains tests for the `v2x_to_model.py` and `v2x_to_pb_type` tools. + +## Blackbox detection + + - [ ] model of the leaf pb\_type is generated + - [ ] leaf pb\_type xml is generated + - [ ] automatic inclusion of sub modules in model and pb\_type files + +## Pack pattern inferrence + + - [ ] automatic pack patern inferrence for all the direct internal module connetions
diff --git a/tests/muxes/README.md b/tests/muxes/README.md new file mode 100644 index 0000000..e7bfb7a --- /dev/null +++ b/tests/muxes/README.md
@@ -0,0 +1,13 @@ +## Routuing muxes tests + +This directory contains tests for the `v2x_to_model.py` and `v2x_to_pb_type` tools. + +## Blackbox detection + + - [ ] model of the leaf pb\_type is generated + - [ ] leaf pb\_type xml is generated + - [ ] automatic inclusion of sub modules in model and pb\_type files + +## Routing muxes inferrence + + - [ ] routing muxes should not generate model files and pb\_types but rather routing elements
diff --git a/tests/simple_pll/README.md b/tests/simple_pll/README.md new file mode 100644 index 0000000..cec4628 --- /dev/null +++ b/tests/simple_pll/README.md
@@ -0,0 +1,15 @@ +## PLL tests + +This directory contains tests for the `v2x_to_model.py` and `v2x_to_pb_type` tools. + +## Clock associations inferrence + + - [ ] automatic inferrence is signal is associated with any clock and include the info in the model + - [ ] automatic clock detection (signals named `*clk*` are considered as clocks) + - [ ] signals marked with `CLOCK` attributes should be considered as clocks + +## Blackbox detection + + - [ ] model of the leaf pb\_type is generated + - [ ] leaf pb\_type xml is generated +