quantum/keymap.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 #include <util/delay.h>
  23 #include "action.h"
  24 #include "action_macro.h"
  25 #include "debug.h"
  26 #include "backlight.h"
  27 #include "quantum.h"
  28
  29 #ifdef MIDI_ENABLE
  30         #include "keymap_midi.h"
  31 #endif
  32
  33 extern keymap_config_t keymap_config;
  34
  35 #include <stdio.h>
  36 #include <inttypes.h>
  37
  38 /* converts key to action */
  39 action_t action_for_key(uint8_t layer, keypos_t key)
  40 {
  41     // 16bit keycodes - important
  42     uint16_t keycode = keymap_key_to_keycode(layer, key);
  43
  44     // keycode remapping
  45     keycode = keycode_config(keycode);
  46
  47     action_t action;
  48     uint8_t action_layer, when, mod;
  49
  50     switch (keycode) {
  51         case KC_FN0 ... KC_FN31:
  52             action.code = pgm_read_word(&fn_actions[FN_INDEX(keycode)]);
  53             break;
  54         case KC_A ... KC_EXSEL:
  55         case KC_LCTRL ... KC_RGUI:
  56             action.code = ACTION_KEY(keycode);
  57             break;
  58         case KC_SYSTEM_POWER ... KC_SYSTEM_WAKE:
  59             action.code = ACTION_USAGE_SYSTEM(KEYCODE2SYSTEM(keycode));
  60             break;
  61         case KC_AUDIO_MUTE ... KC_WWW_FAVORITES:
  62             action.code = ACTION_USAGE_CONSUMER(KEYCODE2CONSUMER(keycode));
  63             break;
  64         case KC_MS_UP ... KC_MS_ACCEL2:
  65             action.code = ACTION_MOUSEKEY(keycode);
  66             break;
  67         case KC_TRNS:
  68             action.code = ACTION_TRANSPARENT;
  69             break;
  70         case QK_MODS ... QK_MODS_MAX: ;
  71             // Has a modifier
  72             // Split it up
  73             action.code = ACTION_MODS_KEY(keycode >> 8, keycode & 0xFF); // adds modifier to key
  74             break;
  75         case QK_FUNCTION ... QK_FUNCTION_MAX: ;
  76             // Is a shortcut for function action_layer, pull last 12bits
  77             // This means we have 4,096 FN macros at our disposal
  78             action.code = pgm_read_word(&fn_actions[(int)keycode & 0xFFF]);
  79             break;
  80         case QK_MACRO ... QK_MACRO_MAX:
  81             action.code = ACTION_MACRO(keycode & 0xFF);
  82             break;
  83         case QK_LAYER_TAP ... QK_LAYER_TAP_MAX:
  84             action.code = ACTION_LAYER_TAP_KEY((keycode >> 0x8) & 0xF, keycode & 0xFF);
  85             break;
  86         case QK_TO ... QK_TO_MAX: ;
  87             // Layer set "GOTO"
  88             when = (keycode >> 0x4) & 0x3;
  89             action_layer = keycode & 0xF;
  90             action.code = ACTION_LAYER_SET(action_layer, when);
  91             break;
  92         case QK_MOMENTARY ... QK_MOMENTARY_MAX: ;
  93             // Momentary action_layer
  94             action_layer = keycode & 0xFF;
  95             action.code = ACTION_LAYER_MOMENTARY(action_layer);
  96             break;
  97         case QK_DEF_LAYER ... QK_DEF_LAYER_MAX: ;
  98             // Set default action_layer
  99             action_layer = keycode & 0xFF;
 100             action.code = ACTION_DEFAULT_LAYER_SET(action_layer);
 101             break;
 102         case QK_TOGGLE_LAYER ... QK_TOGGLE_LAYER_MAX: ;
 103             // Set toggle
 104             action_layer = keycode & 0xFF;
 105             action.code = ACTION_LAYER_TOGGLE(action_layer);
 106             break;
 107         case QK_ONE_SHOT_LAYER ... QK_ONE_SHOT_LAYER_MAX: ;
 108             // OSL(action_layer) - One-shot action_layer
 109             action_layer = keycode & 0xFF;
 110             action.code = ACTION_LAYER_ONESHOT(action_layer);
 111             break;
 112         case QK_ONE_SHOT_MOD ... QK_ONE_SHOT_MOD_MAX: ;
 113             // OSM(mod) - One-shot mod
 114             mod = keycode & 0xFF;
 115             action.code = ACTION_MODS_ONESHOT(mod);
 116             break;
 117         case QK_MOD_TAP ... QK_MOD_TAP_MAX:
 118             action.code = ACTION_MODS_TAP_KEY((keycode >> 0x8) & 0xF, keycode & 0xFF);
 119             break;
 120     #ifdef BACKLIGHT_ENABLE
 121         case BL_0 ... BL_15:
 122             action.code = ACTION_BACKLIGHT_LEVEL(keycode - BL_0);
 123             break;
 124         case BL_DEC:
 125             action.code = ACTION_BACKLIGHT_DECREASE();
 126             break;
 127         case BL_INC:
 128             action.code = ACTION_BACKLIGHT_INCREASE();
 129             break;
 130         case BL_TOGG:
 131             action.code = ACTION_BACKLIGHT_TOGGLE();
 132             break;
 133         case BL_STEP:
 134             action.code = ACTION_BACKLIGHT_STEP();
 135             break;
 136     #endif
 137         default:
 138             action.code = ACTION_NO;
 139             break;
 140     }
 141     return action;
 142 }
 143
 144 __attribute__ ((weak))
 145 const uint16_t PROGMEM fn_actions[] = {
 146
 147 };
 148
 149 /* Macro */
 150 __attribute__ ((weak))
 151 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 152 {
 153     return MACRO_NONE;
 154 }
 155
 156 /* Function */
 157 __attribute__ ((weak))
 158 void action_function(keyrecord_t *record, uint8_t id, uint8_t opt)
 159 {
 160 }
 161
 162 /* translates key to keycode */
 163 uint16_t keymap_key_to_keycode(uint8_t layer, keypos_t key)
 164 {
 165     // Read entire word (16bits)
 166     return pgm_read_word(&keymaps[(layer)][(key.row)][(key.col)]);
 167 }