Merge pull request #54 from sh-mug/feature_stypes_Xorshift

add stypes.RandXorshift

Author: shtaxxx

tests/extension/thread_/stream_rand_xorshift/Makefile

@@ -0,0 +1,29 @@
+TARGET=$(shell ls *.py | grep -v test | grep -v parsetab.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 .cache *.out *.png *.dot tmp.v *.vcd

tests/extension/thread_/stream_rand_xorshift/test_thread_stream_rand_xorshift.py

@@ -0,0 +1,18 @@
+from __future__ import absolute_import
+from __future__ import print_function
+
+import os
+import veriloggen
+import thread_stream_rand_xorshift
+
+
+def test(request):
+    veriloggen.reset()
+
+    simtype = request.config.getoption('--sim')
+
+    rslt = thread_stream_rand_xorshift.run(filename=None, simtype=simtype,
+                                     outputfile=os.path.splitext(os.path.basename(__file__))[0] + '.out')
+
+    verify_rslt = rslt.splitlines()[-1]
+    assert(verify_rslt == '# verify: PASSED')

tests/extension/thread_/stream_rand_xorshift/thread_stream_rand_xorshift.py

@@ -0,0 +1,147 @@
+from __future__ import absolute_import
+from __future__ import print_function
+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.dirname(os.path.abspath(__file__)))))))
+
+from veriloggen import *
+import veriloggen.thread as vthread
+import veriloggen.types.axi as axi
+
+
+def mkLed():
+    m = Module('blinkled')
+    clk = m.Input('CLK')
+    rst = m.Input('RST')
+
+    datawidth = 32
+    addrwidth = 10
+    initval = 0x12345678
+    myaxi = vthread.AXIM(m, 'myaxi', clk, rst, datawidth)
+    ram_a = vthread.RAM(m, 'ram_a', clk, rst, datawidth, addrwidth)
+    ram_b = vthread.RAM(m, 'ram_b', clk, rst, datawidth, addrwidth)
+    ram_c = vthread.RAM(m, 'ram_c', clk, rst, datawidth, addrwidth)
+
+    strm = vthread.Stream(m, 'mystream', clk, rst)
+    rand_hard = strm.RandXorshift(reg_initval=initval)
+    a = strm.source('a')
+    b = strm.source('b')
+    c = a + b - a - b + rand_hard
+    strm.sink(c, 'c')
+
+    def comp_stream(size, offset):
+        strm.set_source('a', ram_a, offset, size)
+        strm.set_source('b', ram_b, offset, size)
+        strm.set_sink('c', ram_c, offset, size)
+        strm.run()
+        strm.join()
+
+    def comp_sequential(size, offset):
+        rand_soft = initval
+        for i in range(size):
+            a = ram_a.read(i + offset)
+            b = ram_b.read(i + offset)
+            sum = a + b - a - b + rand_soft
+            ram_c.write(i + offset, sum)
+
+            rand_soft = (rand_soft ^ (rand_soft << 13)) & ((1 << datawidth) - 1)
+            rand_soft = rand_soft ^ ((rand_soft >> 17) & ((1 << datawidth - 17) - 1))
+            rand_soft = (rand_soft ^ (rand_soft << 5)) & ((1 << datawidth) - 1)
+
+    def check(size, offset_stream, offset_seq):
+        all_ok = True
+        for i in range(size):
+            st = ram_c.read(i + offset_stream)
+            sq = ram_c.read(i + offset_seq)
+            if vthread.verilog.NotEql(st, sq):
+                all_ok = False
+        if all_ok:
+            print('# verify: PASSED')
+        else:
+            print('# verify: FAILED')
+
+    def comp(size):
+        # stream
+        offset = 0
+        myaxi.dma_read(ram_a, offset, 0, size)
+        myaxi.dma_read(ram_b, offset, 512, size)
+        comp_stream(size, offset)
+        myaxi.dma_write(ram_c, offset, 1024, size)
+
+        # sequential
+        offset = size
+        myaxi.dma_read(ram_a, offset, 0, size)
+        myaxi.dma_read(ram_b, offset, 512, size)
+        comp_sequential(size, offset)
+        myaxi.dma_write(ram_c, offset, 1024 * 2, size)
+
+        # verification
+        check(size, 0, offset)
+
+        vthread.finish()
+
+    th = vthread.Thread(m, 'th_comp', clk, rst, comp)
+    fsm = th.start(32)
+
+    return m
+
+
+def mkTest(memimg_name=None):
+    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']
+
+    memory = axi.AxiMemoryModel(m, 'memory', clk, rst, memimg_name=memimg_name)
+    memory.connect(ports, 'myaxi')
+
+    uut = m.Instance(led, 'uut',
+                     params=m.connect_params(led),
+                     ports=m.connect_ports(led))
+
+    # vcd_name = os.path.splitext(os.path.basename(__file__))[0] + '.vcd'
+    # simulation.setup_waveform(m, uut, dumpfile=vcd_name)
+    simulation.setup_clock(m, clk, hperiod=5)
+    init = simulation.setup_reset(m, rst, m.make_reset(), period=100)
+
+    init.add(
+        Delay(1000000),
+        Systask('finish'),
+    )
+
+    return m
+
+
+def run(filename='tmp.v', simtype='iverilog', outputfile=None):
+
+    if outputfile is None:
+        outputfile = os.path.splitext(os.path.basename(__file__))[0] + '.out'
+
+    memimg_name = 'memimg_' + outputfile
+
+    test = mkTest(memimg_name=memimg_name)
+
+    if filename is not None:
+        test.to_verilog(filename)
+
+    sim = simulation.Simulator(test, sim=simtype)
+    rslt = sim.run(outputfile=outputfile)
+    lines = rslt.splitlines()
+    if simtype == 'verilator' and lines[-1].startswith('-'):
+        rslt = '\n'.join(lines[:-1])
+    return rslt
+
+
+if __name__ == '__main__':
+    rslt = run(filename='tmp.v')
+    print(rslt)

