hhkb/keymap.c

   1 /*
   2  * keymap for HHKB pro
   3  */
   4 #include <stdbool.h>
   5 #include <avr/pgmspace.h>
   6 #include "matrix.h"
   7 #include "keymap.h"
   8 #include "usb_keyboard.h"
   9
  10 int current_layer = 0;
  11 bool key_sent = false;
  12
  13 /*
  14  * Layer0(Default Layer)
  15  * ,-----------------------------------------------------------.
  16  * |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|  \|  `|
  17  * |-----------------------------------------------------------|
  18  * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|Backs|
  19  * |-----------------------------------------------------------|
  20  * |Contro|  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
  21  * |-----------------------------------------------------------|
  22  * |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Fn2   |Fn1|
  23  * `-----------------------------------------------------------'
  24  *       |Gui|Alt  |Space                  |Fn3  |Gui|
  25  *       `-------------------------------------------'
  26  *
  27  * Layer1(Fn) HHKB mode
  28  * ,-----------------------------------------------------------.
  29  * |Pow| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
  30  * |-----------------------------------------------------------|
  31  * |Caps |   |   |   |   |   |   |   |Psc|Slk|Pus|Up |   |Backs|
  32  * |-----------------------------------------------------------|
  33  * |Contro|VoD|VoU|Mut|   |   |  *|  /|Hom|PgU|Lef|Rig|Enter   |
  34  * |-----------------------------------------------------------|
  35  * |Shift   |   |   |   |   |   |  +|  -|End|PgD|Dow|Shift |xxx|
  36  * `-----------------------------------------------------------'
  37  *      |Gui |Alt  |Space                  |Alt  |Gui|
  38  *      `--------------------------------------------'
  39  *
  40  * Layer3(RALT) vi mode
  41  * ,-----------------------------------------------------------.
  42  * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
  43  * |-----------------------------------------------------------|
  44  * |Tab  |   |   |   |   |   |Hom|PgD|PgUlEnd|   |   |   |Backs|
  45  * |-----------------------------------------------------------|
  46  * |Contro|   |   |   |   |   |Lef|Dow|Up |Rig|   |   |Return  |
  47  * |-----------------------------------------------------------|
  48  * |Shift   |   |   |   |   |   |McL|McD|McU|McR|Mb1|Mb2   |   |
  49  * `-----------------------------------------------------------'
  50  *       |Gui|Alt  |Sapce                  |xxxxx|Mb3|
  51  *       `-------------------------------------------'
  52  *
  53  * Layer4(semicolon) mouse mode
  54  * ,-----------------------------------------------------------.
  55  * |Esc|   |   |   |   |   |   |   |   |   |   |   |   |   |   |
  56  * |-----------------------------------------------------------|
  57  * |Tab  |   |   |   |   |   |MwL|MwD|MwU|MwR|   |   |   |Backs|
  58  * |-----------------------------------------------------------|
  59  * |Contro|   |   |   |   |   |McL|McD|McU|McR|xxx|   |Return  |
  60  * |-----------------------------------------------------------|
  61  * |Shift   |   |   |   |   |   |   |Mb1|Mb2|Mb3|   |Shift |   |
  62  * `-----------------------------------------------------------'
  63  *      |Gui |Alt  |Mb1                    |Alt  |Gui|
  64  *      `--------------------------------------------'
  65  *
  66  * Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel
  67  */
  68
  69 /* keycode sent when Fn key released without using layer keys. */
  70 static const uint8_t PROGMEM FnKey[] = {
  71     KB_NO,          // this must be KB_NO. (not used)
  72     KB_NO,          // FN_1
  73     KB_RALT,        // FN_2
  74     KB_SCOLON,      // FN_3
  75 };
  76
  77 static const uint8_t PROGMEM Keymap[][MATRIX_ROWS][MATRIX_COLS] = {
  78 /*  plain keymap
  79     {
  80         { KB_2,       KB_Q,       KB_W,       KB_S,       KB_A,       KB_Z,       KB_X,       KB_C        },
  81         { KB_3,       KB_4,       KB_R,       KB_E,       KB_D,       KB_F,       KB_V,       KB_B        },
  82         { KB_5,       KB_6,       KB_Y,       KB_T,       KB_G,       KB_H,       KB_N,       KB_NO       },
  83         { KB_1,       KB_ESCAPE,  KB_TAB,     KB_LCTRL,   KB_LSHIFT,  KB_LGUI,    KB_LALT,    KB_SPACE    },
  84         { KB_7,       KB_8,       KB_U,       KB_I,       KB_K,       KB_J,       KB_M,       KB_NO       },
  85         { KB_BSLASH,  KB_GRAVE,   KB_BSPACE,  KB_ENTER,   FN_1,       KB_RSHIFT,  KB_RGUI,    KB_RALT     },
  86         { KB_9,       KB_0,       KB_O,       KB_P,       KB_SCOLON,  KB_L,       KB_COMMA,   KB_NO       },
  87         { KB_MINUS,   KB_EQUAL,   KB_RBRACKET,KB_LBRACKET,KB_QUOTE,   KB_SLASH,   KB_DOT,     KB_NO       },
  88     },
  89 */
  90     // 0: default
  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,    FN_2        },
  98         { KB_9,       KB_0,       KB_O,       KB_P,       FN_3,       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     // 1: FN_1 HHKB mode(Fn)
 102     {
 103         { KB_F2,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO       },
 104         { KB_F3,      KB_F4,      KB_NO,      KB_NO,      KB_MUTE,    KB_F20,     KB_NO,      KB_NO       },
 105         { KB_F5,      KB_F6,      KB_NO,      KB_NO,      KB_NO,      KP_ASTERISK,KP_PLUS,    KB_NO       },
 106         { KB_F1,      KB_POWER,   KB_CAPSLOCK,KB_LCTRL,   KB_LSHIFT,  KB_LGUI,    KB_LALT,    KB_SPACE    },
 107         { KB_F7,      KB_F8,      KB_NO,      KB_PSCREEN, KB_HOME,    KP_SLASH,   KB_MINUS,   KB_NO       },
 108         { KB_INSERT,  KB_DELETE,  KB_BSPACE,  KP_ENTER,   KB_NO,      KB_RSHIFT,  KB_RGUI,    KB_RALT     },
 109         { KB_F9,      KB_F10,     KB_SCKLOCK, KB_BREAK,   KB_LEFT,    KB_PGUP,    KB_END,     KB_NO       },
 110         { KB_F11,     KB_F12,     KB_NO,      KB_UP,      KB_RIGHT,   KB_DOWN,    KB_PGDOWN,  KB_NO       },
 111     },
 112     // 2: FN_2 vi mode(RALT)
 113     {
 114         { KB_F2,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO       },
 115         { KB_F3,      KB_F4,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO       },
 116         { KB_F5,      KB_F6,      KB_HOME,    KB_NO,      KB_NO,      KB_LEFT,    MS_LEFT,    KB_NO       },
 117         { KB_F1,      KB_ESCAPE,  KB_TAB,     KB_LCTRL,   KB_LSHIFT,  KB_LGUI,    KB_LALT,    KB_SPACE    },
 118         { KB_F7,      KB_F8,      KB_PGDOWN,  KB_PGUP,    KB_UP,      KB_DOWN,    MS_DOWN,    KB_NO       },
 119         { KB_INSERT,  KB_DELETE,  KB_BSPACE,  KB_ENTER,   KB_NO,      MS_BTN2,    MS_BTN3,    KB_NO       },
 120         { KB_F9,      KB_F10,     KB_END,     KB_NO,      KB_NO,      KB_RIGHT,   MS_UP,      KB_NO       },
 121         { KB_F11,     KB_F12,     MS_WH_UP,   MS_WH_DOWN, KB_NO,      MS_BTN1,    MS_RIGHT,   KB_NO       },
 122     },
 123     // 3: FN_3 vi mouse mode(SCOLON)
 124     {
 125         { KB_F2,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO       },
 126         { KB_F3,      KB_F4,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO,      KB_NO       },
 127         { KB_F5,      KB_F6,      MS_WH_LEFT, KB_NO,      KB_NO,      MS_LEFT,    KB_NO,      KB_NO       },
 128         { KB_F1,      KB_ESCAPE,  KB_TAB,     KB_LCTRL,   KB_LSHIFT,  KB_LGUI,    KB_LALT,    MS_BTN1     },
 129         { KB_F7,      KB_F8,      MS_WH_DOWN, MS_WH_UP,   MS_UP,      MS_DOWN,    MS_BTN1,    KB_NO       },
 130         { KB_NO,      KB_NO,      KB_BSPACE,  KB_ENTER,   KB_NO,      KB_RSHIFT,  KB_RGUI,    KB_RALT     },
 131         { KB_F9,      KB_F10,     MS_WH_RIGHT,KB_NO,      KB_NO,      MS_RIGHT,   MS_BTN2,    KB_NO       },
 132         { KB_F11,     KB_F12,     KB_NO,      KB_NO,      KB_NO,      KB_NO,      MS_BTN3,    KB_NO       },
 133     },
 134 };
 135
 136
 137 uint8_t get_keycode(int layer, int row, int col)
 138 {
 139     if (row >= MATRIX_ROWS)
 140         return KB_NO;
 141     if (col >= MATRIX_COLS)
 142         return KB_NO;
 143     return pgm_read_byte(&Keymap[layer][row][col]);
 144 }
 145
 146 int get_layer(void) {
 147     // keep modifier state when Fn key pressed
 148     static uint8_t preserved_modifiers = 0;
 149     int layer = 0;
 150     uint8_t modifiers = 0;
 151     for (int row = 0; row < MATRIX_ROWS; row++) {
 152         for (int col = 0; col < MATRIX_ROWS; col++) {
 153             if (matrix[row] & 1<<col) continue; // NOT pressed
 154             uint8_t code = get_keycode(0, row, col);
 155             if      (code == FN_1) layer = 1;
 156             else if (code == FN_2) layer = 2;
 157             else if (code == FN_3) layer = 3;
 158             else if (code == FN_4) layer = 4;
 159             else if (KB_LCTRL <= code && code <= KB_RGUI)
 160                 modifiers |= 1<<(code & 0x07);
 161         }
 162     }
 163
 164     // TODO: this logic should go anywhere
 165     // TODO: need timeout for key_sent
 166     // send key when Fn key reloeased without used
 167     if (layer != current_layer) {
 168         if (layer == 0 && !key_sent) {
 169             uint8_t code = pgm_read_byte(&FnKey[current_layer]);
 170             if (code) {
 171                 // send modifiers when Fn key pressed.
 172                 keyboard_modifier_keys = preserved_modifiers;
 173                 for (int i = 0; i < 6; i++) keyboard_keys[i] = KB_NO;
 174
 175                 if (KB_LCTRL <= code && code <= KB_RGUI) {
 176                     keyboard_modifier_keys |= 1<<(code & 0x07);
 177                 } else  {
 178                     keyboard_keys[0] = code;
 179                 }
 180                 usb_keyboard_send();
 181             }
 182         }
 183         current_layer = layer;
 184         key_sent = false;
 185         preserved_modifiers = modifiers;
 186     }
 187
 188     return current_layer;
 189 }