hhkb/keymap.c

   1 /*
   2  * Keymap for PFU HHKB Pro
   3  */
   4 #include <stdint.h>
   5 #include <stdbool.h>
   6 #include <avr/pgmspace.h>
   7 #include "usb_keyboard.h"
   8 #include "usb_keycodes.h"
   9 #include "print.h"
  10 #include "debug.h"
  11 #include "util.h"
  12 #include "keymap_skel.h"
  13
  14
  15 #define KEYMAP( \
  16     R3C1, R3C0, R0C0, R1C0, R1C1, R2C0, R2C1, R4C0, R4C1, R6C0, R6C1, R7C0, R7C1, R5C0, R5C1, \
  17     R3C2, R0C1, R0C2, R1C3, R1C2, R2C3, R2C2, R4C2, R4C3, R6C2, R6C3, R7C3, R7C2, R5C2, \
  18     R3C3, R0C4, R0C3, R1C4, R1C5, R2C4, R2C5, R4C5, R4C4, R6C5, R6C4, R7C4, R5C3, \
  19     R3C4, R0C5, R0C6, R0C7, R1C6, R1C7, R2C6, R4C6, R6C6, R7C6, R7C5, R5C5, R5C4, \
  20     R3C5, R3C6, R3C7, R5C7, R5C6 \
  21 ) \
  22 { \
  23     { R0C0, R0C1, R0C2, R0C3, R0C4, R0C5, R0C6, R0C7 }, \
  24     { R1C0, R1C1, R1C2, R1C3, R1C4, R1C5, R1C6, R1C7 }, \
  25     { R2C0, R2C1, R2C2, R2C3, R2C4, R2C5, R2C6, KB_NO }, \
  26     { R3C0, R3C1, R3C2, R3C3, R3C4, R3C5, R3C6, R3C7 }, \
  27     { R4C0, R4C1, R4C2, R4C3, R4C4, R4C5, R4C6, KB_NO }, \
  28     { R5C0, R5C1, R5C2, R5C3, R5C4, R5C5, R5C6, R5C7 }, \
  29     { R6C0, R6C1, R6C2, R6C3, R6C4, R6C5, R6C6, KB_NO }, \
  30     { R7C0, R7C1, R7C2, R7C3, R7C4, R7C5, R7C6, KB_NO } \
  31 }
  32
  33 #define KEYCODE(layer, row, col) (pgm_read_byte(&keymaps[(layer)][(row)][(col)]))
  34
  35
  36 /* layer to change into while Fn key pressed */
  37 static const int PROGMEM fn_layer[] = { 0, 1, 2, 3, 4, 0, 0, 1 };
  38
  39 /* keycode to sent when Fn key released without using layer keys. */
  40 static const uint8_t PROGMEM fn_keycode[] = {
  41     KB_NO,          // FN_0 [NOT USED]
  42     KB_NO,          // FN_1 layer 1
  43     KB_SLSH,        // FN_2 layer 2
  44     KB_SCLN,        // FN_3 layer 3
  45     KB_SPC,         // FN_4 layer 4
  46     KB_NO,          // FN_5 [NOT USED]
  47     KB_NO,          // FN_6 [NOT USED]
  48     KB_NO           // FN_7 layer 1
  49 };
  50
  51 static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  52     /* Layer 0: Default Layer
  53      * ,-----------------------------------------------------------.
  54      * |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|  \|  `|
  55      * |-----------------------------------------------------------|
  56      * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|Backs|
  57      * |-----------------------------------------------------------|
  58      * |Contro|  A|  S|  D|  F|  G|  H|  J|  K|  L|Fn3|  '|Return  |
  59      * |-----------------------------------------------------------|
  60      * |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|Fn2|Shift |Fn1|
  61      * `-----------------------------------------------------------'
  62      *       |Gui|Alt  |Fn4                    |Alt  |Fn7|
  63      *       `-------------------------------------------'
  64      */
  65     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, \
  66            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, \
  67            KB_LCTL,KB_A,   KB_S,   KB_D,   KB_F,   KB_G,   KB_H,   KB_J,   KB_K,   KB_L,   FN_3,   KB_QUOT,KB_ENT, \
  68            KB_LSFT,KB_Z,   KB_X,   KB_C,   KB_V,   KB_B,   KB_N,   KB_M,   KB_COMM,KB_DOT, FN_2,   KB_RSFT,FN_1, \
  69            KB_LGUI,KB_LALT,FN_4,   KB_RALT,KB_RGUI),
  70
  71     /* Layer 1: HHKB mode (HHKB Fn)
  72      * ,-----------------------------------------------------------.
  73      * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
  74      * |-----------------------------------------------------------|
  75      * |Caps |   |   |   |   |   |   |   |Psc|Slk|Pus|Up |   |Backs|
  76      * |-----------------------------------------------------------|
  77      * |Contro|VoD|VoU|Mut|   |   |  *|  /|Hom|PgU|Lef|Rig|Enter   |
  78      * |-----------------------------------------------------------|
  79      * |Shift   |   |   |   |   |   |  +|  -|End|PgD|Dow|Shift |xxx|
  80      * `-----------------------------------------------------------'
  81      *      |Gui |Alt  |Space                  |Alt  |xxx|
  82      *      `--------------------------------------------'
  83      */
  84     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, \
  85            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, \
  86            KB_LCTL,KB_VOLD,KB_VOLU,KB_MUTE,KB_NO,  KB_NO,  KP_ASTR,KP_SLSH,KB_HOME,KB_PGUP,KB_LEFT,KB_RGHT,KB_ENT, \
  87            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, \
  88            KB_LGUI,KB_LALT,KB_SPC, KB_RALT,FN_7),
  89
  90     /* Layer 2: Vi mode (Slash)
  91      * ,-----------------------------------------------------------.
  92      * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
  93      * |-----------------------------------------------------------|
  94      * |Tab  |Hom|PgD|Up |PgU|End|Hom|PgD|PgUlEnd|   |   |   |Backs|
  95      * |-----------------------------------------------------------|
  96      * |Contro|   |Lef|Dow|Rig|   |Lef|Dow|Up |Rig|   |   |Return  |
  97      * |-----------------------------------------------------------|
  98      * |Shift   |   |   |   |   |   |Hom|PgD|PgUlEnd|xxx|Shift |   |
  99      * `-----------------------------------------------------------'
 100      *       |Gui|Alt  |Space                  |Alt  |Gui|
 101      *       `-------------------------------------------'
 102      */
 103     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, \
 104            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, \
 105            KB_LCTL,KB_NO,  KB_LEFT,KB_DOWN,KB_RGHT,KB_NO,  KB_LEFT,KB_DOWN,KB_UP,  KB_RGHT,KB_NO,  KB_NO,  KB_ENT, \
 106            KB_LSFT,KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_NO,  KB_HOME,KB_PGDN,KB_PGUP,KB_END, FN_2,   KB_RSFT,KB_NO, \
 107            KB_LGUI,KB_LALT,KB_SPC, KB_RALT,KB_RGUI),
 108
 109     /* Layer 3: Mouse mode (Semicolon)
 110      * ,-----------------------------------------------------------.
 111      * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
 112      * |-----------------------------------------------------------|
 113      * |Tab  |MwL|MwU|McU|MwD|MwR|MwL|MwD|MwU|MwR|   |   |   |Backs|
 114      * |-----------------------------------------------------------|
 115      * |Contro|   |McL|McD|McR|   |McL|McD|McU|McR|xxx|   |Return  |
 116      * |-----------------------------------------------------------|
 117      * |Shift   |Mb4|Mb5|Mb1|Mb2|Mb3|Mb2|Mb1|Mb4|Mb5|   |Shift |   |
 118      * `-----------------------------------------------------------'
 119      *      |Gui |Alt  |Mb1                    |Alt  |Gui|
 120      *      `--------------------------------------------'
 121      * Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel
 122      */
 123     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, \
 124            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, \
 125            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, \
 126            KB_LSFT,MS_BTN4,MS_BTN5,MS_BTN1,MS_BTN2,MS_BTN3,MS_BTN2,MS_BTN1,MS_BTN4,MS_BTN5,KB_NO,  KB_RSFT,KB_NO, \
 127            KB_LGUI,KB_LALT,MS_BTN1,KB_RALT,KB_RGUI),
 128
 129     /* Layer 4: Matias half keyboard style (Space)
 130      * ,-----------------------------------------------------------.
 131      * |  -|  0|  9|  8|  7|  6|  5|  4|  3|  2|  1|   |   |   |Esc|
 132      * |-----------------------------------------------------------|
 133      * |Backs|  P|  O|  I|  U|  Y|  T|  R|  E|  W|  Q|   |   |Tab  |
 134      * |-----------------------------------------------------------|
 135      * |Contro|  ;|  L|  K|  J|  H|  G|  F|  D|  S|  A|Con|Control |
 136      * |-----------------------------------------------------------|
 137      * |Shift   |  /|  .|  ,|  M|  N|  B|  V|  C|  X|  Z|Shift |   |
 138      * `-----------------------------------------------------------'
 139      *      |Gui |Alt  |xxxxxxxxxxxxxxxxxxxxxxx|Alt  |Gui|
 140      *      `--------------------------------------------'
 141      */
 142     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, \
 143            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, \
 144            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, \
 145            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, \
 146            KB_LGUI,KB_LALT,FN_4,   KB_RALT,KB_RGUI)
 147 };
 148
 149
 150 uint8_t keymap_get_keycode(uint8_t layer, uint8_t row, uint8_t col)
 151 {
 152     return KEYCODE(layer, row, col);
 153 }
 154
 155 int keymap_fn_layer(uint8_t fn_bits)
 156 {
 157     return pgm_read_byte(&fn_layer[biton(fn_bits)]);
 158 }
 159
 160 uint8_t keymap_fn_keycode(uint8_t fn_bits)
 161 {
 162     return pgm_read_byte(&fn_keycode[(biton(fn_bits))]);
 163 }
 164
 165 bool keymap_is_special_mode(uint8_t fn_bits)
 166 {
 167     return (usb_keyboard_mods == (BIT_LCTRL | BIT_LSHIFT | BIT_LALT | BIT_LGUI));
 168 }