Fix Per Key LED Indicator Callbacks (qmk#18450)

Co-authored-by: Dasky <32983009+daskygit@users.noreply.github.com> Co-authored-by: Nick Brassel <nick@tzarc.org>
ramonimbao · Nov 28, 2022 · b997ca1 · b997ca1
1 parent 6beba62
commit b997ca1
Show file tree

Hide file tree

Showing 218 changed files with 1,430 additions and 1,271 deletions.
diff --git a/docs/feature_led_matrix.md b/docs/feature_led_matrix.md
@@ -441,8 +441,12 @@ Where `28` is an unused index from `eeconfig.h`.
 
 If you want to set custom indicators, such as an LED for Caps Lock, or layer indication, you can use the `led_matrix_indicators_kb` or `led_matrix_indicators_user` function for that: 
 ```c
-void led_matrix_indicators_kb(void) {
+bool led_matrix_indicators_kb(void) {
+    if (!led_matrix_indicators_user()) {
+        return false;
+    }
     led_matrix_set_value(index, value);
+    return true;
 }
 ```
 
@@ -451,5 +455,6 @@ In addition, there are the advanced indicator functions.  These are aimed at tho
 ```c
 void led_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
     LED_MATRIX_INDICATOR_SET_VALUE(index, value);
+    return false;
 }
 ```
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md
@@ -888,37 +888,43 @@ Where `28` is an unused index from `eeconfig.h`.
 
 If you want to set custom indicators, such as an LED for Caps Lock, or layer indication, you can use the `rgb_matrix_indicators_kb` or `rgb_matrix_indicators_user` function for that:
 ```c
-void rgb_matrix_indicators_kb(void) {
+bool rgb_matrix_indicators_kb(void) {
+    if (!rgb_matrix_indicators_user()) {
+        return false;
+    }
     rgb_matrix_set_color(index, red, green, blue);
+    return true;
 }
 ```
 
 In addition, there are the advanced indicator functions.  These are aimed at those with heavily customized displays, where rendering every LED per cycle is expensive.  Such as some of the "drashna" layouts.  This includes a special macro to help make this easier to use: `RGB_MATRIX_INDICATOR_SET_COLOR(i, r, g, b)`.
 
 ```c
-void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
+bool rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
     RGB_MATRIX_INDICATOR_SET_COLOR(index, red, green, blue);
+    return false;
 }
 ```
 
 ### Indicator Examples :id=indicator-examples
 
 Caps Lock indicator on alphanumeric flagged keys:
 ```c
-void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
+bool rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
     if (host_keyboard_led_state().caps_lock) {
         for (uint8_t i = led_min; i <= led_max; i++) {
             if (g_led_config.flags[i] & LED_FLAG_KEYLIGHT) {
                 rgb_matrix_set_color(i, RGB_RED);
             }
         }
     }
+    return false;
 }
 ```
 
 Layer indicator on all keys:
 ```c
-void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
+bool rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
     for (uint8_t i = led_min; i <= led_max; i++) {
         switch(get_highest_layer(layer_state|default_layer_state)) {
             case 2:
@@ -931,12 +937,13 @@ void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
                 break;
         }
     }
+    return false;
 }
 ```
 
 Layer indicator only on keys with configured keycodes:
 ```c
-void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
+bool rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
     if (get_highest_layer(layer_state) > 0) {
         uint8_t layer = get_highest_layer(layer_state);
 
@@ -951,6 +958,7 @@ void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
             }
         }
     }
+    return false;
 }
 ```
 
@@ -961,7 +969,7 @@ void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
 This example sets the modifiers to be a specific color based on the layer state.  You can use a switch case here, instead, if you would like.  This uses HSV and then converts to RGB, because this allows the brightness to be limited (important when using the WS2812 driver).
 
 ```c
-void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
+bool rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
     HSV hsv = {0, 255, 255};
 
     if (layer_state_is(layer_state, 2)) {
@@ -980,18 +988,20 @@ void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
             rgb_matrix_set_color(i, rgb.r, rgb.g, rgb.b);
         }
     }
+    return false;
 }
 ```
 
 If you want to indicate a Host LED status (caps lock, num lock, etc), you can use something like this to light up the caps lock key:
 
 ```c
-void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
+bool rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
     if (host_keyboard_led_state().caps_lock) {
         RGB_MATRIX_INDICATOR_SET_COLOR(5, 255, 255, 255); // assuming caps lock is at led #5
     } else {
         RGB_MATRIX_INDICATOR_SET_COLOR(5, 0, 0, 0);
     }
+    return false;
 }
 ```
 

diff --git a/keyboards/4pplet/perk60_iso/rev_a/rev_a.c b/keyboards/4pplet/perk60_iso/rev_a/rev_a.c
@@ -114,13 +114,19 @@ led_config_t g_led_config = {
     }
 };
 
