goto methods do not return State object

Author: shtaxxx

tests/extension/fsm_/make_case/fsm_make_case.py

@@ -4,10 +4,12 @@
 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__)))))))
+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 *
 
+
 def mkLed():
     m = Module('blinkled')
     width = m.Parameter('WIDTH', 8)
@@ -20,27 +22,29 @@ def mkLed():
     # get the initial index (= 0)
     init = fsm.current
 
-    fsm( count(count + 1) )
+    fsm(count(count + 1))
     fsm.goto_next()
-    fsm( count(count + 2) )
+    fsm(count(count + 2))
     fsm.goto_next()
-    
+
     # get the current index (= 2)
     here = fsm.current
-    fsm( count(count + 3) )
+    fsm(count(count + 3))
     fsm.goto_next()
 
     # jump by using label "init"
-    fsm.goto( dst=init, cond=(count < 1024), else_dst=fsm.next ).inc()
-    
-    fsm( led(led + 1) )
+    fsm.goto(dst=init, cond=(count < 1024), else_dst=fsm.next)
+    fsm.inc()
+
+    fsm(led(led + 1))
     # jump by using label "here"
     fsm.goto(here)
 
     fsm.make_always()
 
     return m
 
+
 if __name__ == '__main__':
     led = mkLed()
     verilog = led.to_verilog()

tests/extension/fsm_/make_if/fsm_make_if.py

@@ -4,10 +4,12 @@
 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__)))))))
+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 *
 
+
 def mkLed():
     m = Module('blinkled')
     width = m.Parameter('WIDTH', 8)
@@ -20,27 +22,29 @@ def mkLed():
     # get the initial index (= 0)
     init = fsm.current
 
-    fsm( count(count + 1) )
+    fsm(count(count + 1))
     fsm.goto_next()
-    fsm( count(count + 2) )
+    fsm(count(count + 2))
     fsm.goto_next()
-    
+
     # get the current index (= 2)
     here = fsm.current
-    fsm( count(count + 3) )
+    fsm(count(count + 3))
     fsm.goto_next()
 
     # jump by using label "init"
-    fsm.goto( dst=init, cond=(count < 1024), else_dst=fsm.next ).inc()
-    
-    fsm( led(led + 1) )
+    fsm.goto(dst=init, cond=(count < 1024), else_dst=fsm.next)
+    fsm.inc()
+
+    fsm(led(led + 1))
     # jump by using label "here"
     fsm.goto(here)
-    
+
     fsm.make_always(case=False)
 
     return m
 
+
 if __name__ == '__main__':
     led = mkLed()
     verilog = led.to_verilog()

tests/extension/fsm_/state/fsm_state.py

@@ -19,39 +19,39 @@ def mkLed():
 
     fsm = FSM(m, 'fsm', clk, rst)
 
-    s0 = fsm.init  # -> State(fsm, 0)
-    s1 = s0.If(valid).goto_next()  # -> State(fsm, 1)
-    s2 = s1.If(valid).goto_next()  # -> State(fsm, 2)
-    s3 = s2.If(counter[0] == 0).goto(s2.next)  # -> State(fsm, 3)
-    s1_ = s2.Elif(counter[1] == 1).goto(s1)  # -> State(fsm, 1)
-    s2_ = s2.Else.goto(s2)  # -> State(fsm, 2)
-    s0_ = s3.goto(s0)  # -> State(fsm, 0)
+    s0 = fsm.init
+    s1 = fsm.State(s0).If(valid).goto_next()
+    s2 = fsm.State(s1).If(valid).goto_next()
+    s3 = fsm.State(s2).If(counter[0] == 0).goto(fsm.next)
+    s1_ = fsm.State(s2).Elif(counter[1] == 1).goto(s1)
+    s2_ = fsm.State(s2).Else.goto(s2)
+    s0_ = fsm.State(s3).goto(s0)
 
     fsm.Always.If(counter <= 2 ** 8 - 1)(
         counter.inc()
     ).Else(
         counter(0)
     )
 
