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