cli: new module, for basic design generaton/simulation.

examples/alu.py

@@ -1,5 +1,5 @@
 from nmigen import *
-from nmigen.back import rtlil, verilog
+from nmigen.cli import main
 
 
 class ALU:
@@ -23,7 +23,6 @@ class ALU:
         return m.lower(platform)
 
 
-alu  = ALU(width=16)
+if __name__ == "__main__":
-frag = alu.get_fragment(platform=None)
+    alu = ALU(width=16)
-# print(rtlil.convert(frag, ports=[alu.sel, alu.a, alu.b, alu.o, alu.co]))
+    main(alu, ports=[alu.sel, alu.a, alu.b, alu.o, alu.co])
-print(verilog.convert(frag, ports=[alu.sel, alu.a, alu.b, alu.o, alu.co]))

examples/alu_hier.py

@@ -1,5 +1,5 @@
 from nmigen import *
-from nmigen.back import rtlil, verilog
+from nmigen.cli import main
 
 
 class Adder:
@@ -53,7 +53,6 @@ class ALU:
         return m.lower(platform)
 
 
-alu  = ALU(width=16)
+if __name__ == "__main__":
-frag = alu.get_fragment(platform=None)
+    alu = ALU(width=16)
-# print(rtlil.convert(frag, ports=[alu.op, alu.a, alu.b, alu.o]))
+    main(alu, ports=[alu.op, alu.a, alu.b, alu.o])
-print(verilog.convert(frag, ports=[alu.op, alu.a, alu.b, alu.o]))

examples/arst.py

@@ -1,5 +1,5 @@
 from nmigen import *
-from nmigen.back import rtlil, verilog
+from nmigen.cli import main
 
 
 class ClockDivisor:
@@ -14,8 +14,8 @@ class ClockDivisor:
         return m.lower(platform)
 
 
-ctr  = ClockDivisor(factor=16)
+if __name__ == "__main__":
-frag = ctr.get_fragment(platform=None)
+    ctr  = ClockDivisor(factor=16)
-frag.add_domains(ClockDomain("sync", async_reset=True))
+    frag = ctr.get_fragment(platform=None)
-# print(rtlil.convert(frag, ports=[ctr.o]))
+    frag.add_domains(ClockDomain("sync", async_reset=True))
-print(verilog.convert(frag, ports=[ctr.o]))
+    main(frag, ports=[ctr.o])

examples/cdc.py

@@ -1,10 +1,10 @@
 from nmigen import *
-from nmigen.back import rtlil, verilog
+from nmigen.cli import main
 
 
 i, o = Signal(name="i"), Signal(name="o")
 m = Module()
 m.submodules += MultiReg(i, o)
-frag = m.lower(platform=None)
+
-# print(rtlil.convert(frag, ports=[i, o]))
+if __name__ == "__main__":
-print(verilog.convert(frag, ports=[i, o]))
+    main(m.lower(platform=None), ports=[i, o])

examples/ctr.py

@@ -1,5 +1,5 @@
 from nmigen import *
-from nmigen.back import rtlil, verilog, pysim
+from nmigen.cli import main, pysim
 
 
 class Counter:
@@ -14,13 +14,6 @@ class Counter:
         return m.lower(platform)
 
 
-ctr  = Counter(width=16)
+ctr = Counter(width=16)
-frag = ctr.get_fragment(platform=None)
+if __name__ == "__main__":
-
+    main(ctr, ports=[ctr.o])
-# print(rtlil.convert(frag, ports=[ctr.o]))
-print(verilog.convert(frag, ports=[ctr.o]))
-
-with pysim.Simulator(frag,
-        vcd_file=open("ctr.vcd", "w")) as sim:
-    sim.add_clock(1e-6)
-    sim.run_until(100e-6, run_passive=True)

examples/gpio.py

@@ -1,6 +1,6 @@
 from types import SimpleNamespace
 from nmigen import *
-from nmigen.back import rtlil, verilog, pysim
+from nmigen.cli import main
 
 
 class GPIO:
@@ -16,16 +16,14 @@ class GPIO:
         return m.lower(platform)
 
 
-# TODO: use Record
+if __name__ == "__main__":
-bus = SimpleNamespace(
+    # TODO: use Record
-    adr=Signal(max=8),
+    bus = SimpleNamespace(
-    dat_r=Signal(),
+        adr  =Signal(name="adr", max=8),
-    dat_w=Signal(),
+        dat_r=Signal(name="dat_r"),
-    we=Signal()
+        dat_w=Signal(name="dat_w"),
-)
+        we   =Signal(name="we"),
-pins = Signal(8)
+    )
-gpio = GPIO(Array(pins), bus)
+    pins = Signal(8)
-frag = gpio.get_fragment(platform=None)
+    gpio = GPIO(Array(pins), bus)
-
+    main(gpio, ports=[pins, bus.adr, bus.dat_r, bus.dat_w, bus.we])
-# print(rtlil.convert(frag, ports=[pins, bus.adr, bus.dat_r, bus.dat_w, bus.we]))
-print(verilog.convert(frag, ports=[pins, bus.adr, bus.dat_r, bus.dat_w, bus.we]))

examples/inst.py

@@ -1,5 +1,5 @@
 from nmigen import *
