Further refactoring of joystick feature (#18437)

4 files changed, 155 insertions, 144 deletions

diff --git a/quantum/joystick.c b/quantum/joystick.c
index 86b2c64036..d285dcdb5e 100644
--- a/quantum/joystick.c
+++ b/quantum/joystick.c
@@ -1,5 +1,24 @@
+/* Copyright 2022
+ *
+ * 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 "joystick.h"
 
+#include "analog.h"
+#include "wait.h"
+
 // clang-format off
 joystick_t joystick_status = {
     .buttons = {0},
@@ -15,12 +34,13 @@ joystick_t joystick_status = {
 // array defining the reading of analog values for each axis
 __attribute__((weak)) joystick_config_t joystick_axes[JOYSTICK_AXES_COUNT] = {};
 
-// to be implemented in the hid protocol library
-void send_joystick_packet(joystick_t *joystick);
+__attribute__((weak)) void joystick_task(void) {
+    joystick_read_axes();
+}
 
 void joystick_flush(void) {
     if ((joystick_status.status & JS_UPDATED) > 0) {
-        send_joystick_packet(&joystick_status);
+        host_joystick_send(&joystick_status);
         joystick_status.status &= ~JS_UPDATED;
     }
 }
@@ -36,3 +56,75 @@ void unregister_joystick_button(uint8_t button) {
     joystick_status.status |= JS_UPDATED;
     joystick_flush();
 }
+
+int16_t joystick_read_axis(uint8_t axis) {
+    // disable pull-up resistor
+    writePinLow(joystick_axes[axis].input_pin);
+
+    // if pin was a pull-up input, we need to uncharge it by turning it low
+    // before making it a low input
+    setPinOutput(joystick_axes[axis].input_pin);
+
+    wait_us(10);
+
+    if (joystick_axes[axis].output_pin != JS_VIRTUAL_AXIS) {
+        setPinOutput(joystick_axes[axis].output_pin);
+        writePinHigh(joystick_axes[axis].output_pin);
+    }
+
+    if (joystick_axes[axis].ground_pin != JS_VIRTUAL_AXIS) {
+        setPinOutput(joystick_axes[axis].ground_pin);
+        writePinLow(joystick_axes[axis].ground_pin);
+    }
+
+    wait_us(10);
+
+    setPinInput(joystick_axes[axis].input_pin);
+
+    wait_us(10);
+
+#if defined(ANALOG_JOYSTICK_ENABLE) && (defined(__AVR__) || defined(PROTOCOL_CHIBIOS))
+    int16_t axis_val = analogReadPin(joystick_axes[axis].input_pin);
+#else
+    // default to resting position
+    int16_t axis_val = joystick_axes[axis].mid_digit;
+#endif
+
+    // test the converted value against the lower range
+    int32_t ref        = joystick_axes[axis].mid_digit;
+    int32_t range      = joystick_axes[axis].min_digit;
+    int32_t ranged_val = ((axis_val - ref) * -JOYSTICK_RESOLUTION) / (range - ref);
+
+    if (ranged_val > 0) {
+        // the value is in the higher range
+        range      = joystick_axes[axis].max_digit;
+        ranged_val = ((axis_val - ref) * JOYSTICK_RESOLUTION) / (range - ref);
+    }
+
+    // clamp the result in the valid range
+    ranged_val = ranged_val < -JOYSTICK_RESOLUTION ? -JOYSTICK_RESOLUTION : ranged_val;
+    ranged_val = ranged_val > JOYSTICK_RESOLUTION ? JOYSTICK_RESOLUTION : ranged_val;
+
+    return ranged_val;
+}
+
+void joystick_read_axes() {
+#if JOYSTICK_AXES_COUNT > 0
+    for (int i = 0; i < JOYSTICK_AXES_COUNT; ++i) {
+        if (joystick_axes[i].input_pin == JS_VIRTUAL_AXIS) {
+            continue;
+        }
+
+        joystick_set_axis(i, joystick_read_axis(i));
+    }
+
+    joystick_flush();
+#endif
+}
+
+void joystick_set_axis(uint8_t axis, int16_t value) {
+    if (value != joystick_status.axes[axis]) {
+        joystick_status.axes[axis] = value;
+        joystick_status.status |= JS_UPDATED;
+    }
+}
diff --git a/quantum/joystick.h b/quantum/joystick.h
index 5d81b14ef2..ee966fdb1a 100644
--- a/quantum/joystick.h
+++ b/quantum/joystick.h
@@ -1,3 +1,19 @@
+/* Copyright 2022
+ *
+ * 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/>.
+ */
+
 #pragma once
 
 #include <stdint.h>
@@ -54,7 +70,10 @@ typedef struct {
 
 extern joystick_config_t joystick_axes[JOYSTICK_AXES_COUNT];
 
-enum joystick_status { JS_INITIALIZED = 1, JS_UPDATED = 2 };
+enum joystick_status {
+    JS_INITIALIZED = 1,
+    JS_UPDATED,
+};
 
 typedef struct {
     uint8_t buttons[(JOYSTICK_BUTTON_COUNT - 1) / 8 + 1];
@@ -65,7 +84,14 @@ typedef struct {
 
 extern joystick_t joystick_status;
 
+void joystick_task(void);
 void joystick_flush(void);
 
 void register_joystick_button(uint8_t button);
 void unregister_joystick_button(uint8_t button);
+
+int16_t joystick_read_axis(uint8_t axis);
+void    joystick_read_axes(void);
+void    joystick_set_axis(uint8_t axis, int16_t value);
+
+void host_joystick_send(joystick_t *joystick);
diff --git a/quantum/process_keycode/process_joystick.c b/quantum/process_keycode/process_joystick.c
index e867606074..af69d3aa05 100644
--- a/quantum/process_keycode/process_joystick.c
+++ b/quantum/process_keycode/process_joystick.c
@@ -1,10 +1,21 @@
-#include "joystick.h"
-#include "process_joystick.h"
-
-#include "analog.h"
+/* Copyright 2022
+ *
+ * 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 <string.h>
-#include <math.h>
+#include "process_joystick.h"
+#include "joystick.h"
 
 bool process_joystick(uint16_t keycode, keyrecord_t *record) {
     switch (keycode) {
@@ -18,132 +29,3 @@ bool process_joystick(uint16_t keycode, keyrecord_t *record) {
     }
     return true;
 }
-
-__attribute__((weak)) void joystick_task(void) {
-    if (process_joystick_analogread()) {
-        joystick_flush();
-    }
-}
-
-uint16_t savePinState(pin_t pin) {
-#ifdef __AVR__
-    uint8_t pinNumber = pin & 0xF;
-    return ((PORTx_ADDRESS(pin) >> pinNumber) & 0x1) << 1 | ((DDRx_ADDRESS(pin) >> pinNumber) & 0x1);
-#elif defined(PROTOCOL_CHIBIOS)
-    /*
-    The pin configuration is backed up in the following format :
- bit  15    9  8   7   6  5  4   3     2    1 0
-      |unused|ODR|IDR|PUPDR|OSPEEDR|OTYPER|MODER|
-    */
-    return ((PAL_PORT(pin)->MODER >> (2 * PAL_PAD(pin))) & 0x3) | (((PAL_PORT(pin)->OTYPER >> (1 * PAL_PAD(pin))) & 0x1) << 2) | (((PAL_PORT(pin)->OSPEEDR >> (2 * PAL_PAD(pin))) & 0x3) << 3) | (((PAL_PORT(pin)->PUPDR >> (2 * PAL_PAD(pin))) & 0x3) << 5) | (((PAL_PORT(pin)->IDR >> (1 * PAL_PAD(pin))) & 0x1) << 7) | (((PAL_PORT(pin)->ODR >> (1 * PAL_PAD(pin))) & 0x1) << 8);
-#else
-    return 0;
-#endif
-}
-
-void restorePinState(pin_t pin, uint16_t restoreState) {
-#if defined(PROTOCOL_LUFA)
-    uint8_t pinNumber  = pin & 0xF;
-    PORTx_ADDRESS(pin) = (PORTx_ADDRESS(pin) & ~_BV(pinNumber)) | (((restoreState >> 1) & 0x1) << pinNumber);
-    DDRx_ADDRESS(pin)  = (DDRx_ADDRESS(pin) & ~_BV(pinNumber)) | ((restoreState & 0x1) << pinNumber);
-#elif defined(PROTOCOL_CHIBIOS)
-    PAL_PORT(pin)->MODER   = (PAL_PORT(pin)->MODER & ~(0x3 << (2 * PAL_PAD(pin)))) | (restoreState & 0x3) << (2 * PAL_PAD(pin));
-    PAL_PORT(pin)->OTYPER  = (PAL_PORT(pin)->OTYPER & ~(0x1 << (1 * PAL_PAD(pin)))) | ((restoreState >> 2) & 0x1) << (1 * PAL_PAD(pin));
-    PAL_PORT(pin)->OSPEEDR = (PAL_PORT(pin)->OSPEEDR & ~(0x3 << (2 * PAL_PAD(pin)))) | ((restoreState >> 3) & 0x3) << (2 * PAL_PAD(pin));
-    PAL_PORT(pin)->PUPDR   = (PAL_PORT(pin)->PUPDR & ~(0x3 << (2 * PAL_PAD(pin)))) | ((restoreState >> 5) & 0x3) << (2 * PAL_PAD(pin));
-    PAL_PORT(pin)->IDR     = (PAL_PORT(pin)->IDR & ~(0x1 << (1 * PAL_PAD(pin)))) | ((restoreState >> 7) & 0x1) << (1 * PAL_PAD(pin));
-    PAL_PORT(pin)->ODR     = (PAL_PORT(pin)->ODR & ~(0x1 << (1 * PAL_PAD(pin)))) | ((restoreState >> 8) & 0x1) << (1 * PAL_PAD(pin));
-#else
-    return;
-#endif
-}
-
-__attribute__((weak)) bool process_joystick_analogread() {
-    return process_joystick_analogread_quantum();
-}
-
-bool process_joystick_analogread_quantum() {
-#if JOYSTICK_AXES_COUNT > 0
-    for (int axis_index = 0; axis_index < JOYSTICK_AXES_COUNT; ++axis_index) {
-        if (joystick_axes[axis_index].input_pin == JS_VIRTUAL_AXIS) {
-            continue;
-        }
-
-        // save previous input pin status as well
-        uint16_t inputSavedState = savePinState(joystick_axes[axis_index].input_pin);
-
-        // disable pull-up resistor
-        writePinLow(joystick_axes[axis_index].input_pin);
-
-        // if pin was a pull-up input, we need to uncharge it by turning it low
-        // before making it a low input
-        setPinOutput(joystick_axes[axis_index].input_pin);
-
-        wait_us(10);
-
-        // save and apply output pin status
-        uint16_t outputSavedState = 0;
-        if (joystick_axes[axis_index].output_pin != JS_VIRTUAL_AXIS) {
-            // save previous output pin status
-            outputSavedState = savePinState(joystick_axes[axis_index].output_pin);
-
-            setPinOutput(joystick_axes[axis_index].output_pin);
-            writePinHigh(joystick_axes[axis_index].output_pin);
-        }
-
-        uint16_t groundSavedState = 0;
-        if (joystick_axes[axis_index].ground_pin != JS_VIRTUAL_AXIS) {
-            // save previous output pin status
-            groundSavedState = savePinState(joystick_axes[axis_index].ground_pin);
-
-            setPinOutput(joystick_axes[axis_index].ground_pin);
-            writePinLow(joystick_axes[axis_index].ground_pin);
-        }
-
-        wait_us(10);
-
-        setPinInput(joystick_axes[axis_index].input_pin);
-
-        wait_us(10);
-
-#    if defined(ANALOG_JOYSTICK_ENABLE) && (defined(__AVR__) || defined(PROTOCOL_CHIBIOS))
-        int16_t axis_val = analogReadPin(joystick_axes[axis_index].input_pin);
-#    else
-        // default to resting position
-        int16_t axis_val = joystick_axes[axis_index].mid_digit;
-#    endif
-
-        // test the converted value against the lower range
-        int32_t ref        = joystick_axes[axis_index].mid_digit;
-        int32_t range      = joystick_axes[axis_index].min_digit;
-        int32_t ranged_val = ((axis_val - ref) * -JOYSTICK_RESOLUTION) / (range - ref);
-
-        if (ranged_val > 0) {
-            // the value is in the higher range
-            range      = joystick_axes[axis_index].max_digit;
-            ranged_val = ((axis_val - ref) * JOYSTICK_RESOLUTION) / (range - ref);
-        }
-
-        // clamp the result in the valid range
-        ranged_val = ranged_val < -JOYSTICK_RESOLUTION ? -JOYSTICK_RESOLUTION : ranged_val;
-        ranged_val = ranged_val > JOYSTICK_RESOLUTION ? JOYSTICK_RESOLUTION : ranged_val;
-
-        if (ranged_val != joystick_status.axes[axis_index]) {
-            joystick_status.axes[axis_index] = ranged_val;
-            joystick_status.status |= JS_UPDATED;
-        }
-
-        // restore output, ground and input status
-        if (joystick_axes[axis_index].output_pin != JS_VIRTUAL_AXIS) {
-            restorePinState(joystick_axes[axis_index].output_pin, outputSavedState);
-        }
-        if (joystick_axes[axis_index].ground_pin != JS_VIRTUAL_AXIS) {
-            restorePinState(joystick_axes[axis_index].ground_pin, groundSavedState);
-        }
-
-        restorePinState(joystick_axes[axis_index].input_pin, inputSavedState);
-    }
-
-#endif
-    return true;
-}
diff --git a/quantum/process_keycode/process_joystick.h b/quantum/process_keycode/process_joystick.h
index 7a8b82913a..1fb8757708 100644
--- a/quantum/process_keycode/process_joystick.h
+++ b/quantum/process_keycode/process_joystick.h
@@ -1,11 +1,22 @@
+/* Copyright 2022
+ *
+ * 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/>.
+ */
+
 #pragma once
 
 #include <stdint.h>
 #include "quantum.h"
 
 bool process_joystick(uint16_t keycode, keyrecord_t *record);
-
-void joystick_task(void);
-
-bool process_joystick_analogread(void);
-bool process_joystick_analogread_quantum(void);