pwarren/zmk_mf68
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

fix(combos): Fix stuck keys when pressing long combos.

Browse source 
To properly retrigger hold-taps when a combo is not activated, some
position down events are reraised instead of released. The corresponding
position up events were never reraised, causing a potential stuck key.
This commit is contained in:
Okke Formsma 2021-02-27 22:34:15 +01:00 committed by Pete Johanson
parent 8ebe0cd0c8
commit 0df7110058
16 changed files with 82 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
app/src/combo.c
View file

@ -192,7 +192,7 @@ static inline bool candidate_is_completely_pressed(struct combo_cfg *candidate)
return pressed_keys[candidate->key_position_len - 1] != NULL;
}
static void cleanup();
static int cleanup();
static int filter_timed_out_candidates(int64_t timestamp) {
int num_candidates = 0;
@ -224,7 +224,7 @@ static int clear_candidates() {
}
static int capture_pressed_key(const zmk_event_t *ev) {
for (int i = 0; i < CONFIG_ZMK_COMBO_MAX_COMBOS_PER_KEY; i++) {
for (int i = 0; i < CONFIG_ZMK_COMBO_MAX_KEYS_PER_COMBO; i++) {
if (pressed_keys[i] != NULL) {
continue;
}
@ -236,24 +236,26 @@ static int capture_pressed_key(const zmk_event_t *ev) {
const struct zmk_listener zmk_listener_combo;
static void release_pressed_keys() {
// release the first key that was pressed
if (pressed_keys[0] == NULL) {
return;
}
ZMK_EVENT_RELEASE(pressed_keys[0])
pressed_keys[0] = NULL;
// reprocess events (see tests/combo/fully-overlapping-combos-3 for why this is needed)
for (int i = 1; i < CONFIG_ZMK_COMBO_MAX_COMBOS_PER_KEY; i++) {
if (pressed_keys[i] == NULL) {
return;
}
static int release_pressed_keys() {
for (int i = 0; i < CONFIG_ZMK_COMBO_MAX_KEYS_PER_COMBO; i++) {
const zmk_event_t *captured_event = pressed_keys[i];
if (pressed_keys[i] == NULL) {
return i;
}
pressed_keys[i] = NULL;
if (i == 0) {
LOG_DBG("combo: releasing position event %d",
as_zmk_position_state_changed(captured_event)->position);
ZMK_EVENT_RELEASE(captured_event)
} else {
// reprocess events (see tests/combo/fully-overlapping-combos-3 for why this is needed)
LOG_DBG("combo: reraising position event %d",
as_zmk_position_state_changed(captured_event)->position);
ZMK_EVENT_RAISE(captured_event);
}
}
return CONFIG_ZMK_COMBO_MAX_KEYS_PER_COMBO;
}
static inline int press_combo_behavior(struct combo_cfg *combo, int32_t timestamp) {
struct zmk_behavior_binding_event event = {
@ -360,14 +362,14 @@ static bool release_combo_key(int32_t position, int64_t timestamp) {
return false;
}
static void cleanup() {
static int cleanup() {
k_delayed_work_cancel(&timeout_task);
clear_candidates();
if (fully_pressed_combo != NULL) {
activate_combo(fully_pressed_combo);
fully_pressed_combo = NULL;
}
release_pressed_keys();
return release_pressed_keys();
}
static void update_timeout_task() {
@ -399,6 +401,7 @@ static int position_state_down(const zmk_event_t *ev, struct zmk_position_state_
update_timeout_task();
struct combo_cfg *candidate_combo = candidates[0].combo;
LOG_DBG("combo: capturing position event %d", data->position);
int ret = capture_pressed_key(ev);
switch (num_candidates) {
case 0:
@ -418,13 +421,18 @@ static int position_state_down(const zmk_event_t *ev, struct zmk_position_state_
}
}
static int position_state_up(struct zmk_position_state_changed *ev) {
cleanup();
if (release_combo_key(ev->position, ev->timestamp)) {
static int position_state_up(const zmk_event_t *ev, struct zmk_position_state_changed *data) {
int released_keys = cleanup();
if (release_combo_key(data->position, data->timestamp)) {
return ZMK_EV_EVENT_HANDLED;
} else {
return 0;
}
if (released_keys > 1) {
// The second and further key down events are re-raised. To preserve
// correct order for e.g. hold-taps, reraise the key up event too.
ZMK_EVENT_RAISE(ev);
return ZMK_EV_EVENT_CAPTURED;
}
return 0;
}
static void combo_timeout_handler(struct k_work *item) {
@ -447,7 +455,7 @@ static int position_state_changed_listener(const zmk_event_t *ev) {
if (data->state) { // keydown
return position_state_down(ev, data);
} else { // keyup
return position_state_up(data);
return position_state_up(ev, data);
}
}

1
app/tests/combo/combos-and-holdtaps-0/events.patterns
View file

@ -1,2 +1 @@
s/.*hid_listener_keycode_//p
s/.*combo//p

1
app/tests/combo/combos-and-holdtaps-1/events.patterns
View file

@ -1,2 +1 @@
s/.*hid_listener_keycode_//p
s/.*combo//p

1
app/tests/combo/combos-and-holdtaps-2/events.patterns
View file

@ -1,2 +1 @@
s/.*hid_listener_keycode_//p
s/.*combo//p

1
app/tests/combo/layer-filter-0/events.patterns
View file

@ -1,2 +1 @@
s/.*hid_listener_keycode_//p
s/.*combo//p

1
app/tests/combo/layer-filter-1/events.patterns
View file

@ -1,2 +1 @@
s/.*hid_listener_keycode_//p
s/.*combo//p

1
app/tests/combo/overlapping-combos-0/events.patterns
View file

@ -1,2 +1 @@
s/.*hid_listener_keycode_//p
s/.*combo//p

1
app/tests/combo/overlapping-combos-1/events.patterns
View file

@ -1,2 +1 @@
s/.*hid_listener_keycode_//p
s/.*combo//p

1
app/tests/combo/overlapping-combos-2/events.patterns
View file

@ -1,2 +1 @@
s/.*hid_listener_keycode_//p
s/.*combo//p

1
app/tests/combo/overlapping-combos-3/events.patterns
View file

@ -1,2 +1 @@
s/.*hid_listener_keycode_//p
s/.*combo//p

1
app/tests/combo/press-release-long-combo/events.patterns Normal file
View file

@ -0,0 +1 @@
s/.*hid_listener_keycode_//p

4
app/tests/combo/press-release-long-combo/keycode_events.snapshot Normal file
View file

@ -0,0 +1,4 @@
pressed: usage_page 0x07 keycode 0x07 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
released: usage_page 0x07 keycode 0x07 implicit_mods 0x00 explicit_mods 0x00

35
app/tests/combo/press-release-long-combo/native_posix.keymap Normal file
View file

@ -0,0 +1,35 @@
#include <dt-bindings/zmk/keys.h>
#include <behaviors.dtsi>
#include <dt-bindings/zmk/kscan-mock.h>
/ {
combos {
compatible = "zmk,combos";
combo_one {
timeout-ms = <80>;
key-positions = <0 1 2 3>;
bindings = <&kp Z>;
};
};
keymap {
compatible = "zmk,keymap";
label ="Default keymap";
default_layer {
bindings = <
&kp A &kp B
&kp C &kp D
>;
};
};
};
&kscan {
events = <
ZMK_MOCK_PRESS(1,1,10)
ZMK_MOCK_PRESS(0,1,10)
ZMK_MOCK_RELEASE(0,1,100)
ZMK_MOCK_RELEASE(1,1,100)
>;
};

1
app/tests/combo/press1-press2-release1-release2/events.patterns
View file

@ -1,2 +1 @@
s/.*hid_listener_keycode_//p
s/.*combo/combo/p

1
app/tests/combo/press1-press2-release2-release1/events.patterns
View file

@ -1,2 +1 @@
s/.*hid_listener_keycode_//p
s/.*combo/combo/p

1
app/tests/combo/press1-release1-press2-release2/events.patterns
View file

@ -1,2 +1 @@
s/.*hid_listener_keycode_//p
s/.*combo/combo/p