feat(embassy): provide a GPIO API unified across architectures (futur…

…e-proof-iot#322)

.github/workflows/main.yml

@@ -141,7 +141,7 @@ jobs:
           args: --verbose --locked --features no-boards -p riot-rs -p riot-rs-boards -p riot-rs-chips -p riot-rs-debug -p riot-rs-embassy -p riot-rs-macros -p riot-rs-random -p riot-rs-rt -p riot-rs-threads -p riot-rs-utils
 
       - name: rustdoc
-        run: RUSTDOCFLAGS='-D warnings' cargo doc -p riot-rs --features no-boards,bench,threading,random,csprng,hwrng
+        run: RUSTDOCFLAGS='-D warnings' cargo doc -p riot-rs --features no-boards,bench,external-interrupts,threading,random,csprng,hwrng
 
       - name: rustfmt
         run: cargo fmt --check --all

Cargo.toml

@@ -15,6 +15,9 @@ members = [
   "src/riot-rs-macros",
   "src/riot-rs-random",
   "tests/benchmarks/bench_sched_yield",
+  "tests/gpio",
+  "tests/gpio-interrupt-nrf",
+  "tests/gpio-interrupt-stm32",
 ]
 
 exclude = ["src/lib"]
@@ -43,6 +46,8 @@ portable-atomic = { version = "1.6.0", default-features = false, features = [
 ] }
 
 embassy-executor = { version = "0.5", default-features = false }
+embassy-futures = { version = "0.1.1", default-features = false }
+embassy-hal-internal = { version = "0.1.0", default-features = false }
 embassy-net = { version = "0.4", default-features = false }
 embassy-net-driver-channel = { version = "0.2.0", default-features = false }
 embassy-nrf = { version = "0.1", default-features = false }
@@ -52,6 +57,9 @@ embassy-sync = { version = "0.6", default-features = false }
 embassy-time = { version = "0.3", default-features = false }
 embassy-usb = { version = "0.1", default-features = false }
 
+embedded-hal = { version = "1.0.0", default-features = false }
+embedded-hal-async = { version = "1.0.0", default-features = false }
+
 esp-hal = { git = "https://github.com/kaspar030/esp-hal", branch = "for-riot-rs-2024-06-14", default-features = false }
 esp-hal-embassy = { git = "https://github.com/kaspar030/esp-hal", branch = "for-riot-rs-2024-06-14", default-features = false }
 esp-println = { version = "0.9.0" }

_typos.toml

@@ -1,6 +1,7 @@
 [default.extend-words]
 hax = "hax"
 hsi = "hsi"
+extint = "extint" # External interrupt
 
 [default.extend-identifiers]
 celcius = "celcius" # Until embedded-aht20 is fixed

examples/blinky/Cargo.toml

@@ -0,0 +1,18 @@
+[package]
+name = "blinky"
+version = "0.1.0"
+authors.workspace = true
+edition.workspace = true
+publish = false
+
+[lints]
+workspace = true
+
+[dependencies]
+embassy-executor = { workspace = true }
+embassy-time = { workspace = true }
+riot-rs = { path = "../../src/riot-rs", features = [
+  "external-interrupts",
+  "time",
+] }
+riot-rs-boards = { path = "../../src/riot-rs-boards" }

examples/blinky/README.md

@@ -0,0 +1,11 @@
+# blinky
+
+## About
+
+This application is demonstrating basic GPIO output usage with RIOT-rs.
+
+## How to run
+
+In this folder, run
+
+    laze build -b nrf52840dk run

examples/blinky/laze.yml

@@ -0,0 +1,14 @@
+apps:
+  - name: blinky
+    context:
+      # list of contexts that have an entry in `pins.rs`
+      - esp
+      - microbit-v2
+      - nrf52840dk
+      - nrf5340dk
+      - rp
+      - st-nucleo-f401re
+      - st-nucleo-h755zi-q
+      - st-nucleo-wb55
+    selects:
+      - ?release

examples/blinky/src/main.rs

@@ -0,0 +1,23 @@
+#![no_main]
+#![no_std]
+#![feature(type_alias_impl_trait)]
+#![feature(used_with_arg)]
+
+mod pins;
+
+use embassy_time::{Duration, Timer};
+use riot_rs::embassy::gpio::{Level, Output};
+
+#[riot_rs::task(autostart, peripherals)]
+async fn blinky(peripherals: pins::LedPeripherals) {
+    let mut led = Output::new(peripherals.led, Level::Low);
+
+    // The micro:bit uses an LED matrix; pull the column line low.
+    #[cfg(context = "microbit-v2")]
+    let _led_col1 = Output::new(peripherals.led_col1, Level::Low);
+
+    loop {
+        led.toggle();
+        Timer::after(Duration::from_millis(500)).await;
+    }
+}

examples/blinky/src/pins.rs

@@ -0,0 +1,28 @@
+use riot_rs::embassy::arch::peripherals;
+
+#[cfg(context = "microbit-v2")]
+riot_rs::define_peripherals!(LedPeripherals {
+    led_col1: P0_28,
+    led: P0_21,
+});
+
+#[cfg(context = "nrf52840dk")]
+riot_rs::define_peripherals!(LedPeripherals { led: P0_13 });
+
+#[cfg(context = "nrf5340dk")]
+riot_rs::define_peripherals!(LedPeripherals { led: P0_28 });
+
+#[cfg(context = "rp")]
+riot_rs::define_peripherals!(LedPeripherals { led: PIN_1 });
+
+#[cfg(context = "esp")]
+riot_rs::define_peripherals!(LedPeripherals { led: GPIO_0 });
+
+#[cfg(context = "st-nucleo-f401re")]
+riot_rs::define_peripherals!(LedPeripherals { led: PA5 });
+
+#[cfg(context = "st-nucleo-h755zi-q")]
+riot_rs::define_peripherals!(LedPeripherals { led: PB0 });
+
+#[cfg(context = "st-nucleo-wb55")]
+riot_rs::define_peripherals!(LedPeripherals { led: PB5 });

examples/gpio/Cargo.toml

@@ -0,0 +1,19 @@
+[package]
+name = "gpio"
+version = "0.1.0"
+authors.workspace = true
+edition.workspace = true
+publish = false
+
+[lints]
+workspace = true
+
+[dependencies]
+embassy-executor = { workspace = true }
+embassy-futures = { workspace = true }
+embassy-time = { workspace = true }
+riot-rs = { path = "../../src/riot-rs", features = [
+  "external-interrupts",
+  "time",
+] }
+riot-rs-boards = { path = "../../src/riot-rs-boards" }

examples/gpio/README.md

@@ -0,0 +1,11 @@
+# gpio
+
+## About
+
+This application is testing GPIO usage with RIOT-rs.
+
+## How to run
+
+In this folder, run
+
+    laze build -b nrf52840dk run

examples/gpio/laze.yml

@@ -0,0 +1,4 @@
+apps:
+  - name: gpio
+    selects:
+      - ?release

examples/gpio/src/main.rs

@@ -0,0 +1,39 @@
+#![no_main]
+#![no_std]
+#![feature(type_alias_impl_trait)]
+#![feature(used_with_arg)]
+
+mod pins;
+
+use embassy_time::{Duration, Timer};
+use riot_rs::embassy::gpio::{Input, Level, Output, Pull};
+
+#[riot_rs::task(autostart, peripherals)]
+async fn blinky(peripherals: pins::Peripherals) {
+    let mut led1 = Output::new(peripherals.led1, Level::Low);
+
+    #[allow(unused_variables)]
+    let pull = Pull::Up;
+    #[cfg(context = "st-nucleo-h755zi-q")]
+    let pull = Pull::None;
+
+    let mut btn1 = Input::builder(peripherals.btn1, pull)
+        .build_with_interrupt()
+        .unwrap();
+
+    // The micro:bit uses an LED matrix; pull the column line low.
+    #[cfg(context = "microbit-v2")]
+    let _led_col1 = Output::new(peripherals.led_col1, Level::Low);
+
+    loop {
+        // Wait for the button being pressed or 300 ms, whichever comes first.
+        let _ = embassy_futures::select::select(
+            btn1.wait_for_low(),
+            Timer::after(Duration::from_millis(300)),
+        )
+        .await;
+
+        led1.toggle();
+        Timer::after(Duration::from_millis(100)).await;
+    }
+}