feat: use slices for changing block sizes (#6)

* feat: update passthru example

* update readme

* feat: make buffer size generic

* feat: failed passthru example build
fix: gh action
fix: wrong target
fix: github action
fix: github action
fix: github action

* fix: delay and flash examples

* fix: hid_blinky, knob, sine examples

* fix: sdram, switch, toggle, volume

* chore: linting fix

* wip: use slices
feat: use slices instead of generics

* fix: update missing slices
fix: use slice of audio buffer

* feat: base max transfer size on user set block size
chore: formatting

* fix: examples failing on real device

* chore: cleanup comments and linting

* chore: remove magic number

* fix: branching type change

* fix: noise

* chore: format document

* chore: remove magic numbers dma_block_size

.github/workflows/build_examples.yml

@@ -0,0 +1,48 @@
+name: Build LibDaisy Examples
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Set up Rust
+      uses: actions-rs/toolchain@v1
+      with:
+        toolchain: stable
+        override: true
+
+    - name: Install target
+      run: rustup target add thumbv7em-none-eabihf
+
+    - name: Cache cargo registry
+      uses: actions/cache@v2
+      with:
+        path: |
+          ~/.cargo/registry
+          ~/.cargo/git
+        key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-cargo-registry-
+
+    - name: Build examples
+      run: |
+        excluded_examples="sdmmc usb_midi"  # List of examples to exclude
+        for example in $(ls examples/*.rs); do
+          example_name=$(basename $example .rs)
+          if [[ ! " $excluded_examples " =~ " $example_name " ]]; then
+            cargo build --example $example_name
+          else
+            echo "Skipping $example_name"
+          fi
+        done

Cargo.toml

@@ -23,11 +23,11 @@ log = "0.4"
 micromath = "2"
 panic-halt = "0.2.0"
 panic-itm = { version = "0.4", optional = true  }
-panic-rtt-target = { version = "0.1.2", features = ["cortex-m"], optional = true }
+panic-rtt-target = { version = "0.1.3", optional = true }
 panic-semihosting = { version = "0.6", optional = true  }
-rtt-target = { version = "0.4.0", optional = true }
+rtt-target = { version = "0.5.0", optional = true }
 stm32-fmc = "0.3.0"
-stm32h7xx-hal = { version = "0.15.1", features = ["stm32h750v","rt","fmc", "xspi", "sdmmc", "sdmmc-fatfs", "usb_hs"] }
+stm32h7xx-hal = { version = "0.16.0", features = ["stm32h750v","rt","fmc", "xspi", "sdmmc", "sdmmc-fatfs", "usb_hs"] }
 
 [features]
 default = []

README.md

@@ -33,6 +33,7 @@ One of:
 ```bash
 cargo embed --features log-rtt --example passthru
 ```
+**note** You will need to specify the board IE `--chip stm32h750v` for the daisy seed, or create an `Embed.toml` that specifies the chip.
 
 ## Build Examples
 

examples/button.rs

@@ -5,25 +5,30 @@
 
 #[rtic::app(device = stm32h7xx_hal::stm32, peripherals = true)]
 mod app {
-    use libdaisy::{gpio, system};
-    use stm32h7xx_hal::gpio::{Edge, ExtiPin};
+    use libdaisy::{
+        gpio,
+        hal::gpio::{Edge, ExtiPin},
+        logger, system,
+    };
+    use log::info;
 
     #[shared]
-    struct SharedResources {}
+    struct Shared {}
+
     #[local]
-    struct LocalResources {
+    struct Local {
         button: gpio::SeedButton,
         led: gpio::SeedLed,
     }
 
-    use panic_halt as _;
-
     #[init]
-    fn init(ctx: init::Context) -> (SharedResources, LocalResources, init::Monotonics) {
+    fn init(ctx: init::Context) -> (Shared, Local, init::Monotonics) {
+        logger::init();
         let mut core = ctx.core;
         let mut device = ctx.device;
         let ccdr = system::System::init_clocks(device.PWR, device.RCC, &device.SYSCFG);
         let mut system = libdaisy::system_init!(core, device, ccdr);
+        info!("Startup done!");
 
         // Button
         system.gpio.button.make_interrupt_source(&mut device.SYSCFG);
@@ -34,8 +39,8 @@ mod app {
         system.gpio.button.enable_interrupt(&mut device.EXTI);
 
         (
-            SharedResources {},
-            LocalResources {
+            Shared {},
+            Local {
                 button: system.gpio.button,
                 led: system.gpio.led,
             },

examples/delay.rs

@@ -7,7 +7,10 @@
     peripherals = true,
 )]
 mod app {
-    use libdaisy::{audio, logger, system};
+    use libdaisy::{
+        audio::{self, AudioBuffer},
+        logger, system,
+    };
     use log::info;
 
     #[shared]
@@ -16,14 +19,18 @@ mod app {
     #[local]
     struct Local {
         audio: audio::Audio,
-        buffer: audio::AudioBuffer,
+        buffer: AudioBuffer,
         sdram: &'static mut [f32],
     }
 
     #[init]
     fn init(ctx: init::Context) -> (Shared, Local, init::Monotonics) {
         logger::init();
-        let system = system::System::init(ctx.core, ctx.device);
+
+        let mut core = ctx.core;
+        let device = ctx.device;
+        let ccdr = system::System::init_clocks(device.PWR, device.RCC, &device.SYSCFG);
+        let system = libdaisy::system_init!(core, device, ccdr);
         let buffer = [(0.0, 0.0); audio::BLOCK_SIZE_MAX];
 
         info!("Startup done!");

examples/flash.rs

@@ -26,12 +26,21 @@ mod app {
     #[init]
     fn init(ctx: init::Context) -> (Shared, Local, init::Monotonics) {
         logger::init();
-        let mut system = system::System::init(ctx.core, ctx.device);
+        let mut core = ctx.core;
+        let device = ctx.device;
+        let ccdr = system::System::init_clocks(device.PWR, device.RCC, &device.SYSCFG);
+        let system = libdaisy::system_init!(core, device, ccdr);
         info!("Startup done!");
+        let mut timer2 = stm32h7xx_hal::timer::TimerExt::timer(
+            device.TIM2,
+            MilliSeconds::from_ticks(100).into_rate(),
+            ccdr.peripheral.TIM2,
+            &ccdr.clocks,
+        );
 
-        system
-            .timer2
-            .set_freq(MilliSeconds::from_ticks(500).into_rate());
+        timer2.listen(stm32h7xx_hal::timer::Event::TimeOut);
+
+        timer2.set_freq(MilliSeconds::from_ticks(500).into_rate());
 
         let mut flash = system.flash;
 
@@ -79,7 +88,7 @@ mod app {
             Shared {},
             Local {
                 seed_led: system.gpio.led,
-                timer2: system.timer2,
+                timer2,
             },
             init::Monotonics(),
         )

examples/hid_blinky.rs

@@ -27,11 +27,22 @@ mod app {
     #[init]
     fn init(ctx: init::Context) -> (Shared, Local, init::Monotonics) {
         logger::init();
-        let mut system = system::System::init(ctx.core, ctx.device);
+        let mut core = ctx.core;
+        let device = ctx.device;
+        let ccdr = system::System::init_clocks(device.PWR, device.RCC, &device.SYSCFG);
+        let mut system = libdaisy::system_init!(core, device, ccdr);
+        info!("Startup done!");
 
-        system
-            .timer2
-            .set_freq(MilliSeconds::from_ticks(1).into_rate());
+        let mut timer2 = stm32h7xx_hal::timer::TimerExt::timer(
+            device.TIM2,
+            MilliSeconds::from_ticks(100).into_rate(),
+            ccdr.peripheral.TIM2,
+            &ccdr.clocks,
+        );
+
+        timer2.listen(stm32h7xx_hal::timer::Event::TimeOut);
+
+        timer2.set_freq(MilliSeconds::from_ticks(1).into_rate());
 
         let mut led1 = hid::Led::new(system.gpio.led, false, 1000);
         led1.set_brightness(0.5);
@@ -55,7 +66,7 @@ mod app {
                 led1,
                 adc1,
                 control1,
-                timer2: system.timer2,
+                timer2,
             },
             init::Monotonics(),
         )

examples/knob.rs

@@ -11,6 +11,7 @@ mod app {
     use libdaisy::logger;
     use libdaisy::{gpio::*, hid, prelude::*, system};
     use log::info;
+    use stm32h7xx_hal::time::MilliSeconds;
     use stm32h7xx_hal::{adc, stm32, timer::Timer};
 
     #[shared]
@@ -27,12 +28,25 @@ mod app {
     #[init]
     fn init(ctx: init::Context) -> (Shared, Local, init::Monotonics) {
         logger::init();
-        let mut system = system::System::init(ctx.core, ctx.device);
+        let mut core = ctx.core;
+        let device = ctx.device;
+        let ccdr = system::System::init_clocks(device.PWR, device.RCC, &device.SYSCFG);
+        let mut system = libdaisy::system_init!(core, device, ccdr);
+        info!("Startup done!");
+
+        let mut timer2 = stm32h7xx_hal::timer::TimerExt::timer(
+            device.TIM2,
+            MilliSeconds::from_ticks(100).into_rate(),
+            ccdr.peripheral.TIM2,
+            &ccdr.clocks,
+        );
+
+        timer2.listen(stm32h7xx_hal::timer::Event::TimeOut);
 
         let duty_cycle = 50;
         let resolution = 20;
 
-        system.timer2.set_freq((duty_cycle * resolution).Hz());
+        timer2.set_freq((duty_cycle * resolution).Hz());
 
         let daisy28 = system
             .gpio
@@ -62,7 +76,7 @@ mod app {
                 led1,
                 adc1,
                 control1,
-                timer2: system.timer2,
+                timer2,
             },
             init::Monotonics(),
         )

examples/passthru.rs

@@ -6,7 +6,9 @@
     peripherals = true,
 )]
 mod app {
-    use libdaisy::{audio, logger, system};
+    const BLOCK_SIZE: usize = 128;
+    use libdaisy::logger;
+    use libdaisy::{audio, system};
     use log::info;
 
     #[shared]
@@ -21,10 +23,18 @@ mod app {
     #[init]
     fn init(ctx: init::Context) -> (Shared, Local, init::Monotonics) {
         logger::init();
-        let system = system::System::init(ctx.core, ctx.device);
+
+        // Latest changes here. This approach allows you to
+        // access peripherals and resources that were simply
+        // moved out of the function in the previous implementation.
+        let mut core = ctx.core;
+        let device = ctx.device;
+        let ccdr = system::System::init_clocks(device.PWR, device.RCC, &device.SYSCFG);
+        let system = libdaisy::system_init!(core, device, ccdr, BLOCK_SIZE);
+
         let buffer = [(0.0, 0.0); audio::BLOCK_SIZE_MAX];
 
-        info!("Startup done!");
+        info!("Startup done!!");
 
         (
             Shared {},
@@ -52,8 +62,8 @@ mod app {
         let buffer = ctx.local.buffer;
 
         if audio.get_stereo(buffer) {
-            for (left, right) in buffer {
-                audio.push_stereo((*left, *right)).unwrap();
+            for (left, right) in &buffer.as_slice()[..BLOCK_SIZE] {
+                let _ = audio.push_stereo((*left, *right));
             }
         } else {
             info!("Error reading data!");

examples/sdram.rs

@@ -26,11 +26,20 @@ mod app {
     #[init]
     fn init(ctx: init::Context) -> (Shared, Local, init::Monotonics) {
         logger::init();
-        let mut system = system::System::init(ctx.core, ctx.device);
+        let mut core = ctx.core;
+        let device = ctx.device;
+        let ccdr = system::System::init_clocks(device.PWR, device.RCC, &device.SYSCFG);
+        let system = libdaisy::system_init!(core, device, ccdr);
+        info!("Startup done!");
+        let mut timer2 = stm32h7xx_hal::timer::TimerExt::timer(
+            device.TIM2,
+            MilliSeconds::from_ticks(100).into_rate(),
+            ccdr.peripheral.TIM2,
+            &ccdr.clocks,
+        );
+        timer2.listen(stm32h7xx_hal::timer::Event::TimeOut);
 
-        system
-            .timer2
-            .set_freq(MilliSeconds::from_ticks(500).into_rate());
+        timer2.set_freq(MilliSeconds::from_ticks(500).into_rate());
 
         let sdram = system.sdram;
 
@@ -72,7 +81,7 @@ mod app {
             Shared {},
             Local {
                 seed_led: system.gpio.led,
-                timer2: system.timer2,
+                timer2,
             },
             init::Monotonics(),
         )