Move RGBLight code into its own folder (#13312)

1 files changed, 1391 insertions, 0 deletions

diff --git a/quantum/rgblight/rgblight.c b/quantum/rgblight/rgblight.c
new file mode 100644
index 0000000000..54face173c
--- /dev/null
+++ b/quantum/rgblight/rgblight.c
@@ -0,0 +1,1391 @@
+/* Copyright 2016-2017 Yang Liu
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#include <math.h>
+#include <string.h>
+#include <stdlib.h>
+#ifdef __AVR__
+#    include <avr/eeprom.h>
+#    include <avr/interrupt.h>
+#endif
+#ifdef EEPROM_ENABLE
+#    include "eeprom.h"
+#endif
+#ifdef STM32_EEPROM_ENABLE
+#    include <hal.h>
+#    include "eeprom_stm32.h"
+#endif
+#include "wait.h"
+#include "progmem.h"
+#include "sync_timer.h"
+#include "rgblight.h"
+#include "color.h"
+#include "debug.h"
+#include "led_tables.h"
+#include <lib/lib8tion/lib8tion.h>
+#ifdef VELOCIKEY_ENABLE
+#    include "velocikey.h"
+#endif
+
+#ifndef MIN
+#    define MIN(a, b) (((a) < (b)) ? (a) : (b))
+#endif
+#ifndef MAX
+#    define MAX(a, b) (((a) > (b)) ? (a) : (b))
+#endif
+
+#ifdef RGBLIGHT_SPLIT
+/* for split keyboard */
+#    define RGBLIGHT_SPLIT_SET_CHANGE_MODE rgblight_status.change_flags |= RGBLIGHT_STATUS_CHANGE_MODE
+#    define RGBLIGHT_SPLIT_SET_CHANGE_HSVS rgblight_status.change_flags |= RGBLIGHT_STATUS_CHANGE_HSVS
+#    define RGBLIGHT_SPLIT_SET_CHANGE_MODEHSVS rgblight_status.change_flags |= (RGBLIGHT_STATUS_CHANGE_MODE | RGBLIGHT_STATUS_CHANGE_HSVS)
+#    define RGBLIGHT_SPLIT_SET_CHANGE_LAYERS rgblight_status.change_flags |= RGBLIGHT_STATUS_CHANGE_LAYERS
+#    define RGBLIGHT_SPLIT_SET_CHANGE_TIMER_ENABLE rgblight_status.change_flags |= RGBLIGHT_STATUS_CHANGE_TIMER
+#    define RGBLIGHT_SPLIT_ANIMATION_TICK rgblight_status.change_flags |= RGBLIGHT_STATUS_ANIMATION_TICK
+#else
+#    define RGBLIGHT_SPLIT_SET_CHANGE_MODE
+#    define RGBLIGHT_SPLIT_SET_CHANGE_HSVS
+#    define RGBLIGHT_SPLIT_SET_CHANGE_MODEHSVS
+#    define RGBLIGHT_SPLIT_SET_CHANGE_LAYERS
+#    define RGBLIGHT_SPLIT_SET_CHANGE_TIMER_ENABLE
+#    define RGBLIGHT_SPLIT_ANIMATION_TICK
+#endif
+
+#define _RGBM_SINGLE_STATIC(sym) RGBLIGHT_MODE_##sym,
+#define _RGBM_SINGLE_DYNAMIC(sym)
+#define _RGBM_MULTI_STATIC(sym) RGBLIGHT_MODE_##sym,
+#define _RGBM_MULTI_DYNAMIC(sym)
+#define _RGBM_TMP_STATIC(sym, msym) RGBLIGHT_MODE_##sym,
+#define _RGBM_TMP_DYNAMIC(sym, msym)
+static uint8_t static_effect_table[] = {
+#include "rgblight_modes.h"
+};
+
+#define _RGBM_SINGLE_STATIC(sym) RGBLIGHT_MODE_##sym,
+#define _RGBM_SINGLE_DYNAMIC(sym) RGBLIGHT_MODE_##sym,
+#define _RGBM_MULTI_STATIC(sym) RGBLIGHT_MODE_##sym,
+#define _RGBM_MULTI_DYNAMIC(sym) RGBLIGHT_MODE_##sym,
+#define _RGBM_TMP_STATIC(sym, msym) RGBLIGHT_MODE_##msym,
+#define _RGBM_TMP_DYNAMIC(sym, msym) RGBLIGHT_MODE_##msym,
+static uint8_t mode_base_table[] = {
+    0,  // RGBLIGHT_MODE_zero
+#include "rgblight_modes.h"
+};
+
+#if !defined(RGBLIGHT_DEFAULT_MODE)
+#    define RGBLIGHT_DEFAULT_MODE RGBLIGHT_MODE_STATIC_LIGHT
+#endif
+
+#if !defined(RGBLIGHT_DEFAULT_HUE)
+#    define RGBLIGHT_DEFAULT_HUE 0
+#endif
+
+#if !defined(RGBLIGHT_DEFAULT_SAT)
+#    define RGBLIGHT_DEFAULT_SAT UINT8_MAX
+#endif
+
+#if !defined(RGBLIGHT_DEFAULT_VAL)
+#    define RGBLIGHT_DEFAULT_VAL RGBLIGHT_LIMIT_VAL
+#endif
+
+#if !defined(RGBLIGHT_DEFAULT_SPD)
+#    define RGBLIGHT_DEFAULT_SPD 0
+#endif
+
+static inline int is_static_effect(uint8_t mode) { return memchr(static_effect_table, mode, sizeof(static_effect_table)) != NULL; }
+
+#ifdef RGBLIGHT_LED_MAP
+const uint8_t led_map[] PROGMEM = RGBLIGHT_LED_MAP;
+#endif
+
+#ifdef RGBLIGHT_EFFECT_STATIC_GRADIENT
+__attribute__((weak)) const uint8_t RGBLED_GRADIENT_RANGES[] PROGMEM = {255, 170, 127, 85, 64};
+#endif
+
+rgblight_config_t rgblight_config;
+rgblight_status_t rgblight_status         = {.timer_enabled = false};
+bool              is_rgblight_initialized = false;
+
+#ifdef RGBLIGHT_SLEEP
+static bool is_suspended;
+static bool pre_suspend_enabled;
+#endif
+
+#ifdef RGBLIGHT_USE_TIMER
+animation_status_t animation_status = {};
+#endif
+
+#ifndef LED_ARRAY
+LED_TYPE led[RGBLED_NUM];
+#    define LED_ARRAY led
+#endif
+
+#ifdef RGBLIGHT_LAYERS
+rgblight_segment_t const *const *rgblight_layers = NULL;
+#endif
+
+rgblight_ranges_t rgblight_ranges = {0, RGBLED_NUM, 0, RGBLED_NUM, RGBLED_NUM};
+
+void rgblight_set_clipping_range(uint8_t start_pos, uint8_t num_leds) {
+    rgblight_ranges.clipping_start_pos = start_pos;
+    rgblight_ranges.clipping_num_leds  = num_leds;
+}
+
+void rgblight_set_effect_range(uint8_t start_pos, uint8_t num_leds) {
+    if (start_pos >= RGBLED_NUM) return;
+    if (start_pos + num_leds > RGBLED_NUM) return;
+    rgblight_ranges.effect_start_pos = start_pos;
+    rgblight_ranges.effect_end_pos   = start_pos + num_leds;
+    rgblight_ranges.effect_num_leds  = num_leds;
+}
+
+__attribute__((weak)) RGB rgblight_hsv_to_rgb(HSV hsv) { return hsv_to_rgb(hsv); }
+
+void sethsv_raw(uint8_t hue, uint8_t sat, uint8_t val, LED_TYPE *led1) {
+    HSV hsv = {hue, sat, val};
+    RGB rgb = rgblight_hsv_to_rgb(hsv);
+    setrgb(rgb.r, rgb.g, rgb.b, led1);
+}
+
+void sethsv(uint8_t hue, uint8_t sat, uint8_t val, LED_TYPE *led1) { sethsv_raw(hue, sat, val > RGBLIGHT_LIMIT_VAL ? RGBLIGHT_LIMIT_VAL : val, led1); }
+
+void setrgb(uint8_t r, uint8_t g, uint8_t b, LED_TYPE *led1) {
+    led1->r = r;
+    led1->g = g;
+    led1->b = b;
+#ifdef RGBW
+    led1->w = 0;
+#endif
+}
+
+void rgblight_check_config(void) {
+    /* Add some out of bound checks for RGB light config */
+
+    if (rgblight_config.mode < RGBLIGHT_MODE_STATIC_LIGHT) {
+        rgblight_config.mode = RGBLIGHT_MODE_STATIC_LIGHT;
+    } else if (rgblight_config.mode > RGBLIGHT_MODES) {
+        rgblight_config.mode = RGBLIGHT_MODES;
+    }
+
+    if (rgblight_config.val > RGBLIGHT_LIMIT_VAL) {
+        rgblight_config.val = RGBLIGHT_LIMIT_VAL;
+    }
+}
+
+uint32_t eeconfig_read_rgblight(void) {
+#ifdef EEPROM_ENABLE
+    return eeprom_read_dword(EECONFIG_RGBLIGHT);
+#else
+    return 0;
+#endif
+}
+
+void eeconfig_update_rgblight(uint32_t val) {
+#ifdef EEPROM_ENABLE
+    rgblight_check_config();
+    eeprom_update_dword(EECONFIG_RGBLIGHT, val);
+#endif
+}
+
+void eeconfig_update_rgblight_current(void) { eeconfig_update_rgblight(rgblight_config.raw); }
+
+void eeconfig_update_rgblight_default(void) {
+    rgblight_config.enable = 1;
+    rgblight_config.mode   = RGBLIGHT_DEFAULT_MODE;
+    rgblight_config.hue    = RGBLIGHT_DEFAULT_HUE;
+    rgblight_config.sat    = RGBLIGHT_DEFAULT_SAT;
+    rgblight_config.val    = RGBLIGHT_DEFAULT_VAL;
+    rgblight_config.speed  = RGBLIGHT_DEFAULT_SPD;
+    RGBLIGHT_SPLIT_SET_CHANGE_MODEHSVS;
+    eeconfig_update_rgblight(rgblight_config.raw);
+}
+
+void eeconfig_debug_rgblight(void) {
+    dprintf("rgblight_config EEPROM:\n");
+    dprintf("rgblight_config.enable = %d\n", rgblight_config.enable);
+    dprintf("rghlight_config.mode = %d\n", rgblight_config.mode);
+    dprintf("rgblight_config.hue = %d\n", rgblight_config.hue);
+    dprintf("rgblight_config.sat = %d\n", rgblight_config.sat);
+    dprintf("rgblight_config.val = %d\n", rgblight_config.val);
+    dprintf("rgblight_config.speed = %d\n", rgblight_config.speed);
+}
+
+void rgblight_init(void) {
+    /* if already initialized, don't do it again.
+       If you must do it again, extern this and set to false, first.
+       This is a dirty, dirty hack until proper hooks can be added for keyboard startup. */
+    if (is_rgblight_initialized) {
+        return;
+    }
+
+    dprintf("rgblight_init called.\n");
+    dprintf("rgblight_init start!\n");
+    if (!eeconfig_is_enabled()) {
+        dprintf("rgblight_init eeconfig is not enabled.\n");
+        eeconfig_init();
+        eeconfig_update_rgblight_default();
+    }
+    rgblight_config.raw = eeconfig_read_rgblight();
+    RGBLIGHT_SPLIT_SET_CHANGE_MODEHSVS;
+    if (!rgblight_config.mode) {
+        dprintf("rgblight_init rgblight_config.mode = 0. Write default values to EEPROM.\n");
+        eeconfig_update_rgblight_default();
+        rgblight_config.raw = eeconfig_read_rgblight();
+    }
+    rgblight_check_config();
+
+    eeconfig_debug_rgblight();  // display current eeprom values
+
+    rgblight_timer_init();  // setup the timer
+
+    if (rgblight_config.enable) {
+        rgblight_mode_noeeprom(rgblight_config.mode);
+    }
+
+    is_rgblight_initialized = true;
+}
+
+void rgblight_reload_from_eeprom(void) {
+    /* Reset back to what we have in eeprom */
+    rgblight_config.raw = eeconfig_read_rgblight();
+    RGBLIGHT_SPLIT_SET_CHANGE_MODEHSVS;
+    rgblight_check_config();
+    eeconfig_debug_rgblight();  // display current eeprom values
+    if (rgblight_config.enable) {
+        rgblight_mode_noeeprom(rgblight_config.mode);
+    }
+}
+
+uint32_t rgblight_read_dword(void) { return rgblight_config.raw; }
+
+void rgblight_update_dword(uint32_t dword) {
+    RGBLIGHT_SPLIT_SET_CHANGE_MODEHSVS;
+    rgblight_config.raw = dword;
+    if (rgblight_config.enable)
+        rgblight_mode_noeeprom(rgblight_config.mode);
+    else {
+        rgblight_timer_disable();
+        rgblight_set();
+    }
+}
+
+void rgblight_increase(void) {
+    uint8_t mode = 0;
+    if (rgblight_config.mode < RGBLIGHT_MODES) {
+        mode = rgblight_config.mode + 1;
+    }
+    rgblight_mode(mode);
+}
+void rgblight_decrease(void) {
+    uint8_t mode = 0;
+    // Mode will never be < 1. If it ever is, eeprom needs to be initialized.
+    if (rgblight_config.mode > RGBLIGHT_MODE_STATIC_LIGHT) {
+        mode = rgblight_config.mode - 1;
+    }
+    rgblight_mode(mode);
+}
+void rgblight_step_helper(bool write_to_eeprom) {
+    uint8_t mode = 0;
+    mode         = rgblight_config.mode + 1;
+    if (mode > RGBLIGHT_MODES) {
+        mode = 1;
+    }
+    rgblight_mode_eeprom_helper(mode, write_to_eeprom);
+}
+void rgblight_step_noeeprom(void) { rgblight_step_helper(false); }
+void rgblight_step(void) { rgblight_step_helper(true); }
+void rgblight_step_reverse_helper(bool write_to_eeprom) {
+    uint8_t mode = 0;
+    mode         = rgblight_config.mode - 1;
+    if (mode < 1) {
+        mode = RGBLIGHT_MODES;
+    }
+    rgblight_mode_eeprom_helper(mode, write_to_eeprom);
+}
+void rgblight_step_reverse_noeeprom(void) { rgblight_step_reverse_helper(false); }
+void rgblight_step_reverse(void) { rgblight_step_reverse_helper(true); }
+
+uint8_t rgblight_get_mode(void) {
+    if (!rgblight_config.enable) {
+        return false;
+    }
+
+    return rgblight_config.mode;
+}
+
+void rgblight_mode_eeprom_helper(uint8_t mode, bool write_to_eeprom) {
+    if (!rgblight_config.enable) {
+        return;
+    }
+    if (mode < RGBLIGHT_MODE_STATIC_LIGHT) {
+        rgblight_config.mode = RGBLIGHT_MODE_STATIC_LIGHT;
+    } else if (mode > RGBLIGHT_MODES) {
+        rgblight_config.mode = RGBLIGHT_MODES;
+    } else {
+        rgblight_config.mode = mode;
+    }
+    RGBLIGHT_SPLIT_SET_CHANGE_MODE;
+    if (write_to_eeprom) {
+        eeconfig_update_rgblight(rgblight_config.raw);
+        dprintf("rgblight mode [EEPROM]: %u\n", rgblight_config.mode);
+    } else {
+        dprintf("rgblight mode [NOEEPROM]: %u\n", rgblight_config.mode);
+    }
+    if (is_static_effect(rgblight_config.mode)) {
+        rgblight_timer_disable();
+    } else {
+        rgblight_timer_enable();
+    }
+#ifdef RGBLIGHT_USE_TIMER
+    animation_status.restart = true;
+#endif
+    rgblight_sethsv_noeeprom(rgblight_config.hue, rgblight_config.sat, rgblight_config.val);
+}
+
+void rgblight_mode(uint8_t mode) { rgblight_mode_eeprom_helper(mode, true); }
+
+void rgblight_mode_noeeprom(uint8_t mode) { rgblight_mode_eeprom_helper(mode, false); }
+
+void rgblight_toggle(void) {
+    dprintf("rgblight toggle [EEPROM]: rgblight_config.enable = %u\n", !rgblight_config.enable);
+    if (rgblight_config.enable) {
+        rgblight_disable();
+    } else {
+        rgblight_enable();
+    }
+}
+
+void rgblight_toggle_noeeprom(void) {
+    dprintf("rgblight toggle [NOEEPROM]: rgblight_config.enable = %u\n", !rgblight_config.enable);
+    if (rgblight_config.enable) {
+        rgblight_disable_noeeprom();
+    } else {
+        rgblight_enable_noeeprom();
+    }
+}
+
+void rgblight_enable(void) {
+    rgblight_config.enable = 1;
+    // No need to update EEPROM here. rgblight_mode() will do that, actually
+    // eeconfig_update_rgblight(rgblight_config.raw);
+    dprintf("rgblight enable [EEPROM]: rgblight_config.enable = %u\n", rgblight_config.enable);
+    rgblight_mode(rgblight_config.mode);
+}
+
+void rgblight_enable_noeeprom(void) {
+    rgblight_config.enable = 1;
+    dprintf("rgblight enable [NOEEPROM]: rgblight_config.enable = %u\n", rgblight_config.enable);
+    rgblight_mode_noeeprom(rgblight_config.mode);
+}
+
+void rgblight_disable(void) {
+    rgblight_config.enable = 0;
+    eeconfig_update_rgblight(rgblight_config.raw);
+    dprintf("rgblight disable [EEPROM]: rgblight_config.enable = %u\n", rgblight_config.enable);
+    rgblight_timer_disable();
+    RGBLIGHT_SPLIT_SET_CHANGE_MODE;
+    wait_ms(50);
+    rgblight_set();
+}
+
+void rgblight_disable_noeeprom(void) {
+    rgblight_config.enable = 0;
+    dprintf("rgblight disable [NOEEPROM]: rgblight_config.enable = %u\n", rgblight_config.enable);
+    rgblight_timer_disable();
+    RGBLIGHT_SPLIT_SET_CHANGE_MODE;
+    wait_ms(50);
+    rgblight_set();
+}
+
+bool rgblight_is_enabled(void) { return rgblight_config.enable; }
+
+void rgblight_increase_hue_helper(bool write_to_eeprom) {
+    uint8_t hue = rgblight_config.hue + RGBLIGHT_HUE_STEP;
+    rgblight_sethsv_eeprom_helper(hue, rgblight_config.sat, rgblight_config.val, write_to_eeprom);
+}
+void rgblight_increase_hue_noeeprom(void) { rgblight_increase_hue_helper(false); }
+void rgblight_increase_hue(void) { rgblight_increase_hue_helper(true); }
+void rgblight_decrease_hue_helper(bool write_to_eeprom) {
+    uint8_t hue = rgblight_config.hue - RGBLIGHT_HUE_STEP;
+    rgblight_sethsv_eeprom_helper(hue, rgblight_config.sat, rgblight_config.val, write_to_eeprom);
+}
+void rgblight_decrease_hue_noeeprom(void) { rgblight_decrease_hue_helper(false); }
+void rgblight_decrease_hue(void) { rgblight_decrease_hue_helper(true); }
+void rgblight_increase_sat_helper(bool write_to_eeprom) {
+    uint8_t sat = qadd8(rgblight_config.sat, RGBLIGHT_SAT_STEP);
+    rgblight_sethsv_eeprom_helper(rgblight_config.hue, sat, rgblight_config.val, write_to_eeprom);
+}
+void rgblight_increase_sat_noeeprom(void) { rgblight_increase_sat_helper(false); }
+void rgblight_increase_sat(void) { rgblight_increase_sat_helper(true); }
+void rgblight_decrease_sat_helper(bool write_to_eeprom) {
+    uint8_t sat = qsub8(rgblight_config.sat, RGBLIGHT_SAT_STEP);
+    rgblight_sethsv_eeprom_helper(rgblight_config.hue, sat, rgblight_config.val, write_to_eeprom);
+}
+void rgblight_decrease_sat_noeeprom(void) { rgblight_decrease_sat_helper(false); }
+void rgblight_decrease_sat(void) { rgblight_decrease_sat_helper(true); }
+void rgblight_increase_val_helper(bool write_to_eeprom) {
+    uint8_t val = qadd8(rgblight_config.val, RGBLIGHT_VAL_STEP);
+    rgblight_sethsv_eeprom_helper(rgblight_config.hue, rgblight_config.sat, val, write_to_eeprom);
+}
+void rgblight_increase_val_noeeprom(void) { rgblight_increase_val_helper(false); }
+void rgblight_increase_val(void) { rgblight_increase_val_helper(true); }
+void rgblight_decrease_val_helper(bool write_to_eeprom) {
+    uint8_t val = qsub8(rgblight_config.val, RGBLIGHT_VAL_STEP);
+    rgblight_sethsv_eeprom_helper(rgblight_config.hue, rgblight_config.sat, val, write_to_eeprom);
+}
+void rgblight_decrease_val_noeeprom(void) { rgblight_decrease_val_helper(false); }
+void rgblight_decrease_val(void) { rgblight_decrease_val_helper(true); }
+
+void rgblight_increase_speed_helper(bool write_to_eeprom) {
+    if (rgblight_config.speed < 3) rgblight_config.speed++;
+    // RGBLIGHT_SPLIT_SET_CHANGE_HSVS; // NEED?
+    if (write_to_eeprom) {
+        eeconfig_update_rgblight(rgblight_config.raw);  // EECONFIG needs to be increased to support this
+    }
+}
+void rgblight_increase_speed(void) { rgblight_increase_speed_helper(true); }
+void rgblight_increase_speed_noeeprom(void) { rgblight_increase_speed_helper(false); }
+
+void rgblight_decrease_speed_helper(bool write_to_eeprom) {
+    if (rgblight_config.speed > 0) rgblight_config.speed--;
+    // RGBLIGHT_SPLIT_SET_CHANGE_HSVS; // NEED??
+    if (write_to_eeprom) {
+        eeconfig_update_rgblight(rgblight_config.raw);  // EECONFIG needs to be increased to support this
+    }
+}
+void rgblight_decrease_speed(void) { rgblight_decrease_speed_helper(true); }
+void rgblight_decrease_speed_noeeprom(void) { rgblight_decrease_speed_helper(false); }
+
+void rgblight_sethsv_noeeprom_old(uint8_t hue, uint8_t sat, uint8_t val) {
+    if (rgblight_config.enable) {
+        LED_TYPE tmp_led;
+        sethsv(hue, sat, val, &tmp_led);
+        rgblight_setrgb(tmp_led.r, tmp_led.g, tmp_led.b);
+    }
+}
+
+void rgblight_sethsv_eeprom_helper(uint8_t hue, uint8_t sat, uint8_t val, bool write_to_eeprom) {
+    if (rgblight_config.enable) {
+        rgblight_status.base_mode = mode_base_table[rgblight_config.mode];
+        if (rgblight_config.mode == RGBLIGHT_MODE_STATIC_LIGHT) {
+            // same static color
+            LED_TYPE tmp_led;
+            sethsv(hue, sat, val, &tmp_led);
+            rgblight_setrgb(tmp_led.r, tmp_led.g, tmp_led.b);
+        } else {
+            // all LEDs in same color
+            if (1 == 0) {  // dummy
+            }
+#ifdef RGBLIGHT_EFFECT_BREATHING
+            else if (rgblight_status.base_mode == RGBLIGHT_MODE_BREATHING) {
+                // breathing mode, ignore the change of val, use in memory value instead
+                val = rgblight_config.val;
+            }
+#endif
+#ifdef RGBLIGHT_EFFECT_RAINBOW_MOOD
+            else if (rgblight_status.base_mode == RGBLIGHT_MODE_RAINBOW_MOOD) {
+                // rainbow mood, ignore the change of hue
+                hue = rgblight_config.hue;
+            }
+#endif
+#ifdef RGBLIGHT_EFFECT_RAINBOW_SWIRL
+            else if (rgblight_status.base_mode == RGBLIGHT_MODE_RAINBOW_SWIRL) {
+                // rainbow swirl, ignore the change of hue
+                hue = rgblight_config.hue;
+            }
+#endif
+#ifdef RGBLIGHT_EFFECT_STATIC_GRADIENT
+            else if (rgblight_status.base_mode == RGBLIGHT_MODE_STATIC_GRADIENT) {
+                // static gradient
+                uint8_t delta     = rgblight_config.mode - rgblight_status.base_mode;
+                bool    direction = (delta % 2) == 0;
+#    ifdef __AVR__
+                // probably due to how pgm_read_word is defined for ARM, but the ARM compiler really hates this line
+                uint8_t range = pgm_read_word(&RGBLED_GRADIENT_RANGES[delta / 2]);
+#    else
+                uint8_t range = RGBLED_GRADIENT_RANGES[delta / 2];
+#    endif
+                for (uint8_t i = 0; i < rgblight_ranges.effect_num_leds; i++) {
+                    uint8_t _hue = ((uint16_t)i * (uint16_t)range) / rgblight_ranges.effect_num_leds;
+                    if (direction) {
+                        _hue = hue + _hue;
+                    } else {
+                        _hue = hue - _hue;
+                    }
+                    dprintf("rgblight rainbow set hsv: %d,%d,%d,%u\n", i, _hue, direction, range);
+                    sethsv(_hue, sat, val, (LED_TYPE *)&led[i + rgblight_ranges.effect_start_pos]);
+                }
+                rgblight_set();
+            }
+#endif
+        }
+#ifdef RGBLIGHT_SPLIT
+        if (rgblight_config.hue != hue || rgblight_config.sat != sat || rgblight_config.val != val) {
+            RGBLIGHT_SPLIT_SET_CHANGE_HSVS;
+        }
+#endif
+        rgblight_config.hue = hue;
+        rgblight_config.sat = sat;
+        rgblight_config.val = val;
+        if (write_to_eeprom) {
+            eeconfig_update_rgblight(rgblight_config.raw);
+            dprintf("rgblight set hsv [EEPROM]: %u,%u,%u\n", rgblight_config.hue, rgblight_config.sat, rgblight_config.val);
+        } else {
+            dprintf("rgblight set hsv [NOEEPROM]: %u,%u,%u\n", rgblight_config.hue, rgblight_config.sat, rgblight_config.val);
+        }
+    }
+}
+
+void rgblight_sethsv(uint8_t hue, uint8_t sat, uint8_t val) { rgblight_sethsv_eeprom_helper(hue, sat, val, true); }
+
+void rgblight_sethsv_noeeprom(uint8_t hue, uint8_t sat, uint8_t val) { rgblight_sethsv_eeprom_helper(hue, sat, val, false); }
+
+uint8_t rgblight_get_speed(void) { return rgblight_config.speed; }
+
+void rgblight_set_speed_eeprom_helper(uint8_t speed, bool write_to_eeprom) {
+    rgblight_config.speed = speed;
+    if (write_to_eeprom) {
+        eeconfig_update_rgblight(rgblight_config.raw);  // EECONFIG needs to be increased to support this
+        dprintf("rgblight set speed [EEPROM]: %u\n", rgblight_config.speed);
+    } else {
+        dprintf("rgblight set speed [NOEEPROM]: %u\n", rgblight_config.speed);
+    }
+}
+
+void rgblight_set_speed(uint8_t speed) { rgblight_set_speed_eeprom_helper(speed, true); }
+
+void rgblight_set_speed_noeeprom(uint8_t speed) { rgblight_set_speed_eeprom_helper(speed, false); }
+
+uint8_t rgblight_get_hue(void) { return rgblight_config.hue; }
+
+uint8_t rgblight_get_sat(void) { return rgblight_config.sat; }
+
+uint8_t rgblight_get_val(void) { return rgblight_config.val; }
+
+HSV rgblight_get_hsv(void) { return (HSV){rgblight_config.hue, rgblight_config.sat, rgblight_config.val}; }
+
+void rgblight_setrgb(uint8_t r, uint8_t g, uint8_t b) {
+    if (!rgblight_config.enable) {
+        return;
+    }
+
+    for (uint8_t i = rgblight_ranges.effect_start_pos; i < rgblight_ranges.effect_end_pos; i++) {
+        led[i].r = r;
+        led[i].g = g;
+        led[i].b = b;
+#ifdef RGBW
+        led[i].w = 0;
+#endif
+    }
+    rgblight_set();
+}
+
+void rgblight_setrgb_at(uint8_t r, uint8_t g, uint8_t b, uint8_t index) {
+    if (!rgblight_config.enable || index >= RGBLED_NUM) {
+        return;
+    }
+
+    led[index].r = r;
+    led[index].g = g;
+    led[index].b = b;
+#ifdef RGBW
+    led[index].w = 0;
+#endif
+    rgblight_set();
+}
+
+void rgblight_sethsv_at(uint8_t hue, uint8_t sat, uint8_t val, uint8_t index) {
+    if (!rgblight_config.enable) {
+        return;
+    }
+
+    LED_TYPE tmp_led;
+    sethsv(hue, sat, val, &tmp_led);
+    rgblight_setrgb_at(tmp_led.r, tmp_led.g, tmp_led.b, index);
+}
+
+#if defined(RGBLIGHT_EFFECT_BREATHING) || defined(RGBLIGHT_EFFECT_RAINBOW_MOOD) || defined(RGBLIGHT_EFFECT_RAINBOW_SWIRL) || defined(RGBLIGHT_EFFECT_SNAKE) || defined(RGBLIGHT_EFFECT_KNIGHT) || defined(RGBLIGHT_EFFECT_TWINKLE)
+
+static uint8_t get_interval_time(const uint8_t *default_interval_address, uint8_t velocikey_min, uint8_t velocikey_max) {
+    return
+#    ifdef VELOCIKEY_ENABLE
+        velocikey_enabled() ? velocikey_match_speed(velocikey_min, velocikey_max) :
+#    endif
+                            pgm_read_byte(default_interval_address);
+}
+
+#endif
+
+void rgblight_setrgb_range(uint8_t r, uint8_t g, uint8_t b, uint8_t start, uint8_t end) {
+    if (!rgblight_config.enable || start < 0 || start >= end || end > RGBLED_NUM) {
+        return;
+    }
+
+    for (uint8_t i = start; i < end; i++) {
+        led[i].r = r;
+        led[i].g = g;
+        led[i].b = b;
+#ifdef RGBW
+        led[i].w = 0;
+#endif
+    }
+    rgblight_set();
+    wait_ms(1);
+}
+
+void rgblight_sethsv_range(uint8_t hue, uint8_t sat, uint8_t val, uint8_t start, uint8_t end) {
+    if (!rgblight_config.enable) {
+        return;
+    }
+
+    LED_TYPE tmp_led;
+    sethsv(hue, sat, val, &tmp_led);
+    rgblight_setrgb_range(tmp_led.r, tmp_led.g, tmp_led.b, start, end);
+}
+
+#ifndef RGBLIGHT_SPLIT
+void rgblight_setrgb_master(uint8_t r, uint8_t g, uint8_t b) { rgblight_setrgb_range(r, g, b, 0, (uint8_t)RGBLED_NUM / 2); }
+
+void rgblight_setrgb_slave(uint8_t r, uint8_t g, uint8_t b) { rgblight_setrgb_range(r, g, b, (uint8_t)RGBLED_NUM / 2, (uint8_t)RGBLED_NUM); }
+
+void rgblight_sethsv_master(uint8_t hue, uint8_t sat, uint8_t val) { rgblight_sethsv_range(hue, sat, val, 0, (uint8_t)RGBLED_NUM / 2); }
+
+void rgblight_sethsv_slave(uint8_t hue, uint8_t sat, uint8_t val) { rgblight_sethsv_range(hue, sat, val, (uint8_t)RGBLED_NUM / 2, (uint8_t)RGBLED_NUM); }
+#endif  // ifndef RGBLIGHT_SPLIT
+
+#ifdef RGBLIGHT_LAYERS
+void rgblight_set_layer_state(uint8_t layer, bool enabled) {
+    rgblight_layer_mask_t mask = (rgblight_layer_mask_t)1 << layer;
+    if (enabled) {
+        rgblight_status.enabled_layer_mask |= mask;
+    } else {
+        rgblight_status.enabled_layer_mask &= ~mask;
+    }
+    RGBLIGHT_SPLIT_SET_CHANGE_LAYERS;
+    // Static modes don't have a ticker running to update the LEDs
+    if (rgblight_status.timer_enabled == false) {
+        rgblight_mode_noeeprom(rgblight_config.mode);
+    }
+
+#    ifdef RGBLIGHT_LAYERS_OVERRIDE_RGB_OFF
+    // If not enabled, then nothing else will actually set the LEDs...
+    if (!rgblight_config.enable) {
+        rgblight_set();
+    }
+#    endif
+}
+
+bool rgblight_get_layer_state(uint8_t layer) {
+    rgblight_layer_mask_t mask = (rgblight_layer_mask_t)1 << layer;
+    return (rgblight_status.enabled_layer_mask & mask) != 0;
+}
+
+// Write any enabled LED layers into the buffer
+static void rgblight_layers_write(void) {
+    uint8_t i = 0;
+    // For each layer
+    for (const rgblight_segment_t *const *layer_ptr = rgblight_layers; i < RGBLIGHT_MAX_LAYERS; layer_ptr++, i++) {
+        if (!rgblight_get_layer_state(i)) {
+            continue;  // Layer is disabled
+        }
+        const rgblight_segment_t *segment_ptr = pgm_read_ptr(layer_ptr);
+        if (segment_ptr == NULL) {
+            break;  // No more layers
+        }
+        // For each segment
+        while (1) {
+            rgblight_segment_t segment;
+            memcpy_P(&segment, segment_ptr, sizeof(rgblight_segment_t));
+            if (segment.index == RGBLIGHT_END_SEGMENT_INDEX) {
+                break;  // No more segments
+            }
+            // Write segment.count LEDs
+            LED_TYPE *const limit = &led[MIN(segment.index + segment.count, RGBLED_NUM)];
+            for (LED_TYPE *led_ptr = &led[segment.index]; led_ptr < limit; led_ptr++) {
+                sethsv(segment.hue, segment.sat, segment.val, led_ptr);
+            }
+            segment_ptr++;
+        }
+    }
+}
+
+#    ifdef RGBLIGHT_LAYER_BLINK
+rgblight_layer_mask_t _blinking_layer_mask = 0;
+static uint16_t       _repeat_timer;
+static uint8_t        _times_remaining;
+static uint16_t       _dur;
+
+void rgblight_blink_layer(uint8_t layer, uint16_t duration_ms) { rgblight_blink_layer_repeat(layer, duration_ms, 1); }
+
+void rgblight_blink_layer_repeat(uint8_t layer, uint16_t duration_ms, uint8_t times) {
+    _times_remaining = times * 2;
+    _dur             = duration_ms;
+
+    rgblight_set_layer_state(layer, true);
+    _times_remaining--;
+    _blinking_layer_mask |= (rgblight_layer_mask_t)1 << layer;
+    _repeat_timer = sync_timer_read() + duration_ms;
+}
+
+void rgblight_blink_layer_repeat_helper(void) {
+    if (_blinking_layer_mask != 0 && timer_expired(sync_timer_read(), _repeat_timer)) {
+        for (uint8_t layer = 0; layer < RGBLIGHT_MAX_LAYERS; layer++) {
+            if ((_blinking_layer_mask & (rgblight_layer_mask_t)1 << layer) != 0 && _times_remaining > 0) {
+                if (_times_remaining % 2 == 1) {
+                    rgblight_set_layer_state(layer, false);
+                } else {
+                    rgblight_set_layer_state(layer, true);
+                }
+                _times_remaining--;
+                _repeat_timer = sync_timer_read() + _dur;
+            }
+        }
+        if (_times_remaining <= 0) {
+            _blinking_layer_mask = 0;
+        }
+    }
+}
+#    endif
+
+#endif
+
+#ifdef RGBLIGHT_SLEEP
+
+void rgblight_suspend(void) {
+    rgblight_timer_disable();
+    if (!is_suspended) {
+        is_suspended        = true;
+        pre_suspend_enabled = rgblight_config.enable;
+
+#    ifdef RGBLIGHT_LAYER_BLINK
+        // make sure any layer blinks don't come back after suspend
+        rgblight_status.enabled_layer_mask &= ~_blinking_layer_mask;
+        _blinking_layer_mask = 0;
+#    endif
+
+        rgblight_disable_noeeprom();
+    }
+}
+
+void rgblight_wakeup(void) {
+    is_suspended = false;
+
+    if (pre_suspend_enabled) {
+        rgblight_enable_noeeprom();
+    }
+#    ifdef RGBLIGHT_LAYERS_OVERRIDE_RGB_OFF
+    // Need this or else the LEDs won't be set
+    else if (rgblight_status.enabled_layer_mask != 0) {
+        rgblight_set();
+    }
+#    endif
+
+    rgblight_timer_enable();
+}
+
+#endif
+
+__attribute__((weak)) void rgblight_call_driver(LED_TYPE *start_led, uint8_t num_leds) { ws2812_setleds(start_led, num_leds); }
+
+#ifndef RGBLIGHT_CUSTOM_DRIVER
+
+void rgblight_set(void) {
+    LED_TYPE *start_led;
+    uint8_t   num_leds = rgblight_ranges.clipping_num_leds;
+
+    if (!rgblight_config.enable) {
+        for (uint8_t i = rgblight_ranges.effect_start_pos; i < rgblight_ranges.effect_end_pos; i++) {
+            led[i].r = 0;
+            led[i].g = 0;
+            led[i].b = 0;
+#    ifdef RGBW
+            led[i].w = 0;
+#    endif
+        }
+    }
+
+#    ifdef RGBLIGHT_LAYERS
+    if (rgblight_layers != NULL
+#        if !defined(RGBLIGHT_LAYERS_OVERRIDE_RGB_OFF)
+        && rgblight_config.enable
+#        elif defined(RGBLIGHT_SLEEP)
+        && !is_suspended
+#        endif
+    ) {
+        rgblight_layers_write();
+    }
+#    endif
+
+#    ifdef RGBLIGHT_LED_MAP
+    LED_TYPE led0[RGBLED_NUM];
+    for (uint8_t i = 0; i < RGBLED_NUM; i++) {
+        led0[i] = led[pgm_read_byte(&led_map[i])];
+    }
+    start_led = led0 + rgblight_ranges.clipping_start_pos;
+#    else
+    start_led = led + rgblight_ranges.clipping_start_pos;
+#    endif
+
+#    ifdef RGBW
+    for (uint8_t i = 0; i < num_leds; i++) {
+        convert_rgb_to_rgbw(&start_led[i]);
+    }
+#    endif
+    rgblight_call_driver(start_led, num_leds);
+}
+#endif
+
+#ifdef RGBLIGHT_SPLIT
+/* for split keyboard master side */
+uint8_t rgblight_get_change_flags(void) { return rgblight_status.change_flags; }
+
+void rgblight_clear_change_flags(void) { rgblight_status.change_flags = 0; }
+
+void rgblight_get_syncinfo(rgblight_syncinfo_t *syncinfo) {
+    syncinfo->config = rgblight_config;
+    syncinfo->status = rgblight_status;
+}
+
+/* for split keyboard slave side */
+void rgblight_update_sync(rgblight_syncinfo_t *syncinfo, bool write_to_eeprom) {
+#    ifdef RGBLIGHT_LAYERS
+    if (syncinfo->status.change_flags & RGBLIGHT_STATUS_CHANGE_LAYERS) {
+        rgblight_status.enabled_layer_mask = syncinfo->status.enabled_layer_mask;
+    }
+#    endif
+    if (syncinfo->status.change_flags & RGBLIGHT_STATUS_CHANGE_MODE) {
+        if (syncinfo->config.enable) {
+            rgblight_config.enable = 1;  // == rgblight_enable_noeeprom();
+            rgblight_mode_eeprom_helper(syncinfo->config.mode, write_to_eeprom);
+        } else {
+            rgblight_disable_noeeprom();
+        }
+    }
+    if (syncinfo->status.change_flags & RGBLIGHT_STATUS_CHANGE_HSVS) {
+        rgblight_sethsv_eeprom_helper(syncinfo->config.hue, syncinfo->config.sat, syncinfo->config.val, write_to_eeprom);
+        // rgblight_config.speed = config->speed; // NEED???
+    }
+#    ifdef RGBLIGHT_USE_TIMER
+    if (syncinfo->status.change_flags & RGBLIGHT_STATUS_CHANGE_TIMER) {
+        if (syncinfo->status.timer_enabled) {
+            rgblight_timer_enable();
+        } else {
+            rgblight_timer_disable();
+        }
+    }
+#        ifndef RGBLIGHT_SPLIT_NO_ANIMATION_SYNC
+    if (syncinfo->status.change_flags & RGBLIGHT_STATUS_ANIMATION_TICK) {
+        animation_status.restart = true;
+    }
+#        endif /* RGBLIGHT_SPLIT_NO_ANIMATION_SYNC */
+#    endif     /* RGBLIGHT_USE_TIMER */
+}
+#endif /* RGBLIGHT_SPLIT */
+
+#ifdef RGBLIGHT_USE_TIMER
+
+typedef void (*effect_func_t)(animation_status_t *anim);
+
+// Animation timer -- use system timer (AVR Timer0)
+void rgblight_timer_init(void) {
+    rgblight_status.timer_enabled = false;
+    RGBLIGHT_SPLIT_SET_CHANGE_TIMER_ENABLE;
+}
+void rgblight_timer_enable(void) {
+    if (!is_static_effect(rgblight_config.mode)) {
+        rgblight_status.timer_enabled = true;
+    }
+    animation_status.last_timer = sync_timer_read();
+    RGBLIGHT_SPLIT_SET_CHANGE_TIMER_ENABLE;
+    dprintf("rgblight timer enabled.\n");
+}
+void rgblight_timer_disable(void) {
+    rgblight_status.timer_enabled = false;
+    RGBLIGHT_SPLIT_SET_CHANGE_TIMER_ENABLE;
+    dprintf("rgblight timer disable.\n");
+}
+void rgblight_timer_toggle(void) {
+    dprintf("rgblight timer toggle.\n");
+    if (rgblight_status.timer_enabled) {
+        rgblight_timer_disable();
+    } else {
+        rgblight_timer_enable();
+    }
+}
+
+void rgblight_show_solid_color(uint8_t r, uint8_t g, uint8_t b) {
+    rgblight_enable();
+    rgblight_mode(RGBLIGHT_MODE_STATIC_LIGHT);
+    rgblight_setrgb(r, g, b);
+}
+
+static void rgblight_effect_dummy(animation_status_t *anim) {
+    // do nothing
+    /********
+    dprintf("rgblight_task() what happened?\n");
+    dprintf("is_static_effect %d\n", is_static_effect(rgblight_config.mode));
+    dprintf("mode = %d, base_mode = %d, timer_enabled %d, ",
+            rgblight_config.mode, rgblight_status.base_mode,
+            rgblight_status.timer_enabled);
+    dprintf("last_timer = %d\n",anim->last_timer);
+    **/
+}
+
+void rgblight_task(void) {
+    if (rgblight_status.timer_enabled) {
+        effect_func_t effect_func   = rgblight_effect_dummy;
+        uint16_t      interval_time = 2000;  // dummy interval
+        uint8_t       delta         = rgblight_config.mode - rgblight_status.base_mode;
+        animation_status.delta      = delta;
+
+        // static light mode, do nothing here
+        if (1 == 0) {  // dummy
+        }
+#    ifdef RGBLIGHT_EFFECT_BREATHING
+        else if (rgblight_status.base_mode == RGBLIGHT_MODE_BREATHING) {
+            // breathing mode
+            interval_time = get_interval_time(&RGBLED_BREATHING_INTERVALS[delta], 1, 100);
+            effect_func   = rgblight_effect_breathing;
+        }
+#    endif
+#    ifdef RGBLIGHT_EFFECT_RAINBOW_MOOD
+        else if (rgblight_status.base_mode == RGBLIGHT_MODE_RAINBOW_MOOD) {
+            // rainbow mood mode
+            interval_time = get_interval_time(&RGBLED_RAINBOW_MOOD_INTERVALS[delta], 5, 100);
+            effect_func   = rgblight_effect_rainbow_mood;
+        }
+#    endif
+#    ifdef RGBLIGHT_EFFECT_RAINBOW_SWIRL
+        else if (rgblight_status.base_mode == RGBLIGHT_MODE_RAINBOW_SWIRL) {
+            // rainbow swirl mode
+            interval_time = get_interval_time(&RGBLED_RAINBOW_SWIRL_INTERVALS[delta / 2], 1, 100);
+            effect_func   = rgblight_effect_rainbow_swirl;
+        }
+#    endif
+#    ifdef RGBLIGHT_EFFECT_SNAKE
+        else if (rgblight_status.base_mode == RGBLIGHT_MODE_SNAKE) {
+            // snake mode
+            interval_time = get_interval_time(&RGBLED_SNAKE_INTERVALS[delta / 2], 1, 200);
+            effect_func   = rgblight_effect_snake;
+        }
+#    endif
+#    ifdef RGBLIGHT_EFFECT_KNIGHT
+        else if (rgblight_status.base_mode == RGBLIGHT_MODE_KNIGHT) {
+            // knight mode
+            interval_time = get_interval_time(&RGBLED_KNIGHT_INTERVALS[delta], 5, 100);
+            effect_func   = rgblight_effect_knight;
+        }
+#    endif
+#    ifdef RGBLIGHT_EFFECT_CHRISTMAS
+        else if (rgblight_status.base_mode == RGBLIGHT_MODE_CHRISTMAS) {
+            // christmas mode
+            interval_time = RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL;
+            effect_func   = (effect_func_t)rgblight_effect_christmas;
+        }
+#    endif
+#    ifdef