refactor(log): use defmt instead of log crate, to reduce binary size

Signed-off-by: Haobo Gu <haobogu@outlook.com>

boards/rp2040/Cargo.toml

@@ -30,7 +30,7 @@ cortex-m-rt = "0.7.3"
 embedded-storage = "0.3"
 portable-atomic = { version = "1.5", features = ["critical-section"] }
 packed_struct = { version = "0.10.1", default-features = false }
-static_cell = { version = "2" }
+static_cell = "2"
 defmt = "0.3"
 defmt-rtt = "0.4"
 panic-probe = { version = "0.3", features = ["print-defmt"] }

boards/stm32f4/.cargo/config.toml

@@ -33,4 +33,4 @@ target = "thumbv7em-none-eabihf"     # Cortex-M4F and Cortex-M7F (with FPU)
 # target = "thumbv8m.main-none-eabihf" # Cortex-M33 (with FPU)
 
 [env]
-DEFMT_LOG = "info"
+DEFMT_LOG = "debug"

boards/stm32f4/Cargo.toml

@@ -29,8 +29,8 @@ embassy-executor = { version = "0.5", features = [
     "integrated-timers",
 ] }
 packed_struct = { version = "0.10.1", default-features = false }
-embedded-storage = { version = "0.3" }
-static_cell = { version = "2" }
+embedded-storage = "0.3"
+static_cell = "2"
 
 # defmt deps
 defmt = "0.3"

boards/stm32h7/.cargo/config.toml

@@ -37,4 +37,4 @@ target = "thumbv7em-none-eabihf"     # Cortex-M4F and Cortex-M7F (with FPU)
 # target = "thumbv8m.main-none-eabihf" # Cortex-M33 (with FPU)
 
 [env]
-DEFMT_LOG = "info"
+DEFMT_LOG = "debug"

boards/stm32h7/Cargo.toml

@@ -29,8 +29,8 @@ embassy-executor = { version = "0.5", features = [
     "integrated-timers",
 ] }
 packed_struct = { version = "0.10.1", default-features = false }
-embedded-storage = { version = "0.3" }
-static_cell = { version = "2" }
+embedded-storage = "0.3"
+static_cell = "2"
 
 # rtt-target = "0.5.0"
 # panic-rtt-target = { version = "0.1.2", features = ["cortex-m"] }

rmk/Cargo.toml

@@ -10,21 +10,23 @@ edition = "2021"
 license = "MIT OR Apache-2.0"
 
 [dependencies]
-embedded-hal = "1.0.0"
+embedded-hal = { version = "1.0.0", features = ["defmt-03"] }
 embedded-storage = "0.3"
 embedded-alloc = "0.5"
-embassy-time = { version = "0.3" }
+embassy-time = { version = "0.3", features = ["defmt"] }
 embassy-usb = { version = "0.1", features = [
+    "defmt",
     "usbd-hid",
     "max-interface-count-8",
     "max-handler-count-8",
 ] }
-embassy-sync = { version = "0.5" }
-embassy-futures = { version = "0.1" }
-num_enum = { version = "0.7", default-features = false }
+embassy-sync = { version = "0.5", features = ["defmt"] }
+embassy-futures = { version = "0.1", features = ["defmt"] }
+usbd-hid = { version = "0.6.1", features = ["defmt"] }
+defmt = "0.3"
 log = "0.4"
-static_cell = { version = "2" }
-usbd-hid = "0.6.1"
+static_cell = "2" 
+num_enum = { version = "0.7", default-features = false }
 packed_struct = { version = "0.10", default-features = false }
 byteorder = { version = "1.4", default-features = false }
 

rmk/src/action.rs

@@ -1,5 +1,5 @@
 use crate::keycode::{KeyCode, ModifierCombination};
-use log::{error, warn};
+use defmt::{error, warn, Format};
 use num_enum::FromPrimitive;
 use packed_struct::PackedStructSlice;
 
@@ -15,7 +15,7 @@ use packed_struct::PackedStructSlice;
 /// The `BasicAction` represents only a single key action of keycodes defined in HID spec. The `Action` represents all actions defined in the following `Action` enum, including modifier combination and layer switch.
 ///
 /// The KeyActionType bits varies between different types of a KeyAction, see docs of each enum variant.
