lib.dataflow supports the visualization of the dataflow by using pygraphviz.

Author: shtaxxx

README.md

@@ -42,19 +42,35 @@ Install on your platform. For exmple, on Ubuntu:
     sudo apt-get install iverilog
 
 - Jinja2: 2.8 or later
-- pytest: 2.8.2 or later
-- pytest-pythonpath: 0.7 or later
 
 Install on your python environment by using pip.
 
-    pip install jinja2 pytest pytest-pythonpath
+    pip install jinja2
 
 - Pyverilog: 1.0.1 or later
 
 Install from pip:
 
     pip install pyverilog
 
+Options
+--------------------
+
+- pytest: 2.8.2 or later
+- pytest-pythonpath: 0.7 or later
+
+These softwares are required for the test of tests and examples.
+
+    pip install pytest pytest-pythonpath
+
+- Graphviz: 2.38.0 or later
+- Pygraphviz: 1.3.1 or later
+
+These softwares are required for graph visualization by lib.dataflow.
+
+    sudo apt-get install graphviz
+    pip install pygraphviz
+
 Install
 --------------------
 

README.rst

@@ -46,23 +46,43 @@ Install on your platform. For exmple, on Ubuntu:
     sudo apt-get install iverilog
 
 -  Jinja2: 2.8 or later
--  pytest: 2.8.2 or later
--  pytest-pythonpath: 0.7 or later
 
 Install on your python environment by using pip.
 
 ::
 
-    pip install jinja2 pytest pytest-pythonpath
+    pip install jinja2
 
--  Pyverilog: 1.0.0 or later
+-  Pyverilog: 1.0.1 or later
 
 Install from pip:
 
 ::
 
     pip install pyverilog
 
+Options
+-------
+
+-  pytest: 2.8.2 or later
+-  pytest-pythonpath: 0.7 or later
+
+These softwares are required for the test of tests and examples.
+
+::
+
+    pip install pytest pytest-pythonpath
+
+-  Graphviz: 2.38.0 or later
+-  Pygraphviz: 1.3.1 or later
+
+These softwares are required for graph visualization by lib.dataflow.
+
+::
+
+    sudo apt-get install graphviz
+    pip install pygraphviz
+
 Install
 -------
 

examples/Makefile

@@ -14,5 +14,5 @@ run:
 
 .PHONY: clean
 clean:
-	rm -rf *.pyc __pycache__ parsetab.py *.out .cache
+	rm -rf *.pyc __pycache__ parsetab.py *.out .cache tmp.v uut.vcd *.png *.dot 
 	find . -maxdepth 1 -type d |grep "./" | xargs -I {} make clean -C {}

examples/dataflow_example/Makefile

@@ -26,4 +26,4 @@ check:
 
 .PHONY: clean
 clean:
-	rm -rf *.pyc __pycache__ parsetab.py *.out tmp.v uut.vcd
+	rm -rf *.pyc __pycache__ parsetab.py *.out *.png *.dot tmp.v uut.vcd 

examples/dataflow_example/dataflow_example.py

@@ -45,6 +45,9 @@ def mkMultAdd():
 
     # generate always statement
     df.make_always()
+
+    # draw dataflow graph in png
+    df.draw_graph()
 
     return m
 

setup.py

@@ -23,6 +23,7 @@ def read(filename):
       #package_data={ 'path' : ['*.*'], },
       install_requires=[ 'pyverilog>=1.0.1', 'Jinja2>=2.8' ],
       extras_require={
+          'graph' : [ 'pygraphviz>=1.3.1' ],
           'test' : [ 'pytest>=2.8.2', 'pytest-pythonpath>=0.7' ],
       },
 )

tests/Makefile

@@ -14,5 +14,5 @@ run:
 
 .PHONY: clean
 clean:
-	rm -rf *.pyc __pycache__ parsetab.py *.out .cache tmp.v uut.vcd
+	rm -rf *.pyc __pycache__ parsetab.py *.out .cache tmp.v uut.vcd *.png *.dot 
 	find . -maxdepth 1 -type d |grep "./" | xargs -I {} make clean -C {}

tests/lib_dataflow_/draw_graph/Makefile

@@ -0,0 +1,29 @@
+TARGET=*.py
+ARGS=
+
+PYTHON=python3
+#PYTHON=python
+#OPT=-m pdb
+#OPT=-m cProfile -s time
+#OPT=-m cProfile -o profile.rslt
+
+.PHONY: all
+all: test
+
+.PHONY: run
+run:
+	$(PYTHON) $(OPT) $(TARGET) $(ARGS)
+
+.PHONY: test
+test:
+	$(PYTHON) -m pytest -vv
+
+.PHONY: check
+check:
+	$(PYTHON) $(OPT) $(TARGET) $(ARGS) > tmp.v
+	iverilog -tnull -Wall tmp.v
+	rm -f tmp.v
+
+.PHONY: clean
+clean:
+	rm -rf *.pyc __pycache__ parsetab.py *.out *.png *.dot tmp.v uut.vcd 

