quantum/keymap_common.c

   1 /*
   2 Copyright 2012-2017 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 "keymap.h"
  19 #include "report.h"
  20 #include "keycode.h"
  21 #include "action_layer.h"
  22 #if defined(__AVR__)
  23 #include <util/delay.h>
  24 #include <stdio.h>
  25 #endif
  26 #include "action.h"
  27 #include "action_macro.h"
  28 #include "debug.h"
  29 #include "backlight.h"
  30 #include "quantum.h"
  31
  32 #ifdef SPLIT_KEYBOARD
  33     #include "split_flags.h"
  34 #endif
  35
  36 #ifdef MIDI_ENABLE
  37         #include "process_midi.h"
  38 #endif
  39
  40 extern keymap_config_t keymap_config;
  41
  42 #include <inttypes.h>
  43
  44 /* converts key to action */
  45 action_t action_for_key(uint8_t layer, keypos_t key)
  46 {
  47     // 16bit keycodes - important
  48     uint16_t keycode = keymap_key_to_keycode(layer, key);
  49
  50     // keycode remapping
  51     keycode = keycode_config(keycode);
  52
  53     action_t action;
  54     uint8_t action_layer, when, mod;
  55
  56     switch (keycode) {
  57         case KC_FN0 ... KC_FN31:
  58             action.code = keymap_function_id_to_action(FN_INDEX(keycode));
  59             break;
  60         case KC_A ... KC_EXSEL:
  61         case KC_LCTRL ... KC_RGUI:
  62             action.code = ACTION_KEY(keycode);
  63             break;
  64         case KC_SYSTEM_POWER ... KC_SYSTEM_WAKE:
  65             action.code = ACTION_USAGE_SYSTEM(KEYCODE2SYSTEM(keycode));
  66             break;
  67         case KC_AUDIO_MUTE ... KC_BRIGHTNESS_DOWN:
  68             action.code = ACTION_USAGE_CONSUMER(KEYCODE2CONSUMER(keycode));
  69             break;
  70         case KC_MS_UP ... KC_MS_ACCEL2:
  71             action.code = ACTION_MOUSEKEY(keycode);
  72             break;
  73         case KC_TRNS:
  74             action.code = ACTION_TRANSPARENT;
  75             break;
  76         case QK_MODS ... QK_MODS_MAX: ;
  77             // Has a modifier
  78             // Split it up
  79             action.code = ACTION_MODS_KEY(keycode >> 8, keycode & 0xFF); // adds modifier to key
  80             break;
  81         case QK_FUNCTION ... QK_FUNCTION_MAX: ;
  82             // Is a shortcut for function action_layer, pull last 12bits
  83             // This means we have 4,096 FN macros at our disposal
  84             action.code = keymap_function_id_to_action( (int)keycode & 0xFFF );
  85             break;
  86         case QK_MACRO ... QK_MACRO_MAX:
  87             if (keycode & 0x800) // tap macros have upper bit set
  88                 action.code = ACTION_MACRO_TAP(keycode & 0xFF);
  89             else
  90                 action.code = ACTION_MACRO(keycode & 0xFF);
  91             break;
  92         case QK_LAYER_TAP ... QK_LAYER_TAP_MAX:
  93             action.code = ACTION_LAYER_TAP_KEY((keycode >> 0x8) & 0xF, keycode & 0xFF);
  94             break;
  95         case QK_TO ... QK_TO_MAX: ;
  96             // Layer set "GOTO"
  97             when = (keycode >> 0x4) & 0x3;
  98             action_layer = keycode & 0xF;
  99             action.code = ACTION_LAYER_SET(action_layer, when);
 100             break;
 101         case QK_MOMENTARY ... QK_MOMENTARY_MAX: ;
 102             // Momentary action_layer
 103             action_layer = keycode & 0xFF;
 104             action.code = ACTION_LAYER_MOMENTARY(action_layer);
 105             break;
 106         case QK_DEF_LAYER ... QK_DEF_LAYER_MAX: ;
 107             // Set default action_layer
 108             action_layer = keycode & 0xFF;
 109             action.code = ACTION_DEFAULT_LAYER_SET(action_layer);
 110             break;
 111         case QK_TOGGLE_LAYER ... QK_TOGGLE_LAYER_MAX: ;
 112             // Set toggle
 113             action_layer = keycode & 0xFF;
 114             action.code = ACTION_LAYER_TOGGLE(action_layer);
 115             break;
 116         case QK_ONE_SHOT_LAYER ... QK_ONE_SHOT_LAYER_MAX: ;
 117             // OSL(action_layer) - One-shot action_layer
 118             action_layer = keycode & 0xFF;
 119             action.code = ACTION_LAYER_ONESHOT(action_layer);
 120             break;
 121         case QK_ONE_SHOT_MOD ... QK_ONE_SHOT_MOD_MAX: ;
 122             // OSM(mod) - One-shot mod
 123             mod = mod_config(keycode & 0xFF);
 124             action.code = ACTION_MODS_ONESHOT(mod);
 125             break;
 126         case QK_LAYER_TAP_TOGGLE ... QK_LAYER_TAP_TOGGLE_MAX:
 127             action.code = ACTION_LAYER_TAP_TOGGLE(keycode & 0xFF);
 128             break;
 129         case QK_LAYER_MOD ... QK_LAYER_MOD_MAX:
 130             mod = mod_config(keycode & 0xF);
 131             action_layer = (keycode >> 4) & 0xF;
 132             action.code = ACTION_LAYER_MODS(action_layer, mod);
 133             break;
 134         case QK_MOD_TAP ... QK_MOD_TAP_MAX:
 135             mod = mod_config((keycode >> 0x8) & 0x1F);
 136             action.code = ACTION_MODS_TAP_KEY(mod, keycode & 0xFF);
 137             break;
 138     #ifdef BACKLIGHT_ENABLE
 139         case BL_ON:
 140             action.code = ACTION_BACKLIGHT_ON();
 141             #ifdef SPLIT_KEYBOARD
 142                 BACKLIT_DIRTY = true;
 143             #endif
 144             break;
 145         case BL_OFF:
 146             action.code = ACTION_BACKLIGHT_OFF();
 147             #ifdef SPLIT_KEYBOARD
 148                 BACKLIT_DIRTY = true;
 149             #endif
 150             break;
 151         case BL_DEC:
 152             action.code = ACTION_BACKLIGHT_DECREASE();
 153             #ifdef SPLIT_KEYBOARD
 154                 BACKLIT_DIRTY = true;
 155             #endif
 156             break;
 157         case BL_INC:
 158             action.code = ACTION_BACKLIGHT_INCREASE();
 159             #ifdef SPLIT_KEYBOARD
 160                 BACKLIT_DIRTY = true;
 161             #endif
 162             break;
 163         case BL_TOGG:
 164             action.code = ACTION_BACKLIGHT_TOGGLE();
 165             #ifdef SPLIT_KEYBOARD
 166                 BACKLIT_DIRTY = true;
 167             #endif
 168             break;
 169         case BL_STEP:
 170             action.code = ACTION_BACKLIGHT_STEP();
 171             #ifdef SPLIT_KEYBOARD
 172                 BACKLIT_DIRTY = true;
 173             #endif
 174             break;
 175     #endif
 176     #ifdef SWAP_HANDS_ENABLE
 177         case QK_SWAP_HANDS ... QK_SWAP_HANDS_MAX:
 178             action.code = ACTION(ACT_SWAP_HANDS, keycode & 0xff);
 179             break;
 180     #endif
 181
 182         default:
 183             action.code = ACTION_NO;
 184             break;
 185     }
 186     return action;
 187 }
 188
 189 __attribute__ ((weak))
 190 const uint16_t PROGMEM fn_actions[] = {
 191
 192 };
 193
 194 /* Macro */
 195 __attribute__ ((weak))
 196 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 197 {
 198     return MACRO_NONE;
 199 }
 200
 201 /* Function */
 202 __attribute__ ((weak))
 203 void action_function(keyrecord_t *record, uint8_t id, uint8_t opt)
 204 {
 205 }
 206
 207 // translates key to keycode
 208 __attribute__ ((weak))
 209 uint16_t keymap_key_to_keycode(uint8_t layer, keypos_t key)
 210 {
 211     // Read entire word (16bits)
 212     return pgm_read_word(&keymaps[(layer)][(key.row)][(key.col)]);
 213 }
 214
 215 // translates function id to action
 216 __attribute__ ((weak))
 217 uint16_t keymap_function_id_to_action( uint16_t function_id )
 218 {
 219     // The compiler sees the empty (weak) fn_actions and generates a warning
 220     // This function should not be called in that case, so the warning is too strict
 221     // If this function is called however, the keymap should have overridden fn_actions, and then the compile
 222     // is comparing against the wrong array
 223     #pragma GCC diagnostic push
 224     #pragma GCC diagnostic ignored "-Warray-bounds"
 225         return pgm_read_word(&fn_actions[function_id]);
 226     #pragma GCC diagnostic pop
 227 }