~ruther/qmk_firmware

60297a1099e5a310bd10a4d59fcb80bbc7fe4be5 — Joel Challis 3 years ago 951331c
Reuse of EEPROM debounce logic (#14699)

* reuse rgb debounce logic

* Refactor led matrix

* Remove log line

* timeout should not be hard coded
3 files changed, 46 insertions(+), 44 deletions(-)

M quantum/eeconfig.h
M quantum/led_matrix/led_matrix.c
M quantum/rgb_matrix/rgb_matrix.c
M quantum/eeconfig.h => quantum/eeconfig.h +26 -0
@@ 111,3 111,29 @@ void     eeconfig_update_haptic(uint32_t val);

bool eeconfig_read_handedness(void);
void eeconfig_update_handedness(bool val);

#define EECONFIG_DEBOUNCE_HELPER(name, offset, config)                     \
    static uint8_t dirty_##name = false;                                   \
                                                                           \
    static inline void eeconfig_init_##name(void) {                        \
        eeprom_read_block(&config, offset, sizeof(config));                \
        dirty_##name = false;                                              \
    }                                                                      \
    static inline void eeconfig_flush_##name(bool force) {                 \
        if (force || dirty_##name) {                                       \
            eeprom_update_block(&config, offset, sizeof(config));          \
            dirty_##name = false;                                          \
        }                                                                  \
    }                                                                      \
    static inline void eeconfig_flush_##name##_task(uint16_t timeout) {    \
        static uint16_t flush_timer = 0;                                   \
        if (timer_elapsed(flush_timer) > timeout) {                        \
            eeconfig_flush_##name(false);                                  \
            flush_timer = timer_read();                                    \
        }                                                                  \
    }                                                                      \
    static inline void eeconfig_flag_##name(bool v) { dirty_##name |= v; } \
    static inline void eeconfig_write_##name(typeof(config) conf) {        \
        memcpy(&config, &conf, sizeof(config));                            \
        eeconfig_flag_##name(true);                                        \
    }

M quantum/led_matrix/led_matrix.c => quantum/led_matrix/led_matrix.c +10 -22
@@ 33,14 33,6 @@ const led_point_t k_led_matrix_center = {112, 32};
const led_point_t k_led_matrix_center = LED_MATRIX_CENTER;
#endif

// clang-format off
#ifndef LED_MATRIX_IMMEDIATE_EEPROM
#    define led_eeconfig_update(v) led_update_eeprom |= v
#else
#    define led_eeconfig_update(v) if (v) eeconfig_update_led_matrix()
#endif
// clang-format on

// Generic effect runners
#include "led_matrix_runners.inc"



@@ 107,7 99,6 @@ last_hit_t g_last_hit_tracker;

// internals
static bool            suspend_state     = false;
static bool            led_update_eeprom = false;
static uint8_t         led_last_enable   = UINT8_MAX;
static uint8_t         led_last_effect   = UINT8_MAX;
static effect_params_t led_effect_params = {0, LED_FLAG_ALL, false};


@@ 127,9 118,7 @@ static last_hit_t last_hit_buffer;
const uint8_t k_led_matrix_split[2] = LED_MATRIX_SPLIT;
#endif

void eeconfig_read_led_matrix(void) { eeprom_read_block(&led_matrix_eeconfig, EECONFIG_LED_MATRIX, sizeof(led_matrix_eeconfig)); }

void eeconfig_update_led_matrix(void) { eeprom_update_block(&led_matrix_eeconfig, EECONFIG_LED_MATRIX, sizeof(led_matrix_eeconfig)); }
EECONFIG_DEBOUNCE_HELPER(led_matrix, EECONFIG_LED_MATRIX, led_matrix_eeconfig);