-__attribute__((weak)) void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
+bool rgb_matrix_indicators_advanced_kb(uint8_t led_min, uint8_t led_max) {
+    if (!rgb_matrix_indicators_advanced_user(led_min, led_max)) {
+        return false;
+    }
+
     if (host_keyboard_led_state().caps_lock && CAPS_LOCK_ENABLE) {
         for (uint8_t i = led_min; i <= led_max; i++) {
             if (g_led_config.flags[i] & CAPS_LED_GROUP) {
                 rgb_matrix_set_color(i, CAPS_LOCK_COLOR);
             }
         }
     }
+
+    return true;
 }
 #endif
diff --git a/keyboards/abatskeyboardclub/nayeon/nayeon.c b/keyboards/abatskeyboardclub/nayeon/nayeon.c
@@ -32,13 +32,16 @@ led_config_t g_led_config = {{
     LED_FLAG_INDICATOR, LED_FLAG_INDICATOR
 }};
 
-void rgb_matrix_indicators_advanced_kb(uint8_t led_min, uint8_t led_max) {
+bool rgb_matrix_indicators_advanced_kb(uint8_t led_min, uint8_t led_max) {
+    if (!rgb_matrix_indicators_advanced_user(led_min, led_max)) {
+        return false;
+    }
     if (!host_keyboard_led_state().caps_lock) {
         RGB_MATRIX_INDICATOR_SET_COLOR(0, 0, 0, 0);
     }
     if (!host_keyboard_led_state().scroll_lock) {
         RGB_MATRIX_INDICATOR_SET_COLOR(1, 0, 0, 0);
     }
 
-    rgb_matrix_indicators_advanced_user(led_min, led_max);
+    return true;
 }
diff --git a/keyboards/an_achronism/tetromino/keymaps/indicators/keymap.c b/keyboards/an_achronism/tetromino/keymaps/indicators/keymap.c
@@ -68,7 +68,7 @@ void keyboard_post_init_user(void) {
 };
 
 // Custom RGB indicator behaviour:
-void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
+bool rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
     uint8_t led_processed_count = 0;
     for (uint8_t row = 0; row < MATRIX_ROWS; ++row) {
         for (uint8_t col = 0; col < MATRIX_COLS; ++col) {
@@ -115,10 +115,11 @@ void rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
                                 break;
                             default:
                                 break;
-                        }   
+                        }
                     }
                 }
             }
         }
     }
+    return false;
 }
