Merge remote-tracking branch 'origin/master' into develop

keyboards/bastardkb/skeletyl/skeletyl.c

@@ -1,4 +1,4 @@
-/* 
+/*
  * Copyright 2021 Quentin LEBASTARD <qlebastard@gmail.com>
  *
  * This program is free software: you can redistribute it and/or modify
@@ -17,41 +17,65 @@
 
 #include "skeletyl.h"
 
+/**
+ * LEDs index.
+ *
+ * ╭────────────────────╮                 ╭────────────────────╮
+ *    2   3   8   9  12                     30  27  26  21  20
+ * ├────────────────────┤                 ├────────────────────┤
+ *    1   4   7  10  13                     31  28  25  22  19
+ * ├────────────────────┤                 ├────────────────────┤
+ *    0   5   6  11  14                     32  29  24  23  18
+ * ╰────────────────────╯                 ╰────────────────────╯
+ *                   15  16  17     35  34  33
+ *                 ╰────────────╯ ╰────────────╯
+ */
+// clang-format off
 #ifdef RGB_MATRIX_ENABLE
 led_config_t g_led_config = { {
-    // left
-    {  0,  5,  6, 11, 12 },
-    {  1,  4,  7, 10, 13 },
-    {  2,  3,  8,  9, 14 },
-    { 15, NO_LED, 16, 17, NO_LED },
-    // right
-    { 18, 23, 24, 29, 30 },
-    { 19, 22, 25, 28, 31 },
-    { 20, 21, 26, 27, 32 },
-    { 33, NO_LED, 34, 35, NO_LED }
+    /* Key Matrix to LED index. */
+    // Left split.
+    {      2,      3,      8,      9,     12 }, // Top row
+    {      1,      4,      7,     10,     13 }, // Middle row
+    {      0,      5,      6,     11,     14 }, // Bottom row
+    {     17, NO_LED,     15,     16, NO_LED }, // Thumb cluster
+    // Right split.
+    {     20,     21,     26,     27,     30 }, // Top row
+    {     19,     22,     25,     28,     31 }, // Middle row
+    {     18,     23,     24,     29,     32 }, // Bottom row
+    {     35, NO_LED,     33,     34, NO_LED }, // Thumb cluster
 }, {
-    // left
-    {   0,   0 }, {   0,  21 }, {   0,  42 }, // col 1
-    {  25,  42 }, {  25,  21 }, {  25,   0 }, // col 2
-    {  50,   0 }, {  50,  21 }, {  50,  42 },
-    {  74,  42 }, {  74,  21 }, {  74,   0 },
-    {  99,   0 }, {  99,  21 }, {  99,  42 },
-    {  50,  64 }, {  74,  64 }, {  99,  64 }, // left thumb cluster
-    // right
-    { 224,   0 }, { 224,  21 }, { 224,  42 }, // col 10
-    { 198,  42 }, { 198,  21 }, { 198,   0 }, // col 9
-    { 174,   0 }, { 174,  21 }, { 174,  42 },
-    { 149,  42 }, { 149,  21 }, { 149,   0 },
-    { 124,   0 }, { 124,  21 }, { 124,  42 },
-    { 174,  64 }, { 149,  64 }, { 124,  64 }  // right thumb cluster
+    /* LED index to physical position. */
+    // Left split.
+    /* index=0  */ {   0,  42 }, {   0,  21 }, {   0,   0 }, // col 1 (left most)
+    /* index=3  */ {  18,   0 }, {  18,  21 }, {  18,  42 }, // col 2
+    /* index=6  */ {  36,  42 }, {  36,  21 }, {  36,   0 },
+    /* index=9  */ {  54,   0 }, {  54,  21 }, {  54,  42 },
+    /* index=12 */ {  72,   0 }, {  72,  21 }, {  72,  42 },
+    /* index=15 */ {  72,  64 }, {  90,  64 }, { 108,  64 }, // Thumb cluster
+    // Right split.
+    /* index=18 */ { 224,  42 }, { 224,  21 }, { 224,   0 }, // col 10 (right most)
+    /* index=21 */ { 206,   0 }, { 206,  21 }, { 206,  42 }, // col 9
+    /* index=24 */ { 188,  42 }, { 188,  21 }, { 188,   0 },
+    /* index=27 */ { 170,   0 }, { 170,  21 }, { 170,  42 },
+    /* index=30 */ { 152,   0 }, { 152,  21 }, { 152,  42 },
+    /* index=33 */ { 152,  64 }, { 134,  64 }, { 116,  64 }, // Thumb cluster
 }, {
-    // left
-    4, 4, 4, 4, 4, 4, 4,
-    4, 4, 4, 4, 4, 4, 4, 4,
-    2, 2, 2,
-    // right
-    4, 4, 4, 4, 4, 4, 4,
-    4, 4, 4, 4, 4, 4, 4, 4,
-    2, 2, 2
+    /* LED index to flag. */
+    // Left split.
+    /* index=0  */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, // col 1
+    /* index=3  */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, // col 2
+    /* index=6  */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT,
+    /* index=9  */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT,
+    /* index=12 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT,
+    /* index=15 */ LED_FLAG_MODIFIER, LED_FLAG_MODIFIER, LED_FLAG_MODIFIER, // Thumb cluster
+    // Right split.
+    /* index=18 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, // col 10
+    /* index=21 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, // col 9
+    /* index=24 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT,
+    /* index=27 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT,
+    /* index=30 */ LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT, LED_FLAG_KEYLIGHT,
+    /* index=33 */ LED_FLAG_MODIFIER, LED_FLAG_MODIFIER, LED_FLAG_MODIFIER, // Thumb cluster
 } };
 #endif
