feat(core): add RmkConfig to initialize_keyboard_and_run, remove …

…`initialize_keyboard_with_config_and_run`

Signed-off-by: Haobo Gu <[email protected]>

.gitignore

@@ -10,6 +10,8 @@ target
 
 # ignore Cargo.lock of library, but keep it for binaries
 rmk/Cargo.lock
+rmk-config/Cargo.lock
+rmk-macro/Cargo.lock
 
 # mdbook site
 docs/book

examples/use_config/nrf52832_ble/src/vial.rs

@@ -3,8 +3,8 @@
 include!(concat!(env!("OUT_DIR"), "/config_generated.rs"));
 
 // Or you can manually generate vial config then put here
-// pub const VIAL_KEYBOARD_ID: [u8; 8] = [0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
-// pub const VIAL_KEYBOARD_DEF: [u8; 308] = [
+// pub const VIAL_KEYBOARD_ID: &[u8; 8] = &[0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
+// pub const VIAL_KEYBOARD_DEF: &[u8; 308] = &[
 //     0xFD, 0x37, 0x7A, 0x58, 0x5A, 0x00, 0x00, 0x04, 0xE6, 0xD6, 0xB4, 0x46, 0x02, 0x00, 0x21, 0x01,
 //     0x16, 0x00, 0x00, 0x00, 0x74, 0x2F, 0xE5, 0xA3, 0xE0, 0x01, 0x58, 0x00, 0xF1, 0x5D, 0x00, 0x3D,
 //     0x88, 0x89, 0xC6, 0x54, 0x36, 0xC3, 0x17, 0x4F, 0xE4, 0xE2, 0x11, 0x2F, 0x22, 0xB0, 0xBC, 0xC8,

examples/use_config/nrf52840_ble/src/vial.rs

@@ -3,8 +3,8 @@
 include!(concat!(env!("OUT_DIR"), "/config_generated.rs"));
 
 // Or you can manually generate vial config then put here
-// pub const VIAL_KEYBOARD_ID: [u8; 8] = [0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
-// pub const VIAL_KEYBOARD_DEF: [u8; 308] = [
+// pub const VIAL_KEYBOARD_ID: &[u8; 8] = &[0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
+// pub const VIAL_KEYBOARD_DEF: &[u8; 308] = &[
 //     0xFD, 0x37, 0x7A, 0x58, 0x5A, 0x00, 0x00, 0x04, 0xE6, 0xD6, 0xB4, 0x46, 0x02, 0x00, 0x21, 0x01,
 //     0x16, 0x00, 0x00, 0x00, 0x74, 0x2F, 0xE5, 0xA3, 0xE0, 0x01, 0x58, 0x00, 0xF1, 0x5D, 0x00, 0x3D,
 //     0x88, 0x89, 0xC6, 0x54, 0x36, 0xC3, 0x17, 0x4F, 0xE4, 0xE2, 0x11, 0x2F, 0x22, 0xB0, 0xBC, 0xC8,

examples/use_config/nrf52840_usb/src/vial.rs

@@ -3,8 +3,8 @@
 include!(concat!(env!("OUT_DIR"), "/config_generated.rs"));
 
 // Or you can manually generate vial config then put here
-// pub const VIAL_KEYBOARD_ID: [u8; 8] = [0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
-// pub const VIAL_KEYBOARD_DEF: [u8; 308] = [
+// pub const VIAL_KEYBOARD_ID: &[u8; 8] = &[0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
+// pub const VIAL_KEYBOARD_DEF: &[u8; 308] = &[
 //     0xFD, 0x37, 0x7A, 0x58, 0x5A, 0x00, 0x00, 0x04, 0xE6, 0xD6, 0xB4, 0x46, 0x02, 0x00, 0x21, 0x01,
 //     0x16, 0x00, 0x00, 0x00, 0x74, 0x2F, 0xE5, 0xA3, 0xE0, 0x01, 0x58, 0x00, 0xF1, 0x5D, 0x00, 0x3D,
 //     0x88, 0x89, 0xC6, 0x54, 0x36, 0xC3, 0x17, 0x4F, 0xE4, 0xE2, 0x11, 0x2F, 0x22, 0xB0, 0xBC, 0xC8,

examples/use_config/rp2040/src/vial.rs

@@ -3,8 +3,8 @@
 include!(concat!(env!("OUT_DIR"), "/config_generated.rs"));
 
 // Or you can manually generate vial config then put here
