HRTIM: Update examples

Author: usbalbin

examples/hrtim/adc-trigger.rs

@@ -1,17 +1,23 @@
 #![no_std]
 #![no_main]
 
+/// Example showcasing the use of the HRTIM peripheral to trigger the ADC at various points of the switch cycle off HRTIM_TIMA
+
+#[path = "../utils/mod.rs"]
+mod utils;
+
 use cortex_m_rt::entry;
 
 use defmt_rtt as _; // global logger
 use panic_probe as _;
 
+use utils::logger::info;
+
 #[entry]
 fn main() -> ! {
     use hal::adc;
     use stm32g4xx_hal as hal;
 
-    use defmt::info;
     use hal::{
         adc::{
             config::{Continuous, Dma as AdcDma, SampleTime, Sequence},

examples/hrtim/capture.rs

@@ -1,16 +1,22 @@
 #![no_std]
 #![no_main]
 
+/// Example showcasing the use of the HRTIM peripheral's capture function to detect phase shift between a digital event and the output of HRTIM_TIMA
+
+#[path = "../utils/mod.rs"]
+mod utils;
+
 use cortex_m_rt::entry;
 
 use defmt_rtt as _; // global logger
 use panic_probe as _;
 
+use utils::logger::info;
+
 #[entry]
 fn main() -> ! {
     use stm32g4xx_hal as hal;
 
-    use defmt::info;
     use hal::{
         gpio::{gpioa::PA8, Alternate, GpioExt, AF13},
         hrtim::{
@@ -22,6 +28,7 @@ fn main() -> ! {
         rcc::{self, RccExt},
         stm32::Peripherals,
     };
+    use info;
 
     info!("start");
 
@@ -101,7 +108,12 @@ fn main() -> ! {
             let value = capture.get_signed();
             cr1.set_duty(duty as u16);
             capture.clear_interrupt();
-            info!("Capture: {:?}, duty: {}, diff: {}", value, old_duty, value - old_duty as i32);
+            info!(
+                "Capture: {:?}, duty: {}, diff: {}",
+                value,
+                old_duty,
+                value - old_duty as i32
+            );
             old_duty = duty;
         }
     }

examples/hrtim/eev-comp.rs

@@ -1,12 +1,19 @@
-//This example puts the timer in PWM mode using the specified pin with a frequency of 100Hz and a duty cycle of 50%.
-#![no_main]
 #![no_std]
+#![no_main]
+
+/// Example showcasing the use of the HRTIM peripheral together with a comparator to implement a cycle by cycle current limit.
+/// Once the comparator input exceeds the reference set by the DAC, the output is set low thus limiting the pulse width and in turn the current.
+
+#[path = "../utils/mod.rs"]
+mod utils;
 
 use cortex_m_rt::entry;
 
 use defmt_rtt as _; // global logger
 use panic_probe as _;
 
+use utils::logger::info;
+
 #[entry]
 fn main() -> ! {
     use hal::comparator;
@@ -116,17 +123,17 @@ fn main() -> ! {
         .finalize(&mut hr_control);
 
     out1.enable_rst_event(&cr1); // Set low on compare match with cr1
-    out1.enable_rst_event(eev_input4);
+    out1.enable_rst_event(&eev_input4);
     out1.enable_set_event(&timer); // Set high at new period
     cr1.set_duty(timer.get_period() / 3);
 
     out1.enable();
     timer.start(&mut hr_control);
 
-    defmt::info!("Started");
+    info!("Started");
 
     loop {
-        defmt::info!(
+        info!(
             "Comp: {}, pending: {}",
             comp1.output(),
             comp1.is_pending(&exti)

examples/hrtim/eev.rs

@@ -1,14 +1,19 @@
-//This example puts the timer in PWM mode using the specified pin with a frequency of 100Hz and a duty cycle of 50%.
-#![no_main]
 #![no_std]
+#![no_main]
 
-use cortex_m_rt::entry;
+/// Example showcasing the use of the HRTIM peripheral together with a digital input to implement a cycle by cycle current limit.
+/// Once the digital input goes high, the output is set low thus limiting the pulse width and in turn the current.
 
-//mod utils;
+#[path = "../utils/mod.rs"]
+mod utils;
+
+use cortex_m_rt::entry;
 
 use defmt_rtt as _; // global logger
 use panic_probe as _;
 
+use utils::logger::info;
+
 #[entry]
 fn main() -> ! {
     use hal::gpio::gpioa::PA8;
@@ -90,14 +95,14 @@ fn main() -> ! {
         .finalize(&mut hr_control);
 
     out1.enable_rst_event(&cr1); // Set low on compare match with cr1
-    out1.enable_rst_event(eev_input3);
+    out1.enable_rst_event(&eev_input3);
     out1.enable_set_event(&timer); // Set high at new period
     cr1.set_duty(timer.get_period() / 3);
 
     out1.enable();
     timer.start(&mut hr_control);
 
-    defmt::info!("Started");
+    info!("Started");
 
     loop {
         cortex_m::asm::nop()

examples/hrtim/flt-comp.rs

@@ -1,13 +1,19 @@
-//This example puts the timer in PWM mode using the specified pin with a frequency of 100Hz and a duty cycle of 50%.
-#![no_main]
 #![no_std]
+#![no_main]
+
+/// Example showcasing the use of the HRTIM peripheral together with a comparator to implement a current fault.
+/// Once the comparator input exceeds the reference set by the DAC, the output is forced low and put into a fault state.
+
+#[path = "../utils/mod.rs"]
+mod utils;
 
 use cortex_m_rt::entry;
-//mod utils;
 
 use defmt_rtt as _; // global logger
 use panic_probe as _;
 
+use utils::logger::info;
+
 #[entry]
 fn main() -> ! {
     use hal::comparator::{ComparatorExt, ComparatorSplit, Config, Hysteresis};
@@ -110,7 +116,7 @@ fn main() -> ! {
     //   -----------------------------------------        --------------------------
     //        .               .               .  *            .               .
     //        .               .               .  *            .               .
-    let (timer, (mut cr1, _cr2, _cr3, _cr4), mut out1) = dp
+    let (mut timer, (mut cr1, _cr2, _cr3, _cr4), mut out1) = dp
         .HRTIM_TIMA
         .pwm_advanced(pin_a, &mut rcc)
         .prescaler(prescaler)
@@ -125,13 +131,14 @@ fn main() -> ! {
     cr1.set_duty(timer.get_period() / 3);
     //unsafe {((HRTIM_COMMON::ptr() as *mut u8).offset(0x14) as *mut u32).write_volatile(1); }
     out1.enable();
+    timer.start(&mut hr_control);
 
-    defmt::info!("Started");
+    info!("Started");
 
     loop {
         for _ in 0..5 {
             //delay.delay(500_u32.millis());
-            defmt::info!(
+            info!(
                 "State: {}, comp: {}, is_fault_active: {}, pc1: {}",
                 out1.get_state(),
                 comp3.output(),
@@ -142,7 +149,7 @@ fn main() -> ! {
         if hr_control.fault_5.is_fault_active() {
             hr_control.fault_5.clear_fault(); // Clear fault every 5s
             out1.enable();
-            defmt::info!("failt cleared, and output reenabled");
+            info!("failt cleared, and output reenabled");
         }
     }
 }

examples/hrtim/flt.rs

@@ -1,13 +1,19 @@
-//This example puts the timer in PWM mode using the specified pin with a frequency of 100Hz and a duty cycle of 50%.
-#![no_main]
 #![no_std]
+#![no_main]
+
+/// Example showcasing the use of the HRTIM peripheral together with a comparator to implement a current fault.
+/// Once the digital input goes high, the output is forced low and put into a fault state.
+
+#[path = "../utils/mod.rs"]
+mod utils;
 
 use cortex_m_rt::entry;
-//mod utils;
 
 use defmt_rtt as _; // global logger
 use panic_probe as _;
 
+use utils::logger::info;
+
 #[entry]
 fn main() -> ! {
     use hal::gpio::gpioa::PA8;
@@ -76,7 +82,7 @@ fn main() -> ! {
     //   -----------------------------------------        --------------------------
     //        .               .               .  *            .               .
     //        .               .               .  *            .               .
-    let (timer, (mut cr1, _cr2, _cr3, _cr4), mut out1) = dp
+    let (mut timer, (mut cr1, _cr2, _cr3, _cr4), mut out1) = dp
         .HRTIM_TIMA
         .pwm_advanced(pin_a, &mut rcc)
         .prescaler(prescaler)
@@ -99,18 +105,19 @@ fn main() -> ! {
     cr1.set_duty(timer.get_period() / 3);
     //unsafe {((HRTIM_COMMON::ptr() as *mut u8).offset(0x14) as *mut u32).write_volatile(1); }
     out1.enable();
+    timer.start(&mut hr_control);
 
-    defmt::info!("Started");
+    info!("Started");
 
     loop {
         for _ in 0..5 {
             delay.delay(500_u32.millis());
-            defmt::info!("State: {}", out1.get_state());
+            info!("State: {}", out1.get_state());
         }
         if hr_control.fault_3.is_fault_active() {
             hr_control.fault_3.clear_fault(); // Clear fault every 5s
             out1.enable();
-            defmt::info!("failt cleared, and output reenabled");
+            info!("failt cleared, and output reenabled");
         }
     }
 }

examples/hrtim/hrtim.rs

@@ -1,12 +1,18 @@
-//This example puts the timer in PWM mode using the specified pin with a frequency of 100Hz and a duty cycle of 50%.
-#![no_main]
 #![no_std]
+#![no_main]
+
+/// Add description
+
+#[path = "../utils/mod.rs"]
+mod utils;
 
 use cortex_m_rt::entry;
 
 use defmt_rtt as _; // global logger
 use panic_probe as _;
 
+use utils::logger::info;
+
 #[entry]
 fn main() -> ! {
     use fugit::ExtU32;
@@ -27,6 +33,8 @@ fn main() -> ! {
     use stm32g4xx_hal as hal;
     extern crate cortex_m_rt as rt;
 
+    info!("Initializing...");
+
     let dp = stm32::Peripherals::take().expect("cannot take peripherals");
     let cp = stm32::CorePeripherals::take().expect("cannot take core");
     // Set system frequency to 16MHz * 15/1/2 = 120MHz

examples/hrtim/master.rs

@@ -1,9 +1,18 @@
-//This example puts the timer in PWM mode using the specified pin with a frequency of 100Hz and a duty cycle of 50%.
-#![no_main]
 #![no_std]
+#![no_main]
+
+/// Add description
+
+#[path = "../utils/mod.rs"]
+mod utils;
 
 use cortex_m_rt::entry;
 
+use defmt_rtt as _; // global logger
+use panic_probe as _;
+
+use utils::logger::info;
+
 #[entry]
 fn main() -> ! {
     use fugit::ExtU32;
@@ -16,9 +25,7 @@ fn main() -> ! {
     use hal::hrtim::output::HrOutput;
     use hal::hrtim::timer::HrTimer;
     use hal::hrtim::HrPwmAdvExt;
-    use hal::hrtim::{
-        event::TimerAResetEventSource, HrTimerMode, MasterPreloadSource, PreloadSource, Pscl4,
-    };
+    use hal::hrtim::{HrTimerMode, MasterPreloadSource, PreloadSource, Pscl4};
     use hal::prelude::*;
     use hal::pwr::PwrExt;
     use hal::rcc;
@@ -89,7 +96,7 @@ fn main() -> ! {
         .finalize(&mut hr_control);
 
     // Run in sync with master timer
-    timer.enable_reset_event(TimerAResetEventSource::MasterPeriod);
+    timer.enable_reset_event(&mtimer);
 
     out1.enable_rst_event(&mcr1); // Set low on compare match with cr1
     out2.enable_rst_event(&mcr1);
@@ -101,13 +108,13 @@ fn main() -> ! {
     out2.enable();
 
     let tima = unsafe { &*stm32g4xx_hal::stm32::HRTIM_TIMA::ptr() };
-    defmt::info!("set1r: {}", tima.seta1r.read().bits());
-    defmt::info!("rst1r: {}", tima.rsta1r.read().bits());
+    info!("set1r: {}", tima.seta1r.read().bits());
+    info!("rst1r: {}", tima.rsta1r.read().bits());
 
-    defmt::info!("set2r: {}", tima.seta2r.read().bits());
-    defmt::info!("rst2r: {}", tima.rsta2r.read().bits());
+    info!("set2r: {}", tima.seta2r.read().bits());
+    info!("rst2r: {}", tima.rsta2r.read().bits());
 
-    defmt::info!("Running");
+    info!("Running");
 
     loop {
         // Step frequency from 18kHz to about 180kHz(half of that when only looking at one pin)
@@ -119,7 +126,7 @@ fn main() -> ! {
             mtimer.set_period(new_period);
             timer.set_period(new_period - 1000);
 
-            defmt::info!(
+            info!(
                 "period: {}, duty: {}, get_duty: {}, get_period: {}",
                 new_period,
                 new_period / 3,