Use defmt in app

card-io-ecg · Aug 26, 2023 · a00137f · a00137f
1 parent 2712ad5
commit a00137f
Show file tree

Hide file tree

Showing 27 changed files with 207 additions and 93 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -19,6 +19,7 @@ embassy-net = { version = "0.1.0", features = [
     "udp",
     "dhcpv4",
     "medium-ethernet",
+    "defmt"
 ] }
 embassy-sync = { version = "0.2.0" }
 
@@ -55,10 +56,7 @@ esp32s3-hal = { version = "0.11.0", optional = true, features = [
 ] }
 # esp32s2 = { version = "0.15.0", optional = true }
 esp32s3 = { version = "0.20.0", optional = true }
-esp-backtrace = { version = "0.7.0", features = [
-    "panic-handler",
-    "exception-handler",
-] } # add "halt-cores"
+esp-backtrace = { version = "0.7.0" }
 esp-println = { version = "0.5.0", default-features = false, features = [
     "critical-section",
     "colors",
@@ -90,7 +88,7 @@ critical-section = "1.1"
 device-descriptor = { path = "device-descriptor" }
 register-access = { path = "register-access" }
 gui = { path = "gui" }
-ads129x = { path = "ads129x" }
+ads129x = { path = "ads129x", features = ["defmt"] }
 max17055 = { path = "max17055", optional = true }
 signal-processing = { path = "signal-processing", features = ["nostd"] }
 replace_with = { version = "0.1", default-features = false, features = [

diff --git a/ads129x/Cargo.toml b/ads129x/Cargo.toml
@@ -12,3 +12,9 @@ embedded-hal = { workspace = true }
 embedded-hal-async = { workspace = true }
 log = { workspace = true }
 register-access = { path = "../register-access" }
+defmt = { version = "0.3.5", optional = true }
+
+[features]
+default = ["debug"]
+defmt = ["dep:defmt", "device-descriptor/defmt"]
+debug = ["device-descriptor/debug"]
diff --git a/ads129x/src/lib.rs b/ads129x/src/lib.rs
@@ -23,7 +23,9 @@ pub enum Error<SpiE> {
     Transfer(SpiE),
 }
 
-#[derive(Copy, Clone, Debug, Default)]
+#[derive(Copy, Clone, Default)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[cfg_attr(feature = "debug", derive(Debug))]
 pub struct ConfigRegisters {
     pub config1: Config1,
     pub config2: Config2,
@@ -379,6 +381,8 @@ where
 }
 
 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[cfg_attr(feature = "debug", derive(Debug))]
 pub struct Sample {
     sample: i32,
 }
@@ -395,6 +399,8 @@ impl Sample {
     }
 }
 
+#[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[cfg_attr(feature = "debug", derive(Debug))]
 pub struct AdsData {
     status: LoffStat,
     ch1: Sample,

diff --git a/bad-server/src/lib.rs b/bad-server/src/lib.rs
@@ -240,7 +240,7 @@ where
                 }
             }
 
-            log::debug!("Buffer size: {pos}");
+            log::debug!("Buffer size: {}", pos);
 
             let mut headers = [httparse::EMPTY_HEADER; MAX_HEADERS];
             let mut req = httparse::Request::new(&mut headers);
@@ -254,7 +254,7 @@ where
                     // We need to read more
                 }
                 Err(e) => {
-                    log::warn!("Parsing request failed: {e}");
+                    log::warn!("Parsing request failed: {}", e);
                     return Err(HandleError::RequestParse(e));
                 }
             };

diff --git a/bad-server/src/request.rs b/bad-server/src/request.rs
@@ -30,7 +30,7 @@ impl<'req, 's, C: Connection> Request<'req, 's, C> {
             return Err(ResponseStatus::BadRequest);
         };
 
