replaced duplicate code with functions, almost working
[pinmux.git] / src / spec / simple_gpio.py
index a543edcfcd7cc8f7cf26abf89b1508a2d425b06e..08ca522e244d15b30709e6474dbcd3d2f0df416d 100644 (file)
@@ -56,6 +56,7 @@ class SimpleGPIO(Elaboratable):
         spec.mask_wid = 4
         spec.reg_wid = wordsize*8 # 32
         self.bus = Record(make_wb_layout(spec), name="gpio_wb")
+        self.wb_rd_data_reg = Signal(self.wordsize*8) # same len as WB bus
 
         #print("CSRBUS layout: ", csrbus_layout)
         # MultiCSR read and write buses
@@ -84,59 +85,47 @@ class SimpleGPIO(Elaboratable):
         bus = self.bus
         wb_rd_data = bus.dat_r
         wb_wr_data = bus.dat_w
+        wb_rd_data_reg = self.wb_rd_data_reg
         wb_ack = bus.ack
 
         gpio_ports = self.gpio_ports
         multi = self.multicsrbus
         rd_multi = self.rd_multicsr
 
-        comb += wb_ack.eq(0)
-
-        row_const = []
-        for row in range(self.n_rows):
-            row_const.append(Const(row))
-
-        # log2_int(1) will give 0, which wouldn't work?
-        if (self.n_gpio == 1):
-            row_start = Signal(1)
-        else:
-            row_start = Signal(log2_int(self.n_gpio))
-
         # Flag for indicating rd/wr transactions
         new_transaction = Signal(1)
 
-        #print("Types:")
-        #print("gpio_addr: ", type(gpio_addr))
-
         # One address used to configure CSR, set output, read input
         with m.If(bus.cyc & bus.stb):
-            comb += wb_ack.eq(1) # always ack
-            # Probably wasteful
-            sync += row_start.eq(bus.adr * self.wordsize)
+            sync += wb_ack.eq(1) # always ack, always delayed
+            # TODO: is this needed anymore?
             sync += new_transaction.eq(1)
+            # Concatinate the GPIO configs that are on the same "row" or
+            # address and send
+            multi_cat = []
+            for i in range(0, self.wordsize):
+                multi_cat.append(rd_multi[i])
+            sync += wb_rd_data_reg.eq(Cat(multi_cat))
             with m.If(bus.we): # write
                 # Configure CSR
                 for byte in range(0, self.wordsize):
+                    # TODO: wasteful... convert to Cat(), somehow
                     sync += multi[byte].eq(wb_wr_data[byte*8:8+byte*8])
-            with m.Else(): # read
-                # Concatinate the GPIO configs that are on the same "row" or
-                # address and send
-                multi_cat = []
-                for i in range(0, self.wordsize):
-                    multi_cat.append(rd_multi[i])
-                comb += wb_rd_data.eq(Cat(multi_cat))
         with m.Else():
             sync += new_transaction.eq(0)
+            sync += wb_ack.eq(0)
+
+        with m.If(wb_ack): # read (and acked)
+            comb += wb_rd_data.eq(wb_rd_data_reg)
+
+        self.connect_gpio_to_rd_bus(m, sync, bus.adr, gpio_ports, rd_multi)
 
         # Only update GPIOs config if a new transaction happened last cycle
         # (read or write). Always lags from multi csrbus by 1 clk cycle, most
         # sane way I could think of while using Record().
         with m.If(new_transaction):
             self.connect_wr_bus_to_gpio(m, sync, bus.adr, gpio_ports, multi)
-        self.connect_gpio_to_rd_bus(m, sync, bus.adr, gpio_ports, rd_multi)
-        #with m.Else():
-        #    print("Copy gpio_ports to multi...")
-        #    sync += multi[]
+
         return m
 
     def connect_wr_bus_to_gpio(self, module, domain, addr, gp, multi):
@@ -144,20 +133,13 @@ class SimpleGPIO(Elaboratable):
             print("#GPIOs is greater than, and is a multiple of WB wordsize")
             # Case where all gpios fit within full words
             if self.n_gpio % self.wordsize == 0:
-                for row in range(self.n_rows):
-                    with module.If(addr == Const(row)):
-                        offset = row*self.wordsize
-                        for byte in range(self.wordsize):
-                            domain += gp[byte+offset].oe.eq(multi[byte].oe)
-                            domain += gp[byte+offset].puen.eq(multi[byte].puen)
-                            domain += gp[byte+offset].pden.eq(multi[byte].pden)
-                            # prevent output being set if GPIO configured as i
-                            # TODO: No checking is done if ie/oe high together
-                            with module.If(multi[byte].oe):
-                                domain += gp[byte+offset].o.eq(multi[byte].io)
-                            with module.Else():
-                                domain += multi[byte].io.eq(gp[byte+offset].i)
-                            domain += gp[byte+offset].bank.eq(multi[byte].bank)
+                for byte in range(self.wordsize):
+                    with module.If(addr[0]):
+                        self.wr_connect_one_byte(module, domain, gp, multi,
+                                                 byte, self.wordsize)
+                    with module.Else():
+                        self.wr_connect_one_byte(module, domain, gp, multi,
+                                                 byte, 0)
             else:
                 # TODO: This is a complex case, not needed atm
                 print("#GPIOs is greater than WB wordsize")
@@ -167,36 +149,18 @@ class SimpleGPIO(Elaboratable):
         else:
             print("#GPIOs is less or equal to WB wordsize (in bytes)")
             for byte in range(self.n_gpio):
-                domain += gp[byte].oe.eq(multi[byte].oe)
-                domain += gp[byte].puen.eq(multi[byte].puen)
-                domain += gp[byte].pden.eq(multi[byte].pden)
-                # Check to prevent output being set if GPIO configured as i
-                # TODO: No checking is done if ie/oe high together
-                with module.If(multi[byte].oe):
-                    domain += gp[byte].o.eq(multi[byte].io)
-                with module.Else():
-                    domain += gp[byte].o.eq(0)
-                domain += gp[byte].bank.eq(multi[byte].bank)
+                self.wr_connect_one_byte(module, domain, gp, multi, byte, 0)
 
     def connect_gpio_to_rd_bus(self, module, domain, addr, gp, multi):
         if self.n_gpio > self.wordsize:
             print("#GPIOs is greater than, and is a multiple of WB wordsize")
             # Case where all gpios fit within full words
             if self.n_gpio % self.wordsize == 0:
-                for row in range(self.n_rows):
-                    with module.If(addr == Const(row)):
-                        offset = row*self.wordsize
-                        for byte in range(self.wordsize):
-                            domain += multi[byte].oe.eq(gp[byte+offset].oe)
-                            domain += multi[byte].puen.eq(gp[byte+offset].puen)
-                            domain += multi[byte].pden.eq(gp[byte+offset].pden)
-                            # prevent output being set if GPIO configured as i
-                            # TODO: No checking is done if ie/oe high together
-                            with module.If(gp[byte+offset].oe):
-                                domain += multi[byte].io.eq(gp[byte+offset].o)
-                            with module.Else():
-                                domain += multi[byte].io.eq(gp[byte+offset].i)
-                            domain += multi[byte].bank.eq(gp[byte+offset].bank)
+                for byte in range(self.wordsize):
+                    with module.If(addr[0]):
+                        self.rd_connect_one_byte(module, domain, gp, multi, byte, self.wordsize)
+                    with module.Else():
+                        self.rd_connect_one_byte(module, domain, gp, multi, byte, 0)
             else:
                 # TODO: This is a complex case, not needed atm
                 print("#GPIOs is greater than WB wordsize")
@@ -205,16 +169,32 @@ class SimpleGPIO(Elaboratable):
         else:
             print("#GPIOs is less or equal to WB wordsize (in bytes)")
             for byte in range(self.n_gpio):
