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.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.

keymap.c 14KB

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