diff --git a/keyboards/axolstudio/yeti/hotswap/hotswap.c b/keyboards/axolstudio/yeti/hotswap/hotswap.c
@@ -21,20 +21,20 @@ const is31_led g_is31_leds[RGB_MATRIX_LED_COUNT] = {
     { 0, B_1,  A_1,  C_1 },
     { 0, B_2,  A_2,  C_2 },
     { 0, B_3,  A_3,  C_3 },
-    { 0, B_4,  A_4,  C_4 },  
-    { 0, B_5,  A_5,  C_5 },  
-    { 0, B_6,  A_6,  C_6 },   
-    { 0, B_7,  A_7,  C_7 }, 
-    { 0, B_8,  A_8,  C_8 },  
-    { 0, B_9,  A_9,  C_9 },  
-    { 0, B_10, A_10, C_10 },  
-    { 0, B_11, A_11, C_11 }, 
-    { 0, B_12, A_12, C_12 },     
-    { 0, B_13, A_13, C_13 },                          
+    { 0, B_4,  A_4,  C_4 },
+    { 0, B_5,  A_5,  C_5 },
+    { 0, B_6,  A_6,  C_6 },
+    { 0, B_7,  A_7,  C_7 },
+    { 0, B_8,  A_8,  C_8 },
+    { 0, B_9,  A_9,  C_9 },
+    { 0, B_10, A_10, C_10 },
+    { 0, B_11, A_11, C_11 },
+    { 0, B_12, A_12, C_12 },
+    { 0, B_13, A_13, C_13 },
     { 0, B_14, A_14, C_14 },
     { 0, B_15, A_15, C_15 },
-    
-    { 0, E_1,  D_1,  F_1 },        
+
+    { 0, E_1,  D_1,  F_1 },
     { 0, E_2,  D_2,  F_2 },
     { 0, E_3,  D_3,  F_3 },
     { 0, E_4,  D_4,  F_4 },
@@ -46,13 +46,13 @@ const is31_led g_is31_leds[RGB_MATRIX_LED_COUNT] = {
     { 0, E_10, D_10, F_10 },
     { 0, E_11, D_11, F_11 },
     { 0, E_12, D_12, F_12 },
-    { 0, E_13, D_13, F_13 },    
-    { 0, E_14, D_14, F_14 },    
+    { 0, E_13, D_13, F_13 },
+    { 0, E_14, D_14, F_14 },
     { 0, E_15, D_15, F_15 },
-    
-    { 0, H_1,  G_1,  I_1 }, 
-    { 0, H_2,  G_2,  I_2 }, 
-    { 0, H_3,  G_3,  I_3 }, 
+
+    { 0, H_1,  G_1,  I_1 },
+    { 0, H_2,  G_2,  I_2 },
+    { 0, H_3,  G_3,  I_3 },
     { 0, H_4,  G_4,  I_4 },
     { 0, H_5,  G_5,  I_5 },
     { 0, H_6,  G_6,  I_6 },
@@ -67,25 +67,25 @@ const is31_led g_is31_leds[RGB_MATRIX_LED_COUNT] = {
 
     { 0, K_2,  J_2,  L_2 },
     { 0, K_3,  J_3,  L_3 },
-    { 0, K_4,  J_4,  L_4 },    
+    { 0, K_4,  J_4,  L_4 },
     { 0, K_5,  J_5,  L_5 },
     { 0, K_6,  J_6,  L_6 },
-    { 0, K_7,  J_7,  L_7 },    
-    { 0, K_8,  J_8,  L_8 },    
-    { 0, K_9,  J_9,  L_9 },    
+    { 0, K_7,  J_7,  L_7 },
+    { 0, K_8,  J_8,  L_8 },
+    { 0, K_9,  J_9,  L_9 },
     { 0, K_10, J_10, L_10 },
-    { 0, K_11, J_11, L_11 },    
-    { 0, K_12, J_12, L_12 },    
-    { 0, K_13, J_13, L_13 },                       
+    { 0, K_11, J_11, L_11 },
+    { 0, K_12, J_12, L_12 },
+    { 0, K_13, J_13, L_13 },
     { 0, K_14, J_14, L_14 },
 
     { 0, K_1,  J_1,  L_1 },
     { 0, K_16, J_16, L_16 },
     { 0, H_16, G_16, I_16 },
-    { 0, E_16, D_16, F_16 },    
-    { 0, B_16, A_16, C_16 },            
+    { 0, E_16, D_16, F_16 },
+    { 0, B_16, A_16, C_16 },
     { 0, H_15, G_15, I_15 },
-    { 0, K_15, J_15, L_15 },    
+    { 0, K_15, J_15, L_15 },
 };
 
 led_config_t g_led_config = {
@@ -102,17 +102,20 @@ led_config_t g_led_config = {
         {16,48},{32,48},{48,48},{64,48},{80,48},{96,48},{112,48},{128,48},{144,48},{160,48},{176,48},{192,48},{224,48},
         {16,64},{48,64},{80,64},{96,64},{128,64},{160,64},{224,64}
     }, {
-        1, 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 1, 
+        1, 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 1,
         1, 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 1,
         1, 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,    1,
            1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,    1,
            1,    1,    4, 1,    4,    1,          1
     }
 };
 #endif
-__attribute__ ((weak))
-void rgb_matrix_indicators_user(void) {
+bool rgb_matrix_indicators_kb(void) {
+    if (!rgb_matrix_indicators_user()) {
+        return false;
+    }
     if (host_keyboard_led_state().caps_lock) {
         rgb_matrix_set_color(31, 0xFF, 0xFF, 0xFF);
     }
+    return true;
 }
diff --git a/keyboards/bandominedoni/keymaps/led/keymap.c b/keyboards/bandominedoni/keymaps/led/keymap.c
@@ -205,7 +205,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 }
 
 #ifdef RGB_MATRIX_ENABLE
-void rgb_matrix_indicators_user(void) {
+bool rgb_matrix_indicators_user(void) {
     if (rgb_matrix_is_enabled()) {  // turn the lights on when it is enabled.
         uint8_t layer = get_highest_layer(layer_state);
         switch (layer) {
@@ -250,5 +250,6 @@ void rgb_matrix_indicators_user(void) {
                 break;
         }
     }
+    return false;
 }
 #endif
diff --git a/keyboards/bandominedoni/keymaps/lednotg/keymap.c b/keyboards/bandominedoni/keymaps/lednotg/keymap.c
@@ -205,7 +205,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 }
 
 #ifdef RGB_MATRIX_ENABLE
-void rgb_matrix_indicators_user(void) {
+bool rgb_matrix_indicators_user(void) {
     if (rgb_matrix_is_enabled()) {  // turn the lights on when it is enabled.
         uint8_t layer = biton32(layer_state);
         switch (layer) {
@@ -250,5 +250,6 @@ void rgb_matrix_indicators_user(void) {
                 break;
         }
     }
+    return false;
 }
 #endif
diff --git a/keyboards/bandominedoni/keymaps/via/keymap.c b/keyboards/bandominedoni/keymaps/via/keymap.c
@@ -141,7 +141,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 }
 
 #ifdef RGB_MATRIX_ENABLE
-void rgb_matrix_indicators_user(void) {
+bool rgb_matrix_indicators_user(void) {
     if (rgb_matrix_is_enabled()) {  // turn the lights on when it is enabled.
         uint8_t layer = get_highest_layer(layer_state);
         switch (layer) {
@@ -177,5 +177,6 @@ void rgb_matrix_indicators_user(void) {
                 break;
         }
     }
+    return false;
 }
 #endif