Introduce Board struct

Introduce a Board struct similar to those in other nrf-rs board support
crates. This makes for a much nicer API and allows for pretty much all
of the feature switching to be removed from the examples.

Author: robyoung

CHANGELOG.md

@@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
   APIs to be more aligned with each other.
 - Add BLE Beacon demo.
 - Add a simple speaker demo for micro:bit V2.
+- Add Board struct following the pattern used in other nrf board support crates.
 
 ## [0.10.1] - 2021-05-25
 

examples/display-blocking/src/main.rs

@@ -7,36 +7,16 @@ use panic_halt as _;
 use cortex_m_rt::entry;
 
 use microbit::{
-    display_pins,
-    hal::{gpio::p0::Parts as P0Parts, prelude::*, Timer},
+    board::Board,
+    display::blocking::Display,
+    hal::{prelude::*, Timer},
 };
 
-#[cfg(feature = "v2")]
-use microbit::hal::gpio::p1::Parts as P1Parts;
-
-use microbit::display::blocking::Display;
-
 #[entry]
 fn main() -> ! {
-    if let Some(p) = microbit::pac::Peripherals::take() {
-        let mut timer = Timer::new(p.TIMER0);
-
-        // Set up pins
-        #[cfg(feature = "v1")]
-        let pins = {
-            let p0parts = P0Parts::new(p.GPIO);
-            display_pins!(p0parts)
-        };
-
-        #[cfg(feature = "v2")]
-        let pins = {
-            let p0parts = P0Parts::new(p.P0);
-            let p1parts = P1Parts::new(p.P1);
-            display_pins!(p0parts, p1parts)
-        };
-
-        // Display
-        let mut display = Display::new(pins);
+    if let Some(board) = Board::take() {
+        let mut timer = Timer::new(board.TIMER0);
+        let mut display = Display::new(board.display_pins);
 
         #[allow(non_snake_case)]
         let letter_I = [

examples/display-nonblocking/src/main.rs

@@ -10,18 +10,15 @@ use cortex_m::peripheral::Peripherals;
 use cortex_m_rt::entry;
 
 use microbit::{
+    board::Board,
     display::nonblocking::{Display, GreyscaleImage},
-    display_pins,
     hal::{
-        gpio::p0::Parts as P0Parts,
+        clocks::Clocks,
         rtc::{Rtc, RtcInterrupt},
     },
     pac::{self, interrupt, RTC0, TIMER1},
 };
 
-#[cfg(feature = "v2")]
-use microbit::hal::gpio::p1::Parts as P1Parts;
-
 fn heart_image(inner_brightness: u8) -> GreyscaleImage {
     let b = inner_brightness;
     GreyscaleImage::new(&[
@@ -41,34 +38,19 @@ static ANIM_TIMER: Mutex<RefCell<Option<Rtc<RTC0>>>> = Mutex::new(RefCell::new(N
 
 #[entry]
 fn main() -> ! {
-    if let Some(p) = pac::Peripherals::take() {
+    if let Some(board) = Board::take() {
         // Starting the low-frequency clock (needed for RTC to work)
-        p.CLOCK.tasks_lfclkstart.write(|w| unsafe { w.bits(1) });
-        while p.CLOCK.events_lfclkstarted.read().bits() == 0 {}
-        p.CLOCK.events_lfclkstarted.reset();
+        Clocks::new(board.CLOCK).start_lfclk();
 
         // RTC at 16Hz (32_768 / (2047 + 1))
         // 62.5ms period
-        let mut rtc0 = Rtc::new(p.RTC0, 2047).unwrap();
+        let mut rtc0 = Rtc::new(board.RTC0, 2047).unwrap();
         rtc0.enable_event(RtcInterrupt::Tick);
         rtc0.enable_interrupt(RtcInterrupt::Tick, None);
         rtc0.enable_counter();
 
-        // Set up pins
-        #[cfg(feature = "v1")]
-        let pins = {
-            let p0parts = P0Parts::new(p.GPIO);
-            display_pins!(p0parts)
-        };
-
-        #[cfg(feature = "v2")]
-        let pins = {
-            let p0parts = P0Parts::new(p.P0);
-            let p1parts = P1Parts::new(p.P1);
-            display_pins!(p0parts, p1parts)
-        };
-
-        let display = Display::new(p.TIMER1, pins);
+        // Create display
+        let display = Display::new(board.TIMER1, board.display_pins);
 
         cortex_m::interrupt::free(move |cs| {
             *DISPLAY.borrow(cs).borrow_mut() = Some(display);

examples/display-rtic/src/main.rs

@@ -11,18 +11,15 @@ use defmt_rtt as _;
 use panic_halt as _;
 
 use microbit::{
+    board::Board,
     display::nonblocking::{Display, GreyscaleImage},
-    display_pins,
     hal::{
-        gpio::p0::Parts as P0Parts,
+        clocks::Clocks,
         rtc::{Rtc, RtcInterrupt},
     },
     pac,
 };
 
-#[cfg(feature = "v2")]
-use microbit::hal::gpio::p1::Parts as P1Parts;
-
 use rtic::app;
 
 fn heart_image(inner_brightness: u8) -> GreyscaleImage {
@@ -36,45 +33,28 @@ fn heart_image(inner_brightness: u8) -> GreyscaleImage {
     ])
 }
 
-#[app(device = microbit::pac, peripherals = true)]
+#[app(device = microbit::pac, peripherals = false)]
 const APP: () = {
     struct Resources {
         display: Display<pac::TIMER1>,
         anim_timer: Rtc<pac::RTC0>,
     }
 
     #[init]
-    fn init(cx: init::Context) -> init::LateResources {
-        let p: pac::Peripherals = cx.device;
+    fn init(_cx: init::Context) -> init::LateResources {
+        let board = Board::take().unwrap();
 
         // Starting the low-frequency clock (needed for RTC to work)
-        p.CLOCK.tasks_lfclkstart.write(|w| unsafe { w.bits(1) });
-
-        while p.CLOCK.events_lfclkstarted.read().bits() == 0 {}
-        p.CLOCK.events_lfclkstarted.reset();
+        Clocks::new(board.CLOCK).start_lfclk();
 
         // RTC at 16Hz (32_768 / (2047 + 1))
         // 16Hz; 62.5ms period
-        let mut rtc0 = Rtc::new(p.RTC0, 2047).unwrap();
+        let mut rtc0 = Rtc::new(board.RTC0, 2047).unwrap();
         rtc0.enable_event(RtcInterrupt::Tick);
         rtc0.enable_interrupt(RtcInterrupt::Tick, None);
         rtc0.enable_counter();
 
-        // Set up pins
-        #[cfg(feature = "v1")]
-        let pins = {
-            let p0parts = P0Parts::new(p.GPIO);
-            display_pins!(p0parts)
-        };
-
-        #[cfg(feature = "v2")]
-        let pins = {
-            let p0parts = P0Parts::new(p.P0);
-            let p1parts = P1Parts::new(p.P1);
-            display_pins!(p0parts, p1parts)
-        };
-
-        let display = Display::new(p.TIMER1, pins);
+        let display = Display::new(board.TIMER1, board.display_pins);
 
         init::LateResources {
             anim_timer: rtc0,

examples/gpio-hal-blinky/src/main.rs

@@ -5,44 +5,21 @@ use panic_halt as _;
 
 use cortex_m_rt::entry;
 use embedded_hal::{blocking::delay::DelayMs, digital::v2::OutputPin};
-use microbit::hal::{
-    gpio::{p0, Level},
-    timer::Timer,
-};
+use microbit::{board::Board, hal::timer::Timer};
 
 #[entry]
 fn main() -> ! {
-    if let Some(p) = microbit::Peripherals::take() {
-        /* Split GPIO pins */
-        #[cfg(feature = "v1")]
-        let p0 = p0::Parts::new(p.GPIO);
+    let mut board = Board::take().unwrap();
 
-        #[cfg(feature = "v2")]
-        let p0 = p0::Parts::new(p.P0);
+    let mut timer = Timer::new(board.TIMER0);
 
-        let mut timer = Timer::new(p.TIMER0);
-
-        #[cfg(feature = "v1")]
-        let mut led = {
-            let _ = p0.p0_04.into_push_pull_output(Level::Low);
-            p0.p0_13.into_push_pull_output(Level::Low)
-        };
-
-        #[cfg(feature = "v2")]
-        let mut led = {
-            let _ = p0.p0_28.into_push_pull_output(Level::Low);
-            p0.p0_21.into_push_pull_output(Level::Low)
-        };
-
-        loop {
-            let _ = led.set_low();
-            timer.delay_ms(1_000_u16);
-            let _ = led.set_high();
-            timer.delay_ms(1_000_u16);
-        }
-    }
+    let _ = board.display_pins.col1.set_low();
+    let mut row1 = board.display_pins.row1;
 
     loop {
-        continue;
+        let _ = row1.set_low();
+        timer.delay_ms(1_000_u16);
+        let _ = row1.set_high();
+        timer.delay_ms(1_000_u16);
     }
 }

examples/gpio-hal-ledbutton/src/main.rs

@@ -5,78 +5,28 @@ use defmt_rtt as _;
 use panic_halt as _;
 
 use cortex_m_rt::entry;
-use microbit::hal::{
-    gpio::{p0, Level},
-    prelude::*,
-};
+use microbit::{board::Board, hal::prelude::*};
 
 #[entry]
 fn main() -> ! {
-    if let Some(p) = microbit::Peripherals::take() {
-        // Split GPIO pins
-        #[cfg(feature = "v1")]
-        let p0 = p0::Parts::new(p.GPIO);
+    let mut board = Board::take().unwrap();
 
-        #[cfg(feature = "v2")]
-        let p0 = p0::Parts::new(p.P0);
+    board.display_pins.row1.set_high().unwrap();
 
-        // Set row of LED matrix to permanent high
-        #[cfg(feature = "v1")]
-        let _ = p0.p0_13.into_push_pull_output(Level::Low).set_high();
+    let mut led1 = board.display_pins.col1;
+    let mut led2 = board.display_pins.col2;
 
-        #[cfg(feature = "v2")]
-        let _ = p0.p0_21.into_push_pull_output(Level::Low).set_high();
-
-        // Set 2 columns to output to control LED states
-        #[cfg(feature = "v1")]
-        let (mut led1, mut led2) = {
-            (
-                p0.p0_04.into_push_pull_output(Level::Low),
-                p0.p0_06.into_push_pull_output(Level::Low),
-            )
-        };
-
-        #[cfg(feature = "v2")]
-        let (mut led1, mut led2) = {
-            (
-                p0.p0_28.into_push_pull_output(Level::Low),
-                p0.p0_11.into_push_pull_output(Level::Low),
-            )
-        };
-
-        // Configure button GPIOs as inputs
-        #[cfg(feature = "v1")]
-        let (button_a, button_b) = {
-            (
-                p0.p0_17.into_floating_input(),
-                p0.p0_26.into_floating_input(),
-            )
-        };
-
-        #[cfg(feature = "v2")]
-        let (button_a, button_b) = {
-            (
-                p0.p0_14.into_floating_input(),
-                p0.p0_23.into_floating_input(),
-            )
-        };
-
-        loop {
-            if let Ok(true) = button_a.is_high() {
-                let _ = led1.set_high();
-            } else {
-                let _ = led1.set_low();
-            }
-
-            if let Ok(true) = button_b.is_high() {
-                let _ = led2.set_high();
-            } else {
-                let _ = led2.set_low();
-            }
+    loop {
+        if let Ok(true) = board.buttons.button_a.is_high() {
+            let _ = led1.set_high();
+        } else {
+            let _ = led1.set_low();
         }
-    }
 
-    loop {
-        continue;
+        if let Ok(true) = board.buttons.button_b.is_high() {
+            let _ = led2.set_high();
+        } else {
+            let _ = led2.set_low();
+        }
     }
 }

examples/gpio-hal-printbuttons/Cargo.toml

@@ -12,8 +12,16 @@ defmt = "0.2.0"
 
 [dependencies.microbit]
 path = "../../microbit"
+optional = true
+
+[dependencies.microbit-v2]
+path = "../../microbit-v2"
+optional = true
 
 [features]
+v1 = ["microbit"]
+v2 = ["microbit-v2"]
+
 default = [
   "defmt-default",
 ]