feat: add 0x02_blink_rust driver

2026-07-30 23:57:29 +02:00 · 2026-03-24 17:54:27 -04:00
parent 0fb00852a9
commit 4bb165375f
17 changed files with 1492 additions and 0 deletions
@@ -0,0 +1,100 @@
+//! @file blink.rs
+//! @brief Implementation of the GPIO output / LED blink driver
+//! @author Kevin Thomas
+//! @date 2025
+//!
+//! MIT License
+//!
+//! Copyright (c) 2025 Kevin Thomas
+//!
+//! Permission is hereby granted, free of charge, to any person obtaining a copy
+//! of this software and associated documentation files (the "Software"), to deal
+//! in the Software without restriction, including without limitation the rights
+//! to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//! copies of the Software, and to permit persons to whom the Software is
+//! furnished to do so, subject to the following conditions:
+//!
+//! The above copyright notice and this permission notice shall be included in
+//! all copies or substantial portions of the Software.
+//!
+//! THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//! IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//! FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//! AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//! LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+//! SOFTWARE.
+
+use embedded_hal::digital::{OutputPin, StatefulOutputPin};
+use rp235x_hal as hal;
+use hal::gpio::{FunctionNull, FunctionSio, FunctionSioOutput, Pin, PullDown, SioOutput, ValidFunction};
+
+/// GPIO output / LED blink driver that owns a single output pin.
+pub struct BlinkDriver<I: hal::gpio::PinId> {
+    pin: Pin<I, FunctionSioOutput, PullDown>,
+}
+
+impl<I: hal::gpio::PinId + ValidFunction<FunctionSio<SioOutput>>> BlinkDriver<I> {
+    /// Initialize a GPIO pin as a push-pull digital output.
+    ///
+    /// Calls into_push_pull_output() to configure the pin for output.
+    /// The initial drive level is low (LED off).
+    ///
+    /// # Arguments
+    ///
+    /// * `pin` - GPIO pin number to configure as a digital output.
+    ///
+    /// # Returns
+    ///
+    /// A new BlinkDriver instance owning the configured pin.
+    pub fn init(pin: Pin<I, FunctionNull, PullDown>) -> Self {
+        let mut pin = pin.into_push_pull_output();
+        pin.set_low().unwrap();
+        Self { pin }
+    }
+
+    /// Drive the output pin high (LED on).
+    ///
+    /// # Arguments
+    ///
+    /// * `self` - Mutable reference to the BlinkDriver.
+    pub fn on(&mut self) {
+        self.pin.set_high().unwrap();
+    }
+
+    /// Drive the output pin low (LED off).
+    ///
+    /// # Arguments
+    ///
+    /// * `self` - Mutable reference to the BlinkDriver.
+    pub fn off(&mut self) {
+        self.pin.set_low().unwrap();
+    }
+
+    /// Toggle the current state of the output pin.
+    ///
+    /// Reads the current GPIO output level and inverts it. If the LED was on
+    /// it is turned off, and vice versa.
+    ///
+    /// # Arguments
+    ///
+    /// * `self` - Mutable reference to the BlinkDriver.
+    pub fn toggle(&mut self) {
+        self.pin.toggle().unwrap();
+    }
+
+    /// Query the current drive state of the output pin.
+    ///
+    /// # Arguments
+    ///
+    /// * `self` - Mutable reference to the BlinkDriver.
+    ///
+    /// # Returns
+    ///
+    /// `true` if the pin is driven high, `false` if driven low.
+    pub fn get_state(&mut self) -> bool {
+        self.pin.is_set_high().unwrap()
+    }
+}
+
+// End of file
@@ -0,0 +1,232 @@
+//! @file main.rs
+//! @brief Blink demonstration: toggle onboard LED every 500 ms
+//! @author Kevin Thomas
+//! @date 2025
+//!
+//! MIT License
+//!
+//! Copyright (c) 2025 Kevin Thomas
+//!
+//! Permission is hereby granted, free of charge, to any person obtaining a copy
+//! of this software and associated documentation files (the "Software"), to deal
+//! in the Software without restriction, including without limitation the rights
+//! to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//! copies of the Software, and to permit persons to whom the Software is
+//! furnished to do so, subject to the following conditions:
+//!
+//! The above copyright notice and this permission notice shall be included in
+//! all copies or substantial portions of the Software.
+//!
+//! THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//! IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//! FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//! AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//! LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//! OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+//! SOFTWARE.
+//!
+//! -----------------------------------------------------------------------------
+//!
+//! Demonstrates GPIO output control using the blink driver (blink.rs).
+//! The onboard LED on GPIO 25 is toggled every BLINK_DELAY_MS milliseconds and
+//! the current state is reported over UART.
+//!
+//! Wiring:
+//!   GPIO25 -> Onboard LED (no external wiring needed)
+
+#![no_std]
+#![no_main]
+
+mod blink;
+
+use defmt_rtt as _;
+#[cfg(target_arch = "riscv32")]
+use panic_halt as _;
+#[cfg(target_arch = "arm")]
+use panic_probe as _;
+
+use fugit::RateExtU32;
+use hal::entry;
+use hal::Clock;
+use hal::gpio::{FunctionNull, FunctionUart, Pin, PullDown, PullNone};
+use hal::uart::{DataBits, Enabled, StopBits, UartConfig, UartPeripheral};
+
+#[cfg(rp2350)]
+use rp235x_hal as hal;
+
+#[cfg(rp2040)]
+use rp2040_hal as hal;
+
+#[unsafe(link_section = ".boot2")]
+#[used]
+#[cfg(rp2040)]
+pub static BOOT2: [u8; 256] = rp2040_boot2::BOOT_LOADER_W25Q080;
+
+#[unsafe(link_section = ".start_block")]
+#[used]
+#[cfg(rp2350)]
+pub static IMAGE_DEF: hal::block::ImageDef = hal::block::ImageDef::secure_exe();
+
+const XTAL_FREQ_HZ: u32 = 12_000_000u32;
+
+const UART_BAUD: u32 = 115_200;
+
+const BLINK_DELAY_MS: u32 = 500;
+
+type TxPin = Pin<hal::gpio::bank0::Gpio0, FunctionUart, PullNone>;
+type RxPin = Pin<hal::gpio::bank0::Gpio1, FunctionUart, PullNone>;
+type TxPinDefault = Pin<hal::gpio::bank0::Gpio0, FunctionNull, PullDown>;
+type RxPinDefault = Pin<hal::gpio::bank0::Gpio1, FunctionNull, PullDown>;
+type EnabledUart = UartPeripheral<Enabled, hal::pac::UART0, (TxPin, RxPin)>;
+
+/// Initialise system clocks and PLLs from the external 12 MHz crystal.
+///
+/// # Arguments
+///
+/// * `xosc` - XOSC peripheral singleton.
+/// * `clocks` - CLOCKS peripheral singleton.
+/// * `pll_sys` - PLL_SYS peripheral singleton.
+/// * `pll_usb` - PLL_USB peripheral singleton.
+/// * `resets` - Mutable reference to the RESETS peripheral.
+/// * `watchdog` - Mutable reference to the watchdog timer.
+///
+/// # Returns
+///
+/// Configured clocks manager.
+///
+/// # Panics
+///
+/// Panics if clock initialisation fails.
+fn init_clocks(
+    xosc: hal::pac::XOSC,
+    clocks: hal::pac::CLOCKS,
+    pll_sys: hal::pac::PLL_SYS,
+    pll_usb: hal::pac::PLL_USB,
+    resets: &mut hal::pac::RESETS,
+    watchdog: &mut hal::Watchdog,
+) -> hal::clocks::ClocksManager {
+    hal::clocks::init_clocks_and_plls(
+        XTAL_FREQ_HZ, xosc, clocks, pll_sys, pll_usb, resets, watchdog,
+    )
+    .unwrap()
+}
+
+/// Unlock the GPIO bank and return the pin set.
+///
+/// # Arguments
+///
+/// * `io_bank0` - IO_BANK0 peripheral singleton.
+/// * `pads_bank0` - PADS_BANK0 peripheral singleton.
+/// * `sio` - SIO peripheral singleton.
+/// * `resets` - Mutable reference to the RESETS peripheral.
+///
+/// # Returns
+///
+/// GPIO pin set for the entire bank.
+fn init_pins(
+    io_bank0: hal::pac::IO_BANK0,
+    pads_bank0: hal::pac::PADS_BANK0,
+    sio: hal::pac::SIO,
+    resets: &mut hal::pac::RESETS,
+) -> hal::gpio::Pins {
+    let sio = hal::Sio::new(sio);
+    hal::gpio::Pins::new(io_bank0, pads_bank0, sio.gpio_bank0, resets)
+}
+
+/// Initialise UART0 for serial output (stdio equivalent).
+///
+/// Configures UART0 at the requested baud rate with 8N1 framing on
+/// GPIO 0 (TX) and GPIO 1 (RX).
+///
+/// # Arguments
+///
+/// * `uart0` - PAC UART0 peripheral singleton.
+/// * `tx_pin` - GPIO pin to use as UART0 TX (GPIO 0).
+/// * `rx_pin` - GPIO pin to use as UART0 RX (GPIO 1).
+/// * `resets` - Mutable reference to the RESETS peripheral.
+/// * `clocks` - Reference to the initialised clock configuration.
+///
+/// # Returns
+///
+/// Enabled UART0 peripheral ready for blocking writes.
+///
+/// # Panics
+///
+/// Panics if the HAL cannot achieve the requested baud rate.
+fn init_uart(
+    uart0: hal::pac::UART0,
+    tx_pin: TxPinDefault,
+    rx_pin: RxPinDefault,
+    resets: &mut hal::pac::RESETS,
+    clocks: &hal::clocks::ClocksManager,
+) -> EnabledUart {
+    let pins = (
+        tx_pin.reconfigure::<FunctionUart, PullNone>(),
+        rx_pin.reconfigure::<FunctionUart, PullNone>(),
+    );
+    let cfg = UartConfig::new(UART_BAUD.Hz(), DataBits::Eight, None, StopBits::One);
+    UartPeripheral::new(uart0, pins, resets)
+        .enable(cfg, clocks.peripheral_clock.freq())
+        .unwrap()
+}
+
+/// Create a blocking delay timer from the ARM SysTick peripheral.
+///
+/// # Arguments
+///
+/// * `clocks` - Reference to the initialised clock configuration.
+///
+/// # Returns
+///
+/// Blocking delay provider.
+///
+/// # Panics
+///
+/// Panics if the cortex-m core peripherals have already been taken.
+fn init_delay(clocks: &hal::clocks::ClocksManager) -> cortex_m::delay::Delay {
+    let core = cortex_m::Peripherals::take().unwrap();
+    cortex_m::delay::Delay::new(core.SYST, clocks.system_clock.freq().to_Hz())
+}
+
+/// Application entry point for the LED blink demo.
+///
+/// Initializes the onboard LED and enters an infinite loop that
+/// toggles the LED state every BLINK_DELAY_MS milliseconds.
+///
+/// # Returns
+///
+/// Does not return.
+#[entry]
+fn main() -> ! {
+    let mut pac = hal::pac::Peripherals::take().unwrap();
+    let clocks = init_clocks(
+        pac.XOSC, pac.CLOCKS, pac.PLL_SYS, pac.PLL_USB, &mut pac.RESETS,
+        &mut hal::Watchdog::new(pac.WATCHDOG),
+    );
+    let pins = init_pins(pac.IO_BANK0, pac.PADS_BANK0, pac.SIO, &mut pac.RESETS);
+    let uart = init_uart(pac.UART0, pins.gpio0, pins.gpio1, &mut pac.RESETS, &clocks);
+    let mut delay = init_delay(&clocks);
+    let mut led = blink::BlinkDriver::init(pins.gpio25);
+    uart.write_full_blocking(b"Blink driver initialized on GPIO 25\r\n");
+    loop {
+        led.toggle();
+        if led.get_state() {
+            uart.write_full_blocking(b"LED: ON\r\n");
+        } else {
+            uart.write_full_blocking(b"LED: OFF\r\n");
+        }
+        delay.delay_ms(BLINK_DELAY_MS);
+    }
+}
+
+#[unsafe(link_section = ".bi_entries")]
+#[used]
+pub static PICOTOOL_ENTRIES: [hal::binary_info::EntryAddr; 5] = [
+    hal::binary_info::rp_cargo_bin_name!(),
+    hal::binary_info::rp_cargo_version!(),
+    hal::binary_info::rp_program_description!(c"Blink LED Demo"),
+    hal::binary_info::rp_cargo_homepage_url!(),
+    hal::binary_info::rp_program_build_attribute!(),
+];
+
+// End of file