-from nmigen.back import rtlil, verilog
+from nmigen.cli import main
 
 
 class System:
@@ -11,7 +11,7 @@ class System:
 
     def get_fragment(self, platform):
         m = Module()
-        m.submodules += Instance("CPU",
+        m.submodules.cpu = Instance("CPU",
             p_RESET_ADDR=0xfff0,
             i_d_adr  =self.adr,
             i_d_dat_r=self.dat_r,
@@ -21,7 +21,6 @@ class System:
         return m.lower(platform)
 
 
-sys  = System()
+if __name__ == "__main__":
-frag = sys.get_fragment(platform=None)
+    sys = System()
-# print(rtlil.convert(frag, ports=[sys.adr, sys.dat_r, sys.dat_w, sys.we]))
+    main(sys, ports=[sys.adr, sys.dat_r, sys.dat_w, sys.we])
-print(verilog.convert(frag, ports=[sys.adr, sys.dat_r, sys.dat_w, sys.we]))

examples/mem.py

@@ -1,5 +1,5 @@
 from nmigen import *
-from nmigen.back import rtlil, verilog
+from nmigen.cli import main
 
 
 class RegisterFile:
@@ -24,7 +24,6 @@ class RegisterFile:
         return m.lower(platform)
 
 
-rf   = RegisterFile()
+if __name__ == "__main__":
-frag = rf.get_fragment(platform=None)
+    rf = RegisterFile()
-# print(rtlil.convert(frag, ports=[rf.adr, rf.dat_r, rf.dat_w, rf.we]))
+    main(rf, ports=[rf.adr, rf.dat_r, rf.dat_w, rf.we])
-print(verilog.convert(frag, ports=[rf.adr, rf.dat_r, rf.dat_w, rf.we]))

examples/pmux.py

@@ -1,5 +1,5 @@
 from nmigen import *
-from nmigen.back import rtlil, verilog
+from nmigen.cli import main
 
 
 class ParMux:
@@ -24,7 +24,6 @@ class ParMux:
         return m.lower(platform)
 
 
-pmux = ParMux(width=16)
+if __name__ == "__main__":
-frag = pmux.get_fragment(platform=None)
+    pmux = ParMux(width=16)
-# print(rtlil.convert(frag, ports=[pmux.s, pmux.a, pmux.b, pmux.c, pmux.o]))
+    main(pmux, ports=[pmux.s, pmux.a, pmux.b, pmux.c, pmux.o])
-print(verilog.convert(frag, ports=[pmux.s, pmux.a, pmux.b, pmux.c, pmux.o]))

nmigen/cli.py

@@ -0,0 +1,65 @@
+import argparse
+
+from .back import rtlil, verilog, pysim
+
+
+__all__ = ["main"]
+
+
+def main_parser(parser=None):
+    if parser is None:
+        parser = argparse.ArgumentParser()
+
+    p_action = parser.add_subparsers(dest="action")
+
+    p_generate = p_action.add_parser("generate",
+        help="generate RTLIL or Verilog from the design")
+    p_generate.add_argument("-t", "--type", dest="generate_type",
+        metavar="LANGUAGE", choices=["il", "v"], default="v",
+        help="generate LANGUAGE (il for RTLIL, v for Verilog; default: %(default)s)")
+    p_generate.add_argument("generate_file",
+        metavar="FILE", type=argparse.FileType("w"), nargs="?",
+        help="write generated code to FILE")
+
+    p_simulate = p_action.add_parser(
+        "simulate", help="simulate the design")
+    p_simulate.add_argument("-v", "--vcd-file",
+        metavar="VCD-FILE", type=argparse.FileType("w"),
+        help="write execution trace to VCD-FILE")
+    p_simulate.add_argument("-w", "--gtkw-file",
+        metavar="GTKW-FILE", type=argparse.FileType("w"),
+        help="write GTKWave configuration to GTKW-FILE")
+    p_simulate.add_argument("-p", "--period", dest="sync_period",
+        metavar="TIME", type=float, default=1e-6,
+        help="set 'sync' clock domain period to TIME (default: %(default)s)")
+    p_simulate.add_argument("-c", "--clocks", dest="sync_clocks",
+        metavar="COUNT", type=int, required=True,
+        help="simulate for COUNT 'sync' clock periods")
+
+    return parser
+
+
+def main_runner(args, design, platform=None, name="top", ports=()):
+    if args.action == "generate":
+        fragment = design.get_fragment(platform=platform)
+        if args.generate_type == "il":
+            output = rtlil.convert(fragment, name=name, ports=ports)
+        if args.generate_type == "v":
+            output = verilog.convert(fragment, name=name, ports=ports)
+        if args.generate_file:
+            args.generate_file.write(output)
+        else:
+            print(output)
+
+    if args.action == "simulate":
+        fragment = design.get_fragment(platform=platform)
+        with pysim.Simulator(fragment,
+                vcd_file=args.vcd_file,
+                gtkw_file=args.gtkw_file,
+                traces=ports) as sim:
+            sim.add_clock(args.sync_period)
+            sim.run_until(args.sync_period * args.sync_clocks, run_passive=True)
+
+
+def main(*args, **kwargs):
+    main_runner(main_parser().parse_args(), *args, **kwargs)