keyboards/espectro/espectro.h

   1 /* Copyright 2018 @TurboMech /u/TurboMech <discord> @A9entOran9e#6134
   2  *
   3  * This program is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16
  17
  18 #pragma once
  19
  20 #include "quantum.h"
  21
  22
  23 /*
  24  * Placement of every possible switch defined below.
  25  * x2 means the diode allows two possible positions for the switch
  26  *
  27  * Layout:
  28  *   ┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┐
  29  *   │K00  │K01  │K02  │K03  │K04  │K60  │K61  │K62  │K63  │K05  │K06  │K07  │K08  │K72  │K09  │K0A  │K0B  │K0C  │K7C  │
  30  *   │     │     │     │     │     │     │     │     │     │     │     │     │     │     │     │     │     │     │     │
  31  *   ├─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
  32  *   │K10  │K11  │K12  │K13  │K14  │K64  │K65  │K66  │K67  │K15  │K16  │K17  │K18  │K70  │K71  │K19  │K1A  │K1B  │K1C  │
  33  *   │     │     │     │     │     │     │     │     │     │     │     │     │     │     │x2   │     │     │     │     │
  34  *   ├─────┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴─────┼─────┼─────┼─────┼─────┤          ┌────────┐
  35  *   │K20     │K21  │K22  │K23  │K24  │K68  │K69  │K6A  │K6B  │K25  │K26  │K27  │K28  │K73     │K29  │K2A  │K2B  │K2C  │          │K38     │
  36  *   │        │     │     │     │     │     │     │     │     │     │     │     │     │        │     │     │     │     │          │        │
  37  *   ├────────┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┴────────┼─────┼─────┼─────┼─────┤      ┌───┴─┐      │
  38  *   │K30       │K31  │K32  │K33  │K34  │K6C  │K75  │K76  │K77  │K35  │K36  │K37  │K38         │K39  │K3A  │K3B  │K3C  │      │K73  │      │
  39  *   │          │     │     │     │     │     │     │     │     │     │     │     │            │     │     │     │     │      │     │      │
  40  *   ├───────┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──┬──┴──────┬─────┼─────┼─────┼─────┼─────┤      └─────┴──────┘
  41  *   │K40x2  │K41  │K42  │K43  │K44  │K78  │K79  │K7A  │K7B  │K45  │K46  │K47  │K48      │K74  │K49  │K4A  │K4B  │K4C  │
  42  *   │       │     │     │     │     │     │     │     │     │     │     │     │         │     │     │     │     │     │
  43  *   ├───────┼─────┴─┬───┴───┬─┴─────┴─────┴─────┴─────┴─────┴───┬─┴───┬─┴───┬─┴───┬─────┼─────┼─────┼─────┼─────┼─────┤
  44  *   │K50    │K51    │K52    │K59                                │K55  │K56  │K57  │K58  │K53  │K54  │K5A  │K5B  │K5C  │
  45  *   │x2     │x2     │       │x3                                 │x3   │x2   │x2   │x2   │x2   │     │x2   │     │     │
  46  *   └───────┴───────┴───────┴───────────────────────────────────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘
  47  *
  48  * Variants:
  49  *   - 2u Backspace:      Delete K70   Use K71
  50  *   - 2u Num +:          Delete K3C   Use K2C
  51  *   - 2u Num Enter:      Delete K5C   Use K4C
  52  *   - ANSI Left Shift:   Delete K41   Use K40
  53  *
  54  *   ANSI Backslash and ISO Hash are the same position
  55  *   ANSI Enter and ISO Enter are the same position
  56  *   For two 1.5u modifiers on the right of the Spacebar, delete K56 and use K55 and K57
  57  *
  58  * Matrix:
  59  *   { K00,  K01,  K02,  K03,  K04,  K05,  K06,  K07,  K08,  K09,  K0A,  K0B,  K0C }, \
  60  *   { K10,  K11,  K12,  K13,  K14,  K15,  K16,  K17,  K18,  K19,  K1A,  K1B,  K1C }, \
  61  *   { K20,  K21,  K22,  K23,  K24,  K25,  K26,  K27,  K28,  K29,  K2A,  K2B,  K2C }, \
  62  *   { K30,  K31,  K32,  K33,  K34,  K35,  K36,  K37,  K38,  K39,  K3A,  K3B,  K3C }, \
  63  *   { K40,  K41,  K42,  K43,  K44,  K45,  K46,  K47,  K48,  K49,  K4A,  K4B,  K4C }, \
  64  *   { K50,  K51,  K52,  K53,  K54,  K55,  K56,  K57,  K58,  K59,  K5A,  K5B,  K5C }, \
  65  *   { K60,  K61,  K62,  K63,  K64,  K65,  K66,  K67,  K68,  K69,  K6A,  K6B,  K6C }, \
  66  *   { K70,  K71,  K72,  K73,  K74,  K75,  K76,  K77,  K78,  K79,  K7A,  K7B,  K7C }  \
  67  */
  68
  69
  70 /* LAYOUT_all (Identical to LAYOUT_split_shift_and_bs)
  71  *   Every matrix position
  72  * ,---------------------------------------------------------------------------.
  73  * | 00| 01| 02| 03| 04| 60| 61| 62| 63| 05| 06| 07| 08| 72| 09| 0A| 0B| 0C| 7C|
  74  * |---------------------------------------------------------------------------|
  75  * | 10| 11| 12| 13| 14| 64| 65| 66| 67| 15| 16| 17| 18| 70| 71| 19| 1A| 1B| 1C|
  76  * |---------------------------------------------------------------------------|
  77  * | 20  | 21| 22| 23| 24| 68| 69| 6A| 6B| 25| 26| 27| 28|   73| 29| 2A| 2B| 2C|
  78  * |---------------------------------------------------------------------------|
  79  * | 30   | 31| 32| 33| 34| 6C| 75| 76| 77| 35| 36| 37|      38| 39| 3A| 3B| 3C|
  80  * |---------------------------------------------------------------------------|
  81  * | 40 | 41| 42| 43| 44| 78| 79| 7A| 7B| 45| 46| 47|    48| 74| 49| 4A| 4B| 4C|
  82  * |---------------------------------------------------------------------------|
  83  * | 50 | 51 | 52 |           59           | 55| 56| 57| 58| 53| 54| 5A| 5B| 5C|
  84  * `---------------------------------------------------------------------------'
  85 */
  86
  87
  88 //Arrow keys and 1.75u right shift
  89 #define LAYOUT_default( \
  90   K00, K01, K02, K03, K04, K60, K61, K62, K63, K05, K06, K07, K08, K72, K09,    K0A, K0B, K0C, K7C, \
  91   K10, K11, K12, K13, K14, K64, K65, K66, K67, K15, K16, K17, K18,      K71,    K19, K1A, K1B, K1C, \
  92   K20,    K21, K22, K23, K24, K68, K69, K6A, K6B, K25, K26, K27, K28,   K73,    K29, K2A, K2B, K2C, \
  93   K30,     K31, K32, K33, K34, K6C, K75, K76, K77, K35, K36, K37,       K38,    K39, K3A, K3B,      \
  94   K40,       K42, K43, K44, K78, K79, K7A, K7B, K45, K46, K47,     K48, K74,    K49, K4A, K4B, K4C, \
  95   K50,  K51,  K52,                K59,              K55, K56, K57, K58, K53, K54,    K5A, K5B       \
  96 ) { \
  97   { K00,    K01,    K02,  K03,  K04,  K05,  K06,  K07,  K08,  K09,  K0A,  K0B,  K0C   }, \
  98   { K10,    K11,    K12,  K13,  K14,  K15,  K16,  K17,  K18,  K19,  K1A,  K1B,  K1C   }, \
  99   { K20,    K21,    K22,  K23,  K24,  K25,  K26,  K27,  K28,  K29,  K2A,  K2B,  K2C   }, \
 100   { K30,    K31,    K32,  K33,  K34,  K35,  K36,  K37,  K38,  K39,  K3A,  K3B,  KC_NO }, \
 101   { K40,    KC_NO,  K42,  K43,  K44,  K45,  K46,  K47,  K48,  K49,  K4A,  K4B,  K4C   }, \
 102   { K50,    K51,    K52,  K53,  K54,  K55,  K56,  K57,  K58,  K59,  K5A,  K5B,  KC_NO }, \
 103   { K60,    K61,    K62,  K63,  K64,  K65,  K66,  K67,  K68,  K69,  K6A,  K6B,  K6C   }, \
 104   { KC_NO,  K71,    K72,  K73,  K74,  K75,  K76,  K77,  K78,  K79,  K7A,  K7B,  K7C   }  \
 105 }
 106
 107 // Split backspace 1.5u right mods
 108 #define LAYOUT_split_bs_joined_right( \
 109   K00, K01, K02, K03, K04, K60, K61, K62, K63, K05, K06, K07, K08, K72, K09, K0A, K0B, K0C, K7C,  \
 110   K10, K11, K12, K13, K14, K64, K65, K66, K67, K15, K16, K17, K18, K70, K71, K19, K1A, K1B, K1C,  \
 111   K20,   K21, K22, K23, K24, K68, K69, K6A, K6B, K25, K26, K27, K28,  K73,   K29, K2A, K2B, K2C,  \
 112   K30,    K31, K32, K33, K34, K6C, K75, K76, K77, K35, K36, K37,     K38,    K39, K3A, K3B,       \
 113   K40,     K42, K43, K44, K78, K79, K7A, K7B, K45, K46, K47,    K48,    K74, K49, K4A, K4B, K4C,  \
 114   K50, K51, K52,                K59,                     K55, K57, K58, K53, K54, K5A, K5B        \
 115 ) { \
 116   { K00,  K01,    K02,  K03,  K04,  K05,  K06,    K07,  K08,  K09,  K0A,  K0B,  K0C   }, \
 117   { K10,  K11,    K12,  K13,  K14,  K15,  K16,    K17,  K18,  K19,  K1A,  K1B,  K1C   }, \
 118   { K20,  K21,    K22,  K23,  K24,  K25,  K26,    K27,  K28,  K29,  K2A,  K2B,  K2C   }, \
 119   { K30,  K31,    K32,  K33,  K34,  K35,  K36,    K37,  K38,  K39,  K3A,  K3B,  KC_NO }, \
 120   { K40,  KC_NO,  K42,  K43,  K44,  K45,  K46,    K47,  K48,  K49,  K4A,  K4B,  K4C   }, \
 121   { K50,  K51,    K52,  K53,  K54,  K55,  KC_NO,  K57,  K58,  K59,  K5A,  K5B,  KC_NO }, \
 122   { K60,  K61,    K62,  K63,  K64,  K65,  K66,    K67,  K68,  K69,  K6A,  K6B,  K6C   }, \
 123   { K70,  K71,    K72,  K73,  K74,  K75,  K76,    K77,  K78,  K79,  K7A,  K7B,  K7C   }, \
 124 }
 125
 126 // Split numpad (enter, 0), split shifts (right, left), split backspace
 127 // This layout contains every possible keycode placement
 128 #define LAYOUT_split_shift_and_bs( \
 129   K00, K01, K02, K03, K04, K60, K61, K62, K63, K05, K06, K07, K08, K72, K09,    K0A, K0B, K0C, K7C, \
 130   K10, K11, K12, K13, K14, K64, K65, K66, K67, K15, K16, K17, K18, K70, K71,    K19, K1A, K1B, K1C, \
 131   K20,    K21, K22, K23, K24, K68, K69, K6A, K6B, K25, K26, K27, K28,   K73,    K29, K2A, K2B, K2C, \
 132   K30,     K31, K32, K33, K34, K6C, K75, K76, K77, K35, K36, K37,       K38,    K39, K3A, K3B, K3C, \
 133   K40,  K41, K42, K43, K44, K78, K79, K7A, K7B, K45, K46, K47,     K48, K74,    K49, K4A, K4B, K4C, \
 134   K50,  K51,  K52,                K59,              K55, K56, K57, K58, K53, K54,    K5A, K5B, K5C  \
 135 ) { \
 136   { K00,  K01,  K02,  K03,  K04,  K05,  K06,  K07,  K08,  K09,  K0A,  K0B,  K0C },  \
 137   { K10,  K11,  K12,  K13,  K14,  K15,  K16,  K17,  K18,  K19,  K1A,  K1B,  K1C },  \
 138   { K20,  K21,  K22,  K23,  K24,  K25,  K26,  K27,  K28,  K29,  K2A,  K2B,  K2C },  \
 139   { K30,  K31,  K32,  K33,  K34,  K35,  K36,  K37,  K38,  K39,  K3A,  K3B,  K3C },  \
 140   { K40,  K41,  K42,  K43,  K44,  K45,  K46,  K47,  K48,  K49,  K4A,  K4B,  K4C },  \
 141   { K50,  K51,  K52,  K53,  K54,  K55,  K56,  K57,  K58,  K59,  K5A,  K5B,  K5C },  \
 142   { K60,  K61,  K62,  K63,  K64,  K65,  K66,  K67,  K68,  K69,  K6A,  K6B,  K6C },  \
 143   { K70,  K71,  K72,  K73,  K74,  K75,  K76,  K77,  K78,  K79,  K7A,  K7B,  K7C },  \
 144 }
 145
 146 // ISO Layout
 147 #define LAYOUT_iso( \
 148   K00, K01, K02, K03, K04, K60, K61, K62, K63, K05, K06, K07, K08, K72, K09,    K0A, K0B, K0C, K7C, \
 149   K10, K11, K12, K13, K14, K64, K65, K66, K67, K15, K16, K17, K18,      K71,    K19, K1A, K1B, K1C, \
 150   K20,    K21, K22, K23, K24, K68, K69, K6A, K6B, K25, K26, K27, K28,           K29, K2A, K2B, K2C, \
 151   K30,     K31, K32, K33, K34, K6C, K75, K76, K77, K35, K36, K37, K73,  K38,    K39, K3A, K3B,      \
 152   K40,  K41, K42, K43, K44, K78, K79, K7A, K7B, K45, K46, K47,     K48, K74,    K49, K4A, K4B, K4C, \
 153   K50,  K51,  K52,                K59,              K55, K56, K57, K58, K53, K54,    K5A, K5B       \
 154 ) { \
 155   { K00,    K01,    K02,  K03,  K04,  K05,  K06,  K07,  K08,  K09,  K0A,  K0B,  K0C   }, \
 156   { K10,    K11,    K12,  K13,  K14,  K15,  K16,  K17,  K18,  K19,  K1A,  K1B,  K1C   }, \
 157   { K20,    K21,    K22,  K23,  K24,  K25,  K26,  K27,  K28,  K29,  K2A,  K2B,  K2C   }, \
 158   { K30,    K31,    K32,  K33,  K34,  K35,  K36,  K37,  K38,  K39,  K3A,  K3B,  KC_NO }, \
 159   { K40,    K41,    K42,  K43,  K44,  K45,  K46,  K47,  K48,  K49,  K4A,  K4B,  K4C   }, \
 160   { K50,    K51,    K52,  K53,  K54,  K55,  K56,  K57,  K58,  K59,  K5A,  K5B,  KC_NO }, \
 161   { K60,    K61,    K62,  K63,  K64,  K65,  K66,  K67,  K68,  K69,  K6A,  K6B,  K6C   }, \
 162   { KC_NO,  K71,    K72,  K73,  K74,  K75,  K76,  K77,  K78,  K79,  K7A,  K7B,  K7C   }  \
 163 }