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