The original changes from zmkfirmware#778

A squashed version of the original changeset from
zmkfirmware#778 rebased on main

app/CMakeLists.txt

@@ -24,13 +24,20 @@ target_sources(app PRIVATE src/stdlib.c)
 target_sources(app PRIVATE src/activity.c)
 target_sources(app PRIVATE src/kscan.c)
 target_sources(app PRIVATE src/matrix_transform.c)
+target_sources(app PRIVATE src/mouse/key_listener.c)
+target_sources(app PRIVATE src/mouse/main.c)
+target_sources(app PRIVATE src/mouse/tick_listener.c)
 target_sources(app PRIVATE src/sensors.c)
 target_sources_ifdef(CONFIG_ZMK_WPM app PRIVATE src/wpm.c)
 target_sources(app PRIVATE src/event_manager.c)
 target_sources_ifdef(CONFIG_ZMK_EXT_POWER app PRIVATE src/ext_power_generic.c)
 target_sources(app PRIVATE src/events/activity_state_changed.c)
 target_sources(app PRIVATE src/events/position_state_changed.c)
 target_sources(app PRIVATE src/events/sensor_event.c)
+target_sources(app PRIVATE src/events/mouse_button_state_changed.c)
+target_sources(app PRIVATE src/events/mouse_move_state_changed.c)
+target_sources(app PRIVATE src/events/mouse_tick.c)
+target_sources(app PRIVATE src/events/mouse_scroll_state_changed.c)
 target_sources_ifdef(CONFIG_ZMK_WPM app PRIVATE src/events/wpm_state_changed.c)
 target_sources_ifdef(CONFIG_USB_DEVICE_STACK app PRIVATE src/events/usb_conn_state_changed.c)
 target_sources(app PRIVATE src/behaviors/behavior_reset.c)
@@ -52,6 +59,9 @@ if ((NOT CONFIG_ZMK_SPLIT) OR CONFIG_ZMK_SPLIT_ROLE_CENTRAL)
   target_sources(app PRIVATE src/behaviors/behavior_transparent.c)
   target_sources(app PRIVATE src/behaviors/behavior_none.c)
   target_sources(app PRIVATE src/behaviors/behavior_sensor_rotate_key_press.c)
+  target_sources(app PRIVATE src/behaviors/behavior_mouse_key_press.c)
+  target_sources(app PRIVATE src/behaviors/behavior_mouse_move.c)
+  target_sources(app PRIVATE src/behaviors/behavior_mouse_scroll.c)
   target_sources(app PRIVATE src/combo.c)
   target_sources(app PRIVATE src/behaviors/behavior_tap_dance.c)
   target_sources(app PRIVATE src/behavior_queue.c)

app/Kconfig

@@ -139,6 +139,10 @@ config ZMK_BLE_CONSUMER_REPORT_QUEUE_SIZE
 	int "Max number of consumer HID reports to queue for sending over BLE"
 	default 5
 
+config ZMK_BLE_MOUSE_REPORT_QUEUE_SIZE
+	int "Max number of mouse HID reports to queue for sending over BLE"
+	default 20
+
 config ZMK_BLE_CLEAR_BONDS_ON_START
 	bool "Configuration that clears all bond information from the keyboard on startup."
 	default n
@@ -297,6 +301,13 @@ endif
 #Display/LED Options
 endmenu
 
+menu "Mouse Options"
+
+rsource "src/mouse/Kconfig"
+
+#Mouse Options
+endmenu
+
 menu "Power Management"
 
 config ZMK_IDLE_TIMEOUT

app/dts/behaviors.dtsi

@@ -18,4 +18,7 @@
 #include <behaviors/caps_word.dtsi>
 #include <behaviors/key_repeat.dtsi>
 #include <behaviors/backlight.dtsi>
-#include <behaviors/macros.dtsi>
+#include <behaviors/macros.dtsi>
+#include <behaviors/mouse_key_press.dtsi>
+#include <behaviors/mouse_move.dtsi>
+#include <behaviors/mouse_scroll.dtsi>

app/dts/behaviors/mouse_key_press.dtsi

@@ -0,0 +1,9 @@
+/ {
+	behaviors {
+		/omit-if-no-ref/ mkp: behavior_mouse_key_press {
+			compatible = "zmk,behavior-mouse-key-press";
+			label = "MOUSE_KEY_PRESS";
+			#binding-cells = <1>;
+		};
+	};
+};

app/dts/behaviors/mouse_move.dtsi

@@ -0,0 +1,12 @@
+/ {
+	behaviors {
+		/omit-if-no-ref/ mmv: behavior_mouse_move {
+			compatible = "zmk,behavior-mouse-move";
+			label = "MOUSE_MOVE";
+			#binding-cells = <1>;
+			delay-ms = <0>;
+			time-to-max-speed-ms = <300>;
+			acceleration-exponent = <1>;
+		};
+	};
+};

