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 uint16_t PROGMEM fn_actions[] = {
  55     ACTION_LAYER_TO_DEFAULT_ON_RELEASED,    // Fn0
  56     ACTION_LAYER_SET_ON_PRESSED(1),         // Fn1
  57     ACTION_LAYER_SET_TAP_KEY(2, KC_SLASH),  // Fn2
  58     ACTION_LAYER_SET_TAP_KEY(3, KC_SCLN),   // Fn3
  59     //ACTION_LAYER_SET_ON_PRESSED(3),         // Fn4
  60     ACTION_FUNCTION(0x01, 0xA), // Fn4
  61     ACTION_LAYER_SET_TAP_KEY(5, KC_SPC),    // Fn5
  62     ACTION_LMODS_TAP(MOD_BIT(KC_LCTL), KC_BSPC), // Fn6
  63     ACTION_RMODS_TAP(MOD_BIT(KC_RCTL), KC_ENT), // Fn7
  64
  65     ACTION_LMODS_TAP(MOD_BIT(KC_LSFT), ONE_SHOT),   // Fn8
  66     ACTION_LAYER_SET_ON_RELEASED_TAP_TOGGLE(1),                     // Fn9
  67     ACTION_LAYER_BIT_TAP_TOGGLE(1),                 // Fn10
  68 };
  69
  70
  71 static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  72     /* Layer 0: Default Layer
  73      * ,-----------------------------------------------------------.
  74      * |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|  \|  `|
  75      * |-----------------------------------------------------------|
  76      * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|Backs|
  77      * |-----------------------------------------------------------|
  78      * |Contro|  A|  S|  D|  F|  G|  H|  J|  K|  L|Fn3|  '|Return  |
  79      * |-----------------------------------------------------------|
  80      * |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|Fn2|Shift |Fn1|
  81      * `-----------------------------------------------------------'
  82      *       |Gui|Alt  |Fn5                    |Alt  |Fn4|
  83      *       `-------------------------------------------'
  84      */
  85     KEYMAP(ESC, 1,   2,   3,   4,   5,   6,   7,   8,   9,   0,   MINS,EQL, BSLS,GRV, \
  86            TAB, Q,   W,   E,   R,   T,   Y,   U,   I,   O,   P,   LBRC,RBRC,BSPC, \
  87            FN6, A,   S,   D,   F,   G,   H,   J,   K,   L,   FN3, QUOT,FN7, \
  88            FN8, Z,   X,   C,   V,   B,   N,   M,   COMM,DOT, FN2, RSFT,FN10, \
  89                 LGUI,LALT,          FN5,                RALT,FN4),
  90
  91     /* Layer 1: HHKB mode (HHKB Fn)
  92      * ,-----------------------------------------------------------.
  93      * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
  94      * |-----------------------------------------------------------|
  95      * |Caps |   |   |   |   |   |   |   |Psc|Slk|Pus|Up |   |Backs|
  96      * |-----------------------------------------------------------|
  97      * |Contro|VoD|VoU|Mut|   |   |  *|  /|Hom|PgU|Lef|Rig|Enter   |
  98      * |-----------------------------------------------------------|
  99      * |Shift   |   |   |   |   |   |  +|  -|End|PgD|Dow|Shift |Fn0|
 100      * `-----------------------------------------------------------'
 101      *      |Gui |Alt  |Space                  |Alt  |xxx|
 102      *      `--------------------------------------------'
 103      */
 104     KEYMAP(PWR, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12, INS, DEL, \
 105            CAPS,NO,  NO,  NO,  NO,  NO,  NO,  NO,  PSCR,SLCK,BRK, UP,  NO,  BSPC, \
 106            LCTL,VOLD,VOLU,MUTE,NO,  NO,  PAST,PSLS,HOME,PGUP,LEFT,RGHT,ENT, \
 107            LSFT,NO,  NO,  NO,  NO,  NO,  PPLS,PMNS,END, PGDN,DOWN,RSFT,FN10, \
 108                 LGUI,LALT,          SPC,                RALT,RGUI),
 109
 110     /* Layer 2: Vi mode (Slash)
 111      * ,-----------------------------------------------------------.
 112      * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
 113      * |-----------------------------------------------------------|
 114      * |Tab  |Hom|PgD|Up |PgU|End|Hom|PgD|PgUlEnd|   |   |   |Backs|
 115      * |-----------------------------------------------------------|
 116      * |Contro|   |Lef|Dow|Rig|   |Lef|Dow|Up |Rig|   |   |Return  |
 117      * |-----------------------------------------------------------|
 118      * |Shift   |   |   |   |   |   |Hom|PgD|PgUlEnd|Fn0|Shift |   |
 119      * `-----------------------------------------------------------'
 120      *       |Gui|Alt  |Space                  |Alt  |Gui|
 121      *       `-------------------------------------------'
 122      */
 123     KEYMAP(ESC, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12, INS, DEL, \
 124            TAB, HOME,PGDN,UP,  PGUP,END, HOME,PGDN,PGUP,END, NO,  NO,  NO,  BSPC, \
 125            LCTL,NO,  LEFT,DOWN,RGHT,NO,  LEFT,DOWN,UP,  RGHT,NO,  NO,  ENT, \
 126            LSFT,NO,  NO,  NO,  NO,  NO,  HOME,PGDN,PGUP,END, FN0, RSFT,NO, \
 127                 LGUI,LALT,          SPC,                RALT,RGUI),
 128
 129     /* Layer 3: Mouse mode (Semicolon)
 130      * ,-----------------------------------------------------------.
 131      * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
 132      * |-----------------------------------------------------------|
 133      * |Tab  |MwL|MwU|McU|MwD|MwR|MwL|MwD|MwU|MwR|   |   |   |Backs|
 134      * |-----------------------------------------------------------|
 135      * |Contro|   |McL|McD|McR|   |McL|McD|McU|McR|Fn0|   |Return  |
 136      * |-----------------------------------------------------------|
 137      * |Shift   |Mb4|Mb5|Mb1|Mb2|Mb3|Mb2|Mb1|Mb4|Mb5|   |Shift |   |
 138      * `-----------------------------------------------------------'
 139      *      |Gui |Alt  |Mb1                    |Alt  |Fn0|
 140      *      `--------------------------------------------'
 141      * Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel
 142      */
 143     KEYMAP(ESC, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12, INS, DEL, \
 144            TAB, NO,  NO,  NO,  NO,  NO,  WH_L,WH_D,WH_U,WH_R,NO,  NO,  NO,  BSPC, \
 145            LCTL,NO,  ACL0,ACL1,ACL2,NO,  MS_L,MS_D,MS_U,MS_R,FN0, QUOT,ENT, \
 146            LSFT,NO,  NO,  NO,  NO,  BTN3,BTN2,BTN1,BTN4,BTN5,SLSH,RSFT,NO, \
 147                 LGUI,LALT,          BTN1,               RALT,FN0),
 148
 149     /* Layer 4: Matias half keyboard style (Space)
 150      * ,-----------------------------------------------------------.
 151      * |  -|  0|  9|  8|  7|  6|  5|  4|  3|  2|  1|   |   |   |Esc|
 152      * |-----------------------------------------------------------|
 153      * |Backs|  P|  O|  I|  U|  Y|  T|  R|  E|  W|  Q|   |   |Tab  |
 154      * |-----------------------------------------------------------|
 155      * |Contro|  ;|  L|  K|  J|  H|  G|  F|  D|  S|  A|Con|Control |
 156      * |-----------------------------------------------------------|
 157      * |Shift   |  /|  .|  ,|  M|  N|  B|  V|  C|  X|  Z|Shift |   |
 158      * `-----------------------------------------------------------'
 159      *      |Gui |Alt  |          Fn0          |Alt  |Gui|
 160      *      `--------------------------------------------'
 161      */
 162     KEYMAP(MINS,0,   9,   8,   7,   6,   5,   4,   3,   2,   1,   NO,  NO,  NO,  ESC, \
 163            BSPC,P,   O,   I,   U,   Y,   T,   R,   E,   W,   Q,   NO,  NO,  TAB, \
 164            LCTL,SCLN,L,   K,   J,   H,   G,   F,   D,   S,   A,   RCTL,RCTL, \
 165            LSFT,SLSH,DOT, COMM,M,   N,   B,   V,   C,   X,   Z,   RSFT,NO, \
 166                 LGUI,LALT,          FN0,                RALT,RGUI),
 167
 168     /* Layer5: another Mouse mode (Space) */
 169     KEYMAP(ESC, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12, INS, DEL, \
 170            TAB, NO,  NO,  NO,  NO,  NO,  WH_L,WH_D,WH_U,WH_R,NO,  NO,  NO,  BSPC, \
 171            LCTL,NO,  ACL0,ACL1,ACL2,NO,  MS_L,MS_D,MS_U,MS_R,FN0, NO,  ENT, \
 172            LSFT,NO,  NO,  NO,  NO,  BTN3,BTN2,BTN1,BTN4,BTN5,NO,  RSFT,NO, \
 173                 LGUI,LALT,          FN0,                RALT,RGUI),
 174 };
 175
 176 #define KEYCODE(layer, row, col) (pgm_read_byte(&keymaps[(layer)][(row)][(col)]))
 177
 178
 179 /* legacy interface */
 180 uint8_t keymap_get_keycode(uint8_t layer, uint8_t row, uint8_t col) { return 0; }
 181 uint8_t keymap_fn_layer(uint8_t fn_bits) { return 0; }
 182 uint8_t keymap_fn_keycode(uint8_t fn_bits) { return 0; }
 183
 184
 185 action_t keymap_get_action(uint8_t layer, uint8_t row, uint8_t col) {
 186     /* convert from legacy keycode to action */
 187     uint8_t key = KEYCODE(layer, row, col);
 188     action_t action;
 189     switch (key) {
 190         case KC_A ... KC_EXSEL:
 191         case KC_LCTRL ... KC_LGUI:
 192         case KC_RCTRL ... KC_RGUI:
 193             action.code = ACTION_KEY(key);
 194             break;
 195         case KC_SYSTEM_POWER ... KC_SYSTEM_WAKE:
 196             action.code = ACTION_USAGE_SYSTEM(KEYCODE2SYSTEM(key));
 197             break;
 198         case KC_AUDIO_MUTE ... KC_WWW_FAVORITES:
 199             action.code = ACTION_USAGE_CONSUMER(KEYCODE2CONSUMER(key));
 200             break;
 201         case KC_MS_UP ... KC_MS_ACCEL2:
 202             action.code = ACTION_MOUSEKEY(key);
 203             break;
 204 /* TODO
 205         case KC_LCTRL ... KC_LGUI:
 206             action.code = ACTION_LMODS(MOD_BIT(key));
 207             break;
 208         case KC_RCTRL ... KC_RGUI:
 209             action.code = ACTION_RMODS(MOD_BIT(key)>>4);
 210             break;
 211 */
 212         case KC_FN0 ... FN_MAX:
 213             if (FN_INDEX(key) < sizeof(fn_actions) / sizeof(fn_actions[0])) {
 214                 action.code = pgm_read_word(&fn_actions[FN_INDEX(key)]);
 215             } else {
 216                 action.code = ACTION_NO;
 217             }
 218             break;
 219         case KC_NO ... KC_UNDEFINED:
 220         default:
 221             action.code = ACTION_NO;
 222             break;
 223     }
 224     return action;
 225 }
 226
 227 // TODO: how to define action function
 228 void action_call_function(keyevent_t event, uint8_t id)
 229 {
 230     // '(' Shift+9
 231     if (event.pressed) {
 232         register_code(KC_LSHIFT);
 233         register_code(KC_9);
 234         debug("action_call_function: pressed: id: "); debug_hex(id); debug("\n");
 235     } else {
 236         unregister_code(KC_9);
 237         unregister_code(KC_LSHIFT);
 238         debug("action_call_function: released: id: "); debug_hex(id); debug("\n");
 239     }
 240 }