Rearranged pack-pattern tests/examples

Signed-off-by: Maciej Kurc <mkurc@antmicro.com>
chipsalliance · Dec 22, 2020 · 00dff88 · 00dff88
1 parent 9480f75
commit 00dff88
Show file tree

Hide file tree

Showing 20 changed files with 34 additions and 24 deletions.
diff --git a/tests/pack_pattern/README.rst b/tests/pack_pattern/README.rst
@@ -1,25 +1,10 @@
-Pack pattern annotation
-+++++++++++++++++++++++
+.. Examples for pack-pattern annotations
 
-This example shows that v2x prevents annotating a top-level port of a pb_type 
-when a net of that port is forking. This enables using pack patterns, 
-e.g., for LUT to FF connections when the LUT output is also connected to 
-a top-level output port. 
+Pack patterns
+=============
 
-.. symbolator:: pack_pattern.sim.v
+These are examples of pack-pattern annotation of connections between cells.
 
-.. verilog-diagram:: pack_pattern.sim.v
-   :type: netlistsvg
-   :module: PACK_PATTERN
-
-.. no-license::  pack_pattern.sim.v
-   :language: verilog
-   :caption: pack_pattern.sim.v
-
-.. no-license:: pack_pattern.model.xml
-   :language: xml
-   :caption: pack_pattern.model.xml
-
-.. no-license:: pack_pattern.pb_type.xml
-   :language: xml
-   :caption: pack_pattern.pb_type.xml
+.. toctree::
+   multiple/README.rst
+   forking/README.rst
diff --git a/tests/pack_pattern/forking/README.rst b/tests/pack_pattern/forking/README.rst
@@ -0,0 +1,25 @@
+Forking net annotation
+++++++++++++++++++++++
+
+This example shows that v2x prevents annotating a top-level port of a pb_type 
+when a net of that port is forking. This enables using pack patterns, 
+e.g., for LUT to FF connections when the LUT output is also connected to 
+a top-level output port. 
+
+.. symbolator:: pack_pattern.sim.v
+
+.. verilog-diagram:: pack_pattern.sim.v
+   :type: netlistsvg
+   :module: PACK_PATTERN
+
+.. no-license::  pack_pattern.sim.v
+   :language: verilog
+   :caption: pack_pattern.sim.v
+
+.. no-license:: pack_pattern.model.xml
+   :language: xml
+   :caption: pack_pattern.model.xml
+
+.. no-license:: pack_pattern.pb_type.xml
+   :language: xml
+   :caption: pack_pattern.pb_type.xml
diff --git a/tests/pack_pattern/dff/dff.sim.v → tests/pack_pattern/forking/dff/dff.sim.v b/tests/pack_pattern/dff/dff.sim.v → tests/pack_pattern/forking/dff/dff.sim.v
diff --git a/tests/pack_pattern/dff/golden.model.xml → ...pack_pattern/forking/dff/golden.model.xml b/tests/pack_pattern/dff/golden.model.xml → ...pack_pattern/forking/dff/golden.model.xml
diff --git a/tests/pack_pattern/dff/golden.pb_type.xml → ...ck_pattern/forking/dff/golden.pb_type.xml b/tests/pack_pattern/dff/golden.pb_type.xml → ...ck_pattern/forking/dff/golden.pb_type.xml
diff --git a/tests/pack_pattern/golden.model.xml → tests/pack_pattern/forking/golden.model.xml b/tests/pack_pattern/golden.model.xml → tests/pack_pattern/forking/golden.model.xml
diff --git a/tests/pack_pattern/golden.pb_type.xml → ...s/pack_pattern/forking/golden.pb_type.xml b/tests/pack_pattern/golden.pb_type.xml → ...s/pack_pattern/forking/golden.pb_type.xml
diff --git a/tests/pack_pattern/lut/golden.model.xml → ...pack_pattern/forking/lut/golden.model.xml b/tests/pack_pattern/lut/golden.model.xml → ...pack_pattern/forking/lut/golden.model.xml
diff --git a/tests/pack_pattern/lut/golden.pb_type.xml → ...ck_pattern/forking/lut/golden.pb_type.xml b/tests/pack_pattern/lut/golden.pb_type.xml → ...ck_pattern/forking/lut/golden.pb_type.xml
diff --git a/tests/pack_pattern/lut/lut4.sim.v → tests/pack_pattern/forking/lut/lut4.sim.v b/tests/pack_pattern/lut/lut4.sim.v → tests/pack_pattern/forking/lut/lut4.sim.v
diff --git a/tests/pack_pattern/pack_pattern.sim.v → ...s/pack_pattern/forking/pack_pattern.sim.v b/tests/pack_pattern/pack_pattern.sim.v → ...s/pack_pattern/forking/pack_pattern.sim.v
diff --git a/tests/multi_pack_pattern/README.rst → tests/pack_pattern/multiple/README.rst b/tests/multi_pack_pattern/README.rst → tests/pack_pattern/multiple/README.rst
@@ -1,5 +1,5 @@
-Pack pattern annotation example
-+++++++++++++++++++++++++++++++
+Multiple pack pattern annotation example
+++++++++++++++++++++++++++++++++++++++++
 
 VPR requires that connections between primitives that need to be packed together be annotated with pack patterns. Moreover, a single connection may have multiple pack pattern annotations.
 

diff --git a/tests/multi_pack_pattern/block.sim.v → tests/pack_pattern/multiple/block.sim.v b/tests/multi_pack_pattern/block.sim.v → tests/pack_pattern/multiple/block.sim.v
diff --git a/tests/multi_pack_pattern/ff/ff.pb_type.xml → ...s/pack_pattern/multiple/ff/ff.pb_type.xml b/tests/multi_pack_pattern/ff/ff.pb_type.xml → ...s/pack_pattern/multiple/ff/ff.pb_type.xml
diff --git a/tests/multi_pack_pattern/ff/ff.sim.v → tests/pack_pattern/multiple/ff/ff.sim.v b/tests/multi_pack_pattern/ff/ff.sim.v → tests/pack_pattern/multiple/ff/ff.sim.v
diff --git a/tests/multi_pack_pattern/golden.pb_type.xml → .../pack_pattern/multiple/golden.pb_type.xml b/tests/multi_pack_pattern/golden.pb_type.xml → .../pack_pattern/multiple/golden.pb_type.xml
diff --git a/tests/multi_pack_pattern/lut/lut.pb_type.xml → ...pack_pattern/multiple/lut/lut.pb_type.xml b/tests/multi_pack_pattern/lut/lut.pb_type.xml → ...pack_pattern/multiple/lut/lut.pb_type.xml
diff --git a/tests/multi_pack_pattern/lut/lut.sim.v → tests/pack_pattern/multiple/lut/lut.sim.v b/tests/multi_pack_pattern/lut/lut.sim.v → tests/pack_pattern/multiple/lut/lut.sim.v
diff --git a/tests/multi_pack_pattern/mux/mux.pb_type.xml → ...pack_pattern/multiple/mux/mux.pb_type.xml b/tests/multi_pack_pattern/mux/mux.pb_type.xml → ...pack_pattern/multiple/mux/mux.pb_type.xml
diff --git a/tests/multi_pack_pattern/mux/mux.sim.v → tests/pack_pattern/multiple/mux/mux.sim.v b/tests/multi_pack_pattern/mux/mux.sim.v → tests/pack_pattern/multiple/mux/mux.sim.v