]> git.friedersdorff.com Git - max/tmk_keyboard.git/blob - hhkb/keymap.c
revise Fn key processing.
[max/tmk_keyboard.git] / hhkb / keymap.c
1 /* 
2  * Keymap for PFU HHKB Pro
3  */
4 #include <stdint.h>
5 #include <stdbool.h>
6 #include <avr/pgmspace.h>
7 #include "usb_keyboard.h"
8 #include "usb_keycodes.h"
9 #include "print.h"
10 #include "debug.h"
11 #include "util.h"
12 #include "controller.h"
13 #include "keymap_skel.h"
14
15
16 #define KEYMAP( \
17     R3C1, R3C0, R0C0, R1C0, R1C1, R2C0, R2C1, R4C0, R4C1, R6C0, R6C1, R7C0, R7C1, R5C0, R5C1, \
18     R3C2, R0C1, R0C2, R1C3, R1C2, R2C3, R2C2, R4C2, R4C3, R6C2, R6C3, R7C3, R7C2, R5C2, \
19     R3C3, R0C4, R0C3, R1C4, R1C5, R2C4, R2C5, R4C5, R4C4, R6C5, R6C4, R7C4, R5C3, \
20     R3C4, R0C5, R0C6, R0C7, R1C6, R1C7, R2C6, R4C6, R6C6, R7C6, R7C5, R5C5, R5C4, \
21     R3C5, R3C6, R3C7, R5C7, R5C6 \
22 ) \
23 { \
24     { R0C0, R0C1, R0C2, R0C3, R0C4, R0C5, R0C6, R0C7 }, \
25     { R1C0, R1C1, R1C2, R1C3, R1C4, R1C5, R1C6, R1C7 }, \
26     { R2C0, R2C1, R2C2, R2C3, R2C4, R2C5, R2C6, KB_NO }, \
27     { R3C0, R3C1, R3C2, R3C3, R3C4, R3C5, R3C6, R3C7 }, \
28     { R4C0, R4C1, R4C2, R4C3, R4C4, R4C5, R4C6, KB_NO }, \
29     { R5C0, R5C1, R5C2, R5C3, R5C4, R5C5, R5C6, R5C7 }, \
30     { R6C0, R6C1, R6C2, R6C3, R6C4, R6C5, R6C6, KB_NO }, \
31     { R7C0, R7C1, R7C2, R7C3, R7C4, R7C5, R7C6, KB_NO } \
32 }
33
34 #define KEYCODE(layer, row, col) (pgm_read_byte(&keymaps[(layer)][(row)][(col)]))
35
36
37 /* layer to change into while Fn key pressed */ 
38 static const int PROGMEM fn_layer[] = { 0, 1, 2, 3, 4, 0, 0, 1 };
39
40 /* keycode to sent when Fn key released without using layer keys. */
41 static const uint8_t PROGMEM fn_keycode[] = {
42     KB_NO,          // FN_0 [NOT USED]
43     KB_NO,          // FN_1 layer 1
44     KB_QUOTE,       // FN_2 layer 2
45     KB_SCOLON,      // FN_3 layer 3
46     KB_SPACE,       // FN_4 layer 4
47     KB_NO,          // FN_5 [NOT USED]
48     KB_NO,          // FN_6 [NOT USED]
49     KB_NO           // FN_7 layer 1
50 };
51
52 static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
53     /* Layer 0: Default Layer
54      * ,-----------------------------------------------------------.
55      * |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|  \|  `|
56      * |-----------------------------------------------------------|
57      * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|Backs|
58      * |-----------------------------------------------------------|
59      * |Contro|  A|  S|  D|  F|  G|  H|  J|  K|  L|Fn3|Fn2|Return  |
60      * |-----------------------------------------------------------|
61      * |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift |Fn1|
62      * `-----------------------------------------------------------'
63      *       |Gui|Alt  |Fn4                    |Alt  |Fn7|
64      *       `-------------------------------------------'
65      */
66     KEYMAP(KB_ESC, KB_1,   KB_2,   KB_3,   KB_4,   KB_5,   KB_6,   KB_7,   KB_8,   KB_9,   KB_0,   KB_MINS,KB_EQL, KB_BSLS,KB_GRV, \
67            KB_TAB, KB_Q,   KB_W,   KB_E,   KB_R,   KB_T,   KB_Y,   KB_U,   KB_I,   KB_O,   KB_P,   KB_LBRC,KB_RBRC,KB_BSPC, \
68            KB_LCTL,KB_A,   KB_S,   KB_D,   KB_F,   KB_G,   KB_H,   KB_J,   KB_K,   KB_L,   FN_3,   FN_2,   KB_ENT, \
69            KB_LSFT,KB_Z,   KB_X,   KB_C,   KB_V,   KB_B,   KB_N,   KB_M,   KB_COMM,KB_DOT, KB_SLSH,KB_RSFT,FN_1, \
70            KB_LGUI,KB_LALT,FN_4,   KB_RALT,FN_7),
71
72     /* Layer 1: HHKB mode (HHKB Fn)
73      * ,-----------------------------------------------------------.
74      * |Pow| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
75      * |-----------------------------------------------------------|
76      * |Caps |   |   |   |   |   |   |   |Psc|Slk|Pus|Up |   |Backs|
77      * |-----------------------------------------------------------|
78      * |Contro|   |   |   |   |   |  *|  /|Hom|PgU|Lef|Rig|Enter   |
79      * |-----------------------------------------------------------|
80      * |Shift   |   |   |   |   |   |  +|  -|End|PgD|Dow|Shift |xxx|
81      * `-----------------------------------------------------------'
82      *      |Gui |Alt  |Space                  |Alt  |xxx|
83      *      `--------------------------------------------'
84      */ 
85     KEYMAP(KB_PWR, KB_F1,  KB_F2,  KB_F3,  KB_F4,  KB_F5,  KB_F6,  KB_F7,  KB_F8,  KB_F9,  KB_F10, KB_F11, KB_F12, KB_INS, KB_DEL, \
86            KB_CAPS,KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_PSCR,KB_SLCK,KB_BRK, KB_UP,  KB_NO,  KB_BSPC, \
87            KB_LCTL,KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KP_ASTR,KP_SLSH,KB_HOME,KB_PGUP,KB_LEFT,KB_RGHT,KB_ENT, \
88            KB_LSFT,KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KP_PLUS,KP_MINS,KB_END, KB_PGDN,KB_DOWN,KB_RSFT,FN_1, \
89            KB_LGUI,KB_LALT,KB_SPC, KB_RALT,FN_7),
90
91     /* Layer 2: Vi mode (Quote/Rmeta)
92      * ,-----------------------------------------------------------.
93      * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
94      * |-----------------------------------------------------------|
95      * |Tab  |Hom|PgD|Up |PgU|End|Hom|PgD|PgUlEnd|   |   |   |Backs|
96      * |-----------------------------------------------------------|
97      * |Contro|   |Lef|Dow|Rig|   |Lef|Dow|Up |Rig|   |xxx|Return  |
98      * |-----------------------------------------------------------|
99      * |Shift   |   |   |   |   |   |   |   |   |   |   |Shift |   |
100      * `-----------------------------------------------------------'
101      *       |Gui|Alt  |Space                  |Alt  |Gui|
102      *       `-------------------------------------------'
103      */
104     KEYMAP(KB_ESC, KB_F1,  KB_F2,  KB_F3,  KB_F4,  KB_F5,  KB_F6,  KB_F7,  KB_F8,  KB_F9,  KB_F10, KB_F11, KB_F12, KB_INS, KB_DEL, \
105            KB_TAB, KB_HOME,KB_PGDN,KB_UP,  KB_PGUP,KB_END, KB_HOME,KB_PGDN,KB_PGUP,KB_END, KB_NO,  KB_NO,  KB_NO,  KB_BSPC, \
106            KB_LCTL,KB_NO,  KB_LEFT,KB_DOWN,KB_RGHT,KB_NO,  KB_LEFT,KB_DOWN,KB_UP,  KB_RGHT,KB_NO,  FN_2,   KB_ENT, \
107            KB_LSFT,KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_RSFT,KB_NO, \
108            KB_LGUI,KB_LALT,KB_SPC, KB_RALT,KB_RGUI),
109
110     /* Layer 3: Mouse mode (Semicolon)
111      * ,-----------------------------------------------------------.
112      * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
113      * |-----------------------------------------------------------|
114      * |Tab  |MwL|MwU|McU|MwD|MwR|MwL|MwD|MwU|MwR|   |   |   |Backs|
115      * |-----------------------------------------------------------|
116      * |Contro|   |McL|McD|McR|   |McL|McD|McU|McR|xxx|   |Return  |
117      * |-----------------------------------------------------------|
118      * |Shift   |   |   |   |   |   |Mb2|Mb1|Mb2|Mb3|   |Shift |   |
119      * `-----------------------------------------------------------'
120      *      |Gui |Alt  |Mb1                    |Alt  |Gui|
121      *      `--------------------------------------------'
122      * Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel 
123      */
124     KEYMAP(KB_ESC, KB_F1,  KB_F2,  KB_F3,  KB_F4,  KB_F5,  KB_F6,  KB_F7,  KB_F8,  KB_F9,  KB_F10, KB_F11, KB_F12, KB_INS, KB_DEL, \
125            KB_TAB, MS_WH_L,MS_WH_U,MS_UP,  MS_WH_D,MS_WH_R,MS_WH_L,MS_WH_D,MS_WH_U,MS_WH_R,KB_NO,  KB_NO,  KB_NO,  KB_BSPC, \
126            KB_LCTL,KB_NO,  MS_LEFT,MS_DOWN,MS_RGHT,KB_NO,  MS_LEFT,MS_DOWN,MS_UP,  MS_RGHT,FN_3,   KB_NO,  KB_ENT, \
127            KB_LSFT,KB_NO,  MS_DOWN,KB_NO,  KB_NO,  KB_NO,  MS_BTN2,MS_BTN1,MS_BTN2,MS_BTN3,KB_NO,  KB_RSFT,KB_NO, \
128            KB_LGUI,KB_LALT,MS_BTN1,KB_RALT,KB_RGUI),
129
130     /* Layer 4: Matias half keyboard style (Space)
131      * ,-----------------------------------------------------------.
132      * |  -|  0|  9|  8|  7|  6|  5|  4|  3|  2|  1|   |   |   |Esc|
133      * |-----------------------------------------------------------|
134      * |Backs|  P|  O|  I|  U|  Y|  T|  R|  E|  W|  Q|   |   |Tab  |
135      * |-----------------------------------------------------------|
136      * |Contro|  ;|  L|  K|  J|  H|  G|  F|  D|  S|  A|Con|Control |
137      * |-----------------------------------------------------------|
138      * |Shift   |  /|  .|  ,|  M|  N|  B|  V|  C|  X|  Z|Shift |   |
139      * `-----------------------------------------------------------'
140      *      |Gui |Alt  |xxxxxxxxxxxxxxxxxxxxxxx|Alt  |Gui|
141      *      `--------------------------------------------'
142      */
143     KEYMAP(KB_MINS,KB_0,   KB_9,   KB_8,   KB_7,   KB_6,   KB_5,   KB_4,   KB_3,   KB_2,   KB_1,   KB_NO,  KB_NO,  KB_NO,  KB_ESC, \
144            KB_BSPC,KB_P,   KB_O,   KB_I,   KB_U,   KB_Y,   KB_T,   KB_R,   KB_E,   KB_W,   KB_Q,   KB_NO,  KB_NO,  KB_TAB, \
145            KB_LCTL,KB_SCLN,KB_L,   KB_K,   KB_J,   KB_H,   KB_G,   KB_F,   KB_D,   KB_S,   KB_A,   KB_RCTL,KB_RCTL, \
146            KB_LSFT,KB_SLSH,KB_DOT, KB_COMM,KB_M,   KB_N,   KB_B,   KB_V,   KB_C,   KB_X,   KB_Z,   KB_RSFT,KB_NO, \
147            KB_LGUI,KB_LALT,FN_4,   KB_RALT,KB_RGUI)
148 };
149
150
151 uint8_t keymap_get_keycode(uint8_t layer, uint8_t row, uint8_t col)
152 {
153     return KEYCODE(layer, row, col);
154 }
155
156 int keymap_fn_layer(uint8_t fn_bits)
157 {
158     return pgm_read_byte(&fn_layer[biton(fn_bits)]);
159 }
160
161 uint8_t keymap_fn_keycode(uint8_t fn_bits)
162 {
163     return pgm_read_byte(&fn_keycode[(biton(fn_bits))]);
164 }
165
166 bool keymap_is_special_mode(uint8_t fn_bits)
167 {
168     return (usb_keyboard_mods == (BIT_LCTRL | BIT_LSHIFT | BIT_LALT | BIT_LGUI));
169 }