converter/m0110_usb/keymap.c

   1 /*
   2 Copyright 2011,2012 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 /* M0110A Support was contributed by skagon@github */
  18
  19 #include <stdint.h>
  20 #include <stdbool.h>
  21 #include <avr/pgmspace.h>
  22 #include "usb_keyboard.h"
  23 #include "keycode.h"
  24 #include "print.h"
  25 #include "debug.h"
  26 #include "util.h"
  27 #include "keymap.h"
  28
  29
  30 #define KEYCODE(layer, row, col) (pgm_read_byte(&keymaps[(layer)][(row)][(col)]))
  31
  32 #define KEYMAP( \
  33     K32,K12,K13,K14,K15,K17,K16,K1A,K1C,K19,K1D,K1B,K18,K33,  K47,K68,K6D,K62, \
  34     K30,K0C,K0D,K0E,K0F,K11,K10,K20,K22,K1F,K23,K21,K1E,      K59,K5B,K5C,K4E, \
  35     K39,K00,K01,K02,K03,K05,K04,K26,K28,K25,K29,K27,    K24,  K56,K57,K58,K66, \
  36     K38,K06,K07,K08,K09,K0B,K2D,K2E,K2B,K2F,K2C,        K4D,  K53,K54,K55,K4C, \
  37     K3A,K37,            K31,            K34,K2A,K46,K42,K48,  K52,    K41      \
  38 ) { \
  39     { KC_##K00, KC_##K01, KC_##K02, KC_##K03, KC_##K04, KC_##K05, KC_##K06, KC_##K07 }, \
  40     { KC_##K08, KC_##K09, KC_NO,    KC_##K0B, KC_##K0C, KC_##K0D, KC_##K0E, KC_##K0F }, \
  41     { KC_##K10, KC_##K11, KC_##K12, KC_##K13, KC_##K14, KC_##K15, KC_##K16, KC_##K17 }, \
  42     { KC_##K18, KC_##K19, KC_##K1A, KC_##K1B, KC_##K1C, KC_##K1D, KC_##K1E, KC_##K1F }, \
  43     { KC_##K20, KC_##K21, KC_##K22, KC_##K23, KC_##K24, KC_##K25, KC_##K26, KC_##K27 }, \
  44     { KC_##K28, KC_##K29, KC_##K2A, KC_##K2B, KC_##K2C, KC_##K2D, KC_##K2E, KC_##K2F }, \
  45     { KC_##K30, KC_##K31, KC_##K32, KC_##K33, KC_##K34, KC_NO,    KC_NO,    KC_##K37 }, \
  46     { KC_##K38, KC_##K39, KC_##K3A, KC_NO,    KC_NO,    KC_NO,    KC_NO,    KC_NO    }, \
  47     { KC_NO,    KC_##K41, KC_##K42, KC_NO,    KC_NO,    KC_NO,    KC_##K46, KC_##K47 }, \
  48     { KC_##K48, KC_NO,    KC_NO,    KC_NO,    KC_##K4C, KC_##K4D, KC_##K4E, KC_NO    }, \
  49     { KC_NO,    KC_NO,    KC_##K52, KC_##K53, KC_##K54, KC_##K55, KC_##K56, KC_##K57 }, \
  50     { KC_##K58, KC_##K59, KC_NO,    KC_##K5B, KC_##K5C, KC_NO,    KC_NO,    KC_NO    }, \
  51     { KC_NO,    KC_NO,    KC_##K62, KC_NO,    KC_NO,    KC_NO,    KC_##K66, KC_NO    }, \
  52     { KC_##K68, KC_NO,    KC_NO,    KC_NO,    KC_NO,    KC_##K6D, KC_NO,    KC_NO    }, \
  53 }
  54
  55
  56 // Assign Fn key(0-7) to a layer to which switch with the Fn key pressed.
  57 static const uint8_t PROGMEM fn_layer[] = {
  58 #ifndef HASU
  59     1,              // Fn0
  60     0,              // Fn1
  61     0,              // Fn2
  62     0,              // Fn3
  63     0,              // Fn4
  64     0,              // Fn5
  65     0,              // Fn6
  66     0               // Fn7
  67 #else
  68     1,              // Fn0
  69     2,              // Fn1
  70     3,              // Fn2
  71     1,              // Fn3
  72     2,              // Fn4
  73     0,              // Fn5
  74     0,              // Fn6
  75     0               // Fn7
  76 #endif
  77 };
  78
  79 // Assign Fn key(0-7) to a keycode sent when release Fn key without use of the layer.
  80 // See layer.c for details.
  81 static const uint8_t PROGMEM fn_keycode[] = {
  82 #ifndef HASU
  83     KC_NO,          // Fn0
  84     KC_NO,          // Fn1
  85     KC_NO,          // Fn2
  86     KC_NO,          // Fn3
  87     KC_NO,          // Fn4
  88     KC_NO,          // Fn5
  89     KC_NO,          // Fn6
  90     KC_NO           // Fn7
  91 #else
  92     KC_ENTER,       // Fn0
  93     KC_SCOLON,      // Fn1
  94     KC_SLASH,       // Fn2
  95     KC_UP,          // Fn3
  96     KC_NO,          // Fn4
  97     KC_NO,          // Fn5
  98     KC_NO,          // Fn6
  99     KC_NO           // Fn7
 100 #endif
 101 };
 102
 103 static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 104     /*
 105      * The keymap works with both M0110 and M0110A keyboards. As you can see, the M0110A is a superset
 106      * of the M0110 keyboard, with only one exception: 'Enter' in M0110 does not exist
 107      * on the M0110A, but since it generates a unique scan code which is not used for some other key in
 108      * the M0110A, they are totally interchangeable.  In fact, the M0110A is functionally (almost)
 109      * identical to the combination of the M0110 along with the M0120 keypad. The only difference
 110      * (which is causing some problems as you will read below) is that the M0110+M0120 don't have
 111      * dedicated arrow keys, while the M0110A does. However, the M0120 did have arrow keys, which
 112      * doubled as the [comma], [/], [*] and [+] keys, when used with the [Shift] key. The M0110A has
 113      * substituted the [comma] key with the [=] key, however its scancode is the same.
 114      *
 115      * Default:
 116      * ,---------------------------------------------------------. ,---------------.
 117      * |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backs| |Gui|  =|  /|  *|
 118      * |---------------------------------------------------------| |---------------|
 119      * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|   | |  7|  8|  9|  -|
 120      * |-----------------------------------------------------'   | |---------------|
 121      * |Fn0   |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return| |  4|  5|  6|  +|
 122      * |---------------------------------------------------------| |---------------|
 123      * |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  ,|  /|Shft|Up | |  1|  2|  3|   |
 124      * |---------------------------------------------------------| |-----------|Ent|
 125      * |Ctrl |Alt    |         Space         |Gui|  \|Lft|Rgt|Dn | |      0|  .|   |
 126      * `---------------------------------------------------------' `---------------'
 127      *
 128      * HHKB/WASD/Mouse Layer(Fn0):
 129      * ,---------------------------------------------------------. ,---------------.
 130      * |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Delet| |Nlk|Mb1|Mb3|Mb2|
 131      * |---------------------------------------------------------| |---------------|
 132      * |Caps |Hom| Up|PgU|   |   |   |   |Psc|Slk|Pau|Up |Ins|   | |MwD|McU|MwU|MwU|
 133      * |-----------------------------------------------------'   | |---------------|
 134      * |Fn0   |Lef|Dow|Rig|   |   |   |   |Hom|PgU|Lef|Rig|Return| |McL|McD|McR|MwD|
 135      * |---------------------------------------------------------| |---------------|
 136      * |Shift   |End|   |PgD|   |VoD|VoU|Mut|End|PgD|Dow|Shif|Up | |MwL|McD|MwR|   |
 137      * |---------------------------------------------------------| |-----------|Mb2|
 138      * |Ctrl |Alt    |         Space        |Gui |  \|Lft|Rgt|Dn | |    Mb1|Mb3|   |
 139      * `---------------------------------------------------------' `---------------'
 140      * Mb: Mouse Button / Mc: Mouse Cursor / Mw: Mouse Wheel
 141      *
 142      * NOTE: M0110 has no arrow and keypad keys.
 143      * NOTE: \ is located next to ] on M0110.
 144      * NOTE: Gui between Space and \ is Enter on M0110 not exists on M0110A.
 145      * NOTE: LShift and RShift are logically same key. (M0110, M0110A)
 146      * NOTE: LOption and ROption are logically same key. (M0110)
 147      */
 148 #ifndef HASU
 149     KEYMAP(
 150     GRV, 1,   2,   3,   4,   5,   6,   7,   8,   9,   0,   MINS,EQL, BSPC,    LGUI,EQL, PSLS,PAST,
 151     TAB, Q,   W,   E,   R,   T,   Y,   U,   I,   O,   P,   LBRC,RBRC,         P7,  P8,  P9,  PMNS,
 152     FN0, A,   S,   D,   F,   G,   H,   J,   K,   L,   SCLN,QUOT,     ENT,     P4,  P5,  P6,  PPLS,
 153     LSFT,Z,   X,   C,   V,   B,   N,   M,   COMM,DOT, SLSH,          UP,      P1,  P2,  P3,  PENT,
 154     LCTL,LALT,               SPC,                LGUI,BSLS,LEFT,RGHT,DOWN,    P0,       PDOT
 155     ),
 156     // HHKB & WASD
 157     KEYMAP(
 158     ESC, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12, DEL,     NLCK,BTN1,BTN3,BTN2,
 159     CAPS,HOME,UP,  PGUP,NO,  NO,  NO,  NO,  PSCR,SLCK,PAUS,UP,  NO,           WH_D,MS_U,WH_U,WH_U,
 160     FN0, LEFT,DOWN,RGHT,NO,  NO,  NO,  NO,  HOME,PGUP,LEFT,RGHT,     ENT,     MS_L,MS_D,MS_R,WH_D,
 161     LSFT,END, NO,  PGDN,NO,  VOLD,VOLU,MUTE,END, PGDN,DOWN,          UP,      WH_L,MS_D,WH_R,BTN2,
 162     LCTL,LALT,               SPC,                LGUI,INS, LEFT,RGHT,DOWN,    BTN1,     BTN3
 163     ),
 164 #else
 165     // hasu's keymap(To enable this use 'make hasu' to add option flag: EXTRAFLAGS=-DHASU)
 166     KEYMAP(
 167     ESC, 1,   2,   3,   4,   5,   6,   7,   8,   9,   0,   MINS,EQL, BSPC,    LGUI,EQL, PSLS,PAST,
 168     TAB, Q,   W,   E,   R,   T,   Y,   U,   I,   O,   P,   LBRC,RBRC,         P7,  P8,  P9,  PMNS,
 169     LCTL,A,   S,   D,   F,   G,   H,   J,   K,   L,   FN1, QUOT,     FN0,     P4,  P5,  P6,  PPLS,
 170     LSFT,Z,   X,   C,   V,   B,   N,   M,   COMM,DOT, FN2,           FN3,     P1,  P2,  P3,  PENT,
 171     FN4, LALT,               SPC,                LGUI,BSLS,LEFT,RGHT,DOWN,    LGUI,     PDOT
 172     ),
 173     // HHKB & WASD
 174     KEYMAP(
 175     GRV, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12, DEL,     NLCK,EQL, PSLS,PAST,
 176     CAPS,HOME,UP,  PGUP,NO,  NO,  NO,  NO,  PSCR,SLCK,PAUS,UP,  NO,           P7,  P8,  P9,  PMNS,
 177     LCTL,LEFT,DOWN,RGHT,NO,  NO,  NO,  NO,  HOME,PGUP,LEFT,RGHT,     FN0,     P4,  P5,  P6,  PPLS,
 178     LSFT,END, NO,  PGDN,NO,  VOLD,VOLU,MUTE,END, PGDN,DOWN,          FN3,     P1,  P2,  P3,  PENT,
 179     LCTL,LALT,               SPC,                LGUI,INS, LEFT,RGHT,DOWN,    P0,       PDOT
 180     ),
 181     // vi mousekeys
 182     KEYMAP(
 183     GRV, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12, DEL,     NLCK,EQL, PSLS,PAST,
 184     CAPS,NO,  NO,  NO,  NO,  NO,  WH_L,WH_D,WH_U,WH_R,NO,  NO,  NO,           P7,  P8,  P9,  PMNS,
 185     NO,  VOLD,VOLU,MUTE,NO,  NO,  MS_L,MS_D,MS_U,MS_R,FN1, NO,       ENT,     P4,  P5,  P6,  PPLS,
 186     LSFT,NO,  NO,  NO,  NO,  BTN3,BTN2,BTN1,NO,  NO,  NO,            UP,      P1,  P2,  P3,  PENT,
 187     FN4, LALT,               BTN1,               LGUI,NO,  LEFT,RGHT,DOWN,    P0,       PDOT
 188     ),
 189     // vi cusorkeys
 190     KEYMAP(
 191     GRV, F1,  F2,  F3,  F4,  F5,  F6,  F7,  F8,  F9,  F10, F11, F12, DEL,     NLCK,EQL, PSLS,PAST,
 192     CAPS,NO,  NO,  NO,  NO,  NO,  HOME,PGDN,PGUP,END, PSCR,SLCK,PAUS,         P7,  P8,  P9,  PMNS,
 193     NO,  NO,  NO,  NO,  NO,  NO,  LEFT,DOWN,UP,  RGHT,NO,  NO,       ENT,     P4,  P5,  P6,  PPLS,
 194     LSFT,NO,  NO,  NO,  NO,  NO,  HOME,PGDN,PGUP,END, FN2,           UP,      P1,  P2,  P3,  PENT,
 195     LCTL,LALT,               SPC,                LGUI,INS, LEFT,RGHT,DOWN,    P0,       PDOT
 196     ),
 197 #endif
 198 };
 199
 200
 201 uint8_t keymap_get_keycode(uint8_t layer, uint8_t row, uint8_t col)
 202 {
 203     return KEYCODE(layer, row, col);
 204 }
 205
 206 uint8_t keymap_fn_layer(uint8_t fn_bits)
 207 {
 208     return pgm_read_byte(&fn_layer[biton(fn_bits)]);
 209 }
 210
 211 uint8_t keymap_fn_keycode(uint8_t fn_bits)
 212 {
 213     return pgm_read_byte(&fn_keycode[(biton(fn_bits))]);
 214 }