hhkb/keymap.c

   1 /*
   2  * Keymap for PFU HHKB Pro
   3  */
   4 #include <stdbool.h>
   5 #include <avr/pgmspace.h>
   6 #include "usb_keyboard.h"
   7 #include "usb_keycodes.h"
   8 #include "matrix.h"
   9 #include "keymap.h"
  10 #include "print.h"
  11 #include "debug.h"
  12
  13
  14 #define FN_KEYCODE(fn) (pgm_read_byte(&fn_keycode[(fn)]))
  15 #define FN_LAYER(fn)   (pgm_read_byte(&fn_layer[(fn)]))
  16 #define KEYCODE(layer, row, col) (pgm_read_byte(&keymaps[(layer)][(row)][(col)]))
  17 #define KEYMAP( \
  18     R3C1, R3C0, R0C0, R1C0, R1C1, R2C0, R2C1, R4C0, R4C1, R6C0, R6C1, R7C0, R7C1, R5C0, R5C1, \
  19     R3C2, R0C1, R0C2, R1C3, R1C2, R2C3, R2C2, R4C2, R4C3, R6C2, R6C3, R7C3, R7C2, R5C2, \
  20     R3C3, R0C4, R0C3, R1C4, R1C5, R2C4, R2C5, R4C5, R4C4, R6C5, R6C4, R7C4, R5C3, \
  21     R3C4, R0C5, R0C6, R0C7, R1C6, R1C7, R2C6, R4C6, R6C6, R7C6, R7C5, R5C5, R5C4, \
  22     R3C5, R3C6, R3C7, R5C7, R5C6 \
  23 ) \
  24 { \
  25     { R0C0, R0C1, R0C2, R0C3, R0C4, R0C5, R0C6, R0C7 }, \
  26     { R1C0, R1C1, R1C2, R1C3, R1C4, R1C5, R1C6, R1C7 }, \
  27     { R2C0, R2C1, R2C2, R2C3, R2C4, R2C5, R2C6, KB_NO }, \
  28     { R3C0, R3C1, R3C2, R3C3, R3C4, R3C5, R3C6, R3C7 }, \
  29     { R4C0, R4C1, R4C2, R4C3, R4C4, R4C5, R4C6, KB_NO }, \
  30     { R5C0, R5C1, R5C2, R5C3, R5C4, R5C5, R5C6, R5C7 }, \
  31     { R6C0, R6C1, R6C2, R6C3, R6C4, R6C5, R6C6, KB_NO }, \
  32     { R7C0, R7C1, R7C2, R7C3, R7C4, R7C5, R7C6, KB_NO } \
  33 }
  34
  35
  36 static int onbit(uint8_t bits);
  37
  38
  39 static int current_layer = 0;
  40 static bool layer_used = false;
  41
  42
  43 /* layer to change into while Fn key pressed */
  44 static const int PROGMEM fn_layer[] = { 0, 1, 2, 3, 4, 0, 0, 0 };
  45
  46 /* keycode to sent when Fn key released without using layer keys. */
  47 static const uint8_t PROGMEM fn_keycode[] = {
  48     KB_NO,          // FN_0 [NOT USED]
  49     KB_NO,          // FN_1 layer 1
  50     KB_QUOTE,       // FN_2 layer 2
  51     KB_SCOLON,      // FN_3 layer 3
  52     KB_SPACE,       // FN_4 layer 4 [NOT USED]
  53     KB_NO,          // FN_5 [NOT USED]
  54     KB_NO,          // FN_6 [NOT USED]
  55     KB_NO           // FN_7 [NOT USED]
  56 };
  57
  58 static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  59     /* Layer 0: Default Layer
  60      * ,-----------------------------------------------------------.
  61      * |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|  \|  `|
  62      * |-----------------------------------------------------------|
  63      * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|Backs|
  64      * |-----------------------------------------------------------|
  65      * |Contro|  A|  S|  D|  F|  G|  H|  J|  K|  L|Fn3|Fn2|Return  |
  66      * |-----------------------------------------------------------|
  67      * |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift |Fn1|
  68      * `-----------------------------------------------------------'
  69      *       |Gui|Alt  |Space                  |Alt  |Gui|
  70      *       `-------------------------------------------'
  71      */
  72     KEYMAP(KB_ESC, KB_1,   KB_2,   KB_3,   KB_4,   KB_5,   KB_6,   KB_7,   KB_8,   KB_9,   KB_0,   KB_MINS,KB_EQL, KB_BSLS,KB_GRV, \
  73            KB_TAB, KB_Q,   KB_W,   KB_E,   KB_R,   KB_T,   KB_Y,   KB_U,   KB_I,   KB_O,   KB_P,   KB_LBRC,KB_RBRC,KB_BSPC, \
  74            KB_LCTL,KB_A,   KB_S,   KB_D,   KB_F,   KB_G,   KB_H,   KB_J,   KB_K,   KB_L,   FN_3,   FN_2,   KB_ENT, \
  75            KB_LSFT,KB_Z,   KB_X,   KB_C,   KB_V,   KB_B,   KB_N,   KB_M,   KB_COMM,KB_DOT, KB_SLSH,KB_RSFT,FN_1, \
  76            KB_LGUI,KB_LALT,KB_SPC, KB_RALT,KB_RGUI),
  77
  78     /* Layer 1: HHKB mode (HHKB Fn)
  79      * ,-----------------------------------------------------------.
  80      * |Pow| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
  81      * |-----------------------------------------------------------|
  82      * |Caps |   |   |   |   |   |   |   |Psc|Slk|Pus|Up |   |Backs|
  83      * |-----------------------------------------------------------|
  84      * |Contro|   |   |   |   |   |  *|  /|Hom|PgU|Lef|Rig|Enter   |
  85      * |-----------------------------------------------------------|
  86      * |Shift   |   |   |   |   |   |  +|  -|End|PgD|Dow|Shift |xxx|
  87      * `-----------------------------------------------------------'
  88      *      |Gui |Alt  |Space                  |Alt  |Gui|
  89      *      `--------------------------------------------'
  90      */
  91     KEYMAP(KB_PWR, KB_F1,  KB_F2,  KB_F3,  KB_F4,  KB_F5,  KB_F6,  KB_F7,  KB_F8,  KB_F9,  KB_F10, KB_F11, KB_F12, KB_INS, KB_DEL, \
  92            KB_CAPS,KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_PSCR,KB_SLCK,KB_BRK, KB_UP,  KB_NO,  KB_BSPC, \
  93            KB_LCTL,KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KP_ASTR,KP_SLSH,KB_HOME,KB_PGUP,KB_LEFT,KB_RGHT,KB_ENT, \
  94            KB_LSFT,KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KP_PLUS,KP_MINS,KB_END, KB_PGDN,KB_DOWN,KB_RSFT,FN_1, \
  95            KB_LGUI,KB_LALT,KB_SPC, KB_RALT,KB_RGUI),
  96
  97     /* Layer 2: Vi mode (Quote/Rmeta)
  98      * ,-----------------------------------------------------------.
  99      * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
 100      * |-----------------------------------------------------------|
 101      * |Tab  |Hom|PgD|Up |PgU|End|Hom|PgD|PgUlEnd|   |   |   |Backs|
 102      * |-----------------------------------------------------------|
 103      * |Contro|   |Lef|Dow|Rig|   |Lef|Dow|Up |Rig|   |xxx|Return  |
 104      * |-----------------------------------------------------------|
 105      * |Shift   |   |   |   |   |   |   |   |   |   |   |Shift |   |
 106      * `-----------------------------------------------------------'
 107      *       |Gui|Alt  |Sapce                  |Alt  |Gui|
 108      *       `-------------------------------------------'
 109      */
 110     KEYMAP(KB_ESC, KB_F1,  KB_F2,  KB_F3,  KB_F4,  KB_F5,  KB_F6,  KB_F7,  KB_F8,  KB_F9,  KB_F10, KB_F11, KB_F12, KB_INS, KB_DEL, \
 111            KB_TAB, KB_HOME,KB_PGDN,KB_UP,  KB_PGUP,KB_END, KB_HOME,KB_PGDN,KB_PGUP,KB_END, KB_NO,  KB_NO,  KB_NO,  KB_BSPC, \
 112            KB_LCTL,KB_NO,  KB_LEFT,KB_DOWN,KB_RGHT,KB_NO,  KB_LEFT,KB_DOWN,KB_UP,  KB_RGHT,KB_NO,  FN_2,   KB_ENT, \
 113            KB_LSFT,KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_RSFT,KB_NO, \
 114            KB_LGUI,KB_LALT,KB_SPC, KB_RALT,KB_RGUI),
 115
 116     /* Layer 3: Mouse mode (Semicolon)
 117      * ,-----------------------------------------------------------.
 118      * |Esc|   |   |   |   |   |   |   |   |   |   |   |   |   |   |
 119      * |-----------------------------------------------------------|
 120      * |Tab  |MwL|MwU|McU|MwD|MwL|MwR|MwD|MwU|MwR|   |   |   |Backs|
 121      * |-----------------------------------------------------------|
 122      * |Contro|   |McL|McD|McR|   |McL|McD|McU|McR|xxx|   |Return  |
 123      * |-----------------------------------------------------------|
 124      * |Shift   |   |   |   |   |   |Mb2|Mb1|Mb2|Mb3|   |Shift |   |
 125      * `-----------------------------------------------------------'
 126      *      |Gui |Alt  |Mb1                    |Alt  |Gui|
 127      *      `--------------------------------------------'
 128      * Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel
 129      */
 130     KEYMAP(KB_ESC, KB_F1,  KB_F2,  KB_F3,  KB_F4,  KB_F5,  KB_F6,  KB_F7,  KB_F8,  KB_F9,  KB_F10, KB_F11, KB_F12, KB_INS, KB_DEL, \
 131            KB_TAB, MS_WH_L,MS_WH_U,MS_UP,  MS_WH_D,MS_WH_R,MS_WH_L,MS_WH_D,MS_WH_U,MS_WH_R,KB_NO,  KB_NO,  KB_NO,  KB_BSPC, \
 132            KB_LCTL,KB_NO,  MS_LEFT,MS_DOWN,MS_RGHT,KB_NO,  MS_LEFT,MS_DOWN,MS_UP,  MS_RGHT,FN_3,   KB_NO,  KB_ENT, \
 133            KB_LSFT,KB_NO,  MS_DOWN,KB_NO,  KB_NO,  KB_NO,  MS_BTN2,MS_BTN1,MS_BTN2,MS_BTN3,KB_NO,  KB_RSFT,KB_NO, \
 134            KB_LGUI,KB_LALT,MS_BTN1,KB_RALT,KB_RGUI),
 135
 136     /* Layer 4: Matias half keyboard style (Space)
 137      * ,-----------------------------------------------------------.
 138      * |  -|  0|  9|  8|  7|  6|  5|  4|  3|  2|  1|   |   |   |Esc|
 139      * |-----------------------------------------------------------|
 140      * |Backs|  P|  O|  I|  U|  Y|  T|  R|  E|  W|  Q|   |   |Tab  |
 141      * |-----------------------------------------------------------|
 142      * |Contro|  ;|  L|  K|  J|  H|  G|  F|  D|  S|  A|Con|Control |
 143      * |-----------------------------------------------------------|
 144      * |Shift   |  /|  .|  ,|  M|  N|  B|  V|  C|  X|  Z|Shift |   |
 145      * `-----------------------------------------------------------'
 146      *      |Gui |Alt  |xxxxxxxxxxxxxxxxxxxxxxx|Alt  |Gui|
 147      *      `--------------------------------------------'
 148      */
 149     KEYMAP(KB_MINS,KB_0,   KB_9,   KB_8,   KB_7,   KB_6,   KB_5,   KB_4,   KB_3,   KB_2,   KB_1,   KB_NO,  KB_NO,  KB_NO,  KB_ESC, \
 150            KB_BSPC,KB_P,   KB_O,   KB_I,   KB_U,   KB_Y,   KB_T,   KB_R,   KB_E,   KB_W,   KB_Q,   KB_NO,  KB_NO,  KB_TAB, \
 151            KB_LCTL,KB_SCLN,KB_L,   KB_K,   KB_J,   KB_H,   KB_G,   KB_F,   KB_D,   KB_S,   KB_A,   KB_RCTL,KB_RCTL, \
 152            KB_LSFT,KB_SLSH,KB_DOT, KB_COMM,KB_M,   KB_N,   KB_B,   KB_V,   KB_C,   KB_X,   KB_Z,   KB_RSFT,KB_NO, \
 153            KB_LGUI,KB_LALT,FN_4,   KB_RALT,KB_RGUI)
 154 };
 155
 156
 157 uint8_t keymap_get_keycode(int row, int col)
 158 {
 159     return keymap_get_keycodel(current_layer, row, col);
 160 }
 161
 162 uint8_t keymap_get_keycodel(int layer, int row, int col)
 163 {
 164     uint8_t code = KEYCODE(layer, row, col);
 165     // normal key or mouse key
 166     if (IS_KEY(code) || IS_MOUSE(code))
 167         layer_used = true;
 168     return code;
 169 }
 170
 171 inline
 172 int keymap_get_layer(void)
 173 {
 174     return current_layer;
 175 }
 176
 177 inline
 178 int keymap_set_layer(int layer)
 179 {
 180     current_layer = layer;
 181     return current_layer;
 182 }
 183
 184 inline
 185 bool keymap_is_special_mode(int fn_bits)
 186 {
 187     return (keyboard_modifier_keys == (BIT_LCTRL | BIT_LSHIFT | BIT_LALT | BIT_LGUI));
 188 }
 189
 190 void keymap_fn_proc(int fn_bits)
 191 {
 192     // layer switching
 193     static int last_bits = 0;
 194     static uint8_t last_mod = 0;
 195
 196     if (usb_keyboard_has_key() || fn_bits == last_bits) {
 197         // do nothing during press other than Fn key
 198         return;
 199     } else if (fn_bits == 0) {
 200         // send key when Fn key is released without using the layer
 201         if (!layer_used) {
 202             uint8_t code = FN_KEYCODE(onbit(last_bits));
 203             if (code != KB_NO) {
 204                 if (IS_MOD(code)) {
 205                     keyboard_modifier_keys = last_mod | 1<<(code & 0x07);
 206                 } else {
 207                     keyboard_keys[0] = code;
 208                     keyboard_modifier_keys = last_mod;
 209                 }
 210                 usb_keyboard_send();
 211                 usb_keyboard_print();
 212                 usb_keyboard_clear();
 213             }
 214         }
 215         last_bits = 0;
 216         last_mod = 0;
 217         layer_used = false;
 218         keymap_set_layer(0); // default layer
 219     } else if ((fn_bits & (fn_bits - 1)) == 0) {
 220         // switch layer when just one Fn Key is pressed
 221         last_bits = fn_bits;
 222         last_mod = keyboard_modifier_keys;
 223         layer_used = false;
 224         keymap_set_layer(FN_LAYER(onbit(fn_bits)));
 225         debug("layer: "); phex(current_layer); debug("(");
 226         debug_bin(last_bits); debug(")\n");
 227         debug("last_mod: "); debug_hex(last_mod); debug("\n");
 228     }
 229 }
 230
 231 static int onbit(uint8_t bits)
 232 {
 233     int n = 0;
 234     if (bits >> 4) { bits >>= 4; n += 4;}
 235     if (bits >> 2) { bits >>= 2; n += 2;}
 236     if (bits >> 1) { bits >>= 1; n += 1;}
 237     return n;
 238 }