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