tests/lib_dataflow_/draw_graph/lib_dataflow_draw_graph.py

@@ -0,0 +1,151 @@
+import sys
+import os
+
+# the next line can be removed after installation
+sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))))
+
+from veriloggen import *
+
+def mkLed():
+    m = Module('blinkled')
+    clk = m.Input('CLK')
+    rst = m.Input('RST')
+    
+    x = m.Input('x', 32)
+    vx = m.Input('vx')
+    rx = m.Output('rx')
+    
+    y = m.Input('y', 32)
+    vy = m.Input('vy')
+    ry = m.Output('ry')
+
+    z = m.Output('z', 32)
+    vz = m.Output('vz')
+    rz = m.Input('rz')
+    
+    df = lib.Dataflow(m, 'df', clk, rst)
+    
+    px = df.input(x, valid=vx, ready=rx)
+    py = df.input(y, valid=vy, ready=ry)
+    pz = df(px + py)
+    pz.output(z, valid=vz, ready=rz)
+    
+    df.make_always()
+
+    df.draw_graph('out.png')
+    
+    return m
+
+def mkTest(numports=8):
+    m = Module('test')
+
+    # target instance
+    led = mkLed()
+    
+    # copy paras and ports
+    params = m.copy_params(led)
+    ports = m.copy_sim_ports(led)
+
+    clk = ports['CLK']
+    rst = ports['RST']
+    
+    x = ports['x']
+    vx = ports['vx']
+    rx = ports['rx']
+    y = ports['y']
+    vy = ports['vy']
+    ry = ports['ry']
+    z = ports['z']
+    vz = ports['vz']
+    rz = ports['rz']
+    
+    uut = m.Instance(led, 'uut',
+                     params=m.connect_params(led),
+                     ports=m.connect_ports(led))
+
+    reset_done = m.Reg('reset_done', initval=0)
+    
+    reset_stmt = []
+    reset_stmt.append( reset_done(0) )
+    reset_stmt.append( x(0) )
+    reset_stmt.append( y(0) )
+    reset_stmt.append( vx(0) )
+    reset_stmt.append( vy(0) )
+    reset_stmt.append( rz(0) )
+    
+    lib.simulation.setup_waveform(m, uut)
+    lib.simulation.setup_clock(m, clk, hperiod=5)
+    init = lib.simulation.setup_reset(m, rst, reset_stmt, period=100)
+
+    nclk = lib.simulation.next_clock
+    
+    init.add(
+        Delay(1000),
+        reset_done(1),
+        nclk(clk),
+        Delay(10000),
+        Systask('finish'),
+    )
+
+    
+    x_count = m.TmpReg(32, initval=0)
+    y_count = m.TmpReg(32, initval=0)
+    z_count = m.TmpReg(32, initval=0)
+
+    
+    xfsm = lib.FSM(m, 'xfsm', clk, rst)
+    xfsm.add(vx(0))
+    xfsm.goto_next(cond=reset_done)
+    xfsm.add(vx(1))
+    xfsm.add(x.inc(), cond=rx)
+    xfsm.add(x_count.inc(), cond=rx)
+    xfsm.goto_next(cond=AndList(x_count==10, rx))
+    xfsm.add(vx(0))
+    xfsm.make_always()
+    
+    
+    yfsm = lib.FSM(m, 'yfsm', clk, rst)
+    yfsm.add(vy(0))
+    yfsm.goto_next(cond=reset_done)
+    yfsm.add(vy(1))
+    yfsm.add(y.add(2), cond=ry)
+    yfsm.add(y_count.inc(), cond=ry)
+    yfsm.goto_next(cond=AndList(y_count==10, ry))
+    yfsm.add(vy(0))
+    yfsm.make_always()
+
+    
+    zfsm = lib.FSM(m, 'zfsm', clk, rst)
+    zfsm.add(rz(0))
+    zfsm.goto_next(cond=reset_done)
+    zfsm.goto_next()
+    zinit= zfsm.current()
+    zfsm.add(rz(1), cond=vz)
+    zfsm.goto_next(cond=vz)
+    for i in range(10):
+        zfsm.add(rz(0))
+        zfsm.goto_next()
+    zfsm.goto(zinit)
+    zfsm.make_always()
+
+    
+    m.Always(Posedge(clk))(
+        If(reset_done)(
+            If(AndList(vx, rx))(
+                Systask('display', 'x=%d', x)
+            ),
+            If(AndList(vy, ry))(
+                Systask('display', 'y=%d', y)
+            ),
+            If(AndList(vz, rz))(
+                Systask('display', 'z=%d', z)
+            )
+        )
+    )
+    
+    return m
+    
+if __name__ == '__main__':
+    test = mkTest()
+    verilog = test.to_verilog('tmp.v')
+    print(verilog)