Merge pull request #847 from HaoboGu/feat/rynk-pr1-protocol

Rename rmk_protocol to rynk, add basic rynk protocol, remove postcard-rpc

Author: HaoboGu

rmk-config/src/lib.rs

@@ -26,7 +26,7 @@ pub(crate) mod storage;
 ///
 /// These define the maximum values any firmware may use for protocol
 /// Vec capacities (`COMBO_SIZE`, `MORSE_SIZE`, etc.). The host tool compiles
-/// against these as upper bounds. Any firmware with `rmk_protocol` enabled
+/// against these as upper bounds. Any firmware with `rynk` enabled
 /// must satisfy `value <= ceiling` at compile time.
 ///
 /// Constant names mirror the generated constants with a `MAX_` prefix:
@@ -249,6 +249,11 @@ pub(crate) struct RmkConstantsConfig {
     /// Smaller values reduce firmware RAM usage but require more round-trips.
     #[serde_inline_default(64)]
     pub protocol_macro_chunk_size: usize,
+    /// Optional override for the Rynk RX/TX buffer size (bytes). When `None`,
+    /// the build emits `RYNK_BUFFER_SIZE = RYNK_MIN_BUFFER_SIZE`. The const
+    /// assertion in `rmk/src/host/rynk` rejects user values below the floor.
+    #[serde(default)]
+    pub rynk_buffer_size: Option<usize>,
 }
 
 fn check_combo_max_num<'de, D>(deserializer: D) -> Result<usize, D::Error>
@@ -316,6 +321,7 @@ impl Default for RmkConstantsConfig {
             split_central_sleep_timeout_seconds: 0,
             protocol_max_bulk_size: 8,
             protocol_macro_chunk_size: 64,
+            rynk_buffer_size: None,
         }
     }
 }

rmk-config/src/resolved/build_constants.rs

@@ -48,6 +48,9 @@ pub struct BuildConstants {
     pub split_central_sleep_timeout_seconds: u32,
     pub protocol_max_bulk_size: usize,
     pub protocol_macro_chunk_size: usize,
+    /// Optional override for the Rynk RX/TX buffer size (bytes). `None`
+    /// instructs `rmk-types/build.rs` to fall back to `RYNK_MIN_BUFFER_SIZE`.
+    pub rynk_buffer_size: Option<usize>,
     pub events: Vec<EventChannel>,
     pub passkey: Option<Passkey>,
 }
@@ -173,6 +176,7 @@ impl crate::KeyboardTomlConfig {
             split_central_sleep_timeout_seconds: rmk.split_central_sleep_timeout_seconds,
             protocol_max_bulk_size: rmk.protocol_max_bulk_size,
             protocol_macro_chunk_size: rmk.protocol_macro_chunk_size,
+            rynk_buffer_size: rmk.rynk_buffer_size,
             events,
             passkey,
         })

rmk-types/Cargo.toml

@@ -14,8 +14,6 @@ defmt = { version = "1.0", optional = true }
 
 serde = { version = "1", default-features = false, features = ["derive"] }
 postcard = { version = "1", features = ["experimental-derive"] }
-postcard-schema = { version = "0.2", default-features = false, features = ["derive", "heapless-v0_9"], optional = true }
-postcard-rpc = { version = "0.12", default-features = false, optional = true }
 heapless = { version = "0.9", default-features = false, features = ["serde"] }
 strum = { version = "0.28", default-features = false, features = ["derive"] }
 
@@ -34,14 +32,14 @@ defmt = [
 ]
 # Feature for proc-macro code generation only, not included in firmware
 _codegen = []
-# Feature for RMK native protocol schema/endpoint support
-rmk_protocol = ["dep:postcard-rpc", "dep:postcard-schema"]
+# Feature for RMK native (rynk) protocol support
+rynk = []
 # Bulk transfer endpoints for MCUs with sufficient RAM.
 # Enables multi-element bulk keymap/combo/morse endpoints and BULK_SIZE constant.
-bulk = ["rmk_protocol"]
+bulk = ["rynk"]
 # Host tool: uses protocol ceiling values for Vec capacities.
 # Enables all optional endpoint groups so the host can talk to any firmware.
-host = ["rmk_protocol", "bulk", "_ble", "split"]
+host = ["rynk", "bulk", "_ble", "split"]
 # Build-time only features: forwarded from rmk to control constant generation in build.rs.
 # Also used as `#[cfg(feature = "...")]` guards for protocol endpoint/topic gating.
 _ble = []

rmk-types/build.rs

@@ -150,8 +150,8 @@ fn generate_constants(bc: &BuildConstants) -> String {
             bc.protocol_macro_chunk_size
         ));
         // Compile-time check: firmware Vec sizes must not exceed protocol ceilings.
-        // Only enforce when the rmk_protocol feature is active.
-        if env::var("CARGO_FEATURE_RMK_PROTOCOL").is_ok() {
+        // Only enforce when the rynk feature is active.
+        if env::var("CARGO_FEATURE_RYNK").is_ok() {
             lines.push("const _: () = assert!(COMBO_SIZE <= MAX_COMBO_SIZE, \"firmware COMBO_SIZE exceeds protocol ceiling MAX_COMBO_SIZE\");".to_string());
             lines.push("const _: () = assert!(MORSE_SIZE <= MAX_MORSE_SIZE, \"firmware MORSE_SIZE exceeds protocol ceiling MAX_MORSE_SIZE\");".to_string());
             lines.push("const _: () = assert!(MACRO_DATA_SIZE <= MAX_MACRO_DATA_SIZE, \"firmware MACRO_DATA_SIZE exceeds protocol ceiling MAX_MACRO_DATA_SIZE\");".to_string());
@@ -164,6 +164,25 @@ fn generate_constants(bc: &BuildConstants) -> String {
         }
     }
 
+    // Rynk RX/TX buffer size. Only emitted when the `rynk` feature is on
+    // so the constant doesn't leak into non-Rynk builds. `None` falls back
+    // to `RYNK_MIN_BUFFER_SIZE`, which is the compile-time lower bound;
+    // the `rmk/src/host/rynk/mod.rs` const-assert rejects values below it.
+    if env::var("CARGO_FEATURE_RYNK").is_ok() {
+        match bc.rynk_buffer_size {
+            Some(n) => {
+                lines.push(format!("pub const RYNK_BUFFER_SIZE: usize = {n};"));
+            }
+            None => {
+                lines.push(
+                    "pub const RYNK_BUFFER_SIZE: usize = \
+                     crate::protocol::rynk::RYNK_MIN_BUFFER_SIZE;"
+                        .to_string(),
+                );
+            }
+        }
+    }
+
     // Event channels
     for ev in &bc.events {
         let upper = ev.name.to_uppercase();

rmk-types/src/action/encoder.rs

@@ -1,8 +1,6 @@
 //! Rotary encoder actions.
 
 use postcard::experimental::max_size::MaxSize;
-#[cfg(feature = "rmk_protocol")]
-use postcard_schema::Schema;
 use serde::{Deserialize, Serialize};
 
 use super::KeyAction;
@@ -12,7 +10,6 @@ use super::KeyAction;
 /// Both fields default to `KeyAction::No` (no action).
 #[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize, MaxSize)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
-#[cfg_attr(feature = "rmk_protocol", derive(Schema))]
 pub struct EncoderAction {
     /// Action triggered when the encoder is rotated clockwise.
     pub clockwise: KeyAction,

rmk-types/src/action/key_action.rs

@@ -1,8 +1,6 @@
 //! Composite key actions stored in the keymap.
 
 use postcard::experimental::max_size::MaxSize;
-#[cfg(feature = "rmk_protocol")]
-use postcard_schema::Schema;
 use serde::{Deserialize, Serialize};
 
 use super::Action;
@@ -12,7 +10,6 @@ use crate::morse::MorseProfile;
 /// It can be a single action like triggering a key, or a composite keyboard action like tap/hold
 #[derive(Debug, Copy, Clone, Eq, Serialize, Deserialize, MaxSize)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
-#[cfg_attr(feature = "rmk_protocol", derive(Schema))]
 #[non_exhaustive]
 pub enum KeyAction {
     /// No action

rmk-types/src/action/keyboard.rs

@@ -1,14 +1,11 @@
 //! Keyboard control actions.
 
 use postcard::experimental::max_size::MaxSize;
-#[cfg(feature = "rmk_protocol")]
-use postcard_schema::Schema;
 use serde::{Deserialize, Serialize};
 
 /// Actions for controlling the keyboard or changing the keyboard's state, for example, enable/disable a particular function
 #[derive(Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, MaxSize)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
-#[cfg_attr(feature = "rmk_protocol", derive(Schema))]
 #[cfg_attr(feature = "_codegen", derive(strum::VariantNames))]
 #[non_exhaustive]
 pub enum KeyboardAction {

rmk-types/src/action/light.rs

@@ -1,14 +1,11 @@
 //! Light control actions.
 
 use postcard::experimental::max_size::MaxSize;
-#[cfg(feature = "rmk_protocol")]
-use postcard_schema::Schema;
 use serde::{Deserialize, Serialize};
 
 /// Actions for controlling lights
 #[derive(Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, MaxSize)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
-#[cfg_attr(feature = "rmk_protocol", derive(Schema))]
 #[cfg_attr(feature = "_codegen", derive(strum::VariantNames))]
 #[non_exhaustive]
 pub enum LightAction {

rmk-types/src/action/mod.rs

@@ -22,8 +22,6 @@ pub use key_action::KeyAction;
 pub use keyboard::KeyboardAction;
 pub use light::LightAction;
 use postcard::experimental::max_size::MaxSize;
-#[cfg(feature = "rmk_protocol")]
-use postcard_schema::Schema;
 use serde::{Deserialize, Serialize};
 
 use crate::keycode::{KeyCode, SpecialKey};
@@ -34,7 +32,6 @@ use crate::steno::StenoKey;
 /// A single basic action that a keyboard can execute.
 #[derive(Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, MaxSize)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
-#[cfg_attr(feature = "rmk_protocol", derive(Schema))]
 #[non_exhaustive]
 pub enum Action {
     /// Default action, no action.

rmk-types/src/battery.rs

@@ -1,13 +1,10 @@
 //! Battery status types.
 
 use postcard::experimental::max_size::MaxSize;
-#[cfg(feature = "rmk_protocol")]
-use postcard_schema::Schema;
 use serde::{Deserialize, Serialize};
 
 /// Charge state of the battery.
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, MaxSize)]
-#[cfg_attr(feature = "rmk_protocol", derive(Schema))]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum ChargeState {
     Charging,
@@ -28,7 +25,6 @@ impl From<bool> for ChargeState {
 
 /// Battery status used for both status queries and event notifications.
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, MaxSize)]
-#[cfg_attr(feature = "rmk_protocol", derive(Schema))]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum BatteryStatus {
     Unavailable,