-// pub const VIAL_KEYBOARD_ID: [u8; 8] = [0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
-// pub const VIAL_KEYBOARD_DEF: [u8; 308] = [
+// pub const VIAL_KEYBOARD_ID: &[u8; 8] = &[0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
+// pub const VIAL_KEYBOARD_DEF: &[u8; 308] = &[
 //     0xFD, 0x37, 0x7A, 0x58, 0x5A, 0x00, 0x00, 0x04, 0xE6, 0xD6, 0xB4, 0x46, 0x02, 0x00, 0x21, 0x01,
 //     0x16, 0x00, 0x00, 0x00, 0x74, 0x2F, 0xE5, 0xA3, 0xE0, 0x01, 0x58, 0x00, 0xF1, 0x5D, 0x00, 0x3D,
 //     0x88, 0x89, 0xC6, 0x54, 0x36, 0xC3, 0x17, 0x4F, 0xE4, 0xE2, 0x11, 0x2F, 0x22, 0xB0, 0xBC, 0xC8,

examples/use_config/stm32h7/src/main.rs

@@ -20,7 +20,7 @@ mod my_keyboard {
         usb_otg::Driver,
         Config,
     };
-    use rmk::initialize_keyboard_with_config_and_run;
+    use rmk::initialize_keyboard_and_run;
     use static_cell::StaticCell;
 
     // If you want customize interrupte binding , use `#[Override(bind_interrupt)]` to override default interrupt binding
@@ -88,7 +88,7 @@ mod my_keyboard {
     #[Override(entry)]
     fn run() {
         // Start serving
-        initialize_keyboard_with_config_and_run::<
+        initialize_keyboard_and_run::<
             Flash<'_, Blocking>,
             Driver<'_, USB_OTG_HS>,
             Input<'_, AnyPin>,

examples/use_config/stm32h7/src/vial.rs

@@ -3,8 +3,8 @@
 include!(concat!(env!("OUT_DIR"), "/config_generated.rs"));
 
 // Or you can manually generate vial config then put here
-// pub const VIAL_KEYBOARD_ID: [u8; 8] = [0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
-// pub const VIAL_KEYBOARD_DEF: [u8; 308] = [
+// pub const VIAL_KEYBOARD_ID: &[u8; 8] = &[0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
+// pub const VIAL_KEYBOARD_DEF: &[u8; 308] = &[
 //     0xFD, 0x37, 0x7A, 0x58, 0x5A, 0x00, 0x00, 0x04, 0xE6, 0xD6, 0xB4, 0x46, 0x02, 0x00, 0x21, 0x01,
 //     0x16, 0x00, 0x00, 0x00, 0x74, 0x2F, 0xE5, 0xA3, 0xE0, 0x01, 0x58, 0x00, 0xF1, 0x5D, 0x00, 0x3D,
 //     0x88, 0x89, 0xC6, 0x54, 0x36, 0xC3, 0x17, 0x4F, 0xE4, 0xE2, 0x11, 0x2F, 0x22, 0xB0, 0xBC, 0xC8,

examples/use_rust/nrf52832_ble/src/vial.rs

@@ -3,8 +3,8 @@
 include!(concat!(env!("OUT_DIR"), "/config_generated.rs"));
 
 // Or you can manually generate vial config then put here
-// pub const VIAL_KEYBOARD_ID: [u8; 8] = [0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
-// pub const VIAL_KEYBOARD_DEF: [u8; 308] = [
+// pub const VIAL_KEYBOARD_ID: &[u8; 8] = &[0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
+// pub const VIAL_KEYBOARD_DEF: &[u8; 308] = &[
 //     0xFD, 0x37, 0x7A, 0x58, 0x5A, 0x00, 0x00, 0x04, 0xE6, 0xD6, 0xB4, 0x46, 0x02, 0x00, 0x21, 0x01,
 //     0x16, 0x00, 0x00, 0x00, 0x74, 0x2F, 0xE5, 0xA3, 0xE0, 0x01, 0x58, 0x00, 0xF1, 0x5D, 0x00, 0x3D,
 //     0x88, 0x89, 0xC6, 0x54, 0x36, 0xC3, 0x17, 0x4F, 0xE4, 0xE2, 0x11, 0x2F, 0x22, 0xB0, 0xBC, 0xC8,

examples/use_rust/nrf52840/src/main.rs

@@ -19,7 +19,7 @@ use embassy_nrf::{
     usb::{self, vbus_detect::HardwareVbusDetect, Driver},
 };
 use panic_probe as _;
-use rmk::initialize_keyboard_and_run;
+use rmk::{initialize_keyboard_and_run, config::{RmkConfig, VialConfig}};
 use vial::{VIAL_KEYBOARD_DEF, VIAL_KEYBOARD_ID};
 
 bind_interrupts!(struct Irqs {
@@ -51,12 +51,18 @@ async fn main(_spawner: Spawner) {
     // Use internal flash to emulate eeprom
     let f = Nvmc::new(p.NVMC);
 
+    // Keyboard config
+    let keyboard_config = RmkConfig {
+        vial_config: VialConfig::new(VIAL_KEYBOARD_ID, VIAL_KEYBOARD_DEF,),
+        ..Default::default()
+    };
+
     // Start serving
     initialize_keyboard_and_run::<
+        Nvmc,
         Driver<'_, USBD, HardwareVbusDetect>,
         Input<'_, AnyPin>,
         Output<'_, AnyPin>,
-        Nvmc,
         ROW,
         COL,
         NUM_LAYER,
@@ -66,8 +72,7 @@ async fn main(_spawner: Spawner) {
         output_pins,
         Some(f),
         crate::keymap::KEYMAP,
-        VIAL_KEYBOARD_ID,
-        VIAL_KEYBOARD_DEF,
+        keyboard_config,
     )
     .await;
 }

examples/use_rust/nrf52840/src/vial.rs

@@ -3,8 +3,8 @@
 include!(concat!(env!("OUT_DIR"), "/config_generated.rs"));
 
 // Or you can manually generate vial config then put here
-// pub const VIAL_KEYBOARD_ID: [u8; 8] = [0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
-// pub const VIAL_KEYBOARD_DEF: [u8; 308] = [
+// pub const VIAL_KEYBOARD_ID: &[u8; 8] = &[0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
+// pub const VIAL_KEYBOARD_DEF: &[u8; 308] = &[
 //     0xFD, 0x37, 0x7A, 0x58, 0x5A, 0x00, 0x00, 0x04, 0xE6, 0xD6, 0xB4, 0x46, 0x02, 0x00, 0x21, 0x01,
 //     0x16, 0x00, 0x00, 0x00, 0x74, 0x2F, 0xE5, 0xA3, 0xE0, 0x01, 0x58, 0x00, 0xF1, 0x5D, 0x00, 0x3D,
 //     0x88, 0x89, 0xC6, 0x54, 0x36, 0xC3, 0x17, 0x4F, 0xE4, 0xE2, 0x11, 0x2F, 0x22, 0xB0, 0xBC, 0xC8,

examples/use_rust/nrf52840_ble/src/vial.rs

@@ -3,8 +3,8 @@
 include!(concat!(env!("OUT_DIR"), "/config_generated.rs"));
 
 // Or you can manually generate vial config then put here
-// pub const VIAL_KEYBOARD_ID: [u8; 8] = [0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
-// pub const VIAL_KEYBOARD_DEF: [u8; 308] = [
+// pub const VIAL_KEYBOARD_ID: &[u8; 8] = &[0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
+// pub const VIAL_KEYBOARD_DEF: &[u8; 308] = &[
 //     0xFD, 0x37, 0x7A, 0x58, 0x5A, 0x00, 0x00, 0x04, 0xE6, 0xD6, 0xB4, 0x46, 0x02, 0x00, 0x21, 0x01,
 //     0x16, 0x00, 0x00, 0x00, 0x74, 0x2F, 0xE5, 0xA3, 0xE0, 0x01, 0x58, 0x00, 0xF1, 0x5D, 0x00, 0x3D,
 //     0x88, 0x89, 0xC6, 0x54, 0x36, 0xC3, 0x17, 0x4F, 0xE4, 0xE2, 0x11, 0x2F, 0x22, 0xB0, 0xBC, 0xC8,

examples/use_rust/rp2040/src/main.rs

@@ -21,7 +21,7 @@ use embassy_rp::{
 use panic_probe as _;
 use rmk::{
     config::{KeyboardUsbConfig, RmkConfig, VialConfig},
-    initialize_keyboard_with_config_and_run_async_flash,
+    initialize_keyboard_and_run_async_flash,
 };
 use vial::{VIAL_KEYBOARD_DEF, VIAL_KEYBOARD_ID};
 
@@ -65,9 +65,9 @@ async fn main(_spawner: Spawner) {
     };
 
     // Start serving
-    // initialize_keyboard_with_config_and_run::<
+    // initialize_keyboard_and_run::<
     // Flash<peripherals::FLASH, Blocking, FLASH_SIZE>,
-    initialize_keyboard_with_config_and_run_async_flash::<
+    initialize_keyboard_and_run_async_flash::<
         Flash<peripherals::FLASH, Async, FLASH_SIZE>,
         Driver<'_, USB>,
         Input<'_, AnyPin>,

examples/use_rust/rp2040/src/vial.rs

@@ -3,8 +3,8 @@
 include!(concat!(env!("OUT_DIR"), "/config_generated.rs"));
 
 // Or you can manually generate vial config then put here
-// pub const VIAL_KEYBOARD_ID: [u8; 8] = [0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
-// pub const VIAL_KEYBOARD_DEF: [u8; 308] = [
+// pub const VIAL_KEYBOARD_ID: &[u8; 8] = &[0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
+// pub const VIAL_KEYBOARD_DEF: &[u8; 308] = &[
 //     0xFD, 0x37, 0x7A, 0x58, 0x5A, 0x00, 0x00, 0x04, 0xE6, 0xD6, 0xB4, 0x46, 0x02, 0x00, 0x21, 0x01,
 //     0x16, 0x00, 0x00, 0x00, 0x74, 0x2F, 0xE5, 0xA3, 0xE0, 0x01, 0x58, 0x00, 0xF1, 0x5D, 0x00, 0x3D,
 //     0x88, 0x89, 0xC6, 0x54, 0x36, 0xC3, 0x17, 0x4F, 0xE4, 0xE2, 0x11, 0x2F, 0x22, 0xB0, 0xBC, 0xC8,

examples/use_rust/stm32f1/src/main.rs

@@ -18,7 +18,7 @@ use embassy_stm32::{
     Config,
 };
 use panic_halt as _;
-use rmk::initialize_keyboard_and_run;
+use rmk::{initialize_keyboard_and_run, config::{RmkConfig, VialConfig}};
 use vial::{VIAL_KEYBOARD_DEF, VIAL_KEYBOARD_ID};
 
 #[defmt::global_logger]
@@ -53,12 +53,18 @@ async fn main(_spawner: Spawner) {
     // Use internal flash to emulate eeprom
     let f = Flash::new_blocking(p.FLASH);
 
+    // Keyboard config
+    let keyboard_config = RmkConfig {
+        vial_config: VialConfig::new(VIAL_KEYBOARD_ID, VIAL_KEYBOARD_DEF),
+        ..Default::default()
+    };
+
     // Start serving
     initialize_keyboard_and_run::<
+        Flash<'_, Blocking>,
         Driver<'_, USB>,
         Input<'_, AnyPin>,
         Output<'_, AnyPin>,
-        Flash<'_, Blocking>,
         ROW,
         COL,
         NUM_LAYER,
@@ -68,8 +74,7 @@ async fn main(_spawner: Spawner) {
         output_pins,
         Some(f),
         crate::keymap::KEYMAP,
-        &VIAL_KEYBOARD_ID,
-        &VIAL_KEYBOARD_DEF,
+        keyboard_config,
     )
     .await;
 }

examples/use_rust/stm32f1/src/vial.rs

@@ -1,5 +1,5 @@
-pub const VIAL_KEYBOARD_ID: [u8; 8] = [0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
-pub const VIAL_KEYBOARD_DEF: [u8; 308] = [
+pub const VIAL_KEYBOARD_ID: &[u8; 8] = &[0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
+pub const VIAL_KEYBOARD_DEF: &[u8; 308] = &[
     0xFD, 0x37, 0x7A, 0x58, 0x5A, 0x00, 0x00, 0x04, 0xE6, 0xD6, 0xB4, 0x46, 0x02, 0x00, 0x21, 0x01,
     0x16, 0x00, 0x00, 0x00, 0x74, 0x2F, 0xE5, 0xA3, 0xE0, 0x01, 0x58, 0x00, 0xF1, 0x5D, 0x00, 0x3D,
     0x88, 0x89, 0xC6, 0x54, 0x36, 0xC3, 0x17, 0x4F, 0xE4, 0xE2, 0x11, 0x2F, 0x22, 0xB0, 0xBC, 0xC8,

examples/use_rust/stm32f4/src/main.rs

@@ -19,7 +19,7 @@ use embassy_stm32::{
     Config,
 };
 use panic_probe as _;
-use rmk::initialize_keyboard_and_run;
+use rmk::{initialize_keyboard_and_run, config::{RmkConfig, VialConfig}};
 use static_cell::StaticCell;
 use vial::{VIAL_KEYBOARD_DEF, VIAL_KEYBOARD_ID};
 
@@ -55,12 +55,18 @@ async fn main(_spawner: Spawner) {
     // Use internal flash to emulate eeprom
     let f = Flash::new_blocking(p.FLASH);
 
+    // Keyboard config
+    let keyboard_config = RmkConfig {
+        vial_config: VialConfig::new(VIAL_KEYBOARD_ID, VIAL_KEYBOARD_DEF),
+        ..Default::default()
+    };
+
     // Start serving
     initialize_keyboard_and_run::<
+        Flash<'_, Blocking>,
         Driver<'_, USB_OTG_FS>,
         Input<'_, AnyPin>,
         Output<'_, AnyPin>,
-        Flash<'_, Blocking>,
         ROW,
         COL,
         NUM_LAYER,
@@ -70,8 +76,7 @@ async fn main(_spawner: Spawner) {
         output_pins,
         Some(f),
         crate::keymap::KEYMAP,
-        &VIAL_KEYBOARD_ID,
-        &VIAL_KEYBOARD_DEF,
+        keyboard_config,
     )
     .await;
 }

examples/use_rust/stm32f4/src/vial.rs

@@ -1,5 +1,5 @@
-pub const VIAL_KEYBOARD_ID: [u8; 8] = [0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
-pub const VIAL_KEYBOARD_DEF: [u8; 308] = [
+pub const VIAL_KEYBOARD_ID: &[u8; 8] = &[0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
+pub const VIAL_KEYBOARD_DEF: &[u8; 308] = &[
     0xFD, 0x37, 0x7A, 0x58, 0x5A, 0x00, 0x00, 0x04, 0xE6, 0xD6, 0xB4, 0x46, 0x02, 0x00, 0x21, 0x01,
     0x16, 0x00, 0x00, 0x00, 0x74, 0x2F, 0xE5, 0xA3, 0xE0, 0x01, 0x58, 0x00, 0xF1, 0x5D, 0x00, 0x3D,
     0x88, 0x89, 0xC6, 0x54, 0x36, 0xC3, 0x17, 0x4F, 0xE4, 0xE2, 0x11, 0x2F, 0x22, 0xB0, 0xBC, 0xC8,

examples/use_rust/stm32h7/src/main.rs

@@ -24,7 +24,7 @@ use embassy_stm32::{
 use panic_probe as _;
 use rmk::{
     config::{RmkConfig, VialConfig},
-    initialize_keyboard_with_config_and_run,
+    initialize_keyboard_and_run,
 };
 use static_cell::StaticCell;
 use vial::{VIAL_KEYBOARD_DEF, VIAL_KEYBOARD_ID};
@@ -98,7 +98,7 @@ async fn main(_spawner: Spawner) {
     };
 
     // Start serving
-    initialize_keyboard_with_config_and_run::<
+    initialize_keyboard_and_run::<
         Flash<'_, Blocking>,
         Driver<'_, USB_OTG_HS>,
         Input<'_, AnyPin>,

examples/use_rust/stm32h7/src/vial.rs

@@ -3,8 +3,8 @@
 include!(concat!(env!("OUT_DIR"), "/config_generated.rs"));
 
 // Or you can manually generate vial config then put here
-// pub const VIAL_KEYBOARD_ID: [u8; 8] = [0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
-// pub const VIAL_KEYBOARD_DEF: [u8; 308] = [
+// pub const VIAL_KEYBOARD_ID: &[u8; 8] = &[0xB9, 0xBC, 0x09, 0xB2, 0x9D, 0x37, 0x4C, 0xEA];
+// pub const VIAL_KEYBOARD_DEF: &[u8; 308] = &[
 //     0xFD, 0x37, 0x7A, 0x58, 0x5A, 0x00, 0x00, 0x04, 0xE6, 0xD6, 0xB4, 0x46, 0x02, 0x00, 0x21, 0x01,
 //     0x16, 0x00, 0x00, 0x00, 0x74, 0x2F, 0xE5, 0xA3, 0xE0, 0x01, 0x58, 0x00, 0xF1, 0x5D, 0x00, 0x3D,
 //     0x88, 0x89, 0xC6, 0x54, 0x36, 0xC3, 0x17, 0x4F, 0xE4, 0xE2, 0x11, 0x2F, 0x22, 0xB0, 0xBC, 0xC8,