]> git.donarmstrong.com Git - tmk_firmware.git/blobdiff - common/mousekey.c
Remove MCU dependent code from common/keyboard.c
[tmk_firmware.git] / common / mousekey.c
index 6fe8e2d2658b9c6a0744b0d1a8871d0847313955..23469476e264fd8bacdc56682dcf2e23c5a84c2b 100644 (file)
@@ -16,7 +16,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include <stdint.h>
-#include <util/delay.h>
 #include "keycode.h"
 #include "host.h"
 #include "timer.h"
@@ -25,133 +24,173 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include "mousekey.h"
 
 
-static report_mouse_t report;
 
+static report_mouse_t mouse_report = {};
 static uint8_t mousekey_repeat =  0;
+static uint8_t mousekey_accel = 0;
 
 static void mousekey_debug(void);
 
 
 /*
- * TODO: fix acceleration algorithm
- * see wikipedia http://en.wikipedia.org/wiki/Mouse_keys
+ * Mouse keys  acceleration algorithm
+ *  http://en.wikipedia.org/wiki/Mouse_keys
+ *
+ *  speed = delta * max_speed * (repeat / time_to_max)**((1000+curve)/1000)
  */
-#ifndef MOUSEKEY_DELAY_TIME
-#   define MOUSEKEY_DELAY_TIME 100
-#endif
+/* milliseconds between the initial key press and first repeated motion event (0-2550) */
+uint8_t mk_delay = MOUSEKEY_DELAY/10;
+/* milliseconds between repeated motion events (0-255) */
+uint8_t mk_interval = MOUSEKEY_INTERVAL;
+/* steady speed (in action_delta units) applied each event (0-255) */
+uint8_t mk_max_speed = MOUSEKEY_MAX_SPEED;
+/* number of events (count) accelerating to steady speed (0-255) */
+uint8_t mk_time_to_max = MOUSEKEY_TIME_TO_MAX;
+/* ramp used to reach maximum pointer speed (NOT SUPPORTED) */
+//int8_t mk_curve = 0;
+/* wheel params */
+uint8_t mk_wheel_max_speed = MOUSEKEY_WHEEL_MAX_SPEED;
+uint8_t mk_wheel_time_to_max = MOUSEKEY_WHEEL_TIME_TO_MAX;
 
-#define MOUSEKEY_MOVE_INIT      5
-#define MOUSEKEY_WHEEL_INIT     1
-#define MOUSEKEY_MOVE_ACCEL     5
-#define MOUSEKEY_WHEEL_ACCEL    1
 
 static uint16_t last_timer = 0;
 
-// acceleration parameters
-//uint8_t mousekey_move_unit = 2;
-//uint8_t mousekey_resolution = 5;
 
-
-static inline uint8_t move_unit(void)
+static uint8_t move_unit(void)
 {
-    uint16_t unit = MOUSEKEY_MOVE_INIT + MOUSEKEY_MOVE_ACCEL * mousekey_repeat;
-    return (unit > 63 ? 63 : unit);
+    uint16_t unit;
+    if (mousekey_accel & (1<<0)) {
+        unit = (MOUSEKEY_MOVE_DELTA * mk_max_speed)/4;
+    } else if (mousekey_accel & (1<<1)) {
+        unit = (MOUSEKEY_MOVE_DELTA * mk_max_speed)/2;
+    } else if (mousekey_accel & (1<<2)) {
+        unit = (MOUSEKEY_MOVE_DELTA * mk_max_speed);
+    } else if (mousekey_repeat == 0) {
+        unit = MOUSEKEY_MOVE_DELTA;
+    } else if (mousekey_repeat >= mk_time_to_max) {
+        unit = MOUSEKEY_MOVE_DELTA * mk_max_speed;
+    } else {
+        unit = (MOUSEKEY_MOVE_DELTA * mk_max_speed * mousekey_repeat) / mk_time_to_max;
+    }
+    return (unit > MOUSEKEY_MOVE_MAX ? MOUSEKEY_MOVE_MAX : (unit == 0 ? 1 : unit));
 }
 
-static inline uint8_t wheel_unit(void)
+static uint8_t wheel_unit(void)
 {
-    uint16_t unit = MOUSEKEY_WHEEL_INIT + MOUSEKEY_WHEEL_ACCEL * mousekey_repeat;
-    return (unit > 15 ? 15 : unit);
+    uint16_t unit;
+    if (mousekey_accel & (1<<0)) {
+        unit = (MOUSEKEY_WHEEL_DELTA * mk_wheel_max_speed)/4;
+    } else if (mousekey_accel & (1<<1)) {
+        unit = (MOUSEKEY_WHEEL_DELTA * mk_wheel_max_speed)/2;
+    } else if (mousekey_accel & (1<<2)) {
+        unit = (MOUSEKEY_WHEEL_DELTA * mk_wheel_max_speed);
+    } else if (mousekey_repeat == 0) {
+        unit = MOUSEKEY_WHEEL_DELTA;
+    } else if (mousekey_repeat >= mk_wheel_time_to_max) {
+        unit = MOUSEKEY_WHEEL_DELTA * mk_wheel_max_speed;
+    } else {
+        unit = (MOUSEKEY_WHEEL_DELTA * mk_wheel_max_speed * mousekey_repeat) / mk_wheel_time_to_max;
+    }
+    return (unit > MOUSEKEY_WHEEL_MAX ? MOUSEKEY_WHEEL_MAX : (unit == 0 ? 1 : unit));
 }
 
 void mousekey_task(void)
 {
-    if (timer_elapsed(last_timer) < MOUSEKEY_DELAY_TIME)
+    if (timer_elapsed(last_timer) < (mousekey_repeat ? mk_interval : mk_delay*10))
         return;
 
-    if (report.x == 0 && report.y == 0 && report.v == 0 && report.h == 0)
+    if (mouse_report.x == 0 && mouse_report.y == 0 && mouse_report.v == 0 && mouse_report.h == 0)
         return;
 
     if (mousekey_repeat != UINT8_MAX)
         mousekey_repeat++;
 
 
-    if (report.x > 0) report.x = move_unit();
-    if (report.x < 0) report.x = move_unit() * -1;
-    if (report.y > 0) report.y = move_unit();
-    if (report.y < 0) report.y = move_unit() * -1;
+    if (mouse_report.x > 0) mouse_report.x = move_unit();
+    if (mouse_report.x < 0) mouse_report.x = move_unit() * -1;
+    if (mouse_report.y > 0) mouse_report.y = move_unit();
+    if (mouse_report.y < 0) mouse_report.y = move_unit() * -1;
 
-    if (report.x && report.y) {
-        report.x *= 0.7;
-        report.y *= 0.7;
+    /* diagonal move [1/sqrt(2) = 0.7] */
+    if (mouse_report.x && mouse_report.y) {
+        mouse_report.x *= 0.7;
+        mouse_report.y *= 0.7;
     }
 
-    if (report.v > 0) report.v = wheel_unit();
-    if (report.v < 0) report.v = wheel_unit() * -1;
-    if (report.h > 0) report.h = wheel_unit();
-    if (report.h < 0) report.h = wheel_unit() * -1;
+    if (mouse_report.v > 0) mouse_report.v = wheel_unit();
+    if (mouse_report.v < 0) mouse_report.v = wheel_unit() * -1;
+    if (mouse_report.h > 0) mouse_report.h = wheel_unit();
+    if (mouse_report.h < 0) mouse_report.h = wheel_unit() * -1;
 
     mousekey_send();
 }
 
 void mousekey_on(uint8_t code)
 {
-    if      (code == KC_MS_UP)       report.y = MOUSEKEY_MOVE_INIT * -1;
-    else if (code == KC_MS_DOWN)     report.y = MOUSEKEY_MOVE_INIT;
-    else if (code == KC_MS_LEFT)     report.x = MOUSEKEY_MOVE_INIT * -1;
-    else if (code == KC_MS_RIGHT)    report.x = MOUSEKEY_MOVE_INIT;
-    else if (code == KC_MS_WH_UP)    report.v = MOUSEKEY_WHEEL_INIT;
-    else if (code == KC_MS_WH_DOWN)  report.v = MOUSEKEY_WHEEL_INIT * -1;
-    else if (code == KC_MS_WH_LEFT)  report.h = MOUSEKEY_WHEEL_INIT * -1;
-    else if (code == KC_MS_WH_RIGHT) report.h = MOUSEKEY_WHEEL_INIT;
-    else if (code == KC_MS_BTN1)     report.buttons |= MOUSE_BTN1;
-    else if (code == KC_MS_BTN2)     report.buttons |= MOUSE_BTN2;
-    else if (code == KC_MS_BTN3)     report.buttons |= MOUSE_BTN3;
-    else if (code == KC_MS_BTN4)     report.buttons |= MOUSE_BTN4;
-    else if (code == KC_MS_BTN5)     report.buttons |= MOUSE_BTN5;
+    if      (code == KC_MS_UP)       mouse_report.y = move_unit() * -1;
+    else if (code == KC_MS_DOWN)     mouse_report.y = move_unit();
+    else if (code == KC_MS_LEFT)     mouse_report.x = move_unit() * -1;
+    else if (code == KC_MS_RIGHT)    mouse_report.x = move_unit();
+    else if (code == KC_MS_WH_UP)    mouse_report.v = wheel_unit();
+    else if (code == KC_MS_WH_DOWN)  mouse_report.v = wheel_unit() * -1;
+    else if (code == KC_MS_WH_LEFT)  mouse_report.h = wheel_unit() * -1;
+    else if (code == KC_MS_WH_RIGHT) mouse_report.h = wheel_unit();
+    else if (code == KC_MS_BTN1)     mouse_report.buttons |= MOUSE_BTN1;
+    else if (code == KC_MS_BTN2)     mouse_report.buttons |= MOUSE_BTN2;
+    else if (code == KC_MS_BTN3)     mouse_report.buttons |= MOUSE_BTN3;
+    else if (code == KC_MS_BTN4)     mouse_report.buttons |= MOUSE_BTN4;
+    else if (code == KC_MS_BTN5)     mouse_report.buttons |= MOUSE_BTN5;
+    else if (code == KC_MS_ACCEL0)   mousekey_accel |= (1<<0);
+    else if (code == KC_MS_ACCEL1)   mousekey_accel |= (1<<1);
+    else if (code == KC_MS_ACCEL2)   mousekey_accel |= (1<<2);
 }
 
 void mousekey_off(uint8_t code)
 {
-    if      (code == KC_MS_UP       && report.y < 0) report.y = 0;
-    else if (code == KC_MS_DOWN     && report.y > 0) report.y = 0;
-    else if (code == KC_MS_LEFT     && report.x < 0) report.x = 0;
-    else if (code == KC_MS_RIGHT    && report.x > 0) report.x = 0;
-    else if (code == KC_MS_WH_UP    && report.v > 0) report.v = 0;
-    else if (code == KC_MS_WH_DOWN  && report.v < 0) report.v = 0;
-    else if (code == KC_MS_WH_LEFT  && report.h < 0) report.h = 0;
-    else if (code == KC_MS_WH_RIGHT && report.h > 0) report.h = 0;
-    else if (code == KC_MS_BTN1)                     report.buttons &= ~MOUSE_BTN1;
-    else if (code == KC_MS_BTN2)                     report.buttons &= ~MOUSE_BTN2;
-    else if (code == KC_MS_BTN3)                     report.buttons &= ~MOUSE_BTN3;
-    else if (code == KC_MS_BTN4)                     report.buttons &= ~MOUSE_BTN4;
-    else if (code == KC_MS_BTN5)                     report.buttons &= ~MOUSE_BTN5;
-
-    if (report.x == 0 && report.y == 0 && report.v == 0 && report.h == 0)
+    if      (code == KC_MS_UP       && mouse_report.y < 0) mouse_report.y = 0;
+    else if (code == KC_MS_DOWN     && mouse_report.y > 0) mouse_report.y = 0;
+    else if (code == KC_MS_LEFT     && mouse_report.x < 0) mouse_report.x = 0;
+    else if (code == KC_MS_RIGHT    && mouse_report.x > 0) mouse_report.x = 0;
+    else if (code == KC_MS_WH_UP    && mouse_report.v > 0) mouse_report.v = 0;
+    else if (code == KC_MS_WH_DOWN  && mouse_report.v < 0) mouse_report.v = 0;
+    else if (code == KC_MS_WH_LEFT  && mouse_report.h < 0) mouse_report.h = 0;
+    else if (code == KC_MS_WH_RIGHT && mouse_report.h > 0) mouse_report.h = 0;
+    else if (code == KC_MS_BTN1) mouse_report.buttons &= ~MOUSE_BTN1;
+    else if (code == KC_MS_BTN2) mouse_report.buttons &= ~MOUSE_BTN2;
+    else if (code == KC_MS_BTN3) mouse_report.buttons &= ~MOUSE_BTN3;
+    else if (code == KC_MS_BTN4) mouse_report.buttons &= ~MOUSE_BTN4;
+    else if (code == KC_MS_BTN5) mouse_report.buttons &= ~MOUSE_BTN5;
+    else if (code == KC_MS_ACCEL0) mousekey_accel &= ~(1<<0);
+    else if (code == KC_MS_ACCEL1) mousekey_accel &= ~(1<<1);
+    else if (code == KC_MS_ACCEL2) mousekey_accel &= ~(1<<2);
+
+    if (mouse_report.x == 0 && mouse_report.y == 0 && mouse_report.v == 0 && mouse_report.h == 0)
         mousekey_repeat = 0;
 }
 
 void mousekey_send(void)
 {
     mousekey_debug();
-    host_mouse_send(&report);
+    host_mouse_send(&mouse_report);
     last_timer = timer_read();
 }
 
 void mousekey_clear(void)
 {
-    report = (report_mouse_t){};
+    mouse_report = (report_mouse_t){};
+    mousekey_repeat = 0;
+    mousekey_accel = 0;
 }
 
 static void mousekey_debug(void)
 {
     if (!debug_mouse) return;
-    print("mousekey [btn|x y v h]rep: [");
-    phex(report.buttons); print("|");
-    phex(report.x); print(" ");
-    phex(report.y); print(" ");
-    phex(report.v); print(" ");
-    phex(report.h); print("]");
-    phex(mousekey_repeat);
-    print("\n");
+    print("mousekey [btn|x y v h](rep/acl): [");
+    phex(mouse_report.buttons); print("|");
+    print_decs(mouse_report.x); print(" ");
+    print_decs(mouse_report.y); print(" ");
+    print_decs(mouse_report.v); print(" ");
+    print_decs(mouse_report.h); print("](");
+    print_dec(mousekey_repeat); print("/");
+    print_dec(mousekey_accel); print(")\n");
 }