Rework and expand Pointing Device support (#14343)

Co-authored-by: Dasky <32983009+daskygit@users.noreply.github.com>

5 files changed, 419 insertions, 33 deletions

diff --git a/quantum/pointing_device.c b/quantum/pointing_device.c
index 09d889f69..feeb2b316 100644
--- a/quantum/pointing_device.c
+++ b/quantum/pointing_device.c
@@ -1,34 +1,56 @@
-/*
-Copyright 2017 Joshua Broekhuijsen <snipeye+qmk@gmail.com>
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-*/
-
-#include <stdint.h>
-#include "report.h"
-#include "host.h"
-#include "timer.h"
-#include "print.h"
-#include "debug.h"
+/* Copyright 2017 Joshua Broekhuijsen <snipeye+qmk@gmail.com>
+ * Copyright 2020 Christopher Courtney, aka Drashna Jael're  (@drashna) <drashna@live.com>
+ * Copyright 2021 Dasky (@daskygit)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
 #include "pointing_device.h"
+#ifdef MOUSEKEY_ENABLE
+#    include "mousekey.h"
+#endif
+#if (defined(POINTING_DEVICE_ROTATION_90) + defined(POINTING_DEVICE_ROTATION_180) + defined(POINTING_DEVICE_ROTATION_270)) > 1
+#    error More than one rotation selected.  This is not supported.
+#endif
 
 static report_mouse_t mouseReport = {};
 
-__attribute__((weak)) bool has_mouse_report_changed(report_mouse_t new, report_mouse_t old) { return (new.buttons != old.buttons) || (new.x&& new.x != old.x) || (new.y&& new.y != old.y) || (new.h&& new.h != old.h) || (new.v&& new.v != old.v); }
+extern const pointing_device_driver_t pointing_device_driver;
+
+__attribute__((weak)) bool has_mouse_report_changed(report_mouse_t new, report_mouse_t old) { return memcmp(&new, &old, sizeof(new)); }
+
+__attribute__((weak)) void           pointing_device_init_kb(void) {}
+__attribute__((weak)) void           pointing_device_init_user(void) {}
+__attribute__((weak)) report_mouse_t pointing_device_task_kb(report_mouse_t mouse_report) { return pointing_device_task_user(mouse_report); }
+__attribute__((weak)) report_mouse_t pointing_device_task_user(report_mouse_t mouse_report) { return mouse_report; }
+
+__attribute__((weak)) uint8_t pointing_device_handle_buttons(uint8_t buttons, bool pressed, pointing_device_buttons_t button) {
+    if (pressed) {
+        buttons |= 1 << (button);
+    } else {
+        buttons &= ~(1 << (button));
+    }
+    return buttons;
+}
 
 __attribute__((weak)) void pointing_device_init(void) {
-    // initialize device, if that needs to be done.
+    pointing_device_driver.init();
+#ifdef POINTING_DEVICE_MOTION_PIN
+    setPinInputHigh(POINTING_DEVICE_MOTION_PIN);
+#endif
+    pointing_device_init_kb();
+    pointing_device_init_user();
 }
 
 __attribute__((weak)) void pointing_device_send(void) {
@@ -43,20 +65,55 @@ __attribute__((weak)) void pointing_device_send(void) {
     mouseReport.y = 0;
     mouseReport.v = 0;
     mouseReport.h = 0;
-    old_report    = mouseReport;
+
+    memcpy(&old_report, &mouseReport, sizeof(mouseReport));
 }
 
 __attribute__((weak)) void pointing_device_task(void) {
-    // gather info and put it in:
-    // mouseReport.x = 127 max -127 min
-    // mouseReport.y = 127 max -127 min
-    // mouseReport.v = 127 max -127 min (scroll vertical)
-    // mouseReport.h = 127 max -127 min (scroll horizontal)
-    // mouseReport.buttons = 0x1F (decimal 31, binary 00011111) max (bitmask for mouse buttons 1-5, 1 is rightmost, 5 is leftmost) 0x00 min
-    // send the report
+    // Gather report info
+#ifdef POINTING_DEVICE_MOTION_PIN
+    if (!readPin(POINTING_DEVICE_MOTION_PIN))
+#endif
+        mouseReport = pointing_device_driver.get_report(mouseReport);
+
+        // Support rotation of the sensor data
+#if defined(POINTING_DEVICE_ROTATION_90) || defined(POINTING_DEVICE_ROTATION_180) || defined(POINTING_DEVICE_ROTATION_270)
+    int8_t x = mouseReport.x, y = mouseReport.y;
+#    if defined(POINTING_DEVICE_ROTATION_90)
+    mouseReport.x = y;
+    mouseReport.y = -x;
+#    elif defined(POINTING_DEVICE_ROTATION_180)
+    mouseReport.x = -x;
+    mouseReport.y = -y;
+#    elif defined(POINTING_DEVICE_ROTATION_270)
+    mouseReport.x = -y;
+    mouseReport.y = x;
+#    else
+#        error "How the heck did you get here?!"
+#    endif
+#endif
+    // Support Inverting the X and Y Axises
+#if defined(POINTING_DEVICE_INVERT_X)
+    mouseReport.x = -mouseReport.x;
+#endif
+#if defined(POINTING_DEVICE_INVERT_Y)
+    mouseReport.y = -mouseReport.y;
+#endif
+
+    // allow kb to intercept and modify report
+    mouseReport = pointing_device_task_kb(mouseReport);
+    // combine with mouse report to ensure that the combined is sent correctly
+#ifdef MOUSEKEY_ENABLE
+    report_mouse_t mousekey_report = mousekey_get_report();
+    mouseReport.buttons            = mouseReport.buttons | mousekey_report.buttons;
+#endif
     pointing_device_send();
 }
 
 report_mouse_t pointing_device_get_report(void) { return mouseReport; }
 
 void pointing_device_set_report(report_mouse_t newMouseReport) { mouseReport = newMouseReport; }
+
+uint16_t pointing_device_get_cpi(void) { return pointing_device_driver.get_cpi(); }
+
+void pointing_device_set_cpi(uint16_t cpi) { pointing_device_driver.set_cpi(cpi); }
diff --git a/quantum/pointing_device.h b/quantum/pointing_device.h
index 56a542d54..5106c2666 100644
--- a/quantum/pointing_device.h
+++ b/quantum/pointing_device.h
@@ -21,9 +21,68 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include "host.h"
 #include "report.h"
 
+#if defined(POINTING_DEVICE_DRIVER_adns5050)
+#    include "drivers/sensors/adns5050.h"
+#elif defined(POINTING_DEVICE_DRIVER_adns9800)
+#    include "spi_master.h"
+#    include "drivers/sensors/adns9800.h"
+#elif defined(POINTING_DEVICE_DRIVER_analog_joystick)
+#    include "analog.h"
+#    include "drivers/sensors/analog_joystick.h"
+#elif defined(POINTING_DEVICE_DRIVER_cirque_pinnacle_i2c) || defined(POINTING_DEVICE_DRIVER_cirque_pinnacle_spi)
+#    include "drivers/sensors/cirque_pinnacle.h"
+#elif defined(POINTING_DEVICE_DRIVER_pimoroni_trackball)
+#    include "i2c_master.h"
+#    include "drivers/sensors/pimoroni_trackball.h"
+// support for legacy pimoroni defines
+#    ifdef PIMORONI_TRACKBALL_INVERT_X
+#        define POINTING_DEVICE_INVERT_X
+#    endif
+#    ifdef PIMORONI_TRACKBALL_INVERT_Y
+#        define POINTING_DEVICE_INVERT_Y
+#    endif
+#    ifdef PIMORONI_TRACKBALL_ROTATE
+#        define POINTING_DEVICE_ROTATION_90
+#    endif
+#elif defined(POINTING_DEVICE_DRIVER_pmw3360)
+#    include "spi_master.h"
+#    include "drivers/sensors/pmw3360.h"
+#else
+void           pointing_device_driver_init(void);
+report_mouse_t pointing_device_driver_get_report(report_mouse_t mouse_report);
+uint16_t       pointing_device_driver_get_cpi(void);
+void           pointing_device_driver_set_cpi(uint16_t cpi);
+#endif
+
+typedef struct {
+    void (*init)(void);
+    report_mouse_t (*get_report)(report_mouse_t mouse_report);
+    void (*set_cpi)(uint16_t);
+    uint16_t (*get_cpi)(void);
+} pointing_device_driver_t;
+
+typedef enum {
+    POINTING_DEVICE_BUTTON1,
+    POINTING_DEVICE_BUTTON2,
+    POINTING_DEVICE_BUTTON3,
+    POINTING_DEVICE_BUTTON4,
+    POINTING_DEVICE_BUTTON5,
+    POINTING_DEVICE_BUTTON6,
+    POINTING_DEVICE_BUTTON7,
+    POINTING_DEVICE_BUTTON8,
+} pointing_device_buttons_t;
+
 void           pointing_device_init(void);
 void           pointing_device_task(void);
 void           pointing_device_send(void);
 report_mouse_t pointing_device_get_report(void);
 void           pointing_device_set_report(report_mouse_t newMouseReport);
 bool           has_mouse_report_changed(report_mouse_t new, report_mouse_t old);
+uint16_t       pointing_device_get_cpi(void);
+void           pointing_device_set_cpi(uint16_t cpi);
+
+void           pointing_device_init_kb(void);
+void           pointing_device_init_user(void);
+report_mouse_t pointing_device_task_kb(report_mouse_t mouse_report);
+report_mouse_t pointing_device_task_user(report_mouse_t mouse_report);
+uint8_t        pointing_device_handle_buttons(uint8_t buttons, bool pressed, pointing_device_buttons_t button);
diff --git a/quantum/pointing_device_drivers.c b/quantum/pointing_device_drivers.c
new file mode 100644
index 000000000..9ad5e76ba
--- /dev/null
+++ b/quantum/pointing_device_drivers.c
@@ -0,0 +1,262 @@
+/* Copyright 2017 Joshua Broekhuijsen <snipeye+qmk@gmail.com>
+ * Copyright 2020 Christopher Courtney, aka Drashna Jael're  (@drashna) <drashna@live.com>
+ * Copyright 2021 Dasky (@daskygit)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "pointing_device.h"
+#include "debug.h"
+#include "wait.h"
+#include "timer.h"
+#include <stddef.h>
+
+// hid mouse reports cannot exceed -127 to 127, so constrain to that value
+#define constrain_hid(amt) ((amt) < -127 ? -127 : ((amt) > 127 ? 127 : (amt)))
+
+// get_report functions should probably be moved to their respective drivers.
+#if defined(POINTING_DEVICE_DRIVER_adns5050)
+report_mouse_t adns5050_get_report(report_mouse_t mouse_report) {
+    report_adns5050_t data = adns5050_read_burst();
+
+    if (data.dx != 0 || data.dy != 0) {
+#    ifdef CONSOLE_ENABLE
+        if (debug_mouse) dprintf("Raw ] X: %d, Y: %d\n", data.dx, data.dy);
+#    endif
+
+        mouse_report.x = data.dx;
+        mouse_report.y = data.dy;
+    }
+
+    return mouse_report;
+}
+
+// clang-format off
+const pointing_device_driver_t pointing_device_driver = {
+    .init         = adns5050_init,
+    .get_report   = adns5050_get_report,
+    .set_cpi      = adns5050_set_cpi,
+    .get_cpi      = adns5050_get_cpi,
+};
+// clang-format on
+#elif defined(POINTING_DEVICE_DRIVER_adns9800)
+
+report_mouse_t adns9800_get_report_driver(report_mouse_t mouse_report) {
+    report_adns9800_t sensor_report = adns9800_get_report();
+
+    int8_t clamped_x = constrain_hid(sensor_report.x);
+    int8_t clamped_y = constrain_hid(sensor_report.y);
+
+    mouse_report.x = clamped_x;
+    mouse_report.y = clamped_y;
+
+    return mouse_report;
+}
+
+// clang-format off
+const pointing_device_driver_t pointing_device_driver = {
+    .init       = adns9800_init,
+    .get_report = adns9800_get_report_driver,
+    .set_cpi    = adns9800_set_cpi,
+    .get_cpi    = adns9800_get_cpi
+};
+// clang-format on
+#elif defined(POINTING_DEVICE_DRIVER_analog_joystick)
+report_mouse_t analog_joystick_get_report(report_mouse_t mouse_report) {
+    report_analog_joystick_t data = analog_joystick_read();
+
+#    ifdef CONSOLE_ENABLE
+    if (debug_mouse) dprintf("Raw ] X: %d, Y: %d\n", data.x, data.y);
+#    endif
+
+    mouse_report.x = data.x;
+    mouse_report.y = data.y;
+
+    mouse_report.buttons = pointing_device_handle_buttons(mouse_report.buttons, data.button, POINTING_DEVICE_BUTTON1);
+
+    return mouse_report;
+}
+
+// clang-format off
+const pointing_device_driver_t pointing_device_driver = {
+    .init       = analog_joystick_init,
+    .get_report = analog_joystick_get_report,
+    .set_cpi    = NULL,
+    .get_cpi    = NULL
+};
+// clang-format on
+#elif defined(POINTING_DEVICE_DRIVER_cirque_pinnacle_i2c) || defined(POINTING_DEVICE_DRIVER_cirque_pinnacle_spi)
+#    ifndef CIRQUE_PINNACLE_TAPPING_TERM
+#        ifdef TAPPING_TERM_PER_KEY
+#            include "action.h"
+#            include "action_tapping.h"
+#            define CIRQUE_PINNACLE_TAPPING_TERM get_tapping_term(KC_BTN1, NULL)
+#        else
+#            ifdef TAPPING_TERM
+#                define CIRQUE_PINNACLE_TAPPING_TERM TAPPING_TERM
+#            else
+#                define CIRQUE_PINNACLE_TAPPING_TERM 200
+#            endif
+#        endif
+#    endif
+#    ifndef CIRQUE_PINNACLE_TOUCH_DEBOUNCE
+#        define CIRQUE_PINNACLE_TOUCH_DEBOUNCE (CIRQUE_PINNACLE_TAPPING_TERM * 8)
+#    endif
+
+report_mouse_t cirque_pinnacle_get_report(report_mouse_t mouse_report) {
+    pinnacle_data_t touchData = cirque_pinnacle_read_data();
+    static uint16_t x = 0, y = 0, mouse_timer = 0;
+    int8_t          report_x = 0, report_y = 0;
+    static bool     is_z_down = false;
+
+    cirque_pinnacle_scale_data(&touchData, cirque_pinnacle_get_scale(), cirque_pinnacle_get_scale());  // Scale coordinates to arbitrary X, Y resolution
+
+    if (x && y && touchData.xValue && touchData.yValue) {
+        report_x = (int8_t)(touchData.xValue - x);
+        report_y = (int8_t)(touchData.yValue - y);
+    }
+    x = touchData.xValue;
+    y = touchData.yValue;
+
+    if ((bool)touchData.zValue != is_z_down) {
+        is_z_down = (bool)touchData.zValue;
+        if (!touchData.zValue) {
+            if (timer_elapsed(mouse_timer) < CIRQUE_PINNACLE_TAPPING_TERM && mouse_timer != 0) {
+                mouse_report.buttons = pointing_device_handle_buttons(mouse_report.buttons, true, POINTING_DEVICE_BUTTON1);
+                pointing_device_set_report(mouse_report);
+                pointing_device_send();
+#    if TAP_CODE_DELAY > 0
+                wait_ms(TAP_CODE_DELAY);
+#    endif
+                mouse_report.buttons = pointing_device_handle_buttons(mouse_report.buttons, false, POINTING_DEVICE_BUTTON1);
+                pointing_device_set_report(mouse_report);
+                pointing_device_send();
+            }
+        }
+        mouse_timer = timer_read();
+    }
+    if (timer_elapsed(mouse_timer) > (CIRQUE_PINNACLE_TOUCH_DEBOUNCE)) {
+        mouse_timer = 0;
+    }
+    mouse_report.x = report_x;
+    mouse_report.y = report_y;
+
+    return mouse_report;
+}
+
+// clang-format off
+const pointing_device_driver_t pointing_device_driver = {
+    .init       = cirque_pinnacle_init,
+    .get_report = cirque_pinnacle_get_report,
+    .set_cpi    = cirque_pinnacle_set_scale,
+    .get_cpi    = cirque_pinnacle_get_scale
+};
+// clang-format on
+
+#elif defined(POINTING_DEVICE_DRIVER_pimoroni_trackball)
+report_mouse_t pimorono_trackball_get_report(report_mouse_t mouse_report) {
+    static fast_timer_t throttle      = 0;
+    static uint16_t     debounce      = 0;
+    static uint8_t      error_count   = 0;
+    pimoroni_data_t     pimoroni_data = {0};
+    static int16_t      x_offset = 0, y_offset = 0;
+
+    if (error_count < PIMORONI_TRACKBALL_ERROR_COUNT && timer_elapsed_fast(throttle) >= PIMORONI_TRACKBALL_INTERVAL_MS) {
+        i2c_status_t status = read_pimoroni_trackball(&pimoroni_data);
+
+        if (status == I2C_STATUS_SUCCESS) {
+            error_count = 0;
+
+            if (!(pimoroni_data.click & 128)) {
+                mouse_report.buttons = pointing_device_handle_buttons(mouse_report.buttons, false, POINTING_DEVICE_BUTTON1);
+                if (!debounce) {
+                    x_offset += pimoroni_trackball_get_offsets(pimoroni_data.right, pimoroni_data.left, PIMORONI_TRACKBALL_SCALE);
+                    y_offset += pimoroni_trackball_get_offsets(pimoroni_data.down, pimoroni_data.up, PIMORONI_TRACKBALL_SCALE);
+                    pimoroni_trackball_adapt_values(&mouse_report.x, &x_offset);
+                    pimoroni_trackball_adapt_values(&mouse_report.y, &y_offset);
+                } else {
+                    debounce--;
+                }
+            } else {
+                mouse_report.buttons = pointing_device_handle_buttons(mouse_report.buttons, true, POINTING_DEVICE_BUTTON1);
+                debounce             = PIMORONI_TRACKBALL_DEBOUNCE_CYCLES;
+            }
+        } else {
+            error_count++;
+        }
+        throttle = timer_read_fast();
+    }
+    return mouse_report;
+}
+
+// clang-format off
+const pointing_device_driver_t pointing_device_driver = {
+    .init       = pimironi_trackball_device_init,
+    .get_report = pimorono_trackball_get_report,
+    .set_cpi    = NULL,
+    .get_cpi    = NULL
+};
+// clang-format on
+#elif defined(POINTING_DEVICE_DRIVER_pmw3360)
+
+static void init(void) { pmw3360_init(); }
+
+report_mouse_t pmw3360_get_report(report_mouse_t mouse_report) {
+    report_pmw3360_t data        = pmw3360_read_burst();
+    static uint16_t  MotionStart = 0;  // Timer for accel, 0 is resting state
+
+    if (data.isOnSurface && data.isMotion) {
+        // Reset timer if stopped moving
+        if (!data.isMotion) {
+            if (MotionStart != 0) MotionStart = 0;
+            return mouse_report;
+        }
+
+        // Set timer if new motion
+        if ((MotionStart == 0) && data.isMotion) {
+#    ifdef CONSOLE_ENABLE
+            if (debug_mouse) dprintf("Starting motion.\n");
+#    endif
+            MotionStart = timer_read();
+        }
+        mouse_report.x = constrain_hid(data.dx);
+        mouse_report.y = constrain_hid(data.dy);
+    }
+
+    return mouse_report;
+}
+
+// clang-format off
+const pointing_device_driver_t pointing_device_driver = {
+    .init       = init,
+    .get_report = pmw3360_get_report,
+    .set_cpi    = pmw3360_set_cpi,
+    .get_cpi    = pmw3360_get_cpi
+};
+// clang-format on
+#else
+__attribute__((weak)) void           pointing_device_driver_init(void) {}
+__attribute__((weak)) report_mouse_t pointing_device_driver_get_report(report_mouse_t mouse_report) { return mouse_report; }
+__attribute__((weak)) uint16_t       pointing_device_driver_get_cpi(void) { return 0; }
+__attribute__((weak)) void           pointing_device_driver_set_cpi(uint16_t cpi) {}
+
+// clang-format off
+const pointing_device_driver_t pointing_device_driver = {
+    .init       = pointing_device_driver_init,
+    .get_report = pointing_device_driver_get_report,
+    .get_cpi    = pointing_device_driver_get_cpi,
+    .set_cpi    = pointing_device_driver_set_cpi
+};
+// clang-format on
+#endif
diff --git a/quantum/quantum.c b/quantum/quantum.c
index 0eca329f0..c7a3bb197 100644
--- a/quantum/quantum.c
+++ b/quantum/quantum.c
@@ -531,6 +531,10 @@ void suspend_power_down_quantum(void) {
 #    ifdef ST7565_ENABLE
     st7565_off();
 #    endif
+#    if defined(POINTING_DEVICE_ENABLE)
+    // run to ensure scanning occurs while suspended
+    pointing_device_task();
+#    endif
 #endif
 }
 
diff --git a/quantum/quantum.h b/quantum/quantum.h
index 9250f5acc..e6015adbe 100644
--- a/quantum/quantum.h
+++ b/quantum/quantum.h
@@ -204,6 +204,10 @@ extern layer_state_t layer_state;
 #    include "encoder.h"
 #endif
 
+#ifdef POINTING_DEVICE_ENABLE
+#    include "pointing_device.h"
+#endif
+
 // For tri-layer
 void          update_tri_layer(uint8_t layer1, uint8_t layer2, uint8_t layer3);
 layer_state_t update_tri_layer_state(layer_state_t state, uint8_t layer1, uint8_t layer2, uint8_t layer3);