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