+// clang-format on

keyboards/bastardkb/skeletyl/skeletyl.h

@@ -1,4 +1,4 @@
-/* 
+/*
  * Copyright 2021 Quentin LEBASTARD <qlebastard@gmail.com>
  *
  * This program is free software: you can redistribute it and/or modify
@@ -15,23 +15,24 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-
 #pragma once
 #include "quantum.h"
 
-#define LAYOUT_split_3x5_3( \
-	k00, k01, k02, k03, k04,     			k44, k43, k42, k41, k40, \
-	k10, k11, k12, k13, k14,	    		k54, k53, k52, k51, k50, \
-	k20, k21, k22, k23, k24,    			k64, k63, k62, k61, k60, \
-		       k33, k34, k31,		        k71, k74, k73  \
-)\
-{\
-	{ k00, k01, k02, k03, k04 }, \
-	{ k10, k11, k12, k13, k14 }, \
-	{ k20, k21, k22, k23, k24 }, \
-	{ k31, KC_NO, k33, k34, KC_NO }, \
-	{ k40, k41, k42, k43, k44 }, \
-	{ k50, k51, k52, k53, k54 }, \
-	{ k60, k61, k62, k63, k64 }, \
-	{ k71, KC_NO, k73, k74, KC_NO }, \
+// clang-format off
+#define LAYOUT_split_3x5_3(                             \
+  k00, k01, k02, k03, k04,     k44, k43, k42, k41, k40, \
+  k10, k11, k12, k13, k14,     k54, k53, k52, k51, k50, \
+  k20, k21, k22, k23, k24,     k64, k63, k62, k61, k60, \
+            k33, k34, k31,     k71, k74, k73            \
+)                                                       \
+{                                                       \
+  {   k00,   k01,   k02,   k03,   k04 },                \
+  {   k10,   k11,   k12,   k13,   k14 },                \
+  {   k20,   k21,   k22,   k23,   k24 },                \
+  {   k31, KC_NO,   k33,   k34, KC_NO },                \
+  {   k40,   k41,   k42,   k43,   k44 },                \
+  {   k50,   k51,   k52,   k53,   k54 },                \
+  {   k60,   k61,   k62,   k63,   k64 },                \
+  {   k71, KC_NO,   k73,   k74, KC_NO },                \
 }
+// clang-format on