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