keyboard/gh60/keymap.c

   1 /*
   2 Copyright 2012,2013 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 #include <stdint.h>
  18 #include <stdbool.h>
  19 #include <avr/pgmspace.h>
  20 #include "keycode.h"
  21 #include "action.h"
  22 #include "action_macro.h"
  23 #include "layer_switch.h"
  24 #include "report.h"
  25 #include "host.h"
  26 #include "print.h"
  27 #include "debug.h"
  28 #include "keymap.h"
  29
  30
  31 /* GH60 keymap definition macro
  32  * K2C, K31 and  K3C are extra keys for ISO
  33  */
  34 #define KEYMAP( \
  35     K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D, \
  36     K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D, \
  37     K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, K2D, \
  38     K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3C, K3D, \
  39     K40, K41, K42,           K45,                     K4A, K4B, K4C, K4D  \
  40 ) { \
  41     { KC_##K00, KC_##K01, KC_##K02, KC_##K03, KC_##K04, KC_##K05, KC_##K06, KC_##K07, KC_##K08, KC_##K09, KC_##K0A, KC_##K0B, KC_##K0C, KC_##K0D }, \
  42     { KC_##K10, KC_##K11, KC_##K12, KC_##K13, KC_##K14, KC_##K15, KC_##K16, KC_##K17, KC_##K18, KC_##K19, KC_##K1A, KC_##K1B, KC_##K1C, KC_##K1D }, \
  43     { KC_##K20, KC_##K21, KC_##K22, KC_##K23, KC_##K24, KC_##K25, KC_##K26, KC_##K27, KC_##K28, KC_##K29, KC_##K2A, KC_##K2B, KC_##K2C, KC_##K2D }, \
  44     { KC_##K30, KC_##K31, KC_##K32, KC_##K33, KC_##K34, KC_##K35, KC_##K36, KC_##K37, KC_##K38, KC_##K39, KC_##K3A, KC_##K3B, KC_##K3C, KC_##K3D }, \
  45     { KC_##K40, KC_##K41, KC_##K42, KC_NO,    KC_NO,    KC_##K45, KC_NO,    KC_NO,    KC_NO,    KC_NO,    KC_##K4A, KC_##K4B, KC_##K4C, KC_##K4D }  \
  46 }
  47
  48 /* ANSI valiant. No extra keys for ISO */
  49 #define KEYMAP_ANSI( \
  50     K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D, \
  51     K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D, \
  52     K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B,      K2D, \
  53     K30, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B,           K3D, \
  54     K40, K41, K42,           K45,                     K4A, K4B, K4C, K4D  \
  55 ) KEYMAP( \
  56     K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D, \
  57     K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D, \
  58     K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, NO,  K2D, \
  59     K30, NO,  K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, NO,  K3D, \
  60     K40, K41, K42,           K45,                     K4A, K4B, K4C, K4D  \
  61 )
  62
  63
  64 #if defined(KEYMAP_PLAIN)
  65     #include "keymap_plain.h"
  66 #elif defined(KEYMAP_POKER)
  67     #include "keymap_poker.h"
  68 #elif defined(KEYMAP_POKER_SET)
  69     #include "keymap_poker_set.h"
  70 #elif defined(KEYMAP_POKER_BIT)
  71     #include "keymap_poker_bit.h"
  72 #else
  73 static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  74     /*
  75      * Funky
  76      */
  77     /* Keymap 0: Default Layer
  78      * ,-----------------------------------------------------------.
  79      * |Esc|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |
  80      * |-----------------------------------------------------------|
  81      * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|    \|
  82      * |-----------------------------------------------------------|
  83      * |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|Fn3|  '|Return  |
  84      * |-----------------------------------------------------------|
  85      * |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|Fn2|Shift     |
  86      * |-----------------------------------------------------------|
  87      * |Ctrl|Gui |Alt |      Space             |Alt |Fn4 |Fn4 |Fn1 |
  88      * `-----------------------------------------------------------'
  89      */
  90     KEYMAP_ANSI(
  91         ESC, 1,   2,   3,   4,   5,   6,   7,   8,   9,   0,   MINS,EQL, BSPC, \
  92         TAB, Q,   W,   E,   R,   T,   Y,   U,   I,   O,   P,   LBRC,RBRC,BSLS, \
  93         LCTL,A,   S,   D,   F,   G,   H,   J,   K,   L,   FN2, QUOT,     ENT,  \
  94         LSFT,Z,   X,   C,   V,   B,   N,   M,   COMM,DOT, FN1,           RSFT, \
  95         LCTL,LGUI,LALT,          SPC,                     RALT,FN3, FN3, FN0),
  96     /* Keymap 1: colemak */
  97     KEYMAP_ANSI(
  98         GRV, 1,   2,   3,   4,   5,   6,   7,   8,   9,   0,   MINS,EQL, BSPC, \
  99         TAB, Q,   W,   F,   P,   G,   J,   L,   U,   Y,   SCLN,LBRC,RBRC,BSLS, \
 100         BSPC,A,   R,   S,   T,   D,   H,   N,   E,   I,   O,   QUOT,     ENT,  \
 101         LSFT,Z,   X,   C,   V,   B,   K,   M,   COMM,DOT, SLSH,          RSFT, \
 102         LCTL,LGUI,LALT,          SPC,                     RALT,RGUI,APP, FN0),
 103     /* Keymap 2: dvorak */
 104     KEYMAP_ANSI(
 105         GRV, 1,   2,   3,   4,   5,   6,   7,   8,   9,   0,   LBRC,RBRC,BSPC, \
 106         TAB, QUOT,COMM,DOT, P,   Y,   F,   G,   C,   R,   L,   SLSH,EQL, BSLS, \
 107         CAPS,A,   O,   E,   U,   I,   D,   H,   T,   N,   S,   MINS,     ENT,  \
 108         LSFT,SCLN,Q,   J,   K,   X,   B,   M,   W,   V,   Z,             RSFT, \
 109         LCTL,LGUI,LALT,          SPC,                     RALT,RGUI,APP, FN0),
 110     /* Keymap: workman */
 111     KEYMAP_ANSI(
 112         GRV, 1,   2,   3,   4,   5,   6,   7,   8,   9,   0,   MINS,EQL, BSPC, \
 113         TAB, Q,   D,   R,   W,   B,   J,   F,   U,   P,   SCLN,LBRC,RBRC,BSLS, \
 114         BSPC,A,   S,   H,   T,   G,   Y,   N,   E,   O,   I,   QUOT,     ENT,  \
 115         LSFT,Z,   X,   M,   C,   V,   K,   L,   COMM,DOT, SLSH,          RSFT, \
 116         LCTL,LGUI,LALT,          SPC,                     RALT,RGUI,APP, FN0),
 117 };
 118
 119 static const uint8_t PROGMEM overlays[][MATRIX_ROWS][MATRIX_COLS] = {
 120     /*
 121      * Funky
 122      */
 123     /* Overlay 0: HHKB mode
 124      * ,-----------------------------------------------------------.
 125      * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delete |
 126      * |-----------------------------------------------------------|
 127      * |Caps |   |   |   |   |   |   |   |Psc|Slk|Pus|Up |   |Inser|
 128      * |-----------------------------------------------------------|
 129      * |Contro|VoD|VoU|Mut|   |   |  *|  /|Hom|PgU|Lef|Rig|Enter   |
 130      * |-----------------------------------------------------------|
 131      * |Shift   |   |   |   |   |   |  +|  -|End|PgD|Dow|Shift     |
 132      * |-----------------------------------------------------------|
 133      * |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |    |
 134      * `-----------------------------------------------------------'
 135      */
 136     KEYMAP_ANSI(
 137         PWR, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12, DEL,  \
 138         CAPS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,TRNS,PSCR,SLCK,PAUS,UP,  TRNS,INS,  \
 139         LCTL,VOLD,VOLU,MUTE,TRNS,TRNS,PAST,PSLS,HOME,PGUP,LEFT,RGHT,     ENT,  \
 140         LSFT,TRNS,TRNS,TRNS,TRNS,TRNS,PPLS,PMNS,END, PGDN,DOWN,          RSFT, \
 141         LCTL,LGUI,LALT,          SPC,                     RALT,RGUI,APP, TRNS),
 142     /* Overlay 1: Vi mode (Slash)
 143      * ,-----------------------------------------------------------.
 144      * |  `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
 145      * |-----------------------------------------------------------|
 146      * |Tab  |Hom|PgD|Up |PgU|End|Hom|PgD|PgU|End|   |   |   |     |
 147      * |-----------------------------------------------------------|
 148      * |Contro|   |Lef|Dow|Rig|   |Lef|Dow|Up |Rig|   |   |Return  |
 149      * |-----------------------------------------------------------|
 150      * |Shift   |   |   |   |   |   |Hom|PgD|PgU|End|   |Shift     |
 151      * |-----------------------------------------------------------|
 152      * |Ctrl|Gui |Alt |      Space             |Alt |Gui |App |Ctrl|
 153      * `-----------------------------------------------------------'
 154      */
 155     KEYMAP_ANSI(
 156         GRV, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12, BSPC, \
 157         TAB, HOME,PGDN,UP,  PGUP,END, HOME,PGDN,PGUP,END, TRNS,TRNS,TRNS,TRNS, \
 158         LCTL,TRNS,LEFT,DOWN,RGHT,TRNS,LEFT,DOWN,UP,  RGHT,TRNS,TRNS,     ENT,  \
 159         LSFT,TRNS,TRNS,TRNS,TRNS,TRNS,HOME,PGDN,PGUP,END, TRNS,          RSFT, \
 160         LCTL,LGUI,LALT,          SPC,                     RALT,RGUI,APP, RCTL),
 161     /* Overlay 2: Mouse mode (Semicolon/App)
 162      * ,-----------------------------------------------------------.
 163      * |  `| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Backsp |
 164      * |-----------------------------------------------------------|
 165      * |Tab  |   |   |   |   |   |MwL|MwD|MwU|MwR|   |   |   |     |
 166      * |-----------------------------------------------------------|
 167      * |Contro|   |Ac0|Ac1|Ac1|   |McL|McD|McU|McR|   |   |Return  |
 168      * |-----------------------------------------------------------|
 169      * |Shift   |   |   |   |   |Mb3|Mb2|Mb1|Mb4|Mb5|   |Shift     |
 170      * |-----------------------------------------------------------|
 171      * |Ctrl|Gui |Alt |      Space             |    |    |    |    |
 172      * `-----------------------------------------------------------'
 173      * Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel
 174      */
 175     KEYMAP_ANSI(
 176         GRV, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12, BSPC, \
 177         TAB, TRNS,TRNS,TRNS,TRNS,TRNS,WH_L,WH_D,WH_U,WH_R,TRNS,TRNS,TRNS,TRNS, \
 178         LCTL,TRNS,ACL0,ACL1,ACL2,TRNS,MS_L,MS_D,MS_U,MS_R,TRNS,TRNS,     ENT,  \
 179         LSFT,TRNS,TRNS,TRNS,TRNS,BTN3,BTN2,BTN1,BTN4,BTN5,TRNS,          RSFT, \
 180         LCTL,LGUI,LALT,          BTN1,                    TRNS,TRNS,TRNS,RCTL),
 181 };
 182
 183 /*
 184  * Fn action definition
 185  */
 186 static const uint16_t PROGMEM fn_actions[] = {
 187     ACTION_OVERLAY_TAP_TOGGLE(0),                 // FN0
 188     ACTION_OVERLAY_TAP_KEY(1, KC_SLASH),          // FN1
 189     ACTION_OVERLAY_TAP_KEY(2, KC_SCLN),           // FN2
 190     ACTION_OVERLAY(2),                            // FN3
 191 };
 192 #endif
 193
 194
 195
 196 #define KEYMAPS_SIZE    (sizeof(keymaps) / sizeof(keymaps[0]))
 197 #define OVERLAYS_SIZE   (sizeof(overlays) / sizeof(overlays[0]))
 198 #define FN_ACTIONS_SIZE (sizeof(fn_actions) / sizeof(fn_actions[0]))
 199
 200 /* translates key to keycode */
 201 uint8_t keymap_key_to_keycode(uint8_t layer, key_t key)
 202 {
 203     /* Overlay: 16-31(OVERLAY_BIT(0x10) | overlay_layer) */
 204     if (layer & OVERLAY_BIT) {
 205         layer &= OVERLAY_MASK;
 206         if (layer < OVERLAYS_SIZE) {
 207             return pgm_read_byte(&overlays[(layer)][(key.row)][(key.col)]);
 208         } else {
 209             debug("key_to_keycode: overlay "); debug_dec(layer); debug(" is invalid.\n");
 210             return KC_TRANSPARENT;
 211         }
 212     }
 213     /* Keymap: 0-15 */
 214     else {
 215         if (layer < KEYMAPS_SIZE) {
 216             return pgm_read_byte(&keymaps[(layer)][(key.row)][(key.col)]);
 217         } else {
 218             // fall back to layer 0
 219             debug("key_to_keycode: base "); debug_dec(layer); debug(" is invalid.\n");
 220             return pgm_read_byte(&keymaps[0][(key.row)][(key.col)]);
 221         }
 222     }
 223 }
 224
 225 /* translates Fn keycode to action */
 226 action_t keymap_fn_to_action(uint8_t keycode)
 227 {
 228     action_t action;
 229     if (FN_INDEX(keycode) < FN_ACTIONS_SIZE) {
 230         action.code = pgm_read_word(&fn_actions[FN_INDEX(keycode)]);
 231     } else {
 232         action.code = ACTION_NO;
 233     }
 234     return action;
 235 }