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