src/spec/testing_stage1.py

   1 #!/usr/bin/env python3
   2 from nmigen.build.dsl import Resource, Subsignal, Pins
   3 from nmigen.build.plat import TemplatedPlatform
   4 from nmigen.build.res import ResourceManager, ResourceError
   5 from nmigen import Elaboratable, Signal, Module, Instance
   6 from collections import OrderedDict
   7 from jtag import JTAG, resiotypes
   8 from copy import deepcopy
   9
  10 # Was thinking of using these functions, but skipped for simplicity for now
  11 # XXX nope.  the output from JSON file.
  12 #from pinfunctions import (i2s, lpc, emmc, sdmmc, mspi, mquadspi, spi,
  13 # quadspi, i2c, mi2c, jtag, uart, uartfull, rgbttl, ulpi, rgmii, flexbus1,
  14 # flexbus2, sdram1, sdram2, sdram3, vss, vdd, sys, eint, pwm, gpio)
  15
  16 # File for stage 1 pinmux tested proposed by Luke,
  17 # https://bugs.libre-soc.org/show_bug.cgi?id=50#c10
  18
  19
  20 def dummy_pinset():
  21     # sigh this needs to come from pinmux.
  22     gpios = []
  23     for i in range(4):
  24         gpios.append("%d*" % i)
  25     return {'uart': ['tx+', 'rx-'],
  26             'gpio': gpios,
  27             'i2c': ['sda*', 'scl+']}
  28
  29 """
  30 a function is needed which turns the results of dummy_pinset()
  31 into:
  32
  33 [UARTResource("uart", 0, tx=..., rx=..),
  34  I2CResource("i2c", 0, scl=..., sda=...),
  35  Resource("gpio", 0, Subsignal("i"...), Subsignal("o"...)
  36  Resource("gpio", 1, Subsignal("i"...), Subsignal("o"...)
  37  ...
  38 ]
  39 """
  40
  41
  42 def create_resources(pinset):
  43     resources = []
  44     for periph, pins in pinset.items():
  45         print(periph, pins)
  46         if periph == 'i2c':
  47             #print("I2C required!")
  48             resources.append(I2CResource('i2c', 0, sda='sda', scl='scl'))
  49         elif periph == 'uart':
  50             #print("UART required!")
  51             resources.append(UARTResource('uart', 0, tx='tx', rx='rx'))
  52         elif periph == 'gpio':
  53             #print("GPIO required!")
  54             print ("GPIO is defined as '*' type, meaning i, o and oe needed")
  55             ios = []
  56             for pin in pins:
  57                 pname = "gpio"+pin[:-1] # strip "*" on end
  58                 # urrrr... tristsate and io assume a single pin which is
  59                 # of course exactly what we don't want in an ASIC: we want
  60                 # *all three* pins but the damn port is not outputted
  61                 # as a triplet, it's a single Record named "io". sigh.
  62                 # therefore the only way to get a triplet of i/o/oe
  63                 # is to *actually* create explicit triple pins
  64                 pad = Subsignal("io",
  65                             Pins("%s_i %s_o %s_oe" % (pname, pname, pname),
  66                                  dir="io", assert_width=3))
  67                 ios.append(Resource(pname, 0, pad))
  68             resources.append(Resource.family(periph, 0, default_name="gpio",
  69                                              ios=ios))
  70
  71     # add clock and reset
  72     clk = Resource("clk", 0, Pins("sys_clk", dir="i"))
  73     rst = Resource("rst", 0, Pins("sys_rst", dir="i"))
  74     resources.append(clk)
  75     resources.append(rst)
  76     return resources
  77
  78
  79 def UARTResource(*args, rx, tx):
  80     io = []
  81     io.append(Subsignal("rx", Pins(rx, dir="i", assert_width=1)))
  82     io.append(Subsignal("tx", Pins(tx, dir="o", assert_width=1)))
  83     return Resource.family(*args, default_name="uart", ios=io)
  84
  85
  86 def I2CResource(*args, scl, sda):
  87     io = []
  88     io.append(Subsignal("scl", Pins(scl, dir="io", assert_width=1)))
  89     io.append(Subsignal("sda", Pins(sda, dir="io", assert_width=1)))
  90     return Resource.family(*args, default_name="i2c", ios=io)
  91
  92
  93 # ridiculously-simple top-level module.  doesn't even have a sync domain
  94 # and can't have one until a clock has been established by ASICPlatform.
  95 class Blinker(Elaboratable):
  96     def __init__(self, pinset):
  97         self.jtag = JTAG({}, "sync")
  98
  99     def elaborate(self, platform):
 100         m = Module()
 101         m.submodules.jtag = self.jtag
 102         count = Signal(5)
 103         m.d.sync += count.eq(5)
 104         print ("resources", platform.resources.items())
 105         gpio = platform.request('gpio')
 106         print (gpio, gpio.layout, gpio.fields)
 107         # get the GPIO bank, mess about with some of the pins
 108         m.d.comb += gpio.gpio0.io.o.eq(1)
 109         m.d.comb += gpio.gpio1.io.o.eq(gpio.gpio2.io.i)
 110         m.d.comb += gpio.gpio1.io.oe.eq(count[4])
 111         m.d.sync += count[0].eq(gpio.gpio1.io.i)
 112         # get the UART resource, mess with the output tx
 113         uart = platform.request('uart')
 114         print (uart, uart.fields)
 115         intermediary = Signal()
 116         m.d.comb += uart.tx.eq(intermediary)
 117         m.d.comb += intermediary.eq(uart.rx)
 118         return m
 119
 120
 121 '''
 122     _trellis_command_templates = [
 123         r"""
 124         {{invoke_tool("yosys")}}
 125             {{quiet("-q")}}
 126             {{get_override("yosys_opts")|options}}
 127             -l {{name}}.rpt
 128             {{name}}.ys
 129         """,
 130     ]
 131 '''
 132
 133 # sigh, have to create a dummy platform for now.
 134 # TODO: investigate how the heck to get it to output ilang. or verilog.
 135 # or, anything, really.  but at least it doesn't barf
 136 class ASICPlatform(TemplatedPlatform):
 137     connectors = []
 138     resources = OrderedDict()
 139     required_tools = []
 140     command_templates = ['/bin/true']
 141     file_templates = {
 142         **TemplatedPlatform.build_script_templates,
 143         "{{name}}.il": r"""
 144             # {{autogenerated}}
 145             {{emit_rtlil()}}
 146         """,
 147         "{{name}}.debug.v": r"""
 148             /* {{autogenerated}} */
 149             {{emit_debug_verilog()}}
 150         """,
 151     }
 152     toolchain = None
 153     default_clk = "clk" # should be picked up / overridden by platform sys.clk
 154     default_rst = "rst" # should be picked up / overridden by platform sys.rst
 155
 156     def __init__(self, resources, jtag):
 157         self.pad_mgr = ResourceManager([], [])
 158         self.jtag = jtag
 159         super().__init__()
 160         # create set of pin resources based on the pinset, this is for the core
 161         self.add_resources(resources)
 162         # record resource lookup between core IO names and pads
 163         self.padlookup = {}
 164
 165     def request(self, name, number=0, *, dir=None, xdr=None):
 166         """request a Resource (e.g. name="uart", number=0) which will
 167         return a data structure containing Records of all the pins.
 168
 169         this override will also - automatically - create a JTAG Boundary Scan
 170         connection *without* any change to the actual Platform.request() API
 171         """
 172         # okaaaay, bit of shenanigens going on: the important data structure
 173         # here is Resourcemanager._ports.  requests add to _ports, which is
 174         # what needs redirecting.  therefore what has to happen is to
 175         # capture the number of ports *before* the request. sigh.
 176         start_ports = len(self._ports)
 177         value = super().request(name, number, dir=dir, xdr=xdr)
 178         end_ports = len(self._ports)
 179
 180         # now make a corresponding (duplicate) request to the pad manager
 181         # BUT, if it doesn't exist, don't sweat it: all it means is, the
 182         # application did not request Boundary Scan for that resource.
 183         pad_start_ports = len(self.pad_mgr._ports)
 184         try:
 185             pvalue = self.pad_mgr.request(name, number, dir=dir, xdr=xdr)
 186         except AssertionError:
 187             return value
 188         pad_end_ports = len(self.pad_mgr._ports)
 189
 190         # ok now we have the lengths: now create a lookup between the pad
 191         # and the core, so that JTAG boundary scan can be inserted in between
 192         core = self._ports[start_ports:end_ports]
 193         pads = self.pad_mgr._ports[pad_start_ports:pad_end_ports]
 194         # oops if not the same numbers added. it's a duplicate. shouldn't happen
 195         assert len(core) == len(pads), "argh, resource manager error"
 196         print ("core", core)
 197         print ("pads", pads)
 198
 199         # pad/core each return a list of tuples of (res, pin, port, attrs)
 200         for pad, core in zip(pads, core):
 201             # create a lookup on pin name to get at the hidden pad instance
 202             # this pin name will be handed to get_input, get_output etc.
 203             # and without the padlookup you can't find the (duplicate) pad.
 204             # note that self.padlookup and self.jtag.ios use the *exact* same
 205             # pin.name per pin
 206             pin = pad[1]
 207             corepin = core[1]
 208             if pin is None: continue # skip when pin is None
 209             assert corepin is not None # if pad was None, core should be too
 210             print ("iter", pad, pin.name)
 211             print ("existing pads", self.padlookup.keys())
 212             assert pin.name not in self.padlookup # no overwrites allowed!
 213             assert pin.name == corepin.name       # has to be the same!
 214             self.padlookup[pin.name] = pad        # store pad by pin name
 215
 216             # now add the IO Shift Register.  first identify the type
 217             # then request a JTAG IOConn. we can't wire it up (yet) because
 218             # we don't have a Module() instance. doh. that comes in get_input
 219             # and get_output etc. etc.
 220             iotype = resiotypes[pin.dir] # look up the C4M-JTAG IOType
 221             io = self.jtag.add_io(iotype=iotype, name=pin.name) # create IOConn
 222             self.jtag.ios[pin.name] = io # store IOConn Record by pin name
 223
 224         # finally return the value just like ResourceManager.request()
 225         return value
 226
 227     def add_resources(self, resources, no_boundary_scan=False):
 228         super().add_resources(resources)
 229         if no_boundary_scan:
 230             return
 231         # make a *second* - identical - set of pin resources for the IO ring
 232         padres = deepcopy(resources)
 233         self.pad_mgr.add_resources(padres)
 234
 235     #def iter_ports(self):
 236     #    yield from super().iter_ports()
 237     #    for io in self.jtag.ios.values():
 238     #        print ("iter ports", io.layout, io)
 239     #        for field in io.core.fields:
 240     #            yield getattr(io.core, field)
 241     #        for field in io.pad.fields:
 242     #            yield getattr(io.pad, field)
 243
 244     # XXX these aren't strictly necessary right now but the next
 245     # phase is to add JTAG Boundary Scan so it maaay be worth adding?
 246     # at least for the print statements
 247     def get_input(self, pin, port, attrs, invert):
 248         self._check_feature("single-ended input", pin, attrs,
 249                             valid_xdrs=(0,), valid_attrs=None)
 250
 251         m = Module()
 252         print ("    get_input", pin, "port", port, port.layout)
 253         if pin.name in ['clk_0', 'rst_0']: # sigh
 254             # simple pass-through from port to pin
 255             print("No JTAG chain in-between")
 256             m.d.comb += pin.i.eq(self._invert_if(invert, port))
 257             return m
 258         (padres, padpin, padport, padattrs) = self.padlookup[pin.name]
 259         io = self.jtag.ios[pin.name]
 260         print ("       pad", padres, padpin, padport, attrs)
 261         print ("       padpin", padpin.layout)
 262         print ("      jtag", io.core.layout, io.pad.layout)
 263         m.d.comb += pin.i.eq(self._invert_if(invert, port))
 264         m.d.comb += padpin.i.eq(padport)
 265         m.d.comb += padport.io.eq(io.core.i)
 266         m.d.comb += io.pad.i.eq(pin.i)
 267         return m
 268
 269     def get_output(self, pin, port, attrs, invert):
 270         self._check_feature("single-ended output", pin, attrs,
 271                             valid_xdrs=(0,), valid_attrs=None)
 272
 273         m = Module()
 274         print ("    get_output", pin, "port", port, port.layout)
 275         if pin.name in ['clk_0', 'rst_0']: # sigh
 276             # simple pass-through from pin to port
 277             print("No JTAG chain in-between")
 278             m.d.comb += port.eq(self._invert_if(invert, pin.o))
 279             return m
 280         (padres, padpin, padport, padattrs) = self.padlookup[pin.name]
 281         io = self.jtag.ios[pin.name]
 282         print ("       pad", padres, padpin, padport, padattrs)
 283         print ("       pin", padpin.layout)
 284         print ("      jtag", io.core.layout, io.pad.layout)
 285         m.d.comb += port.eq(self._invert_if(invert, pin.o))
 286         m.d.comb += padport.io.eq(self._invert_if(invert, padpin.o))
 287         m.d.comb += io.core.o.eq(port.io)
 288         m.d.comb += padpin.o.eq(io.pad.o)
 289         return m
 290
 291     def get_tristate(self, pin, port, attrs, invert):
 292         self._check_feature("single-ended tristate", pin, attrs,
 293                             valid_xdrs=(0,), valid_attrs=None)
 294
 295         print ("    get_tristate", pin, "port", port, port.layout)
 296         m = Module()
 297         if pin.name in ['clk_0', 'rst_0']: # sigh
 298             print("No JTAG chain in-between")
 299             m.submodules += Instance("$tribuf",
 300                 p_WIDTH=pin.width,
 301                 i_EN=pin.oe,
 302                 i_A=self._invert_if(invert, pin.o),
 303                 o_Y=port,
 304             )
 305             return m
 306         (res, pin, port, attrs) = self.padlookup[pin.name]
 307         io = self.jtag.ios[pin.name]
 308         print ("       pad", res, pin, port, attrs)
 309         print ("       pin", pin.layout)
 310         print ("      jtag", io.core.layout, io.pad.layout)
 311         #m.submodules += Instance("$tribuf",
 312         #    p_WIDTH=pin.width,
 313         #    i_EN=io.pad.oe,
 314         #    i_A=self._invert_if(invert, io.pad.o),
 315         #    o_Y=port,
 316         #)
 317         m.d.comb += io.core.o.eq(pin.o)
 318         m.d.comb += io.core.oe.eq(pin.oe)
 319         m.d.comb += pin.i.eq(io.core.i)
 320         m.d.comb += io.pad.i.eq(port.i)
 321         m.d.comb += port.o.eq(io.pad.o)
 322         m.d.comb += port.oe.eq(io.pad.oe)
 323         return m
 324
 325     def get_input_output(self, pin, port, attrs, invert):
 326         self._check_feature("single-ended input/output", pin, attrs,
 327                             valid_xdrs=(0,), valid_attrs=None)
 328
 329         print ("    get_input_output", pin, "port", port, port.layout)
 330         m = Module()
 331         if pin.name in ['clk_0', 'rst_0']: # sigh
 332             print("No JTAG chain in-between")
 333             m.submodules += Instance("$tribuf",
 334                 p_WIDTH=pin.width,
 335                 i_EN=pin.oe,
 336                 i_A=self._invert_if(invert, pin.o),
 337                 o_Y=port,
 338             )
 339             m.d.comb += pin.i.eq(self._invert_if(invert, port))
 340             return m
 341         (res, pin, port, attrs) = self.padlookup[pin.name]
 342         io = self.jtag.ios[pin.name]
 343         print ("       pad", res, pin, port, attrs)
 344         print ("       pin", pin.layout)
 345         print ("       port layout", port.layout)
 346         print ("      jtag", io.core.layout, io.pad.layout)
 347         #m.submodules += Instance("$tribuf",
 348         #    p_WIDTH=pin.width,
 349         #    i_EN=io.pad.oe,
 350         #    i_A=self._invert_if(invert, io.pad.o),
 351         #    o_Y=port,
 352         #)
 353         port_i = port.io[0]
 354         port_o = port.io[1]
 355         port_oe = port.io[2]
 356         m.d.comb += io.pad.i.eq(self._invert_if(invert, port_i))
 357         m.d.comb += port_o.eq(self._invert_if(invert, io.pad.o))
 358         m.d.comb += port_oe.eq(io.pad.o)
 359         m.d.comb += pin.i.eq(io.core.i)
 360         m.d.comb += io.core.o.eq(pin.o)
 361         m.d.comb += io.core.oe.eq(pin.oe)
 362         return m
 363
 364
 365 """
 366 and to create a Platform instance with that list, and build
 367 something random
 368
 369    p=Platform()
 370    p.resources=listofstuff
 371    p.build(Blinker())
 372 """
 373 pinset = dummy_pinset()
 374 top = Blinker(pinset)
 375 print(pinset)
 376 resources = create_resources(pinset)
 377 p = ASICPlatform (resources, top.jtag)
 378 p.build(top)
 379