feat(pointing): Add behavior input processor

Add the ability to intercept certain input events and trigger behaviors when they occur. Co-authored-by: Jorge Villalobos <minusfive@users.noreply.github.com> Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
zmkfirmware · Dec 16, 2024 · 43539c4 · 43539c4
1 parent 4d7cad3
commit 43539c4
Show file tree

Hide file tree

Showing 21 changed files with 403 additions and 20 deletions.
diff --git a/app/dts/bindings/input_processors/zmk,input-processor-behaviors.yaml b/app/dts/bindings/input_processors/zmk,input-processor-behaviors.yaml
@@ -0,0 +1,18 @@
+# Copyright (c) 2024, The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+description: Input Processor for invoking behaviors on certain events
+
+compatible: "zmk,input-processor-behaviors"
+
+include: ip_zero_param.yaml
+
+properties:
+  type:
+    type: int
+  codes:
+    type: array
+    required: true
+  bindings:
+    type: phandle-array
+    required: true
diff --git a/app/dts/input/processors.dtsi b/app/dts/input/processors.dtsi
@@ -7,4 +7,5 @@
 #include <input/processors/scaler.dtsi>
 #include <input/processors/code_mapper.dtsi>
 #include <input/processors/transform.dtsi>
-#include <input/processors/temp_layer.dtsi>
+#include <input/processors/temp_layer.dtsi>
+#include <input/processors/behaviors.dtsi>
diff --git a/app/dts/input/processors/behaviors.dtsi b/app/dts/input/processors/behaviors.dtsi
@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2024 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include <zephyr/dt-bindings/input/input-event-codes.h>
+
+/ {
+    zip_button_behaviors: zip_button_behaviors {
+        compatible = "zmk,input-processor-behaviors";
+        #input-processor-cells = <0>;
+        codes =    <INPUT_BTN_0 INPUT_BTN_1 INPUT_BTN_2>;
+        bindings = <&none       &none       &none>;
+    };
+};
diff --git a/app/include/drivers/input_processor.h b/app/include/drivers/input_processor.h
@@ -36,6 +36,7 @@ struct zmk_input_processor_entry {
     }
 
 struct zmk_input_processor_state {
+    uint8_t input_device_index;
     int16_t *remainder;
 };
 

diff --git a/app/include/zmk/combos.h b/app/include/zmk/combos.h
@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2020 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#pragma once
+
+#include <zephyr/devicetree.h>
+
+#define ZMK_COMBOS_UTIL_ONE(n) 1
+
+#define ZMK_COMBOS_LEN                                                                             \
+    COND_CODE_1(                                                                                   \
+        DT_HAS_COMPAT_STATUS_OKAY(zmk_combos),                                                     \
+        (DT_FOREACH_CHILD_STATUS_OKAY_SEP(DT_INST(0, zmk_combos), ZMK_COMBOS_UTIL_ONE, (+))), (0))
diff --git a/app/include/zmk/input_listeners.h b/app/include/zmk/input_listeners.h
@@ -0,0 +1,14 @@
+/*
+ * Copyright (c) 2020 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#pragma once
+
+#include <zephyr/devicetree.h>
+
+#define ZMK_INPUT_LISTENERS_UTIL_ONE(n) 1 +
+
+#define ZMK_INPUT_LISTENERS_LEN                                                                    \
+    (DT_FOREACH_STATUS_OKAY(zmk_input_listener, ZMK_INPUT_LISTENERS_UTIL_ONE) 0)
diff --git a/app/include/zmk/virtual_key_position.h b/app/include/zmk/virtual_key_position.h
@@ -7,6 +7,8 @@
 #pragma once
 
 #include <zmk/matrix.h>
+#include <zmk/combos.h>
+#include <zmk/input_listeners.h>
 #include <zmk/sensors.h>
 
 /**
@@ -22,4 +24,9 @@
 /**
  * Gets the virtual key position to use for the combo with the given index.
  */