veriloggen/stream/stypes.py

@@ -3630,6 +3630,62 @@ def _implement(self, m, seq, svalid=None, senable=None):
         seq(count(next_count_value), cond=enable_cond)
 
 
+class RandXorshift(_Accumulator):
+
+    def __init__(self, reg_initval=0x12345678, dependency=None, enable=None, width=32):
+
+        right = 0
+        size = None
+        interval = None
+        initval = None
+        offset = None
+        reset = None
+        signed = False
+
+        _Accumulator.__init__(self, right, size, interval, initval, offset,
+                              dependency, enable, reset, reg_initval, width, signed)
+        self.graph_label = 'RandXorshift'
+
+    def _implement(self, m, seq, svalid=None, senable=None):
+        if self.latency != 1:
+            raise ValueError("Latency mismatch '%d' vs '%s'" %
+                             (self.latency, 1))
+
+        width = self.get_width()
+        signed = self.get_signed()
+
+        reg_initval_data = self.reg_initval.sig_data
+
+        data = m.Reg(self.name('data'), width,
+                     initval=reg_initval_data, signed=signed)
+
+        randval = m.Reg(self.name('randval'), width,
+                      initval=reg_initval_data, signed=signed)
+
+        self.sig_data = data
+
+        enabledata = self.enable.sig_data if self.enable is not None else None
+        
+        if width == 32:
+            next_value = randval ^ (randval << 13)
+            next_value = next_value ^ (next_value >> 17)
+            next_value = next_value ^ (next_value << 5)
+        elif width == 64:
+            next_value = randval ^ (randval << 13)
+            next_value = next_value ^ (next_value >> 7)
+            next_value = next_value ^ (next_value << 17)
+        else:
+            raise ValueError("Invalid width value '%d', please specify 32 or 64" % width)
+
+        enable_cond = _and_vars(svalid, senable)
+
+        if self.enable is not None:
+            enable_cond = _and_vars(enable_cond, enabledata)
+
+        seq(data(randval), cond=enable_cond)
+        seq(randval(next_value), cond=enable_cond)
+
+
 class Pulse(_Accumulator):
     ops = ()