aboutsummaryrefslogtreecommitdiffstats
path: root/quantum/keymap_common.c
blob: 8f00f9cc32226ec1cff4acf986d64a168ae8ab2c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
/*
Copyright 2012,2013 Jun Wako <wakojun@gmail.com>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#include "keymap_common.h"
#include "report.h"
#include "keycode.h"
#include "action_layer.h"
#include <util/delay.h>
#include "action.h"
#include "action_macro.h"
#include "debug.h"
#include "backlight.h"
#include "bootloader.h"
#include "eeconfig.h"

#ifdef MIDI_ENABLE
	#include "keymap_midi.h"
#endif


extern keymap_config_t keymap_config;

#include <stdio.h>
#include <inttypes.h>
#ifdef AUDIO_ENABLE
    #include "audio.h"
#endif /* AUDIO_ENABLE */

static action_t keycode_to_action(uint16_t keycode);

/* converts key to action */
action_t action_for_key(uint8_t layer, keypos_t key)
{
    // 16bit keycodes - important
    uint16_t keycode = keymap_key_to_keycode(layer, key);

    switch (keycode) {
        case KC_FN0 ... KC_FN31:
            return keymap_fn_to_action(keycode);
        case KC_CAPSLOCK:
        case KC_LOCKING_CAPS:
            if (keymap_config.swap_control_capslock || keymap_config.capslock_to_control) {
                return keycode_to_action(KC_LCTL);
            }
            return keycode_to_action(keycode);
        case KC_LCTL:
            if (keymap_config.swap_control_capslock) {
                return keycode_to_action(KC_CAPSLOCK);
            }
            return keycode_to_action(KC_LCTL);
        case KC_LALT:
            if (keymap_config.swap_lalt_lgui) {
                if (keymap_config.no_gui) {
                    return keycode_to_action(ACTION_NO);
                }
                return keycode_to_action(KC_LGUI);
            }
            return keycode_to_action(KC_LALT);
        case KC_LGUI:
            if (keymap_config.swap_lalt_lgui) {
                return keycode_to_action(KC_LALT);
            }
            if (keymap_config.no_gui) {
                return keycode_to_action(ACTION_NO);
            }
            return keycode_to_action(KC_LGUI);
        case KC_RALT:
            if (keymap_config.swap_ralt_rgui) {
                if (keymap_config.no_gui) {
                    return keycode_to_action(ACTION_NO);
                }
                return keycode_to_action(KC_RGUI);
            }
            return keycode_to_action(KC_RALT);
        case KC_RGUI:
            if (keymap_config.swap_ralt_rgui) {
                return keycode_to_action(KC_RALT);
            }
            if (keymap_config.no_gui) {
                return keycode_to_action(ACTION_NO);
            }
            return keycode_to_action(KC_RGUI);
        case KC_GRAVE:
            if (keymap_config.swap_grave_esc) {
                return keycode_to_action(KC_ESC);
            }
            return keycode_to_action(KC_GRAVE);
        case KC_ESC:
            if (keymap_config.swap_grave_esc) {
                return keycode_to_action(KC_GRAVE);
            }
            return keycode_to_action(KC_ESC);
        case KC_BSLASH:
            if (keymap_config.swap_backslash_backspace) {
                return keycode_to_action(KC_BSPACE);
            }
            return keycode_to_action(KC_BSLASH);
        case KC_BSPACE:
            if (keymap_config.swap_backslash_backspace) {
                return keycode_to_action(KC_BSLASH);
            }
            return keycode_to_action(KC_BSPACE);
        default:
            return keycode_to_action(keycode);
    }
}


/* Macro */
__attribute__ ((weak))
const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
{
    return MACRO_NONE;
}

/* Function */
__attribute__ ((weak))
void action_function(keyrecord_t *record, uint8_t id, uint8_t opt)
{
}

