/* * Copyright (c) 2022 The ZMK Contributors * * SPDX-License-Identifier: MIT */ #define DT_DRV_COMPAT zmk_behavior_macro #include #include #include #include #include #include LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL); #if DT_HAS_COMPAT_STATUS_OKAY(DT_DRV_COMPAT) enum behavior_macro_mode { MACRO_MODE_TAP, MACRO_MODE_PRESS, MACRO_MODE_RELEASE, }; struct behavior_macro_trigger_state { uint32_t wait_ms; uint32_t tap_ms; enum behavior_macro_mode mode; uint16_t start_index; uint16_t count; }; struct behavior_macro_state { struct behavior_macro_trigger_state release_state; uint32_t press_bindings_count; }; struct behavior_macro_config { uint32_t default_wait_ms; uint32_t default_tap_ms; uint32_t count; struct zmk_behavior_binding bindings[]; }; #define TAP_MODE DT_LABEL(DT_INST(0, zmk_macro_control_mode_tap)) #define PRESS_MODE DT_LABEL(DT_INST(0, zmk_macro_control_mode_press)) #define REL_MODE DT_LABEL(DT_INST(0, zmk_macro_control_mode_release)) #define TAP_TIME DT_LABEL(DT_INST(0, zmk_macro_control_tap_time)) #define WAIT_TIME DT_LABEL(DT_INST(0, zmk_macro_control_wait_time)) #define WAIT_REL DT_LABEL(DT_INST(0, zmk_macro_pause_for_release)) #define ZM_IS_NODE_MATCH(a, b) (strcmp(a, b) == 0) #define IS_TAP_MODE(dev) ZM_IS_NODE_MATCH(dev, TAP_MODE) #define IS_PRESS_MODE(dev) ZM_IS_NODE_MATCH(dev, PRESS_MODE) #define IS_RELEASE_MODE(dev) ZM_IS_NODE_MATCH(dev, REL_MODE) #define IS_TAP_TIME(dev) ZM_IS_NODE_MATCH(dev, TAP_TIME) #define IS_WAIT_TIME(dev) ZM_IS_NODE_MATCH(dev, WAIT_TIME) #define IS_PAUSE(dev) ZM_IS_NODE_MATCH(dev, WAIT_REL) static bool handle_control_binding(struct behavior_macro_trigger_state *state, const struct zmk_behavior_binding *binding) { if (IS_TAP_MODE(binding->behavior_dev)) { state->mode = MACRO_MODE_TAP; LOG_DBG("macro mode set: tap"); } else if (IS_PRESS_MODE(binding->behavior_dev)) { state->mode = MACRO_MODE_PRESS; LOG_DBG("macro mode set: press"); } else if (IS_RELEASE_MODE(binding->behavior_dev)) { state->mode = MACRO_MODE_RELEASE; LOG_DBG("macro mode set: release"); } else if (IS_TAP_TIME(binding->behavior_dev)) { state->tap_ms = binding->param1; LOG_DBG("macro tap time set: %d", state->tap_ms); } else if (IS_WAIT_TIME(binding->behavior_dev)) { state->wait_ms = binding->param1; LOG_DBG("macro wait time set: %d", state->wait_ms); } else { return false; } return true; } static int behavior_macro_init(const struct device *dev) { const struct behavior_macro_config *cfg = dev->config; struct behavior_macro_state *state = dev->data; state->press_bindings_count = cfg->count; state->release_state.start_index = cfg->count; state->release_state.count = 0; LOG_DBG("Precalculate initial release state:"); for (int i = 0; i < cfg->count; i++) { if (handle_control_binding(&state->release_state, &cfg->bindings[i])) { // Updated state used for initial state on release. } else if (IS_PAUSE(cfg->bindings[i].behavior_dev)) { state->release_state.start_index = i + 1; state->release_state.count = cfg->count - state->release_state.start_index; state->press_bindings_count = i; LOG_DBG("Release will resume at %d", state->release_state.start_index); break; } else { // Ignore regular invokable bindings } } return 0; }; static void queue_macro(uint32_t position, const struct zmk_behavior_binding bindings[], struct behavior_macro_trigger_state state) { LOG_DBG("Iterating macro bindings - starting: %d, count: %d", state.start_index, state.count); for (int i = state.start_index; i < state.start_index + state.count; i++) { if (!handle_control_binding(&state, &bindings[i])) { switch (state.mode) { case MACRO_MODE_TAP: zmk_behavior_queue_add(position, bindings[i], true, state.tap_ms); zmk_behavior_queue_add(position, bindings[i], false, state.wait_ms); break; case MACRO_MODE_PRESS: zmk_behavior_queue_add(position, bindings[i], true, state.wait_ms); break; case MACRO_MODE_RELEASE: zmk_behavior_queue_add(position, bindings[i], false, state.wait_ms); break; default: LOG_ERR("Unknown macro mode: %d", state.mode); break; } } } } static int on_macro_binding_pressed(struct zmk_behavior_binding *binding, struct zmk_behavior_binding_event event) { const struct device *dev = device_get_binding(binding->behavior_dev); const struct behavior_macro_config *cfg = dev->config; struct behavior_macro_state *state = dev->data; struct behavior_macro_trigger_state trigger_state = {.mode = MACRO_MODE_TAP, .tap_ms = cfg->default_tap_ms, .wait_ms = cfg->default_wait_ms, .start_index = 0, .count = state->press_bindings_count}; queue_macro(event.position, cfg->bindings, trigger_state); return ZMK_BEHAVIOR_OPAQUE; } static int on_macro_binding_released(struct zmk_behavior_binding *binding, struct zmk_behavior_binding_event event) { const struct device *dev = device_get_binding(binding->behavior_dev); const struct behavior_macro_config *cfg = dev->config; struct behavior_macro_state *state = dev->data; queue_macro(event.position, cfg->bindings, state->release_state); return ZMK_BEHAVIOR_OPAQUE; } static const struct behavior_driver_api behavior_macro_driver_api = { .binding_pressed = on_macro_binding_pressed, .binding_released = on_macro_binding_released, }; #define BINDING_WITH_COMMA(idx, drv_inst) ZMK_KEYMAP_EXTRACT_BINDING(idx, DT_DRV_INST(drv_inst)), #define TRANSFORMED_BEHAVIORS(n) \ {UTIL_LISTIFY(DT_PROP_LEN(DT_DRV_INST(n), bindings), BINDING_WITH_COMMA, n)}, #define MACRO_INST(n) \ static struct behavior_macro_state behavior_macro_state_##n = {}; \ static struct behavior_macro_config behavior_macro_config_##n = { \ .default_wait_ms = DT_INST_PROP_OR(n, wait_ms, 100), \ .default_tap_ms = DT_INST_PROP_OR(n, tap_ms, 100), \ .count = DT_INST_PROP_LEN(n, bindings), \ .bindings = TRANSFORMED_BEHAVIORS(n)}; \ DEVICE_DT_INST_DEFINE(n, behavior_macro_init, NULL, &behavior_macro_state_##n, \ &behavior_macro_config_##n, APPLICATION, \ CONFIG_KERNEL_INIT_PRIORITY_DEFAULT, &behavior_macro_driver_api); DT_INST_FOREACH_STATUS_OKAY(MACRO_INST) #endif /* DT_HAS_COMPAT_STATUS_OKAY(DT_DRV_COMPAT) */