tmk_core/common/mousekey.c

   1 /*
   2 Copyright 2011 Jun Wako <wakojun@gmail.com>
   3
   4 This program is free software: you can redistribute it and/or modify
   5 it under the terms of the GNU General Public License as published by
   6 the Free Software Foundation, either version 2 of the License, or
   7 (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 */
  17
  18 #include <stdint.h>
  19 #include "keycode.h"
  20 #include "host.h"
  21 #include "timer.h"
  22 #include "print.h"
  23 #include "debug.h"
  24 #include "mousekey.h"
  25
  26 inline int8_t times_inv_sqrt2(int8_t x) {
  27     // 181/256 is pretty close to 1/sqrt(2)
  28     // 0.70703125                 0.707106781
  29     // 1 too small for x=99 and x=198
  30     // This ends up being a mult and discard lower 8 bits
  31     return (x * 181) >> 8;
  32 }
  33
  34 static report_mouse_t mouse_report = {0};
  35 static void           mousekey_debug(void);
  36 static uint8_t        mousekey_accel  = 0;
  37 static uint8_t        mousekey_repeat = 0;
  38 static uint16_t       last_timer      = 0;
  39
  40 #ifndef MK_3_SPEED
  41
  42 static uint16_t last_timer_c = 0;
  43 static uint16_t last_timer_w = 0;
  44
  45 /*
  46  * Mouse keys  acceleration algorithm
  47  *  http://en.wikipedia.org/wiki/Mouse_keys
  48  *
  49  *  speed = delta * max_speed * (repeat / time_to_max)**((1000+curve)/1000)
  50  */
  51 /* milliseconds between the initial key press and first repeated motion event (0-2550) */
  52 uint8_t mk_delay = MOUSEKEY_DELAY / 10;
  53 /* milliseconds between repeated motion events (0-255) */
  54 uint8_t mk_interval = MOUSEKEY_INTERVAL;
  55 /* steady speed (in action_delta units) applied each event (0-255) */
  56 uint8_t mk_max_speed = MOUSEKEY_MAX_SPEED;
  57 /* number of events (count) accelerating to steady speed (0-255) */
  58 uint8_t mk_time_to_max = MOUSEKEY_TIME_TO_MAX;
  59 /* ramp used to reach maximum pointer speed (NOT SUPPORTED) */
  60 // int8_t mk_curve = 0;
  61 /* wheel params */
  62 /* milliseconds between the initial key press and first repeated motion event (0-2550) */
  63 uint8_t mk_wheel_delay = MOUSEKEY_WHEEL_DELAY / 10;
  64 /* milliseconds between repeated motion events (0-255) */
  65 uint8_t mk_wheel_interval    = MOUSEKEY_WHEEL_INTERVAL;
  66 uint8_t mk_wheel_max_speed   = MOUSEKEY_WHEEL_MAX_SPEED;
  67 uint8_t mk_wheel_time_to_max = MOUSEKEY_WHEEL_TIME_TO_MAX;
  68
  69 static uint8_t move_unit(void) {
  70     uint16_t unit;
  71     if (mousekey_accel & (1 << 0)) {
  72         unit = (MOUSEKEY_MOVE_DELTA * mk_max_speed) / 4;
  73     } else if (mousekey_accel & (1 << 1)) {
  74         unit = (MOUSEKEY_MOVE_DELTA * mk_max_speed) / 2;
  75     } else if (mousekey_accel & (1 << 2)) {
  76         unit = (MOUSEKEY_MOVE_DELTA * mk_max_speed);
  77     } else if (mousekey_repeat == 0) {
  78         unit = MOUSEKEY_MOVE_DELTA;
  79     } else if (mousekey_repeat >= mk_time_to_max) {
  80         unit = MOUSEKEY_MOVE_DELTA * mk_max_speed;
  81     } else {
  82         unit = (MOUSEKEY_MOVE_DELTA * mk_max_speed * mousekey_repeat) / mk_time_to_max;
  83     }
  84     return (unit > MOUSEKEY_MOVE_MAX ? MOUSEKEY_MOVE_MAX : (unit == 0 ? 1 : unit));
  85 }
  86
  87 static uint8_t wheel_unit(void) {
  88     uint16_t unit;
  89     if (mousekey_accel & (1 << 0)) {
  90         unit = (MOUSEKEY_WHEEL_DELTA * mk_wheel_max_speed) / 4;
  91     } else if (mousekey_accel & (1 << 1)) {
  92         unit = (MOUSEKEY_WHEEL_DELTA * mk_wheel_max_speed) / 2;
  93     } else if (mousekey_accel & (1 << 2)) {
  94         unit = (MOUSEKEY_WHEEL_DELTA * mk_wheel_max_speed);
  95     } else if (mousekey_repeat == 0) {
  96         unit = MOUSEKEY_WHEEL_DELTA;
  97     } else if (mousekey_repeat >= mk_wheel_time_to_max) {
  98         unit = MOUSEKEY_WHEEL_DELTA * mk_wheel_max_speed;
  99     } else {
 100         unit = (MOUSEKEY_WHEEL_DELTA * mk_wheel_max_speed * mousekey_repeat) / mk_wheel_time_to_max;
 101     }
 102     return (unit > MOUSEKEY_WHEEL_MAX ? MOUSEKEY_WHEEL_MAX : (unit == 0 ? 1 : unit));
 103 }
 104
 105 void mousekey_task(void) {
 106     // report cursor and scroll movement independently
 107     report_mouse_t const tmpmr = mouse_report;
 108     if ((mouse_report.x || mouse_report.y) && timer_elapsed(last_timer_c) > (mousekey_repeat ? mk_interval : mk_delay * 10)) {
 109         if (mousekey_repeat != UINT8_MAX) mousekey_repeat++;
 110         mouse_report.v = 0;
 111         mouse_report.h = 0;
 112         if (mouse_report.x > 0) mouse_report.x = move_unit();
 113         if (mouse_report.x < 0) mouse_report.x = move_unit() * -1;
 114         if (mouse_report.y > 0) mouse_report.y = move_unit();
 115         if (mouse_report.y < 0) mouse_report.y = move_unit() * -1;
 116         /* diagonal move [1/sqrt(2)] */
 117         if (mouse_report.x && mouse_report.y) {
 118             mouse_report.x = times_inv_sqrt2(mouse_report.x);
 119             if (mouse_report.x == 0) {
 120                 mouse_report.x = 1;
 121             }
 122             mouse_report.y = times_inv_sqrt2(mouse_report.y);
 123             if (mouse_report.y == 0) {
 124                 mouse_report.y = 1;
 125             }
 126         }
 127         mousekey_send();
 128         last_timer_c = last_timer;
 129         mouse_report = tmpmr;
 130     }
 131     if ((mouse_report.v || mouse_report.h) && timer_elapsed(last_timer_w) > (mousekey_repeat ? mk_wheel_interval : mk_wheel_delay * 10)) {
 132         if (mousekey_repeat != UINT8_MAX) mousekey_repeat++;
 133         mouse_report.x = 0;
 134         mouse_report.y = 0;
 135         if (mouse_report.v > 0) mouse_report.v = wheel_unit();
 136         if (mouse_report.v < 0) mouse_report.v = wheel_unit() * -1;
 137         if (mouse_report.h > 0) mouse_report.h = wheel_unit();
 138         if (mouse_report.h < 0) mouse_report.h = wheel_unit() * -1;
 139         /* diagonal move [1/sqrt(2)] */
 140         if (mouse_report.v && mouse_report.h) {
 141             mouse_report.v = times_inv_sqrt2(mouse_report.v);
 142             if (mouse_report.v == 0) {
 143                 mouse_report.v = 1;
 144             }
 145             mouse_report.h = times_inv_sqrt2(mouse_report.h);
 146             if (mouse_report.h == 0) {
 147                 mouse_report.h = 1;
 148             }
 149         }
 150         mousekey_send();
 151         last_timer_w = last_timer;
 152         mouse_report = tmpmr;
 153     }
 154 }
 155
 156 void mousekey_on(uint8_t code) {
 157     if (code == KC_MS_UP)
 158         mouse_report.y = move_unit() * -1;
 159     else if (code == KC_MS_DOWN)
 160         mouse_report.y = move_unit();
 161     else if (code == KC_MS_LEFT)
 162         mouse_report.x = move_unit() * -1;
 163     else if (code == KC_MS_RIGHT)
 164         mouse_report.x = move_unit();
 165     else if (code == KC_MS_WH_UP)
 166         mouse_report.v = wheel_unit();
 167     else if (code == KC_MS_WH_DOWN)
 168         mouse_report.v = wheel_unit() * -1;
 169     else if (code == KC_MS_WH_LEFT)
 170         mouse_report.h = wheel_unit() * -1;
 171     else if (code == KC_MS_WH_RIGHT)
 172         mouse_report.h = wheel_unit();
 173     else if (code == KC_MS_BTN1)
 174         mouse_report.buttons |= MOUSE_BTN1;
 175     else if (code == KC_MS_BTN2)
 176         mouse_report.buttons |= MOUSE_BTN2;
 177     else if (code == KC_MS_BTN3)
 178         mouse_report.buttons |= MOUSE_BTN3;
 179     else if (code == KC_MS_BTN4)
 180         mouse_report.buttons |= MOUSE_BTN4;
 181     else if (code == KC_MS_BTN5)
 182         mouse_report.buttons |= MOUSE_BTN5;
 183     else if (code == KC_MS_ACCEL0)
 184         mousekey_accel |= (1 << 0);
 185     else if (code == KC_MS_ACCEL1)
 186         mousekey_accel |= (1 << 1);
 187     else if (code == KC_MS_ACCEL2)
 188         mousekey_accel |= (1 << 2);
 189 }
 190
 191 void mousekey_off(uint8_t code) {
 192     if (code == KC_MS_UP && mouse_report.y < 0)
 193         mouse_report.y = 0;
 194     else if (code == KC_MS_DOWN && mouse_report.y > 0)
 195         mouse_report.y = 0;
 196     else if (code == KC_MS_LEFT && mouse_report.x < 0)
 197         mouse_report.x = 0;
 198     else if (code == KC_MS_RIGHT && mouse_report.x > 0)
 199         mouse_report.x = 0;
 200     else if (code == KC_MS_WH_UP && mouse_report.v > 0)
 201         mouse_report.v = 0;
 202     else if (code == KC_MS_WH_DOWN && mouse_report.v < 0)
 203         mouse_report.v = 0;
 204     else if (code == KC_MS_WH_LEFT && mouse_report.h < 0)
 205         mouse_report.h = 0;
 206     else if (code == KC_MS_WH_RIGHT && mouse_report.h > 0)
 207         mouse_report.h = 0;
 208     else if (code == KC_MS_BTN1)
 209         mouse_report.buttons &= ~MOUSE_BTN1;
 210     else if (code == KC_MS_BTN2)
 211         mouse_report.buttons &= ~MOUSE_BTN2;
 212     else if (code == KC_MS_BTN3)
 213         mouse_report.buttons &= ~MOUSE_BTN3;
 214     else if (code == KC_MS_BTN4)
 215         mouse_report.buttons &= ~MOUSE_BTN4;
 216     else if (code == KC_MS_BTN5)
 217         mouse_report.buttons &= ~MOUSE_BTN5;
 218     else if (code == KC_MS_ACCEL0)
 219         mousekey_accel &= ~(1 << 0);
 220     else if (code == KC_MS_ACCEL1)
 221         mousekey_accel &= ~(1 << 1);
 222     else if (code == KC_MS_ACCEL2)
 223         mousekey_accel &= ~(1 << 2);
 224     if (mouse_report.x == 0 && mouse_report.y == 0 && mouse_report.v == 0 && mouse_report.h == 0) mousekey_repeat = 0;
 225 }
 226
 227 #else /* #ifndef MK_3_SPEED */
 228
 229 enum { mkspd_unmod, mkspd_0, mkspd_1, mkspd_2, mkspd_COUNT };
 230 #    ifndef MK_MOMENTARY_ACCEL
 231 static uint8_t  mk_speed                 = mkspd_1;
 232 #    else
 233 static uint8_t mk_speed      = mkspd_unmod;
 234 static uint8_t mkspd_DEFAULT = mkspd_unmod;
 235 #    endif
 236 static uint16_t last_timer_c             = 0;
 237 static uint16_t last_timer_w             = 0;
 238 uint16_t        c_offsets[mkspd_COUNT]   = {MK_C_OFFSET_UNMOD, MK_C_OFFSET_0, MK_C_OFFSET_1, MK_C_OFFSET_2};
 239 uint16_t        c_intervals[mkspd_COUNT] = {MK_C_INTERVAL_UNMOD, MK_C_INTERVAL_0, MK_C_INTERVAL_1, MK_C_INTERVAL_2};
 240 uint16_t        w_offsets[mkspd_COUNT]   = {MK_W_OFFSET_UNMOD, MK_W_OFFSET_0, MK_W_OFFSET_1, MK_W_OFFSET_2};
 241 uint16_t        w_intervals[mkspd_COUNT] = {MK_W_INTERVAL_UNMOD, MK_W_INTERVAL_0, MK_W_INTERVAL_1, MK_W_INTERVAL_2};
 242
 243 void mousekey_task(void) {
 244     // report cursor and scroll movement independently
 245     report_mouse_t const tmpmr = mouse_report;
 246     if ((mouse_report.x || mouse_report.y) && timer_elapsed(last_timer_c) > c_intervals[mk_speed]) {
 247         mouse_report.h = 0;
 248         mouse_report.v = 0;
 249         mousekey_send();
 250         last_timer_c = last_timer;
 251         mouse_report = tmpmr;
 252     }
 253     if ((mouse_report.h || mouse_report.v) && timer_elapsed(last_timer_w) > w_intervals[mk_speed]) {
 254         mouse_report.x = 0;
 255         mouse_report.y = 0;
 256         mousekey_send();
 257         last_timer_w = last_timer;
 258         mouse_report = tmpmr;
 259     }
 260 }
 261
 262 void adjust_speed(void) {
 263     uint16_t const c_offset = c_offsets[mk_speed];
 264     uint16_t const w_offset = w_offsets[mk_speed];
 265     if (mouse_report.x > 0) mouse_report.x = c_offset;
 266     if (mouse_report.x < 0) mouse_report.x = c_offset * -1;
 267     if (mouse_report.y > 0) mouse_report.y = c_offset;
 268     if (mouse_report.y < 0) mouse_report.y = c_offset * -1;
 269     if (mouse_report.h > 0) mouse_report.h = w_offset;
 270     if (mouse_report.h < 0) mouse_report.h = w_offset * -1;
 271     if (mouse_report.v > 0) mouse_report.v = w_offset;
 272     if (mouse_report.v < 0) mouse_report.v = w_offset * -1;
 273     // adjust for diagonals
 274     if (mouse_report.x && mouse_report.y) {
 275         mouse_report.x = times_inv_sqrt2(mouse_report.x);
 276         if (mouse_report.x == 0) {
 277             mouse_report.x = 1;
 278         }
 279         mouse_report.y = times_inv_sqrt2(mouse_report.y);
 280         if (mouse_report.y == 0) {
 281             mouse_report.y = 1;
 282         }
 283     }
 284     if (mouse_report.h && mouse_report.v) {
 285         mouse_report.h = times_inv_sqrt2(mouse_report.h);
 286         mouse_report.v = times_inv_sqrt2(mouse_report.v);
 287     }
 288 }
 289
 290 void mousekey_on(uint8_t code) {
 291     uint16_t const c_offset  = c_offsets[mk_speed];
 292     uint16_t const w_offset  = w_offsets[mk_speed];
 293     uint8_t const  old_speed = mk_speed;
 294     if (code == KC_MS_UP)
 295         mouse_report.y = c_offset * -1;
 296     else if (code == KC_MS_DOWN)
 297         mouse_report.y = c_offset;
 298     else if (code == KC_MS_LEFT)
 299         mouse_report.x = c_offset * -1;
 300     else if (code == KC_MS_RIGHT)
 301         mouse_report.x = c_offset;
 302     else if (code == KC_MS_WH_UP)
 303         mouse_report.v = w_offset;
 304     else if (code == KC_MS_WH_DOWN)
 305         mouse_report.v = w_offset * -1;
 306     else if (code == KC_MS_WH_LEFT)
 307         mouse_report.h = w_offset * -1;
 308     else if (code == KC_MS_WH_RIGHT)
 309         mouse_report.h = w_offset;
 310     else if (code == KC_MS_BTN1)
 311         mouse_report.buttons |= MOUSE_BTN1;
 312     else if (code == KC_MS_BTN2)
 313         mouse_report.buttons |= MOUSE_BTN2;
 314     else if (code == KC_MS_BTN3)
 315         mouse_report.buttons |= MOUSE_BTN3;
 316     else if (code == KC_MS_BTN4)
 317         mouse_report.buttons |= MOUSE_BTN4;
 318     else if (code == KC_MS_BTN5)
 319         mouse_report.buttons |= MOUSE_BTN5;
 320     else if (code == KC_MS_ACCEL0)
 321         mk_speed = mkspd_0;
 322     else if (code == KC_MS_ACCEL1)
 323         mk_speed = mkspd_1;
 324     else if (code == KC_MS_ACCEL2)
 325         mk_speed = mkspd_2;
 326     if (mk_speed != old_speed) adjust_speed();
 327 }
 328
 329 void mousekey_off(uint8_t code) {
 330 #    ifdef MK_MOMENTARY_ACCEL
 331     uint8_t const old_speed = mk_speed;
 332 #    endif
 333     if (code == KC_MS_UP && mouse_report.y < 0)
 334         mouse_report.y = 0;
 335     else if (code == KC_MS_DOWN && mouse_report.y > 0)
 336         mouse_report.y = 0;
 337     else if (code == KC_MS_LEFT && mouse_report.x < 0)
 338         mouse_report.x = 0;
 339     else if (code == KC_MS_RIGHT && mouse_report.x > 0)
 340         mouse_report.x = 0;
 341     else if (code == KC_MS_WH_UP && mouse_report.v > 0)
 342         mouse_report.v = 0;
 343     else if (code == KC_MS_WH_DOWN && mouse_report.v < 0)
 344         mouse_report.v = 0;
 345     else if (code == KC_MS_WH_LEFT && mouse_report.h < 0)
 346         mouse_report.h = 0;
 347     else if (code == KC_MS_WH_RIGHT && mouse_report.h > 0)
 348         mouse_report.h = 0;
 349     else if (code == KC_MS_BTN1)
 350         mouse_report.buttons &= ~MOUSE_BTN1;
 351     else if (code == KC_MS_BTN2)
 352         mouse_report.buttons &= ~MOUSE_BTN2;
 353     else if (code == KC_MS_BTN3)
 354         mouse_report.buttons &= ~MOUSE_BTN3;
 355     else if (code == KC_MS_BTN4)
 356         mouse_report.buttons &= ~MOUSE_BTN4;
 357     else if (code == KC_MS_BTN5)
 358         mouse_report.buttons &= ~MOUSE_BTN5;
 359 #    ifdef MK_MOMENTARY_ACCEL
 360     else if (code == KC_MS_ACCEL0)
 361         mk_speed = mkspd_DEFAULT;
 362     else if (code == KC_MS_ACCEL1)
 363         mk_speed = mkspd_DEFAULT;
 364     else if (code == KC_MS_ACCEL2)
 365         mk_speed = mkspd_DEFAULT;
 366     if (mk_speed != old_speed) adjust_speed();
 367 #    endif
 368 }
 369
 370 #endif /* #ifndef MK_3_SPEED */
 371
 372 void mousekey_send(void) {
 373     mousekey_debug();
 374     host_mouse_send(&mouse_report);
 375     last_timer = timer_read();
 376 }
 377
 378 void mousekey_clear(void) {
 379     mouse_report    = (report_mouse_t){};
 380     mousekey_repeat = 0;
 381     mousekey_accel  = 0;
 382 }
 383
 384 static void mousekey_debug(void) {
 385     if (!debug_mouse) return;
 386     print("mousekey [btn|x y v h](rep/acl): [");
 387     phex(mouse_report.buttons);
 388     print("|");
 389     print_decs(mouse_report.x);
 390     print(" ");
 391     print_decs(mouse_report.y);
 392     print(" ");
 393     print_decs(mouse_report.v);
 394     print(" ");
 395     print_decs(mouse_report.h);
 396     print("](");
 397     print_dec(mousekey_repeat);
 398     print("/");
 399     print_dec(mousekey_accel);
 400     print(")\n");
 401 }