From c23d752917774bc740c791e2f7eeef6f8f9e1033 Mon Sep 17 00:00:00 2001 From: Pete Johanson Date: Fri, 19 Jun 2020 15:32:33 -0400 Subject: Some initial work on behavior bindings for keymaps --- app/include/drivers/behavior.h | 88 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+) create mode 100644 app/include/drivers/behavior.h (limited to 'app/include/drivers') diff --git a/app/include/drivers/behavior.h b/app/include/drivers/behavior.h new file mode 100644 index 0000000..84b11ce --- /dev/null +++ b/app/include/drivers/behavior.h @@ -0,0 +1,88 @@ +/* + * Copyright (c) 2020 Peter Johanson + * + * SPDX-License-Identifier: MIT + */ + +#pragma once + +#include +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @cond INTERNAL_HIDDEN + * + * Behavior driver API definition and system call entry points. + * + * (Internal use only.) + */ + +typedef int (*behavior_position_pressed_t)(struct device *dev, u32_t param1, u32_t param2); +typedef int (*behavior_position_released_t)(struct device *dev, u32_t param1, u32_t param2); + +__subsystem struct behavior_driver_api { + behavior_position_pressed_t position_pressed; + behavior_position_released_t position_released; +}; +/** + * @endcond + */ + +/** + * @brief Handle the assigned position being pressed + * @param dev Pointer to the device structure for the driver instance. + * @param param1 User parameter specified at time of behavior assignment. + * + * @retval 0 If successful. + * @retval Negative errno code if failure. + */ +__syscall int behavior_position_pressed(struct device *dev, u32_t param1, u32_t param2); + +static inline int z_impl_behavior_position_pressed(struct device *dev, u32_t param1, u32_t param2) +{ + const struct behavior_driver_api *api = + (const struct behavior_driver_api *)dev->driver_api; + + if (api->position_pressed == NULL) { + return -ENOTSUP; + } + + return api->position_pressed(dev, param1, param2); +} + +/** + * @brief Handle the assigned position being pressed + * @param dev Pointer to the device structure for the driver instance. + * @param param1 User parameter specified at time of behavior assignment. + * + * @retval 0 If successful. + * @retval Negative errno code if failure. + */ +__syscall int behavior_position_released(struct device *dev, u32_t param1, u32_t param2); + +static inline int z_impl_behavior_position_released(struct device *dev, u32_t param1, u32_t param2) +{ + const struct behavior_driver_api *api = + (const struct behavior_driver_api *)dev->driver_api; + + if (api->position_released == NULL) { + return -ENOTSUP; + } + + return api->position_released(dev, param1, param2); +} + +#ifdef __cplusplus +} +#endif + +/** + * @} + */ + +#include -- cgit v1.3.1 From d65629b9a0b79b6e294419fe9a4118fb09491c91 Mon Sep 17 00:00:00 2001 From: Pete Johanson Date: Sat, 20 Jun 2020 00:11:39 -0400 Subject: Lots more pieces toward HID working again. --- app/CMakeLists.txt | 3 + app/boards/arm/nice_nano/nice_nano.dts | 1 + app/boards/native_posix.overlay | 22 +++++++ .../petejohanson_handwire/keymap/keymap.overlay | 7 +++ app/dts/behaviors/hid.dtsi | 9 +++ app/dts/behaviors/keymap.dtsi | 9 +++ app/dts/bindings/behaviors/zmk,behavior-hid.yaml | 8 +++ .../bindings/behaviors/zmk,behavior-keymap.yaml | 8 +++ app/dts/bindings/zmk,global-bindings.yaml | 9 +++ app/include/drivers/behavior.h | 55 +++++++++++++++-- app/include/zmk/behavior.h | 8 +++ app/include/zmk/events.h | 13 ++++ app/src/behaviors/behavior_hid.c | 59 ++++++++++++++++++ app/src/behaviors/behavior_key_press.c | 13 ++-- app/src/behaviors/behavior_keymap.c | 50 +++++++++++++++ app/src/endpoints.c | 1 + app/src/events.c | 72 ++++++++++++++++++++++ app/src/kscan.c | 11 +++- app/src/kscan_mock.c | 1 + 19 files changed, 346 insertions(+), 13 deletions(-) create mode 100644 app/dts/behaviors/hid.dtsi create mode 100644 app/dts/behaviors/keymap.dtsi create mode 100644 app/dts/bindings/behaviors/zmk,behavior-hid.yaml create mode 100644 app/dts/bindings/behaviors/zmk,behavior-keymap.yaml create mode 100644 app/dts/bindings/zmk,global-bindings.yaml create mode 100644 app/include/zmk/behavior.h create mode 100644 app/include/zmk/events.h create mode 100644 app/src/behaviors/behavior_hid.c create mode 100644 app/src/behaviors/behavior_keymap.c create mode 100644 app/src/events.c (limited to 'app/include/drivers') diff --git a/app/CMakeLists.txt b/app/CMakeLists.txt index 89f4055..6f4217a 100644 --- a/app/CMakeLists.txt +++ b/app/CMakeLists.txt @@ -28,8 +28,11 @@ endif() # find_package(Zephyr) which defines the target. target_include_directories(app PRIVATE include) target_sources(app PRIVATE src/kscan.c) +target_sources(app PRIVATE src/events.c) target_sources(app PRIVATE src/keymap.c) target_sources(app PRIVATE src/hid.c) +target_sources(app PRIVATE src/behaviors/behavior_keymap.c) +target_sources(app PRIVATE src/behaviors/behavior_hid.c) target_sources(app PRIVATE src/behaviors/behavior_key_press.c) target_sources(app PRIVATE src/behaviors/behavior_reset.c) target_sources_ifdef(CONFIG_ZMK_BLE app PRIVATE src/ble.c) diff --git a/app/boards/arm/nice_nano/nice_nano.dts b/app/boards/arm/nice_nano/nice_nano.dts index 4604e9a..9d3b484 100644 --- a/app/boards/arm/nice_nano/nice_nano.dts +++ b/app/boards/arm/nice_nano/nice_nano.dts @@ -8,6 +8,7 @@ #include #include #include +#include #include "arduino_pro_micro_pins.dtsi" / { diff --git a/app/boards/native_posix.overlay b/app/boards/native_posix.overlay index 9d92bee..3f2eead 100644 --- a/app/boards/native_posix.overlay +++ b/app/boards/native_posix.overlay @@ -1,10 +1,20 @@ #include +#include +#include +#include +#include #include / { chosen { zmk,kscan = &kscan0; zmk,keymap = &keymap0; + zmk,global_bindings = &bindings; + }; + + bindings: global_bindings { + compatible = "zmk,global-bindings"; + bindings = <&keymap_behavior &hid_behavior>; }; kscan0: kscan_0 { @@ -58,6 +68,10 @@ KC_A MT(MOD_LSFT, KC_B) KC_C KC_D KC_E KC_F KC_G KC_H >; + + bindings = < + &kp 5 &kp 0 &kp 10 &kp 11 + &kp 1 &kp 2 &kp 4 &kp 89>; }; lower: layer_1 { @@ -66,6 +80,10 @@ KC_A KC_B KC_C KC_D KC_E KC_F KC_G KC_H >; + + bindings = < + &kp 5 &kp 0 &kp 10 &kp 11 + &kp 1 &kp 2 &kp 4 &kp 89>; }; raise: layer_2 { @@ -74,6 +92,10 @@ KC_E KC_F KC_G KC_H KC_A KC_B KC_C KC_D >; + + bindings = < + &kp 5 &kp 0 &kp 10 &kp 11 + &kp 1 &kp 2 &kp 4 &kp 89>; }; }; }; diff --git a/app/boards/shields/petejohanson_handwire/keymap/keymap.overlay b/app/boards/shields/petejohanson_handwire/keymap/keymap.overlay index 8cb7654..5ae78cf 100644 --- a/app/boards/shields/petejohanson_handwire/keymap/keymap.overlay +++ b/app/boards/shields/petejohanson_handwire/keymap/keymap.overlay @@ -1,11 +1,18 @@ #include #include #include +#include #include / { chosen { zmk,keymap = &keymap0; + zmk,global_bindings = &bindings; + }; + + bindings: global_bindings { + compatible = "zmk,global-bindings"; + bindings = <&reset>; }; keymap0: keymap { compatible = "zmk,keymap"; diff --git a/app/dts/behaviors/hid.dtsi b/app/dts/behaviors/hid.dtsi new file mode 100644 index 0000000..d859c37 --- /dev/null +++ b/app/dts/behaviors/hid.dtsi @@ -0,0 +1,9 @@ +/ { + behaviors { + hid_behavior: behavior_hid { + compatible = "zmk,behavior-hid"; + label = "HID"; + #binding-cells = <0>; + }; + }; +}; diff --git a/app/dts/behaviors/keymap.dtsi b/app/dts/behaviors/keymap.dtsi new file mode 100644 index 0000000..87b2f41 --- /dev/null +++ b/app/dts/behaviors/keymap.dtsi @@ -0,0 +1,9 @@ +/ { + behaviors { + keymap_behavior: behavior_keymap { + compatible = "zmk,behavior-keymap"; + label = "KEYMAP"; + #binding-cells = <0>; + }; + }; +}; diff --git a/app/dts/bindings/behaviors/zmk,behavior-hid.yaml b/app/dts/bindings/behaviors/zmk,behavior-hid.yaml new file mode 100644 index 0000000..f3e0603 --- /dev/null +++ b/app/dts/bindings/behaviors/zmk,behavior-hid.yaml @@ -0,0 +1,8 @@ +# Copyright (c) 2020, Pete Johanson +# SPDX-License-Identifier: MIT + +description: HID Report Behavior + +compatible: "zmk,behavior-hid" + +include: zero_param.yaml diff --git a/app/dts/bindings/behaviors/zmk,behavior-keymap.yaml b/app/dts/bindings/behaviors/zmk,behavior-keymap.yaml new file mode 100644 index 0000000..1d8a51f --- /dev/null +++ b/app/dts/bindings/behaviors/zmk,behavior-keymap.yaml @@ -0,0 +1,8 @@ +# Copyright (c) 2020, Pete Johanson +# SPDX-License-Identifier: MIT + +description: Keymap Behavior + +compatible: "zmk,behavior-keymap" + +include: zero_param.yaml diff --git a/app/dts/bindings/zmk,global-bindings.yaml b/app/dts/bindings/zmk,global-bindings.yaml new file mode 100644 index 0000000..69e79cd --- /dev/null +++ b/app/dts/bindings/zmk,global-bindings.yaml @@ -0,0 +1,9 @@ +description: | + Specify the the global behaviors bound to state changes + +compatible: "zmk,global-bindings" + +properties: + bindings: + type: phandles + required: true diff --git a/app/include/drivers/behavior.h b/app/include/drivers/behavior.h index 84b11ce..f5f5f53 100644 --- a/app/include/drivers/behavior.h +++ b/app/include/drivers/behavior.h @@ -22,12 +22,14 @@ extern "C" { * (Internal use only.) */ -typedef int (*behavior_position_pressed_t)(struct device *dev, u32_t param1, u32_t param2); -typedef int (*behavior_position_released_t)(struct device *dev, u32_t param1, u32_t param2); +typedef int (*behavior_position_callback_t)(struct device *dev, u32_t param1, u32_t param2); +typedef int (*behavior_keycode_callback_t)(struct device *dev, u32_t keycode); __subsystem struct behavior_driver_api { - behavior_position_pressed_t position_pressed; - behavior_position_released_t position_released; + behavior_position_callback_t position_pressed; + behavior_position_callback_t position_released; + behavior_keycode_callback_t keycode_pressed; + behavior_keycode_callback_t keycode_released; }; /** * @endcond @@ -77,6 +79,51 @@ static inline int z_impl_behavior_position_released(struct device *dev, u32_t pa return api->position_released(dev, param1, param2); } +/** + * @brief Handle the keycode being pressed + * @param dev Pointer to the device structure for the driver instance. + * @param keycode The keycode that is being pressed. + * + * @retval 0 If successful. + * @retval Negative errno code if failure. + */ +__syscall int behavior_keycode_pressed(struct device *dev, u32_t keycode); + +static inline int z_impl_behavior_keycode_pressed(struct device *dev, u32_t keycode) +{ + const struct behavior_driver_api *api = + (const struct behavior_driver_api *)dev->driver_api; + + if (api->keycode_pressed == NULL) { + return -ENOTSUP; + } + + return api->keycode_pressed(dev, keycode); +} + + +/** + * @brief Handle the keycode being released + * @param dev Pointer to the device structure for the driver instance. + * @param keycode The keycode that is being pressed. + * + * @retval 0 If successful. + * @retval Negative errno code if failure. + */ +__syscall int behavior_keycode_released(struct device *dev, u32_t keycode); + +static inline int z_impl_behavior_keycode_released(struct device *dev, u32_t keycode) +{ + const struct behavior_driver_api *api = + (const struct behavior_driver_api *)dev->driver_api; + + if (api->keycode_released == NULL) { + return -ENOTSUP; + } + + return api->keycode_released(dev, keycode); +} + #ifdef __cplusplus } #endif diff --git a/app/include/zmk/behavior.h b/app/include/zmk/behavior.h new file mode 100644 index 0000000..63edcc9 --- /dev/null +++ b/app/include/zmk/behavior.h @@ -0,0 +1,8 @@ + +#pragma once + +struct zmk_behavior_binding { + char *behavior_dev; + u32_t param1; + u32_t param2; +}; \ No newline at end of file diff --git a/app/include/zmk/events.h b/app/include/zmk/events.h new file mode 100644 index 0000000..9314b9d --- /dev/null +++ b/app/include/zmk/events.h @@ -0,0 +1,13 @@ +#pragma once + +int zmk_events_position_pressed(u32_t row, u32_t column); +int zmk_events_position_released(u32_t row, u32_t column); +int zmk_events_keycode_pressed(u32_t keycode); +int zmk_events_keycode_released(u32_t keycode); +int zmk_events_mod_pressed(u32_t modifier); +int zmk_events_mod_released(u32_t modifier); +int zmk_events_consumer_key_pressed(u32_t usage); +int zmk_events_consumer_key_released(u32_t usage); + +// TODO: Encoders? +// TODO: Sensors? \ No newline at end of file diff --git a/app/src/behaviors/behavior_hid.c b/app/src/behaviors/behavior_hid.c new file mode 100644 index 0000000..2779568 --- /dev/null +++ b/app/src/behaviors/behavior_hid.c @@ -0,0 +1,59 @@ +/* + * Copyright (c) 2020 Peter Johanson + * + * SPDX-License-Identifier: MIT + */ + +#define DT_DRV_COMPAT zmk_behavior_hid + +#include +#include +#include +#include + +LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL); + +#include +#include + +struct behavior_hid_config { }; +struct behavior_hid_data { }; + +static int behavior_hid_init(struct device *dev) +{ + return 0; +}; + +static int on_keycode_pressed(struct device *dev, u32_t keycode) +{ + enum zmk_hid_report_changes changes; + LOG_DBG("keycode %d", keycode); + + changes = zmk_hid_press_key(keycode); + return zmk_endpoints_send_report(changes); +} + +static int on_keycode_released(struct device *dev, u32_t keycode) +{ + enum zmk_hid_report_changes changes; + LOG_DBG("keycode %d", keycode); + + changes = zmk_hid_release_key(keycode); + return zmk_endpoints_send_report(changes); +} + +static const struct behavior_driver_api behavior_hid_driver_api = { + .keycode_pressed = on_keycode_pressed, + .keycode_released = on_keycode_released +}; + + +static const struct behavior_hid_config behavior_hid_config = {}; + +static struct behavior_hid_data behavior_hid_data; + +DEVICE_AND_API_INIT(behavior_hid, DT_INST_LABEL(0), behavior_hid_init, + &behavior_hid_data, + &behavior_hid_config, + APPLICATION, CONFIG_KERNEL_INIT_PRIORITY_DEFAULT, + &behavior_hid_driver_api); \ No newline at end of file diff --git a/app/src/behaviors/behavior_key_press.c b/app/src/behaviors/behavior_key_press.c index b9d0ff0..3c57c51 100644 --- a/app/src/behaviors/behavior_key_press.c +++ b/app/src/behaviors/behavior_key_press.c @@ -10,6 +10,8 @@ #include #include +#include + LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL); struct behavior_key_press_config { }; @@ -29,19 +31,16 @@ static int behavior_key_press_init(struct device *dev) // * < 0 - Indicate error processing, report and halt further propagation. static int on_position_pressed(struct device *dev, u32_t keycode, u32_t _) { - // Invoking this triggers a *new* event, that can be linked to other behaviours. - //return zmk_key_state_press(u32_t keycode); - return 0; + LOG_DBG("pressing: %d", keycode); + return zmk_events_keycode_pressed(keycode); } // They keycode is passed by the "keymap" based on the parameter created as part of the assignment. static int on_position_released(struct device *dev, u32_t keycode, u32_t _) { - // Invoking this triggers a *new* event, that can will be handled by other behaviors - // This is the "command" piece. Which could be better/richer, but captures essence here. - // return zmk_key_state_release(u32_t keycode); - return 0; + LOG_DBG("releasing: %d", keycode); + return zmk_events_keycode_released(keycode); } static const struct behavior_driver_api behavior_key_press_driver_api = { diff --git a/app/src/behaviors/behavior_keymap.c b/app/src/behaviors/behavior_keymap.c new file mode 100644 index 0000000..48f8547 --- /dev/null +++ b/app/src/behaviors/behavior_keymap.c @@ -0,0 +1,50 @@ +/* + * Copyright (c) 2020 Peter Johanson + * + * SPDX-License-Identifier: MIT + */ + +#define DT_DRV_COMPAT zmk_behavior_keymap + +#include +#include +#include +#include + +LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL); + +#include + +struct behavior_keymap_config { }; +struct behavior_keymap_data { }; + +static int behavior_keymap_init(struct device *dev) +{ + return 0; +}; + +static int on_position_pressed(struct device *dev, u32_t row, u32_t column) +{ + return zmk_keymap_position_state_changed(row, column, true); +} + +static int on_position_released(struct device *dev, u32_t row, u32_t column) +{ + return zmk_keymap_position_state_changed(row, column, false); +} + +static const struct behavior_driver_api behavior_keymap_driver_api = { + .position_pressed = on_position_pressed, + .position_released = on_position_released +}; + + +static const struct behavior_keymap_config behavior_keymap_config = {}; + +static struct behavior_keymap_data behavior_keymap_data; + +DEVICE_AND_API_INIT(behavior_keymap, DT_INST_LABEL(0), behavior_keymap_init, + &behavior_keymap_data, + &behavior_keymap_config, + APPLICATION, CONFIG_KERNEL_INIT_PRIORITY_DEFAULT, + &behavior_keymap_driver_api); \ No newline at end of file diff --git a/app/src/endpoints.c b/app/src/endpoints.c index f46d42d..2f31e10 100644 --- a/app/src/endpoints.c +++ b/app/src/endpoints.c @@ -40,6 +40,7 @@ int zmk_endpoints_send_report(enum zmk_hid_report_changes report_type) int err; struct zmk_hid_keypad_report *keypad_report; struct zmk_hid_consumer_report *consumer_report; + LOG_DBG(""); switch (report_type) { case Keypad: diff --git a/app/src/events.c b/app/src/events.c new file mode 100644 index 0000000..c3e8d84 --- /dev/null +++ b/app/src/events.c @@ -0,0 +1,72 @@ + +#include +#include +#include +#include +#include + +#define BINDINGS_NODE DT_CHOSEN(zmk_global_bindings) +#define BINDING_COUNT DT_PROP_LEN(BINDINGS_NODE, bindings) + +#define BINDING_GEN(idx,_) \ + { .behavior_dev = DT_LABEL(DT_PHANDLE_BY_IDX(BINDINGS_NODE, bindings, idx)), \ + .param1 = COND_CODE_0(DT_PHA_HAS_CELL_AT_IDX(BINDINGS_NODE, bindings, idx, param1), (0), (DT_PHA_BY_IDX(BINDINGS_NODE, bindings, idx, param1))), \ + .param2 = COND_CODE_0(DT_PHA_HAS_CELL_AT_IDX(BINDINGS_NODE, bindings, idx, param2), (0), (DT_PHA_BY_IDX(BINDINGS_NODE, bindings, idx, param2))), \ + }, + +static const struct zmk_behavior_binding bindings[] = + { UTIL_LISTIFY(BINDING_COUNT, BINDING_GEN, 0) }; + +int zmk_events_position_pressed(u32_t row, u32_t column) +{ + for (int i = 0; i < BINDING_COUNT; i++) { + const struct zmk_behavior_binding *b = &bindings[i]; + struct device *dev = device_get_binding(b->behavior_dev); + behavior_position_pressed(dev, row, column); + } + return 0; +}; + +int zmk_events_position_released(u32_t row, u32_t column) +{ + for (int i = 0; i < BINDING_COUNT; i++) { + const struct zmk_behavior_binding *b = &bindings[i]; + struct device *dev = device_get_binding(b->behavior_dev); + behavior_position_released(dev, row, column); + } + return 0; +} +int zmk_events_keycode_pressed(u32_t keycode) +{ + for (int i = 0; i < BINDING_COUNT; i++) { + const struct zmk_behavior_binding *b = &bindings[i]; + struct device *dev = device_get_binding(b->behavior_dev); + behavior_keycode_pressed(dev, keycode); + } + return 0; +} +int zmk_events_keycode_released(u32_t keycode) +{ + for (int i = 0; i < BINDING_COUNT; i++) { + const struct zmk_behavior_binding *b = &bindings[i]; + struct device *dev = device_get_binding(b->behavior_dev); + behavior_keycode_released(dev, keycode); + } + return 0; +}; +int zmk_events_mod_pressed(u32_t modifier) +{ + return 0; +}; +int zmk_events_mod_released(u32_t modifier) +{ + return 0; +}; +int zmk_events_consumer_key_pressed(u32_t usage) +{ + return 0; +}; +int zmk_events_consumer_key_released(u32_t usage) +{ + return 0; +}; \ No newline at end of file diff --git a/app/src/kscan.c b/app/src/kscan.c index d1ed621..781824d 100644 --- a/app/src/kscan.c +++ b/app/src/kscan.c @@ -11,7 +11,7 @@ LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL); -#include +#include #include #define ZMK_KSCAN_EVENT_STATE_PRESSED 0 @@ -49,7 +49,14 @@ void zmk_kscan_process_msgq(struct k_work *item) while (k_msgq_get(&zmk_kscan_msgq, &ev, K_NO_WAIT) == 0) { bool pressed = (ev.state == ZMK_KSCAN_EVENT_STATE_PRESSED); - zmk_keymap_position_state_changed(ev.row, ev.column, pressed); + if (pressed) { + LOG_DBG("PRESSING"); + zmk_events_position_pressed(ev.row, ev.column); + } else { + LOG_DBG("RELEASSING"); + zmk_events_position_released(ev.row, ev.column); + } + // zmk_keymap_position_state_changed(ev.row, ev.column, pressed); // zmk_key key = zmk_keymap_keycode_from_position(ev.row, ev.column); // struct zmk_key_event kev = (struct zmk_key_event){.row = ev.row, .column = ev.column, .key = key, .pressed = pressed}; diff --git a/app/src/kscan_mock.c b/app/src/kscan_mock.c index 7d2d24d..b0ba90b 100644 --- a/app/src/kscan_mock.c +++ b/app/src/kscan_mock.c @@ -9,6 +9,7 @@ #include #include #include + LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL); #include -- cgit v1.3.1 From 223edf05ad08938b066f9187668ebfae43c5e91a Mon Sep 17 00:00:00 2001 From: Pete Johanson Date: Sun, 21 Jun 2020 21:43:44 -0400 Subject: Refactor global bindings, implement mod-tap. * Use extra comptible = "zmk,behavior-global" to add behaviors to global bindings for event notification. * Implement mod-tap, as a keymap binding and global one to skip tap if other keycode pressed while held. --- app/CMakeLists.txt | 1 + app/boards/native_posix.overlay | 9 +- app/boards/shields/kyria/kyria.overlay | 6 -- .../petejohanson_handwire/keymap/keymap.overlay | 5 - app/dts/behaviors/hid.dtsi | 2 +- app/dts/behaviors/keymap.dtsi | 2 +- app/dts/behaviors/mod_tap.dtsi | 9 ++ .../bindings/behaviors/zmk,behavior-mod-tap.yaml | 8 ++ app/dts/bindings/zmk,global-bindings.yaml | 9 -- app/include/drivers/behavior.h | 119 +++++++++++++++++++-- app/include/zmk/events.h | 6 +- app/include/zmk/keymap.h | 8 -- app/include/zmk/matrix.h | 2 + app/src/behaviors/behavior_hid.c | 20 +++- app/src/behaviors/behavior_key_press.c | 12 +-- app/src/behaviors/behavior_keymap.c | 8 +- app/src/behaviors/behavior_mod_tap.c | 89 +++++++++++++++ app/src/behaviors/behavior_reset.c | 10 +- app/src/events.c | 69 +++++++----- app/src/keymap.c | 13 ++- 20 files changed, 307 insertions(+), 100 deletions(-) create mode 100644 app/dts/behaviors/mod_tap.dtsi create mode 100644 app/dts/bindings/behaviors/zmk,behavior-mod-tap.yaml delete mode 100644 app/dts/bindings/zmk,global-bindings.yaml create mode 100644 app/src/behaviors/behavior_mod_tap.c (limited to 'app/include/drivers') diff --git a/app/CMakeLists.txt b/app/CMakeLists.txt index ff534fe..e91bd58 100644 --- a/app/CMakeLists.txt +++ b/app/CMakeLists.txt @@ -36,6 +36,7 @@ target_sources(app PRIVATE src/behaviors/behavior_keymap.c) target_sources(app PRIVATE src/behaviors/behavior_hid.c) target_sources(app PRIVATE src/behaviors/behavior_key_press.c) target_sources(app PRIVATE src/behaviors/behavior_reset.c) +target_sources(app PRIVATE src/behaviors/behavior_mod_tap.c) target_sources_ifdef(CONFIG_ZMK_BLE app PRIVATE src/ble.c) target_sources_ifdef(CONFIG_ZMK_KSCAN_MOCK_DRIVER app PRIVATE src/kscan_mock.c) target_sources_ifdef(CONFIG_ZMK_KSCAN_COMPOSITE_DRIVER app PRIVATE src/kscan_composite.c) diff --git a/app/boards/native_posix.overlay b/app/boards/native_posix.overlay index 3f2eead..8004705 100644 --- a/app/boards/native_posix.overlay +++ b/app/boards/native_posix.overlay @@ -1,5 +1,6 @@ #include #include +#include #include #include #include @@ -9,12 +10,6 @@ chosen { zmk,kscan = &kscan0; zmk,keymap = &keymap0; - zmk,global_bindings = &bindings; - }; - - bindings: global_bindings { - compatible = "zmk,global-bindings"; - bindings = <&keymap_behavior &hid_behavior>; }; kscan0: kscan_0 { @@ -70,7 +65,7 @@ >; bindings = < - &kp 5 &kp 0 &kp 10 &kp 11 + &kp 5 &mt MOD_LSFT KC_B &kp 10 &kp 11 &kp 1 &kp 2 &kp 4 &kp 89>; }; diff --git a/app/boards/shields/kyria/kyria.overlay b/app/boards/shields/kyria/kyria.overlay index 4140fcf..d560ed6 100644 --- a/app/boards/shields/kyria/kyria.overlay +++ b/app/boards/shields/kyria/kyria.overlay @@ -12,12 +12,6 @@ chosen { zmk,kscan = &kscan0; zmk,matrix_transform = &default_transform; - zmk,global_bindings = &bindings; - }; - - bindings: global_bindings { - compatible = "zmk,global-bindings"; - bindings = <&keymap_behavior &hid_behavior>; }; kscan0: kscan_comp { diff --git a/app/boards/shields/petejohanson_handwire/keymap/keymap.overlay b/app/boards/shields/petejohanson_handwire/keymap/keymap.overlay index 5ae78cf..1a70ff4 100644 --- a/app/boards/shields/petejohanson_handwire/keymap/keymap.overlay +++ b/app/boards/shields/petejohanson_handwire/keymap/keymap.overlay @@ -7,13 +7,8 @@ / { chosen { zmk,keymap = &keymap0; - zmk,global_bindings = &bindings; }; - bindings: global_bindings { - compatible = "zmk,global-bindings"; - bindings = <&reset>; - }; keymap0: keymap { compatible = "zmk,keymap"; label ="Default keymap"; diff --git a/app/dts/behaviors/hid.dtsi b/app/dts/behaviors/hid.dtsi index d859c37..30ebb09 100644 --- a/app/dts/behaviors/hid.dtsi +++ b/app/dts/behaviors/hid.dtsi @@ -1,7 +1,7 @@ / { behaviors { hid_behavior: behavior_hid { - compatible = "zmk,behavior-hid"; + compatible = "zmk,behavior-hid", "zmk,behavior-global"; label = "HID"; #binding-cells = <0>; }; diff --git a/app/dts/behaviors/keymap.dtsi b/app/dts/behaviors/keymap.dtsi index 87b2f41..ec434d5 100644 --- a/app/dts/behaviors/keymap.dtsi +++ b/app/dts/behaviors/keymap.dtsi @@ -1,7 +1,7 @@ / { behaviors { keymap_behavior: behavior_keymap { - compatible = "zmk,behavior-keymap"; + compatible = "zmk,behavior-keymap", "zmk,behavior-global"; label = "KEYMAP"; #binding-cells = <0>; }; diff --git a/app/dts/behaviors/mod_tap.dtsi b/app/dts/behaviors/mod_tap.dtsi new file mode 100644 index 0000000..1be7db6 --- /dev/null +++ b/app/dts/behaviors/mod_tap.dtsi @@ -0,0 +1,9 @@ +/ { + behaviors { + mt: behavior_mod_tap { + compatible = "zmk,behavior-mod-tap", "zmk,behavior-global"; + label = "MOD_TAP"; + #binding-cells = <2>; + }; + }; +}; diff --git a/app/dts/bindings/behaviors/zmk,behavior-mod-tap.yaml b/app/dts/bindings/behaviors/zmk,behavior-mod-tap.yaml new file mode 100644 index 0000000..7911082 --- /dev/null +++ b/app/dts/bindings/behaviors/zmk,behavior-mod-tap.yaml @@ -0,0 +1,8 @@ +# Copyright (c) 2020, Pete Johanson +# SPDX-License-Identifier: MIT + +description: Mod-Tap Beavhior + +compatible: "zmk,behavior-mod-tap" + +include: two_param.yaml diff --git a/app/dts/bindings/zmk,global-bindings.yaml b/app/dts/bindings/zmk,global-bindings.yaml deleted file mode 100644 index 69e79cd..0000000 --- a/app/dts/bindings/zmk,global-bindings.yaml +++ /dev/null @@ -1,9 +0,0 @@ -description: | - Specify the the global behaviors bound to state changes - -compatible: "zmk,global-bindings" - -properties: - bindings: - type: phandles - required: true diff --git a/app/include/drivers/behavior.h b/app/include/drivers/behavior.h index f5f5f53..b3c6ad2 100644 --- a/app/include/drivers/behavior.h +++ b/app/include/drivers/behavior.h @@ -9,6 +9,7 @@ #include #include #include +#include #ifdef __cplusplus extern "C" { @@ -22,30 +23,36 @@ extern "C" { * (Internal use only.) */ -typedef int (*behavior_position_callback_t)(struct device *dev, u32_t param1, u32_t param2); +typedef int (*behavior_position_callback_t)(struct device *dev, u32_t position); +typedef int (*behavior_keymap_binding_callback_t)(struct device *dev, u32_t position, u32_t param1, u32_t param2); typedef int (*behavior_keycode_callback_t)(struct device *dev, u32_t keycode); +typedef int (*behavior_modifiers_callback_t)(struct device *dev, zmk_mod_flags modifiers); __subsystem struct behavior_driver_api { behavior_position_callback_t position_pressed; behavior_position_callback_t position_released; + behavior_keymap_binding_callback_t binding_pressed; + behavior_keymap_binding_callback_t binding_released; behavior_keycode_callback_t keycode_pressed; behavior_keycode_callback_t keycode_released; + behavior_modifiers_callback_t modifiers_pressed; + behavior_modifiers_callback_t modifiers_released; }; /** * @endcond */ /** - * @brief Handle the assigned position being pressed + * @brief Handle the key position being pressed * @param dev Pointer to the device structure for the driver instance. - * @param param1 User parameter specified at time of behavior assignment. + * @param position They key position that was pressed * * @retval 0 If successful. * @retval Negative errno code if failure. */ -__syscall int behavior_position_pressed(struct device *dev, u32_t param1, u32_t param2); +__syscall int behavior_position_pressed(struct device *dev, u32_t position); -static inline int z_impl_behavior_position_pressed(struct device *dev, u32_t param1, u32_t param2) +static inline int z_impl_behavior_position_pressed(struct device *dev, u32_t position) { const struct behavior_driver_api *api = (const struct behavior_driver_api *)dev->driver_api; @@ -54,7 +61,52 @@ static inline int z_impl_behavior_position_pressed(struct device *dev, u32_t par return -ENOTSUP; } - return api->position_pressed(dev, param1, param2); + return api->position_pressed(dev, position); +} + +/** + * @brief Handle the key position being released + * @param dev Pointer to the device structure for the driver instance. + * @param position They key position that was released + * + * @retval 0 If successful. + * @retval Negative errno code if failure. + */ +__syscall int behavior_position_released(struct device *dev, u32_t position); + +static inline int z_impl_behavior_position_released(struct device *dev, u32_t position) +{ + const struct behavior_driver_api *api = + (const struct behavior_driver_api *)dev->driver_api; + + if (api->position_released == NULL) { + return -ENOTSUP; + } + + return api->position_released(dev, position); +} + +/** + * @brief Handle the keymap binding being pressed + * @param dev Pointer to the device structure for the driver instance. + * @param param1 User parameter specified at time of behavior binding. + * @param param2 User parameter specified at time of behavior binding. + * + * @retval 0 If successful. + * @retval Negative errno code if failure. + */ +__syscall int behavior_keymap_binding_pressed(struct device *dev, u32_t position, u32_t param1, u32_t param2); + +static inline int z_impl_behavior_keymap_binding_pressed(struct device *dev, u32_t position, u32_t param1, u32_t param2) +{ + const struct behavior_driver_api *api = + (const struct behavior_driver_api *)dev->driver_api; + + if (api->binding_pressed == NULL) { + return -ENOTSUP; + } + + return api->binding_pressed(dev, position, param1, param2); } /** @@ -65,20 +117,21 @@ static inline int z_impl_behavior_position_pressed(struct device *dev, u32_t par * @retval 0 If successful. * @retval Negative errno code if failure. */ -__syscall int behavior_position_released(struct device *dev, u32_t param1, u32_t param2); +__syscall int behavior_keymap_binding_released(struct device *dev, u32_t position, u32_t param1, u32_t param2); -static inline int z_impl_behavior_position_released(struct device *dev, u32_t param1, u32_t param2) +static inline int z_impl_behavior_keymap_binding_released(struct device *dev, u32_t position, u32_t param1, u32_t param2) { const struct behavior_driver_api *api = (const struct behavior_driver_api *)dev->driver_api; - if (api->position_released == NULL) { + if (api->binding_released == NULL) { return -ENOTSUP; } - return api->position_released(dev, param1, param2); + return api->binding_released(dev, position, param1, param2); } + /** * @brief Handle the keycode being pressed * @param dev Pointer to the device structure for the driver instance. @@ -124,6 +177,52 @@ static inline int z_impl_behavior_keycode_released(struct device *dev, u32_t key return api->keycode_released(dev, keycode); } + +/** + * @brief Handle the keycode being pressed + * @param dev Pointer to the device structure for the driver instance. + * @param keycode The keycode that is being pressed. + * + * @retval 0 If successful. + * @retval Negative errno code if failure. + */ +__syscall int behavior_modifiers_pressed(struct device *dev, zmk_mod_flags modifiers); + +static inline int z_impl_behavior_modifiers_pressed(struct device *dev, zmk_mod_flags modifiers) +{ + const struct behavior_driver_api *api = + (const struct behavior_driver_api *)dev->driver_api; + + if (api->modifiers_pressed == NULL) { + return -ENOTSUP; + } + + return api->modifiers_pressed(dev, modifiers); +} + + +/** + * @brief Handle the keycode being released + * @param dev Pointer to the device structure for the driver instance. + * @param keycode The keycode that is being pressed. + * + * @retval 0 If successful. + * @retval Negative errno code if failure. + */ +__syscall int behavior_modifiers_released(struct device *dev, zmk_mod_flags modifiers); + +static inline int z_impl_behavior_modifiers_released(struct device *dev, zmk_mod_flags modifiers) +{ + const struct behavior_driver_api *api = + (const struct behavior_driver_api *)dev->driver_api; + + if (api->modifiers_released == NULL) { + return -ENOTSUP; + } + + return api->modifiers_released(dev, modifiers); +} + #ifdef __cplusplus } #endif diff --git a/app/include/zmk/events.h b/app/include/zmk/events.h index ac4815a..8d1ae6a 100644 --- a/app/include/zmk/events.h +++ b/app/include/zmk/events.h @@ -1,11 +1,13 @@ #pragma once +#include + int zmk_events_position_pressed(u32_t position); int zmk_events_position_released(u32_t position); int zmk_events_keycode_pressed(u32_t keycode); int zmk_events_keycode_released(u32_t keycode); -int zmk_events_mod_pressed(u32_t modifier); -int zmk_events_mod_released(u32_t modifier); +int zmk_events_modifiers_pressed(zmk_mod_flags modifiers); +int zmk_events_modifiers_released(zmk_mod_flags modifiers); int zmk_events_consumer_key_pressed(u32_t usage); int zmk_events_consumer_key_released(u32_t usage); diff --git a/app/include/zmk/keymap.h b/app/include/zmk/keymap.h index cf38904..38c1249 100644 --- a/app/include/zmk/keymap.h +++ b/app/include/zmk/keymap.h @@ -1,13 +1,5 @@ #pragma once -#include -#include -#include -#include - -#include -// #include - bool zmk_keymap_layer_activate(u8_t layer); bool zmk_keymap_layer_deactivate(u8_t layer); diff --git a/app/include/zmk/matrix.h b/app/include/zmk/matrix.h index 783c98e..9cabb7e 100644 --- a/app/include/zmk/matrix.h +++ b/app/include/zmk/matrix.h @@ -1,5 +1,7 @@ #pragma once +#include + #define ZMK_MATRIX_NODE_ID DT_CHOSEN(zmk_kscan) #if DT_NODE_HAS_PROP(ZMK_MATRIX_NODE_ID,row_gpios) diff --git a/app/src/behaviors/behavior_hid.c b/app/src/behaviors/behavior_hid.c index 2779568..0aeade5 100644 --- a/app/src/behaviors/behavior_hid.c +++ b/app/src/behaviors/behavior_hid.c @@ -42,9 +42,27 @@ static int on_keycode_released(struct device *dev, u32_t keycode) return zmk_endpoints_send_report(changes); } +static int on_modifiers_pressed(struct device *dev, zmk_mod_flags modifiers) +{ + LOG_DBG("modifiers %d", modifiers); + + zmk_hid_register_mods(modifiers); + return zmk_endpoints_send_report(Keypad); +} + +static int on_modifiers_released(struct device *dev, zmk_mod_flags modifiers) +{ + LOG_DBG("modifiers %d", modifiers); + + zmk_hid_unregister_mods(modifiers); + return zmk_endpoints_send_report(Keypad); +} + static const struct behavior_driver_api behavior_hid_driver_api = { .keycode_pressed = on_keycode_pressed, - .keycode_released = on_keycode_released + .keycode_released = on_keycode_released, + .modifiers_pressed = on_modifiers_pressed, + .modifiers_released = on_modifiers_released }; diff --git a/app/src/behaviors/behavior_key_press.c b/app/src/behaviors/behavior_key_press.c index 3c57c51..1b3e670 100644 --- a/app/src/behaviors/behavior_key_press.c +++ b/app/src/behaviors/behavior_key_press.c @@ -29,25 +29,25 @@ static int behavior_key_press_init(struct device *dev) // * > 0 - indicate successful processing, and halt further handling, // * 0 - Indicate successful processing, and continue propagation. // * < 0 - Indicate error processing, report and halt further propagation. -static int on_position_pressed(struct device *dev, u32_t keycode, u32_t _) +static int on_keymap_binding_pressed(struct device *dev, u32_t position, u32_t keycode, u32_t _) { - LOG_DBG("pressing: %d", keycode); + LOG_DBG("position %d keycode %d", position, keycode); return zmk_events_keycode_pressed(keycode); } // They keycode is passed by the "keymap" based on the parameter created as part of the assignment. -static int on_position_released(struct device *dev, u32_t keycode, u32_t _) +static int on_keymap_binding_released(struct device *dev, u32_t position, u32_t keycode, u32_t _) { - LOG_DBG("releasing: %d", keycode); + LOG_DBG("position %d keycode %d", position, keycode); return zmk_events_keycode_released(keycode); } static const struct behavior_driver_api behavior_key_press_driver_api = { // These callbacks are all optional, and define which kinds of events the behavior can handle. // They can reference local functions defined here, or shared event handlers. - .position_pressed = on_position_pressed, - .position_released = on_position_released + .binding_pressed = on_keymap_binding_pressed, + .binding_released = on_keymap_binding_released // Other optional callbacks a behavior can implement // .on_mouse_moved // .on_sensor_data - Any behaviour that wants to be linked to a censor can implement this behavior diff --git a/app/src/behaviors/behavior_keymap.c b/app/src/behaviors/behavior_keymap.c index 9369b40..7a06b2f 100644 --- a/app/src/behaviors/behavior_keymap.c +++ b/app/src/behaviors/behavior_keymap.c @@ -23,19 +23,19 @@ static int behavior_keymap_init(struct device *dev) return 0; }; -static int on_position_pressed(struct device *dev, u32_t position, u32_t _) +static int on_position_pressed(struct device *dev, u32_t position) { return zmk_keymap_position_state_changed(position, true); } -static int on_position_released(struct device *dev, u32_t position, u32_t _) +static int on_position_released(struct device *dev, u32_t position) { return zmk_keymap_position_state_changed(position, false); } static const struct behavior_driver_api behavior_keymap_driver_api = { .position_pressed = on_position_pressed, - .position_released = on_position_released + .position_released = on_position_released, }; @@ -47,4 +47,4 @@ DEVICE_AND_API_INIT(behavior_keymap, DT_INST_LABEL(0), behavior_keymap_init, &behavior_keymap_data, &behavior_keymap_config, APPLICATION, CONFIG_KERNEL_INIT_PRIORITY_DEFAULT, - &behavior_keymap_driver_api); \ No newline at end of file + &behavior_keymap_driver_api); diff --git a/app/src/behaviors/behavior_mod_tap.c b/app/src/behaviors/behavior_mod_tap.c new file mode 100644 index 0000000..7684c29 --- /dev/null +++ b/app/src/behaviors/behavior_mod_tap.c @@ -0,0 +1,89 @@ +/* + * Copyright (c) 2020 Peter Johanson + * + * SPDX-License-Identifier: MIT + */ + +#define DT_DRV_COMPAT zmk_behavior_mod_tap + +#include +#include +#include + +#include + +LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL); + +struct behavior_mod_tap_config { }; +struct behavior_mod_tap_data { + u16_t pending_press_positions; +}; + +static int behavior_mod_tap_init(struct device *dev) +{ + return 0; +}; + + +static int on_keymap_binding_pressed(struct device *dev, u32_t position, u32_t mods, u32_t keycode) +{ + struct behavior_mod_tap_data *data = dev->driver_data; + LOG_DBG("mods: %d, keycode: %d", mods, keycode); + WRITE_BIT(data->pending_press_positions, position, true); + return zmk_events_modifiers_pressed(mods); +} + + +// They keycode is passed by the "keymap" based on the parameter created as part of the assignment. +static int on_keymap_binding_released(struct device *dev, u32_t position, u32_t mods, u32_t keycode) +{ + struct behavior_mod_tap_data *data = dev->driver_data; + LOG_DBG("mods: %d, keycode: %d", mods, keycode); + + zmk_events_modifiers_released(mods); + if (data->pending_press_positions & BIT(position)) { + zmk_events_keycode_pressed(keycode); + k_msleep(10); + zmk_events_keycode_released(keycode); + } + + return 0; +} + +static int on_keycode_pressed(struct device *dev, u32_t keycode) +{ + struct behavior_mod_tap_data *data = dev->driver_data; + data->pending_press_positions = 0; + LOG_DBG("pressing: %d", keycode); + return 0; +} + + +static int on_keycode_released(struct device *dev, u32_t keycode) +{ + LOG_DBG("releasing: %d", keycode); + return 0; +} + +static const struct behavior_driver_api behavior_mod_tap_driver_api = { + // These callbacks are all optional, and define which kinds of events the behavior can handle. + // They can reference local functions defined here, or shared event handlers. + .binding_pressed = on_keymap_binding_pressed, + .binding_released = on_keymap_binding_released, + .keycode_pressed = on_keycode_pressed, + .keycode_released = on_keycode_released + // Other optional callbacks a behavior can implement + // .on_mouse_moved + // .on_sensor_data - Any behaviour that wants to be linked to a censor can implement this behavior +}; + + +static const struct behavior_mod_tap_config behavior_mod_tap_config = {}; + +static struct behavior_mod_tap_data behavior_mod_tap_data; + +DEVICE_AND_API_INIT(behavior_key_press, DT_INST_LABEL(0), behavior_mod_tap_init, + &behavior_mod_tap_data, + &behavior_mod_tap_config, + APPLICATION, CONFIG_KERNEL_INIT_PRIORITY_DEFAULT, + &behavior_mod_tap_driver_api); diff --git a/app/src/behaviors/behavior_reset.c b/app/src/behaviors/behavior_reset.c index 1609fad..44cbc21 100644 --- a/app/src/behaviors/behavior_reset.c +++ b/app/src/behaviors/behavior_reset.c @@ -21,7 +21,7 @@ static int behavior_reset_init(struct device *dev) return 0; }; -static int on_position_pressed(struct device *dev, u32_t _param1, u32_t _param2) +static int on_keymap_binding_pressed(struct device *dev, u32_t position, u32_t _param1, u32_t _param2) { // TODO: Correct magic code for going into DFU? // See https://github.com/adafruit/Adafruit_nRF52_Bootloader/blob/d6b28e66053eea467166f44875e3c7ec741cb471/src/main.c#L107 @@ -29,14 +29,8 @@ static int on_position_pressed(struct device *dev, u32_t _param1, u32_t _param2) return 0; } -static int on_position_released(struct device *dev, u32_t _param1, u32_t _param2) -{ - return 0; -} - static const struct behavior_driver_api behavior_reset_driver_api = { - .position_pressed = on_position_pressed, - .position_released = on_position_released + .binding_pressed = on_keymap_binding_pressed, }; diff --git a/app/src/events.c b/app/src/events.c index 73c0e29..376f370 100644 --- a/app/src/events.c +++ b/app/src/events.c @@ -5,63 +5,74 @@ #include #include -#define BINDINGS_NODE DT_CHOSEN(zmk_global_bindings) -#define BINDING_COUNT DT_PROP_LEN(BINDINGS_NODE, bindings) +#define DT_DRV_COMPAT zmk_behavior_global +#define GLOBAL_BEHAVIOR_LEN DT_NUM_INST_STATUS_OKAY(DT_DRV_COMPAT) -#define BINDING_GEN(idx,_) \ - { .behavior_dev = DT_LABEL(DT_PHANDLE_BY_IDX(BINDINGS_NODE, bindings, idx)), \ - .param1 = COND_CODE_0(DT_PHA_HAS_CELL_AT_IDX(BINDINGS_NODE, bindings, idx, param1), (0), (DT_PHA_BY_IDX(BINDINGS_NODE, bindings, idx, param1))), \ - .param2 = COND_CODE_0(DT_PHA_HAS_CELL_AT_IDX(BINDINGS_NODE, bindings, idx, param2), (0), (DT_PHA_BY_IDX(BINDINGS_NODE, bindings, idx, param2))), \ - }, - -static const struct zmk_behavior_binding bindings[] = - { UTIL_LISTIFY(BINDING_COUNT, BINDING_GEN, 0) }; +#define LABEL_ENTRY(i) DT_INST_LABEL(i), +static const char *global_behaviors[] = { + DT_INST_FOREACH_STATUS_OKAY(LABEL_ENTRY) +}; int zmk_events_position_pressed(u32_t position) { - for (int i = 0; i < BINDING_COUNT; i++) { - const struct zmk_behavior_binding *b = &bindings[i]; - struct device *dev = device_get_binding(b->behavior_dev); - behavior_position_pressed(dev, position, 0); + for (int i = 0; i < GLOBAL_BEHAVIOR_LEN; i++) { + const char* label = global_behaviors[i]; + struct device *dev = device_get_binding(label); + behavior_position_pressed(dev, position); } return 0; }; int zmk_events_position_released(u32_t position) { - for (int i = 0; i < BINDING_COUNT; i++) { - const struct zmk_behavior_binding *b = &bindings[i]; - struct device *dev = device_get_binding(b->behavior_dev); - behavior_position_released(dev, position, 0); + for (int i = 0; i < GLOBAL_BEHAVIOR_LEN; i++) { + const char* label = global_behaviors[i]; + struct device *dev = device_get_binding(label); + behavior_position_released(dev, position); } return 0; -} +}; + int zmk_events_keycode_pressed(u32_t keycode) { - for (int i = 0; i < BINDING_COUNT; i++) { - const struct zmk_behavior_binding *b = &bindings[i]; - struct device *dev = device_get_binding(b->behavior_dev); + for (int i = 0; i < GLOBAL_BEHAVIOR_LEN; i++) { + const char* label = global_behaviors[i]; + struct device *dev = device_get_binding(label); behavior_keycode_pressed(dev, keycode); } return 0; -} +}; + int zmk_events_keycode_released(u32_t keycode) { - for (int i = 0; i < BINDING_COUNT; i++) { - const struct zmk_behavior_binding *b = &bindings[i]; - struct device *dev = device_get_binding(b->behavior_dev); + for (int i = 0; i < GLOBAL_BEHAVIOR_LEN; i++) { + const char* label = global_behaviors[i]; + struct device *dev = device_get_binding(label); behavior_keycode_released(dev, keycode); } return 0; }; -int zmk_events_mod_pressed(u32_t modifier) + +int zmk_events_modifiers_pressed(zmk_mod_flags modifiers) { + for (int i = 0; i < GLOBAL_BEHAVIOR_LEN; i++) { + const char* label = global_behaviors[i]; + struct device *dev = device_get_binding(label); + behavior_modifiers_pressed(dev, modifiers); + } return 0; }; -int zmk_events_mod_released(u32_t modifier) + +int zmk_events_modifiers_released(zmk_mod_flags modifiers) { + for (int i = 0; i < GLOBAL_BEHAVIOR_LEN; i++) { + const char* label = global_behaviors[i]; + struct device *dev = device_get_binding(label); + behavior_modifiers_released(dev, modifiers); + } return 0; }; + int zmk_events_consumer_key_pressed(u32_t usage) { return 0; @@ -69,4 +80,4 @@ int zmk_events_consumer_key_pressed(u32_t usage) int zmk_events_consumer_key_released(u32_t usage) { return 0; -}; \ No newline at end of file +}; diff --git a/app/src/keymap.c b/app/src/keymap.c index 6ee61ec..e14626a 100644 --- a/app/src/keymap.c +++ b/app/src/keymap.c @@ -1,11 +1,13 @@ +#include #include LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL); + +#include #include #include #include #include -#include static u32_t zmk_keymap_layer_state = 0; static u8_t zmk_keymap_layer_default = 0; @@ -88,10 +90,15 @@ int zmk_keymap_position_state_changed(u32_t position, bool pressed) LOG_DBG("position: %d, binding name: %s", position, binding->behavior_dev); behavior = device_get_binding(binding->behavior_dev); + + if (!behavior) { + LOG_DBG("No behavior assigned to %d on layer %d", position, layer); + continue; + } if (pressed) { - ret = behavior_position_pressed(behavior, binding->param1, binding->param2); + ret = behavior_keymap_binding_pressed(behavior, position, binding->param1, binding->param2); } else { - ret = behavior_position_released(behavior, binding->param1, binding->param2); + ret = behavior_keymap_binding_released(behavior, position, binding->param1, binding->param2); } -- cgit v1.3.1 From 55cf9db564e66e2804f2d3f2201c55c3c86a90d7 Mon Sep 17 00:00:00 2001 From: Pete Johanson Date: Mon, 22 Jun 2020 11:06:01 -0400 Subject: Fix consumer keys w/ refactored behaviors. --- app/boards/native_posix.overlay | 4 +- .../petejohanson_handwire/keymap/include/keymap.h | 5 -- .../shields/petejohanson_handwire/keymap/keymap.c | 34 --------- .../petejohanson_handwire/keymap/keymap.overlay | 26 ++----- app/dts/behaviors/key_press.dtsi | 10 +++ .../bindings/behaviors/zmk,behavior-key-press.yaml | 5 ++ app/include/drivers/behavior.h | 16 +++-- app/include/dt-bindings/zmk/keys.h | 19 ++--- app/include/zmk/endpoints.h | 3 +- app/include/zmk/events.h | 4 +- app/include/zmk/hid.h | 55 +++++--------- app/include/zmk/keymap.h | 4 +- app/src/behaviors/behavior_hid.c | 51 ++++++++++--- app/src/behaviors/behavior_key_press.c | 50 ++++++------- app/src/behaviors/behavior_mod_tap.c | 11 ++- app/src/behaviors/behavior_momentary_layer.c | 8 +-- app/src/endpoints.c | 32 +++------ app/src/events.c | 8 +-- app/src/hid.c | 84 ++++++++++++---------- app/src/keymap.c | 10 +-- 20 files changed, 197 insertions(+), 242 deletions(-) delete mode 100644 app/boards/shields/petejohanson_handwire/keymap/include/keymap.h delete mode 100644 app/boards/shields/petejohanson_handwire/keymap/keymap.c (limited to 'app/include/drivers') diff --git a/app/boards/native_posix.overlay b/app/boards/native_posix.overlay index bf9ae2c..e9c4c95 100644 --- a/app/boards/native_posix.overlay +++ b/app/boards/native_posix.overlay @@ -56,7 +56,7 @@ label = "DEFAULT"; bindings = < - &kp B &mo A &kp C &kp E + &kp B &mo 1 &kp C &kp E &kp D &kp G &kp F &kp Q>; }; @@ -64,7 +64,7 @@ label = "LOWER"; bindings = < - &kp N &trans &kp O &kp Q + &cp M_NEXT &trans &kp O &kp Q &kp L &kp J &kp P &kp K>; }; diff --git a/app/boards/shields/petejohanson_handwire/keymap/include/keymap.h b/app/boards/shields/petejohanson_handwire/keymap/include/keymap.h deleted file mode 100644 index 01cd9e5..0000000 --- a/app/boards/shields/petejohanson_handwire/keymap/include/keymap.h +++ /dev/null @@ -1,5 +0,0 @@ - -#include - -#define CC_RAIS ZC_CSTM(1) -#define CC_LOWR ZC_CSTM(2) \ No newline at end of file diff --git a/app/boards/shields/petejohanson_handwire/keymap/keymap.c b/app/boards/shields/petejohanson_handwire/keymap/keymap.c deleted file mode 100644 index 067cd08..0000000 --- a/app/boards/shields/petejohanson_handwire/keymap/keymap.c +++ /dev/null @@ -1,34 +0,0 @@ - -#include -#include -#include - -bool zmk_handle_key_user(struct zmk_key_event *key_event) -{ - switch (key_event->key) - { - case CC_LOWR: - if (key_event->pressed) - { - zmk_keymap_layer_activate(1); - } - else - { - zmk_keymap_layer_deactivate(1); - } - - return false; - case CC_RAIS: - if (key_event->pressed) - { - zmk_keymap_layer_activate(2); - } - else - { - zmk_keymap_layer_deactivate(2); - } - return false; - } - - return true; -}; diff --git a/app/boards/shields/petejohanson_handwire/keymap/keymap.overlay b/app/boards/shields/petejohanson_handwire/keymap/keymap.overlay index 5da88b8..b294171 100644 --- a/app/boards/shields/petejohanson_handwire/keymap/keymap.overlay +++ b/app/boards/shields/petejohanson_handwire/keymap/keymap.overlay @@ -1,6 +1,5 @@ #include #include -#include / { chosen { @@ -18,37 +17,24 @@ default: layer_0 { label = "DEFAULT"; - keys = - < - KC_A MT(MOD_LSFT, KC_B) ZC_NO ZC_NO - CC_RAIS CC_LOWR ZC_NO ZC_NO - >; bindings = < - &reset &kp 0 - &kp 1 &kp 2>; + &cp M_NEXT &mt MOD_LSFT B &trans &trans + &mo 1 &mo 2 &trans &trans>; }; lower: layer_1 { label = "LOWER"; - keys = < - KC_MPLY KC_MNXT ZC_NO ZC_NO - ZC_TRNS ZC_TRNS ZC_NO ZC_NO - >; bindings = < - &reset &kp 0 - &kp 1 &kp 2>; + &cp M_PLAY &cp M_NEXT &trans &trans + &trans &trans &trans &trans>; }; raise: layer_2 { label = "RAISE"; - keys = < - KC_C KC_D ZC_NO ZC_NO - ZC_TRNS ZC_TRNS ZC_NO ZC_NO>; - bindings = < - &reset &kp 0 - &kp 1 &kp 2>; + &kp C &kp D &trans &trans + &trans &kp E &trans &trans>; }; }; }; diff --git a/app/dts/behaviors/key_press.dtsi b/app/dts/behaviors/key_press.dtsi index 7c7ac5b..5a01953 100644 --- a/app/dts/behaviors/key_press.dtsi +++ b/app/dts/behaviors/key_press.dtsi @@ -1,8 +1,18 @@ +#include + / { behaviors { kp: behavior_key_press { compatible = "zmk,behavior-key-press"; label = "KEY_PRESS"; + usage_page = ; + #binding-cells = <1>; + }; + + cp: behavior_consumer_press { + compatible = "zmk,behavior-key-press"; + label = "CONSUMER_PRESS"; + usage_page = ; #binding-cells = <1>; }; }; diff --git a/app/dts/bindings/behaviors/zmk,behavior-key-press.yaml b/app/dts/bindings/behaviors/zmk,behavior-key-press.yaml index 0169d7d..7ec5494 100644 --- a/app/dts/bindings/behaviors/zmk,behavior-key-press.yaml +++ b/app/dts/bindings/behaviors/zmk,behavior-key-press.yaml @@ -6,3 +6,8 @@ description: Key press/release behavior compatible: "zmk,behavior-key-press" include: one_param.yaml + +properties: + usage_page: + type: int + default: 0 diff --git a/app/include/drivers/behavior.h b/app/include/drivers/behavior.h index b3c6ad2..cca9272 100644 --- a/app/include/drivers/behavior.h +++ b/app/include/drivers/behavior.h @@ -25,7 +25,7 @@ extern "C" { typedef int (*behavior_position_callback_t)(struct device *dev, u32_t position); typedef int (*behavior_keymap_binding_callback_t)(struct device *dev, u32_t position, u32_t param1, u32_t param2); -typedef int (*behavior_keycode_callback_t)(struct device *dev, u32_t keycode); +typedef int (*behavior_keycode_callback_t)(struct device *dev, u8_t usage_page, u32_t keycode); typedef int (*behavior_modifiers_callback_t)(struct device *dev, zmk_mod_flags modifiers); __subsystem struct behavior_driver_api { @@ -135,14 +135,15 @@ static inline int z_impl_behavior_keymap_binding_released(struct device *dev, u3 /** * @brief Handle the keycode being pressed * @param dev Pointer to the device structure for the driver instance. + * @param usage_page The usage page for the keycode. * @param keycode The keycode that is being pressed. * * @retval 0 If successful. * @retval Negative errno code if failure. */ -__syscall int behavior_keycode_pressed(struct device *dev, u32_t keycode); +__syscall int behavior_keycode_pressed(struct device *dev, u8_t usage_page, u32_t keycode); -static inline int z_impl_behavior_keycode_pressed(struct device *dev, u32_t keycode) +static inline int z_impl_behavior_keycode_pressed(struct device *dev, u8_t usage_page, u32_t keycode) { const struct behavior_driver_api *api = (const struct behavior_driver_api *)dev->driver_api; @@ -151,21 +152,22 @@ static inline int z_impl_behavior_keycode_pressed(struct device *dev, u32_t keyc return -ENOTSUP; } - return api->keycode_pressed(dev, keycode); + return api->keycode_pressed(dev, usage_page, keycode); } /** * @brief Handle the keycode being released * @param dev Pointer to the device structure for the driver instance. + * @param usage_page The usage page for the keycode. * @param keycode The keycode that is being pressed. * * @retval 0 If successful. * @retval Negative errno code if failure. */ -__syscall int behavior_keycode_released(struct device *dev, u32_t keycode); +__syscall int behavior_keycode_released(struct device *dev, u8_t usage_page, u32_t keycode); -static inline int z_impl_behavior_keycode_released(struct device *dev, u32_t keycode) +static inline int z_impl_behavior_keycode_released(struct device *dev, u8_t usage_page, u32_t keycode) { const struct behavior_driver_api *api = (const struct behavior_driver_api *)dev->driver_api; @@ -174,7 +176,7 @@ static inline int z_impl_behavior_keycode_released(struct device *dev, u32_t key return -ENOTSUP; } - return api->keycode_released(dev, keycode); + return api->keycode_released(dev, usage_page, keycode); } diff --git a/app/include/dt-bindings/zmk/keys.h b/app/include/dt-bindings/zmk/keys.h index 476d110..c7003c6 100644 --- a/app/include/dt-bindings/zmk/keys.h +++ b/app/include/dt-bindings/zmk/keys.h @@ -1,6 +1,9 @@ #pragma once +#define USAGE_KEYPAD 0x07 +#define USAGE_CONSUMER 0x0C + #define A 0x04 #define B 0x05 #define C 0x06 @@ -104,14 +107,14 @@ /* The following are select consumer page usages */ -#define MNXT 0x100 -#define MPRV 0x101 -#define MSTP 0x102 -#define MJCT 0x103 -#define MPLY 0x104 -#define MMUT 0x105 -#define MVLU 0x106 -#define MVLD 0x107 +#define M_NEXT 0xB5 +#define M_PREV 0xB6 +#define M_STOP 0xB7 +#define M_EJCT 0xB8 +#define M_PLAY 0xCD +#define M_MUTE 0xE2 +#define M_VOLU 0xE9 +#define M_VOLD 0xEA #define MOD_LCTL (1 << 0x00) #define MOD_LSFT (1 << 0x01) diff --git a/app/include/zmk/endpoints.h b/app/include/zmk/endpoints.h index 255ca54..624bb4e 100644 --- a/app/include/zmk/endpoints.h +++ b/app/include/zmk/endpoints.h @@ -4,5 +4,4 @@ #include int zmk_endpoints_init(); -int zmk_endpoints_send_report(enum zmk_hid_report_changes changes); -int zmk_endpoints_send_key_event(struct zmk_key_event key_event); +int zmk_endpoints_send_report(u8_t usage_report); diff --git a/app/include/zmk/events.h b/app/include/zmk/events.h index 8d1ae6a..5be2beb 100644 --- a/app/include/zmk/events.h +++ b/app/include/zmk/events.h @@ -4,8 +4,8 @@ int zmk_events_position_pressed(u32_t position); int zmk_events_position_released(u32_t position); -int zmk_events_keycode_pressed(u32_t keycode); -int zmk_events_keycode_released(u32_t keycode); +int zmk_events_keycode_pressed(u8_t usage_page, u32_t keycode); +int zmk_events_keycode_released(u8_t usage_page, u32_t keycode); int zmk_events_modifiers_pressed(zmk_mod_flags modifiers); int zmk_events_modifiers_released(zmk_mod_flags modifiers); int zmk_events_consumer_key_pressed(u32_t usage); diff --git a/app/include/zmk/hid.h b/app/include/zmk/hid.h index e14a51a..138606a 100644 --- a/app/include/zmk/hid.h +++ b/app/include/zmk/hid.h @@ -108,40 +108,21 @@ static const u8_t zmk_hid_report_desc[] = { 0x00, /* LOGICAL_MAXIMUM (1) */ HID_GI_LOGICAL_MAX(1), - 0x01, - /* USAGE (Scan Next Track) */ - HID_LI_USAGE, - 0xB5, - /* USAGE (Scan Previous Track) */ - HID_LI_USAGE, - 0xB6, - /* USAGE (Stop) */ - HID_LI_USAGE, - 0xB7, - /* USAGE (Eject) */ - HID_LI_USAGE, - 0xB8, - /* USAGE (Media Play/Pause) */ - HID_LI_USAGE, - 0xCD, - /* USAGE (Mute) */ - HID_LI_USAGE, - 0xE2, - /* USAGE (Volume Increment) */ - HID_LI_USAGE, - 0xE9, - /* USAGE (Volume Decrement) */ - HID_LI_USAGE, - 0xEA, + 0xFF, + HID_LI_USAGE_MIN(1), + 0x00, + /* USAGE_MAXIMUM (Keyboard Application) */ + HID_LI_USAGE_MAX(1), + 0xFF, /* INPUT (Data,Ary,Abs) */ - /* REPORT_SIZE (1) */ + /* REPORT_SIZE (8) */ HID_GI_REPORT_SIZE, - 0x01, + 0x08, /* REPORT_COUNT (8) */ HID_GI_REPORT_COUNT, - 0x08, + 0x06, HID_MI_INPUT, - 0x02, + 0x00, /* END COLLECTION */ HID_MI_COLLECTION_END, }; @@ -167,7 +148,7 @@ struct zmk_hid_keypad_report struct zmk_hid_consumer_report_body { - u8_t keys; + u8_t keys[6]; } __packed; struct zmk_hid_consumer_report @@ -176,19 +157,15 @@ struct zmk_hid_consumer_report struct zmk_hid_consumer_report_body body; } __packed; -enum zmk_hid_report_changes -{ - None = 0x00, - Keypad = (0x01 << 0x00), - Consumer = (0x01 << 0x01) -}; - int zmk_hid_register_mod(zmk_mod modifier); int zmk_hid_unregister_mod(zmk_mod modifier); int zmk_hid_register_mods(zmk_mod_flags modifiers); int zmk_hid_unregister_mods(zmk_mod_flags modifiers); -enum zmk_hid_report_changes zmk_hid_press_key(zmk_key key); -enum zmk_hid_report_changes zmk_hid_release_key(zmk_key key); +int zmk_hid_keypad_press(zmk_key key); +int zmk_hid_keypad_release(zmk_key key); + +int zmk_hid_consumer_press(zmk_key key); +int zmk_hid_consumer_release(zmk_key key); struct zmk_hid_keypad_report *zmk_hid_get_keypad_report(); struct zmk_hid_consumer_report *zmk_hid_get_consumer_report(); diff --git a/app/include/zmk/keymap.h b/app/include/zmk/keymap.h index 38c1249..4a6bb37 100644 --- a/app/include/zmk/keymap.h +++ b/app/include/zmk/keymap.h @@ -1,6 +1,6 @@ #pragma once -bool zmk_keymap_layer_activate(u8_t layer); -bool zmk_keymap_layer_deactivate(u8_t layer); +int zmk_keymap_layer_activate(u8_t layer); +int zmk_keymap_layer_deactivate(u8_t layer); int zmk_keymap_position_state_changed(u32_t position, bool pressed); diff --git a/app/src/behaviors/behavior_hid.c b/app/src/behaviors/behavior_hid.c index 0aeade5..1ac7404 100644 --- a/app/src/behaviors/behavior_hid.c +++ b/app/src/behaviors/behavior_hid.c @@ -24,22 +24,53 @@ static int behavior_hid_init(struct device *dev) return 0; }; -static int on_keycode_pressed(struct device *dev, u32_t keycode) +static int on_keycode_pressed(struct device *dev, u8_t usage_page, u32_t keycode) { - enum zmk_hid_report_changes changes; + int err; LOG_DBG("keycode %d", keycode); - changes = zmk_hid_press_key(keycode); - return zmk_endpoints_send_report(changes); + switch (usage_page) { + case USAGE_KEYPAD: + err = zmk_hid_keypad_press(keycode); + if (err) { + LOG_ERR("Unable to press keycode"); + return err; + } + break; + case USAGE_CONSUMER: + err = zmk_hid_consumer_press(keycode); + if (err) { + LOG_ERR("Unable to press keycode"); + return err; + } + break; + } + + return zmk_endpoints_send_report(usage_page); } -static int on_keycode_released(struct device *dev, u32_t keycode) +static int on_keycode_released(struct device *dev, u8_t usage_page, u32_t keycode) { - enum zmk_hid_report_changes changes; + int err; LOG_DBG("keycode %d", keycode); - changes = zmk_hid_release_key(keycode); - return zmk_endpoints_send_report(changes); + switch (usage_page) { + case USAGE_KEYPAD: + err = zmk_hid_keypad_release(keycode); + if (err) { + LOG_ERR("Unable to press keycode"); + return err; + } + break; + case USAGE_CONSUMER: + err = zmk_hid_consumer_release(keycode); + if (err) { + LOG_ERR("Unable to press keycode"); + return err; + } + break; + } + return zmk_endpoints_send_report(usage_page); } static int on_modifiers_pressed(struct device *dev, zmk_mod_flags modifiers) @@ -47,7 +78,7 @@ static int on_modifiers_pressed(struct device *dev, zmk_mod_flags modifiers) LOG_DBG("modifiers %d", modifiers); zmk_hid_register_mods(modifiers); - return zmk_endpoints_send_report(Keypad); + return zmk_endpoints_send_report(USAGE_KEYPAD); } static int on_modifiers_released(struct device *dev, zmk_mod_flags modifiers) @@ -55,7 +86,7 @@ static int on_modifiers_released(struct device *dev, zmk_mod_flags modifiers) LOG_DBG("modifiers %d", modifiers); zmk_hid_unregister_mods(modifiers); - return zmk_endpoints_send_report(Keypad); + return zmk_endpoints_send_report(USAGE_KEYPAD); } static const struct behavior_driver_api behavior_hid_driver_api = { diff --git a/app/src/behaviors/behavior_key_press.c b/app/src/behaviors/behavior_key_press.c index 1b3e670..7213b3c 100644 --- a/app/src/behaviors/behavior_key_press.c +++ b/app/src/behaviors/behavior_key_press.c @@ -14,7 +14,9 @@ LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL); -struct behavior_key_press_config { }; +struct behavior_key_press_config { + u8_t usage_page; +}; struct behavior_key_press_data { }; static int behavior_key_press_init(struct device *dev) @@ -22,44 +24,34 @@ static int behavior_key_press_init(struct device *dev) return 0; }; - -// They keycode is passed by the "keymap" based on the parameter created as part of the assignment. -// Other drivers instead might activate a layer, update the consumer page state, or update the RGB state, etc. -// Returns: -// * > 0 - indicate successful processing, and halt further handling, -// * 0 - Indicate successful processing, and continue propagation. -// * < 0 - Indicate error processing, report and halt further propagation. static int on_keymap_binding_pressed(struct device *dev, u32_t position, u32_t keycode, u32_t _) { - LOG_DBG("position %d keycode %d", position, keycode); - return zmk_events_keycode_pressed(keycode); + const struct behavior_key_press_config *cfg = dev->config_info; + LOG_DBG("position %d usage_page 0x%02X keycode 0x%02X", position, cfg->usage_page, keycode); + return zmk_events_keycode_pressed(cfg->usage_page, keycode); } - -// They keycode is passed by the "keymap" based on the parameter created as part of the assignment. static int on_keymap_binding_released(struct device *dev, u32_t position, u32_t keycode, u32_t _) { - LOG_DBG("position %d keycode %d", position, keycode); - return zmk_events_keycode_released(keycode); + const struct behavior_key_press_config *cfg = dev->config_info; + LOG_DBG("position %d usage_page 0x%02X keycode 0x%02X", position, cfg->usage_page, keycode); + return zmk_events_keycode_released(cfg->usage_page, keycode); } static const struct behavior_driver_api behavior_key_press_driver_api = { - // These callbacks are all optional, and define which kinds of events the behavior can handle. - // They can reference local functions defined here, or shared event handlers. .binding_pressed = on_keymap_binding_pressed, .binding_released = on_keymap_binding_released - // Other optional callbacks a behavior can implement - // .on_mouse_moved - // .on_sensor_data - Any behaviour that wants to be linked to a censor can implement this behavior }; - -static const struct behavior_key_press_config behavior_key_press_config = {}; - -static struct behavior_key_press_data behavior_key_press_data; - -DEVICE_AND_API_INIT(behavior_key_press, DT_INST_LABEL(0), behavior_key_press_init, - &behavior_key_press_data, - &behavior_key_press_config, - APPLICATION, CONFIG_KERNEL_INIT_PRIORITY_DEFAULT, - &behavior_key_press_driver_api); +#define KP_INST(n) \ + static const struct behavior_key_press_config behavior_key_press_config_##n = { \ + .usage_page = DT_INST_PROP(n, usage_page) \ + }; \ + static struct behavior_key_press_data behavior_key_press_data_##n; \ + DEVICE_AND_API_INIT(behavior_key_press_##n, DT_INST_LABEL(n), behavior_key_press_init, \ + &behavior_key_press_data_##n, \ + &behavior_key_press_config_##n, \ + APPLICATION, CONFIG_KERNEL_INIT_PRIORITY_DEFAULT, \ + &behavior_key_press_driver_api); + +DT_INST_FOREACH_STATUS_OKAY(KP_INST) \ No newline at end of file diff --git a/app/src/behaviors/behavior_mod_tap.c b/app/src/behaviors/behavior_mod_tap.c index 7684c29..2e6e339 100644 --- a/app/src/behaviors/behavior_mod_tap.c +++ b/app/src/behaviors/behavior_mod_tap.c @@ -40,17 +40,17 @@ static int on_keymap_binding_released(struct device *dev, u32_t position, u32_t struct behavior_mod_tap_data *data = dev->driver_data; LOG_DBG("mods: %d, keycode: %d", mods, keycode); - zmk_events_modifiers_released(mods); +zmk_events_modifiers_released(mods); if (data->pending_press_positions & BIT(position)) { - zmk_events_keycode_pressed(keycode); + zmk_events_keycode_pressed(USAGE_KEYPAD, keycode); k_msleep(10); - zmk_events_keycode_released(keycode); + zmk_events_keycode_released(USAGE_KEYPAD, keycode); } return 0; } -static int on_keycode_pressed(struct device *dev, u32_t keycode) +static int on_keycode_pressed(struct device *dev, u8_t usage_page, u32_t keycode) { struct behavior_mod_tap_data *data = dev->driver_data; data->pending_press_positions = 0; @@ -58,8 +58,7 @@ static int on_keycode_pressed(struct device *dev, u32_t keycode) return 0; } - -static int on_keycode_released(struct device *dev, u32_t keycode) +static int on_keycode_released(struct device *dev, u8_t usage_page, u32_t keycode) { LOG_DBG("releasing: %d", keycode); return 0; diff --git a/app/src/behaviors/behavior_momentary_layer.c b/app/src/behaviors/behavior_momentary_layer.c index f85d33d..904051e 100644 --- a/app/src/behaviors/behavior_momentary_layer.c +++ b/app/src/behaviors/behavior_momentary_layer.c @@ -24,14 +24,14 @@ static int behavior_mo_init(struct device *dev) }; -static int on_keymap_binding_pressed(struct device *dev, u32_t position, u32_t layer, u32_t _) +static int mo_keymap_binding_pressed(struct device *dev, u32_t position, u32_t layer, u32_t _) { LOG_DBG("position %d layer %d", position, layer); return zmk_keymap_layer_activate(layer); } -static int on_keymap_binding_released(struct device *dev, u32_t position, u32_t layer, u32_t _) +static int mo_keymap_binding_released(struct device *dev, u32_t position, u32_t layer, u32_t _) { LOG_DBG("position %d layer %d", position, layer); @@ -39,8 +39,8 @@ static int on_keymap_binding_released(struct device *dev, u32_t position, u32_t } static const struct behavior_driver_api behavior_mo_driver_api = { - .binding_pressed = on_keymap_binding_pressed, - .binding_released = on_keymap_binding_released + .binding_pressed = mo_keymap_binding_pressed, + .binding_released = mo_keymap_binding_released }; diff --git a/app/src/endpoints.c b/app/src/endpoints.c index 2f31e10..7823e95 100644 --- a/app/src/endpoints.c +++ b/app/src/endpoints.c @@ -3,6 +3,7 @@ #include #include #include +# #include LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL); @@ -35,15 +36,15 @@ int zmk_endpoints_init() return 0; } -int zmk_endpoints_send_report(enum zmk_hid_report_changes report_type) +int zmk_endpoints_send_report(u8_t usage_page) { int err; struct zmk_hid_keypad_report *keypad_report; struct zmk_hid_consumer_report *consumer_report; - LOG_DBG(""); - switch (report_type) + LOG_DBG("usage page 0x%02X", usage_page); + switch (usage_page) { - case Keypad: + case USAGE_KEYPAD: keypad_report = zmk_hid_get_keypad_report(); #ifdef CONFIG_ZMK_USB if (zmk_usb_hid_send_report((u8_t *)keypad_report, sizeof(struct zmk_hid_keypad_report)) != 0) @@ -61,7 +62,7 @@ int zmk_endpoints_send_report(enum zmk_hid_report_changes report_type) #endif /* CONFIG_ZMK_BLE */ break; - case Consumer: + case USAGE_CONSUMER: consumer_report = zmk_hid_get_consumer_report(); #ifdef CONFIG_ZMK_USB if (zmk_usb_hid_send_report((u8_t *)consumer_report, sizeof(struct zmk_hid_consumer_report)) != 0) @@ -80,27 +81,10 @@ int zmk_endpoints_send_report(enum zmk_hid_report_changes report_type) break; default: - LOG_ERR("Unknown report change type %d", report_type); - return -EINVAL; + LOG_ERR("Unsupported usage page %d", usage_page); + return -ENOTSUP; } return 0; } -int zmk_endpoints_send_key_event(struct zmk_key_event key_event) -{ - enum zmk_hid_report_changes changes; - - LOG_DBG("key %d, state %d\n", key_event.key, key_event.pressed); - - if (key_event.pressed) - { - changes = zmk_hid_press_key(key_event.key); - } - else - { - changes = zmk_hid_release_key(key_event.key); - } - - return zmk_endpoints_send_report(changes); -} diff --git a/app/src/events.c b/app/src/events.c index 376f370..fabb93e 100644 --- a/app/src/events.c +++ b/app/src/events.c @@ -33,22 +33,22 @@ int zmk_events_position_released(u32_t position) return 0; }; -int zmk_events_keycode_pressed(u32_t keycode) +int zmk_events_keycode_pressed(u8_t usage_page, u32_t keycode) { for (int i = 0; i < GLOBAL_BEHAVIOR_LEN; i++) { const char* label = global_behaviors[i]; struct device *dev = device_get_binding(label); - behavior_keycode_pressed(dev, keycode); + behavior_keycode_pressed(dev, usage_page, keycode); } return 0; }; -int zmk_events_keycode_released(u32_t keycode) +int zmk_events_keycode_released(u8_t usage_page, u32_t keycode) { for (int i = 0; i < GLOBAL_BEHAVIOR_LEN; i++) { const char* label = global_behaviors[i]; struct device *dev = device_get_binding(label); - behavior_keycode_released(dev, keycode); + behavior_keycode_released(dev, usage_page, keycode); } return 0; }; diff --git a/app/src/hid.c b/app/src/hid.c index 2bcb621..ca04056 100644 --- a/app/src/hid.c +++ b/app/src/hid.c @@ -12,7 +12,7 @@ static struct zmk_hid_keypad_report kp_report = { static struct zmk_hid_consumer_report consumer_report = { .report_id = 2, .body = { - .keys = 0x00}}; + .keys = {0,0,0,0,0,0}}}; #define _TOGGLE_MOD(mod, state) \ if (modifier > MOD_RGUI) \ @@ -61,62 +61,68 @@ int zmk_hid_unregister_mods(zmk_mod_flags modifiers) #define TOGGLE_KEY(code, val) WRITE_BIT(kp_report.body.keys[code / 8], code % 8, val) -#define TOGGLE_CONSUMER(key, state) \ - WRITE_BIT(consumer_report.body.keys, (key - 0x100), state); +#define TOGGLE_CONSUMER(match, val) \ + for (int idx = 0; idx < MAX_KEYS; idx++) \ + { \ + if (consumer_report.body.keys[idx] != match) \ + { \ + continue; \ + } \ + consumer_report.body.keys[idx] = val; \ + break; \ + } + -enum zmk_hid_report_changes zmk_hid_press_key(zmk_key code) +int zmk_hid_keypad_press(zmk_key code) { if (code >= LCTL && code <= RGUI) { return zmk_hid_register_mod(code - LCTL); } - // if (ZK_IS_CONSUMER(code)) - // { - // LOG_DBG("Toggling a consumer key!"); - // TOGGLE_CONSUMER(code, true); - // return Consumer; - // } - // else - // { - if (code > ZMK_HID_MAX_KEYCODE) - { - return -EINVAL; - } - - // TOGGLE_BOOT_KEY(0U, code); - - TOGGLE_KEY(code, true); - - return Keypad; - // } + + if (code > ZMK_HID_MAX_KEYCODE) + { + return -EINVAL; + } + + // TOGGLE_BOOT_KEY(0U, code); + + TOGGLE_KEY(code, true); + + return 0; }; -enum zmk_hid_report_changes zmk_hid_release_key(zmk_key code) +int zmk_hid_keypad_release(zmk_key code) { if (code >= LCTL && code <= RGUI) { return zmk_hid_unregister_mod(code - LCTL); } - // if (ZK_IS_CONSUMER(code)) - // { - // TOGGLE_CONSUMER(code, false); - // return Consumer; - // } - // else - // { - if (code > ZMK_HID_MAX_KEYCODE) - { - return -EINVAL; - } + if (code > ZMK_HID_MAX_KEYCODE) + { + return -EINVAL; + } - // TOGGLE_BOOT_KEY(0U, code); + // TOGGLE_BOOT_KEY(0U, code); - TOGGLE_KEY(code, false); + TOGGLE_KEY(code, false); - return Keypad; - // } + return 0; +}; + +int zmk_hid_consumer_press(zmk_key code) +{ + TOGGLE_CONSUMER(0U, code); + return 0; +}; + + +int zmk_hid_consumer_release(zmk_key code) +{ + TOGGLE_CONSUMER(code, 0U); + return 0; }; struct zmk_hid_keypad_report *zmk_hid_get_keypad_report() diff --git a/app/src/keymap.c b/app/src/keymap.c index e14626a..dd0fee4 100644 --- a/app/src/keymap.c +++ b/app/src/keymap.c @@ -62,17 +62,17 @@ static struct zmk_behavior_binding zmk_keymap[ZMK_KEYMAP_LAYERS_LEN][ZMK_MATRIX_ #define SET_LAYER_STATE(layer, state) \ if (layer >= 32) \ { \ - return false; \ + return -EINVAL; \ } \ WRITE_BIT(zmk_keymap_layer_state, layer, state); \ - return true; + return 0; -bool zmk_keymap_layer_activate(u8_t layer) +int zmk_keymap_layer_activate(u8_t layer) { SET_LAYER_STATE(layer, true); }; -bool zmk_keymap_layer_deactivate(u8_t layer) +int zmk_keymap_layer_deactivate(u8_t layer) { SET_LAYER_STATE(layer, false); }; @@ -87,7 +87,7 @@ int zmk_keymap_position_state_changed(u32_t position, bool pressed) struct device *behavior; int ret; - LOG_DBG("position: %d, binding name: %s", position, binding->behavior_dev); + LOG_DBG("layer: %d position: %d, binding name: %s", layer, position, binding->behavior_dev); behavior = device_get_binding(binding->behavior_dev); -- cgit v1.3.1