quantum/keymap_common.c

   1 /*
   2 Copyright 2012,2013 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     // The arm-none-eabi compiler generates out of bounds warnings when using the fn_actions directly for some reason
  52     const uint16_t* actions = fn_actions;
  53
  54     switch (keycode) {
  55         case KC_FN0 ... KC_FN31:
  56             action.code = pgm_read_word(&actions[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_MEDIA_REWIND:
  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 = pgm_read_word(&actions[(int)keycode & 0xFFF]);
  83             break;
  84         case QK_MACRO ... QK_MACRO_MAX:
  85             action.code = ACTION_MACRO(keycode & 0xFF);
  86             break;
  87         case QK_LAYER_TAP ... QK_LAYER_TAP_MAX:
  88             action.code = ACTION_LAYER_TAP_KEY((keycode >> 0x8) & 0xF, keycode & 0xFF);
  89             break;
  90         case QK_TO ... QK_TO_MAX: ;
  91             // Layer set "GOTO"
  92             when = (keycode >> 0x4) & 0x3;
  93             action_layer = keycode & 0xF;
  94             action.code = ACTION_LAYER_SET(action_layer, when);
  95             break;
  96         case QK_MOMENTARY ... QK_MOMENTARY_MAX: ;
  97             // Momentary action_layer
  98             action_layer = keycode & 0xFF;
  99             action.code = ACTION_LAYER_MOMENTARY(action_layer);
 100             break;
 101         case QK_DEF_LAYER ... QK_DEF_LAYER_MAX: ;
 102             // Set default action_layer
 103             action_layer = keycode & 0xFF;
 104             action.code = ACTION_DEFAULT_LAYER_SET(action_layer);
 105             break;
 106         case QK_TOGGLE_LAYER ... QK_TOGGLE_LAYER_MAX: ;
 107             // Set toggle
 108             action_layer = keycode & 0xFF;
 109             action.code = ACTION_LAYER_TOGGLE(action_layer);
 110             break;
 111         case QK_ONE_SHOT_LAYER ... QK_ONE_SHOT_LAYER_MAX: ;
 112             // OSL(action_layer) - One-shot action_layer
 113             action_layer = keycode & 0xFF;
 114             action.code = ACTION_LAYER_ONESHOT(action_layer);
 115             break;
 116         case QK_ONE_SHOT_MOD ... QK_ONE_SHOT_MOD_MAX: ;
 117             // OSM(mod) - One-shot mod
 118             mod = keycode & 0xFF;
 119             action.code = ACTION_MODS_ONESHOT(mod);
 120             break;
 121         case QK_MOD_TAP ... QK_MOD_TAP_MAX:
 122             action.code = ACTION_MODS_TAP_KEY((keycode >> 0x8) & 0xF, keycode & 0xFF);
 123             break;
 124     #ifdef BACKLIGHT_ENABLE
 125         case BL_0 ... BL_15:
 126             action.code = ACTION_BACKLIGHT_LEVEL(keycode - BL_0);
 127             break;
 128         case BL_DEC:
 129             action.code = ACTION_BACKLIGHT_DECREASE();
 130             break;
 131         case BL_INC:
 132             action.code = ACTION_BACKLIGHT_INCREASE();
 133             break;
 134         case BL_TOGG:
 135             action.code = ACTION_BACKLIGHT_TOGGLE();
 136             break;
 137         case BL_STEP:
 138             action.code = ACTION_BACKLIGHT_STEP();
 139             break;
 140     #endif
 141         default:
 142             action.code = ACTION_NO;
 143             break;
 144     }
 145     return action;
 146 }
 147
 148 __attribute__ ((weak))
 149 const uint16_t PROGMEM fn_actions[] = {
 150
 151 };
 152
 153 /* Macro */
 154 __attribute__ ((weak))
 155 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 156 {
 157     return MACRO_NONE;
 158 }
 159
 160 /* Function */
 161 __attribute__ ((weak))
 162 void action_function(keyrecord_t *record, uint8_t id, uint8_t opt)
 163 {
 164 }
 165
 166 /* translates key to keycode */
 167 uint16_t keymap_key_to_keycode(uint8_t layer, keypos_t key)
 168 {
 169     // Read entire word (16bits)
 170     return pgm_read_word(&keymaps[(layer)][(key.row)][(key.col)]);
 171 }