-    s0.If(counter == 10)(
+    fsm.State(s0).If(counter == 10)(
         valid(0)
     ).Else(
         valid(1)
     )
 
-    s1.If(counter == 20)(
+    fsm.State(s1).If(counter == 20)(
         valid(0)
     ).Else(
         valid(1)
     )
 
-    s2.If(counter == 30)(
+    fsm.State(s2).If(counter == 30)(
         valid(0)
     ).Else(
         valid(1)
     )
 
-    s0_.If(counter == 40)(
+    fsm.State(s0_).If(counter == 40)(
         valid(0)
     ).Else(
         valid(1)

veriloggen/__init__.py

@@ -43,7 +43,7 @@
 
 # Abstract Extension
 from .seq.seq import Seq, TmpSeq, make_condition
-from .fsm.fsm import FSM, TmpFSM, State
+from .fsm.fsm import FSM, TmpFSM
 from .pipeline.pipeline import Pipeline
 
 # Extension reset

veriloggen/fsm/fsm.py

@@ -86,9 +86,6 @@ def __init__(self, m, name, clk, rst, width=32, initname='init',
 
     # -------------------------------------------------------------------------
     def goto(self, dst, cond=None, else_dst=None):
-        if isinstance(dst, State):
-            dst = dst.index
-
         if cond is None and 'cond' in self.next_kwargs:
             cond = self.next_kwargs['cond']
 
@@ -108,7 +105,7 @@ def goto(self, dst, cond=None, else_dst=None):
             src = index
 
         self._go(src, dst, cond, else_dst)
-        return State(self, dst)
+        return dst
 
     def goto_init(self, cond=None):
         if cond is None and 'cond' in self.next_kwargs:
@@ -131,7 +128,7 @@ def goto_init(self, cond=None):
 
         dst = 0
         self._go(src, dst, cond)
-        return State(self, dst)
+        return dst
 
     def goto_next(self, cond=None):
         if cond is None and 'cond' in self.next_kwargs:
@@ -155,15 +152,9 @@ def goto_next(self, cond=None):
         dst = src + 1
         self._go(src, dst, cond=cond)
         self.inc()
-        return State(self, dst)
+        return dst
 
     def goto_from(self, src, dst, cond=None, else_dst=None):
-        if isinstance(src, State):
-            src = src.index
-
-        if isinstance(dst, State):
-            dst = dst.index
-
         if cond is None and 'cond' in self.next_kwargs:
             cond = self.next_kwargs['cond']
 
@@ -173,7 +164,7 @@ def goto_from(self, src, dst, cond=None, else_dst=None):
         # self._clear_elif_cond()
 
         self._go(src, dst, cond, else_dst)
-        return State(self, dst)
+        return dst
 
     def inc(self):
         return self._set_index(None)
@@ -300,6 +291,12 @@ def Elif(self, *cond):
 
         return self
 
+    def Then(self):
+        cond = self._make_cond(self.last_cond)
+        self._clear_last_cond()
+        self.If(cond)
+        return self
+
     def Delay(self, delay):
         self.next_kwargs['delay'] = delay
         return self
@@ -308,12 +305,6 @@ def Keep(self, keep):
         self.next_kwargs['keep'] = keep
         return self
 
-    def Then(self):
-        cond = self._make_cond(self.last_cond)
-        self._clear_last_cond()
-        self.If(cond)
-        return self
-
     def LazyCond(self, value=True):
         self.next_kwargs['lazy_cond'] = value
         return self
@@ -326,6 +317,11 @@ def When(self, index):
         self.next_kwargs['index'] = index
         return self
 
+    def State(self, index=None):
+        if index is None:
+            index = fsm.current
+        return State(self, index)
+
     def Clear(self):
         self._clear_next_kwargs()
         self._clear_last_if_statement()
@@ -340,15 +336,15 @@ def Always(self):
 
     @property
     def init(self):
-        return State(self, 0)
+        return 0
 
     @property
     def current(self):
-        return State(self, self.state_count)
+        return self.state_count
 
     @property
     def next(self):
-        return State(self, self.state_count + 1)
+        return self.state_count + 1
 
     @property
     def current_delay(self):

veriloggen/seq/seq.py

@@ -267,6 +267,12 @@ def Elif(self, *cond):
 
         return self
 
+    def Then(self):
+        cond = self._make_cond(self.last_cond)
+        self._clear_last_cond()
+        self.If(cond)
+        return self
+
     def Delay(self, delay):
         self.next_kwargs['delay'] = delay
         return self
@@ -275,12 +281,6 @@ def Keep(self, keep):
         self.next_kwargs['keep'] = keep
         return self
 
-    def Then(self):
-        cond = self._make_cond(self.last_cond)
-        self._clear_last_cond()
-        self.If(cond)
-        return self
-
     def LazyCond(self, value=True):
         self.next_kwargs['lazy_cond'] = value
         return self