from collections import OrderedDict
from jtag import JTAG, resiotypes
from copy import deepcopy
+from nmigen.cli import rtlil
+import sys
# extra dependencies for jtag testing (?)
from soc.bus.sram import SRAM
from soc.debug.dmi import DMIInterface, DBGCore
from soc.debug.test.dmi_sim import dmi_sim
from soc.debug.test.jtagremote import JTAGServer, JTAGClient
+from nmigen.build.res import ResourceError
# Was thinking of using these functions, but skipped for simplicity for now
# XXX nope. the output from JSON file.
gpios.append("%d*" % i)
return {'uart': ['tx+', 'rx-'],
'gpio': gpios,
+ #'jtag': ['tms-', 'tdi-', 'tdo+', 'tck+'],
'i2c': ['sda*', 'scl+']}
"""
return resources
+def JTAGResource(*args):
+ io = []
+ io.append(Subsignal("tms", Pins("tms", dir="i", assert_width=1)))
+ io.append(Subsignal("tdi", Pins("tdi", dir="i", assert_width=1)))
+ io.append(Subsignal("tck", Pins("tck", dir="i", assert_width=1)))
+ io.append(Subsignal("tdo", Pins("tdo", dir="o", assert_width=1)))
+ return Resource.family(*args, default_name="jtag", ios=io)
+
def UARTResource(*args, rx, tx):
io = []
io.append(Subsignal("rx", Pins(rx, dir="i", assert_width=1)))
# ridiculously-simple top-level module. doesn't even have a sync domain
# and can't have one until a clock has been established by ASICPlatform.
class Blinker(Elaboratable):
- def __init__(self, pinset):
+ def __init__(self, pinset, resources):
self.jtag = JTAG({}, "sync")
+ self.jtag.pad_mgr = ResourceManager([], [])
+ self.jtag.core_mgr = ResourceManager([], [])
+ self.jtag.pad_mgr.add_resources(resources)
+ self.jtag.core_mgr.add_resources(resources)
+ # record resource lookup between core IO names and pads
+ self.jtag.padlookup = {}
+ self.jtag.requests_made = []
memory = Memory(width=32, depth=16)
self.sram = SRAM(memory=memory, bus=self.jtag.wb)
-
def elaborate(self, platform):
+ jtag_resources = self.jtag.pad_mgr.resources
+ core_resources = self.jtag.core_mgr.resources
m = Module()
m.submodules.jtag = self.jtag
m.submodules.sram = self.sram
count = Signal(5)
- m.d.sync += count.eq(5)
- print ("resources", platform.resources.items())
- gpio = platform.request('gpio')
+ m.d.sync += count.eq(count+1)
+ print ("resources", platform, jtag_resources.items())
+ gpio = self.jtag_request(m, 'gpio')
print (gpio, gpio.layout, gpio.fields)
# get the GPIO bank, mess about with some of the pins
m.d.comb += gpio.gpio0.io.o.eq(1)
m.d.comb += gpio.gpio1.io.oe.eq(count[4])
m.d.sync += count[0].eq(gpio.gpio1.io.i)
# get the UART resource, mess with the output tx
- uart = platform.request('uart')
+ uart = self.jtag_request(m, 'uart')
print (uart, uart.fields)
intermediary = Signal()
m.d.comb += uart.tx.eq(intermediary)
m.d.comb += intermediary.eq(uart.rx)
+
+ # platform requested: make the exact same requests,
+ # then add JTAG afterwards
+ if platform is not None:
+ for (name, number, dir, xdr) in self.jtag.requests_made:
+ platform.request(name, number, dir=dir, xdr=xdr)
+
+ # wire up JTAG otherwise we are in trouble (no clock)
+ jtag = platform.request('jtag')
+ m.d.comb += self.jtag.bus.tdi.eq(jtag.tdi)
+ m.d.comb += self.jtag.bus.tck.eq(jtag.tck)
+ m.d.comb += self.jtag.bus.tms.eq(jtag.tms)
+ m.d.comb += jtag.tdo.eq(self.jtag.bus.tdo)
+
return m
+ def ports(self):
+ return list(self)
+
+ def __iter__(self):
+ yield self.jtag.bus.tdi
+ yield self.jtag.bus.tdo
+ yield self.jtag.bus.tck
+ yield self.jtag.bus.tms
+
+ def jtag_request(self, m, name, number=0, *, dir=None, xdr=None):
+ """request a Resource (e.g. name="uart", number=0) which will
+ return a data structure containing Records of all the pins.
+
+ this override will also - automatically - create a JTAG Boundary Scan
+ connection *without* any change to the actual Platform.request() API
+ """
+ pad_mgr = self.jtag.pad_mgr
+ core_mgr = self.jtag.core_mgr
+ padlookup = self.jtag.padlookup
+ # okaaaay, bit of shenanigens going on: the important data structure
+ # here is Resourcemanager._ports. requests add to _ports, which is
+ # what needs redirecting. therefore what has to happen is to
+ # capture the number of ports *before* the request. sigh.
+ start_ports = len(core_mgr._ports)
+ value = core_mgr.request(name, number, dir=dir, xdr=xdr)
+ end_ports = len(core_mgr._ports)
+
+ # take a copy of the requests made
+ self.jtag.requests_made.append((name, number, dir, xdr))
+
+ # now make a corresponding (duplicate) request to the pad manager
+ # BUT, if it doesn't exist, don't sweat it: all it means is, the
+ # application did not request Boundary Scan for that resource.
+ pad_start_ports = len(pad_mgr._ports)
+ pvalue = pad_mgr.request(name, number, dir=dir, xdr=xdr)
+ pad_end_ports = len(pad_mgr._ports)
+
+ # ok now we have the lengths: now create a lookup between the pad
+ # and the core, so that JTAG boundary scan can be inserted in between
+ core = core_mgr._ports[start_ports:end_ports]
+ pads = pad_mgr._ports[pad_start_ports:pad_end_ports]
+ # oops if not the same numbers added. it's a duplicate. shouldn't happen
+ assert len(core) == len(pads), "argh, resource manager error"
+ print ("core", core)
+ print ("pads", pads)
+
+ # pad/core each return a list of tuples of (res, pin, port, attrs)
+ for pad, core in zip(pads, core):
+ # create a lookup on pin name to get at the hidden pad instance
+ # this pin name will be handed to get_input, get_output etc.
+ # and without the padlookup you can't find the (duplicate) pad.
+ # note that self.padlookup and self.jtag.ios use the *exact* same
+ # pin.name per pin
+ padpin = pad[1]
+ corepin = core[1]
+ if padpin is None: continue # skip when pin is None
+ assert corepin is not None # if pad was None, core should be too
+ print ("iter", pad, padpin.name)
+ print ("existing pads", padlookup.keys())
+ assert padpin.name not in padlookup # no overwrites allowed!
+ assert padpin.name == corepin.name # has to be the same!
+ padlookup[padpin.name] = (core, pad) # store pad by pin name
+
+ # now add the IO Shift Register. first identify the type
+ # then request a JTAG IOConn. we can't wire it up (yet) because
+ # we don't have a Module() instance. doh. that comes in get_input
+ # and get_output etc. etc.
+ iotype = resiotypes[padpin.dir] # look up the C4M-JTAG IOType
+ io = self.jtag.add_io(iotype=iotype, name=padpin.name) # IOConn
+ self.jtag.ios[padpin.name] = io # store IOConn Record by pin name
+
+ # and connect up core to pads based on type
+ if padpin.dir == 'i':
+ print ("jtag_request add input pin", padpin)
+ print (" corepin", corepin)
+ print (" jtag io core", io.core)
+ print (" jtag io pad", io.pad)
+ # corepin is to be returned, here. so, connect jtag corein to it
+ m.d.comb += corepin.i.eq(io.core.i)
+ # and padpin to JTAG pad
+ m.d.comb += io.pad.i.eq(padpin.i)
+ elif padpin.dir == 'o':
+ print ("jtag_request add output pin", padpin)
+ print (" corepin", corepin)
+ print (" jtag io core", io.core)
+ print (" jtag io pad", io.pad)
+ # corepin is to be returned, here. connect it to jtag core out
+ m.d.comb += io.core.o.eq(corepin.o)
+ # and JTAG pad to padpin
+ m.d.comb += padpin.o.eq(io.pad.o)
+ elif padpin.dir == 'io':
+ print ("jtag_request add io pin", padpin)
+ print (" corepin", corepin)
+ print (" jtag io core", io.core)
+ print (" jtag io pad", io.pad)
+ # corepin is to be returned, here. so, connect jtag corein to it
+ m.d.comb += corepin.i.eq(io.core.i)
+ # and padpin to JTAG pad
+ m.d.comb += io.pad.i.eq(padpin.i)
+ # corepin is to be returned, here. connect it to jtag core out
+ m.d.comb += io.core.o.eq(corepin.o)
+ # and JTAG pad to padpin
+ m.d.comb += padpin.o.eq(io.pad.o)
+ # corepin is to be returned, here. connect it to jtag core out
+ m.d.comb += io.core.oe.eq(corepin.oe)
+ # and JTAG pad to padpin
+ m.d.comb += padpin.oe.eq(io.pad.oe)
+
+ # finally return the *CORE* value just like ResourceManager.request()
+ # so that the module using this can connect to *CORE* i/o to the
+ # resource. pads are taken care of
+ return value
+
'''
_trellis_command_templates = [
connectors = []
resources = OrderedDict()
required_tools = []
- command_templates = ['/bin/true']
+ command_templates = ['/bin/true'] # no command needed: stops barfing
file_templates = {
**TemplatedPlatform.build_script_templates,
"{{name}}.il": r"""
default_rst = "rst" # should be picked up / overridden by platform sys.rst
def __init__(self, resources, jtag):
- self.pad_mgr = ResourceManager([], [])
self.jtag = jtag
super().__init__()
+
# create set of pin resources based on the pinset, this is for the core
+ #jtag_resources = self.jtag.pad_mgr.resources
self.add_resources(resources)
- # record resource lookup between core IO names and pads
- self.padlookup = {}
- def request(self, name, number=0, *, dir=None, xdr=None):
+ # add JTAG without scan
+ self.add_resources([JTAGResource('jtag', 0)], no_boundary_scan=True)
+
+ def _request(self, name, number=0, *, dir=None, xdr=None):
"""request a Resource (e.g. name="uart", number=0) which will
return a data structure containing Records of all the pins.
this override will also - automatically - create a JTAG Boundary Scan
connection *without* any change to the actual Platform.request() API
"""
+ pad_mgr = self.jtag.pad_mgr
+ pad_mgr = self.jtag.pad_mgr
+ padlookup = self.jtag.padlookup
# okaaaay, bit of shenanigens going on: the important data structure
# here is Resourcemanager._ports. requests add to _ports, which is
# what needs redirecting. therefore what has to happen is to
# now make a corresponding (duplicate) request to the pad manager
# BUT, if it doesn't exist, don't sweat it: all it means is, the
# application did not request Boundary Scan for that resource.
- pad_start_ports = len(self.pad_mgr._ports)
+ pad_start_ports = len(pad_mgr._ports)
try:
- pvalue = self.pad_mgr.request(name, number, dir=dir, xdr=xdr)
- except AssertionError:
+ pvalue = pad_mgr.request(name, number, dir=dir, xdr=xdr)
+ except ResourceError:
return value
- pad_end_ports = len(self.pad_mgr._ports)
+ pad_end_ports = len(pad_mgr._ports)
# ok now we have the lengths: now create a lookup between the pad
# and the core, so that JTAG boundary scan can be inserted in between
core = self._ports[start_ports:end_ports]
- pads = self.pad_mgr._ports[pad_start_ports:pad_end_ports]
+ pads = pad_mgr._ports[pad_start_ports:pad_end_ports]
# oops if not the same numbers added. it's a duplicate. shouldn't happen
assert len(core) == len(pads), "argh, resource manager error"
print ("core", core)
if pin is None: continue # skip when pin is None
assert corepin is not None # if pad was None, core should be too
print ("iter", pad, pin.name)
- print ("existing pads", self.padlookup.keys())
- assert pin.name not in self.padlookup # no overwrites allowed!
+ print ("existing pads", padlookup.keys())
+ assert pin.name not in padlookup # no overwrites allowed!
assert pin.name == corepin.name # has to be the same!
- self.padlookup[pin.name] = pad # store pad by pin name
+ padlookup[pin.name] = pad # store pad by pin name
# now add the IO Shift Register. first identify the type
# then request a JTAG IOConn. we can't wire it up (yet) because
return value
def add_resources(self, resources, no_boundary_scan=False):
+ print ("ASICPlatform add_resources", resources)
super().add_resources(resources)
+ return
if no_boundary_scan:
return
# make a *second* - identical - set of pin resources for the IO ring
padres = deepcopy(resources)
- self.pad_mgr.add_resources(padres)
+ self.jtag.pad_mgr.add_resources(padres)
#def iter_ports(self):
# yield from super().iter_ports()
# 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):
+ padlookup = self.jtag.padlookup
self._check_feature("single-ended input", pin, attrs,
valid_xdrs=(0,), valid_attrs=None)
print("No JTAG chain in-between")
m.d.comb += pin.i.eq(self._invert_if(invert, port))
return m
- (padres, padpin, padport, padattrs) = self.padlookup[pin.name]
+ if pin.name not in padlookup:
+ print("No pin named %s, not connecting to JTAG BS" % pin.name)
+ m.d.comb += pin.i.eq(self._invert_if(invert, port))
+ return m
+ (padres, padpin, padport, padattrs) = padlookup[pin.name]
io = self.jtag.ios[pin.name]
print (" pad", padres, padpin, padport, attrs)
print (" padpin", padpin.layout)
print (" jtag", io.core.layout, io.pad.layout)
- m.d.comb += pin.i.eq(self._invert_if(invert, port))
- m.d.comb += padpin.i.eq(padport)
- m.d.comb += padport.io.eq(io.core.i)
- m.d.comb += io.pad.i.eq(pin.i)
+ m.d.comb += pin.i.eq(io.core.i)
+ m.d.comb += padpin.i.eq(pin.i)
+ m.d.comb += padport.io.eq(self._invert_if(invert, port))
+ m.d.comb += io.pad.i.eq(padport.io)
print("+=+=+= pin: ", pin)
print("+=+=+= port: ", port.layout)
return m
def get_output(self, pin, port, attrs, invert):
+ padlookup = self.jtag.padlookup
self._check_feature("single-ended output", pin, attrs,
valid_xdrs=(0,), valid_attrs=None)
print("No JTAG chain in-between")
m.d.comb += port.eq(self._invert_if(invert, pin.o))
return m
- (padres, padpin, padport, padattrs) = self.padlookup[pin.name]
+ if pin.name not in padlookup:
+ print("No pin named %s, not connecting to JTAG BS" % pin.name)
+ m.d.comb += port.eq(self._invert_if(invert, pin.o))
+ return m
+ (padres, padpin, padport, padattrs) = padlookup[pin.name]
io = self.jtag.ios[pin.name]
print (" pad", padres, padpin, padport, padattrs)
print (" pin", padpin.layout)
print (" jtag", io.core.layout, io.pad.layout)
- m.d.comb += port.eq(self._invert_if(invert, pin.o))
- m.d.comb += padport.io.eq(self._invert_if(invert, padpin.o))
- m.d.comb += io.core.o.eq(port.io)
- m.d.comb += padpin.o.eq(io.pad.o)
+ m.d.comb += io.core.o.eq(self._invert_if(invert, pin.o))
+ m.d.comb += pin.o.eq(padpin.o)
+ m.d.comb += port.eq(padport.io)
+ m.d.comb += padport.io.eq(io.pad.o)
return m
def get_tristate(self, pin, port, attrs, invert):
+ padlookup = self.jtag.padlookup
self._check_feature("single-ended tristate", pin, attrs,
valid_xdrs=(0,), valid_attrs=None)
o_Y=port,
)
return m
- (res, pin, port, attrs) = self.padlookup[pin.name]
+ return m
+ (res, pin, port, attrs) = padlookup[pin.name]
io = self.jtag.ios[pin.name]
print (" pad", res, pin, port, attrs)
print (" pin", pin.layout)
return m
def get_input_output(self, pin, port, attrs, invert):
+ padlookup = self.jtag.padlookup
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 = Module()
if pin.name in ['clk_0', 'rst_0']: # sigh
print("No JTAG chain in-between")
m.submodules += Instance("$tribuf",
)
m.d.comb += pin.i.eq(self._invert_if(invert, port))
return m
- (padres, padpin, padport, padattrs) = self.padlookup[pin.name]
+ (padres, padpin, padport, padattrs) = padlookup[pin.name]
io = self.jtag.ios[pin.name]
- print (" pad", padres, padpin, padport, padattrs)
- print (" pin", padpin.layout)
+ print (" padres", padres)
+ print (" padpin", padpin)
+ print (" layout", padpin.layout)
+ print (" padport", padport)
+ print (" layout", padport.layout)
+ print (" padattrs", padattrs)
print (" port layout", port.layout)
- print (" jtag", io.core.layout, io.pad.layout)
+ print (" pin", pin)
+ print (" layout", pin.layout)
+ print (" jtag io.core", io.core.layout)
+ print (" jtag io.pad", io.pad.layout)
#m.submodules += Instance("$tribuf",
# p_WIDTH=pin.width,
# i_EN=io.pad.oe,
port_i = port.io[0]
port_o = port.io[1]
port_oe = port.io[2]
-
+
padport_i = padport.io[0]
padport_o = padport.io[1]
padport_oe = padport.io[2]
- # Connect SoC pins to SoC port
- m.d.comb += pin.i.eq(port_i)
- m.d.comb += port_o.eq(pin.o)
- m.d.comb += port_oe.eq(pin.oe)
- # Connect SoC port to JTAG io.core side
- m.d.comb += port_i.eq(io.core.i)
- m.d.comb += io.core.o.eq(port_o)
- m.d.comb += io.core.oe.eq(port_oe)
- # Connect JTAG io.pad side to pad port
+ # connect i
+ m.d.comb += pin.i.eq(io.core.i)
+ m.d.comb += padpin.i.eq(pin.i)
+ m.d.comb += padport_i.eq(self._invert_if(invert, port_i))
m.d.comb += io.pad.i.eq(padport_i)
+
+ # connect o
+ m.d.comb += io.core.o.eq(self._invert_if(invert, pin.o))
+ m.d.comb += pin.o.eq(padpin.o)
+ m.d.comb += port_o.eq(padport_o)
m.d.comb += padport_o.eq(io.pad.o)
+
+ # connect oe
+ m.d.comb += io.core.oe.eq(self._invert_if(invert, pin.oe))
+ m.d.comb += pin.oe.eq(padpin.oe)
+ m.d.comb += port_oe.eq(padport_oe)
m.d.comb += padport_oe.eq(io.pad.oe)
- # Connect pad port to pad pins
- m.d.comb += padport_i.eq(padpin.i)
- m.d.comb += padpin.o.eq(padport_o)
- m.d.comb += padpin.oe.eq(padport_oe)
+
return m
def toolchain_prepare(self, fragment, name, **kwargs):
p.build(Blinker())
"""
pinset = dummy_pinset()
-top = Blinker(pinset)
-
-# XXX these modules are all being added *AFTER* the build process links
-# everything together. the expectation that this would work is... unrealistic.
-# ordering, clearly, is important.
-
-# dut = JTAG(test_pinset(), wb_data_wid=64, domain="sync")
-top.jtag.stop = False
-# rather than the client access the JTAG bus directly
-# create an alternative that the client sets
-class Dummy: pass
-cdut = Dummy()
-cdut.cbus = JTAGInterface()
-
-# set up client-server on port 44843-something
-top.jtag.s = JTAGServer()
-cdut.c = JTAGClient()
-top.jtag.s.get_connection()
-#else:
-# print ("running server only as requested, use openocd remote to test")
-# sys.stdout.flush()
-# top.jtag.s.get_connection(None) # block waiting for connection
-
-# take copy of ir_width and scan_len
-cdut._ir_width = top.jtag._ir_width
-cdut.scan_len = top.jtag.scan_len
-
print(pinset)
resources = create_resources(pinset)
-p = ASICPlatform (resources, top.jtag)
-p.build(top)
-# this is what needs to gets treated as "top", after "main module" top
-# is augmented with IO pads with JTAG tacked on. the expectation that
-# the get_input() etc functions will be called magically by some other
-# function is unrealistic.
-top_fragment = p.fragment
+top = Blinker(pinset, resources)
+
+vl = rtlil.convert(top, ports=top.ports())
+with open("test_jtag_blinker.il", "w") as f:
+ f.write(vl)
+
+sys.exit(0)
+
+if False:
+ # XXX these modules are all being added *AFTER* the build process links
+ # everything together. the expectation that this would work is...
+ # unrealistic. ordering, clearly, is important.
+
+ # dut = JTAG(test_pinset(), wb_data_wid=64, domain="sync")
+ top.jtag.stop = False
+ # rather than the client access the JTAG bus directly
+ # create an alternative that the client sets
+ class Dummy: pass
+ cdut = Dummy()
+ cdut.cbus = JTAGInterface()
+
+ # set up client-server on port 44843-something
+ top.jtag.s = JTAGServer()
+ cdut.c = JTAGClient()
+ top.jtag.s.get_connection()
+ #else:
+ # print ("running server only as requested, use openocd remote to test")
+ # sys.stdout.flush()
+ # top.jtag.s.get_connection(None) # block waiting for connection
+
+ # take copy of ir_width and scan_len
+ cdut._ir_width = top.jtag._ir_width
+ cdut.scan_len = top.jtag.scan_len
+
+ p = ASICPlatform (resources, top.jtag)
+ p.build(top)
+ # this is what needs to gets treated as "top", after "main module" top
+ # is augmented with IO pads with JTAG tacked on. the expectation that
+ # the get_input() etc functions will be called magically by some other
+ # function is unrealistic.
+ top_fragment = p.fragment
# XXX simulating top (the module that does not itself contain IO pads
# because that's covered by build) cannot possibly be expected to work
# particularly when modules have been added *after* the platform build()
# function has been called.
-sim = Simulator(top_fragment)
+sim = Simulator(top)
sim.add_clock(1e-6, domain="sync") # standard clock
sim.add_sync_process(wrap(jtag_srv(top))) #? jtag server
projects / pinmux.git / blobdiff