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_common.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 "keymap_midi.h"
  28
  29 #include <stdio.h>
  30 #include <inttypes.h>
  31 #ifdef AUDIO_ENABLE
  32     #include "audio.h"
  33
  34     float goodbye[][2] = {
  35         {440.0*pow(2.0,(67)/12.0), 400},
  36         {0, 50},
  37         {440.0*pow(2.0,(60)/12.0), 400},
  38         {0, 50},
  39         {440.0*pow(2.0,(55)/12.0), 600},
  40     };
  41 #endif
  42
  43 static action_t keycode_to_action(uint16_t keycode);
  44
  45 /* converts key to action */
  46 action_t action_for_key(uint8_t layer, keypos_t key)
  47 {
  48         // 16bit keycodes - important
  49     uint16_t keycode = keymap_key_to_keycode(layer, key);
  50
  51     if (keycode >= 0x0100 && keycode < 0x2000) {
  52         // Has a modifier
  53         action_t action;
  54         // Split it up
  55         action.code = ACTION_MODS_KEY(keycode >> 8, keycode & 0xFF); // adds modifier to key
  56         return action;
  57         } else if (keycode >= 0x2000 && keycode < 0x3000) {
  58         // Is a shortcut for function layer, pull last 12bits
  59         // This means we have 4,096 FN macros at our disposal
  60         return keymap_func_to_action(keycode & 0xFFF);
  61         } else if (keycode >= 0x3000 && keycode < 0x4000) {
  62       // When the code starts with 3, it's an action macro.
  63         action_t action;
  64         action.code = ACTION_MACRO(keycode & 0xFF);
  65         return action;
  66 #ifdef BACKLIGHT_ENABLE
  67         } else if (keycode >= BL_0 && keycode <= BL_15) {
  68         action_t action;
  69         action.code = ACTION_BACKLIGHT_LEVEL(keycode & 0x000F);
  70         return action;
  71     } else if (keycode == BL_DEC) {
  72         action_t action;
  73         action.code = ACTION_BACKLIGHT_DECREASE();
  74         return action;
  75     } else if (keycode == BL_INC) {
  76         action_t action;
  77         action.code = ACTION_BACKLIGHT_INCREASE();
  78         return action;
  79     } else if (keycode == BL_TOGG) {
  80         action_t action;
  81         action.code = ACTION_BACKLIGHT_TOGGLE();
  82         return action;
  83     } else if (keycode == BL_STEP) {
  84         action_t action;
  85         action.code = ACTION_BACKLIGHT_STEP();
  86         return action;
  87 #endif
  88     } else if (keycode == RESET) { // RESET is 0x5000, which is why this is here
  89         clear_keyboard();
  90         #ifdef AUDIO_ENABLE
  91             play_notes(&goodbye, 5, false);
  92         #endif
  93         _delay_ms(250);
  94         #ifdef ATREUS_ASTAR
  95             *(uint16_t *)0x0800 = 0x7777; // these two are a-star-specific
  96         #endif
  97         bootloader_jump();
  98         return;
  99     } else if (keycode == DEBUG) { // DEBUG is 0x5001
 100       // TODO: Does this actually work?
 101         print("\nDEBUG: enabled.\n");
 102         debug_enable = true;
 103         return;
 104     } else if (keycode >= 0x5000 && keycode < 0x6000) {
 105         // Layer movement shortcuts
 106         // See .h to see constraints/usage
 107         int type = (keycode >> 0x8) & 0xF;
 108         if (type == 0x1) {
 109             // Layer set "GOTO"
 110             int when = (keycode >> 0x4) & 0x3;
 111             int layer = keycode & 0xF;
 112             action_t action;
 113             action.code = ACTION_LAYER_SET(layer, when);
 114             return action;
 115         } else if (type == 0x2) {
 116             // Momentary layer
 117             int layer = keycode & 0xFF;
 118             action_t action;
 119             action.code = ACTION_LAYER_MOMENTARY(layer);
 120             return action;
 121         } else if (type == 0x3) {
 122             // Set default layer
 123             int layer = keycode & 0xFF;
 124             action_t action;
 125             action.code = ACTION_DEFAULT_LAYER_SET(layer);
 126             return action;
 127         } else if (type == 0x4) {
 128             // Set default layer
 129             int layer = keycode & 0xFF;
 130             action_t action;
 131             action.code = ACTION_LAYER_TOGGLE(layer);
 132             return action;
 133         }
 134 #ifdef MIDI_ENABLE
 135     } else if (keycode >= 0x6000 && keycode < 0x7000) {
 136         action_t action;
 137         action.code =  ACTION_FUNCTION_OPT(keycode & 0xFF, (keycode & 0x0F00) >> 8);
 138         return action;
 139 #endif
 140     } else if (keycode >= 0x7000 && keycode < 0x8000) {
 141         action_t action;
 142         action.code = ACTION_MODS_TAP_KEY((keycode >> 0x8) & 0xF, keycode & 0xFF);
 143         return action;
 144     } else if (keycode >= 0x8000 && keycode < 0x9000) {
 145         action_t action;
 146         action.code = ACTION_LAYER_TAP_KEY((keycode >> 0x8) & 0xF, keycode & 0xFF);
 147         return action;
 148 #ifdef UNICODE_ENABLE
 149     } else if (keycode >= 0x8000000) {
 150         action_t action;
 151         uint16_t unicode = keycode & ~(0x8000);
 152         action.code =  ACTION_FUNCTION_OPT(unicode & 0xFF, (unicode & 0xFF00) >> 8);
 153         return action;
 154 #endif
 155     } else {
 156
 157     }
 158
 159     switch (keycode) {
 160         case KC_FN0 ... KC_FN31:
 161             return keymap_fn_to_action(keycode);
 162 #ifdef BOOTMAGIC_ENABLE
 163         case KC_CAPSLOCK:
 164         case KC_LOCKING_CAPS:
 165             if (keymap_config.swap_control_capslock || keymap_config.capslock_to_control) {
 166                 return keycode_to_action(KC_LCTL);
 167             }
 168             return keycode_to_action(keycode);
 169         case KC_LCTL:
 170             if (keymap_config.swap_control_capslock) {
 171                 return keycode_to_action(KC_CAPSLOCK);
 172             }
 173             return keycode_to_action(KC_LCTL);
 174         case KC_LALT:
 175             if (keymap_config.swap_lalt_lgui) {
 176                 if (keymap_config.no_gui) {
 177                     return keycode_to_action(ACTION_NO);
 178                 }
 179                 return keycode_to_action(KC_LGUI);
 180             }
 181             return keycode_to_action(KC_LALT);
 182         case KC_LGUI:
 183             if (keymap_config.swap_lalt_lgui) {
 184                 return keycode_to_action(KC_LALT);
 185             }
 186             if (keymap_config.no_gui) {
 187                 return keycode_to_action(ACTION_NO);
 188             }
 189             return keycode_to_action(KC_LGUI);
 190         case KC_RALT:
 191             if (keymap_config.swap_ralt_rgui) {
 192                 if (keymap_config.no_gui) {
 193                     return keycode_to_action(ACTION_NO);
 194                 }
 195                 return keycode_to_action(KC_RGUI);
 196             }
 197             return keycode_to_action(KC_RALT);
 198         case KC_RGUI:
 199             if (keymap_config.swap_ralt_rgui) {
 200                 return keycode_to_action(KC_RALT);
 201             }
 202             if (keymap_config.no_gui) {
 203                 return keycode_to_action(ACTION_NO);
 204             }
 205             return keycode_to_action(KC_RGUI);
 206         case KC_GRAVE:
 207             if (keymap_config.swap_grave_esc) {
 208                 return keycode_to_action(KC_ESC);
 209             }
 210             return keycode_to_action(KC_GRAVE);
 211         case KC_ESC:
 212             if (keymap_config.swap_grave_esc) {
 213                 return keycode_to_action(KC_GRAVE);
 214             }
 215             return keycode_to_action(KC_ESC);
 216         case KC_BSLASH:
 217             if (keymap_config.swap_backslash_backspace) {
 218                 return keycode_to_action(KC_BSPACE);
 219             }
 220             return keycode_to_action(KC_BSLASH);
 221         case KC_BSPACE:
 222             if (keymap_config.swap_backslash_backspace) {
 223                 return keycode_to_action(KC_BSLASH);
 224             }
 225             return keycode_to_action(KC_BSPACE);
 226 #endif
 227         default:
 228             return keycode_to_action(keycode);
 229     }
 230 }
 231
 232
 233 /* Macro */
 234 __attribute__ ((weak))
 235 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 236 {
 237     return MACRO_NONE;
 238 }
 239
 240 /* Function */
 241 __attribute__ ((weak))
 242 void action_function(keyrecord_t *record, uint8_t id, uint8_t opt)
 243 {
 244 }
 245
 246 /* translates keycode to action */
 247 static action_t keycode_to_action(uint16_t keycode)
 248 {
 249     action_t action;
 250     switch (keycode) {
 251         case KC_A ... KC_EXSEL:
 252         case KC_LCTRL ... KC_RGUI:
 253             action.code = ACTION_KEY(keycode);
 254             break;
 255         case KC_SYSTEM_POWER ... KC_SYSTEM_WAKE:
 256             action.code = ACTION_USAGE_SYSTEM(KEYCODE2SYSTEM(keycode));
 257             break;
 258         case KC_AUDIO_MUTE ... KC_WWW_FAVORITES:
 259             action.code = ACTION_USAGE_CONSUMER(KEYCODE2CONSUMER(keycode));
 260             break;
 261         case KC_MS_UP ... KC_MS_ACCEL2:
 262             action.code = ACTION_MOUSEKEY(keycode);
 263             break;
 264         case KC_TRNS:
 265             action.code = ACTION_TRANSPARENT;
 266             break;
 267         default:
 268             action.code = ACTION_NO;
 269             break;
 270     }
 271     return action;
 272 }
 273
 274
 275 /* translates key to keycode */
 276 uint16_t keymap_key_to_keycode(uint8_t layer, keypos_t key)
 277 {
 278         // Read entire word (16bits)
 279     return pgm_read_word(&keymaps[(layer)][(key.row)][(key.col)]);
 280 }
 281
 282 /* translates Fn keycode to action */
 283 action_t keymap_fn_to_action(uint16_t keycode)
 284 {
 285     return (action_t){ .code = pgm_read_word(&fn_actions[FN_INDEX(keycode)]) };
 286 }
 287
 288 action_t keymap_func_to_action(uint16_t keycode)
 289 {
 290         // For FUNC without 8bit limit
 291     return (action_t){ .code = pgm_read_word(&fn_actions[(int)keycode]) };
 292 }