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