-#define ZMK_VIRTUAL_KEY_POSITION_COMBO(index) (ZMK_KEYMAP_LEN + ZMK_KEYMAP_SENSORS_LEN + (index))
+#define ZMK_VIRTUAL_KEY_POSITION_COMBO(index)                                                      \
+    (ZMK_VIRTUAL_KEY_POSITION_SENSOR(ZMK_KEYMAP_SENSORS_LEN) + (index))
+
+#define ZMK_VIRTUAL_KEY_POSITION_BEHAVIOR_INPUT_PROCESSOR(listener_index, processor_index)         \
+    (ZMK_VIRTUAL_KEY_POSITION_COMBO(ZMK_COMBOS_LEN) +                                              \
+     (ZMK_INPUT_LISTENERS_LEN * (processor_index)) + (listener_index))
diff --git a/app/src/pointing/CMakeLists.txt b/app/src/pointing/CMakeLists.txt
@@ -6,5 +6,6 @@ target_sources_ifdef(CONFIG_ZMK_INPUT_PROCESSOR_TRANSFORM app PRIVATE input_proc
 target_sources_ifdef(CONFIG_ZMK_INPUT_PROCESSOR_SCALER app PRIVATE input_processor_scaler.c)
 target_sources_ifdef(CONFIG_ZMK_INPUT_PROCESSOR_TEMP_LAYER app PRIVATE input_processor_temp_layer.c)
 target_sources_ifdef(CONFIG_ZMK_INPUT_PROCESSOR_CODE_MAPPER app PRIVATE input_processor_code_mapper.c)
+target_sources_ifdef(CONFIG_ZMK_INPUT_PROCESSOR_BEHAVIORS app PRIVATE input_processor_behaviors.c)
 target_sources_ifdef(CONFIG_ZMK_POINTING_SMOOTH_SCROLLING app PRIVATE resolution_multipliers.c)
 target_sources_ifdef(CONFIG_ZMK_INPUT_SPLIT app PRIVATE input_split.c)
diff --git a/app/src/pointing/Kconfig b/app/src/pointing/Kconfig
@@ -57,6 +57,11 @@ config ZMK_INPUT_PROCESSOR_CODE_MAPPER
     default y
     depends on DT_HAS_ZMK_INPUT_PROCESSOR_CODE_MAPPER_ENABLED
 
+config ZMK_INPUT_PROCESSOR_BEHAVIORS
+    bool "Behaviors Input Processor"
+    default y
+    depends on DT_HAS_ZMK_INPUT_PROCESSOR_BEHAVIORS_ENABLED
+
 config ZMK_INPUT_SPLIT
     bool "Split input support"
     default y

diff --git a/app/src/pointing/input_listener.c b/app/src/pointing/input_listener.c
@@ -71,6 +71,7 @@ struct input_listener_processor_data {
 };
 
 struct input_listener_config {
+    uint8_t listener_index;
     struct input_listener_config_entry base;
     size_t layer_overrides_len;
     struct input_listener_layer_override layer_overrides[];
@@ -152,7 +153,7 @@ static inline bool is_y_data(const struct input_event *evt) {
     return evt->type == INPUT_EV_REL && evt->code == INPUT_REL_Y;
 }
 
-static int apply_config(const struct input_listener_config_entry *cfg,
+static int apply_config(uint8_t listener_index, const struct input_listener_config_entry *cfg,
                         struct input_listener_processor_data *processor_data,
                         struct input_listener_data *data, struct input_event *evt) {
     size_t remainder_index = 0;
@@ -183,7 +184,9 @@ static int apply_config(const struct input_listener_config_entry *cfg,
             }
         }
 
-        struct zmk_input_processor_state state = {.remainder = remainder};
+        LOG_DBG("LISTENER INDEX: %d", listener_index);
+        struct zmk_input_processor_state state = {.input_device_index = listener_index,
+                                                  .remainder = remainder};
 
         int ret = zmk_input_processor_handle_event(proc_e->dev, evt, proc_e->param1, proc_e->param2,
                                                    &state);
@@ -211,7 +214,8 @@ static int filter_with_input_config(const struct input_listener_config *cfg,
         uint8_t layer = 0;
         while (mask != 0) {
             if (mask & BIT(0) && zmk_keymap_layer_active(layer)) {
-                int ret = apply_config(&override->config, override_data, data, evt);
+                int ret =
+                    apply_config(cfg->listener_index, &override->config, override_data, data, evt);
 
                 if (ret < 0) {
                     return ret;
@@ -226,7 +230,7 @@ static int filter_with_input_config(const struct input_listener_config *cfg,
         }
     }
 
-    return apply_config(&cfg->base, &data->base_processor_data, data, evt);
+    return apply_config(cfg->listener_index, &cfg->base, &data->base_processor_data, data, evt);
 }
 
 static void clear_xy_data(struct input_listener_xy_data *data) {
@@ -376,6 +380,7 @@ static void input_handler(const struct input_listener_config *config,
          DT_INST_FOREACH_CHILD_VARGS(n, CHILD_CONFIG,                                              \
                                      n) static const struct input_listener_config config_##n =     \
              {                                                                                     \
+                 .listener_index = n,                                                              \
                  .base = IL_EXTRACT_CONFIG(DT_DRV_INST(n), n, base),                               \
                  .layer_overrides_len = (0 DT_INST_FOREACH_CHILD(n, IL_ONE)),                      \
                  .layer_overrides = {DT_INST_FOREACH_CHILD_SEP_VARGS(n, IL_OVERRIDE, (, ), n)},    \

diff --git a/app/src/pointing/input_processor_behaviors.c b/app/src/pointing/input_processor_behaviors.c
@@ -0,0 +1,92 @@
+/*
+ * Copyright (c) 2024 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#define DT_DRV_COMPAT zmk_input_processor_behaviors
+
+#include <zephyr/dt-bindings/input/input-event-codes.h>
+
+#include <zephyr/kernel.h>
+#include <zephyr/device.h>
+#include <drivers/input_processor.h>
+
+#include <zephyr/logging/log.h>
+
+LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL);
+
+#include <zmk/keymap.h>
+#include <zmk/behavior.h>
+#include <zmk/virtual_key_position.h>
+
+struct ip_behaviors_config {
+    uint8_t index;
+    size_t size;
+    uint16_t type;
+
+    const uint16_t *codes;
+    const struct zmk_behavior_binding *bindings;
+};
+
+static int ip_behaviors_handle_event(const struct device *dev, struct input_event *event,
+                                     uint32_t param1, uint32_t param2,
+                                     struct zmk_input_processor_state *state) {
+    const struct ip_behaviors_config *cfg = dev->config;
+
+    if (event->type != cfg->type) {
+        return 0;
+    }
+
+    for (size_t i = 0; i < cfg->size; i++) {
+        if (cfg->codes[i] == event->code) {
+            struct zmk_behavior_binding_event behavior_event = {
+                .position = ZMK_VIRTUAL_KEY_POSITION_BEHAVIOR_INPUT_PROCESSOR(
+                    state->input_device_index, cfg->index),
+                .timestamp = k_uptime_get(),
+#if IS_ENABLED(CONFIG_ZMK_SPLIT)
+                .source = ZMK_POSITION_STATE_CHANGE_SOURCE_LOCAL,
+#endif
+            };
+
+            LOG_DBG("FOUND A MATCHING CODE, invoke %s for position %d with %d listeners",
+                    cfg->bindings[i].behavior_dev, behavior_event.position,
+                    ZMK_INPUT_LISTENERS_LEN);
+            int ret = zmk_behavior_invoke_binding(&cfg->bindings[i], behavior_event, event->value);
+            if (ret < 0) {
+                return ret;
+            }
+
+            return ZMK_INPUT_PROC_STOP;
+        }
+    }
+
+    return 0;
+}
+
+static struct zmk_input_processor_driver_api ip_behaviors_driver_api = {
+    .handle_event = ip_behaviors_handle_event,
+};
+
+static int ip_behaviors_init(const struct device *dev) { return 0; }
+
+#define ENTRY(i, node) ZMK_KEYMAP_EXTRACT_BINDING(i, node)
+
+#define IP_BEHAVIORS_INST(n)                                                                       \
+    static const uint16_t ip_behaviors_codes_##n[] = DT_INST_PROP(n, codes);                       \
+    static const struct zmk_behavior_binding ip_behaviors_bindings_##n[] = {                       \
+        LISTIFY(DT_INST_PROP_LEN(n, bindings), ZMK_KEYMAP_EXTRACT_BINDING, (, ), DT_DRV_INST(n))}; \
+    BUILD_ASSERT(ARRAY_SIZE(ip_behaviors_codes_##n) == ARRAY_SIZE(ip_behaviors_bindings_##n),      \
+                 "codes and bindings need to be the same length");                                 \
+    static const struct ip_behaviors_config ip_behaviors_config_##n = {                            \
+        .index = n,                                                                                \
+        .type = DT_INST_PROP_OR(n, type, INPUT_EV_KEY),                                            \
+        .size = DT_INST_PROP_LEN(n, codes),                                                        \
+        .codes = ip_behaviors_codes_##n,                                                           \
+        .bindings = ip_behaviors_bindings_##n,                                                     \
+    };                                                                                             \
+    DEVICE_DT_INST_DEFINE(n, &ip_behaviors_init, NULL, NULL, &ip_behaviors_config_##n,             \
+                          POST_KERNEL, CONFIG_KERNEL_INIT_PRIORITY_DEFAULT,                        \
+                          &ip_behaviors_driver_api);
+
+DT_INST_FOREACH_STATUS_OKAY(IP_BEHAVIORS_INST)
diff --git a/app/tests/pointing/mouse-move/processors/behaviors_basic/events.patterns b/app/tests/pointing/mouse-move/processors/behaviors_basic/events.patterns
@@ -0,0 +1,2 @@
+s/.*hid_mouse_//p
+s/.*hid_listener_keycode_//p
diff --git a/app/tests/pointing/mouse-move/processors/behaviors_basic/keycode_events.snapshot b/app/tests/pointing/mouse-move/processors/behaviors_basic/keycode_events.snapshot
@@ -0,0 +1,6 @@
+pressed: usage_page 0x07 keycode 0x04 implicit_mods 0x00 explicit_mods 0x00
+released: usage_page 0x07 keycode 0x04 implicit_mods 0x00 explicit_mods 0x00
+pressed: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
+released: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
+pressed: usage_page 0x07 keycode 0x06 implicit_mods 0x00 explicit_mods 0x00
+released: usage_page 0x07 keycode 0x06 implicit_mods 0x00 explicit_mods 0x00
diff --git a/app/tests/pointing/mouse-move/processors/behaviors_basic/native_posix_64.conf b/app/tests/pointing/mouse-move/processors/behaviors_basic/native_posix_64.conf
@@ -0,0 +1,6 @@
+CONFIG_GPIO=n
+CONFIG_ZMK_BLE=n
+CONFIG_LOG=y
+CONFIG_LOG_BACKEND_SHOW_COLOR=n
+CONFIG_ZMK_LOG_LEVEL_DBG=y
+CONFIG_ZMK_POINTING=y
diff --git a/app/tests/pointing/mouse-move/processors/behaviors_basic/native_posix_64.keymap b/app/tests/pointing/mouse-move/processors/behaviors_basic/native_posix_64.keymap
@@ -0,0 +1,44 @@
+
+#include <dt-bindings/zmk/input_transform.h>
+#include <zephyr/dt-bindings/input/input-event-codes.h>
+
+#include <behaviors.dtsi>
+#include <input/processors.dtsi>
+#include <dt-bindings/zmk/keys.h>
+#include <dt-bindings/zmk/kscan_mock.h>
+#include <dt-bindings/zmk/pointing.h>
+
+
+&zip_button_behaviors {
+    bindings = <&kp A &kp B &kp C>;
+};
+
+&mkp_input_listener {
+    input-processors = <&zip_button_behaviors>;
+};
+
+/ {
+    keymap {
+        compatible = "zmk,keymap";
+        label ="Default keymap";
+
+        default_layer {
+            bindings = <
+                &mkp LCLK &mkp RCLK
+                &mkp MCLK &none
+            >;
+        };
+    };
+};
+
+
+&kscan {
+    events = <
+        ZMK_MOCK_PRESS(0,0,10)
+        ZMK_MOCK_RELEASE(0,0,10)
+        ZMK_MOCK_PRESS(0,1,10)
+        ZMK_MOCK_RELEASE(0,1,10)
+        ZMK_MOCK_PRESS(1,0,10)
+        ZMK_MOCK_RELEASE(1,0,10)
+    >;
+};
diff --git a/app/tests/pointing/mouse-move/processors/behaviors_hold_tap/events.patterns b/app/tests/pointing/mouse-move/processors/behaviors_hold_tap/events.patterns
@@ -0,0 +1,2 @@
+s/.*hid_mouse_//p
+s/.*hid_listener_keycode_//p
diff --git a/app/tests/pointing/mouse-move/processors/behaviors_hold_tap/keycode_events.snapshot b/app/tests/pointing/mouse-move/processors/behaviors_hold_tap/keycode_events.snapshot
@@ -0,0 +1,16 @@
+pressed: usage_page 0x07 keycode 0x04 implicit_mods 0x00 explicit_mods 0x00
+released: usage_page 0x07 keycode 0x04 implicit_mods 0x00 explicit_mods 0x00
+pressed: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
+released: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
+pressed: usage_page 0x07 keycode 0x06 implicit_mods 0x00 explicit_mods 0x00
+released: usage_page 0x07 keycode 0x06 implicit_mods 0x00 explicit_mods 0x00
+pressed: usage_page 0x07 keycode 0xE0 implicit_mods 0x00 explicit_mods 0x00
+released: usage_page 0x07 keycode 0xE0 implicit_mods 0x00 explicit_mods 0x00
+pressed: usage_page 0x07 keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
+released: usage_page 0x07 keycode 0xE1 implicit_mods 0x00 explicit_mods 0x00
+pressed: usage_page 0x07 keycode 0xE2 implicit_mods 0x00 explicit_mods 0x00
+released: usage_page 0x07 keycode 0xE2 implicit_mods 0x00 explicit_mods 0x00
+pressed: usage_page 0x07 keycode 0xE0 implicit_mods 0x00 explicit_mods 0x00
+pressed: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
+released: usage_page 0x07 keycode 0xE0 implicit_mods 0x00 explicit_mods 0x00
+released: usage_page 0x07 keycode 0x05 implicit_mods 0x00 explicit_mods 0x00
diff --git a/app/tests/pointing/mouse-move/processors/behaviors_hold_tap/native_posix_64.conf b/app/tests/pointing/mouse-move/processors/behaviors_hold_tap/native_posix_64.conf
@@ -0,0 +1,6 @@
+CONFIG_GPIO=n
+CONFIG_ZMK_BLE=n
+CONFIG_LOG=y
+CONFIG_LOG_BACKEND_SHOW_COLOR=n
+CONFIG_ZMK_LOG_LEVEL_DBG=y
+CONFIG_ZMK_POINTING=y
-Original file line number
+Diff line change
@@ Expand Up / @@ -36,6 +36,7 @@ struct zmk_input_processor_entry { @@
         }
     struct zmk_input_processor_state {
+        uint8_t input_device_index;
         int16_t *remainder;
     };
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		s/.*hid_mouse_//p
		s/.*hid_listener_keycode_//p