app/dts/behaviors/mouse_scroll.dtsi

@@ -0,0 +1,12 @@
+/ {
+	behaviors {
+		/omit-if-no-ref/ mwh: msc: behavior_mouse_scroll {
+			compatible = "zmk,behavior-mouse-scroll";
+			label = "MOUSE_SCROLL";
+			#binding-cells = <1>;
+			delay-ms = <0>;
+			time-to-max-speed-ms = <300>;
+			acceleration-exponent = <0>;
+		};
+	};
+};

app/dts/bindings/behaviors/zmk,behavior-mouse-key-press.yaml

@@ -0,0 +1,5 @@
+description: Mouse key press/release behavior
+
+compatible: "zmk,behavior-mouse-key-press"
+
+include: one_param.yaml

app/dts/bindings/behaviors/zmk,behavior-mouse-move.yaml

@@ -0,0 +1,13 @@
+description: Mouse move
+
+compatible: "zmk,behavior-mouse-move"
+
+include: one_param.yaml
+
+properties:
+  delay-ms:
+    type: int
+  time-to-max-speed-ms:
+    type: int
+  acceleration-exponent:
+    type: int

app/dts/bindings/behaviors/zmk,behavior-mouse-scroll.yaml

@@ -0,0 +1,13 @@
+description: Mouse scroll
+
+compatible: "zmk,behavior-mouse-scroll"
+
+include: one_param.yaml
+
+properties:
+  delay-ms:
+    type: int
+  time-to-max-speed-ms:
+    type: int
+  acceleration-exponent:
+    type: int

app/include/dt-bindings/zmk/hid_usage_pages.h

@@ -26,6 +26,7 @@
 #define HID_USAGE_GDV (0x06)            // Generic Device Controls
 #define HID_USAGE_KEY (0x07)            // Keyboard/Keypad
 #define HID_USAGE_LED (0x08)            // LED
+#define HID_USAGE_BUTTON (0x09)         // Button
 #define HID_USAGE_TELEPHONY (0x0B)      // Telephony Device
 #define HID_USAGE_CONSUMER (0x0C)       // Consumer
 #define HID_USAGE_DIGITIZERS (0x0D)     // Digitizers

app/include/dt-bindings/zmk/mouse.h

@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2020 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+#pragma once
+
+/* Mouse press behavior */
+/* Left click */
+#define MB1 (0x01)
+#define LCLK (MB1)
+
+/* Right click */
+#define MB2 (0x02)
+#define RCLK (MB2)
+
+/* Middle click */
+#define MB3 (0x04)
+#define MCLK (MB3)
+
+#define MB4 (0x08)
+
+#define MB5 (0x10)
+
+#define MB6 (0x20)
+
+#define MB7 (0x40)
+
+#define MB8 (0x80)
+
+/* Mouse move behavior */
+#define MOVE_VERT(vert) ((vert)&0xFFFF)
+#define MOVE_VERT_DECODE(encoded) (int16_t)((encoded)&0x0000FFFF)
+#define MOVE_HOR(hor) (((hor)&0xFFFF) << 16)
+#define MOVE_HOR_DECODE(encoded) (int16_t)(((encoded)&0xFFFF0000) >> 16)
+
+#define MOVE(hor, vert) (MOVE_HOR(hor) + MOVE_VERT(vert))
+
+#define MOVE_UP MOVE_VERT(-600)
+#define MOVE_DOWN MOVE_VERT(600)
+#define MOVE_LEFT MOVE_HOR(-600)
+#define MOVE_RIGHT MOVE_HOR(600)
+
+/* Mouse scroll behavior */
+#define SCROLL_VERT(vert) ((vert)&0xFFFF)
+#define SCROLL_VERT_DECODE(encoded) (int16_t)((encoded)&0x0000FFFF)
+#define SCROLL_HOR(hor) (((hor)&0xFFFF) << 16)
+#define SCROLL_HOR_DECODE(encoded) (int16_t)(((encoded)&0xFFFF0000) >> 16)
+
+#define SCROLL(hor, vert) (SCROLL_HOR(hor) + SCROLL_VERT(vert))
+
+#define SCROLL_UP SCROLL_VERT(10)
+#define SCROLL_DOWN SCROLL_VERT(-10)
+#define SCROLL_LEFT SCROLL_HOR(-10)
+#define SCROLL_RIGHT SCROLL_HOR(10)

app/include/zmk/endpoints.h

@@ -13,3 +13,4 @@ int zmk_endpoints_toggle();
 enum zmk_endpoint zmk_endpoints_selected();
 
 int zmk_endpoints_send_report(uint16_t usage_page);