-        log::info!("[{}] {path}", method.as_str());
+        log::info!("[{}] {}", method.as_str(), path);
 
         Ok(Self {
             method,
@@ -54,7 +54,7 @@ impl<'req, 's, C: Connection> Request<'req, 's, C> {
         while !self.is_complete() && !buffer.is_empty() {
             read += self.read(&mut buffer[read..]).await?;
         }
-        log::debug!("Read {read} bytes");
+        log::debug!("Read {} bytes", read);
 
         Ok(&mut buffer[..read])
     }

diff --git a/config-site/src/handlers/add_new_network.rs b/config-site/src/handlers/add_new_network.rs
@@ -18,7 +18,7 @@ impl<'a> AddNewNetwork<'a> {
         status: ResponseStatus,
         message: &str,
     ) -> Result<(), HandleError<C>> {
-        log::warn!("Request error: {status:?}, {message}");
+        log::warn!("Request error: {:?}, {}", status, message);
         request
             .send_response(status)
             .await?
@@ -49,7 +49,7 @@ impl<C: Connection> RequestHandler<C> for AddNewNetwork<'_> {
         let post_body = match core::str::from_utf8(post_data) {
             Ok(body) => body,
             Err(err) => {
-                log::warn!("Invalid UTF-8 in POST body: {err}");
+                log::warn!("Invalid UTF-8 in POST body: {}", err);
                 return self
                     .request_error(
                         request,
@@ -59,7 +59,7 @@ impl<C: Connection> RequestHandler<C> for AddNewNetwork<'_> {
                     .await;
             }
         };
-        log::debug!("POST body: {post_body:?}");
+        log::debug!("POST body: {:?}", post_body);
 
         let (ssid, pass) = post_body.split_once('\n').unwrap_or((post_body, ""));
 

diff --git a/config-site/src/handlers/delete_network.rs b/config-site/src/handlers/delete_network.rs
@@ -18,7 +18,7 @@ impl<'a> DeleteNetwork<'a> {
         status: ResponseStatus,
         message: &str,
     ) -> Result<(), HandleError<C>> {
-        log::warn!("Request error: {status:?}, {message}");
+        log::warn!("Request error: {:?}, {}", status, message);
         request
             .send_response(status)
             .await?
@@ -49,7 +49,7 @@ impl<C: Connection> RequestHandler<C> for DeleteNetwork<'_> {
         let post_body = match core::str::from_utf8(post_data) {
             Ok(body) => body,
             Err(err) => {
-                log::warn!("Invalid UTF-8 in POST body: {err}");
+                log::warn!("Invalid UTF-8 in POST body: {}", err);
                 return self
                     .request_error(
                         request,
@@ -59,12 +59,12 @@ impl<C: Connection> RequestHandler<C> for DeleteNetwork<'_> {
                     .await;
             }
         };
-        log::debug!("POST body: {post_body:?}");
+        log::debug!("POST body: {:?}", post_body);
 
         let index = match usize::from_str(post_body) {
             Ok(index) => index,
             Err(err) => {
-                log::warn!("Invalid index in POST body: {err}");
+                log::warn!("Invalid index in POST body: {}", err);
                 return self
                     .request_error(
                         request,

diff --git a/device-descriptor/Cargo.toml b/device-descriptor/Cargo.toml
@@ -6,3 +6,9 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+defmt = { version = "0.3.5", optional = true }
+
+[features]
+default = ["debug"]
+defmt = ["dep:defmt"]
+debug = []
diff --git a/device-descriptor/src/lib.rs b/device-descriptor/src/lib.rs
@@ -151,7 +151,9 @@ macro_rules! define_register_type {
             $name:ident = $value:expr
         ),+
     }) => {
-        #[derive(Debug, PartialEq, Copy, Clone)]
+        #[derive(PartialEq, Copy, Clone)]
+        #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+        #[cfg_attr(feature = "debug", derive(Debug))]
         pub enum $type {
             $(
                 $(#[$variant_attr])*
@@ -185,7 +187,9 @@ macro_rules! register {
         $($(#[$field_meta:meta])* $field:ident($($field_args:tt)*): $type:ty ),*
     } ) => {
         $(#[$meta])*
-        #[derive(Debug, Copy, Clone)]
+        #[derive(Copy, Clone)]
+        #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+        #[cfg_attr(feature = "debug", derive(Debug))]
         #[must_use]
         #[allow(non_camel_case_types)]
         pub struct $reg {

diff --git a/max17055/Cargo.toml b/max17055/Cargo.toml
@@ -12,3 +12,9 @@ embedded-hal = { workspace = true }
 embedded-hal-async = { workspace = true }
 log = { workspace = true }
 register-access = { path = "../register-access" }
+defmt = { version = "0.3.5", optional = true }
+
+[features]
+default = ["debug"]
+defmt = ["dep:defmt", "device-descriptor/defmt"]
+debug = ["device-descriptor/debug"]
diff --git a/max17055/src/lib.rs b/max17055/src/lib.rs
@@ -252,7 +252,7 @@ impl<I2C> Max17055<I2C> {
     const DEVICE_ADDR: u8 = 0x36;
 
     pub fn new(i2c: I2C, config: DesignData) -> Self {
-        log::debug!("Design data: {config:?}");
+        log::debug!("Design data: {:?}", config);
         Self { i2c, config }
     }
 

diff --git a/src/backtrace.rs b/src/backtrace.rs
@@ -0,0 +1,76 @@
+use defmt::Debug2Format;
+use esp_backtrace::arch;
+
+#[panic_handler]
+fn panic_handler(info: &core::panic::PanicInfo) -> ! {
+    use defmt::println;
+
+    println!(" ");
+    println!(" ");
+
+    if let Some(location) = info.location() {
+        let (file, line, column) = (location.file(), location.line(), location.column());
+        println!(
+            "!! A panic occured in '{}', at line {}, column {}",
+            file, line, column
+        );
+    } else {
+        println!("!! A panic occured at an unknown location");
+    }
+
+    println!(" ");
+    println!("{:#?}", Debug2Format(info));
+    println!(" ");
+    println!("Backtrace:");
+    println!(" ");
+
+    for e in arch::backtrace() {
+        if let Some(addr) = e {
+            println!("{:#X}", addr);
+        }
+    }
+
+    halt();
+}
+
+#[no_mangle]
+#[link_section = ".rwtext"]
+unsafe fn __user_exception(cause: arch::ExceptionCause, context: arch::Context) {
+    use defmt::println;
+
+    println!("\n\nException occured '{:?}'", Debug2Format(&cause));
+    println!("{:?}", Debug2Format(&context));
+
+    for e in arch::backtrace() {
+        if let Some(addr) = e {
+            println!("{:#X}", addr);
+        }
+    }
+
+    println!("");
+    println!("");
+    println!("");
+
+    halt();
+}
+
+fn halt() -> ! {
+    mod registers {
+        pub(crate) const SW_CPU_STALL: u32 = 0x600080bc;
+        pub(crate) const OPTIONS0: u32 = 0x60008000;
+    }
+
+    let sw_cpu_stall = registers::SW_CPU_STALL as *mut u32;
+    let options0 = registers::OPTIONS0 as *mut u32;
+
+    unsafe {
+        sw_cpu_stall.write_volatile(
+            sw_cpu_stall.read_volatile() & !(0b111111 << 20) & !(0b111111 << 26)
+                | (0x21 << 20)
+                | (0x21 << 26),
+        );
+        options0.write_volatile(options0.read_volatile() & !(0b1111) | 0b1010);
+    }
+
+    loop {}
+}
diff --git a/src/board/drivers/battery_adc.rs b/src/board/drivers/battery_adc.rs
@@ -17,7 +17,7 @@ use embassy_futures::yield_now;
 use embassy_time::{Duration, Ticker};
 use embedded_hal_old::adc::{Channel, OneShot};
 
-#[derive(Clone, Copy, Debug)]
+#[derive(Clone, Copy, Debug, defmt::Format)]
 pub struct BatteryAdcData {
     pub voltage: u16,
     pub charge_current: u16,
@@ -92,7 +92,7 @@ pub async fn monitor_task_adc(
     task_control
         .run_cancellable(async {
             let mut timer = Ticker::every(Duration::from_millis(10));
-            log::info!("ADC monitor started");
+            defmt::info!("ADC monitor started");
 
             battery.lock().await.enable.set_high().unwrap();
 
@@ -118,7 +118,7 @@ pub async fn monitor_task_adc(
                     };
                     state.data = Some(average);
 
-                    log::debug!("Battery data: {average:?}");
+                    defmt::debug!("Battery data: {:?}", averate);
 
                     sample_count = 0;
 
@@ -135,5 +135,5 @@ pub async fn monitor_task_adc(
 
     battery.lock().await.enable.set_low().unwrap();
 
-    log::info!("Monitor exited");
+    defmt::info!("Monitor exited");
 }
diff --git a/src/board/drivers/battery_fg.rs b/src/board/drivers/battery_fg.rs
@@ -7,7 +7,7 @@ use crate::{
     board::drivers::battery_monitor::SharedBatteryState, task_control::TaskControlToken, Shared,
 };
 
-#[derive(Clone, Copy, Debug)]
+#[derive(Clone, Copy, Debug, defmt::Format)]
 pub struct BatteryFgData {
     pub voltage: u16,
     pub percentage: u8,
@@ -57,7 +57,7 @@ pub async fn monitor_task_fg(
     task_control
         .run_cancellable(async {
             let mut timer = Ticker::every(Duration::from_secs(1));
-            log::info!("Fuel gauge monitor started");
+            defmt::info!("Fuel gauge monitor started");
 
             fuel_gauge.lock().await.enable(&mut Delay).await;
 
@@ -68,13 +68,13 @@ pub async fn monitor_task_fg(
                     let mut state = battery_state.lock().await;
                     state.data = Some(data);
                 }
-                log::debug!("Battery data: {data:?}");
+                defmt::debug!("Battery data: {:?}", data);
 
                 timer.next().await;
             }
         })
         .await;
 
     fuel_gauge.lock().await.disable();
-    log::info!("Monitor exited");
+    defmt::info!("Monitor exited");
 }
diff --git a/src/board/drivers/frontend.rs b/src/board/drivers/frontend.rs
@@ -191,7 +191,7 @@ where
 
         self.frontend.device_id = Some(device_id);
 
-        log::info!("ADC device id: {:?}", device_id);
+        defmt::info!("ADC device id: {}", device_id);
 
         let config = self.frontend.config();
         self.frontend.adc.apply_configuration_async(&config).await?;

diff --git a/src/board/initialized.rs b/src/board/initialized.rs
@@ -48,18 +48,18 @@ impl Board {
             return;
         }
 
-        log::info!("Saving config");
+        defmt::info!("Saving config");
         self.config_changed = false;
 
         if let Some(storage) = self.storage.as_mut() {
             if let Err(e) = storage
                 .store_writer("config", self.config, OnCollision::Overwrite)
                 .await
             {
-                log::error!("Failed to save config: {e:?}");
+                defmt::error!("Failed to save config: {:?}", defmt::Debug2Format(&e));
             }
         } else {
-            log::warn!("Storage unavailable");
+            defmt::warn!("Storage unavailable");
         }
     }