/* translates keycode to action */
static action_t keycode_to_action(uint16_t keycode)
{
    action_t action;
    switch (keycode) {
        case KC_A ... KC_EXSEL:
        case KC_LCTRL ... KC_RGUI:
            action.code = ACTION_KEY(keycode);
            break;
        case KC_SYSTEM_POWER ... KC_SYSTEM_WAKE:
            action.code = ACTION_USAGE_SYSTEM(KEYCODE2SYSTEM(keycode));
            break;
        case KC_AUDIO_MUTE ... KC_WWW_FAVORITES:
            action.code = ACTION_USAGE_CONSUMER(KEYCODE2CONSUMER(keycode));
            break;
        case KC_MS_UP ... KC_MS_ACCEL2:
            action.code = ACTION_MOUSEKEY(keycode);
            break;
        case KC_TRNS:
            action.code = ACTION_TRANSPARENT;
            break;
        case 0x0100 ... 0x1FFF: ;
            // Has a modifier
            // Split it up
            action.code = ACTION_MODS_KEY(keycode >> 8, keycode & 0xFF); // adds modifier to key
            break;
        case 0x2000 ... 0x2FFF:
            // Is a shortcut for function layer, pull last 12bits
            // This means we have 4,096 FN macros at our disposal
            return keymap_func_to_action(keycode & 0xFFF);
            break;
        case 0x3000 ... 0x3FFF: ;
            // When the code starts with 3, it's an action macro.
            action.code = ACTION_MACRO(keycode & 0xFF);
            break;
    #ifdef BACKLIGHT_ENABLE
        case BL_0 ... BL_15:
            action.code = ACTION_BACKLIGHT_LEVEL(keycode & 0x000F);
            break;
        case BL_DEC:
            action.code = ACTION_BACKLIGHT_DECREASE();
            break;
        case BL_INC:
            action.code = ACTION_BACKLIGHT_INCREASE();
            break;
        case BL_TOGG:
            action.code = ACTION_BACKLIGHT_TOGGLE();
            break;
        case BL_STEP:
            action.code = ACTION_BACKLIGHT_STEP();
            break;
    #endif
        case RESET: ; // RESET is 0x5000, which is why this is here
            clear_keyboard();
            #ifdef AUDIO_ENABLE
                stop_all_notes();
                play_goodbye_tone();
            #endif
            _delay_ms(250);
            #ifdef ATREUS_ASTAR
                *(uint16_t *)0x0800 = 0x7777; // these two are a-star-specific
            #endif
            bootloader_jump();
            break;
        case DEBUG: ; // DEBUG is 0x5001
            print("\nDEBUG: enabled.\n");
            debug_enable = true;
            break;
        case 0x5002 ... 0x50FF:
            // MAGIC actions (BOOTMAGIC without the boot)
            if (!eeconfig_is_enabled()) {
                eeconfig_init();
            }
            /* keymap config */
            keymap_config.raw = eeconfig_read_keymap();
            if (keycode == MAGIC_SWAP_CONTROL_CAPSLOCK) {
                keymap_config.swap_control_capslock = 1;
            } else if (keycode == MAGIC_CAPSLOCK_TO_CONTROL) {
                keymap_config.capslock_to_control = 1;
            } else if (keycode == MAGIC_SWAP_LALT_LGUI) {
                keymap_config.swap_lalt_lgui = 1;
            } else if (keycode == MAGIC_SWAP_RALT_RGUI) {
                keymap_config.swap_ralt_rgui = 1;
            } else if (keycode == MAGIC_NO_GUI) {
                keymap_config.no_gui = 1;
            } else if (keycode == MAGIC_SWAP_GRAVE_ESC) {
                keymap_config.swap_grave_esc = 1;
            } else if (keycode == MAGIC_SWAP_BACKSLASH_BACKSPACE) {
                keymap_config.swap_backslash_backspace = 1;
            } else if (keycode == MAGIC_HOST_NKRO) {
                keymap_config.nkro = 1;
            } else if (keycode == MAGIC_SWAP_ALT_GUI) {
                keymap_config.swap_lalt_lgui = 1;
                keymap_config.swap_ralt_rgui = 1;
            }
            /* UNs */
            else if (keycode == MAGIC_UNSWAP_CONTROL_CAPSLOCK) {
                keymap_config.swap_control_capslock = 0;
            } else if (keycode == MAGIC_UNCAPSLOCK_TO_CONTROL) {
                keymap_config.capslock_to_control = 0;
            } else if (keycode == MAGIC_UNSWAP_LALT_LGUI) {
                keymap_config.swap_lalt_lgui = 0;
            } else if (keycode == MAGIC_UNSWAP_RALT_RGUI) {
                keymap_config.swap_ralt_rgui = 0;
            } else if (keycode == MAGIC_UNNO_GUI) {
                keymap_config.no_gui = 0;
            } else if (keycode == MAGIC_UNSWAP_GRAVE_ESC) {
                keymap_config.swap_grave_esc = 0;
            } else if (keycode == MAGIC_UNSWAP_BACKSLASH_BACKSPACE) {
                keymap_config.swap_backslash_backspace = 0;
            } else if (keycode == MAGIC_UNHOST_NKRO) {
                keymap_config.nkro = 0;
            } else if (keycode == MAGIC_UNSWAP_ALT_GUI) {
                keymap_config.swap_lalt_lgui = 0;
                keymap_config.swap_ralt_rgui = 0;
            }
            eeconfig_update_keymap(keymap_config.raw);
            break;
        case 0x5100 ... 0x5FFF: ;
            // Layer movement shortcuts
            // See .h to see constraints/usage
            int type = (keycode >> 0x8) & 0xF;
            if (type == 0x1) {
                // Layer set "GOTO"
                int when = (keycode >> 0x4) & 0x3;
                int layer = keycode & 0xF;
                action.code = ACTION_LAYER_SET(layer, when);
            } else if (type == 0x2) {
                // Momentary layer
                int layer = keycode & 0xFF;
                action.code = ACTION_LAYER_MOMENTARY(layer);
            } else if (type == 0x3) {
                // Set default layer
                int layer = keycode & 0xFF;
                action.code = ACTION_DEFAULT_LAYER_SET(layer);
            } else if (type == 0x4) {
                // Set default layer
                int layer = keycode & 0xFF;
                action.code = ACTION_LAYER_TOGGLE(layer);
            } else if (type == 0x5) {
                // OSL(layer) - One-shot layer
                int layer = keycode & 0xFF;
                action.code = ACTION_LAYER_ONESHOT(layer);
            } else if (type == 0x6) {
                // OSM(mod) - One-shot mod
                int mod = keycode & 0xFF;
                action.code = ACTION_MODS_ONESHOT(mod);
            }
            break;
    #ifdef MIDI_ENABLE
        case 0x6000 ... 0x6FFF:
            action.code =  ACTION_FUNCTION_OPT(keycode & 0xFF, (keycode & 0x0F00) >> 8);
            break;
    #endif
        case 0x7000 ... 0x7FFF:
            action.code = ACTION_MODS_TAP_KEY((keycode >> 0x8) & 0xF, keycode & 0xFF);
            break;
        case 0x8000 ... 0x8FFF:
            action.code = ACTION_LAYER_TAP_KEY((keycode >> 0x8) & 0xF, keycode & 0xFF);
            break;
    #ifdef UNICODE_ENABLE
        case 0x8000000 ... 0x8FFFFFF:
            uint16_t unicode = keycode & ~(0x8000);
            action.code =  ACTION_FUNCTION_OPT(unicode & 0xFF, (unicode & 0xFF00) >> 8);
            break;
    #endif
        default:
            action.code = ACTION_NO;
            break;
    }
    return action;
}


/* translates key to keycode */
uint16_t keymap_key_to_keycode(uint8_t layer, keypos_t key)
{
    // Read entire word (16bits)
    return pgm_read_word(&keymaps[(layer)][(key.row)][(key.col)]);
}

/* translates Fn keycode to action */
action_t keymap_fn_to_action(uint16_t keycode)
{
    return (action_t){ .code = pgm_read_word(&fn_actions[FN_INDEX(keycode)]) };
}

action_t keymap_func_to_action(uint16_t keycode)
{
    // For FUNC without 8bit limit
    return (action_t){ .code = pgm_read_word(&fn_actions[(int)keycode]) };
}

void update_tri_layer(uint8_t layer1, uint8_t layer2, uint8_t layer3) {
  if (IS_LAYER_ON(layer1) && IS_LAYER_ON(layer2)) {
    layer_on(layer3);
  } else {
    layer_off(layer3);
  }
}