keyboard/hid_liber/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 HID Liberator controller
  20  */
  21 #include <stdint.h>
  22 #include <stdbool.h>
  23 #include <avr/pgmspace.h>
  24 #include "keycode.h"
  25 #include "action.h"
  26 #include "action_macro.h"
  27 #include "layer_switch.h"
  28 #include "report.h"
  29 #include "host.h"
  30 #include "print.h"
  31 #include "debug.h"
  32 #include "keymap.h"
  33
  34
  35 // Convert physical keyboard layout to matrix array.
  36 // This is a macro to define keymap easily in keyboard layout form.
  37 #define KEYMAP( \
  38     KG1, KH7, KJ7, KJ6, KJ1, KO5, KL1, KA6, KA7, KD7, KD5, KD1, KD2,      KB5, KB3, KO3, \
  39     KG7, KG5, KH5, KJ5, KI5, KI7, KK7, KK5, KL5, KA5, KC5, KC7, KL7, KD6, KQ7, KN7, KM7, \
  40     KG6, KG3, KH3, KJ3, KI3, KI6, KK6, KK3, KL3, KA3, KC3, KC6, KL6, KD4, KP7, KN5, KM5, \
  41     KH6, KG4, KH4, KJ4, KI4, KI1, KK1, KK4, KL4, KA4, KC4, KC1, KD0,                     \
  42     KF6, KH1, KG0, KH0, KJ0, KI0, KI2, KK2, KK0, KL0, KA0, KC2, KF4,           KN1,      \
  43     KO7, KE6, KB1,           KP1,                     KB2, KR4, KA2, KO0, KN2, KP2, KQ2  \
  44 ) { \
  45 /*             0         1         2         3         4         5         6         7     */ \
  46 /* A */   { KC_##KA0, KC_NO   , KC_##KA2, KC_##KA3, KC_##KA4, KC_##KA5, KC_##KA6, KC_##KA7 }, \
  47 /* B */   { KC_NO   , KC_##KB1, KC_##KB2, KC_##KB3, KC_NO   , KC_##KB5, KC_NO   , KC_NO    }, \
  48 /* C */   { KC_NO   , KC_##KC1, KC_##KC2, KC_##KC3, KC_##KC4, KC_##KC5, KC_##KC6, KC_##KC7 }, \
  49 /* D */   { KC_##KD0, KC_##KD1, KC_##KD2, KC_NO   , KC_##KD4, KC_##KD5, KC_##KD6, KC_##KD7 }, \
  50 /* E */   { KC_NO   , KC_NO   , KC_NO   , KC_NO   , KC_NO   , KC_NO   , KC_##KE6, KC_NO    }, \
  51 /* F */   { KC_NO   , KC_NO   , KC_NO   , KC_NO   , KC_##KF4, KC_NO   , KC_##KF6, KC_NO    }, \
  52 /* G */   { KC_##KG0, KC_##KG1, KC_NO   , KC_##KG3, KC_##KG4, KC_##KG5, KC_##KG6, KC_##KG7 }, \
  53 /* H */   { KC_##KH0, KC_##KH1, KC_NO   , KC_##KH3, KC_##KH4, KC_##KH5, KC_##KH6, KC_##KH7 }, \
  54 /* I */   { KC_##KI0, KC_##KI1, KC_##KI2, KC_##KI3, KC_##KI4, KC_##KI5, KC_##KI6, KC_##KI7 }, \
  55 /* J */   { KC_##KJ0, KC_##KJ1, KC_NO   , KC_##KJ3, KC_##KJ4, KC_##KJ5, KC_##KJ6, KC_##KJ7 }, \
  56 /* K */   { KC_##KK0, KC_##KK1, KC_##KK2, KC_##KK3, KC_##KK4, KC_##KK5, KC_##KK6, KC_##KK7 }, \
  57 /* L */   { KC_##KL0, KC_##KL1, KC_NO   , KC_##KL3, KC_##KL4, KC_##KL5, KC_##KL6, KC_##KL7 }, \
  58 /* M */   { KC_NO   , KC_NO   , KC_NO   , KC_NO   , KC_NO   , KC_##KM5, KC_NO   , KC_##KM7 }, \
  59 /* N */   { KC_NO   , KC_##KN1, KC_##KN2, KC_NO   , KC_NO   , KC_##KN5, KC_NO   , KC_##KN7 }, \
  60 /* O */   { KC_##KO0, KC_NO   , KC_NO   , KC_##KO3, KC_NO   , KC_##KO5, KC_NO   , KC_##KO7 }, \
  61 /* P */   { KC_NO   , KC_##KP1, KC_##KP2, KC_NO   , KC_NO   , KC_NO   , KC_NO   , KC_##KP7 }, \
  62 /* Q */   { KC_NO   , KC_NO   , KC_##KQ2, KC_NO   , KC_NO   , KC_NO   , KC_NO   , KC_##KQ7 }, \
  63 /* R */   { KC_NO   , KC_NO   , KC_NO   , KC_NO   , KC_##KR4, KC_NO   , KC_NO   , KC_NO    }  \
  64 }
  65
  66 /*
  67  * Add custom layouts. If no custom layout is defined the default layout is used.
  68 */
  69 #if defined(KEYMAP_CUSTOM)
  70     #include "keymap_custom.h"
  71 #else
  72 /*
  73  * Tenkeyless keyboard default layout, ISO & ANSI (ISO is between Left Shift
  74  * and Z, and the ANSI \ key above Return/Enter is used for the additional ISO
  75  * switch in the ASD row next to enter.  Use NUBS as keycode for the first and
  76  * NUHS as the keycode for the second.
  77  *
  78  * ,---.   ,---------------. ,---------------. ,---------------. ,-----------.
  79  * |Esc|   |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Pau|
  80  * `---'   `---------------' `---------------' `---------------' `-----------'
  81  * ,-----------------------------------------------------------. ,-----------.
  82  * |~  |  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp | |Ins|Hom|PgU|
  83  * |-----------------------------------------------------------| |-----------|
  84  * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \| |Del|End|PgD|
  85  * |-----------------------------------------------------------| `-----------'
  86  * |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
  87  * |-----------------------------------------------------------|     ,---.
  88  * |Shft|ISO|  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |     |Up |
  89  * |-----------------------------------------------------------| ,-----------.
  90  * |Ctl|Gui|Alt|          Space                |Alt|Gui|App|Ctl| |Lef|Dow|Rig|
  91  * `-----------------------------------------------------------' `-----------'
  92  */
  93
  94
  95 static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  96 /* Layer 0: Default Layer
  97  *
  98  * ANSI:
  99  *
 100  * ,---.   ,---------------. ,---------------. ,---------------. ,-----------.
 101  * |Esc|   |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Pau|
 102  * `---'   `---------------' `---------------' `---------------' `-----------'
 103  * ,-----------------------------------------------------------. ,-----------.
 104  * |~  |  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp | |Ins|Hom|PgU|
 105  * |-----------------------------------------------------------| |-----------|
 106  * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \| |Del|End|PgD|
 107  * |-----------------------------------------------------------| `-----------'
 108  * |FN1   |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
 109  * |-----------------------------------------------------------|     ,---.
 110  * |Shft|iso|  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift     |     |Up |
 111  * |-----------------------------------------------------------| ,-----------.
 112  * |Ctl|Gui|Alt|          Space                |Alt|Gui|App|Ctl| |Lef|Dow|Rig|
 113  * `-----------------------------------------------------------' `-----------'
 114  */
 115
 116   KEYMAP(\
 117     ESC,  F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9, F10,  F11,  F12,       PSCR, SLCK,  BRK, \
 118     GRV,   1,   2,   3,   4,   5,   6,   7,   8,   9,   0, MINS,  EQL, BSPC,  INS, HOME, PGUP, \
 119     TAB,   Q,   W,   E,   R,   T,   Y,   U,   I,   O,   P, LBRC, RBRC, BSLS,  DEL,  END, PGDN, \
 120     FN1,   A,   S,   D,   F,   G,   H,   J,   K,   L, SCLN, QUOT,       ENT,                   \
 121     LSFT, NUBS, Z,   X,   C,   V,   B,   N,   M, COMM, DOT, SLSH,      RSFT,         UP,       \
 122     LCTL, LGUI, LALT,             SPC,                RALT, RGUI, APP, RCTL, LEFT, DOWN, RGHT),
 123
 124 /*  EXAMPLE ISO keymap, see the NUBS and NUHS keycodes
 125  *  KEYMAP(\
 126  *    ESC, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, PSCR, SLCK, BRK, \
 127  *    GRV, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, MINS, EQL, BSPC, INS, HOME, PGUP, \
 128  *    TAB, Q, W, E, R, T, Y, U, I, O, P, LBRC, RBRC, NUHS, DEL, END, PGDN, \
 129  *    CAPS, A, S, D, F, G, H, J, K, L, SCLN, QUOT, ENT, \
 130  *    LSFT, NUBS, Z, X, C, V, B, N, M, COMM, DOT, SLSH, RSFT, UP, \
 131  *    LCTL, FN1, LALT, SPC, RALT, RGUI, APP, RCTL, LEFT, DOWN, RGHT),
 132  */
 133
 134
 135 /*
 136  * ,---.   ,---------------. ,---------------. ,---------------. ,-----------.
 137  * |Esc|   |F1 |F2 |F3 |F4 | |F5 |F6 |F7 |F8 | |F9 |F10|F11|F12| |PrS|ScL|Slp|
 138  * `---'   `---------------' `---------------' `---------------' `-----------'
 139  * ,-----------------------------------------------------------. ,-----------.
 140  * |~  |  1|  2|  3|  4|  5|  6|  7|  8|  9|Mut|V- |V+ |Backsp | |Ins|Hom|PgU|
 141  * |-----------------------------------------------------------| |-----------|
 142  * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|MSt|Ply|Prv|Nxt|Media| |Del|End|PgD|
 143  * |-----------------------------------------------------------| `-----------'
 144  * |FN1   |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
 145  * |-----------------------------------------------------------|     ,---.
 146  * |Shft|iso|  Z|  X|Clc|  V|  B|  N|  M|  ,|  .|  /|Caps      |     |Up |
 147  * |-----------------------------------------------------------| ,-----------.
 148  * |Ctl|Gui|Alt|          Space                |Alt|Gui|App|Ctl| |Lef|Dow|Rig|
 149  * `-----------------------------------------------------------' `-----------'
 150  */
 151
 152  KEYMAP(\
 153     ESC,  F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9, F10,  F11,  F12,       PSCR, SLCK, SLEP, \
 154     GRV,   1,   2,   3,   4,   5,   6,   7,   8,   9,MUTE, VOLD, VOLU, BSPC,  INS, HOME, PGUP, \
 155     TAB,   Q,   W,   E,   R,   T,   Y,   U,   I,MSTP,MPLY, MPRV, MNXT, MSEL,  DEL,  END, PGDN, \
 156     FN1,   A,   S,   D,   F,   G,   H,   J,   K,   L, SCLN, QUOT,       ENT,                   \
 157     LSFT, NUBS, Z,   X,CALC,   V,   B,   N,   M, COMM, DOT, SLSH,      CAPS,         UP,       \
 158     LCTL, LGUI, LALT,             SPC,                RALT, RGUI, APP, RCTL, LEFT, DOWN, RGHT),
 159
 160
 161 };
 162
 163 static const uint8_t PROGMEM overlays[][MATRIX_ROWS][MATRIX_COLS] = {};
 164
 165 /*
 166  * Fn action definition
 167  */
 168 static const uint16_t PROGMEM fn_actions[] = {
 169     [0] = ACTION_DEFAULT_LAYER_SET(0),
 170     [1] = ACTION_DEFAULT_LAYER_SET(1),
 171     [2] = ACTION_DEFAULT_LAYER_SET(2),
 172     [3] = ACTION_DEFAULT_LAYER_SET(3),
 173     [4] = ACTION_DEFAULT_LAYER_SET(4),
 174     [5] = ACTION_DEFAULT_LAYER_SET(5),
 175     [6] = ACTION_DEFAULT_LAYER_SET(6),
 176     [7] = ACTION_DEFAULT_LAYER_SET(7),
 177     [8] = ACTION_DEFAULT_LAYER_SET(8),
 178 };
 179 #endif
 180
 181 #define KEYMAPS_SIZE    (sizeof(keymaps) / sizeof(keymaps[0]))
 182 #define OVERLAYS_SIZE   (sizeof(overlays) / sizeof(overlays[0]))
 183 #define FN_ACTIONS_SIZE (sizeof(fn_actions) / sizeof(fn_actions[0]))
 184
 185 /* translates key to keycode */
 186 uint8_t keymap_key_to_keycode(uint8_t layer, key_t key)
 187 {
 188     /* Overlay: 16-31(OVERLAY_BIT(0x10) | overlay_layer) */
 189     if (layer & OVERLAY_BIT) {
 190         layer &= OVERLAY_MASK;
 191         if (layer < OVERLAYS_SIZE) {
 192             return pgm_read_byte(&overlays[(layer)][(key.row)][(key.col)]);
 193         } else {
 194             // XXX: this may cuaes bootlaoder_jump incositent fail.
 195             //debug("key_to_keycode: overlay "); debug_dec(layer); debug(" is invalid.\n");
 196             return KC_TRANSPARENT;
 197         }
 198     }
 199     /* Keymap: 0-15 */
 200     else {
 201         if (layer < KEYMAPS_SIZE) {
 202             return pgm_read_byte(&keymaps[(layer)][(key.row)][(key.col)]);
 203         } else {
 204             // XXX: this may cuaes bootlaoder_jump incositent fail.
 205             //debug("key_to_keycode: base "); debug_dec(layer); debug(" is invalid.\n");
 206             // fall back to layer 0
 207             return pgm_read_byte(&keymaps[0][(key.row)][(key.col)]);
 208         }
 209     }
 210 }
 211
 212 /* translates Fn keycode to action */
 213 action_t keymap_fn_to_action(uint8_t keycode)
 214 {
 215     action_t action;
 216     if (FN_INDEX(keycode) < FN_ACTIONS_SIZE) {
 217         action.code = pgm_read_word(&fn_actions[FN_INDEX(keycode)]);
 218     } else {
 219         action.code = ACTION_NO;
 220     }
 221     return action;
 222 }