Use Amaranth SoC GPIO peripheral.

Author: jfng

chipflow_lib/providers/board_ulx3s.py

@@ -3,10 +3,12 @@
 from amaranth import *
 from amaranth_boards.ulx3s import *
 from amaranth.lib.cdc import ResetSynchronizer
-from amaranth.lib import io
+from amaranth.lib import io, wiring
+from amaranth.lib.wiring import In
+
+from amaranth_soc import gpio
 
 from amaranth_orchard.memory.spimemio import QSPIPins
-from amaranth_orchard.base.gpio import GPIOPins
 from amaranth_orchard.io.uart import UARTPins
 from amaranth_orchard.memory.hyperram import HyperRAMPins
 
@@ -47,29 +49,27 @@ def elaborate(self, platform):
         return m
 
 
-class LEDGPIOProvider(Elaboratable):
-    def __init__(self):
-        self.pins = GPIOPins(width=8)
+class LEDGPIOProvider(wiring.Component):
+    pins: In(gpio.PinSignature()).array(8)
 
     def elaborate(self, platform):
         m = Module()
         for i in range(8):
             led = io.Buffer("o", platform.request("led", i, dir="-"))
             m.submodules[f"led_{i}"] = led
-            m.d.comb += led.o.eq(self.pins.o[i])
+            m.d.comb += led.o.eq(self.pins[i].o)
         return m
 
 
-class ButtonGPIOProvider(Elaboratable):
-    def __init__(self):
-        self.pins = GPIOPins(width=2)
+class ButtonGPIOProvider(wiring.Component):
+    pins: In(gpio.PinSignature()).array(2)
 
     def elaborate(self, platform):
         m = Module()
         for i in range(2):
             btn = io.Buffer("i", platform.request("button_fire", i, dir="-"))
             m.submodules[f"btn_{i}"] = btn
-            m.d.comb += self.pins.i[i].eq(btn.i)
+            m.d.comb += self.pins[i].i.eq(btn.i)
         return m
 
 

chipflow_lib/providers/silicon.py

@@ -2,9 +2,12 @@
 
 from amaranth import *
 from amaranth.lib.cdc import FFSynchronizer
+from amaranth.lib import wiring
+from amaranth.lib.wiring import In
+
+from amaranth_soc import gpio
 
 from amaranth_orchard.memory.spimemio import QSPIPins
-from amaranth_orchard.base.gpio import GPIOPins
 from amaranth_orchard.io.uart import UARTPins
 from amaranth_orchard.memory.hyperram import HyperRAMPins
 
@@ -29,34 +32,32 @@ def elaborate(self, platform):
         return m
 
 
-class LEDGPIOProvider(Elaboratable):
-    def __init__(self):
-        self.pins = GPIOPins(width=8)
+class LEDGPIOProvider(wiring.Component):
+    pins: In(gpio.PinSignature()).array(8)
 
     def elaborate(self, platform):
         m = Module()
         for index in range(8):
             pin = platform.request(f"gpio_{index}")
             m.d.comb += [
-                self.pins.i[index].eq(pin.i),
-                pin.o.eq(self.pins.o[index]),
-                pin.oe.eq(self.pins.oe[index])
+                self.pins[index].i.eq(pin.i),
+                pin.o.eq(self.pins[index].o),
+                pin.oe.eq(self.pins[index].oe),
             ]
         return m
 
 
-class ButtonGPIOProvider(Elaboratable):
-    def __init__(self):
-        self.pins = GPIOPins(width=2)
+class ButtonGPIOProvider(wiring.Component):
+    pins: In(gpio.PinSignature()).array(2)
 
     def elaborate(self, platform):
         m = Module()
         for index in range(2):
             pin = platform.request(f"btn_{index}")
             m.d.comb += [
-                self.pins.i[index].eq(pin.i),
-                pin.o.eq(self.pins.o[index]),
-                pin.oe.eq(self.pins.oe[index])
+                self.pins[index].i.eq(pin.i),
+                pin.o.eq(self.pins[index].o),
+                pin.oe.eq(self.pins[index].oe),
             ]
         return m
 

