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 11KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236
  1. /*
  2. Copyright 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. #include <stdint.h>
  15. #include <stdbool.h>
  16. #include <avr/pgmspace.h>
  17. #include "keycode.h"
  18. #include "action.h"
  19. #include "action_macro.h"
  20. #include "layer_switch.h"
  21. #include "report.h"
  22. #include "host.h"
  23. #include "print.h"
  24. #include "debug.h"
  25. #include "keymap.h"
  26. /* GH60 keymap definition macro
  27. * K2C, K31 and K3C are extra keys for ISO
  28. */
  29. #define KEYMAP( \
  30. K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D, \
  31. K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D, \
  32. K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, K2D, \
  33. K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3C, K3D, \
  34. K40, K41, K42, K45, K4A, K4B, K4C, K4D \
  35. ) { \
  36. { KC_##K00, KC_##K01, KC_##K02, KC_##K03, KC_##K04, KC_##K05, KC_##K06, KC_##K07, KC_##K08, KC_##K09, KC_##K0A, KC_##K0B, KC_##K0C, KC_##K0D }, \
  37. { KC_##K10, KC_##K11, KC_##K12, KC_##K13, KC_##K14, KC_##K15, KC_##K16, KC_##K17, KC_##K18, KC_##K19, KC_##K1A, KC_##K1B, KC_##K1C, KC_##K1D }, \
  38. { KC_##K20, KC_##K21, KC_##K22, KC_##K23, KC_##K24, KC_##K25, KC_##K26, KC_##K27, KC_##K28, KC_##K29, KC_##K2A, KC_##K2B, KC_##K2C, KC_##K2D }, \
  39. { KC_##K30, KC_##K31, KC_##K32, KC_##K33, KC_##K34, KC_##K35, KC_##K36, KC_##K37, KC_##K38, KC_##K39, KC_##K3A, KC_##K3B, KC_##K3C, KC_##K3D }, \
  40. { KC_##K40, KC_##K41, KC_##K42, KC_NO, KC_NO, KC_##K45, KC_NO, KC_NO, KC_NO, KC_NO, KC_##K4A, KC_##K4B, KC_##K4C, KC_##K4D } \
  41. }
  42. /* ANSI valiant. No extra keys for ISO */
  43. #define KEYMAP_ANSI( \
  44. K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D, \
  45. K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D, \
  46. K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2D, \
  47. K30, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3D, \
  48. K40, K41, K42, K45, K4A, K4B, K4C, K4D \
  49. ) KEYMAP( \
  50. K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D, \
  51. K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D, \
  52. K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, NO, K2D, \
  53. K30, NO, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, NO, K3D, \
  54. K40, K41, K42, K45, K4A, K4B, K4C, K4D \
  55. )
  56. #if defined(KEYMAP_PLAIN)
  57. #include "keymap_plain.h"
  58. #elif defined(KEYMAP_POKER)
  59. #include "keymap_poker.h"
  60. #elif defined(KEYMAP_POKER_SET)
  61. #include "keymap_poker_set.h"
  62. #elif defined(KEYMAP_POKER_BIT)
  63. #include "keymap_poker_bit.h"
  64. #else
  65. static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  66. /*
  67. * Funky
  68. */
  69. /* Keymap 0: Default Layer
  70. * ,-----------------------------------------------------------.
  71. * |Esc| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =|Backsp |
  72. * |-----------------------------------------------------------|
  73. * |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| \|
  74. * |-----------------------------------------------------------|
  75. * |Caps | A| S| D| F| G| H| J| K| L|Fn3| '|Return |
  76. * |-----------------------------------------------------------|
  77. * |Shift | Z| X| C| V| B| N| M| ,| .|Fn2|Shift |
  78. * |-----------------------------------------------------------|
  79. * |Ctrl|Gui |Alt | Space |Alt |Fn4 |Fn4 |Fn1 |
  80. * `-----------------------------------------------------------'
  81. */
  82. KEYMAP_ANSI(
  83. ESC, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, MINS,EQL, BSPC, \
  84. TAB, Q, W, E, R, T, Y, U, I, O, P, LBRC,RBRC,BSLS, \
  85. LCTL,A, S, D, F, G, H, J, K, L, FN3, QUOT, ENT, \
  86. LSFT,Z, X, C, V, B, N, M, COMM,DOT, FN2, RSFT, \
  87. LCTL,LGUI,LALT, SPC, RALT,FN4, FN4, FN1),
  88. /* Keymap 1: colemak */
  89. KEYMAP_ANSI(
  90. GRV, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, MINS,EQL, BSPC, \
  91. TAB, Q, W, F, P, G, J, L, U, Y, SCLN,LBRC,RBRC,BSLS, \
  92. BSPC,A, R, S, T, D, H, N, E, I, O, QUOT, ENT, \
  93. LSFT,Z, X, C, V, B, K, M, COMM,DOT, SLSH, RSFT, \
  94. LCTL,LGUI,LALT, SPC, RALT,RGUI,APP, FN1),
  95. /* Keymap 2: dvorak */
  96. KEYMAP_ANSI(
  97. GRV, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, LBRC,RBRC,BSPC, \
  98. TAB, QUOT,COMM,DOT, P, Y, F, G, C, R, L, SLSH,EQL, BSLS, \
  99. CAPS,A, O, E, U, I, D, H, T, N, S, MINS, ENT, \
  100. LSFT,SCLN,Q, J, K, X, B, M, W, V, Z, RSFT, \
  101. LCTL,LGUI,LALT, SPC, RALT,RGUI,APP, FN1),
  102. /* Keymap: workman */
  103. KEYMAP_ANSI(
  104. GRV, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, MINS,EQL, BSPC, \
  105. TAB, Q, D, R, W, B, J, F, U, P, SCLN,LBRC,RBRC,BSLS, \
  106. BSPC,A, S, H, T, G, Y, N, E, O, I, QUOT, ENT, \
  107. LSFT,Z, X, M, C, V, K, L, COMM,DOT, SLSH, RSFT, \
  108. LCTL,LGUI,LALT, SPC, RALT,RGUI,APP, FN1),
  109. };
  110. static const uint8_t PROGMEM overlays[][MATRIX_ROWS][MATRIX_COLS] = {
  111. /*
  112. * Funky
  113. */
  114. /* Overlay 0: HHKB mode
  115. * ,-----------------------------------------------------------.
  116. * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delete |
  117. * |-----------------------------------------------------------|
  118. * |Caps | | | | | | | |Psc|Slk|Pus|Up | |Inser|
  119. * |-----------------------------------------------------------|
  120. * |Contro|VoD|VoU|Mut| | | *| /|Hom|PgU|Lef|Rig|Enter |
  121. * |-----------------------------------------------------------|
  122. * |Shift | | | | | | +| -|End|PgD|Dow|Shift |
  123. * |-----------------------------------------------------------|
  124. * |Ctrl|Gui |Alt | Space |Alt |Gui |App |Fn0 |
  125. * `-----------------------------------------------------------'
  126. */
  127. KEYMAP_ANSI(
  128. PWR, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, DEL, \
  129. CAPS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,PSCR,SLCK,PAUS,UP, TRNS,INS, \
  130. LCTL,VOLD,VOLU,MUTE,TRNS,TRNS,PAST,PSLS,HOME,PGUP,LEFT,RGHT, ENT, \
  131. LSFT,TRNS,TRNS,TRNS,TRNS,TRNS,PPLS,PMNS,END, PGDN,DOWN, RSFT, \
  132. LCTL,LGUI,LALT, SPC, RALT,RGUI,APP, FN0),
  133. /* Overlay 1: Vi mode (Slash)
  134. * ,-----------------------------------------------------------.
  135. * | `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
  136. * |-----------------------------------------------------------|
  137. * |Tab |Hom|PgD|Up |PgU|End|Hom|PgD|PgU|End| | | | |
  138. * |-----------------------------------------------------------|
  139. * |Contro| |Lef|Dow|Rig| |Lef|Dow|Up |Rig| | |Return |
  140. * |-----------------------------------------------------------|
  141. * |Shift | | | | | |Hom|PgD|PgU|End|Fn0|Shift |
  142. * |-----------------------------------------------------------|
  143. * |Ctrl|Gui |Alt | Space |Alt |Gui |App |Ctrl|
  144. * `-----------------------------------------------------------'
  145. */
  146. KEYMAP_ANSI(
  147. GRV, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, BSPC, \
  148. TAB, HOME,PGDN,UP, PGUP,END, HOME,PGDN,PGUP,END, TRNS,TRNS,TRNS,TRNS, \
  149. LCTL,TRNS,LEFT,DOWN,RGHT,TRNS,LEFT,DOWN,UP, RGHT,TRNS,TRNS, ENT, \
  150. LSFT,TRNS,TRNS,TRNS,TRNS,TRNS,HOME,PGDN,PGUP,END, FN0, RSFT, \
  151. LCTL,LGUI,LALT, SPC, RALT,RGUI,APP, RCTL),
  152. /* Overlay 2: Mouse mode (Semicolon/App)
  153. * ,-----------------------------------------------------------.
  154. * | `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
  155. * |-----------------------------------------------------------|
  156. * |Tab | | | | | |MwL|MwD|MwU|MwR| | | | |
  157. * |-----------------------------------------------------------|
  158. * |Contro| |Ac0|Ac1|Ac1| |McL|McD|McU|McR|Fn0| |Return |
  159. * |-----------------------------------------------------------|
  160. * |Shift | | | | |Mb3|Mb2|Mb1|Mb4|Mb5| |Shift |
  161. * |-----------------------------------------------------------|
  162. * |Ctrl|Gui |Alt | Space | |Fn0 |Fn0 | |
  163. * `-----------------------------------------------------------'
  164. * Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel
  165. */
  166. KEYMAP_ANSI(
  167. GRV, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, BSPC, \
  168. TAB, TRNS,TRNS,TRNS,TRNS,TRNS,WH_L,WH_D,WH_U,WH_R,TRNS,TRNS,TRNS,TRNS, \
  169. LCTL,TRNS,ACL0,ACL1,ACL2,TRNS,MS_L,MS_D,MS_U,MS_R,FN0, TRNS, ENT, \
  170. LSFT,TRNS,TRNS,TRNS,TRNS,BTN3,BTN2,BTN1,BTN4,BTN5,TRNS, RSFT, \
  171. LCTL,LGUI,LALT, BTN1, TRNS,FN0, FN0, RCTL),
  172. };
  173. /*
  174. * Fn action definition
  175. */
  176. static const uint16_t PROGMEM fn_actions[] = {
  177. ACTION_LAYER_DEFAULT, // FN0
  178. ACTION_LAYER_SET(0), // FN1
  179. ACTION_LAYER_SET_TAP_KEY(1, KC_SLASH), // FN2
  180. ACTION_LAYER_SET_TAP_KEY(2, KC_SCLN), // FN3
  181. ACTION_LAYER_SET(2), // FN4
  182. };
  183. #endif
  184. #define KEYMAPS_SIZE (sizeof(keymaps) / sizeof(keymaps[0]))
  185. #define OVERLAYS_SIZE (sizeof(overlays) / sizeof(overlays[0]))
  186. #define FN_ACTIONS_SIZE (sizeof(fn_actions) / sizeof(fn_actions[0]))
  187. /* translates key to keycode */
  188. uint8_t keymap_key_to_keycode(uint8_t layer, key_t key)
  189. {
  190. /* Overlay: 16-31(OVERLAY_BIT(0x10) | overlay_layer) */
  191. if (layer & OVERLAY_BIT) {
  192. layer &= OVERLAY_MASK;
  193. if (layer < OVERLAYS_SIZE) {
  194. return pgm_read_byte(&overlays[(layer)][(key.row)][(key.col)]);
  195. } else {
  196. debug("key_to_keycode: overlay "); debug_dec(layer); debug(" is invalid.\n");
  197. return KC_TRANSPARENT;
  198. }
  199. }
  200. /* Keymap: 0-15 */
  201. else {
  202. if (layer < KEYMAPS_SIZE) {
  203. return pgm_read_byte(&keymaps[(layer)][(key.row)][(key.col)]);
  204. } else {
  205. // fall back to layer 0
  206. debug("key_to_keycode: base "); debug_dec(layer); debug(" is invalid.\n");
  207. return pgm_read_byte(&keymaps[0][(key.row)][(key.col)]);
  208. }
  209. }
  210. }
  211. /* translates Fn keycode to action */
  212. action_t keymap_fn_to_action(uint8_t keycode)
  213. {
  214. action_t action;
  215. if (FN_INDEX(keycode) < FN_ACTIONS_SIZE) {
  216. action.code = pgm_read_word(&fn_actions[FN_INDEX(keycode)]);
  217. } else {
  218. action.code = ACTION_NO;
  219. }
  220. return action;
  221. }