keyboards/satan/satan.h

   1 #ifndef SATAN_H
   2 #define SATAN_H
   3
   4 #include "quantum.h"
   5
   6 // readability
   7 #define XXX KC_NO
   8
   9 /* Satan GH60 matrix layout (3c is right of 3d, 3d is shift)
  10    * ,-----------------------------------------------------------.
  11    * | 00 |01| 02| 03| 04| 05| 06| 07| 08| 09| 0a| 0b| 0c| 0d| 49|
  12    * |-----------------------------------------------------------|
  13    * | 10  | 11| 12| 13| 14| 15| 16| 17| 18| 19| 1a| 1b| 1c|  1d |
  14    * |-----------------------------------------------------------|
  15    * | 20    | 21| 22| 23| 24| 25| 26| 27| 28| 29| 2a| 2b| 2c|2d |
  16    * |-----------------------------------------------------------|
  17    * | 30 | 31| 32| 33| 34| 35| 36| 37| 38| 39| 3a| 3b|  3d | 3c |
  18    * |-----------------------------------------------------------|
  19    * | 40 | 41 | 42 |        45             | 4a | 4b | 4c | 4d  |
  20    * `-----------------------------------------------------------'
  21  */
  22 // The first section contains all of the arguments
  23 // The second converts the arguments into a two-dimensional array
  24 #define KEYMAP( \
  25     k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, k49,\
  26         k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k1d, \
  27         k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c, k2d, \
  28         k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3d, k3c, \
  29         k40, k41, k42,           k45,                     k4a, k4b, k4c, k4d  \
  30 ) \
  31 { \
  32         {k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d}, \
  33         {k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k1d}, \
  34         {k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c, k2d}, \
  35         {k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3c, k3d}, \
  36         {k40, k41, k42, XXX, XXX, k45, XXX, XXX, XXX, k49, k4a, k4b, k4c, k4d}  \
  37 }
  38
  39 #define COMPACT_KEYMAP( \
  40     k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, k49,\
  41         k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k1d, \
  42         k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c, k2d, \
  43         k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3c, k3d, \
  44         k40, k41, k42,           k45,                     k4a, k4b, k4c, k4d  \
  45 ) KEYMAP ( \
  46     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, KC_##k49,\
  47         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, \
  48         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, \
  49         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_##k3d, KC_##k3c, \
  50         KC_##k40, KC_##k41, KC_##k42,                     KC_##k45,                                         KC_##k4a, KC_##k4b, KC_##k4c, KC_##k4d  \
  51 )
  52
  53 /* Satan GH60 ANSI layout
  54    * ,-----------------------------------------------------------.
  55    * | 00 |01| 02| 03| 04| 05| 06| 07| 08| 09| 0a| 0b| 0c| 0d    |
  56    * |-----------------------------------------------------------|
  57    * | 10  | 11| 12| 13| 14| 15| 16| 17| 18| 19| 1a| 1b| 1c|  1d |
  58    * |-----------------------------------------------------------|
  59    * | 20    | 21| 22| 23| 24| 25| 26| 27| 28| 29| 2a| 2b| 2d    |
  60    * |-----------------------------------------------------------|
  61    * | 30     | 32| 33| 34| 35| 36| 37| 38| 39| 3a| 3b|    3d    |
  62    * |-----------------------------------------------------------|
  63    * | 40 | 41 | 42 |        45             | 4a | 4b | 4c | 4d  |
  64    * `-----------------------------------------------------------'
  65  */
  66 #define KEYMAP_ANSI( \
  67     k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
  68         k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k1d, \
  69         k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b,      k2d, \
  70         k30,      k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b,      k3d, \
  71         k40, k41, k42,           k45,                     k4a, k4b, k4c, k4d  \
  72 ) \
  73 { \
  74         {k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d}, \
  75         {k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k1d}, \
  76         {k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, XXX, k2d}, \
  77         {k30, XXX, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, XXX, k3d}, \
  78         {k40, k41, k42, XXX, XXX, k45, XXX, XXX, XXX, XXX, k4a, k4b, k4c, k4d}  \
  79 }
  80
  81 /* Satan HHKB matrix layout
  82    * ,------------------------------------------------------------.
  83    * | 00 |01| 02| 03| 04| 05| 06| 07| 08| 09| 0a| 0b| 0c| 0d| 49 |
  84    * |------------------------------------------------------------|
  85    * | 10  | 11| 12| 13| 14| 15| 16| 17| 18| 19| 1a| 1b| 1c|  1d  |
  86    * |------------------------------------------------------------|
  87    * | 20    | 21| 22| 23| 24| 25| 26| 27| 28| 29| 2a| 2b| 2d     |
  88    * |------------------------------------------------------------|
  89    * | 30     | 32| 33| 34| 35| 36| 37| 38| 39| 3a| 3b| 3d   | 3c |
  90    * |------------------------------------------------------------|
  91    * | 40 | 41 | 42 |        45              | 4a | 4b | 4c | 4d  |
  92    * `------------------------------------------------------------'
  93  */
  94
  95 #define KEYMAP_HHKB( \
  96     k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, k49, \
  97         k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k1d, \
  98         k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b,      k2d, \
  99         k30,      k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3d, k3c, \
 100         k40, k41, k42,           k45,                     k4a, k4b, k4c, k4d  \
 101 ) \
 102 { \
 103         {k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d}, \
 104         {k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k1d}, \
 105         {k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, XXX, k2d}, \
 106         {k30, XXX, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3c, k3d}, \
 107         {k40, k41, k42, XXX, XXX, k45, XXX, XXX, XXX, k49, k4a, k4b, k4c, k4d}  \
 108 }
 109
 110 /* ISO w/ split right shift key matrix layout
 111    * ,-----------------------------------------------------------.
 112    * | 00 |01| 02| 03| 04| 05| 06| 07| 08| 09| 0a| 0b| 0c| 0d    |
 113    * |-----------------------------------------------------------|
 114    * | 10  | 11| 12| 13| 14| 15| 16| 17| 18| 19| 1a| 1b| 1c|  1d |
 115    * |-----------------------------------------------------------|
 116    * | 20    | 21| 22| 23| 24| 25| 26| 27| 28| 29| 2a| 2b| 2c|2d |
 117    * |-----------------------------------------------------------|
 118    * | 30 | 31| 32| 33| 34| 35| 36| 37| 38| 39| 3a| 3b|  3d  | 3c|
 119    * |-----------------------------------------------------------|
 120    * | 40 | 41 | 42 |        45             | 4a | 4b | 4c | 4d  |
 121    * `-----------------------------------------------------------'
 122
 123    swap 3c and 3d. 3c is right of 3d in reality
 124  */
 125 #define KEYMAP_ISO_SPLITRSHIFT( \
 126     k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
 127         k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k1d, \
 128         k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c, k2d, \
 129         k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3d, k3c, \
 130         k40, k41, k42,           k45,                     k4a, k4b, k4c, k4d  \
 131 ) \
 132 { \
 133         {k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d}, \
 134         {k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k1d}, \
 135         {k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c, k2d}, \
 136         {k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3c, k3d}, \
 137         {k40, k41, k42, XXX, XXX, k45, XXX, XXX, XXX, XXX, k4a, k4b, k4c, k4d}  \
 138 }
 139
 140 void matrix_init_user(void);
 141 void matrix_scan_user(void);
 142
 143 #endif