Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update store_or_get_action to cache keycode on key press, return cached keycode on key release #24517

Open
wants to merge 15 commits into
base: develop
Choose a base branch
from
+46 −1
Open

Update store_or_get_action to cache keycode on key press, return cached keycode on key release #24517

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
b7dfced
enable via, unregister key on dynamic set
Garretonzo Oct 23, 2024
37d8824
unregister at end of function
Garretonzo Oct 23, 2024
e890fa0
removing custom rules from repo
Garretonzo Oct 23, 2024
9f3e5fa
Update quantum/dynamic_keymap.c
Garretonzo Oct 24, 2024
d3b8178
moving logic to via.c, reverting dynamic_keymap.c changes
Garretonzo Oct 25, 2024
751ad39
working example
Garretonzo Nov 2, 2024
4edc916
Merge branch 'get-event-keycode-cache' into unregister-prev-keycode-o…
Garretonzo Nov 2, 2024
168cabe
revert via.c
Garretonzo Nov 2, 2024
3727bc7
move functions
Garretonzo Nov 9, 2024
46d0724
move additions together
Garretonzo Nov 9, 2024
1dc3373
comments
Garretonzo Nov 9, 2024
f512383
opt in option, move to store_or_get_action
Garretonzo Nov 15, 2024
1378e56
keycode_map simplification, encoder code removed
Garretonzo Nov 15, 2024
9f71517
keycode_map simplification cont
Garretonzo Nov 15, 2024
610863f
keycode_map simplification cont
Garretonzo Nov 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/config_options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,8 @@ If you define these options you will enable the associated feature, which may in
* NKRO by default requires to be turned on, this forces it on during keyboard startup regardless of EEPROM setting. NKRO can still be turned off but will be turned on again if the keyboard reboots.
* `#define STRICT_LAYER_RELEASE`
* force a key release to be evaluated using the current layer stack instead of remembering which layer it came from (used for advanced cases)
* `#define KEYCODE_CACHE_ENABLE`
* Cache keycode for pressed keys, to be used on key release, across entire physical keyboard layout.

## Behaviors That Can Be Configured

Expand Down
40 changes: 39 additions & 1 deletion quantum/action_layer.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,31 @@ uint8_t read_source_layers_cache(keypos_t key) {
# endif // ENCODER_MAP_ENABLE
return 0;
}

# ifdef KEYCODE_CACHE_ENABLE
static uint16_t keycode_map[MATRIX_ROWS][MATRIX_COLS] = {{KC_NO}};
Copy link
Member

@tzarc tzarc Nov 27, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps keeping an array of, say, 10 of:

typedef struct historical_keycode_t {
    uint8_t row;
    uint8_t col;
    uint16_t keycode;
} historical_keycode_t;

...should significantly decrease the RAM requirements at the cost of a slightly more complicated algorithm.


/** \brief update keycode map
*
* Updates map of keycodes when a key is pressed down
*/
void update_keycode_map(keypos_t key, uint16_t keycode) {
if (key.row < MATRIX_ROWS && key.col < MATRIX_COLS) {
keycode_map[key.row][key.col] = keycode;
}
}

/** \brief read keycode map
*
* reads from map of keycodes when a key is released
*/
uint16_t read_keycode_map(keypos_t key) {
if (key.row < MATRIX_ROWS && key.col < MATRIX_COLS) {
return keycode_map[key.row][key.col];
}
return KC_NO;
}
# endif
#endif

/** \brief Store or get action (FIXME: Needs better summary)
Expand All @@ -303,14 +328,27 @@ action_t store_or_get_action(bool pressed, keypos_t key) {
}

uint8_t layer;

# ifdef KEYCODE_CACHE_ENABLE
uint16_t keycode;
# endif
if (pressed) {
layer = layer_switch_get_layer(key);
update_source_layers_cache(key, layer);
# ifdef KEYCODE_CACHE_ENABLE
keycode = keymap_key_to_keycode(layer, key);
update_keycode_map(key, keycode);
# endif
} else {
layer = read_source_layers_cache(key);
# ifdef KEYCODE_CACHE_ENABLE
keycode = read_keycode_map(key);
# endif
}
# ifndef KEYCODE_CACHE_ENABLE
return action_for_key(layer, key);
# else
return action_for_keycode(keycode);
# endif
#else
return layer_switch_get_action(key);
#endif
Expand Down
5 changes: 5 additions & 0 deletions quantum/action_layer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,11 @@ layer_state_t update_tri_layer_state(layer_state_t state, uint8_t layer1, uint8_

void update_source_layers_cache(keypos_t key, uint8_t layer);
uint8_t read_source_layers_cache(keypos_t key);
# ifdef KEYCODE_CACHE_ENABLE
void update_keycode_map(keypos_t key, uint16_t keycode);
uint16_t read_keycode_map(keypos_t key);
uint16_t keymap_key_to_keycode(uint8_t layer, keypos_t key);
# endif
#endif
action_t store_or_get_action(bool pressed, keypos_t key);

Expand Down