Keyboard firmwares for Atmel AVR and Cortex-M
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

keymap.c 15KB

11 years ago
13 years ago
13 years ago
13 years ago
11 years ago
13 years ago
13 years ago
11 years ago
11 years ago
13 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
13 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342
  1. /*
  2. Copyright 2011,2012,2013 Jun Wako <[email protected]>
  3. This program is free software: you can redistribute it and/or modify
  4. it under the terms of the GNU General Public License as published by
  5. the Free Software Foundation, either version 2 of the License, or
  6. (at your option) any later version.
  7. This program is distributed in the hope that it will be useful,
  8. but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. GNU General Public License for more details.
  11. You should have received a copy of the GNU General Public License
  12. along with this program. If not, see <http://www.gnu.org/licenses/>.
  13. */
  14. /*
  15. * Keymap for PFU HHKB Pro
  16. */
  17. #include <stdint.h>
  18. #include <stdbool.h>
  19. #include <avr/pgmspace.h>
  20. #include "keycode.h"
  21. #include "action.h"
  22. #include "action_macro.h"
  23. #include "report.h"
  24. #include "host.h"
  25. #include "debug.h"
  26. #include "keymap.h"
  27. #define KEYMAP( \
  28. K31, K30, K00, K10, K11, K20, K21, K40, K41, K60, K61, K70, K71, K50, K51, \
  29. K32, K01, K02, K13, K12, K23, K22, K42, K43, K62, K63, K73, K72, K52, \
  30. K33, K04, K03, K14, K15, K24, K25, K45, K44, K65, K64, K74, K53, \
  31. K34, K05, K06, K07, K16, K17, K26, K46, K66, K76, K75, K55, K54, \
  32. K35, K36, K37, K57, K56 \
  33. ) \
  34. { \
  35. { KC_##K00, KC_##K01, KC_##K02, KC_##K03, KC_##K04, KC_##K05, KC_##K06, KC_##K07 }, \
  36. { KC_##K10, KC_##K11, KC_##K12, KC_##K13, KC_##K14, KC_##K15, KC_##K16, KC_##K17 }, \
  37. { KC_##K20, KC_##K21, KC_##K22, KC_##K23, KC_##K24, KC_##K25, KC_##K26, KC_NO }, \
  38. { KC_##K30, KC_##K31, KC_##K32, KC_##K33, KC_##K34, KC_##K35, KC_##K36, KC_##K37 }, \
  39. { KC_##K40, KC_##K41, KC_##K42, KC_##K43, KC_##K44, KC_##K45, KC_##K46, KC_NO }, \
  40. { KC_##K50, KC_##K51, KC_##K52, KC_##K53, KC_##K54, KC_##K55, KC_##K56, KC_##K57 }, \
  41. { KC_##K60, KC_##K61, KC_##K62, KC_##K63, KC_##K64, KC_##K65, KC_##K66, KC_NO }, \
  42. { KC_##K70, KC_##K71, KC_##K72, KC_##K73, KC_##K74, KC_##K75, KC_##K76, KC_NO } \
  43. }
  44. static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  45. /* Layer 0: Default Layer
  46. * ,-----------------------------------------------------------.
  47. * |Esc| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =| \| `|
  48. * |-----------------------------------------------------------|
  49. * |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]|Backs|
  50. * |-----------------------------------------------------------|
  51. * |Fn6 | A| S| D| F| G| H| J| K| L|Fn3| '|Return |
  52. * |-----------------------------------------------------------|
  53. * |Fn8 | Z| X| C| V| B| N| M| ,| .|Fn2|Fn12 |Fn1|
  54. * `-----------------------------------------------------------'
  55. * |Gui|Alt | Fn5 |Alt |Fn4|
  56. * `-------------------------------------------'
  57. */
  58. KEYMAP(ESC, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, MINS,EQL, BSLS,GRV, \
  59. TAB, Q, W, E, R, T, Y, U, I, O, P, LBRC,RBRC,BSPC, \
  60. FN6, A, S, D, F, G, H, J, K, L, FN3, QUOT,FN7, \
  61. FN8, Z, X, C, V, B, N, M, COMM,DOT, FN2, FN12,FN9, \
  62. LGUI,LALT, FN5, FN13,FN4),
  63. /* Layer 1: HHKB mode (HHKB Fn)
  64. * ,-----------------------------------------------------------.
  65. * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
  66. * |-----------------------------------------------------------|
  67. * |Caps | | | | | | | |Psc|Slk|Pus|Up | |Backs|
  68. * |-----------------------------------------------------------|
  69. * |Contro|VoD|VoU|Mut| | | *| /|Hom|PgU|Lef|Rig|Enter |
  70. * |-----------------------------------------------------------|
  71. * |Shift | | | | | | +| -|End|PgD|Dow|Shift |Fn0|
  72. * `-----------------------------------------------------------'
  73. * |Gui|Alt | Space |Alt |Gui|
  74. * `-------------------------------------------'
  75. */
  76. KEYMAP(PWR, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, INS, DEL, \
  77. CAPS,NO, NO, NO, NO, NO, NO, NO, PSCR,SLCK,PAUS, UP, NO, BSPC, \
  78. LCTL,VOLD,VOLU,MUTE,NO, NO, PAST,PSLS,HOME,PGUP,LEFT,RGHT,ENT, \
  79. LSFT,NO, NO, NO, NO, NO, PPLS,PMNS,END, PGDN,DOWN,RSFT,FN0, \
  80. LGUI,LALT, SPC, RALT,RGUI),
  81. /* Layer 2: Vi mode (Slash)
  82. * ,-----------------------------------------------------------.
  83. * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
  84. * |-----------------------------------------------------------|
  85. * |Tab |Hom|PgD|Up |PgU|End|Hom|PgD|PgUlEnd| | | |Backs|
  86. * |-----------------------------------------------------------|
  87. * |Contro| |Lef|Dow|Rig| |Lef|Dow|Up |Rig| | |Return |
  88. * |-----------------------------------------------------------|
  89. * |Shift | | | | | |Hom|PgD|PgUlEnd|Fn0|Shift | |
  90. * `-----------------------------------------------------------'
  91. * |Gui|Alt | Space |Alt |Gui|
  92. * `-------------------------------------------'
  93. */
  94. KEYMAP(ESC, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, INS, DEL, \
  95. TAB, HOME,PGDN,UP, PGUP,END, HOME,PGDN,PGUP,END, NO, NO, NO, BSPC, \
  96. LCTL,NO, LEFT,DOWN,RGHT,NO, LEFT,DOWN,UP, RGHT,NO, NO, ENT, \
  97. LSFT,NO, NO, NO, NO, NO, HOME,PGDN,PGUP,END, FN0, RSFT,NO, \
  98. LGUI,LALT, SPC, RALT,RGUI),
  99. /* Layer 3: Mouse mode (Semicolon)
  100. * ,-----------------------------------------------------------.
  101. * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
  102. * |-----------------------------------------------------------|
  103. * |Tab | | | | | |MwL|MwD|MwU|MwR| | | |Backs|
  104. * |-----------------------------------------------------------|
  105. * |Contro| | | | | |McL|McD|McU|McR|Fn0| |Return |
  106. * |-----------------------------------------------------------|
  107. * |Shift | | | | |Mb3|Mb2|Mb1|Mb4|Mb5| |Shift | |
  108. * `-----------------------------------------------------------'
  109. * |Gui |Alt | Mb1 |Alt |Fn0|
  110. * `--------------------------------------------'
  111. * Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel
  112. */
  113. KEYMAP(ESC, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, INS, DEL, \
  114. TAB, NO, NO, NO, NO, NO, WH_L,WH_D,WH_U,WH_R,NO, NO, NO, BSPC, \
  115. LCTL,NO, ACL0,ACL1,ACL2,NO, MS_L,MS_D,MS_U,MS_R,FN0, QUOT,ENT, \
  116. LSFT,NO, NO, NO, NO, BTN3,BTN2,BTN1,BTN4,BTN5,SLSH,RSFT,NO, \
  117. LGUI,LALT, BTN1, RALT,FN0),
  118. /* Layer 4: Matias half keyboard style (Space)
  119. * ,-----------------------------------------------------------.
  120. * | -| 0| 9| 8| 7| 6| 5| 4| 3| 2| 1| | | |Esc|
  121. * |-----------------------------------------------------------|
  122. * |Backs| P| O| I| U| Y| T| R| E| W| Q| | |Tab |
  123. * |-----------------------------------------------------------|
  124. * |Contro| ;| L| K| J| H| G| F| D| S| A|Con|Control |
  125. * |-----------------------------------------------------------|
  126. * |Shift | /| .| ,| M| N| B| V| C| X| Z|Shift | |
  127. * `-----------------------------------------------------------'
  128. * |Gui |Alt | Fn0 |Alt |Gui|
  129. * `--------------------------------------------'
  130. */
  131. KEYMAP(MINS,0, 9, 8, 7, 6, 5, 4, 3, 2, 1, NO, NO, NO, ESC, \
  132. BSPC,P, O, I, U, Y, T, R, E, W, Q, NO, NO, TAB, \
  133. LCTL,SCLN,L, K, J, H, G, F, D, S, A, RCTL,RCTL, \
  134. LSFT,SLSH,DOT, COMM,M, N, B, V, C, X, Z, RSFT,NO, \
  135. LGUI,LALT, FN0, RALT,RGUI),
  136. /* Layer5: another Mouse mode (Space)
  137. * ,-----------------------------------------------------------.
  138. * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
  139. * |-----------------------------------------------------------|
  140. * |Tab | | | | | |MwL|MwD|MwU|MwR| | | |Backs|
  141. * |-----------------------------------------------------------|
  142. * |Contro| | | | | |McL|McD|McU|McR|Fn0| |Return |
  143. * |-----------------------------------------------------------|
  144. * |Shift | | | | |Mb3|Mb2|Mb1|Mb4|Mb5| |Shift | |
  145. * `-----------------------------------------------------------'
  146. * |Gui |Alt | Fn0 |Alt |Fn0|
  147. * `--------------------------------------------'
  148. * Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel
  149. */
  150. KEYMAP(ESC, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, INS, DEL, \
  151. TAB, NO, NO, NO, NO, NO, WH_L,WH_D,WH_U,WH_R,NO, NO, NO, BSPC, \
  152. LCTL,NO, ACL0,ACL1,ACL2,NO, MS_L,MS_D,MS_U,MS_R,NO, NO, ENT, \
  153. LSFT,NO, NO, NO, NO, BTN3,BTN2,BTN1,BTN4,BTN5,NO, RSFT,NO, \
  154. LGUI,LALT, FN0, RALT,RGUI),
  155. };
  156. /* id for user defined functions */
  157. enum function_id {
  158. LSHIFT_LPAREN,
  159. RSHIFT_RPAREN,
  160. MACRO = 0xff
  161. };
  162. /*
  163. * Fn action definition
  164. */
  165. // TODO: use [1] = KEYMAP(...) to prevent from changing index of element?
  166. static const uint16_t PROGMEM fn_actions[] = {
  167. ACTION_LAYER_DEFAULT, // FN0
  168. ACTION_LAYER_SET(1), // FN1
  169. ACTION_LAYER_SET_TAP_KEY(2, KC_SLASH), // FN2 Layer with Slash
  170. ACTION_LAYER_SET_TAP_KEY(3, KC_SCLN), // FN3 Layer with Semicolon
  171. ACTION_LAYER_SET(3), // FN4
  172. // ACTION_LAYER_SET_TOGGLE(3), // FN4
  173. // ACTION_FUNCTION(MACRO, 0), // FN4
  174. ACTION_LAYER_SET_TAP_KEY(5, KC_SPC), // FN5
  175. // ACTION_LMOD_TAP_KEY(KC_LCTL, KC_BSPC), // FN6 Control with tap Backspace
  176. ACTION_LMOD_TAP_KEY(KC_LCTL, KC_ESC), // FN6 Control with tap Backspace
  177. ACTION_RMOD_TAP_KEY(KC_RCTL, KC_ENT), // FN7 Control with tap Enter
  178. ACTION_LMOD_ONESHOT(KC_LSFT), // FN8 Oneshot Shift
  179. ACTION_LAYER_SET_TAP_TOGGLE(1), // FN9
  180. ACTION_LAYER_BIT_TAP_KEY(1, KC_GRV), // FN10 Layer with Grave
  181. //ACTION_LAYER_BIT(1), // FN10
  182. //ACTION_LAYER_BIT_TAP_TOGGLE(1), // FN10
  183. ACTION_FUNCTION_TAP(LSHIFT_LPAREN), // FN11 Function: LShift with tap '('
  184. ACTION_FUNCTION_TAP(RSHIFT_RPAREN), // FN12 Function: RShift with tap ')'
  185. ACTION_FUNCTION(MACRO, 1), // FN13 Macro:
  186. };
  187. /*
  188. * Macro definition
  189. */
  190. #define MACRO(...) ({ static prog_macro_t _m[] PROGMEM = { __VA_ARGS__ }; _m; })
  191. #define MACRO_NONE 0
  192. static const prog_macro_t *get_macro(uint8_t id, bool pressed)
  193. {
  194. switch (id) {
  195. case 0:
  196. return (pressed ?
  197. MACRO( MD(LSHIFT), D(D), END ) :
  198. MACRO( U(D), MU(LSHIFT), END ) );
  199. case 1:
  200. return (pressed ?
  201. MACRO( I(255), T(H), T(E), T(L), T(L), W(255), T(O), END ) :
  202. MACRO_NONE );
  203. }
  204. return 0;
  205. }
  206. /*
  207. * user defined action function
  208. */
  209. void keymap_call_function(keyrecord_t *record, uint8_t id, uint8_t opt)
  210. {
  211. keyevent_t event = record->event;
  212. uint8_t tap_count = record->tap_count;
  213. debug("action_call_function: ");
  214. if (event.pressed) debug("pressed"); else debug("released");
  215. debug(" id: "); debug_hex(id);
  216. debug(" tap_count: "); debug_dec(tap_count);
  217. debug("\n");
  218. switch (id) {
  219. case LSHIFT_LPAREN:
  220. // LShft + tap '('
  221. if (event.pressed) {
  222. if (tap_count == 0) {
  223. add_mods(MOD_BIT(KC_LSHIFT));
  224. } else {
  225. if (waiting_buffer_has_anykey_pressed()) {
  226. // ad hoc: set 0 to cancel tap
  227. record->tap_count = 0;
  228. add_mods(MOD_BIT(KC_LSHIFT));
  229. } else {
  230. // NOTE to avoid conflicting command key bind(LShift+RShift)
  231. //register_code(KC_LSHIFT);
  232. //register_code(KC_9);
  233. host_add_mods(MOD_BIT(KC_LSHIFT));
  234. host_add_key(KC_9);
  235. host_send_keyboard_report();
  236. }
  237. }
  238. } else {
  239. if (tap_count == 0) {
  240. del_mods(MOD_BIT(KC_LSHIFT));
  241. } else {
  242. //unregister_code(KC_9);
  243. //unregister_code(KC_LSHIFT);
  244. host_del_mods(MOD_BIT(KC_LSHIFT));
  245. host_del_key(KC_9);
  246. host_send_keyboard_report();
  247. }
  248. }
  249. break;
  250. case RSHIFT_RPAREN:
  251. // RShift + tap ')'
  252. if (event.pressed) {
  253. if (tap_count == 0) {
  254. add_mods(MOD_BIT(KC_RSHIFT));
  255. } else {
  256. if (waiting_buffer_has_anykey_pressed()) {
  257. // ad hoc: set 0 to cancel tap
  258. record->tap_count = 0;
  259. add_mods(MOD_BIT(KC_RSHIFT));
  260. } else {
  261. //register_code(KC_RSHIFT);
  262. //register_code(KC_0);
  263. host_add_mods(MOD_BIT(KC_RSHIFT));
  264. host_add_key(KC_0);
  265. host_send_keyboard_report();
  266. }
  267. }
  268. } else {
  269. if (tap_count == 0) {
  270. del_mods(MOD_BIT(KC_RSHIFT));
  271. } else {
  272. //unregister_code(KC_0);
  273. //unregister_code(KC_RSHIFT);
  274. host_del_mods(MOD_BIT(KC_RSHIFT));
  275. host_del_key(KC_0);
  276. host_send_keyboard_report();
  277. }
  278. }
  279. break;
  280. case MACRO:
  281. action_macro_play(get_macro(opt, event.pressed));
  282. break;
  283. }
  284. }
  285. /* translates key to keycode */
  286. uint8_t keymap_key_to_keycode(uint8_t layer, key_t key)
  287. {
  288. return pgm_read_byte(&keymaps[(layer)][(key.row)][(key.col)]);
  289. }
  290. /* translates Fn index to action */
  291. action_t keymap_fn_to_action(uint8_t keycode)
  292. {
  293. action_t action;
  294. if (FN_INDEX(keycode) < sizeof(fn_actions) / sizeof(fn_actions[0])) {
  295. action.code = pgm_read_word(&fn_actions[FN_INDEX(keycode)]);
  296. } else {
  297. action.code = ACTION_NO;
  298. }
  299. return action;
  300. }
  301. /* convert key to action */
  302. action_t action_for_key(uint8_t layer, key_t key)
  303. {
  304. uint8_t keycode = keymap_key_to_keycode(layer, key);
  305. switch (keycode) {
  306. case KC_FN0 ... KC_FN31:
  307. return keymap_fn_to_action(keycode);
  308. default:
  309. return keymap_keycode_to_action(keycode);
  310. }
  311. }