forked from cub-uanic/tmk_keyboard
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathkeymap.c
619 lines (598 loc) · 20.6 KB
/
keymap.c
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
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
/*
Copyright 2013 Oleg Kostyuk <[email protected]>
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 <stdint.h>
#include <stdbool.h>
#include <avr/pgmspace.h>
#include <util/delay.h>
#include "keycode.h"
#include "action.h"
#include "action_util.h"
#include "action_code.h"
#include "action_macro.h"
#include "action_layer.h"
#include "bootloader.h"
#include "report.h"
#include "host.h"
#include "print.h"
#include "debug.h"
#include "keymap.h"
#include "ergodox.h"
// Swedish defines for easier reading of layout
#define KC_AA KC_LBRACKET
#define KC_AE KC_QUOTE
#define KC_OE KC_SCOLON
#define KC_PLS KC_MINUS /* +, ? and \ */
#define KC_QUOT KC_BSLASH /* ' and * */
#define KC_MINS KC_SLASH /* - and _ */
#define KC_LTE KC_NONUS_BSLASH /* <, > and | */
#define KC_GRV KC_EQUAL /* ' (accent) and ` */
#define KC_TLDE KC_RBRACKET /* ", ^ and ~ */
// Alias for functions so keymap get's easier to read
/* layers */
#define KC_L0 KC_FN20
#define KC_L1 KC_FN21
#define KC_L2 KC_FN22
#define KC_L3 KC_FN23
/* layer+key combinations */
#define KC_ENR0 KC_FN24
#define KC_ENR3 KC_FN25
/* switched numbers and most common symbol without shift mod */
#define KC_INV1 KC_FN1
#define KC_INV2 KC_FN2
#define KC_INV3 KC_FN3
#define KC_INV4 KC_FN4
#define KC_INV5 KC_FN5
#define KC_INV6 KC_FN6
#define KC_INV7 KC_FN7
#define KC_INV8 KC_FN8
#define KC_INV9 KC_FN9
#define KC_INV0 KC_FN0
/* unique special char keys */
#define KC_LBRK KC_FN11 /* { and [ Left brackets */
#define KC_RBRK KC_FN12 /* } and ] Right brackets */
#define KC_BSHA KC_FN13 /* Backslash and @ */
#define KC_RTDE KC_FN14 /* Modified tilde. ~/ sequence, ^ and " */
#define KC_IMNS KC_FN15 /* _ and - Inverted minus */
#define KC_SCLN KC_FN16 /* Only semicolon */
#define KC_CLN KC_FN17 /* Colon and pipe */
#define KC_MNSA KC_FN18 /* -, ' (accent) and ` (grav accent) */
/* ErgoDox keymap definition macro */
#define KEYMAP( \
\
/* left hand, spatial positions */ \
k00,k01,k02,k03,k04,k05,k06, \
k10,k11,k12,k13,k14,k15,k16, \
k20,k21,k22,k23,k24,k25, \
k30,k31,k32,k33,k34,k35,k36, \
k40,k41,k42,k43,k44, \
k55,k56, \
k54, \
k53,k52,k51, \
\
/* right hand, spatial positions */ \
k07,k08,k09,k0A,k0B,k0C,k0D, \
k17,k18,k19,k1A,k1B,k1C,k1D, \
k28,k29,k2A,k2B,k2C,k2D, \
k37,k38,k39,k3A,k3B,k3C,k3D, \
k49,k4A,k4B,k4C,k4D, \
k57,k58, \
k59, \
k5C,k5B,k5A ) \
\
/* matrix positions */ \
{ \
{ KC_##k00,KC_##k10,KC_##k20,KC_##k30,KC_##k40,KC_NO }, \
{ KC_##k01,KC_##k11,KC_##k21,KC_##k31,KC_##k41,KC_##k51}, \
{ KC_##k02,KC_##k12,KC_##k22,KC_##k32,KC_##k42,KC_##k52}, \
{ KC_##k03,KC_##k13,KC_##k23,KC_##k33,KC_##k43,KC_##k53}, \
{ KC_##k04,KC_##k14,KC_##k24,KC_##k34,KC_##k44,KC_##k54}, \
{ KC_##k05,KC_##k15,KC_##k25,KC_##k35,KC_NO, KC_##k55}, \
{ KC_##k06,KC_##k16,KC_NO, KC_##k36,KC_NO, KC_##k56}, \
\
{ KC_##k07,KC_##k17,KC_NO, KC_##k37,KC_NO, KC_##k57}, \
{ KC_##k08,KC_##k18,KC_##k28,KC_##k38,KC_NO, KC_##k58}, \
{ KC_##k09,KC_##k19,KC_##k29,KC_##k39,KC_##k49,KC_##k59}, \
{ KC_##k0A,KC_##k1A,KC_##k2A,KC_##k3A,KC_##k4A,KC_##k5A}, \
{ KC_##k0B,KC_##k1B,KC_##k2B,KC_##k3B,KC_##k4B,KC_##k5B}, \
{ KC_##k0C,KC_##k1C,KC_##k2C,KC_##k3C,KC_##k4C,KC_##k5C}, \
{ KC_##k0D,KC_##k1D,KC_##k2D,KC_##k3D,KC_##k4D,KC_NO } \
}
static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
KEYMAP( // layer 0 : default
// left hand
L2, INV1,INV2,INV3,INV4,INV5,BSHA,
LTE, Q, W, E, R, T, LBRK,
TAB, A, S, D, F, G,
ESC, Z, X, C, V, B, HOME,
L1, LEFT,UP, DOWN,RGHT,
DEL, F5,
LALT,
LSFT,BSPC,RCTL,
// right hand
L3, INV6,INV7,INV8,INV9,INV0,PLS,
RBRK,Y, U, I, O, P, AA,
H, J, K, L, OE, AE,
END, N, M, COMM,DOT, IMNS,CLN,
QUOT,INS, RTDE,MNSA,SCLN,
RGUI,RALT,
PGUP,
PGDN,ENT, SPC
),
KEYMAP( // layer 1 : regular numbers, and some minor utility stuff
// left hand
TRNS,1, 2, 3, 4, 5, TRNS,
TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
L0, TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,
TRNS,
TRNS,TRNS,LCTL,
// right hand
TRNS,6, 7, 8, 9, 0, TRNS,
TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,TLDE,TRNS,TRNS,
TRNS,TRNS,
TRNS,
TRNS,TRNS,TRNS
),
KEYMAP( // layer 2 : f-keys, numpad, media keys, misc
// left hand
L0, F1, F2, F3, F4, F5, F12,
TRNS,VOLD,VOLU,MPLY,MPRV,TRNS,TRNS,
TRNS,TRNS,MUTE,MSTP,MNXT,TRNS,
TRNS,TRNS,PSCR,PAUS,SLCK,TRNS,TRNS,
TRNS,TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,
TRNS,
TRNS,TRNS,TRNS,
// right hand
TRNS,F6, F7, F8, F9, F10, F11,
TRNS,PAST,P7, P8, P9, NLCK,TRNS,
PPLS,P4, P5, P6, TRNS,TRNS,
TRNS,PMNS,P1, P2, P3, PSLS,TRNS,
P0, PDOT,NO, TRNS,TRNS,
TRNS,TRNS,
TRNS,
TRNS,TRNS,TRNS
),
KEYMAP( // layer 3: gaming layer (some games can't bind special char keys
// left hand
TAB, 1, 2, 3, 4, 5, 6,
H, TRNS,TRNS,TRNS,TRNS,TRNS,END,
J, TRNS,TRNS,TRNS,TRNS,TRNS,
K, TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
L, TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,
TRNS,
TRNS,SPC ,TRNS,
// right hand
L0, 6, 7, 8, 9, 0, ESC,
TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,
TRNS,
TRNS,ENR0,TRNS
),
KEYMAP( // layer 4: gaming typing layer, resets to "gaming layer" on enter
// left hand
TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,
TRNS,
TRNS,TRNS,TRNS,
// right hand
L0, TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,TRNS,TRNS,TRNS,
TRNS,TRNS,
TRNS,
TRNS,ENR3,TRNS
),
};
/* id for user defined functions */
enum function_id {
INV_0,
INV_1,
INV_2,
INV_3,
INV_4,
INV_5,
INV_6,
INV_7,
INV_8,
INV_9,
FN_LCBRACKET,
FN_RCBRACKET,
FN_TILDE,
FN_UNDERSCR,
FN_MINUS_ACCENT,
FN_COLON_PIPE,
FN_BASHSLAH_AT,
SET_L1_WITH_LED,
SET_L2_WITH_LED,
SET_L3_WITH_LED,
SET_L0_LED_OFF,
ENR0,
ENR3,
};
/*
* Fn action definition
*/
static const uint16_t PROGMEM fn_actions[] = {
[0] = ACTION_FUNCTION(INV_0),
[1] = ACTION_FUNCTION(INV_1),
[2] = ACTION_FUNCTION(INV_2),
[3] = ACTION_FUNCTION(INV_3),
[4] = ACTION_FUNCTION(INV_4),
[5] = ACTION_FUNCTION(INV_5),
[6] = ACTION_FUNCTION(INV_6),
[7] = ACTION_FUNCTION(INV_7),
[8] = ACTION_FUNCTION(INV_8),
[9] = ACTION_FUNCTION(INV_9),
[11] = ACTION_FUNCTION(FN_LCBRACKET),
[12] = ACTION_FUNCTION(FN_RCBRACKET),
[13] = ACTION_FUNCTION(FN_BASHSLAH_AT),
[14] = ACTION_FUNCTION(FN_TILDE),
[15] = ACTION_FUNCTION(FN_UNDERSCR),
[16] = ACTION_MODS_KEY(MOD_RSFT, KC_COMM), // ;
[17] = ACTION_FUNCTION(FN_COLON_PIPE),
[18] = ACTION_FUNCTION(FN_MINUS_ACCENT),
[20] = ACTION_FUNCTION(SET_L0_LED_OFF),
[21] = ACTION_FUNCTION(SET_L1_WITH_LED),
[22] = ACTION_FUNCTION(SET_L2_WITH_LED),
[23] = ACTION_FUNCTION(SET_L3_WITH_LED),
[24] = ACTION_FUNCTION(ENR0),
[25] = ACTION_FUNCTION(ENR3),
};
/* Set layer 3 and light up led on teensy board.
* Gaming layer
*/
void set_layer3_with_led(void) {
ergodox_right_led_3_off();
ergodox_right_led_2_off();
ergodox_right_led_1_on();
layer_clear();
layer_on(3);
}
/* Set layer 2 and light up led on teensy board.
* Function layer
*/
void set_layer2_with_led(void) {
ergodox_right_led_1_off();
ergodox_right_led_2_off();
ergodox_right_led_3_on();
layer_clear();
layer_on(2);
}
/* Set layer 1 and light up led on teensy board.
* Number layer
*/
void set_layer1_with_led(void) {
ergodox_right_led_3_off();
ergodox_right_led_1_off();
ergodox_right_led_2_on();
layer_clear();
layer_on(1);
}
/* Set layer 0 and light up led on teensy board.
*/
void set_layer0_switch_led_off(void) {
layer_clear();
ergodox_right_led_3_off();
ergodox_right_led_1_off();
ergodox_right_led_2_off();
}
/* add a shifted mod if no mod,
* remove shited mod if shift mod only,
* let all other mod combinations through without alteration.
*/
void inv_key(uint8_t key) {
// invert shifting
if (get_mods() == MOD_BIT(KC_LSHIFT)) {
del_mods(MOD_BIT(KC_LSHIFT));
} else if (get_mods() == 0) { // don't use else, this lets other mod combos through
add_mods(MOD_BIT(KC_LSHIFT));
}
register_code(key);
// reset mods, otherwise quick keypresses can result in bugs (wrong mod state)
if (get_mods() == MOD_BIT(KC_LSHIFT)) {
del_mods(MOD_BIT(KC_LSHIFT));
} else if (get_mods() == 0) { // don't use else, this lets other mod combos through
add_mods(MOD_BIT(KC_LSHIFT));
}
}
void action_function(keyrecord_t *record, uint8_t id, uint8_t opt)
{
keyevent_t event = record->event;
tap_t tap = record->tap;
switch (id) {
case INV_0:
if (event.pressed) {
inv_key(KC_0);
} else {
unregister_code(KC_0);
}
break;
case INV_1:
if (event.pressed) {
inv_key(KC_1);
} else {
unregister_code(KC_1);
}
break;
case INV_2:
if (event.pressed) {
inv_key(KC_2);
} else {
unregister_code(KC_2);
}
break;
case INV_3:
if (event.pressed) {
inv_key(KC_3);
} else {
unregister_code(KC_3);
}
break;
case INV_4:
if (event.pressed) {
uint8_t mods = get_mods();
if (mods == 0) { // $
set_mods(MOD_BIT(KC_RALT));
register_code(KC_4);
clear_mods();
} else if (mods == MOD_BIT(KC_LSHIFT)) { // 4
clear_mods();
register_code(KC_4);
set_mods(MOD_BIT(KC_LSHIFT));
} else if (mods == MOD_BIT(KC_RALT)) { // ¤
set_mods(MOD_BIT(KC_LSHIFT));
register_code(KC_4);
set_mods(MOD_BIT(KC_RALT));
}
} else {
unregister_code(KC_4);
}
break;
case INV_5:
if (event.pressed) {
inv_key(KC_5);
} else {
unregister_code(KC_5);
}
break;
case INV_6:
if (event.pressed) {
inv_key(KC_6);
} else {
unregister_code(KC_6);
}
break;
case INV_7:
if (event.pressed) {
inv_key(KC_7);
} else {
unregister_code(KC_7);
}
break;
case INV_8:
if (event.pressed) {
inv_key(KC_8);
} else {
unregister_code(KC_8);
}
break;
case INV_9:
if (event.pressed) {
inv_key(KC_9);
} else {
unregister_code(KC_9);
}
break;
case FN_LCBRACKET:
if (event.pressed) {
if (get_mods() == MOD_BIT(KC_LSHIFT)) { // [ if shifted
set_mods(MOD_BIT(KC_RALT));
send_keyboard_report();
register_code(KC_8);
set_mods(MOD_BIT(KC_LSHIFT));
} else { // { otherwise
set_mods(MOD_BIT(KC_RALT));
send_keyboard_report();
register_code(KC_7);
clear_mods();
}
} else {
unregister_code(KC_8);
unregister_code(KC_7);
}
break;
case FN_RCBRACKET:
if (event.pressed) {
if (get_mods() == MOD_BIT(KC_LSHIFT)) { // ] if shifted
set_mods(MOD_BIT(KC_RALT));
register_code(KC_9);
set_mods(MOD_BIT(KC_LSHIFT));
} else { // } otherwise
set_mods(MOD_BIT(KC_RALT));
register_code(KC_0);
clear_mods();
}
} else {
unregister_code(KC_9);
unregister_code(KC_0);
}
break;
case FN_TILDE:
if (event.pressed) {
uint8_t mods = get_mods();
if (mods == 0) { // ~/
set_mods(MOD_BIT(KC_RALT));
send_keyboard_report();
register_code(KC_TLDE);
unregister_code(KC_TLDE);
// don't want to also press space for tilde
register_code(KC_SPC);
unregister_code(KC_SPC);
clear_mods();
send_keyboard_report();
// (almost) always writing ~/ anyways so add the /
inv_key(KC_7);
unregister_code(KC_7);
} else if (mods == MOD_BIT(KC_LSHIFT)) { // ^
register_code(KC_TLDE);
} else if (mods == MOD_BIT(KC_RALT)) { // "
clear_mods();
register_code(KC_TLDE);
set_mods(MOD_BIT(KC_RALT));
}
} else {
uint8_t mods = get_mods();
// Nothing to unregister if mods == 0, which means ~
if (mods != 0) {
unregister_code(KC_TLDE);
}
}
break;
case FN_COLON_PIPE:
if (event.pressed) {
if (get_mods() == MOD_BIT(KC_LSHIFT)) { // | if shifted
set_mods(MOD_BIT(KC_RALT));
register_code(KC_LTE);
set_mods(MOD_BIT(KC_LSHIFT));
} else { // : otherwise
set_mods(MOD_BIT(KC_LSHIFT));
register_code(KC_DOT);
clear_mods();
}
} else {
unregister_code(KC_LTE);
unregister_code(KC_DOT);
}
break;
case FN_BASHSLAH_AT:
if (event.pressed) {
if (get_mods() == MOD_BIT(KC_LSHIFT)) { // @ if shifted
set_mods(MOD_BIT(KC_RALT));
register_code(KC_2);
set_mods(MOD_BIT(KC_LSHIFT));
} else { // \ otherwise
set_mods(MOD_BIT(KC_RALT));
register_code(KC_PLS);
clear_mods();
}
} else {
unregister_code(KC_2);
unregister_code(KC_PLS);
}
break;
case FN_MINUS_ACCENT:
if (event.pressed) {
uint8_t mods = get_mods();
if (mods == 0) { // -
register_code(KC_MINS);
} else if (mods == MOD_BIT(KC_LSHIFT)) { // ' (accent)
clear_mods();
register_code(KC_GRV);
set_mods(MOD_BIT(KC_LSHIFT));
} else if (mods == MOD_BIT(KC_RALT)) { // ` (grave accent)
set_mods(MOD_BIT(KC_LSHIFT));
register_code(KC_GRV);
set_mods(MOD_BIT(KC_RALT));
}
} else {
unregister_code(KC_MINS);
unregister_code(KC_GRV);
}
break;
case FN_UNDERSCR:
if (event.pressed) {
inv_key(KC_MINS);
} else {
unregister_code(KC_MINS);
}
break;
case SET_L0_LED_OFF:
if (event.pressed) {
set_layer0_switch_led_off();
}
break;
case SET_L1_WITH_LED:
if (event.pressed) {
set_layer1_with_led();
}
break;
case SET_L2_WITH_LED:
if (event.pressed) {
set_layer2_with_led();
}
break;
case SET_L3_WITH_LED:
if (event.pressed) {
set_layer3_with_led();
}
break;
case ENR0:
if (event.pressed) {
register_code(KC_ENTER);
} else {
unregister_code(KC_ENTER);
layer_clear();
layer_on(4);
}
break;
case ENR3:
if (event.pressed) {
register_code(KC_ENTER);
} else {
unregister_code(KC_ENTER);
layer_clear();
layer_on(3);
}
break;
}
}
#define KEYMAPS_SIZE (sizeof(keymaps) / sizeof(keymaps[0]))
#define FN_ACTIONS_SIZE (sizeof(fn_actions) / sizeof(fn_actions[0]))
/* translates key to keycode */
uint8_t keymap_key_to_keycode(uint8_t layer, key_t key)
{
if (layer < KEYMAPS_SIZE) {
return pgm_read_byte(&keymaps[(layer)][(key.row)][(key.col)]);
} else {
// fall back to layer 0
return pgm_read_byte(&keymaps[0][(key.row)][(key.col)]);
}
}
/* translates Fn keycode to action */
action_t keymap_fn_to_action(uint8_t keycode)
{
action_t action;
if (FN_INDEX(keycode) < FN_ACTIONS_SIZE) {
action.code = pgm_read_word(&fn_actions[FN_INDEX(keycode)]);
} else {
action.code = ACTION_NO;
}
return action;
}