hhkb/keymap.c

   1 /*
   2  * keymap for HHKB pro
   3  */
   4 #include <stdbool.h>
   5 #include <avr/pgmspace.h>
   6 #include "usb_keyboard.h"
   7 #include "matrix.h"
   8 #include "keymap.h"
   9 #include "print.h"
  10
  11 #define FN_KEYCODE(fn) (pgm_read_byte(&fn_keycode[(fn)]))
  12 #define FN_LAYER(fn)   (pgm_read_byte(&fn_layer[(fn)]))
  13 #define KEYMAPS(layer, row, col) (pgm_read_byte(&keymaps[(layer)][(row)][(col)]))
  14
  15 static int current_layer = 0;
  16 static bool layer_used = false;
  17 static int onbit(uint8_t bits);
  18
  19 /*
  20  * Layer0(Default Layer)
  21  * ,-----------------------------------------------------------.
  22  * |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|  \|  `|
  23  * |-----------------------------------------------------------|
  24  * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|Backs|
  25  * |-----------------------------------------------------------|
  26  * |Contro|  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
  27  * |-----------------------------------------------------------|
  28  * |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Fn2   |Fn1|
  29  * `-----------------------------------------------------------'
  30  *       |Gui|Alt  |Space                  |Fn3  |Gui|
  31  *       `-------------------------------------------'
  32  *
  33  * Layer1(Fn) HHKB mode
  34  * ,-----------------------------------------------------------.
  35  * |Pow| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
  36  * |-----------------------------------------------------------|
  37  * |Caps |   |   |   |   |   |   |   |Psc|Slk|Pus|Up |   |Backs|
  38  * |-----------------------------------------------------------|
  39  * |Contro|VoD|VoU|Mut|   |   |  *|  /|Hom|PgU|Lef|Rig|Enter   |
  40  * |-----------------------------------------------------------|
  41  * |Shift   |   |   |   |   |   |  +|  -|End|PgD|Dow|Shift |xxx|
  42  * `-----------------------------------------------------------'
  43  *      |Gui |Alt  |Space                  |Alt  |Gui|
  44  *      `--------------------------------------------'
  45  *
  46  * Layer3(RALT) vi mode
  47  * ,-----------------------------------------------------------.
  48  * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
  49  * |-----------------------------------------------------------|
  50  * |Tab  |   |   |   |   |   |Hom|PgD|PgUlEnd|   |   |   |Backs|
  51  * |-----------------------------------------------------------|
  52  * |Contro|   |   |   |   |   |Lef|Dow|Up |Rig|   |   |Return  |
  53  * |-----------------------------------------------------------|
  54  * |Shift   |   |   |   |   |   |McL|McD|McU|McR|Mb1|Mb2   |   |
  55  * `-----------------------------------------------------------'
  56  *       |Gui|Alt  |Sapce                  |xxxxx|Mb3|
  57  *       `-------------------------------------------'
  58  *
  59  * Layer4(semicolon) mouse mode
  60  * ,-----------------------------------------------------------.
  61  * |Esc|   |   |   |   |   |   |   |   |   |   |   |   |   |   |
  62  * |-----------------------------------------------------------|
  63  * |Tab  |   |   |   |   |   |MwL|MwD|MwU|MwR|   |   |   |Backs|
  64  * |-----------------------------------------------------------|
  65  * |Contro|   |   |   |   |   |McL|McD|McU|McR|xxx|   |Return  |
  66  * |-----------------------------------------------------------|
  67  * |Shift   |   |   |   |   |   |   |Mb1|Mb2|Mb3|   |Shift |   |
  68  * `-----------------------------------------------------------'
  69  *      |Gui |Alt  |Mb1                    |Alt  |Gui|
  70  *      `--------------------------------------------'
  71  *
  72  * Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel
  73  */
  74
  75 /* keycode to sent when Fn key released without using layer keys. */
  76 static const uint8_t PROGMEM fn_keycode[] = {
  77     KB_NO,          // FN_0
  78     KB_NO,          // FN_1
  79     KB_RALT,        // FN_2
  80     KB_SCOLON,      // FN_3
  81     KB_NO,          // FN_4
  82     KB_NO,          // FN_5
  83     KB_NO,          // FN_6
  84     KB_NO,          // FN_7
  85 };
  86 /* layer to change into while Fn key pressed */
  87 static const int PROGMEM fn_layer[] = { 0, 1, 2, 3, 0, 0, 0, 0 };
  88
  89 static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  90 /*  plain keymap
  91     {
  92         { KB_2,       KB_Q,       KB_W,       KB_S,       KB_A,       KB_Z,       KB_X,       KB_C        },
  93         { KB_3,       KB_4,       KB_R,       KB_E,       KB_D,       KB_F,       KB_V,       KB_B        },
  94         { KB_5,       KB_6,       KB_Y,       KB_T,       KB_G,       KB_H,       KB_N,       KB_NO       },
  95         { KB_1,       KB_ESCAPE,  KB_TAB,     KB_LCTRL,   KB_LSHIFT,  KB_LGUI,    KB_LALT,    KB_SPACE    },
  96         { KB_7,       KB_8,       KB_U,       KB_I,       KB_K,       KB_J,       KB_M,       KB_NO       },
  97         { KB_BSLASH,  KB_GRAVE,   KB_BSPACE,  KB_ENTER,   FN_1,       KB_RSHIFT,  KB_RGUI,    KB_RALT     },
  98         { KB_9,       KB_0,       KB_O,       KB_P,       KB_SCOLON,  KB_L,       KB_COMMA,   KB_NO       },
  99         { KB_MINUS,   KB_EQUAL,   KB_RBRACKET,KB_LBRACKET,KB_QUOTE,   KB_SLASH,   KB_DOT,     KB_NO       },
 100     },
 101 */
 102     // 0: default
 103     {
 104         { KB_2,       KB_Q,       KB_W,       KB_S,       KB_A,       KB_Z,       KB_X,       KB_C        },
 105         { KB_3,       KB_4,       KB_R,       KB_E,       KB_D,       KB_F,       KB_V,       KB_B        },
 106         { KB_5,       KB_6,       KB_Y,       KB_T,       KB_G,       KB_H,       KB_N,       KB_NO       },
 107         { KB_1,       KB_ESCAPE,  KB_TAB,     KB_LCTRL,   KB_LSHIFT,  KB_LGUI,    KB_LALT,    KB_SPACE    },
 108         { KB_7,       KB_8,       KB_U,       KB_I,       KB_K,       KB_J,       KB_M,       KB_NO       },
 109         { KB_BSLASH,  KB_GRAVE,   KB_BSPACE,  KB_ENTER,   FN_1,       KB_RSHIFT,  KB_RGUI,    FN_2        },
 110         { KB_9,       KB_0,       KB_O,       KB_P,       FN_3,       KB_L,       KB_COMMA,   KB_NO       },
 111         { KB_MINUS,   KB_EQUAL,   KB_RBRACKET,KB_LBRACKET,KB_QUOTE,   KB_SLASH,   KB_DOT,     KB_NO       },
 112     },
 113     // 1: FN_1 HHKB mode(Fn)
 114     {
 115         { KB_F2,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO       },
 116         { KB_F3,      KB_F4,      KB_NO,      KB_NO,      KB_MUTE,    KB_F20,     KB_NO,      KB_NO       },
 117         { KB_F5,      KB_F6,      KB_NO,      KB_NO,      KB_NO,      KP_ASTERISK,KP_PLUS,    KB_NO       },
 118         { KB_F1,      KB_POWER,   KB_CAPSLOCK,KB_LCTRL,   KB_LSHIFT,  KB_LGUI,    KB_LALT,    KB_SPACE    },
 119         { KB_F7,      KB_F8,      KB_NO,      KB_PSCREEN, KB_HOME,    KP_SLASH,   KB_MINUS,   KB_NO       },
 120         { KB_INSERT,  KB_DELETE,  KB_BSPACE,  KP_ENTER,   KB_NO,      KB_RSHIFT,  KB_RGUI,    KB_RALT     },
 121         { KB_F9,      KB_F10,     KB_SCKLOCK, KB_BREAK,   KB_LEFT,    KB_PGUP,    KB_END,     KB_NO       },
 122         { KB_F11,     KB_F12,     KB_NO,      KB_UP,      KB_RIGHT,   KB_DOWN,    KB_PGDOWN,  KB_NO       },
 123     },
 124     // 2: FN_2 vi mode(RALT)
 125     {
 126         { KB_F2,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO       },
 127         { KB_F3,      KB_F4,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO       },
 128         { KB_F5,      KB_F6,      KB_HOME,    KB_NO,      KB_NO,      KB_LEFT,    MS_LEFT,    KB_NO       },
 129         { KB_F1,      KB_ESCAPE,  KB_TAB,     KB_LCTRL,   KB_LSHIFT,  KB_LGUI,    KB_LALT,    KB_SPACE    },
 130         { KB_F7,      KB_F8,      KB_PGDOWN,  KB_PGUP,    KB_UP,      KB_DOWN,    MS_DOWN,    KB_NO       },
 131         { KB_INSERT,  KB_DELETE,  KB_BSPACE,  KB_ENTER,   KB_NO,      MS_BTN2,    MS_BTN3,    KB_NO       },
 132         { KB_F9,      KB_F10,     KB_END,     KB_NO,      KB_NO,      KB_RIGHT,   MS_UP,      KB_NO       },
 133         { KB_F11,     KB_F12,     MS_WH_UP,   MS_WH_DOWN, KB_NO,      MS_BTN1,    MS_RIGHT,   KB_NO       },
 134     },
 135     // 3: FN_3 vi mouse mode(SCOLON)
 136     {
 137         { KB_F2,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO       },
 138         { KB_F3,      KB_F4,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO       },
 139         { KB_F5,      KB_F6,      MS_WH_LEFT, KB_NO,      KB_NO,      MS_LEFT,    KB_NO,      KB_NO       },
 140         { KB_F1,      KB_ESCAPE,  KB_TAB,     KB_LCTRL,   KB_LSHIFT,  KB_LGUI,    KB_LALT,    MS_BTN1     },
 141         { KB_F7,      KB_F8,      MS_WH_DOWN, MS_WH_UP,   MS_UP,      MS_DOWN,    MS_BTN1,    KB_NO       },
 142         { KB_NO,      KB_NO,      KB_BSPACE,  KB_ENTER,   KB_NO,      KB_RSHIFT,  KB_RGUI,    KB_RALT     },
 143         { KB_F9,      KB_F10,     MS_WH_RIGHT,KB_NO,      KB_NO,      MS_RIGHT,   MS_BTN2,    KB_NO       },
 144         { KB_F11,     KB_F12,     KB_NO,      KB_NO,      KB_NO,      KB_NO,      MS_BTN3,    KB_NO       },
 145     },
 146 };
 147
 148
 149 uint8_t keymap_get_keycode(int row, int col)
 150 {
 151     return keymap_get_keycodel(current_layer, row, col);
 152 }
 153
 154 uint8_t keymap_get_keycodel(int layer, int row, int col)
 155 {
 156     uint8_t code = KEYMAPS(layer, row, col);
 157     // normal key or mouse key
 158     if ((KB_A <= code && code <= KP_HEXADECIMAL) ||
 159         (MS_UP <= code && code <= MS_WH_RIGHT))
 160         layer_used = true;
 161     return code;
 162 }
 163
 164 inline
 165 int keymap_get_layer(void) {
 166     return current_layer;
 167 }
 168
 169 inline
 170 int keymap_set_layer(int layer) {
 171     current_layer = layer;
 172     return current_layer;
 173 }
 174
 175 void keymap_fn_proc(int fn_bits) {
 176     // layer switching
 177     static int last_bits = 0;
 178     static uint8_t last_mod = 0;
 179
 180     if (usb_keyboard_has_key() || fn_bits == last_bits) {
 181         // do nothing during press other than Fn key
 182         return;
 183     } else if (fn_bits == 0) {
 184         // send key when Fn key is released without using the layer
 185         if (!layer_used) {
 186             uint8_t code = FN_KEYCODE(onbit(last_bits));
 187             if (code != KB_NO) {
 188                 if (KB_LCTRL <= code  && code <= KB_RGUI) {
 189                     keyboard_modifier_keys = last_mod | 1<<(code & 0x07);
 190                 } else {
 191                     keyboard_keys[0] = code;
 192                     keyboard_modifier_keys = last_mod;
 193                 }
 194                 usb_keyboard_send();
 195                 usb_keyboard_print();
 196                 usb_keyboard_clear();
 197             }
 198         }
 199         last_bits = 0;
 200         last_mod = 0;
 201         layer_used = false;
 202         keymap_set_layer(0); // default layer
 203         print("layer default: "); phex(current_layer); print("\n");
 204     } else if ((fn_bits & (fn_bits - 1)) == 0) {
 205         // switch layer when just one Fn Key is pressed
 206         last_bits = fn_bits;
 207         last_mod = keyboard_modifier_keys;
 208         layer_used = false;
 209         keymap_set_layer(FN_LAYER(onbit(fn_bits)));
 210         print("layer: "); phex(current_layer); print("\n");
 211         print("last_bits: "); phex(last_bits); print("\n");
 212         print("last_mod: "); phex(last_mod); print("\n");
 213     }
 214 }
 215
 216 static int onbit(uint8_t bits) {
 217     int n = 0;
 218     if (bits >> 4) { bits >>= 4; n += 4;}
 219     if (bits >> 2) { bits >>= 2; n += 2;}
 220     if (bits >> 1) { bits >>= 1; n += 1;}
 221     return n;
 222 }