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