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 LAYOUT_all( \
  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
  40 /* Satan GH60 ANSI layout-B
  41  * ,-----------------------------------------------------------.
  42  * | 00| 01| 02| 03| 04| 05| 06| 07| 08| 09| 0a| 0b| 0c|    0d |
  43  * |-----------------------------------------------------------|
  44  * | 10  | 11| 12| 13| 14| 15| 16| 17| 18| 19| 1a| 1b| 1c|  1d |
  45  * |-----------------------------------------------------------|
  46  * | 20   | 21| 22| 23| 24| 25| 26| 27| 28| 29| 2a| 2b|     2d |
  47  * |-----------------------------------------------------------|
  48  * | 30     | 32| 33| 34| 35| 36| 37| 38| 39| 3a| 3b|  3d | 3c |
  49  * |-----------------------------------------------------------|
  50  * | 40 | 41 | 42 |        45              | 4a | 4b | 4c | 4d |
  51  * `-----------------------------------------------------------'
  52  */
  53 #define LAYOUT_60_ansi_split_rshift( \
  54     k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
  55     k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k1d, \
  56     k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b,      k2d, \
  57     k30,      k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3d, k3c, \
  58     k40, k41, k42,           k45,                     k4a, k4b, k4c, k4d  \
  59 ) \
  60 { \
  61     {k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d}, \
  62     {k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k1d}, \
  63     {k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, XXX, k2d}, \
  64     {k30, XXX, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3c, k3d}, \
  65     {k40, k41, k42, XXX, XXX, k45, XXX, XXX, XXX, XXX, k4a, k4b, k4c, k4d}  \
  66 }
  67
  68 /* Satan GH60 ANSI layout
  69  * ,-----------------------------------------------------------.
  70  * | 00| 01| 02| 03| 04| 05| 06| 07| 08| 09| 0a| 0b| 0c|    0d |
  71  * |-----------------------------------------------------------|
  72  * | 10  | 11| 12| 13| 14| 15| 16| 17| 18| 19| 1a| 1b| 1c|  1d |
  73  * |-----------------------------------------------------------|
  74  * | 20   | 21| 22| 23| 24| 25| 26| 27| 28| 29| 2a| 2b|     2d |
  75  * |-----------------------------------------------------------|
  76  * | 30     | 32| 33| 34| 35| 36| 37| 38| 39| 3a| 3b|       3d |
  77  * |-----------------------------------------------------------|
  78  * | 40 | 41 | 42 |        45              | 4a | 4b | 4c | 4d |
  79  * `-----------------------------------------------------------'
  80  */
  81 #define LAYOUT_60_ansi( \
  82     k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
  83     k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k1d, \
  84     k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b,      k2d, \
  85     k30,      k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b,      k3d, \
  86     k40, k41, k42,           k45,                     k4a, k4b, k4c, k4d  \
  87 ) \
  88 { \
  89     {k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d}, \
  90     {k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k1d}, \
  91     {k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, XXX, k2d}, \
  92     {k30, XXX, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, XXX, k3d}, \
  93     {k40, k41, k42, XXX, XXX, k45, XXX, XXX, XXX, XXX, k4a, k4b, k4c, k4d}  \
  94 }
  95
  96 /* Satan GH60 ISO layout
  97  * ,-----------------------------------------------------------.
  98  * | 00| 01| 02| 03| 04| 05| 06| 07| 08| 09| 0a| 0b| 0c|    0d |
  99  * |-----------------------------------------------------------|
 100  * | 10  | 11| 12| 13| 14| 15| 16| 17| 18| 19| 1a| 1b| 1c|     |
 101  * |------------------------------------------------------.    |
 102  * | 20   | 21| 22| 23| 24| 25| 26| 27| 28| 29| 2a| 2b| 2c| 2d |
 103  * |-----------------------------------------------------------|
 104  * | 30 | 31| 32| 33| 34| 35| 36| 37| 38| 39| 3a| 3b|       3d |
 105  * |-----------------------------------------------------------|
 106  * | 40 | 41 | 42 |        45              | 4a | 4b | 4c | 4d |
 107  * `-----------------------------------------------------------'
 108  */
 109 #define LAYOUT_60_iso( \
 110     k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
 111     k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c,  \
 112     k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c, k2d, \
 113     k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b,      k3d, \
 114     k40, k41, k42,           k45,                     k4a, k4b, k4c, k4d  \
 115 ) \
 116 { \
 117     {k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d}, \
 118     {k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, XXX}, \
 119     {k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c, k2d}, \
 120     {k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, XXX, k3d}, \
 121     {k40, k41, k42, XXX, XXX, k45, XXX, XXX, XXX, XXX, k4a, k4b, k4c, k4d}  \
 122 }
 123
 124 /* Satan GH60 ANSI split backspace, split right shift matrix layout
 125  *   a.k.a. HHKB layout
 126  * ,-----------------------------------------------------------.
 127  * | 00| 01| 02| 03| 04| 05| 06| 07| 08| 09| 0a| 0b| 0c| 0d| 49|
 128  * |-----------------------------------------------------------|
 129  * | 10  | 11| 12| 13| 14| 15| 16| 17| 18| 19| 1a| 1b| 1c|  1d |
 130  * |-----------------------------------------------------------|
 131  * | 20   | 21| 22| 23| 24| 25| 26| 27| 28| 29| 2a| 2b|     2d |
 132  * |-----------------------------------------------------------|
 133  * | 30     | 32| 33| 34| 35| 36| 37| 38| 39| 3a| 3b|   3d | 3c|
 134  * |-----------------------------------------------------------|
 135  * | 40 | 41 | 42 |        45              | 4a | 4b | 4c | 4d |
 136  * `-----------------------------------------------------------'
 137  */
 138
 139 #define LAYOUT_60_ansi_split_bs_rshift( \
 140     k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, k49, \
 141     k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k1d, \
 142     k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b,      k2d, \
 143     k30,      k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3d, k3c, \
 144     k40, k41, k42,           k45,                     k4a, k4b, k4c, k4d  \
 145 ) \
 146 { \
 147     {k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d}, \
 148     {k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k1d}, \
 149     {k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, XXX, k2d}, \
 150     {k30, XXX, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3c, k3d}, \
 151     {k40, k41, k42, XXX, XXX, k45, XXX, XXX, XXX, k49, k4a, k4b, k4c, k4d}  \
 152 }
 153
 154 /* ISO split right shift key matrix layout
 155  * ,-----------------------------------------------------------.
 156  * | 00| 01| 02| 03| 04| 05| 06| 07| 08| 09| 0a| 0b| 0c|    0d |
 157  * |-----------------------------------------------------------|
 158  * | 10  | 11| 12| 13| 14| 15| 16| 17| 18| 19| 1a| 1b| 1c|     |
 159  * |------------------------------------------------------.    |
 160  * | 20   | 21| 22| 23| 24| 25| 26| 27| 28| 29| 2a| 2b| 2c| 2d |
 161  * |-----------------------------------------------------------|
 162  * | 30 | 31| 32| 33| 34| 35| 36| 37| 38| 39| 3a| 3b|   3d | 3c|
 163  * |-----------------------------------------------------------|
 164  * | 40 | 41 | 42 |        45              | 4a | 4b | 4c | 4d |
 165  * `-----------------------------------------------------------'
 166  */
 167 #define LAYOUT_60_iso_split_rshift( \
 168     k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
 169     k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c,      \
 170     k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c, k2d, \
 171     k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3d, k3c, \
 172     k40, k41, k42,           k45,                     k4a, k4b, k4c, k4d  \
 173 ) { \
 174     { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d }, \
 175     { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, XXX }, \
 176     { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c, k2d }, \
 177     { k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3c, k3d }, \
 178     { k40, k41, k42, XXX, XXX, k45, XXX, XXX, XXX, XXX, k4a, k4b, k4c, k4d }, \
 179 }
 180
 181 /* ISO w/ split right shift key matrix layout
 182  * ,-----------------------------------------------------------.
 183  * | 00| 01| 02| 03| 04| 05| 06| 07| 08| 09| 0a| 0b| 0c| 0d| 49|
 184  * |-----------------------------------------------------------|
 185  * | 10  | 11| 12| 13| 14| 15| 16| 17| 18| 19| 1a| 1b| 1c|     |
 186  * |------------------------------------------------------.    |
 187  * | 20   | 21| 22| 23| 24| 25| 26| 27| 28| 29| 2a| 2b| 2c| 2d |
 188  * |-----------------------------------------------------------|
 189  * | 30 | 31| 32| 33| 34| 35| 36| 37| 38| 39| 3a| 3b|   3d | 3c|
 190  * |-----------------------------------------------------------|
 191  * | 40 | 41 | 42 |        45              | 4a | 4b | 4c | 4d |
 192  * `-----------------------------------------------------------'
 193  */
 194 #define LAYOUT_60_iso_split_bs_rshift( \
 195     k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, k49,\
 196     k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, \
 197     k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c, k2d, \
 198     k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3d, k3c, \
 199     k40, k41, k42,           k45,                     k4a, k4b, k4c, k4d  \
 200 ) \
 201 { \
 202     {k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d}, \
 203     {k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c}, \
 204     {k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c, k2d}, \
 205     {k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3c, k3d}, \
 206     {k40, k41, k42, XXX, XXX, k45, XXX, XXX, XXX, k49, k4a, k4b, k4c, k4d}  \
 207 }
 208
 209 void matrix_init_user(void);
 210 void matrix_scan_user(void);
 211
 212 #endif