-"""This is the module used for multiplexing IO signals
+"""Simple GPIO peripheral on wishbone
-Documentation: https://libre-soc.org/docs/pinmux/temp_pinmux_info/
-Bug: https://bugs.libre-soc.org/show_bug.cgi?id=762
+This is an extremely simple GPIO peripheral intended for use in XICS
+testing, however it could also be used as an actual GPIO peripheral
+
+Modified for use with pinmux, will probably change the class name later.
"""
-#from random import randint
-from nmigen import Elaboratable, Module, Signal, Record, Array
-#from nmigen.utils import log2_int
+from random import randint
+#from math import ceil, floor
+from nmigen import Elaboratable, Module, Signal, Record, Array, Cat
+from nmigen.hdl.rec import Layout
+from nmigen.utils import log2_int
from nmigen.cli import rtlil
#from soc.minerva.wishbone import make_wb_layout
from nmutil.util import wrap
#from soc.bus.test.wb_rw import wb_read, wb_write
+from nmutil.gtkw import write_gtkw
+
cxxsim = False
if cxxsim:
- from nmigen.sim.cxxsim import Simulator, Settle
+ from nmigen.sim.cxxsim import Simulator, Settle, Delay
else:
- from nmigen.sim import Simulator, Settle
+ from nmigen.sim import Simulator, Settle, Delay
+
+io_layout = (("i", 1),
+ ("oe", 1),
+ ("o", 1)
+ )
-class IOMuxBlock(Elaboratable):
+class IOMuxBlockSingle(Elaboratable):
def __init__(self):
- self.bank_sel = Signal()
-
- self.portin0 = {"i": Signal(), "o": Signal(), "oe": Signal()}
- self.portin1 = {"i": Signal(), "o": Signal(), "oe": Signal()}
- self.portout = {"i": Signal(), "o": Signal(), "oe": Signal()}
+ print("1-bit IO Mux Block")
+ self.n_banks = 4
+ self.bank = Signal(log2_int(self.n_banks))
+
+ temp = []
+ for i in range(self.n_banks):
+ temp_str = "bank{}".format(i)
+ temp.append(Record(name=temp_str, layout=io_layout))
+ self.bank_ports = Array(temp)
+
+ self.out_port = Record(name="IO", layout=io_layout)
+
+ #self.b0 = Record(name="b0", layout=io_layout)
+ #self.b1 = Record(name="b1", layout=io_layout)
def elaborate(self, platform):
m = Module()
comb, sync = m.d.comb, m.d.sync
-
- bank_sel = self.bank_sel
- portin0 = self.portin0
- portin1 = self.portin1
- portout = self.portout
+
+ bank = self.bank
+ bank_ports = self.bank_ports
+ #b0 = self.b0
+ #b1 = self.b1
+ out_port = self.out_port
+
# Connect IO Pad output port to one of the peripheral IOs
- comb += portout["o"].eq(Mux(bank_sel, portin1["o"], portin0["o"]))
- comb += portout["oe"].eq(Mux(bank_sel, portin1["oe"], portin0["oe"]))
-
# Connect peripheral inputs to the IO pad input
- comb += portin0["i"].eq(Mux(bank_sel, 0, portout["i"]))
- comb += portin1["i"].eq(Mux(bank_sel, portout["i"], 0))
+ bank_range = range(self.n_banks)
+ # const
+ BANK0_WB = 0
+ BANK1_P1 = 1
+ BANK2_P2 = 2
+ BANK3_P3 = 3
+
+ with m.Switch(bank):
+ with m.Case(BANK0_WB):
+ self.connect_bank_to_io(comb, BANK0_WB)
+ with m.Case(BANK1_P1):
+ self.connect_bank_to_io(comb, BANK1_P1)
+ with m.Case(BANK2_P2):
+ self.connect_bank_to_io(comb, BANK2_P2)
+ with m.Case(BANK3_P3):
+ self.connect_bank_to_io(comb, BANK3_P3)
return m
+ def connect_bank_to_io(self, domain, bank_arg):
+ domain += self.out_port.o.eq(self.bank_ports[bank_arg].o)
+ domain += self.out_port.oe.eq(self.bank_ports[bank_arg].oe)
+ domain += self.bank_ports[bank_arg].i.eq(self.out_port.i)
+
+ # unnecessary, yosys correctly converted to mux's already
+ #temp_list = list(range(self.n_banks))
+ #temp_list.pop(temp_list.index(bank_arg))
+ #print("Banks with input hardwired to 0: {}".format(temp_list))
+ #for j in range(len(temp_list)):
+ # unused_bank = temp_list[j]
+ # domain += self.bank_ports[unused_bank].i.eq(0)
+
+ def __iter__(self):
+ """ Get member signals for Verilog form. """
+ for field in self.out_port.fields.values():
+ yield field
+ for bank in range(len(self.bank_ports)):
+ for field in self.bank_ports[bank].fields.values():
+ yield field
+ yield self.bank
+
def ports(self):
return list(self)
-def sim_iomux(dut):
- # start by setting portin0
- dut.portin0["o"].eq(1)
- dut.portin0["oe"].eq(1)
- yield
- dut.portout["i"].eq(1)
-
- print("Finished the IO mux block test!")
-
-def test_iomux():
-
- dut = IOMuxBlock()
+def gen_gtkw_doc(module_name, n_banks, filename):
+ # GTKWave doc generation
+ style = {
+ '': {'base': 'hex'},
+ 'in': {'color': 'orange'},
+ 'out': {'color': 'yellow'},
+ 'debug': {'module': 'top', 'color': 'red'}
+ }
+
+ # Create a trace list, each block expected to be a tuple()
+ traces = []
+ for bank in range(0, n_banks):
+ temp_traces = ('Bank{}'.format(bank), [
+ ('bank{}__i'.format(bank), 'in'),
+ ('bank{}__o'.format(bank), 'out'),
+ ('bank{}__oe'.format(bank), 'out')
+ ])
+ traces.append(temp_traces)
+
+ temp_traces = ('Misc', [
+ ('clk'),
+ ('bank[1:0]', 'in')
+ ])
+ traces.append(temp_traces)
+ temp_traces = ('IO port to pad', [
+ ('IO__i', 'in'),
+ ('IO__o', 'out'),
+ ('IO__oe', 'out')
+ ])
+ traces.append(temp_traces)
+ #print(traces)
+
+ write_gtkw(filename+".gtkw", filename+".vcd", traces, style,
+ module=module_name)
+
+def sim_iomux():
+ filename = "test_pinmux" # Doesn't include extension
+ dut = IOMuxBlockSingle()
vl = rtlil.convert(dut, ports=dut.ports())
- with open("test_gpio.il", "w") as f:
+ with open(filename+".il", "w") as f:
f.write(vl)
m = Module()
+ m.submodules.pinmux = dut
- #sim = Simulator(m)
+ sim = Simulator(m)
#sim.add_clock(1e-6)
- #sim.add_sync_process(wrap(sim_gpio(dut)))
- #sim_writer = sim.write_vcd('test_gpio.vcd')
- #with sim_writer:
- # sim.run()
-
+ #sim.add_sync_process(wrap(test_iomux(dut)))
+ sim.add_process(wrap(test_iomux(dut)))
+ sim_writer = sim.write_vcd(filename+".vcd")
+ with sim_writer:
+ sim.run()
+
+ gen_gtkw_doc("top.pinmux", dut.n_banks, filename)
+
+# Method for toggling i/o/oe of a particular bank port,
+# while bank_sel has three different values:
+# value before, given value, value after
+# when rand is True, previous and consecutive values are
+# random (but NOT equal to given bank_sel)
+def test_single_bank(dut, bank, rand=True):
+ if rand:
+ print("Randomising the prev and next banks")
+ prev_bank=bank
+ while(prev_bank == bank):
+ prev_bank = randint(0, dut.n_banks-1)
+ next_bank=bank
+ while(next_bank == bank):
+ next_bank = randint(0, dut.n_banks-1)
+ else:
+ if bank == 0:
+ prev_bank = dut.n_banks
+ else:
+ prev_bank = bank - 1
+
+ if bank == dut.n_banks:
+ next_bank = 0
+ else:
+ next_bank = bank + 1
+
+ print("Prev={}, Given={}, Next={}".format(prev_bank, bank, next_bank))
+
+ yield dut.bank.eq(prev_bank)
+ yield Delay(1e-6)
+ yield dut.bank_ports[bank].o.eq(0)
+ yield dut.bank_ports[bank].oe.eq(0)
+ yield dut.out_port.i.eq(0)
+ yield Delay(1e-6)
+
+ yield dut.bank.eq(bank)
+ yield Delay(1e-6)
+
+ test_o = yield dut.out_port.o
+ test_oe = yield dut.out_port.oe
+ test_i = yield dut.bank_ports[bank].i
+ assert(test_o == 0)
+ assert(test_oe == 0)
+ assert(test_i == 0)
+
+ yield dut.bank_ports[bank].o.eq(1)
+ yield Delay(1e-6)
+ yield dut.bank_ports[bank].oe.eq(1)
+ yield Delay(1e-6)
+ yield dut.out_port.i.eq(1)
+ yield Delay(1e-6)
+
+ test_o = yield dut.out_port.o
+ test_oe = yield dut.out_port.oe
+ test_i = yield dut.bank_ports[bank].i
+ #print(test_o, test_oe, test_i)
+ assert(test_o == 1)
+ assert(test_oe == 1)
+ assert(test_i == 1)
+
+ yield dut.bank.eq(next_bank)
+ yield Delay(1e-6)
+ yield dut.bank_ports[bank].o.eq(0)
+ yield dut.bank_ports[bank].oe.eq(0)
+ yield dut.out_port.i.eq(0)
+ yield Delay(1e-6)
+
+def test_iomux(dut):
+ print("------START----------------------")
+ #print(dir(dut.bank_ports[0]))
+ #print(dut.bank_ports[0].fields)
+
+ # TODO: turn into methods
+ yield from test_single_bank(dut, 0)
+ yield from test_single_bank(dut, 1)
+ yield from test_single_bank(dut, 2)
+ yield from test_single_bank(dut, 3)
+
+ print("Finished the 1-bit IO mux block test!")
if __name__ == '__main__':
- test_iomux()
+ sim_iomux()
projects / pinmux.git / blobdiff