keyboard/hhkb/keymap.c

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