+int zmk_endpoints_send_mouse_report();

app/include/zmk/events/mouse_button_state_changed.h

@@ -0,0 +1,27 @@
+
+/*
+ * Copyright (c) 2020 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#pragma once
+
+#include <zephyr.h>
+#include <zmk/hid.h>
+#include <zmk/event_manager.h>
+#include <zmk/mouse.h>
+
+struct zmk_mouse_button_state_changed {
+    zmk_mouse_button_t buttons;
+    bool state;
+    int64_t timestamp;
+};
+
+ZMK_EVENT_DECLARE(zmk_mouse_button_state_changed);
+
+static inline struct zmk_mouse_button_state_changed_event *
+zmk_mouse_button_state_changed_from_encoded(uint32_t encoded, bool pressed, int64_t timestamp) {
+    return new_zmk_mouse_button_state_changed((struct zmk_mouse_button_state_changed){
+        .buttons = HID_USAGE_ID(encoded), .state = pressed, .timestamp = timestamp});
+}

app/include/zmk/events/mouse_move_state_changed.h

@@ -0,0 +1,33 @@
+
+/*
+ * Copyright (c) 2020 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#pragma once
+
+#include <zephyr.h>
+#include <zmk/event_manager.h>
+#include <zmk/mouse.h>
+
+struct zmk_mouse_move_state_changed {
+    struct vector2d max_speed;
+    struct mouse_config config;
+    bool state;
+    int64_t timestamp;
+};
+
+ZMK_EVENT_DECLARE(zmk_mouse_move_state_changed);
+
+static inline struct zmk_mouse_move_state_changed_event *
+zmk_mouse_move_state_changed_from_encoded(uint32_t encoded, struct mouse_config config,
+                                          bool pressed, int64_t timestamp) {
+    struct vector2d max_speed = (struct vector2d){
+        .x = MOVE_HOR_DECODE(encoded),
+        .y = MOVE_VERT_DECODE(encoded),
+    };
+
+    return new_zmk_mouse_move_state_changed((struct zmk_mouse_move_state_changed){
+        .max_speed = max_speed, .config = config, .state = pressed, .timestamp = timestamp});
+}

app/include/zmk/events/mouse_scroll_state_changed.h

@@ -0,0 +1,34 @@
+
+/*
+ * Copyright (c) 2020 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#pragma once
+
+#include <zephyr.h>
+#include <zmk/event_manager.h>
+#include <zmk/mouse.h>
+#include <dt-bindings/zmk/mouse.h>
+
+struct zmk_mouse_scroll_state_changed {
+    struct vector2d max_speed;
+    struct mouse_config config;
+    bool state;
+    int64_t timestamp;
+};
+
+ZMK_EVENT_DECLARE(zmk_mouse_scroll_state_changed);
+
+static inline struct zmk_mouse_scroll_state_changed_event *
+zmk_mouse_scroll_state_changed_from_encoded(uint32_t encoded, struct mouse_config config,
+                                            bool pressed, int64_t timestamp) {
+    struct vector2d max_speed = (struct vector2d){
+        .x = SCROLL_HOR_DECODE(encoded),
+        .y = SCROLL_VERT_DECODE(encoded),
+    };
+
+    return new_zmk_mouse_scroll_state_changed((struct zmk_mouse_scroll_state_changed){
+        .max_speed = max_speed, .config = config, .state = pressed, .timestamp = timestamp});
+}

app/include/zmk/events/mouse_tick.h

@@ -0,0 +1,39 @@
+
+/*
+ * Copyright (c) 2020 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#pragma once
+
+#include <dt-bindings/zmk/mouse.h>
+#include <zephyr.h>
+#include <zmk/event_manager.h>
+#include <zmk/mouse.h>
+
+struct zmk_mouse_tick {
+    struct vector2d max_move;
+    struct vector2d max_scroll;
+    struct mouse_config move_config;
+    struct mouse_config scroll_config;
+    int64_t *start_time;
+    int64_t timestamp;
+};
+
+ZMK_EVENT_DECLARE(zmk_mouse_tick);
+
+static inline struct zmk_mouse_tick_event *zmk_mouse_tick(struct vector2d max_move,
+                                                          struct vector2d max_scroll,
+                                                          struct mouse_config move_config,
+                                                          struct mouse_config scroll_config,
+                                                          int64_t *movement_start) {
+    return new_zmk_mouse_tick((struct zmk_mouse_tick){
+        .max_move = max_move,
+        .max_scroll = max_scroll,
+        .move_config = move_config,
+        .scroll_config = scroll_config,
+        .start_time = movement_start,
+        .timestamp = k_uptime_get(),
+    });
+}