converter/m0110_usb/keymap_common.h

   1 /*
   2 Copyright 2011,2012,2014 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 <avr/pgmspace.h>
  19 #include "keycode.h"
  20 #include "keymap.h"
  21
  22
  23 extern const uint8_t keymaps[][MATRIX_ROWS][MATRIX_COLS];
  24 extern const uint16_t fn_actions[];
  25
  26
  27 /*
  28  * The keymap works with both M0110 and M0110A keyboards. As you can see, the M0110A is a superset
  29  * of the M0110 keyboard, with only one exception: 'Enter' in M0110 does not exist
  30  * on the M0110A, but since it generates a unique scan code which is not used for some other key in
  31  * the M0110A, they are totally interchangeable.  In fact, the M0110A is functionally (almost)
  32  * identical to the combination of the M0110 along with the M0120 keypad. The only difference
  33  * (which is causing some problems as you will read below) is that the M0110+M0120 don't have
  34  * dedicated arrow keys, while the M0110A does. However, the M0120 did have arrow keys, which
  35  * doubled as the [comma], [/], [*] and [+] keys, when used with the [Shift] key. The M0110A has
  36  * substituted the [comma] key with the [=] key, however its scancode is the same.
  37  *
  38  * Physical layout:
  39  * M0110A
  40  * ,---------------------------------------------------------. ,---------------.
  41  * |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Bcksp| |Clr|  =|  /|  *|
  42  * |---------------------------------------------------------| |---------------|
  43  * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|   | |  7|  8|  9|  -|
  44  * |-----------------------------------------------------'   | |---------------|
  45  * |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return| |  4|  5|  6|  +|
  46  * |---------------------------------------------------------| |---------------|
  47  * |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  ,|  /|Shft|Up | |  1|  2|  3|   |
  48  * |---------------------------------------------------------' |-----------|Ent|
  49  * |Opt  |Mac    |           Space           |  \|Lft|Rgt|Dn | |      0|  .|   |
  50  * `---------------------------------------------------------' `---------------'
  51  *
  52  * M0110                                                       M0120
  53  * ,---------------------------------------------------------. ,---------------.
  54  * |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backs| |Clr|  -|  +|  *|
  55  * |---------------------------------------------------------| |---------------|
  56  * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|  \| |  7|  8|  9|  /|
  57  * |---------------------------------------------------------| |---------------|
  58  * |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return| |  4|  5|  6|  ,|
  59  * |---------------------------------------------------------| |---------------|
  60  * |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  ,|  /|Shift   | |  1|  2|  3|   |
  61  * `---------------------------------------------------------' |-----------|Ent|
  62  *      |Opt|Mac |         Space               |Ent |Opt|      |      0|  .|   |
  63  *      `-----------------------------------------------'      `---------------'
  64  * With Shift keys on M0120 work as curosor.(-:Left *:Right /:Up ,:Down)
  65  *
  66  * NOTE: \ is located differently.
  67  * NOTE: Enter on M0110 is different from Enter on keypad(M0120 and M0110A).
  68  * NOTE: Left Shift and right Shift are logically same key.
  69  * NOTE: Left Option and right Option are logically same key.
  70  */
  71
  72 /* Keymap definition Macro
  73  * ,---------------------------------------------------------. ,---------------.
  74  * |  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backs| |Clr|  =|  /|  *|
  75  * |---------------------------------------------------------| |---------------|
  76  * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|   | |  7|  8|  9|  -|
  77  * |-----------------------------------------------------'   | |---------------|
  78  * |Caps  |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return| |  4|  5|  6|  +|
  79  * |---------------------------------------------------------| |---------------|
  80  * |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  ,|  /|Shft|Up | |  1|  2|  3|   |
  81  * |---------------------------------------------------------| |-----------|Ent|
  82  * |Opt  |Mac    |         Space         |Ent|  \|Lft|Rgt|Dn | |      0|  .|   |
  83  * `---------------------------------------------------------' `---------------'
  84  * NOTE: Ent between Space and \ means Enter on M0110.
  85  */
  86 #define KEYMAP( \
  87     K32,K12,K13,K14,K15,K17,K16,K1A,K1C,K19,K1D,K1B,K18,K33,  K47,K68,K6D,K62, \
  88     K30,K0C,K0D,K0E,K0F,K11,K10,K20,K22,K1F,K23,K21,K1E,      K59,K5B,K5C,K4E, \
  89     K39,K00,K01,K02,K03,K05,K04,K26,K28,K25,K29,K27,    K24,  K56,K57,K58,K66, \
  90     K38,K06,K07,K08,K09,K0B,K2D,K2E,K2B,K2F,K2C,        K4D,  K53,K54,K55,K4C, \
  91     K3A,K37,            K31,            K34,K2A,K46,K42,K48,  K52,    K41      \
  92 ) { \
  93     { KC_##K00, KC_##K01, KC_##K02, KC_##K03, KC_##K04, KC_##K05, KC_##K06, KC_##K07 }, \
  94     { KC_##K08, KC_##K09, KC_NO,    KC_##K0B, KC_##K0C, KC_##K0D, KC_##K0E, KC_##K0F }, \
  95     { KC_##K10, KC_##K11, KC_##K12, KC_##K13, KC_##K14, KC_##K15, KC_##K16, KC_##K17 }, \
  96     { KC_##K18, KC_##K19, KC_##K1A, KC_##K1B, KC_##K1C, KC_##K1D, KC_##K1E, KC_##K1F }, \
  97     { KC_##K20, KC_##K21, KC_##K22, KC_##K23, KC_##K24, KC_##K25, KC_##K26, KC_##K27 }, \
  98     { KC_##K28, KC_##K29, KC_##K2A, KC_##K2B, KC_##K2C, KC_##K2D, KC_##K2E, KC_##K2F }, \
  99     { KC_##K30, KC_##K31, KC_##K32, KC_##K33, KC_##K34, KC_NO,    KC_NO,    KC_##K37 }, \
 100     { KC_##K38, KC_##K39, KC_##K3A, KC_NO,    KC_NO,    KC_NO,    KC_NO,    KC_NO    }, \
 101     { KC_NO,    KC_##K41, KC_##K42, KC_NO,    KC_NO,    KC_NO,    KC_##K46, KC_##K47 }, \
 102     { KC_##K48, KC_NO,    KC_NO,    KC_NO,    KC_##K4C, KC_##K4D, KC_##K4E, KC_NO    }, \
 103     { KC_NO,    KC_NO,    KC_##K52, KC_##K53, KC_##K54, KC_##K55, KC_##K56, KC_##K57 }, \
 104     { KC_##K58, KC_##K59, KC_NO,    KC_##K5B, KC_##K5C, KC_NO,    KC_NO,    KC_NO    }, \
 105     { KC_NO,    KC_NO,    KC_##K62, KC_NO,    KC_NO,    KC_NO,    KC_##K66, KC_NO    }, \
 106     { KC_##K68, KC_NO,    KC_NO,    KC_NO,    KC_NO,    KC_##K6D, KC_NO,    KC_NO    }, \
 107 }
 108
 109 /* International keyboard
 110  *  ,---------------------------------------------------------.
 111  *  | 32| 12| 13| 14| 15| 17| 16| 1A| 1C| 19| 1D| 1B| 18|   33|
 112  *  |---------------------------------------------------------|
 113  *  |   30| 0C| 0D| 0E| 0F| 10| 11| 20| 22| 1F| 23| 21| 1E| 2A|
 114  *  |------------------------------------------------------,  |
 115  *  |    39| 00| 01| 02| 03| 05| 04| 26| 28| 25| 29| 27| 24|  |
 116  *  |---------------------------------------------------------|
 117  *  |  38| 06| 07| 08| 09| 0B| 2D| 2E| 2B| 2F| 2C| 0A|      38|
 118  *  `---------------------------------------------------------'
 119  *       | 3A|  37|             34              |   31| 3A|
 120  *       `------------------------------------------------'
 121  */
 122 #define KEYMAP_INTL( \
 123     K32,K12,K13,K14,K15,K17,K16,K1A,K1C,K19,K1D,K1B,K18,K33,  K47,K68,K6D,K62, \
 124     K30,K0C,K0D,K0E,K0F,K11,K10,K20,K22,K1F,K23,K21,K1E,K2A,  K59,K5B,K5C,K4E, \
 125     K39,K00,K01,K02,K03,K05,K04,K26,K28,K25,K29,K27,K24,      K56,K57,K58,K66, \
 126     K38,K06,K07,K08,K09,K0B,K2D,K2E,K2B,K2F,K2C,K0A,    K4D,  K53,K54,K55,K4C, \
 127     K3A,K37,            K34,            K31,    K46,K42,K48,  K52,    K41      \
 128 ) { \
 129     { KC_##K00, KC_##K01, KC_##K02, KC_##K03, KC_##K04, KC_##K05, KC_##K06, KC_##K07 }, \
 130     { KC_##K08, KC_##K09, KC_##K0A, KC_##K0B, KC_##K0C, KC_##K0D, KC_##K0E, KC_##K0F }, \
 131     { KC_##K10, KC_##K11, KC_##K12, KC_##K13, KC_##K14, KC_##K15, KC_##K16, KC_##K17 }, \
 132     { KC_##K18, KC_##K19, KC_##K1A, KC_##K1B, KC_##K1C, KC_##K1D, KC_##K1E, KC_##K1F }, \
 133     { KC_##K20, KC_##K21, KC_##K22, KC_##K23, KC_##K24, KC_##K25, KC_##K26, KC_##K27 }, \
 134     { KC_##K28, KC_##K29, KC_##K2A, KC_##K2B, KC_##K2C, KC_##K2D, KC_##K2E, KC_##K2F }, \
 135     { KC_##K30, KC_##K31, KC_##K32, KC_##K33, KC_##K34, KC_NO,    KC_NO,    KC_##K37 }, \
 136     { KC_##K38, KC_##K39, KC_##K3A, KC_NO,    KC_NO,    KC_NO,    KC_NO,    KC_NO    }, \
 137     { KC_NO,    KC_##K41, KC_##K42, KC_NO,    KC_NO,    KC_NO,    KC_##K46, KC_##K47 }, \
 138     { KC_##K48, KC_NO,    KC_NO,    KC_NO,    KC_##K4C, KC_##K4D, KC_##K4E, KC_NO    }, \
 139     { KC_NO,    KC_NO,    KC_##K52, KC_##K53, KC_##K54, KC_##K55, KC_##K56, KC_##K57 }, \
 140     { KC_##K58, KC_##K59, KC_NO,    KC_##K5B, KC_##K5C, KC_NO,    KC_NO,    KC_NO    }, \
 141     { KC_NO,    KC_NO,    KC_##K62, KC_NO,    KC_NO,    KC_NO,    KC_##K66, KC_NO    }, \
 142     { KC_##K68, KC_NO,    KC_NO,    KC_NO,    KC_NO,    KC_##K6D, KC_NO,    KC_NO    }, \
 143 }