keyboard/hhkb/keymap.c

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