From da144f41d4efa8b344ee49c7f5ff4a2da1fcce17 Mon Sep 17 00:00:00 2001
From: Tim 'mithro' Ansell <mithro@mithis.com>
Date: Fri, 16 Dec 2016 16:58:01 +0100
Subject: [PATCH] bist: Refactoring test bench.

Move a bunch of common code into common.py
---
 test/bist_async_tb.py | 20 +++++++-------------
 test/bist_tb.py       | 42 ++++++------------------------------------
 test/common.py        | 27 +++++++++++++++++++++++++++
 3 files changed, 40 insertions(+), 49 deletions(-)

diff --git a/test/bist_async_tb.py b/test/bist_async_tb.py
index 699a6ba..3930f50 100755
--- a/test/bist_async_tb.py
+++ b/test/bist_async_tb.py
@@ -12,9 +12,11 @@ from litedram.frontend.bist import LiteDRAMBISTGenerator
 from litedram.frontend.bist import LiteDRAMBISTChecker
 from litedram.frontend.adaptation import LiteDRAMPortCDC
 
-
 from litedram.phy.model import SDRAMPHYModel
 
+from test.common import *
+
+
 class SimModule(SDRAMModule):
     # geometry
     nbanks = 2
@@ -70,20 +72,14 @@ def main_generator(dut):
     for i in range(100):
         yield
     # init
-    yield dut.generator.reset.storage.eq(1)
-    yield dut.checker.reset.storage.eq(1)
-    yield
-    yield dut.generator.reset.storage.eq(0)
-    yield dut.checker.reset.storage.eq(0)
-    yield
+    yield from reset_bist_module(dut.generator)
+    yield from reset_bist_module(dut.checker)
     # write
     yield dut.generator.base.storage.eq(16)
     yield dut.generator.length.storage.eq(16)
     for i in range(32):
         yield
-    yield dut.generator.start.re.eq(1)
-    yield
-    yield dut.generator.start.re.eq(0)
+    yield from toggle_re(dut.generator.start)
     for i in range(32):
         yield
     while((yield dut.generator.done.status) == 0):
@@ -93,9 +89,7 @@ def main_generator(dut):
     yield dut.checker.length.storage.eq(16)
     for i in range(32):
         yield
-    yield dut.checker.start.re.eq(1)
-    yield
-    yield dut.checker.start.re.eq(0)
+    yield from toggle_re(dut.generator.start)
     for i in range(32):
         yield
     while((yield dut.checker.done.status) == 0):
diff --git a/test/bist_tb.py b/test/bist_tb.py
index f4fe618..22341bc 100755
--- a/test/bist_tb.py
+++ b/test/bist_tb.py
@@ -10,7 +10,7 @@ from litedram.common import LiteDRAMWritePort, LiteDRAMReadPort
 from litedram.frontend.bist import LiteDRAMBISTGenerator
 from litedram.frontend.bist import LiteDRAMBISTChecker
 
-from test.common import DRAMMemory
+from test.common import *
 
 class TB(Module):
     def __init__(self):
@@ -20,32 +20,6 @@ class TB(Module):
         self.submodules.checker = LiteDRAMBISTChecker(self.read_port)
 
 
-def togglereset(module):
-    resig = module.reset.re
-
-    # Check that reset isn't set
-    reval = yield resig
-    assert not reval, reval
-
-    # Toggle the reset
-    yield resig.eq(1)
-    yield
-    yield resig.eq(0)
-    yield  # Takes 3 clock cycles for the reset to have an effect
-    yield
-    yield
-    yield
-    yield
-    yield
-
-    # Check some initial conditions are correct after reset.
-    started = yield module.core.started
-    assert started == 0, started
-
-    done = yield module.done.status
-    assert not done, done
-
-
 def main_generator(dut, mem):
     # Populate memory with random data
     random.seed(0)
@@ -53,7 +27,7 @@ def main_generator(dut, mem):
         mem.mem[i] = random.randint(0, 2**mem.width)
 
     # write
-    yield from togglereset(dut.generator)
+    yield from reset_bist_module(dut.generator)
 
     yield dut.generator.base.storage.eq(16)
     yield dut.generator.length.storage.eq(64)
@@ -70,7 +44,7 @@ def main_generator(dut, mem):
     assert done, done
 
     # read with no errors
-    yield from togglereset(dut.checker)
+    yield from reset_bist_module(dut.checker)
     errors = yield dut.checker.error_count.status
     assert errors == 0, errors
 
@@ -78,9 +52,7 @@ def main_generator(dut, mem):
     yield dut.checker.length.storage.eq(64)
     for i in range(8):
         yield
-    yield dut.checker.start.re.eq(1)
-    yield
-    yield dut.checker.start.re.eq(0)
+    yield from toggle_re(dut.checker.start)
     for i in range(8):
         yield
     while((yield dut.checker.done.status) == 0):
@@ -94,7 +66,7 @@ def main_generator(dut, mem):
     yield
 
     # read with one error
-    yield from togglereset(dut.checker)
+    yield from reset_bist_module(dut.checker)
     errors = yield dut.checker.error_count.status
     assert errors == 0, errors
 
@@ -105,9 +77,7 @@ def main_generator(dut, mem):
     yield dut.checker.length.storage.eq(64)
     for i in range(8):
         yield
-    yield dut.checker.start.re.eq(1)
-    yield
-    yield dut.checker.start.re.eq(0)
+    yield from toggle_re(dut.checker.start)
     for i in range(8):
         yield
     while((yield dut.checker.done.status) == 0):
diff --git a/test/common.py b/test/common.py
index e8f0f2d..ac0d2a7 100644
--- a/test/common.py
+++ b/test/common.py
@@ -1,6 +1,33 @@
 from litex.gen import *
 
 
+def toggle_re(reg):
+    resig = reg.re
+    # Check that reset isn't set
+    reval = yield resig
+    assert not reval, reval
+    yield resig.eq(1)
+    yield
+    yield resig.eq(0)
+
+
+def reset_bist_module(module):
+    # Toggle the reset
+    yield from toggle_re(module.reset)
+    yield # Takes 5 more clock cycles for the reset to have an effect
+    yield
+    yield
+    yield
+    yield
+
+    # Check some initial conditions are correct after reset.
+    started = yield module.core.started
+    assert started == 0, started
+
+    done = yield module.done.status
+    assert not done, done
+
+
 def seed_to_data(seed, random=True, nbits=32):
     if nbits == 32:
         if random: