Studio RPC Infrastructure

.github/workflows/build.yml

@@ -79,7 +79,7 @@ jobs:
               try {
                 console.log(`::group::${{ matrix.board}} ${shieldArgs.shield} Build`)
 
-                const output = execSync(`west build -s app -p -b ${{ matrix.board }} -- ${shieldArgs.shield ? '-DSHIELD="' + shieldArgs.shield + '"' : ''} ${shieldArgs['cmake-args'] || ''}`);
+                const output = execSync(`west build -s app -p -b ${{ matrix.board }} ${shieldArgs.snippet ? '-S ' + shieldArgs.snippet : ''} -- ${shieldArgs.shield ? '-DSHIELD="' + shieldArgs.shield + '"' : ''} ${shieldArgs['cmake-args'] || ''}`);
 
                 console.log(output.toString());
               } catch (e) {
@@ -170,6 +170,7 @@ jobs:
               perBoard[configuration.board].push({
                 shield: configuration.shield,
                 'cmake-args': configuration['cmake-args'],
+                snippet: configuration.snippet,
                 nickname: configuration.nickname
               })
             }

app/CMakeLists.txt

@@ -63,6 +63,7 @@ if ((NOT CONFIG_ZMK_SPLIT) OR CONFIG_ZMK_SPLIT_ROLE_CENTRAL)
   target_sources_ifdef(CONFIG_ZMK_BEHAVIOR_SENSOR_ROTATE_VAR app PRIVATE src/behaviors/behavior_sensor_rotate_var.c)
   target_sources_ifdef(CONFIG_ZMK_BEHAVIOR_SENSOR_ROTATE_COMMON app PRIVATE src/behaviors/behavior_sensor_rotate_common.c)
   target_sources_ifdef(CONFIG_ZMK_BEHAVIOR_MOUSE_KEY_PRESS app PRIVATE src/behaviors/behavior_mouse_key_press.c)
+  target_sources_ifdef(CONFIG_ZMK_BEHAVIOR_STUDIO_UNLOCK app PRIVATE src/behaviors/behavior_studio_unlock.c)
   target_sources(app PRIVATE src/combo.c)
   target_sources(app PRIVATE src/behaviors/behavior_tap_dance.c)
   target_sources(app PRIVATE src/behavior_queue.c)
@@ -105,4 +106,27 @@ target_sources(app PRIVATE src/main.c)
 add_subdirectory(src/display/)
 add_subdirectory_ifdef(CONFIG_SETTINGS src/settings/)
 
+if (CONFIG_ZMK_STUDIO_RPC)
+  # For some reason this is failing if run from a different sub-file.
+  list(APPEND CMAKE_MODULE_PATH ${ZEPHYR_BASE}/modules/nanopb)
+
+  include(nanopb)
+
+    # Turn off the default nanopb behavior
+  set(NANOPB_GENERATE_CPP_STANDALONE OFF)
+
+  nanopb_generate_cpp(proto_srcs proto_hdrs RELPATH ${ZEPHYR_ZMK_STUDIO_MESSAGES_MODULE_DIR}
+                        ${ZEPHYR_ZMK_STUDIO_MESSAGES_MODULE_DIR}/proto/zmk/studio.proto
+                        ${ZEPHYR_ZMK_STUDIO_MESSAGES_MODULE_DIR}/proto/zmk/meta.proto
+                        ${ZEPHYR_ZMK_STUDIO_MESSAGES_MODULE_DIR}/proto/zmk/core.proto
+                        ${ZEPHYR_ZMK_STUDIO_MESSAGES_MODULE_DIR}/proto/zmk/behaviors.proto
+                        ${ZEPHYR_ZMK_STUDIO_MESSAGES_MODULE_DIR}/proto/zmk/keymap.proto
+  )
+
+  target_include_directories(app PUBLIC ${CMAKE_CURRENT_BINARY_DIR})
+  target_sources(app PRIVATE ${proto_srcs} ${proto_hdrs})
+
+  add_subdirectory(src/studio)
+endif()
+
 zephyr_cc_option(-Wfatal-errors)

app/Kconfig

@@ -258,6 +258,8 @@ rsource "src/split/Kconfig"
 #Basic Keyboard Setup
 endmenu
 
+rsource "src/studio/Kconfig"
+
 menu "Display/LED Options"
 
 rsource "src/display/Kconfig"

app/Kconfig.behaviors

@@ -31,6 +31,7 @@ config ZMK_BEHAVIOR_LOCAL_ID_TYPE_SETTINGS_TABLE
 
 config ZMK_BEHAVIOR_LOCAL_ID_TYPE_CRC16
     bool "CRC16 Hash"
+    select CRC
     help
       Use the CRC16-ANSI hash of behavior device names to generate
       stable behavior local IDs. This saves on settings storage at
@@ -108,6 +109,11 @@ config ZMK_BEHAVIOR_SENSOR_ROTATE_VAR
     depends on DT_HAS_ZMK_BEHAVIOR_SENSOR_ROTATE_VAR_ENABLED
     select ZMK_BEHAVIOR_SENSOR_ROTATE_COMMON
 
+config ZMK_BEHAVIOR_STUDIO_UNLOCK
+    bool
+    default y
+    depends on DT_HAS_ZMK_BEHAVIOR_STUDIO_UNLOCK_ENABLED && ZMK_STUDIO
+
 config ZMK_BEHAVIOR_MACRO
     bool
     default y

app/boards/arm/bdn9/bdn9_rev2.dts

@@ -109,6 +109,9 @@ zephyr_udc0: &usb {
     status = "okay";
     pinctrl-0 = <&usb_dm_pa11 &usb_dp_pa12>;
     pinctrl-names = "default";
+
+    // Overridden to lower RAM usage.
+    num-bidir-endpoints = <4>;
 };
 
 &rtc {

app/boards/arm/bdn9/bdn9_rev2_defconfig

@@ -5,9 +5,6 @@ CONFIG_SOC_STM32F072XB=y
 # 72MHz system clock
 CONFIG_SYS_CLOCK_HW_CYCLES_PER_SEC=72000000
 
-# Floating Point Options
-CONFIG_FPU=y
-
 # enable GPIO
 CONFIG_GPIO=y
 
@@ -17,10 +14,9 @@ CONFIG_PINCTRL=y
 # Poll to avoid interrupt overlap issues
 CONFIG_ZMK_KSCAN_DIRECT_POLLING=y
 
-# Needed to reduce this to size that will fit on F072
-CONFIG_HEAP_MEM_POOL_SIZE=1024
+CONFIG_ISR_STACK_SIZE=1024
 
 # clock configuration
 CONFIG_CLOCK_CONTROL=y
 
-CONFIG_ZMK_USB=y
+CONFIG_ZMK_USB=y

app/core-coverage.yml

@@ -40,3 +40,32 @@ include:
   - board: nice_nano_v2
     shield: lily58_left nice_view_adapter nice_view
     nickname: "niceview"
+  - board: bdn9_rev2
+    snippet: studio-rpc-usb-uart
+    cmake-args: "-DCONFIG_ZMK_STUDIO=y"
+    nickname: "stm32-studio"
+  - board: nice_nano_v2
+    shield: reviung41
+    snippet: studio-rpc-usb-uart
+    cmake-args: "-DCONFIG_ZMK_STUDIO=y"
+    nickname: "nrf52-studio"
+  - board: nice_nano_v2
+    shield: corne_left
+    snippet: studio-rpc-usb-uart
+    cmake-args: "-DCONFIG_ZMK_STUDIO=y"
+    nickname: "split-left-studio"
+  - board: nice_nano_v2
+    shield: corne_right
+    snippet: studio-rpc-usb-uart
+    cmake-args: "-DCONFIG_ZMK_STUDIO=y"
+    nickname: "split-right-studio"
+  - board: sparkfun_pro_micro_rp2040
+    shield: reviung41
+    snippet: studio-rpc-usb-uart
+    cmake-args: "-DCONFIG_ZMK_STUDIO=y"
+    nickname: "rp2040-studio"
+  - board: seeeduino_xiao
+    shield: hummingbird
+    snippet: studio-rpc-usb-uart
+    cmake-args: "-DCONFIG_ZMK_STUDIO=y"
+    nickname: "samd21-studio"

app/dts/behaviors.dtsi

@@ -21,3 +21,4 @@
 #include <behaviors/macros.dtsi>
 #include <behaviors/mouse_key_press.dtsi>
 #include <behaviors/soft_off.dtsi>
+#include <behaviors/studio_unlock.dtsi>

app/dts/behaviors/studio_unlock.dtsi

@@ -0,0 +1,15 @@
+/*
+ * Copyright (c) 2024 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+/ {
+    behaviors {
+        studio_unlock: studio_unlock {
+            compatible = "zmk,behavior-studio-unlock";
+            #binding-cells = <0>;
+            display-name = "Studio Unlock";
+        };
+    };
+};

app/dts/bindings/behaviors/zmk,behavior-studio-unlock.yaml

@@ -0,0 +1,8 @@
+# Copyright (c) 2024 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+description: Studio Unlock Behavior
+
+compatible: "zmk,behavior-studio-unlock"
+
+include: zero_param.yaml

app/include/linker/zmk-rpc-event-mappers.ld

@@ -0,0 +1,9 @@
+/*
+ * Copyright (c) 2024 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include <zephyr/linker/linker-defs.h>
+
+ITERABLE_SECTION_ROM(zmk_rpc_event_mapper, 4)

app/include/linker/zmk-rpc-subsystem-handlers.ld

@@ -0,0 +1,9 @@
+/*
+ * Copyright (c) 2024 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include <zephyr/linker/linker-defs.h>
+
+ITERABLE_SECTION_ROM(zmk_rpc_subsystem_handler, 4)

app/include/linker/zmk-rpc-subsystems.ld

@@ -0,0 +1,9 @@
+/*
+ * Copyright (c) 2024 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include <zephyr/linker/linker-defs.h>
+
+ITERABLE_SECTION_RAM(zmk_rpc_subsystem, 4)

app/include/linker/zmk-rpc-transport.ld

@@ -0,0 +1,9 @@
+/*
+ * Copyright (c) 2024 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include <zephyr/linker/linker-defs.h>
+
+ITERABLE_SECTION_ROM(zmk_rpc_transport, 4)

app/include/zmk/hid.h

@@ -25,6 +25,22 @@
 #define ZMK_HID_KEYBOARD_NKRO_MAX_USAGE HID_USAGE_KEY_KEYPAD_EQUAL
 #endif
 
+#if IS_ENABLED(CONFIG_ZMK_HID_CONSUMER_REPORT_USAGES_BASIC)
+#define ZMK_HID_CONSUMER_MAX_USAGE 0xFF
+#elif IS_ENABLED(CONFIG_ZMK_HID_CONSUMER_REPORT_USAGES_FULL)
+#define ZMK_HID_CONSUMER_MAX_USAGE 0xFFF
+#else
+#error "Unknown consumer report usages configuration"
+#endif
+
+#if IS_ENABLED(CONFIG_ZMK_HID_REPORT_TYPE_NKRO)
+#define ZMK_HID_KEYBOARD_MAX_USAGE ZMK_HID_KEYBOARD_NKRO_MAX_USAGE
+#elif IS_ENABLED(CONFIG_ZMK_HID_REPORT_TYPE_HKRO)
+#define ZMK_HID_KEYBOARD_MAX_USAGE 0xFF
+#else
+#error "Unknown keyboard report usages configuration"
+#endif
+
 #define ZMK_HID_MOUSE_NUM_BUTTONS 0x05
 
 // See https://www.usb.org/sites/default/files/hid1_11.pdf section 6.2.2.4 Main Items

app/include/zmk/studio/core.h

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2024 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#pragma once
+
+#include <zmk/event_manager.h>
+
+enum zmk_studio_core_lock_state {
+    ZMK_STUDIO_CORE_LOCK_STATE_LOCKED = 0,
+    ZMK_STUDIO_CORE_LOCK_STATE_UNLOCKED = 1,
+};
+
+struct zmk_studio_core_lock_state_changed {
+    enum zmk_studio_core_lock_state state;
+};
+
+struct zmk_studio_core_unlock_requested {};
+
+ZMK_EVENT_DECLARE(zmk_studio_core_lock_state_changed);
+
+enum zmk_studio_core_lock_state zmk_studio_core_get_lock_state(void);
+
+void zmk_studio_core_unlock();
+void zmk_studio_core_lock();
+void zmk_studio_core_initiate_unlock();
+void zmk_studio_core_complete_unlock();
+
+void zmk_studio_core_reschedule_lock_timeout();