]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/satan/satan.h
5128fd073b8246e55229cda731a3e4ebdc268a7c
[qmk_firmware.git] / 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
66 /* Satan HHKB matrix layout
67    * ,------------------------------------------------------------.
68    * | 00 |01| 02| 03| 04| 05| 06| 07| 08| 09| 0a| 0b| 0c| 0d| 49 |
69    * |------------------------------------------------------------|
70    * | 10  | 11| 12| 13| 14| 15| 16| 17| 18| 19| 1a| 1b| 1c|  1d  |
71    * |------------------------------------------------------------|
72    * | 20    | 21| 22| 23| 24| 25| 26| 27| 28| 29| 2a| 2b| 2d     |
73    * |------------------------------------------------------------|
74    * | 30     | 32| 33| 34| 35| 36| 37| 38| 39| 3a| 3b| 3d   | 3c |
75    * |------------------------------------------------------------|
76    * | 40 | 41 | 42 |        45              | 4a | 4b | 4c | 4d  |
77    * `------------------------------------------------------------'
78  */
79
80 #define KEYMAP_HHKB( \
81     k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, k49, \
82         k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k1d, \
83         k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b,      k2d, \
84         k30,      k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3d, k3c, \
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, k1d}, \
90         {k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, XXX, k2d}, \
91         {k30, XXX, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3c, k3d}, \
92         {k40, k41, k42, XXX, XXX, k45, XXX, XXX, XXX, k49, k4a, k4b, k4c, k4d}  \
93 }
94
95 /* ISO w/ split right shift key matrix layout
96    * ,-----------------------------------------------------------.
97    * | 00 |01| 02| 03| 04| 05| 06| 07| 08| 09| 0a| 0b| 0c| 0d    |
98    * |-----------------------------------------------------------|
99    * | 10  | 11| 12| 13| 14| 15| 16| 17| 18| 19| 1a| 1b| 1c|  1d |
100    * |-----------------------------------------------------------|
101    * | 20    | 21| 22| 23| 24| 25| 26| 27| 28| 29| 2a| 2b| 2c|2d |
102    * |-----------------------------------------------------------|
103    * | 30 | 31| 32| 33| 34| 35| 36| 37| 38| 39| 3a| 3b|  3d  | 3c|
104    * |-----------------------------------------------------------|
105    * | 40 | 41 | 42 |        45             | 4a | 4b | 4c | 4d  |
106    * `-----------------------------------------------------------'
107
108    swap 3c and 3d. 3c is right of 3d in reality
109  */
110 #define KEYMAP_ISO_SPLITRSHIFT( \
111     k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, \
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, k2c, k2d, \
114         k30, k31, 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, k2c, k2d}, \
121         {k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3c, k3d}, \
122         {k40, k41, k42, XXX, XXX, k45, XXX, XXX, XXX, XXX, k4a, k4b, k4c, k4d}  \
123 }
124
125 void matrix_init_user(void);
126 void matrix_scan_user(void);
127
128 #define LAYOUT_60_ansi KEYMAP_ANSI
129 #define LAYOUT_60_iso KEYMAP
130 #define LAYOUT_60_ansi_split_bs_rshift KEYMAP_HHKB
131
132 #endif