]> git.donarmstrong.com Git - qmk_firmware.git/blobdiff - keyboards/planck/planck.h
[Keyboard] Planck: Layout Macro Refactor (#4402)
[qmk_firmware.git] / keyboards / planck / planck.h
index 8cfee5d1ccbb408ecee123b9e8547a1ec57fb929..09ac0c6077d1ffa4383d87a6ac3263e49b10f43a 100644 (file)
 #ifndef PLANCK_H
 #define PLANCK_H
 
-#ifdef SUBPROJECT_rev3
-    #include "rev3.h"
+#include "quantum.h"
+
+#define encoder_update(clockwise) encoder_update_user(uint8_t index, clockwise)
+
+#ifdef KEYBOARD_planck_ez
+  #include "ez.h"
 #endif
-#ifdef SUBPROJECT_rev4
-    #include "rev4.h"
+
+#ifdef __AVR__ // Planck revs. 1-5
+
+  #define LAYOUT_planck_1x2uC( \
+    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, \
+    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, \
+    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, \
+    k30, k31, k32, k33, k34,    k35,   k37, k38, k39, k3a, k3b \
+  ) \
+  { \
+    { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b }, \
+    { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b }, \
+    { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b }, \
+    { k30, k31, k32, k33, k34, k35, k35, k37, k38, k39, k3a, k3b } \
+  }
+
+  #define LAYOUT_ortho_4x12( \
+    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, \
+    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, \
+    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, \
+    k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b \
+  ) \
+  { \
+    { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b }, \
+    { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b }, \
+    { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b }, \
+    { k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b } \
+  }
+
+#elif KEYBOARD_planck_rev6
+
+  #define LAYOUT_planck_1x2uC( \
+    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, \
+    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, \
+    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, \
+    k30, k31, k32, k33, k34,    k36,   k37, k38, k39, k3a, k3b \
+  ) \
+  { \
+    { k00, k01, k02, k03, k04, k05   }, \
+    { k10, k11, k12, k13, k14, k15   }, \
+    { k20, k21, k22, k23, k24, k25   }, \
+    { k30, k31, k32, k39, k3a, k3b   }, \
+    { k06, k07, k08, k09, k0a, k0b   }, \
+    { k16, k17, k18, k19, k1a, k1b   }, \
+    { k26, k27, k28, k29, k2a, k2b   }, \
+    { k36, k37, k38, k33, k34, KC_NO } \
+  }
+
+  #define LAYOUT_planck_1x2uR( \
+    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, \
+    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, \
+    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, \
+    k30, k31, k32, k33, k34, k35,   k37,    k38, k39, k3a, k3b \
+  ) \
+  { \
+    { k00,   k01, k02, k03, k04, k05 }, \
+    { k10,   k11, k12, k13, k14, k15 }, \
+    { k20,   k21, k22, k23, k24, k25 }, \
+    { k30,   k31, k32, k39, k3a, k3b }, \
+    { k06,   k07, k08, k09, k0a, k0b }, \
+    { k16,   k17, k18, k19, k1a, k1b }, \
+    { k26,   k27, k28, k29, k2a, k2b }, \
+    { KC_NO, k37, k38, k33, k34, k35 } \
+  }
+
+  #define LAYOUT_planck_1x2uL( \
+    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, \
+    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, \
+    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, \
+    k30, k31, k32, k33,   k35,    k36, k37, k38, k39, k3a, k3b \
+  ) \
+  { \
+    { k00, k01, k02, k03, k04,   k05 }, \
+    { k10, k11, k12, k13, k14,   k15 }, \
+    { k20, k21, k22, k23, k24,   k25 }, \
+    { k30, k31, k32, k39, k3a,   k3b }, \
+    { k06, k07, k08, k09, k0a,   k0b }, \
+    { k16, k17, k18, k19, k1a,   k1b }, \
+    { k26, k27, k28, k29, k2a,   k2b }, \
+    { k36, k37, k38, k33, KC_NO, k35 } \
+  }
+
+  #define LAYOUT_planck_2x2u( \
+    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, \
+    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, \
+    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, \
+    k30, k31, k32, k33,   k35,      k37,    k38, k39, k3a, k3b \
+  ) \
+  { \
+    { k00,   k01, k02, k03, k04,   k05 }, \
+    { k10,   k11, k12, k13, k14,   k15 }, \
+    { k20,   k21, k22, k23, k24,   k25 }, \
+    { k30,   k31, k32, k39, k3a,   k3b }, \
+    { k06,   k07, k08, k09, k0a,   k0b }, \
+    { k16,   k17, k18, k19, k1a,   k1b }, \
+    { k26,   k27, k28, k29, k2a,   k2b }, \
+    { KC_NO, k37, k38, k33, KC_NO, k35 } \
+  }
+
+  #define LAYOUT_ortho_4x12( \
+    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, \
+    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, \
+    k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, \
+    k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b \
+  ) \
+  { \
+    { k00, k01, k02, k03, k04, k05 }, \
+    { k10, k11, k12, k13, k14, k15 }, \
+    { k20, k21, k22, k23, k24, k25 }, \
+    { k30, k31, k32, k39, k3a, k3b }, \
+    { k06, k07, k08, k09, k0a, k0b }, \
+    { k16, k17, k18, k19, k1a, k1b }, \
+    { k26, k27, k28, k29, k2a, k2b }, \
+    { k36, k37, k38, k33, k34, k35 } \
+  }
+
 #endif
 
-#include "quantum.h"
+// all Planck keyboards
 
-#define PLANCK_MIT( \
-       k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, \
-       k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, \
-       k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, \
-       k30, k31, k32, k33, k34,    k35,   k37, k38, k39, k3a, k3b \
+// Used to create a keymap using only KC_ prefixed keys
+#define LAYOUT_kc( \
+  k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, \
+  k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, \
+  k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, \
+  k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b \
 ) \
-{ \
-       { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b }, \
-       { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b }, \
-       { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b }, \
-       { k30, k31, k32, k33, k34, k35, k35, k37, k38, k39, k3a, k3b } \
-}
-
-#define PLANCK_GRID( \
-       k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, \
-       k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, \
-       k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, \
-       k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b \
-) \
-{ \
-       { k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b }, \
-       { k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b }, \
-       { k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b }, \
-       { k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b } \
-}
+LAYOUT_ortho_4x12( \
+  KC_##k00, KC_##k01, KC_##k02, KC_##k03, KC_##k04, KC_##k05, KC_##k06, KC_##k07, KC_##k08, KC_##k09, KC_##k0a, KC_##k0b, \
+  KC_##k10, KC_##k11, KC_##k12, KC_##k13, KC_##k14, KC_##k15, KC_##k16, KC_##k17, KC_##k18, KC_##k19, KC_##k1a, KC_##k1b, \
+  KC_##k20, KC_##k21, KC_##k22, KC_##k23, KC_##k24, KC_##k25, KC_##k26, KC_##k27, KC_##k28, KC_##k29, KC_##k2a, KC_##k2b, \
+  KC_##k30, KC_##k31, KC_##k32, KC_##k33, KC_##k34, KC_##k35, KC_##k36, KC_##k37, KC_##k38, KC_##k39, KC_##k3a, KC_##k3b \
+)
+
+#define KEYMAP LAYOUT_ortho_4x12
+#define LAYOUT_planck_mit  LAYOUT_planck_1x2uC
+#define LAYOUT_planck_grid LAYOUT_ortho_4x12
+#define LAYOUT_kc_ortho_4x12 LAYOUT_kc
+#define KC_KEYMAP LAYOUT_kc
 
 #endif