Added Happy Buckling Keyboard.
[tmk_keyboard.git] / hbk / keymap.c
CommitLineData
f4bff66e 1/*
2Copyright 2012 Jun Wako <wakojun@gmail.com>
3
4This program is free software: you can redistribute it and/or modify
5it under the terms of the GNU General Public License as published by
6the Free Software Foundation, either version 2 of the License, or
7(at your option) any later version.
8
9This program is distributed in the hope that it will be useful,
10but WITHOUT ANY WARRANTY; without even the implied warranty of
11MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12GNU General Public License for more details.
13
14You should have received a copy of the GNU General Public License
15along with this program. If not, see <http://www.gnu.org/licenses/>.
16*/
17
18/*
19 * Keymap for Macway mod
20 */
21#include <stdint.h>
22#include <stdbool.h>
23#include <avr/pgmspace.h>
24#include "usb_keycodes.h"
25#include "print.h"
26#include "debug.h"
27#include "util.h"
28#include "keymap.h"
29
30
31/*
32 * Layout: 59key
33 * ,-----------------------------------------------------------.
34 * |Esc| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =| \| `|
35 * |-----------------------------------------------------------|
36 * |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| BS |
37 * |-----------------------------------------------------------|
38 * |Contro| A| S| D| F| G| H| J| K| L|Fn3| '|Return |
39 * |-----------------------------------------------------------|
40 * |Shift | Z| X| C| V| B| N| M| ,| .|Fn2|Shift |
41 * |-----------------------------------------------------------|
42 * |Ctrl | |Alt | Fn4 |Alt | |Fn1 |
43 * `-----' `---------------------------------------' `-----'
44 *
45 * Matrix: 12x8
46 * | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7
47 * ---+---------+---------+---------+---------+---------+---------+---------+---------
48 * 0 | | | LCTRL | | | | RCTRL |
49 * 1 | | LSHIFT | | | | | RSHIFT |
50 * 2 | | Tab | Grave | 1 | Q | A | Z |
51 * 3 | | Cpslck | | 2 | W | S | X |
52 * 4 | | | | 3 | E | D | C |
53 * 5 | G | T | 5 | 4 | R | F | V | B
54 * 6 | | Bckspc | | | Key*1 | Bckslsh | Enter | Space
55 * 7 | H | Y | 6 | 7 | U | J | M | N
56 * 8 | | Rbrckt | Equal | 8 | I | K | Comma |
57 * 9 | | | | 9 | O | L | Dot |
58 * A | | Lbrckt | Minus | 0 | P | Smcolon | | Slash
59 * B | LALT | | | | | | | RALT
60 * Key*1 This key locates between Equal and Backspace.
61 *
62 * Original matrix here: http://geekhack.org/showthread.php?7767-Wireless-Model-M&p=133911&viewfull=1#post133911
63 */
64#define KEYMAP( \
65 K22, K23, K33, K43, K53, K52, K72, K73, K83, K93, KA3, KA2, K82, K64, K61, \
66 K21, K24, K34, K44, K54, K51, K71, K74, K84, K94, KA4, KA1, K81, K65, \
67 K31, K25, K35, K45, K55, K50, K70, K75, K85, K95, KA5, KA0, K66, \
68 K11, K26, K36, K46, K56, K57, K77, K76, K86, K96, KA7, K16, \
69 K02, KB0, K67, KB7, K06 \
70) { \
71 { KB_NO, KB_NO, KB_##K02, KB_NO, KB_NO, KB_NO, KB_##K06, KB_NO }, \
72 { KB_NO, KB_##K11, KB_NO, KB_NO, KB_NO, KB_NO, KB_##K16, KB_NO }, \
73 { KB_NO, KB_##K21, KB_##K22, KB_##K23, KB_##K24, KB_##K25, KB_##K26, KB_NO }, \
74 { KB_NO, KB_##K31, KB_NO, KB_##K33, KB_##K34, KB_##K35, KB_##K36, KB_NO }, \
75 { KB_NO, KB_NO, KB_NO, KB_##K43, KB_##K44, KB_##K45, KB_##K46, KB_NO }, \
76 { KB_##K50, KB_##K51, KB_##K52, KB_##K53, KB_##K54, KB_##K55, KB_##K56, KB_##K57 }, \
77 { KB_NO, KB_##K61, KB_NO, KB_NO, KB_##K64, KB_##K65, KB_##K66, KB_##K67 }, \
78 { KB_##K70, KB_##K71, KB_##K72, KB_##K73, KB_##K74, KB_##K75, KB_##K76, KB_##K77 }, \
79 { KB_NO, KB_##K81, KB_##K82, KB_##K83, KB_##K84, KB_##K85, KB_##K86, KB_NO }, \
80 { KB_NO, KB_NO, KB_NO, KB_##K93, KB_##K94, KB_##K95, KB_##K96, KB_NO }, \
81 { KB_##KA0, KB_##KA1, KB_##KA2, KB_##KA3, KB_##KA4, KB_##KA5, KB_NO, KB_##KA7 }, \
82 { KB_##KB0, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KB_##KB7 }, \
83}
84
85#define KEYCODE(layer, row, col) (pgm_read_byte(&keymaps[(layer)][(row)][(col)]))
86
87
88// Assign Fn key(0-7) to a layer to which switch with the Fn key pressed.
89static const uint8_t PROGMEM fn_layer[] = {
90 0, // Fn0
91 1, // Fn1
92 2, // Fn2
93 3, // Fn3
94 4, // Fn4
95 0, // Fn5
96 0, // Fn6
97 0 // Fn7
98};
99
100// Assign Fn key(0-7) to a keycode sent when release Fn key without use of the layer.
101// See layer.c for details.
102static const uint8_t PROGMEM fn_keycode[] = {
103 KB_NO, // Fn0
104 KB_NO, // Fn1
105 KB_SLSH, // Fn2
106 KB_SCLN, // Fn3
107 KB_SPC, // Fn4
108 KB_NO, // Fn5
109 KB_NO, // Fn6
110 KB_NO // Fn7
111};
112
113static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
114 /* Layer 0: Default Layer
115 * ,-----------------------------------------------------------.
116 * |Esc| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =| \| `|
117 * |-----------------------------------------------------------|
118 * |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| BS |
119 * |-----------------------------------------------------------|
120 * |Contro| A| S| D| F| G| H| J| K| L|Fn3| '|Return |
121 * |-----------------------------------------------------------|
122 * |Shift | Z| X| C| V| B| N| M| ,| .|Fn2|Shift |
123 * |-----------------------------------------------------------|
124 * |Ctrl | |Alt | Fn4 |Alt | |Fn1 |
125 * `-----' `---------------------------------------' `-----'
126 */
127 KEYMAP(ESC, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, MINS,EQL, BSLS,GRV, \
128 TAB, Q, W, E, R, T, Y, U, I, O, P, LBRC,RBRC,BSPC, \
129 LCTL,A, S, D, F, G, H, J, K, L, FN3, QUOT,ENT, \
130 LSFT,Z, X, C, V, B, N, M, COMM,DOT, FN2, FN1, \
131 LGUI, LALT, FN4, RALT, FN1),
132
133
134 /* Layer 1: HHKB mode (HHKB Fn)
135 * ,-----------------------------------------------------------.
136 * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
137 * |-----------------------------------------------------------|
138 * |Caps | | | | | | | |Psc|Slk|Pus|Up | | |
139 * |-----------------------------------------------------------|
140 * |Contro|VoD|VoU|Mut| | | *| /|Hom|PgU|Lef|Rig| |
141 * |-----------------------------------------------------------|
142 * |Shift | | | | | | +| -|End|PgD|Dow|Shift |
143 * |-----------------------------------------------------------|
144 * |Ctrl | |Alt | Space |Alt | |Fn1 |
145 * `-----' `---------------------------------------' `-----'
146 */
147 KEYMAP(ESC, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, INS, DEL, \
148 CAPS,NO, NO, NO, NO, NO, NO, NO, PSCR,SLCK,BRK, UP, NO, NO, \
149 LCTL,VOLD,VOLU,MUTE,NO, NO, PAST,PSLS,HOME,PGUP,LEFT,RGHT,NO, \
150 LSFT,NO, NO, NO, NO, NO, PPLS,PMNS,END, PGDN,DOWN,FN1, \
151 LGUI, LALT, SPC, RALT, FN1),
152
153
154 /* Layer 2: Vi mode (Quote/Rmeta)
155 * ,-----------------------------------------------------------.
156 * | `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12| | |
157 * |-----------------------------------------------------------|
158 * | \ |Hom|PgD|Up |PgU|End|Hom|PgD|PgU|End| | | | |
159 * |-----------------------------------------------------------|
160 * |Contro| |Lef|Dow|Rig| |Lef|Dow|Up |Rig| | | |
161 * |-----------------------------------------------------------|
162 * |Shift | | | | | |Hom|PgD|PgU|End|xxx|Shift |
163 * |-----------------------------------------------------------|
164 * |Ctrl | |Alt | Space |Alt | |Fn1 |
165 * `-----' `---------------------------------------' `-----'
166 */
167 KEYMAP(GRV, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, NO, NO, \
168 BSLS,HOME,PGDN,UP, PGUP,END, HOME,PGDN,PGUP,END, NO, NO, NO, NO, \
169 LCTL,NO, LEFT,DOWN,RGHT,NO, LEFT,DOWN,UP, RGHT,NO, NO, NO, \
170 LSFT,NO, NO, NO, NO, NO, HOME,PGDN,PGUP,END, FN2, RSFT, \
171 LGUI, LALT, SPC, RALT, NO),
172
173
174
175 /* Layer 3: Mouse mode (Semicolon)
176 * ,-----------------------------------------------------------.
177 * | `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12| | |
178 * |-----------------------------------------------------------|
179 * | \ |MwL|MwD|McU|MwU|MwR|MwL|MwD|MwU|MwR| | | | |
180 * |-----------------------------------------------------------|
181 * |Contro| |McL|McD|McR| |McL|McD|McU|McR|xxx| | |
182 * |-----------------------------------------------------------|
183 * |Shift | | |Mb1|Mb2|Mb3|Mb2|Mb1| | | |Shift |
184 * |-----------------------------------------------------------|
185 * |Ctrl | |Alt | Space |Alt | | |
186 * `-----' `---------------------------------------' `-----'
187 * Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel
188 */
189 KEYMAP(GRV, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, NO, NO, \
190 BSLS,WH_L,WH_D,MS_U,WH_U,WH_R,WH_L,WH_D,WH_U,WH_R,NO, NO, NO, NO, \
191 LCTL,NO, MS_L,MS_D,MS_R,NO, MS_L,MS_D,MS_U,MS_R,FN3, NO, NO, \
192 LSFT,NO, NO, BTN1,BTN2,BTN3,BTN2,BTN1,NO, NO, NO, RSFT, \
193 LGUI, LALT, BTN1, RALT, NO),
194
195
196 /* Layer 4: Matias half keyboard style (Space)
197 * ,-----------------------------------------------------------.
198 * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delete |
199 * |-----------------------------------------------------------|
200 * |Backs| P| O| I| U| Y| T| R| E| W| Q| | |Tab |
201 * |-----------------------------------------------------------|
202 * |Contro| ;| L| K| J| H| G| F| D| S| A|Con|Control |
203 * |-----------------------------------------------------------|
204 * |Shift | /| .| ,| M| N| B| V| C| X| Z|Shift |
205 * |-----------------------------------------------------------|
206 * |Ctrl | |Alt | Fn4 |Alt | | |
207 * `-----' `---------------------------------------' `-----'
208 */
209 KEYMAP(MINS,0, 9, 8, 7, 6, 5, 4, 3, 2, 1, NO, NO, NO, ESC, \
210 BSPC,P, O, I, U, Y, T, R, E, W, Q, NO, NO, TAB, \
211 LCTL,SCLN,L, K, J, H, G, F, D, S, A, RCTL,RCTL, \
212 LSFT,SLSH,DOT, COMM,M, N, B, V, C, X, Z, RSFT, \
213 LGUI, LALT, FN4, RALT, NO),
214
215};
216
217
218uint8_t keymap_get_keycode(uint8_t layer, uint8_t row, uint8_t col)
219{
220 return KEYCODE(layer, row, col);
221}
222
223uint8_t keymap_fn_layer(uint8_t fn_bits)
224{
225 return pgm_read_byte(&fn_layer[biton(fn_bits)]);
226}
227
228uint8_t keymap_fn_keycode(uint8_t fn_bits)
229{
230 return pgm_read_byte(&fn_keycode[(biton(fn_bits))]);
231}
Imprint / Impressum