Merge pull request 'feat(q5_max): enable Keychron RGB and fix EEPROM persistence' (#18) from feat/keychron-rgb-persistence into main

Reviewed-on: #18

keyboards/keychron/common/eeconfig_kb.h

@@ -57,5 +57,6 @@
 #define EECONFIG_BASE_WIRELESS_CONFIG EECONFIG_END_CUSTOM_RGB
 #define EECONFIG_END_WIRELESS_CONFIG (EECONFIG_BASE_WIRELESS_CONFIG + __EECONFIG_SIZE_WIRELESS_CONFIG)
 
+#undef EECONFIG_KB_DATA_SIZE
 #define EECONFIG_KB_DATA_SIZE (EECONFIG_END_WIRELESS_CONFIG - EECONFIG_BASE_LANGUAGE)
 

keyboards/keychron/common/rgb/keychron_rgb.c

@@ -76,7 +76,7 @@ void eeconfig_reset_custom_rgb(void) {
 
     eeprom_update_block(&os_ind_cfg, OFFSET_OS_INDICATOR, sizeof(os_ind_cfg));
     retail_demo_enable = 0;
-    eeprom_read_block(&retail_demo_enable, (uint8_t *)(OFFSET_RETAIL_DEMO), sizeof(retail_demo_enable));
+    eeprom_update_block(&retail_demo_enable, (uint8_t *)(OFFSET_RETAIL_DEMO), sizeof(retail_demo_enable));
     per_key_rgb_type = 0;
     eeprom_update_block(&per_key_rgb_type, OFFSET_PER_KEY_RGB_TYPE, sizeof(per_key_rgb_type));
 
@@ -100,15 +100,24 @@ void eeconfig_reset_custom_rgb(void) {
     effect_list[1][0].time = 5000;
 
     eeprom_update_block(effect_list, OFFSET_EFFECT_LIST, sizeof(effect_list));
+    eeprom_update_dword(EECONFIG_KEYBOARD, (EECONFIG_KB_DATA_VERSION));
     update_mixed_rgb_effect_count();
 }
 
 void eeconfig_init_custom_rgb(void) {
     memcpy(per_key_led, default_per_key_led, sizeof(per_key_led));
-    eeprom_update_dword(EECONFIG_KEYBOARD, (EECONFIG_KB_DATA_VERSION));
 
     eeprom_read_block(&os_ind_cfg, OFFSET_OS_INDICATOR, sizeof(os_ind_cfg));
     eeprom_read_block(&retail_demo_enable, (uint8_t *)(OFFSET_RETAIL_DEMO), sizeof(retail_demo_enable));
+    // Clamp to a valid boolean.  eeconfig_reset_custom_rgb() had a bug that
+    // used eeprom_read_block instead of eeprom_update_block for this byte,
+    // leaving EEPROM unwritten (often 0xFF on a freshly-flashed board).
+    // retail_demo_task() treats any non-zero value as "demo active" and forces
+    // the mode to CUSTOM_MIXED_RGB every scan, preventing mode changes.
+    if (retail_demo_enable > 1) {
+        retail_demo_enable = 0;
+        eeprom_update_block(&retail_demo_enable, (uint8_t *)(OFFSET_RETAIL_DEMO), sizeof(retail_demo_enable));
+    }
 
     if (os_ind_cfg.hsv.v < 128) os_ind_cfg.hsv.v = 128;
     // Load per key rgb led
@@ -283,6 +292,12 @@ static bool kc_rgb_save(void) {
     eeprom_update_block(regions, OFFSET_LAYER_FLAGS, RGB_MATRIX_LED_COUNT);
     eeprom_update_block(effect_list, OFFSET_EFFECT_LIST, sizeof(effect_list));
 
+    // Persist the current QMK RGB mode so it survives transport changes and
+    // power cycles.  Without this, rgb_matrix_init() reloads the EEPROM default
+    // (RGB_MATRIX_TYPING_HEATMAP) and the Launcher-configured mode is lost.
+    extern void eeconfig_update_rgb_matrix(void);
+    eeconfig_update_rgb_matrix();
+
     return true;
 }
 

keyboards/keychron/common/rgb/mixed_rgb.c

@@ -14,6 +14,10 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#ifdef KEYCHRON_RGB_ENABLE
+#    include "eeconfig_custom_rgb.h"
+#endif
+
 #if defined(KEYCHRON_RGB_ENABLE) && defined(EECONFIG_SIZE_CUSTOM_RGB)
 
 #include "quantum.h"

keyboards/keychron/common/rgb/rgb_matrix_kb.inc

@@ -15,6 +15,9 @@
  */
 
 #include "rgb_matrix_kb_config.h"
+#ifdef KEYCHRON_RGB_ENABLE
+#    include "eeconfig_custom_rgb.h"
+#endif
 
 #if defined(KEYCHRON_RGB_ENABLE) && defined(EECONFIG_SIZE_CUSTOM_RGB)
 //extern bool MIXED_RGB(effect_params_t *params);

keyboards/keychron/q5_max/ansi_encoder/ansi_encoder.c

@@ -165,4 +165,38 @@ led_config_t g_led_config = {
         1, 1, 1,          1,       1, 1, 1, 1, 1, 1,    1, 1,
     }
 };
+
+#ifdef KEYCHRON_RGB_ENABLE
+// Default Color of Per Key RGB
+#define DC_RED {HSV_RED}
+#define DC_BLU {HSV_BLUE}
+#define DC_YLW {HSV_YELLOW}
+
+// 101 LEDs: rows match g_led_config above
+// Row 0 (0-16):  Fn row (Esc, F1-F12, Del, PrtSc, PgUp, PgDn)
+// Row 1 (17-35): Number row + numpad cluster top
+// Row 2 (36-54): QWERTY row + numpad cluster mid
+// Row 3 (55-71): ASDF row + numpad cluster
+// Row 4 (72-88): ZXCV row + numpad arrows
+// Row 5 (89-100): Modifier/bottom row + numpad
+HSV default_per_key_led[RGB_MATRIX_LED_COUNT] = {
+    DC_RED, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW,
+    DC_YLW, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW,
+    DC_YLW, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW,
+    DC_RED, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_YLW, DC_YLW, DC_YLW, DC_YLW,
+    DC_YLW, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_BLU, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW,
+    DC_YLW, DC_YLW, DC_YLW, DC_BLU, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW, DC_YLW
+};
+
+// Default mixed RGB region (all keys in region 0)
+uint8_t default_region[RGB_MATRIX_LED_COUNT] = {
+    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
+};
+#endif
+
 #endif

keyboards/keychron/q5_max/ansi_encoder/config.h

@@ -45,6 +45,14 @@
 
 #endif
 
+// Pin VIA keymap storage to a fixed EEPROM address.  By default VIA places its
+// magic/keymap block immediately after EECONFIG_KB_DATA_SIZE, so any growth in
+// the Keychron custom-RGB EEPROM region shifts the keymap silently and corrupts
+// the stored layout (observed as layer 0 keys reverting to KC_TRNS on boot).
+// 544 is past the current Keychron data region and leaves headroom for further
+// EEPROM additions without requiring another VIA reset.
+#define VIA_EEPROM_MAGIC_ADDR 544
+
 /* Number of layers */
 #define DYNAMIC_KEYMAP_LAYER_COUNT 6
 

keyboards/keychron/q5_max/ansi_encoder/keymaps/via/keymap.c

@@ -211,7 +211,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
         RGB_TOG,  RGB_MOD,  RGB_VAI,  RGB_HUI,  RGB_SAI,  RGB_SPI,  _______,  _______,  _______,  _______,  _______,  _______,    _______,  _______,            _______,  _______,  _______,  _______,
         _______,  RGB_RMOD, RGB_VAD,  RGB_HUD,  RGB_SAD,  RGB_SPD,  _______,  _______,  _______,  _______,  _______,  _______,              _______,            KC_END,   _______,  _______,  _______,    _______,
         _______,            _______,  _______,  _______,  _______,  BAT_LVL,  NK_TOGG,  _______,  _______,  _______,  _______,              _______,  _______,            _______,  _______,  _______,
-        _______,  _______,  _______,                                _______,                                _______,  _______,    _______,  _______,  _______,  _______,            _______,  _______,    _______),
+        _______,  _______,  _______,                                _______,                                _______,  _______,    _______,  _______,  _______,  _______,        QK_CLEAR_EEPROM,  _______,    _______),
 };
 
 #if defined(ENCODER_MAP_ENABLE)
@@ -262,20 +262,16 @@ void keyboard_post_init_user(void) {
 #ifdef DIP_SWITCH_ENABLE
 // dip_switch_update_user is claimed by factory_test.c; use the weak
 // dip_switch_update_keymap hook added in q5_max.c instead.
+
+// True while the Win-side dip switch is active.  The underlying RGB effect
+// keeps running unchanged; rgb_matrix_indicators_advanced_user() paints over
+// all LEDs with white each frame so neither mode nor EEPROM state is touched.
+// Transport changes (which call rgb_matrix_init()) are therefore irrelevant.
+static bool dip_win_active = false;
+
 void dip_switch_update_keymap(uint8_t index, bool active) {
     if (index == 0) {
-        if (active) {
+        dip_win_active = active;
-            // "Win" side → solid white backlight
-            rgb_matrix_mode(RGB_MATRIX_SOLID_COLOR);
-            rgb_matrix_sethsv(HSV_WHITE);
-        } else {
-            // "Mac" side → heatmap effect.
-            // Restore hue+saturation before switching modes: the heatmap reads
-            // rgb_matrix_config.hsv.s directly for its color scale, so leaving
-            // saturation=0 (from HSV_WHITE) produces a white-only heatmap.
-            rgb_matrix_sethsv(0, 255, rgb_matrix_get_val());
-            rgb_matrix_mode(RGB_MATRIX_TYPING_HEATMAP);
-        }
     }
 }
 #endif
@@ -434,6 +430,19 @@ void matrix_scan_user(void) {
 // BASE stays dark; each FN/control layer gets a distinct colour.
 #if defined(RGB_MATRIX_ENABLE)
 bool rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {
+#ifdef DIP_SWITCH_ENABLE
+    // Win-side override: paint all LEDs white so the user gets a clean white
+    // backlight regardless of which RGB effect is active.  The effect keeps
+    // ticking internally and resumes the moment the switch returns to Mac side.
+    // Layer and status indicators painted in the rest of this function appear
+    // on top of the white fill, so they continue to work normally.
+    if (dip_win_active) {
+        for (uint8_t i = led_min; i < led_max; i++) {
+            rgb_matrix_set_color(i, 255, 255, 255);
+        }
+    }
+#endif
+
     switch (get_highest_layer(layer_state)) {
         case FN1:
             RGB_MATRIX_INDICATOR_SET_COLOR(0, 0, 128, 255); // blue

keyboards/keychron/q5_max/q5_max.c

@@ -44,6 +44,27 @@ bool dip_switch_update_kb(uint8_t index, bool active) {
 }
 #endif
 
+#ifdef LK_WIRELESS_ENABLE
+// Re-apply the saved QMK RGB mode every time wireless connects.
+// During transport changes, rgb_matrix_init() reads the correct mode from
+// EEPROM, but something in the BT/2.4G reconnect sequence can reset it
+// before the display settles.  This hook fires after connection is fully
+// established, ensuring the Launcher-configured mode persists.
+void wireless_enter_connected_kb(uint8_t host_idx) {
+#    if defined(RGB_MATRIX_ENABLE) && defined(KEYCHRON_RGB_ENABLE)
+    extern void eeconfig_init_custom_rgb(void);
+    eeconfig_init_custom_rgb();
+
+    // Re-read the QMK RGB mode from EEPROM and apply if it drifted.
+    rgb_config_t saved_rgb;
+    eeprom_read_block(&saved_rgb, EECONFIG_RGB_MATRIX, sizeof(saved_rgb));
+    if (saved_rgb.mode && saved_rgb.mode != rgb_matrix_get_mode()) {
+        rgb_matrix_mode_noeeprom(saved_rgb.mode);
+    }
+#    endif
+}
+#endif
+
 void keyboard_post_init_kb(void) {
 #ifdef LK_WIRELESS_ENABLE
     palSetLineMode(P2P4_MODE_SELECT_PIN, PAL_MODE_INPUT);
@@ -57,6 +78,14 @@ void keyboard_post_init_kb(void) {
     encoder_cb_init();
 #endif
 
+#if defined(RGB_MATRIX_ENABLE) && defined(KEYCHRON_RGB_ENABLE)
+    // Load Keychron custom RGB data (effect list, regions, per-key colours)
+    // from EEPROM into RAM.  Without this call the arrays are zero-initialised
+    // and Launcher settings are lost on every power cycle or transport change.
+    extern void eeconfig_init_custom_rgb(void);
+    eeconfig_init_custom_rgb();
+#endif
+
     keyboard_post_init_user();
 }
 

keyboards/keychron/q5_max/rules.mk

@@ -1,3 +1,5 @@
+KEYCHRON_RGB_ENABLE = yes
+
 include keyboards/keychron/common/wireless/wireless.mk
 include keyboards/keychron/common/keychron_common.mk