-#[derive(Debug, Copy, Clone, PartialEq, Eq)]
+#[derive(Format, Copy, Clone, PartialEq, Eq)]
 pub enum KeyAction {
     /// No action. Serialized as 0x0000.
     No,
@@ -120,7 +120,7 @@ impl KeyAction {
 
 /// A single basic action that a keyboard can execute.
 /// An Action can be represented in 12 bits, aka 0x000 ~ 0xFFF
-#[derive(Debug, Copy, Clone, PartialEq, Eq)]
+#[derive(Debug, Format, Copy, Clone, PartialEq, Eq)]
 pub enum Action {
     /// A normal key stroke, uses for all keycodes defined in `KeyCode` enum, including mouse key, consumer/system control, etc.
     ///
@@ -177,7 +177,7 @@ impl Action {
                 Action::LayerToggle(layer)
             }
             _ => {
-                warn!("Not a valid 12-bit action code: {:X}", action_code);
+                warn!("Not a valid 12-bit action code: {:#X}", action_code);
                 Action::Key(KeyCode::No)
             }
         }

rmk/src/eeprom.rs

@@ -7,8 +7,8 @@ use self::eeconfig::{Eeconfig, EEPROM_MAGIC};
 use crate::{action::KeyAction, keymap::KeyMapConfig};
 use alloc::vec;
 use core::sync::atomic::{AtomicBool, Ordering::SeqCst};
+use defmt::{debug, error, info, warn};
 use embedded_storage::nor_flash::NorFlash;
-use log::{debug, error, info, warn};
 
 /// A record in the eeprom, with 2-byte address and 2-byte data
 /// A record is 4-byte long, so the tracking pos in the `Eeprom` implementation must be a multiple of 4
@@ -133,11 +133,8 @@ impl<F: NorFlash, const EEPROM_SIZE: usize> Eeprom<F, EEPROM_SIZE> {
                     eeprom.cache[record.address as usize + 1] = record.data as u8;
                     eeprom.pos += eeprom.storage_config.page_size;
                 }
-                Err(e) => {
-                    error!(
-                        "Restore eeprom value at pos {:X} error: {:?}",
-                        eeprom.pos, e
-                    );
+                Err(_) => {
+                    error!("Restore eeprom value at pos {} error", eeprom.pos);
                     break;
                 }
             }
@@ -212,17 +209,16 @@ impl<F: NorFlash, const EEPROM_SIZE: usize> Eeprom<F, EEPROM_SIZE> {
                         break;
                     } else {
                         warn!(
-                            "Writing addr {:X} is not 0xFF",
+                            "Writing addr {:#X} is not 0xFF",
                             self.storage_config.start_addr + self.pos
                         );
                         self.pos += self.storage_config.page_size;
                     }
                 }
-                Err(e) => {
+                Err(_) => {
                     warn!(
-                        "Check addr {:X} error before writing: {:?}",
-                        self.storage_config.start_addr + self.pos,
-                        e
+                        "Check addr {:#X} error before writing",
+                        self.storage_config.start_addr + self.pos
                     );
                     // Go to next possible addr
                     self.pos += self.storage_config.page_size;
@@ -234,7 +230,7 @@ impl<F: NorFlash, const EEPROM_SIZE: usize> Eeprom<F, EEPROM_SIZE> {
         let mut buf = vec![0xFF_u8; self.storage_config.page_size as usize];
         buf[..bytes.len()].copy_from_slice(&bytes);
         debug!(
-            "EEPROM write storage length {:?} at 0x{:X}: {:X?} ",
+            "EEPROM write storage length {} at {:#X}: {=[u8]:#X} ",
             buf.len(),
             self.storage_config.start_addr + self.pos,
             buf,
@@ -246,11 +242,10 @@ impl<F: NorFlash, const EEPROM_SIZE: usize> Eeprom<F, EEPROM_SIZE> {
         {
             // `pos` should be aligned by write size
             Ok(_) => self.pos += self.storage_config.page_size,
-            Err(e) => {
+            Err(_) => {
                 error!(
-                    "Failed to write record to storage at 0x{:X}: {:?}",
-                    self.storage_config.start_addr + self.pos,
-                    e
+                    "Failed to write record to storage at 0x{:#X}",
+                    self.storage_config.start_addr + self.pos
                 )
             }
         }