mirror of
https://github.com/zmkfirmware/zmk.git
synced 2026-03-20 04:55:20 -05:00
cb867f92db
refactor(pointing): Allow stopping event propagation
Allow input processors to return a special value if a given input event
should not be further processed/propagated.
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>
92 lines
3.7 KiB
C
92 lines
3.7 KiB
C
/*
|
|
* 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) |