chipflow_lib/providers/sim.py

@@ -1,9 +1,12 @@
 # SPDX-License-Identifier: BSD-2-Clause
 
 from amaranth import *
+from amaranth.lib import wiring
+from amaranth.lib.wiring import In
+
+from amaranth_soc import gpio
 
 from amaranth_orchard.memory.spimemio import QSPIPins
-from amaranth_orchard.base.gpio import GPIOPins
 from amaranth_orchard.io.uart import UARTPins
 from amaranth_orchard.memory.hyperram import HyperRAMPins
 
@@ -16,21 +19,20 @@ def elaborate(self, platform):
         return platform.add_model("spiflash_model", self.pins, edge_det=['clk_o', 'csn_o'])
 
 
-class LEDGPIOProvider(Elaboratable):
-    def __init__(self):
-        self.pins = GPIOPins(width=8)
+class LEDGPIOProvider(wiring.Component):
+    pins: In(gpio.PinSignature()).array(8)
 
     def elaborate(self, platform):
         return Module()
 
 
-class ButtonGPIOProvider(Elaboratable):
-    def __init__(self):
-        self.pins = GPIOPins(width=2)
+class ButtonGPIOProvider(wiring.Component):
+    pins: In(gpio.PinSignature()).array(2)
 
     def elaborate(self, platform):
         m = Module()
-        m.d.comb += self.pins.i.eq(platform.buttons)
+        for i in range(2):
+            m.d.comb += self.pins[i].i.eq(platform.buttons[i])
         return m
 
 

chipflow_lib/software/drivers/gpio.h

@@ -4,10 +4,45 @@
 
 #include <stdint.h>
 
-typedef struct __attribute__((packed, aligned(4))) {
-	uint32_t out;
-	uint32_t oe;
-	uint32_t in;
+typedef struct __attribute__((packed, aligned(2))) {
+	uint16_t mode;
+	uint8_t input;
+	uint8_t output;
+	uint16_t setclr;
 } gpio_regs_t;
 
+typedef enum {
+#define _GPIO_PIN(n) \
+	GPIO_PIN ## n ## _INPUT_ONLY = (0 << 2 * (n)), \
+	GPIO_PIN ## n ## _PUSH_PULL  = (1 << 2 * (n)), \
+	GPIO_PIN ## n ## _OPEN_DRAIN = (2 << 2 * (n)), \
+	GPIO_PIN ## n ## _ALTERNATE  = (3 << 2 * (n))
+
+	_GPIO_PIN(0),
+	_GPIO_PIN(1),
+	_GPIO_PIN(2),
+	_GPIO_PIN(3),
+	_GPIO_PIN(4),
+	_GPIO_PIN(5),
+	_GPIO_PIN(6),
+	_GPIO_PIN(7),
+#undef _GPIO_PIN
+} gpio_mode_t;
+
+typedef enum {
+#define _GPIO_PIN(n) \
+	GPIO_PIN ## n ## _SET   = (1 << 2 * (n)), \
+	GPIO_PIN ## n ## _CLEAR = (2 << 2 * (n))
+
+	_GPIO_PIN(0),
+	_GPIO_PIN(1),
+	_GPIO_PIN(2),
+	_GPIO_PIN(3),
+	_GPIO_PIN(4),
+	_GPIO_PIN(5),
+	_GPIO_PIN(6),
+	_GPIO_PIN(7),
+#undef _GPIO_PIN
+} gpio_setclr_t;
+
 #endif

chipflow_lib/software/soft_gen.py

@@ -126,11 +126,6 @@ def start(self):
 blt a0, a1, loop_init_bss
 end_init_bss:
 
-# Update LEDs
-li a0, 0xb1000000
-li a1, 2
-sw a1, 0(a0)
-
 # call main
 call main
 loop: