quantum/encoder.c

   1 /*
   2  * Copyright 2018 Jack Humbert <jack.humb@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 "encoder.h"
  19 #ifdef SPLIT_KEYBOARD
  20 #    include "split_util.h"
  21 #endif
  22
  23 // for memcpy
  24 #include <string.h>
  25
  26 #ifndef ENCODER_RESOLUTION
  27 #    define ENCODER_RESOLUTION 4
  28 #endif
  29
  30 #if !defined(ENCODERS_PAD_A) || !defined(ENCODERS_PAD_B)
  31 #    error "No encoder pads defined by ENCODERS_PAD_A and ENCODERS_PAD_B"
  32 #endif
  33
  34 #define NUMBER_OF_ENCODERS (sizeof(encoders_pad_a) / sizeof(pin_t))
  35 static pin_t encoders_pad_a[] = ENCODERS_PAD_A;
  36 static pin_t encoders_pad_b[] = ENCODERS_PAD_B;
  37
  38 static int8_t encoder_LUT[] = {0, -1, 1, 0, 1, 0, 0, -1, -1, 0, 0, 1, 0, 1, -1, 0};
  39
  40 static uint8_t encoder_state[NUMBER_OF_ENCODERS] = {0};
  41
  42 #ifdef SPLIT_KEYBOARD
  43 // right half encoders come over as second set of encoders
  44 static int8_t encoder_value[NUMBER_OF_ENCODERS * 2] = {0};
  45 // row offsets for each hand
  46 static uint8_t thisHand, thatHand;
  47 #else
  48 static int8_t encoder_value[NUMBER_OF_ENCODERS] = {0};
  49 #endif
  50
  51 __attribute__((weak)) void encoder_update_user(int8_t index, bool clockwise) {}
  52
  53 __attribute__((weak)) void encoder_update_kb(int8_t index, bool clockwise) { encoder_update_user(index, clockwise); }
  54
  55 void encoder_init(void) {
  56 #if defined(SPLIT_KEYBOARD) && defined(ENCODERS_PAD_A_RIGHT) && defined(ENCODERS_PAD_B_RIGHT)
  57     if (!isLeftHand) {
  58         const pin_t encoders_pad_a_right[] = ENCODERS_PAD_A_RIGHT;
  59         const pin_t encoders_pad_b_right[] = ENCODERS_PAD_B_RIGHT;
  60         for (uint8_t i = 0; i < NUMBER_OF_ENCODERS; i++) {
  61             encoders_pad_a[i] = encoders_pad_a_right[i];
  62             encoders_pad_b[i] = encoders_pad_b_right[i];
  63         }
  64     }
  65 #endif
  66
  67     for (int i = 0; i < NUMBER_OF_ENCODERS; i++) {
  68         setPinInputHigh(encoders_pad_a[i]);
  69         setPinInputHigh(encoders_pad_b[i]);
  70
  71         encoder_state[i] = (readPin(encoders_pad_a[i]) << 0) | (readPin(encoders_pad_b[i]) << 1);
  72     }
  73
  74 #ifdef SPLIT_KEYBOARD
  75     thisHand = isLeftHand ? 0 : NUMBER_OF_ENCODERS;
  76     thatHand = NUMBER_OF_ENCODERS - thisHand;
  77 #endif
  78 }
  79
  80 static void encoder_update(int8_t index, uint8_t state) {
  81     encoder_value[index] += encoder_LUT[state & 0xF];
  82     if (encoder_value[index] >= ENCODER_RESOLUTION) {
  83         encoder_update_kb(index, false);
  84     }
  85     if (encoder_value[index] <= -ENCODER_RESOLUTION) { // direction is arbitrary here, but this clockwise
  86         encoder_update_kb(index, true);
  87     }
  88     encoder_value[index] %= ENCODER_RESOLUTION;
  89 }
  90
  91 void encoder_read(void) {
  92     for (int i = 0; i < NUMBER_OF_ENCODERS; i++) {
  93         encoder_state[i] <<= 2;
  94         encoder_state[i] |= (readPin(encoders_pad_a[i]) << 0) | (readPin(encoders_pad_b[i]) << 1);
  95 #if SPLIT_KEYBOARD
  96         encoder_update(i + thisHand, encoder_state[i]);
  97 #else
  98         encoder_update(i, encoder_state[i]);
  99 #endif
 100     }
 101 }
 102
 103 #ifdef SPLIT_KEYBOARD
 104 void encoder_state_raw(uint8_t* slave_state) { memcpy(slave_state, encoder_state, sizeof(encoder_state)); }
 105
 106 void encoder_update_raw(uint8_t* slave_state) {
 107     for (int i = 0; i < NUMBER_OF_ENCODERS; i++) {
 108         encoder_update(i + thatHand, slave_state[i]);
 109     }
 110 }
 111 #endif