void eeconfig_update_led_matrix_default(void) {
    dprintf("eeconfig_update_led_matrix_default\n");


@@ 138,7 127,7 @@ void eeconfig_update_led_matrix_default(void) {
    led_matrix_eeconfig.val    = LED_MATRIX_STARTUP_VAL;
    led_matrix_eeconfig.speed  = LED_MATRIX_STARTUP_SPD;
    led_matrix_eeconfig.flags  = LED_FLAG_ALL;
    eeconfig_update_led_matrix();
    eeconfig_flush_led_matrix(true);
}

void eeconfig_debug_led_matrix(void) {


@@ 279,9 268,8 @@ static void led_task_timers(void) {
}

static void led_task_sync(void) {
    eeconfig_flush_led_matrix(false);
    // next task
    if (led_update_eeprom) eeconfig_update_led_matrix();
    led_update_eeprom = false;
    if (sync_timer_elapsed32(g_led_timer) >= LED_MATRIX_LED_FLUSH_LIMIT) led_task_state = STARTING;
}



@@ 449,7 437,7 @@ void led_matrix_init(void) {
        eeconfig_update_led_matrix_default();
    }

    eeconfig_read_led_matrix();
    eeconfig_init_led_matrix();
    if (!led_matrix_eeconfig.mode) {
        dprintf("led_matrix_init_drivers led_matrix_eeconfig.mode = 0. Write default values to EEPROM.\n");
        eeconfig_update_led_matrix_default();


@@ 472,7 460,7 @@ bool led_matrix_get_suspend_state(void) { return suspend_state; }
void led_matrix_toggle_eeprom_helper(bool write_to_eeprom) {
    led_matrix_eeconfig.enable ^= 1;
    led_task_state = STARTING;
    led_eeconfig_update(write_to_eeprom);
    eeconfig_flag_led_matrix(write_to_eeprom);
    dprintf("led matrix toggle [%s]: led_matrix_eeconfig.enable = %u\n", (write_to_eeprom) ? "EEPROM" : "NOEEPROM", led_matrix_eeconfig.enable);
}
void led_matrix_toggle_noeeprom(void) { led_matrix_toggle_eeprom_helper(false); }


@@ 480,7 468,7 @@ void led_matrix_toggle(void) { led_matrix_toggle_eeprom_helper(true); }

void led_matrix_enable(void) {
    led_matrix_enable_noeeprom();
    led_eeconfig_update(true);
    eeconfig_flag_led_matrix(true);
}

void led_matrix_enable_noeeprom(void) {


@@ 490,7 478,7 @@ void led_matrix_enable_noeeprom(void) {

void led_matrix_disable(void) {
    led_matrix_disable_noeeprom();
    led_eeconfig_update(true);
    eeconfig_flag_led_matrix(true);
}

void led_matrix_disable_noeeprom(void) {


@@ 512,7 500,7 @@ void led_matrix_mode_eeprom_helper(uint8_t mode, bool write_to_eeprom) {
        led_matrix_eeconfig.mode = mode;
    }
    led_task_state = STARTING;
    led_eeconfig_update(write_to_eeprom);
    eeconfig_flag_led_matrix(write_to_eeprom);
    dprintf("led matrix mode [%s]: %u\n", (write_to_eeprom) ? "EEPROM" : "NOEEPROM", led_matrix_eeconfig.mode);
}
void led_matrix_mode_noeeprom(uint8_t mode) { led_matrix_mode_eeprom_helper(mode, false); }


@@ 539,7 527,7 @@ void led_matrix_set_val_eeprom_helper(uint8_t val, bool write_to_eeprom) {
        return;
    }
    led_matrix_eeconfig.val = (val > LED_MATRIX_MAXIMUM_BRIGHTNESS) ? LED_MATRIX_MAXIMUM_BRIGHTNESS : val;
    led_eeconfig_update(write_to_eeprom);
    eeconfig_flag_led_matrix(write_to_eeprom);
    dprintf("led matrix set val [%s]: %u\n", (write_to_eeprom) ? "EEPROM" : "NOEEPROM", led_matrix_eeconfig.val);
}
void led_matrix_set_val_noeeprom(uint8_t val) { led_matrix_set_val_eeprom_helper(val, false); }


@@ 557,7 545,7 @@ void led_matrix_decrease_val(void) { led_matrix_decrease_val_helper(true); }

void led_matrix_set_speed_eeprom_helper(uint8_t speed, bool write_to_eeprom) {
    led_matrix_eeconfig.speed = speed;
    led_eeconfig_update(write_to_eeprom);
    eeconfig_flag_led_matrix(write_to_eeprom);
    dprintf("led matrix set speed [%s]: %u\n", (write_to_eeprom) ? "EEPROM" : "NOEEPROM", led_matrix_eeconfig.speed);
}
void led_matrix_set_speed_noeeprom(uint8_t speed) { led_matrix_set_speed_eeprom_helper(speed, false); }

M quantum/rgb_matrix/rgb_matrix.c => quantum/rgb_matrix/rgb_matrix.c +10 -22
@@ 31,14 31,6 @@ const led_point_t k_rgb_matrix_center = {112, 32};
const led_point_t k_rgb_matrix_center = RGB_MATRIX_CENTER;
#endif

// clang-format off
#ifndef RGB_MATRIX_IMMEDIATE_EEPROM
#    define rgb_eeconfig_update(v) rgb_update_eeprom |= v
#else
#    define rgb_eeconfig_update(v) if (v) eeconfig_update_rgb_matrix()
#endif
// clang-format on

__attribute__((weak)) RGB rgb_matrix_hsv_to_rgb(HSV hsv) { return hsv_to_rgb(hsv); }

// Generic effect runners


@@ 128,7 120,6 @@ last_hit_t g_last_hit_tracker;

// internals
static bool            suspend_state     = false;
static bool            rgb_update_eeprom = false;
static uint8_t         rgb_last_enable   = UINT8_MAX;
static uint8_t         rgb_last_effect   = UINT8_MAX;
static effect_params_t rgb_effect_params = {0, LED_FLAG_ALL, false};


@@ 148,9 139,7 @@ static last_hit_t last_hit_buffer;
const uint8_t k_rgb_matrix_split[2] = RGB_MATRIX_SPLIT;
#endif

void eeconfig_read_rgb_matrix(void) { eeprom_read_block(&rgb_matrix_config, EECONFIG_RGB_MATRIX, sizeof(rgb_matrix_config)); }

void eeconfig_update_rgb_matrix(void) { eeprom_update_block(&rgb_matrix_config, EECONFIG_RGB_MATRIX, sizeof(rgb_matrix_config)); }
EECONFIG_DEBOUNCE_HELPER(rgb_matrix, EECONFIG_RGB_MATRIX, rgb_matrix_config);

void eeconfig_update_rgb_matrix_default(void) {
    dprintf("eeconfig_update_rgb_matrix_default\n");


@@ 159,7 148,7 @@ void eeconfig_update_rgb_matrix_default(void) {
    rgb_matrix_config.hsv    = (HSV){RGB_MATRIX_STARTUP_HUE, RGB_MATRIX_STARTUP_SAT, RGB_MATRIX_STARTUP_VAL};
    rgb_matrix_config.speed  = RGB_MATRIX_STARTUP_SPD;
    rgb_matrix_config.flags  = LED_FLAG_ALL;
    eeconfig_update_rgb_matrix();
    eeconfig_flush_rgb_matrix(true);
}

void eeconfig_debug_rgb_matrix(void) {


@@ 314,9 303,8 @@ static void rgb_task_timers(void) {
}

static void rgb_task_sync(void) {
    eeconfig_flush_rgb_matrix(false);
    // next task
    if (rgb_update_eeprom) eeconfig_update_rgb_matrix();
    rgb_update_eeprom = false;
    if (sync_timer_elapsed32(g_rgb_timer) >= RGB_MATRIX_LED_FLUSH_LIMIT) rgb_task_state = STARTING;
}



@@ 491,7 479,7 @@ void rgb_matrix_init(void) {
        eeconfig_update_rgb_matrix_default();
    }

    eeconfig_read_rgb_matrix();
    eeconfig_init_rgb_matrix();
    if (!rgb_matrix_config.mode) {
        dprintf("rgb_matrix_init_drivers rgb_matrix_config.mode = 0. Write default values to EEPROM.\n");
        eeconfig_update_rgb_matrix_default();


@@ 514,7 502,7 @@ bool rgb_matrix_get_suspend_state(void) { return suspend_state; }
void rgb_matrix_toggle_eeprom_helper(bool write_to_eeprom) {
    rgb_matrix_config.enable ^= 1;
    rgb_task_state = STARTING;
    rgb_eeconfig_update(write_to_eeprom);
    eeconfig_flag_rgb_matrix(write_to_eeprom);
    dprintf("rgb matrix toggle [%s]: rgb_matrix_config.enable = %u\n", (write_to_eeprom) ? "EEPROM" : "NOEEPROM", rgb_matrix_config.enable);
}
void rgb_matrix_toggle_noeeprom(void) { rgb_matrix_toggle_eeprom_helper(false); }


@@ 522,7 510,7 @@ void rgb_matrix_toggle(void) { rgb_matrix_toggle_eeprom_helper(true); }

void rgb_matrix_enable(void) {
    rgb_matrix_enable_noeeprom();
    rgb_eeconfig_update(true);
    eeconfig_flag_rgb_matrix(true);
}

void rgb_matrix_enable_noeeprom(void) {


@@ 532,7 520,7 @@ void rgb_matrix_enable_noeeprom(void) {

void rgb_matrix_disable(void) {
    rgb_matrix_disable_noeeprom();
    rgb_eeconfig_update(true);
    eeconfig_flag_rgb_matrix(true);
}

void rgb_matrix_disable_noeeprom(void) {


@@ 554,7 542,7 @@ void rgb_matrix_mode_eeprom_helper(uint8_t mode, bool write_to_eeprom) {
        rgb_matrix_config.mode = mode;
    }
    rgb_task_state = STARTING;
    rgb_eeconfig_update(write_to_eeprom);
    eeconfig_flag_rgb_matrix(write_to_eeprom);
    dprintf("rgb matrix mode [%s]: %u\n", (write_to_eeprom) ? "EEPROM" : "NOEEPROM", rgb_matrix_config.mode);
}
void rgb_matrix_mode_noeeprom(uint8_t mode) { rgb_matrix_mode_eeprom_helper(mode, false); }


@@ 583,7 571,7 @@ void rgb_matrix_sethsv_eeprom_helper(uint16_t hue, uint8_t sat, uint8_t val, boo
    rgb_matrix_config.hsv.h = hue;
    rgb_matrix_config.hsv.s = sat;
    rgb_matrix_config.hsv.v = (val > RGB_MATRIX_MAXIMUM_BRIGHTNESS) ? RGB_MATRIX_MAXIMUM_BRIGHTNESS : val;
    rgb_eeconfig_update(write_to_eeprom);
    eeconfig_flag_rgb_matrix(write_to_eeprom);
    dprintf("rgb matrix set hsv [%s]: %u,%u,%u\n", (write_to_eeprom) ? "EEPROM" : "NOEEPROM", rgb_matrix_config.hsv.h, rgb_matrix_config.hsv.s, rgb_matrix_config.hsv.v);
}
void rgb_matrix_sethsv_noeeprom(uint16_t hue, uint8_t sat, uint8_t val) { rgb_matrix_sethsv_eeprom_helper(hue, sat, val, false); }


@@ 620,7 608,7 @@ void rgb_matrix_decrease_val(void) { rgb_matrix_decrease_val_helper(true); }

void rgb_matrix_set_speed_eeprom_helper(uint8_t speed, bool write_to_eeprom) {
    rgb_matrix_config.speed = speed;
    rgb_eeconfig_update(write_to_eeprom);
    eeconfig_flag_rgb_matrix(write_to_eeprom);
    dprintf("rgb matrix set speed [%s]: %u\n", (write_to_eeprom) ? "EEPROM" : "NOEEPROM", rgb_matrix_config.speed);
}
void rgb_matrix_set_speed_noeeprom(uint8_t speed) { rgb_matrix_set_speed_eeprom_helper(speed, false); }