sim.core: add bench processes that always settle implicitly.

See #228.
amaranth-lang · Oct 20, 2020 · b420994 · b420994
1 parent 2c505de
commit b420994
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 0 deletions.
diff --git a/nmigen/sim/core.py b/nmigen/sim/core.py
@@ -90,6 +90,22 @@ def wrapper():
             yield from process()
         self._engine.add_coroutine_process(wrapper, default_cmd=Tick(domain))
 
+    def add_bench_process(self, process, *, domain="sync"):
+        process = self._check_process(process)
+        def wrapper():
+            generator = process()
+            # Only start a bench process after power-on reset settles.
+            try:
+                yield Settle()
+                command = generator.send(None)
+                while True:
+                    result = yield command
+                    yield Settle()
+                    command = generator.send(result)
+            except StopIteration:
+                pass
+        self._engine.add_coroutine_process(wrapper, default_cmd=Tick(domain))
+
     def add_clock(self, period, *, phase=None, domain="sync", if_exists=False):
         """Add a clock process.
 

diff --git a/tests/test_sim.py b/tests/test_sim.py
@@ -721,6 +721,49 @@ def process():
             sim.add_clock(1e-6)
             sim.add_sync_process(process)
 
+    def test_comb_bench_process(self):
+        m = Module()
+        a = Signal(reset=1)
+        b = Signal()
+        m.d.comb += b.eq(a)
+        with self.assertSimulation(m) as sim:
+            def process():
+                self.assertEqual((yield a), 1)
+                self.assertEqual((yield b), 1)
+                yield a.eq(0)
+                self.assertEqual((yield a), 0)
+                self.assertEqual((yield b), 0)
+            sim.add_bench_process(process)
+
+    def test_sync_bench_process(self):
+        m = Module()
+        a = Signal(reset=1)
+        b = Signal()
+        m.d.sync += b.eq(a)
+        t = Signal()
+        m.d.sync += t.eq(~t)
+        with self.assertSimulation(m) as sim:
+            def process():
+                self.assertEqual((yield a), 1)
+                self.assertEqual((yield b), 0)
+                self.assertEqual((yield t), 0)
+                yield
+                self.assertEqual((yield a), 1)
+                self.assertEqual((yield b), 1)
+                self.assertEqual((yield t), 1)
+                yield
+                self.assertEqual((yield a), 1)
+                self.assertEqual((yield b), 1)
+                self.assertEqual((yield t), 0)
+                yield a.eq(0)
+                self.assertEqual((yield a), 0)
+                self.assertEqual((yield b), 1)
+                yield
+                self.assertEqual((yield a), 0)
+                self.assertEqual((yield b), 0)
+            sim.add_clock(1e-6)
+            sim.add_bench_process(process)
+
     def test_sample_helpers(self):
         m = Module()
         s = Signal(2)