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