-                domain += multi[byte].oe.eq(gp[gpio].oe)
-                domain += multi[byte].puen.eq(gp[gpio].puen)
-                domain += multi[byte].pden.eq(gp[gpio].pden)
-                # Check to prevent output being set if GPIO configured as i
-                # TODO: No checking is done if ie/oe high together
-                with module.If(multi[byte].oe):
-                    domain += multi[byte].io.eq(gp[gpio].o)
-                with module.Else():
-                    domain += multi[byte].io.eq(gp[byte].i)
-                domain += multi[byte].bank.eq(gp[gpio].bank)
+                self.rd_connect_one_byte(module, domain, gp, multi, byte, 0)
+
+    def rd_connect_one_byte(self, module, domain, gp, multi, byte, offset):
+        domain += multi[byte].oe.eq(gp[byte+offset].oe)
+        domain += multi[byte].puen.eq(gp[byte+offset].puen)
+        domain += multi[byte].pden.eq(gp[byte+offset].pden)
+        with module.If(gp[byte+offset].oe):
+            domain += multi[byte].ie.eq(0)
+            domain += multi[byte].io.eq(gp[byte+offset].o)
+        with module.Else():
+            domain += multi[byte].ie.eq(1) # Return GPIO as i by default
+            domain += multi[byte].io.eq(gp[byte+offset].i)
+
+        domain += multi[byte].bank.eq(gp[byte+offset].bank)
+
+    def wr_connect_one_byte(self, module, domain, gp, multi, byte, offset):
+        domain += gp[byte+offset].oe.eq(multi[byte].oe)
+        domain += gp[byte+offset].puen.eq(multi[byte].puen)
+        domain += gp[byte+offset].pden.eq(multi[byte].pden)
+        # prevent output being set if GPIO configured as i
+        # TODO: No checking is done if ie/oe high together
+        with module.If(multi[byte].oe):
+            domain += gp[byte+offset].o.eq(multi[byte].io)
+        with module.Else():
+            domain += gp[byte+offset].o.eq(0)
+        domain += gp[byte+offset].bank.eq(multi[byte].bank)
 
 
     def __iter__(self):
@@ -539,6 +519,7 @@ def gen_gtkw_doc(n_gpios, wordsize, filename):
                         ('gpio_wb__we', 'in'),
                         ('gpio_wb__adr[27:0]', 'in'),
                         ('gpio_wb__dat_w[{}:0]'.format(wb_data_width-1), 'in'),
+                        ('wb_rd_data_reg[{}:0]'.format(wb_data_width-1), ''),
                         ('gpio_wb__dat_r[{}:0]'.format(wb_data_width-1), 'out'),
                         ('gpio_wb__ack', 'out'),
                 ])
@@ -547,11 +528,25 @@ def gen_gtkw_doc(n_gpios, wordsize, filename):
     gpio_internal_traces = ('Internal', [
                                 ('clk', 'in'),
                                 ('new_transaction'),
-                                ('row_start[2:0]'),
                                 ('rst', 'in')
                             ])
     traces.append(gpio_internal_traces)
 
+    traces.append({'comment': 'Multi-byte GPIO config read bus'})
+    for word in range(0, wordsize):
+        prefix = "rd_word{}__".format(word)
+        single_word = []
+        word_signals = []
+        single_word.append('Word{}'.format(word))
+        word_signals.append((prefix+'bank[{}:0]'.format(NUMBANKBITS-1)))
+        word_signals.append((prefix+'ie'))
+        word_signals.append((prefix+'io'))
+        word_signals.append((prefix+'oe'))
+        word_signals.append((prefix+'pden'))
+        word_signals.append((prefix+'puen'))
+        single_word.append(word_signals)
+        traces.append(tuple(single_word))
+
     traces.append({'comment': 'Multi-byte GPIO config bus'})
     for word in range(0, wordsize):
         prefix = "word{}__".format(word)
@@ -615,7 +610,7 @@ def test_gpioman(dut):
     gpios.print_info()
     #gpios._parse_gpio_arg("all")
     #gpios._parse_gpio_arg("0")
-    gpios._parse_gpio_arg("1-3")
+    #gpios._parse_gpio_arg("1-3")
     #gpios._parse_gpio_arg("20")
 
     oe = 1
@@ -626,7 +621,7 @@ def test_gpioman(dut):
     bank = 3
     yield from gpios.config("0-3", oe=1, ie=0, puen=0, pden=1, outval=0, bank=2)
     ie = 1
-    yield from gpios.config("4-7", oe=0, ie=1, puen=0, pden=1, outval=0, bank=2)
+    yield from gpios.config("4-7", oe=0, ie=1, puen=0, pden=1, outval=0, bank=6)
     yield from gpios.set_out("0-3", outval=1)
 
     #yield from gpios.rd_all()