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 "usb_keycodes.h"
  26 #include "print.h"
  27 #include "debug.h"
  28 #include "util.h"
  29 #include "keymap.h"
  30
  31
  32 // Convert physical keyboard layout to matrix array.
  33 // This is a macro to define keymap easily in keyboard layout form.
  34 #define KEYMAP( \
  35     K31, K30, K00, K10, K11, K20, K21, K40, K41, K60, K61, K70, K71, K50, K51, \
  36     K32, K01, K02, K13, K12, K23, K22, K42, K43, K62, K63, K73, K72, K52, \
  37     K33, K04, K03, K14, K15, K24, K25, K45, K44, K65, K64, K74, K53, \
  38     K34, K05, K06, K07, K16, K17, K26, K46, K66, K76, K75, K55, K54, \
  39          K35, K36,           K37,                K57, K56 \
  40 ) \
  41 { \
  42     { KB_##K00, KB_##K01, KB_##K02, KB_##K03, KB_##K04, KB_##K05, KB_##K06, KB_##K07 }, \
  43     { KB_##K10, KB_##K11, KB_##K12, KB_##K13, KB_##K14, KB_##K15, KB_##K16, KB_##K17 }, \
  44     { KB_##K20, KB_##K21, KB_##K22, KB_##K23, KB_##K24, KB_##K25, KB_##K26, KB_NO    }, \
  45     { KB_##K30, KB_##K31, KB_##K32, KB_##K33, KB_##K34, KB_##K35, KB_##K36, KB_##K37 }, \
  46     { KB_##K40, KB_##K41, KB_##K42, KB_##K43, KB_##K44, KB_##K45, KB_##K46, KB_NO    }, \
  47     { KB_##K50, KB_##K51, KB_##K52, KB_##K53, KB_##K54, KB_##K55, KB_##K56, KB_##K57 }, \
  48     { KB_##K60, KB_##K61, KB_##K62, KB_##K63, KB_##K64, KB_##K65, KB_##K66, KB_NO    }, \
  49     { KB_##K70, KB_##K71, KB_##K72, KB_##K73, KB_##K74, KB_##K75, KB_##K76, KB_NO    } \
  50 }
  51
  52 #define KEYCODE(layer, row, col) (pgm_read_byte(&keymaps[(layer)][(row)][(col)]))
  53
  54
  55 // Assign Fn key(0-7) to a layer to which switch with the Fn key pressed.
  56 static const uint8_t PROGMEM fn_layer[] = {
  57     0,              // Fn0
  58     1,              // Fn1
  59     2,              // Fn2
  60     3,              // Fn3
  61     3,              // Fn4
  62     4,              // Fn5
  63     0,              // Fn6
  64     0               // Fn7
  65 };
  66
  67 // Assign Fn key(0-7) to a keycode sent when release Fn key without use of the layer.
  68 // See layer.c for details.
  69 static const uint8_t PROGMEM fn_keycode[] = {
  70     KB_NO,          // Fn0
  71     KB_NO,          // Fn1
  72     KB_SLSH,        // Fn2
  73     KB_SCLN,        // Fn3
  74     KB_NO,          // Fn4
  75     KB_SPC,         // Fn5
  76     KB_NO,          // Fn6
  77     KB_NO           // Fn7
  78 };
  79
  80 static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  81     /* Layer 0: Default Layer
  82      * ,-----------------------------------------------------------.
  83      * |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|  \|  `|
  84      * |-----------------------------------------------------------|
  85      * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|Backs|
  86      * |-----------------------------------------------------------|
  87      * |Contro|  A|  S|  D|  F|  G|  H|  J|  K|  L|Fn3|  '|Return  |
  88      * |-----------------------------------------------------------|
  89      * |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|Fn2|Shift |Fn1|
  90      * `-----------------------------------------------------------'
  91      *       |Gui|Alt  |Fn5                    |Alt  |Fn4|
  92      *       `-------------------------------------------'
  93      */
  94     KEYMAP(ESC, 1,   2,   3,   4,   5,   6,   7,   8,   9,   0,   MINS,EQL, BSLS,GRV, \
  95            TAB, Q,   W,   E,   R,   T,   Y,   U,   I,   O,   P,   LBRC,RBRC,BSPC, \
  96            LCTL,A,   S,   D,   F,   G,   H,   J,   K,   L,   FN3, QUOT,ENT, \
  97            LSFT,Z,   X,   C,   V,   B,   N,   M,   COMM,DOT, FN2, RSFT,FN1, \
  98                 LGUI,LALT,          SPC,                RALT,FN4),
  99
 100     /* Layer 1: HHKB mode (HHKB Fn)
 101      * ,-----------------------------------------------------------.
 102      * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
 103      * |-----------------------------------------------------------|
 104      * |Caps |   |   |   |   |   |   |   |Psc|Slk|Pus|Up |   |Backs|
 105      * |-----------------------------------------------------------|
 106      * |Contro|VoD|VoU|Mut|   |   |  *|  /|Hom|PgU|Lef|Rig|Enter   |
 107      * |-----------------------------------------------------------|
 108      * |Shift   |   |   |   |   |   |  +|  -|End|PgD|Dow|Shift |xxx|
 109      * `-----------------------------------------------------------'
 110      *      |Gui |Alt  |Space                  |Alt  |xxx|
 111      *      `--------------------------------------------'
 112      */
 113     KEYMAP(PWR, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12, INS, DEL, \
 114            CAPS,NO,  NO,  NO,  NO,  NO,  NO,  NO,  PSCR,SLCK,BRK, UP,  NO,  BSPC, \
 115            LCTL,VOLD,VOLU,MUTE,NO,  NO,  PAST,PSLS,HOME,PGUP,LEFT,RGHT,ENT, \
 116            LSFT,NO,  NO,  NO,  NO,  NO,  PPLS,PMNS,END, PGDN,DOWN,RSFT,FN1, \
 117                 LGUI,LALT,          SPC,                RALT,FN7),
 118
 119     /* Layer 2: Vi mode (Slash)
 120      * ,-----------------------------------------------------------.
 121      * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
 122      * |-----------------------------------------------------------|
 123      * |Tab  |Hom|PgD|Up |PgU|End|Hom|PgD|PgUlEnd|   |   |   |Backs|
 124      * |-----------------------------------------------------------|
 125      * |Contro|   |Lef|Dow|Rig|   |Lef|Dow|Up |Rig|   |   |Return  |
 126      * |-----------------------------------------------------------|
 127      * |Shift   |   |   |   |   |   |Hom|PgD|PgUlEnd|xxx|Shift |   |
 128      * `-----------------------------------------------------------'
 129      *       |Gui|Alt  |Space                  |Alt  |Gui|
 130      *       `-------------------------------------------'
 131      */
 132     KEYMAP(ESC, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12, INS, DEL, \
 133            TAB, HOME,PGDN,UP,  PGUP,END, HOME,PGDN,PGUP,END, NO,  NO,  NO,  BSPC, \
 134            LCTL,NO,  LEFT,DOWN,RGHT,NO,  LEFT,DOWN,UP,  RGHT,NO,  NO,  ENT, \
 135            LSFT,NO,  NO,  NO,  NO,  NO,  HOME,PGDN,PGUP,END, FN2, RSFT,NO, \
 136                 LGUI,LALT,          SPC,                RALT,RGUI),
 137
 138     /* Layer 3: Mouse mode (Semicolon)
 139      * ,-----------------------------------------------------------.
 140      * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
 141      * |-----------------------------------------------------------|
 142      * |Tab  |MwL|MwU|McU|MwD|MwR|MwL|MwD|MwU|MwR|   |   |   |Backs|
 143      * |-----------------------------------------------------------|
 144      * |Contro|   |McL|McD|McR|   |McL|McD|McU|McR|xxx|   |Return  |
 145      * |-----------------------------------------------------------|
 146      * |Shift   |Mb4|Mb5|Mb1|Mb2|Mb3|Mb2|Mb1|Mb4|Mb5|   |Shift |   |
 147      * `-----------------------------------------------------------'
 148      *      |Gui |Alt  |Mb1                    |Alt  |Gui|
 149      *      `--------------------------------------------'
 150      * Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel
 151      */
 152 #ifdef HOST_IWRAP
 153 // iWRAP does not support mouse wheel, use these keycodes to remap as wheel
 154 #define KB_KPPL KB_KP_PLUS
 155 #define KB_KPMI KB_KP_MINUS
 156 #define KB_KPAS KB_KP_ASTERISK
 157 #define KB_KPSL KB_KP_SLASH
 158     KEYMAP(ESC, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12, INS, DEL, \
 159            TAB, KPAS,KPPL,MS_U,KPMI,KPSL,KPAS,KPPL,KPMI,KPSL,NO,  NO,  NO,  BSPC, \
 160            LCTL,NO,  MS_L,MS_D,MS_R,NO,  MS_L,MS_D,MS_U,MS_R,FN3, NO,  ENT, \
 161            LSFT,BTN4,BTN5,BTN1,BTN2,BTN3,BTN2,BTN1,NO,  NO,  NO,  RSFT,NO, \
 162                 LGUI,LALT,          BTN1,               RALT,FN4),
 163 #else
 164     KEYMAP(ESC, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12, INS, DEL, \
 165            TAB, WH_L,WH_U,MS_U,WH_D,WH_R,WH_L,WH_D,WH_U,WH_R,NO,  NO,  NO,  BSPC, \
 166            LCTL,NO,  MS_L,MS_D,MS_R,NO,  MS_L,MS_D,MS_U,MS_R,FN3, NO,  ENT, \
 167            LSFT,BTN4,BTN5,BTN1,BTN2,BTN3,BTN2,BTN1,BTN4,BTN5,NO,  RSFT,NO, \
 168                 LGUI,LALT,          BTN1,               RALT,FN4),
 169 #endif
 170
 171     /* Layer 4: Matias half keyboard style (Space)
 172      * ,-----------------------------------------------------------.
 173      * |  -|  0|  9|  8|  7|  6|  5|  4|  3|  2|  1|   |   |   |Esc|
 174      * |-----------------------------------------------------------|
 175      * |Backs|  P|  O|  I|  U|  Y|  T|  R|  E|  W|  Q|   |   |Tab  |
 176      * |-----------------------------------------------------------|
 177      * |Contro|  ;|  L|  K|  J|  H|  G|  F|  D|  S|  A|Con|Control |
 178      * |-----------------------------------------------------------|
 179      * |Shift   |  /|  .|  ,|  M|  N|  B|  V|  C|  X|  Z|Shift |   |
 180      * `-----------------------------------------------------------'
 181      *      |Gui |Alt  |xxxxxxxxxxxxxxxxxxxxxxx|Alt  |Gui|
 182      *      `--------------------------------------------'
 183      */
 184 /*
 185     KEYMAP(MINS,0,   9,   8,   7,   6,   5,   4,   3,   2,   1,   NO,  NO,  NO,  ESC, \
 186            BSPC,P,   O,   I,   U,   Y,   T,   R,   E,   W,   Q,   NO,  NO,  TAB, \
 187            LCTL,SCLN,L,   K,   J,   H,   G,   F,   D,   S,   A,   RCTL,RCTL, \
 188            LSFT,SLSH,DOT, COMM,M,   N,   B,   V,   C,   X,   Z,   RSFT,NO, \
 189                 LGUI,LALT,          FN5,                RALT,RGUI)
 190 */
 191     /* Mouse mode (Space) */
 192 #ifdef HOST_IWRAP
 193     KEYMAP(ESC, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12, INS, DEL, \
 194            TAB, KPAS,KPPL,MS_U,KPMI,KPSL,KPAS,KPPL,KPMI,KPSL,NO,  NO,  NO,  BSPC, \
 195            LCTL,NO,  MS_L,MS_D,MS_R,NO,  MS_L,MS_D,MS_U,MS_R,FN3, NO,  ENT, \
 196            LSFT,BTN4,BTN5,BTN1,BTN2,BTN3,BTN2,BTN1,BTN4,BTN5,NO,  RSFT,NO, \
 197                 LGUI,LALT,          FN5,                RALT,RGUI),
 198 #else
 199     KEYMAP(ESC, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12, INS, DEL, \
 200            TAB, WH_L,WH_U,MS_U,WH_D,WH_R,WH_L,WH_D,WH_U,WH_R,NO,  NO,  NO,  BSPC, \
 201            LCTL,NO,  MS_L,MS_D,MS_R,NO,  MS_L,MS_D,MS_U,MS_R,FN3, NO,  ENT, \
 202            LSFT,BTN4,BTN5,BTN1,BTN2,BTN3,BTN2,BTN1,BTN4,BTN5,NO,  RSFT,NO, \
 203                 LGUI,LALT,          FN5,                RALT,RGUI),
 204 #endif
 205 };
 206
 207
 208 uint8_t keymap_get_keycode(uint8_t layer, uint8_t row, uint8_t col)
 209 {
 210     return KEYCODE(layer, row, col);
 211 }
 212
 213 uint8_t keymap_fn_layer(uint8_t fn_bits)
 214 {
 215     return pgm_read_byte(&fn_layer[biton(fn_bits)]);
 216 }
 217
 218 uint8_t keymap_fn_keycode(uint8_t fn_bits)
 219 {
 220     return pgm_read_byte(&fn_keycode[(biton(fn_bits))]);
 221 }