From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Thu, 12 May 2022 09:14:04 +0000 (+0100)
Subject: improve gpio.py basic example by passing in a list of pins.
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=b1a3f51e9f104441cd87108ce345d775a537573b;p=nmigen.git

improve gpio.py basic example by passing in a list of pins.
the previous version was a little... odd: enumerating the actual bits
of an 8-bit Signal as an Array
---

diff --git a/examples/basic/gpio.py b/examples/basic/gpio.py
index 6905db4..7d93e46 100644
--- a/examples/basic/gpio.py
+++ b/examples/basic/gpio.py
@@ -1,27 +1,38 @@
-from nmigen import *
+from nmigen import Elaboratable, Array, Record, Signal, Module
 from nmigen.cli import main
 
 
 class GPIO(Elaboratable):
+    """GPIO demo class, takes an Array of pins and a bus Record.
+    reading is combinatorial, writing to the GPIO pins is latched (sync)
+    """
     def __init__(self, pins, bus):
-        self.pins = pins
+        self.pins = Array(pins)
         self.bus  = bus
 
     def elaborate(self, platform):
         m = Module()
+        # output (reading) is combinatorial, done all the time
         m.d.comb += self.bus.r_data.eq(self.pins[self.bus.addr])
+        # input (writing) to the GPIOs is done only on "write-enable"
         with m.If(self.bus.we):
             m.d.sync += self.pins[self.bus.addr].eq(self.bus.w_data)
         return m
 
 
 if __name__ == "__main__":
+    # declare number of GPIOs and the width
+    n_pins = 8
+    gpio_width = 8
+    # create a bus from a  Record for the read/write access to the GPIOs
     bus = Record([
-        ("addr",   3),
-        ("r_data", 1),
-        ("w_data", 1),
+        ("addr",   n_pins.bit_length()-1),
+        ("r_data", gpio_width),
+        ("w_data", gpio_width),
         ("we",     1),
     ])
-    pins = Signal(8)
-    gpio = GPIO(Array(pins), bus)
-    main(gpio, ports=[pins, bus.addr, bus.r_data, bus.w_data, bus.we])
+    # create an array of pins and pass them to the GPIO class.
+    pins = [Signal(gpio_width) for i in range(n_pins)]
+    gpio = GPIO(pins, bus)
+    # convenient function to either run simulation or generate verilog/ilang
+    main(gpio, ports=pins + [bus.addr, bus.r_data, bus.w_data, bus.we])