code-morph to drop in a duplicate resource set, for the IO ring
[pinmux.git] / src / spec / testing_stage1.py
index 7de2ef23d971ef0ca80ba60c12b6c9d592ce08c4..3def0b0c8cfe5dfbe8dd21fbe21416e0658d5dfc 100644 (file)
@@ -1,8 +1,11 @@
 #!/usr/bin/env python3
 from nmigen.build.dsl import Resource, Subsignal, Pins
 from nmigen.build.plat import TemplatedPlatform
-from nmigen import Elaboratable, Signal, Module
+from nmigen.build.res import ResourceManager
+from nmigen import Elaboratable, Signal, Module, Instance
 from collections import OrderedDict
+from jtag import JTAG
+from copy import deepcopy
 
 # Was thinking of using these functions, but skipped for simplicity for now
 # XXX nope.  the output from JSON file.
@@ -52,13 +55,29 @@ def create_resources(pinset):
             ios = []
             for pin in pins:
                 pname = "gpio"+pin[:-1] # strip "*" on end
-                ios.append(Subsignal(pname, Pins(pname, assert_width=1)))
+                pads = []
+                # urrrr... tristsate and io assume a single pin which is
+                # of course exactly what we don't want in an ASIC: we want
+                # *all three* pins but the damn port is not outputted
+                # as a triplet, it's a single Record named "io". sigh.
+                # therefore the only way to get a triplet of i/o/oe
+                # is to *actually* create explicit triple pins
+                pads.append(Subsignal("i",
+                            Pins(pname+"_i", dir="i", assert_width=1)))
+                pads.append(Subsignal("o",
+                            Pins(pname+"_o", dir="o", assert_width=1)))
+                pads.append(Subsignal("oe",
+                            Pins(pname+"_oe", dir="oe", assert_width=1)))
+                ios.append(Resource.family(pname, 0, default_name=pname,
+                                                 ios=pads))
             resources.append(Resource.family(periph, 0, default_name="gpio",
                                              ios=ios))
 
     # add clock and reset
-    resources.append(Resource("clk", 0, Pins("sys_clk", dir="i")))
-    resources.append(Resource("rst", 0, Pins("sys_rst", dir="i")))
+    clk = Resource("clk", 0, Pins("sys_clk", dir="i"))
+    rst = Resource("rst", 0, Pins("sys_rst", dir="i"))
+    resources.append(clk)
+    resources.append(rst)
     return resources
 
 
@@ -79,20 +98,24 @@ def I2CResource(*args, scl, sda):
 # ridiculously-simple top-level module.  doesn't even have a sync domain
 # and can't have one until a clock has been established by DummyPlatform.
 class Blinker(Elaboratable):
-    def __init__(self):
-        pass
+    def __init__(self, pinset):
+        self.jtag = JTAG(pinset, "sync")
+
     def elaborate(self, platform):
         m = Module()
+        m.submodules.jtag = self.jtag
         count = Signal(5)
         m.d.sync += count.eq(5)
         print ("resources", platform.resources.items())
-        gpio = platform.request("gpio", 0)
+        gpio = platform.core['gpio']
         print (gpio, gpio.layout, gpio.fields)
         # get the GPIO bank, mess about with some of the pins
         m.d.comb += gpio.gpio0.o.eq(1)
         m.d.comb += gpio.gpio1.o.eq(gpio.gpio2.i)
+        m.d.comb += gpio.gpio1.oe.eq(count[4])
+        m.d.sync += count[0].eq(gpio.gpio1.i)
         # get the UART resource, mess with the output tx
-        uart = platform.request("uart", 0)
+        uart = platform.core['uart']
         print (uart, uart.fields)
         m.d.comb += uart.tx.eq(1)
         return m
@@ -132,9 +155,84 @@ class DummyPlatform(TemplatedPlatform):
     toolchain = None
     default_clk = "clk" # should be picked up / overridden by platform sys.clk
     default_rst = "rst" # should be picked up / overridden by platform sys.rst
-    def __init__(self, resources):
+    def __init__(self, pinset):
         super().__init__()
+        # create set of pin resources based on the pinset, this is for the core
+        resources = create_resources(pinset)
         self.add_resources(resources)
+        # make a *second* - identical - set of pin resources for the IO ring
+        padres = deepcopy(resources)
+        self.pad_mgr = ResourceManager(padres, [])
+        # allocate all resources, right now, so that a lookup can be created
+        # between core IO names and pads
+        self.core = {}
+        self.pads = {}
+        # request every single peripheral in the pinset.
+        for periph, pins in pinset.items():
+            self.core[periph] = self.request(periph)
+            self.pads[periph] = self.pad_mgr.request(periph)
+        # now create a lookup between the pad and the core, so that
+        # JTAG boundary scan can be inserted in between
+        self.padlookup = {}
+        core = list(self.iter_single_ended_pins())
+        pads = list(self.pad_mgr.iter_single_ended_pins())
+        print ("core", core)
+        print ("pads", pads)
+        for pad, core in zip(pads, core):
+            print ("iter", pad)
+            self.padlookup[pad[0].name] = core
+
+    # XXX these aren't strictly necessary right now but the next
+    # phase is to add JTAG Boundary Scan so it maaay be worth adding?
+    # at least for the print statements
+    def get_input(self, pin, port, attrs, invert):
+        self._check_feature("single-ended input", pin, attrs,
+                            valid_xdrs=(0,), valid_attrs=None)
+
+        print ("    get_input", pin, "port", port, port.layout)
+        if pin.name not in ['clk_0', 'rst_0']: # sigh
+            pad = self.padlookup[pin.name]
+            print ("       pad", pad)
+        m = Module()
+        m.d.comb += pin.i.eq(self._invert_if(invert, port))
+        return m
+
+    def get_output(self, pin, port, attrs, invert):
+        self._check_feature("single-ended output", pin, attrs,
+                            valid_xdrs=(0,), valid_attrs=None)
+
+        print ("    get_output", pin, "port", port, port.layout)
+        m = Module()
+        m.d.comb += port.eq(self._invert_if(invert, pin.o))
+        return m
+
+    def get_tristate(self, pin, port, attrs, invert):
+        self._check_feature("single-ended tristate", pin, attrs,
+                            valid_xdrs=(0,), valid_attrs=None)
+
+        m = Module()
+        m.submodules += Instance("$tribuf",
+            p_WIDTH=pin.width,
+            i_EN=pin.oe,
+            i_A=self._invert_if(invert, pin.o),
+            o_Y=port,
+        )
+        return m
+
+    def get_input_output(self, pin, port, attrs, invert):
+        self._check_feature("single-ended input/output", pin, attrs,
+                            valid_xdrs=(0,), valid_attrs=None)
+        print ("    get_input_output", pin, "port", port, port.layout)
+        m = Module()
+        m.submodules += Instance("$tribuf",
+            p_WIDTH=pin.width,
+            i_EN=pin.oe,
+            i_A=self._invert_if(invert, pin.o),
+            o_Y=port,
+        )
+        m.d.comb += pin.i.eq(self._invert_if(invert, port))
+        return m
+
 
 """
 and to create a Platform instance with that list, and build
@@ -145,9 +243,7 @@ something random
    p.build(Blinker())
 """
 pinset = dummy_pinset()
-resources = create_resources(pinset)
 print(pinset)
-print(resources)
-p = DummyPlatform (resources)
-p.build(Blinker())
+p = DummyPlatform (pinset)
+p.build(Blinker(pinset))