keyboards/zeal60/rgb_backlight.c

   1 /* Copyright 2017 Jason Williams (Wilba)
   2  *
   3  * This program is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16 #if RGB_BACKLIGHT_ENABLED
  17
  18 #if defined (RGB_BACKLIGHT_ZEAL60) || defined (RGB_BACKLIGHT_ZEAL65) || defined (RGB_BACKLIGHT_M60_A) || defined(RGB_BACKLIGHT_M6_B) || defined(RGB_BACKLIGHT_KOYU) || defined(RGB_BACKLIGHT_HS60)
  19 #else
  20 #error None of the following was defined: RGB_BACKLIGHT_ZEAL60, RGB_BACKLIGHT_ZEAL65, RGB_BACKLIGHT_M60_A, RGB_BACKLIGHT_M6_B, RGB_BACKLIGHT_KOYU
  21 #endif
  22
  23 #ifndef MAX
  24     #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
  25 #endif
  26
  27 #ifndef MIN
  28     #define MIN(a,b) ((a) < (b)? (a): (b))
  29 #endif
  30
  31 #include "quantum.h"
  32 #include "rgb_backlight.h"
  33 #include "rgb_backlight_api.h"
  34 #include "rgb_backlight_keycodes.h"
  35
  36 #if !defined(RGB_BACKLIGHT_HS60)
  37 #include <avr/io.h>
  38 #include <util/delay.h>
  39 #include <avr/interrupt.h>
  40 #include "drivers/avr/i2c_master.h"
  41 #else
  42 #include "ch.h"
  43 #include "hal.h"
  44 #include "drivers/arm/i2c_master.h"
  45 #include "tmk_core/common/eeprom.h"
  46 #endif
  47 #include "progmem.h"
  48 #include "quantum/color.h"
  49
  50 #if defined (RGB_BACKLIGHT_M6_B)
  51 #include "drivers/issi/is31fl3218.h"
  52 #define BACKLIGHT_LED_COUNT 6
  53 #elif defined (RGB_BACKLIGHT_HS60)
  54 #include "drivers/issi/is31fl3733.h"
  55 #define BACKLIGHT_LED_COUNT 64
  56 #else
  57 #include "drivers/issi/is31fl3731.h"
  58 #define BACKLIGHT_LED_COUNT 72
  59 #endif
  60
  61 #define BACKLIGHT_EFFECT_MAX 10
  62
  63 backlight_config g_config = {
  64         .use_split_backspace = RGB_BACKLIGHT_USE_SPLIT_BACKSPACE,
  65         .use_split_left_shift = RGB_BACKLIGHT_USE_SPLIT_LEFT_SHIFT,
  66         .use_split_right_shift = RGB_BACKLIGHT_USE_SPLIT_RIGHT_SHIFT,
  67         .use_7u_spacebar = RGB_BACKLIGHT_USE_7U_SPACEBAR,
  68         .use_iso_enter = RGB_BACKLIGHT_USE_ISO_ENTER,
  69         .disable_hhkb_blocker_leds = RGB_BACKLIGHT_DISABLE_HHKB_BLOCKER_LEDS,
  70         .disable_when_usb_suspended = RGB_BACKLIGHT_DISABLE_WHEN_USB_SUSPENDED,
  71         .disable_after_timeout = RGB_BACKLIGHT_DISABLE_AFTER_TIMEOUT,
  72         .brightness = RGB_BACKLIGHT_BRIGHTNESS,
  73         .effect = RGB_BACKLIGHT_EFFECT,
  74         .effect_speed = RGB_BACKLIGHT_EFFECT_SPEED,
  75         .color_1 = RGB_BACKLIGHT_COLOR_1,
  76         .color_2 = RGB_BACKLIGHT_COLOR_2,
  77         .caps_lock_indicator = RGB_BACKLIGHT_CAPS_LOCK_INDICATOR,
  78         .layer_1_indicator = RGB_BACKLIGHT_LAYER_1_INDICATOR,
  79         .layer_2_indicator = RGB_BACKLIGHT_LAYER_2_INDICATOR,
  80         .layer_3_indicator = RGB_BACKLIGHT_LAYER_3_INDICATOR,
  81         .alphas_mods = {
  82                 RGB_BACKLIGHT_ALPHAS_MODS_ROW_0,
  83                 RGB_BACKLIGHT_ALPHAS_MODS_ROW_1,
  84                 RGB_BACKLIGHT_ALPHAS_MODS_ROW_2,
  85                 RGB_BACKLIGHT_ALPHAS_MODS_ROW_3,
  86                 RGB_BACKLIGHT_ALPHAS_MODS_ROW_4 },
  87 #if defined(RGB_BACKLIGHT_M6_B)
  88         .custom_color = { { 0, 255 }, { 43, 255 }, { 85, 255 }, { 128, 255 }, { 171, 255 }, { 213, 255 } }
  89 #endif
  90 };
  91
  92 bool g_suspend_state = false;
  93 uint8_t g_indicator_state = 0;
  94
  95 // Global tick at 20 Hz
  96 uint32_t g_tick = 0;
  97
  98 // Ticks since this key was last hit.
  99 uint8_t g_key_hit[BACKLIGHT_LED_COUNT];
 100
 101 // Ticks since any key was last hit.
 102 uint32_t g_any_key_hit = 0;
 103
 104 #if defined(RGB_BACKLIGHT_HS60)
 105
 106 // This is a 7-bit address, that gets left-shifted and bit 0
 107 // set to 0 for write, 1 for read (as per I2C protocol)
 108 // ADDR_2 is not needed. it is here as a dummy
 109 #define ISSI_ADDR_1 0x50
 110 #define ISSI_ADDR_2 0x50
 111
 112 const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
 113 /* Refer to IS31 manual for these locations
 114  *   driver
 115  *   |  R location
 116  *   |  |      G location
 117  *   |  |      |      B location
 118  *   |  |      |      | */
 119     {0, B_1,   A_1,   C_1}, //LA1
 120     {0, E_1,   D_1,   F_1}, //LA2
 121     {0, H_1,   G_1,   I_1}, //LA3
 122     {0, K_1,   J_1,   L_1}, //LA4
 123     {0, B_2,   A_2,   C_2}, //LA5
 124     {0, E_2,   D_2,   F_2}, //LA6
 125     {0, H_2,   G_2,   I_2}, //LA7
 126     {0, K_2,   J_2,   L_2}, //LA8
 127     {0, B_3,   A_3,   C_3}, //LA9
 128     {0, E_3,   D_3,   F_3}, //LA10
 129     {0, H_3,   G_3,   I_3}, //LA11
 130     {0, K_3,   J_3,   L_3}, //LA12
 131     {0, B_4,   A_4,   C_4}, //LA13
 132     {0, E_4,   D_4,   F_4}, //LA14
 133     {0, H_4,   G_4,   I_4}, //LA15
 134     {0, K_4,   J_4,   L_4}, //LA16
 135     {0, B_5,   A_5,   C_5}, //LA17
 136     {0, E_5,   D_5,   F_5}, //LA18
 137     {0, H_5,   G_5,   I_5}, //LA19
 138     {0, K_5,   J_5,   L_5}, //LA20
 139     {0, B_6,   A_6,   C_6}, //LA21
 140     {0, E_6,   D_6,   F_6}, //LA22
 141     {0, H_6,   G_6,   I_6}, //LA23
 142     {0, K_6,   J_6,   L_6}, //LA24
 143     {0, B_7,   A_7,   C_7}, //LA25
 144     {0, E_7,   D_7,   F_7}, //LA26
 145     {0, H_7,   G_7,   I_7}, //LA27
 146     {0, K_7,   J_7,   L_7}, //LA28
 147     {0, B_8,   A_8,   C_8}, //LA29
 148     {0, E_8,   D_8,   F_8}, //LA30
 149     {0, H_8,   G_8,   I_8}, //LA31
 150     {0, K_8,   J_8,   L_8}, //LA32
 151     {0, B_9,   A_9,   C_9}, //LA33
 152     {0, E_9,   D_9,   F_9}, //LA34
 153     {0, H_9,   G_9,   I_9}, //LA35
 154     {0, K_9,   J_9,   L_9}, //LA36
 155     {0, B_10,  A_10,  C_10}, //LA37
 156     {0, E_10,  D_10,  F_10}, //LA38
 157     {0, H_10,  G_10,  I_10}, //LA39
 158     {0, K_10,  J_10,  L_10}, //LA40
 159     {0, B_11,  A_11,  C_11}, //LA41
 160     {0, E_11,  D_11,  F_11}, //LA42
 161     {0, H_11,  G_11,  I_11}, //LA43
 162     {0, K_11,  J_11,  L_11}, //LA44
 163     {0, B_12,  A_12,  C_12}, //LA45
 164     {0, E_12,  D_12,  F_12}, //LA46
 165     {0, H_12,  G_12,  I_12}, //LA47
 166     {0, K_12,  J_12,  L_12}, //LA48
 167     {0, B_13,  A_13,  C_13}, //LA49
 168     {0, E_13,  D_13,  F_13}, //LA50
 169     {0, H_13,  G_13,  I_13}, //LA51
 170     {0, K_13,  J_13,  L_13}, //LA52
 171     {0, B_14,  A_14,  C_14}, //LA53
 172     {0, E_14,  D_14,  F_14}, //LA54
 173     {0, H_14,  G_14,  I_14}, //LA55
 174     {0, K_14,  J_14,  L_14}, //LA56
 175     {0, B_15,  A_15,  C_15}, //LA57
 176     {0, E_15,  D_15,  F_15}, //LA58
 177     {0, H_15,  G_15,  I_15}, //LA59
 178     {0, K_15,  J_15,  L_15}, //LA60
 179     {0, B_16,  A_16,  C_16}, //LA61
 180     {0, E_16,  D_16,  F_16}, //LA62
 181     {0, H_16,  G_16,  I_16}, //LA63
 182     {0, K_16,  J_16,  L_16}, //LA64
 183 };
 184
 185 #elif !defined(RGB_BACKLIGHT_M6_B)
 186 // This is a 7-bit address, that gets left-shifted and bit 0
 187 // set to 0 for write, 1 for read (as per I2C protocol)
 188 #define ISSI_ADDR_1 0x74
 189 #define ISSI_ADDR_2 0x76
 190
 191 const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
 192 /* Refer to IS31 manual for these locations
 193  *   driver
 194  *   |  R location
 195  *   |  |      G location
 196  *   |  |      |      B location
 197  *   |  |      |      | */
 198         {0, C2_1,  C3_1,  C4_1},  // LA0
 199         {0, C1_1,  C3_2, C4_2},   // LA1
 200         {0, C1_2,  C2_2, C4_3},   // LA2
 201         {0, C1_3,  C2_3, C3_3},   // LA3
 202         {0, C1_4,  C2_4, C3_4},   // LA4
 203         {0, C1_5,  C2_5, C3_5},   // LA5
 204         {0, C1_6,  C2_6, C3_6},   // LA6
 205         {0, C1_7,  C2_7, C3_7},   // LA7
 206         {0, C1_8,  C2_8, C3_8},   // LA8
 207         {0, C9_1,  C8_1,  C7_1},  // LA9
 208         {0, C9_2,  C8_2, C7_2},   // LA10
 209         {0, C9_3,  C8_3, C7_3},   // LA11
 210         {0, C9_4,  C8_4, C7_4},   // LA12
 211         {0, C9_5,  C8_5, C7_5},   // LA13
 212         {0, C9_6,  C8_6, C7_6},   // LA14
 213         {0, C9_7,  C8_7, C6_6},   // LA15
 214         {0, C9_8,  C7_7, C6_7},   // LA16
 215         {0, C8_8,  C7_8, C6_8},   // LA17
 216
 217         {0, C2_9,  C3_9,  C4_9},  // LB0
 218         {0, C1_9,  C3_10, C4_10}, // LB1
 219         {0, C1_10, C2_10, C4_11}, // LB2
 220         {0, C1_11, C2_11, C3_11}, // LB3
 221         {0, C1_12, C2_12, C3_12}, // LB4
 222         {0, C1_13, C2_13, C3_13}, // LB5
 223         {0, C1_14, C2_14, C3_14}, // LB6
 224         {0, C1_15, C2_15, C3_15}, // LB7
 225         {0, C1_16, C2_16, C3_16}, // LB8
 226         {0, C9_9,  C8_9,  C7_9},  // LB9
 227         {0, C9_10, C8_10, C7_10}, // LB10
 228         {0, C9_11, C8_11, C7_11}, // LB11
 229         {0, C9_12, C8_12, C7_12}, // LB12
 230         {0, C9_13, C8_13, C7_13}, // LB13
 231         {0, C9_14, C8_14, C7_14}, // LB14
 232         {0, C9_15, C8_15, C6_14}, // LB15
 233         {0, C9_16, C7_15, C6_15}, // LB16
 234         {0, C8_16, C7_16, C6_16}, // LB17
 235
 236         {1, C2_1,  C3_1,  C4_1},  // LC0
 237         {1, C1_1,  C3_2, C4_2},   // LC1
 238         {1, C1_2,  C2_2, C4_3},   // LC2
 239         {1, C1_3,  C2_3, C3_3},   // LC3
 240         {1, C1_4,  C2_4, C3_4},   // LC4
 241         {1, C1_5,  C2_5, C3_5},   // LC5
 242         {1, C1_6,  C2_6, C3_6},   // LC6
 243         {1, C1_7,  C2_7, C3_7},   // LC7
 244         {1, C1_8,  C2_8, C3_8},   // LC8
 245         {1, C9_1,  C8_1,  C7_1},  // LC9
 246         {1, C9_2,  C8_2, C7_2},   // LC10
 247         {1, C9_3,  C8_3, C7_3},   // LC11
 248         {1, C9_4,  C8_4, C7_4},   // LC12
 249         {1, C9_5,  C8_5, C7_5},   // LC13
 250         {1, C9_6,  C8_6, C7_6},   // LC14
 251         {1, C9_7,  C8_7, C6_6},   // LC15
 252         {1, C9_8,  C7_7, C6_7},   // LC16
 253         {1, C8_8,  C7_8, C6_8},   // LC17
 254
 255         {1, C2_9,  C3_9,  C4_9},  // LD0
 256         {1, C1_9,  C3_10, C4_10}, // LD1
 257         {1, C1_10, C2_10, C4_11}, // LD2
 258         {1, C1_11, C2_11, C3_11}, // LD3
 259         {1, C1_12, C2_12, C3_12}, // LD4
 260         {1, C1_13, C2_13, C3_13}, // LD5
 261         {1, C1_14, C2_14, C3_14}, // LD6
 262         {1, C1_15, C2_15, C3_15}, // LD7
 263         {1, C1_16, C2_16, C3_16}, // LD8
 264         {1, C9_9,  C8_9,  C7_9},  // LD9
 265         {1, C9_10, C8_10, C7_10}, // LD10
 266         {1, C9_11, C8_11, C7_11}, // LD11
 267         {1, C9_12, C8_12, C7_12}, // LD12
 268         {1, C9_13, C8_13, C7_13}, // LD13
 269         {1, C9_14, C8_14, C7_14}, // LD14
 270         {1, C9_15, C8_15, C6_14}, // LD15
 271         {1, C9_16, C7_15, C6_15}, // LD16
 272         {1, C8_16, C7_16, C6_16}, // LD17
 273 };
 274 #endif // !defined(RGB_BACKLIGHT_M6_B)
 275
 276
 277 typedef struct Point {
 278         uint8_t x;
 279         uint8_t y;
 280 } Point;
 281
 282
 283 // index in range 0..71 (LA0..LA17, LB0..LB17, LC0..LC17, LD0..LD17)
 284 // point values in range x=0..224 y=0..64
 285 // origin is center of top-left key (i.e Esc)
 286 #if defined (RGB_BACKLIGHT_ZEAL65)
 287 const Point g_map_led_to_point[BACKLIGHT_LED_COUNT] PROGMEM = {
 288         // LA0..LA17
 289         {120,16}, {104,16}, {88,16}, {72,16}, {56,16}, {40,16}, {24,16}, {4,16}, {4,32},
 290         {128,0}, {112,0}, {96,0}, {80,0}, {64,0}, {48,0}, {32,0}, {16,0}, {0,0},
 291         // LB0..LB17
 292         {144,0}, {160,0}, {176,0}, {192,0}, {216,0}, {224,0}, {240,0}, {240,16}, {240,32},
 293         {136,16}, {152,16}, {168,16}, {184,16}, {200,16}, {220,16}, {240,48}, {240,64}, {224,64},
 294         // LC0..LC17
 295         {96,64}, {100,48}, {84,48}, {68,48}, {52,48}, {36,48}, {255,255}, {48,60}, {28,64},
 296         {108,32}, {92,32}, {76,32}, {60,32}, {44,32}, {28,32}, {20,44}, {10,48}, {4,64},
 297         // LD0..LD17
 298         {124,32}, {140,32}, {156,32}, {172,32}, {188,32}, {214,32}, {180,48}, {202,48}, {224,48},
 299         {116,48}, {132,48}, {148,48}, {164,48}, {255,255}, {144,60}, {164,64}, {188,64}, {208,64}
 300 };
 301 const Point g_map_led_to_point_polar[BACKLIGHT_LED_COUNT] PROGMEM = {
 302         // LA0..LA17
 303         {64,128}, {75,132}, {84,145}, {91,164}, {97,187}, {102,213}, {105,242}, {109,255}, {128,243},
 304         {61,255}, {67,255}, {72,255}, {77,255}, {82,255}, {86,255}, {90,255}, {93,255}, {96,255},
 305         // LB0..LB17
 306         {56,255}, {51,255}, {46,255}, {42,255}, {37,255}, {35,255}, {32,255}, {19,255}, {0,255},
 307         {53,132}, {44,145}, {37,164}, {31,187}, {26,213}, {22,249}, {237,255}, {224,255}, {221,255},
 308         // LC0..LC17
 309         {184,255}, {179,135}, {170,149}, {163,169}, {157,193}, {153,220}, {255,255}, {167,255}, {165,255},
 310         {128,26}, {128,60}, {128,94}, {128,128}, {128,162}, {128,196}, {145,233}, {148,255}, {161,255},
 311         // LD0..LD17
 312         {0,9}, {0,43}, {0,77}, {0,111}, {0,145}, {0,201}, {224,181}, {230,217}, {235,255},
 313         {189,128}, {200,131}, {210,141}, {218,159}, {255,255}, {201,228}, {206,255}, {213,255}, {218,255}
 314 };
 315 #elif defined (RGB_BACKLIGHT_KOYU)
 316 const Point g_map_led_to_point[BACKLIGHT_LED_COUNT] PROGMEM = {
 317         // LA0..LA17
 318         {120,16}, {104,16}, {88,16}, {72,16}, {56,16}, {40,16}, {24,16}, {4,16}, {4,32},
 319         {128,0}, {112,0}, {96,0}, {80,0}, {64,0}, {48,0}, {32,0}, {16,0}, {0,0},
 320         // LB0..LB17
 321         {144,0}, {160,0}, {176,0}, {192,0}, {208,0}, {224,0}, {240,0}, {240,16}, {240,32},
 322         {136,16}, {152,16}, {168,16}, {184,16}, {200,16}, {220,16}, {240,48}, {240,64}, {224,64},
 323         // LC0..LC17
 324         {112,64}, {100,48}, {84,48}, {68,48}, {52,48}, {36,48}, {64,60}, {44,60}, {24,64},
 325         {108,32}, {92,32}, {76,32}, {60,32}, {44,32}, {28,32}, {255,255}, {10,48}, {4,64},
 326         // LD0..LD17
 327         {124,32}, {140,32}, {156,32}, {172,32}, {188,32}, {214,32}, {180,48}, {202,48}, {224,48},
 328         {116,48}, {132,48}, {148,48}, {164,48}, {255,255}, {160,60}, {180,64}, {208,64}, {255,255}
 329 };
 330 const Point g_map_led_to_point_polar[BACKLIGHT_LED_COUNT] PROGMEM = {
 331         // LA0..LA17
 332         {64,128}, {75,132}, {84,145}, {91,164}, {97,187}, {102,213}, {105,242}, {109,255}, {128,243},
 333         {61,255}, {67,255}, {72,255}, {77,255}, {82,255}, {86,255}, {90,255}, {93,255}, {96,255},
 334         // LB0..LB17
 335         {56,255}, {51,255}, {46,255}, {42,255}, {38,255}, {35,255}, {32,255}, {19,255}, {0,255},
 336         {53,132}, {44,145}, {37,164}, {31,187}, {26,213}, {22,249}, {237,255}, {224,255}, {221,255},
 337         // LC0..LC17
 338         {189,255}, {179,135}, {170,149}, {163,169}, {157,193}, {153,220}, {172,252}, {169,255}, {165,255},
 339         {128,26}, {128,60}, {128,94}, {128,128}, {128,162}, {128,196}, {255,255}, {148,255}, {161,255},
 340         // LD0..LD17
 341         {0,9}, {0,43}, {0,77}, {0,111}, {0,145}, {0,201}, {224,181}, {230,217}, {235,255},
 342         {189,128}, {200,131}, {210,141}, {218,159}, {255,255}, {207,238}, {211,255}, {218,255}, {255,255}
 343 };
 344 #elif defined (RGB_BACKLIGHT_ZEAL60) || defined (RGB_BACKLIGHT_M60_A)
 345 const Point g_map_led_to_point[BACKLIGHT_LED_COUNT] PROGMEM = {
 346         // LA0..LA17
 347         {120,16}, {104,16}, {88,16}, {72,16}, {56,16}, {40,16}, {24,16}, {4,16}, {4,32},
 348         {128,0}, {112,0}, {96,0}, {80,0}, {64,0}, {48,0}, {32,0}, {16,0}, {0,0},
 349         // LB0..LB17
 350         {144,0}, {160,0}, {176,0}, {192,0}, {216,0}, {224,0}, {255,255}, {255,255}, {255,255},
 351         {136,16}, {152,16}, {168,16}, {184,16}, {200,16}, {220,16}, {255,255}, {255,255}, {255,255},
 352         // LC0..LC17
 353         {102,64}, {100,48}, {84,48}, {68,48}, {52,48}, {36,48}, {60,64}, {43,64}, {23,64},
 354         {108,32}, {92,32}, {76,32}, {60,32}, {44,32}, {28,32}, {20,48}, {2,48}, {3,64},
 355         // LD0..LD17
 356         {124,32}, {140,32}, {156,32}, {172,32}, {188,32}, {214,32}, {180,48}, {210,48}, {224,48},
 357         {116,48}, {132,48}, {148,48}, {164,48}, {144,64}, {161,64}, {181,64}, {201,64}, {221,64}
 358 };
 359 const Point g_map_led_to_point_polar[BACKLIGHT_LED_COUNT] PROGMEM = {
 360         // LA0..LA17
 361         {58,129}, {70,129}, {80,139}, {89,157}, {96,181}, {101,208}, {105,238}, {109,255}, {128,247}, {58,255},
 362         {64,255}, {70,255}, {75,255}, {80,255}, {85,255}, {89,255}, {93,255}, {96,255},
 363         // LB0..LB17
 364         {53,255}, {48,255}, {43,255}, {39,255}, {34,255}, {32,255}, {255,255}, {255,255}, {255,255},
 365         {48,139}, {39,157}, {32,181}, {27,208}, {23,238}, {19,255}, {255,255}, {255,255}, {255,255},
 366         // LC0..LC17
 367         {188,255}, {183,131}, {173,143}, {165,163}, {159,188}, {154,216}, {172,252}, {170,255}, {165,255},
 368         {128,9}, {128,46}, {128,82}, {128,119}, {128,155}, {128,192}, {150,244}, {147,255}, {161,255},
 369         // LD0..LD17
 370         {0,27}, {0,64}, {0,101}, {0,137}, {0,174}, {255,233}, {228,201}, {235,255}, {237,255},
 371         {195,128}, {206,136}, {215,152}, {222,175}, {205,234}, {209,255}, {214,255}, {219,255}, {223,255}
 372 };
 373 #elif defined (RGB_BACKLIGHT_HS60) && defined (HS60_ANSI)
 374 const Point g_map_led_to_point[BACKLIGHT_LED_COUNT] PROGMEM = {
 375         // LA1..LA47
 376         {0,0}, {4,16}, {6,32}, {10,48}, {16,0}, {24,16}, {28,32}, {36,48}, {32,0}, {40,16}, {44,32}, {52,48},
 377         {48,0}, {56,16}, {60,32}, {68,48}, {64,0}, {72,16}, {76,32}, {84,48}, {80,0}, {88,16}, {92,32}, {100,48},
 378         {96,0}, {104,16}, {108,32}, {116,48}, {112,0}, {120,16}, {124,32}, {132,48}, {128,0}, {136,16}, {140,32},
 379         {148,48}, {144,0}, {152,16}, {156,32}, {164,48}, {160,0}, {168,16}, {172,32}, {180,48}, {176,0}, {184, 16}, {188,32},
 380         {255,255},// LA48 does not exist, dummy
 381         // LA49..LA50
 382         {192,0}, {200,16},
 383         {255,255},// LA51 does not exit, dummy
 384         // LA52..LA60
 385         {210,48}, {216,0}, {220,16}, {214,32}, {222,64}, {2,64}, {22,64}, {42,64}, {102,64},
 386         {255,255},// LA61 does not exit, dummy
 387         {162,64}, {182,64}, {202,64}
 388 };
 389 const Point g_map_led_to_point_polar[BACKLIGHT_LED_COUNT] PROGMEM = {
 390         // LA1..LA47
 391         {96,255}, {109,255}, {128,242}, {148,255}, {93,255}, {105,238}, {128,192}, {154,216}, {89,255}, {101,208}, {128,155}, {159,188},
 392         {85,255}, {96,181}, {128,119}, {165,163}, {81,255}, {89,157}, {128,82}, {173,143}, {75,255}, {81,139}, {128,46}, {183,131},
 393         {70,255}, {70,129}, {129,9}, {195,128}, {64,255}, {58,129}, {255,27}, {206,136}, {58,255}, {47,139}, {255,64}, {215,152},
 394         {53,255}, {39,157}, {255,101}, {222,175}, {47,255}, {32,181}, {255,137}, {228,201}, {43,255}, {27,208}, {255, 174},
 395         {255,255},// LA48 does not exist, dummy
 396         // LA49..LA50
 397         {39,255}, {23,238},
 398         {255,255},// LA51 does not exit, dummy
 399         // LA52..LA60
 400         {235,255}, {33,255}, {19,255}, {255,233}, {224,255}, {160,255}, {164,255}, {169,255}, {188,255},
 401         {255,255},// LA61 does not exit, dummy
 402         {209,255}, {215,255}, {220,255}
 403 };
 404 #elif defined (RGB_BACKLIGHT_HS60) && defined (HS60_HHKB)
 405 const Point g_map_led_to_point[BACKLIGHT_LED_COUNT] PROGMEM = {
 406         // LA1..LA60
 407         {0,0}, {4,16}, {6,32}, {10,48}, {16,0}, {24,16}, {28,32}, {36,48}, {32,0}, {40,16}, {44,32}, {52,48},
 408         {48,0}, {56,16}, {60,32}, {68,48}, {64,0}, {72,16}, {76,32}, {84,48}, {80,0}, {88,16}, {92,32}, {100,48},
 409         {96,0}, {104,16}, {108,32}, {116,48}, {112,0}, {120,16}, {124,32}, {132,48}, {128,0}, {136,16}, {140,32},
 410         {148,48}, {144,0}, {152,16}, {156,32}, {164,48}, {160,0}, {168,16}, {172,32}, {180,48}, {176,0}, {184, 16}, {188,32},
 411         {224,0}, {192,0}, {200,16}, {202,48}, {224,48}, {208,0}, {220,16}, {214,32}, {220,64}, {4,64}, {24,64}, {44,64}, {112,64},
 412         {255,255}, {255,255}, // LA61..LA62 does not exit, dummy
 413         // LA63..LA64
 414         {180,64}, {200,64}
 415 };
 416 const Point g_map_led_to_point_polar[BACKLIGHT_LED_COUNT] PROGMEM = {
 417         // LA1..LA60
 418         {96,255}, {109,255}, {128,242}, {148,255}, {93,255}, {105,238}, {128,192}, {154,216}, {89,255}, {101,208}, {128,155}, {159,188},
 419         {85,255}, {96,181}, {128,119}, {165,163}, {81,255}, {89,157}, {128,82}, {173,143}, {75,255}, {81,139}, {128,46}, {183,131},
 420         {70,255}, {70,129}, {129,9}, {195,128}, {64,255}, {58,129}, {255,27}, {206,136}, {58,255}, {47,139}, {255,64}, {215,152},
 421         {53,255}, {39,157}, {255,101}, {222,175}, {47,255}, {32,181}, {255,137}, {228,201}, {43,255}, {27,208}, {255, 174}, {32,255},
 422         {39,255}, {23,238}, {233,242}, {237,255}, {35,255}, {19,255}, {255,233}, {223,255}, {161,255}, {165,255}, {170,255}, {192,255},
 423         {255,255}, {255,255}, // LA61..LA62 does not exit, dummy
 424         // LA63..LA64
 425         {214,255}, {219,255}
 426 };
 427 #elif defined (RGB_BACKLIGHT_HS60) //HS60_ISO
 428 const Point g_map_led_to_point[BACKLIGHT_LED_COUNT] PROGMEM = {
 429         // LA1..LA50
 430         {0,0}, {4,16}, {6,32}, {2,48}, {16,0}, {24,16}, {28,32}, {36,48}, {32,0}, {40,16}, {44,32}, {52,48}, {48,0},
 431         {56,16}, {60,32}, {68,48}, {64,0}, {72,16}, {76,32}, {84,48}, {80,0}, {88,16}, {92,32}, {100,48}, {96,0}, {104,16},
 432         {108,32}, {116,48}, {112,0}, {120,16}, {124,32}, {132,48}, {128,0}, {136,16}, {140,32}, {148,48}, {144,0}, {152,16},
 433         {156,32}, {164,48}, {160,0}, {168,16}, {172,32}, {180,48}, {176,0}, {184, 16}, {188,32}, {20,48}, {192,0}, {200,16},
 434         {255,255},// LA51 does not exit, dummy
 435         // LA52..LA60
 436         {210,48}, {216,0}, {220,16}, {222,24}, {222,64}, {2,64}, {22,64}, {42,64}, {102,64},
 437         {255,255},// LA61 does not exit, dummy
 438         {162,64}, {182,64}, {202,64}
 439 };
 440 const Point g_map_led_to_point_polar[BACKLIGHT_LED_COUNT] PROGMEM = {
 441         // LA1..LA50
 442         {96,255}, {109,255}, {128,242}, {147,255}, {93,255}, {105,238}, {128,192}, {154,216}, {89,255}, {101,208}, {128,155}, {159,188}, {85,255},
 443         {96,181}, {128,119}, {165,163}, {81,255}, {89,157}, {128,82}, {173,143}, {75,255}, {81,139}, {128,46}, {183,131}, {70,255}, {70,129},
 444         {129,9}, {195,128}, {64,255}, {58,129}, {255,27}, {206,136}, {58,255}, {47,139}, {255,64}, {215,152}, {53,255}, {39,157}, {255,101},
 445         {222,175}, {47,255}, {32,181}, {255,137}, {228,201}, {43,255}, {27,208}, {255, 174}, {150,246}, {39,255}, {23,238},
 446         {255,255},// LA51 does not exit, dummy
 447         // LA52..LA60
 448         {235,255}, {33,255}, {19,255}, {10,255}, {224,255}, {160,255}, {164,255}, {169,255}, {188,255},
 449         {255,255},// LA61 does not exit, dummy
 450         {209,255}, {215,255}, {220,255}
 451 };
 452 #elif defined (RGB_BACKLIGHT_M6_B)
 453 // M6-B is really simple:
 454 // 0 3 5
 455 // 1 2 4
 456 const Point g_map_led_to_point[BACKLIGHT_LED_COUNT] PROGMEM = {
 457         {0,0}, {0,16}, {16,16}, {16,0}, {32,16}, {32,0}
 458 };
 459 const Point g_map_led_to_point_polar[BACKLIGHT_LED_COUNT] PROGMEM = {
 460         {160,255}, {96,255}, {77,255}, {179,255}, {51,255}, {205,255}
 461 };
 462 #endif
 463
 464 // This may seem counter-intuitive, but it's quite flexible.
 465 // For each LED, get it's position to decide what color to make it.
 466 // This solves the issue of LEDs (and switches) not aligning to a grid,
 467 // or having a large "bitmap" and sampling them.
 468 void map_led_to_point( uint8_t index, Point *point )
 469 {
 470         // Slightly messy way to get Point structs out of progmem.
 471         uint8_t *addr = (uint8_t*)&g_map_led_to_point[index];
 472         point->x = pgm_read_byte(addr);
 473         point->y = pgm_read_byte(addr+1);
 474
 475 #if defined (RGB_BACKLIGHT_M6_B)
 476         return;
 477 #endif
 478
 479         switch (index)
 480         {
 481                 case 18+4: // LB4A
 482                         if ( g_config.use_split_backspace )
 483                                 point->x -= 8;
 484                         break;
 485 #if defined (RGB_BACKLIGHT_ZEAL60)
 486                 case 18+14: // LB14A
 487                         if ( g_config.use_iso_enter )
 488                                 point->y += 8; // extremely pedantic
 489                         break;
 490                 case 54+5: // LD5A
 491                         if ( !g_config.use_iso_enter )
 492                                 point->x -= 10;
 493                         break;
 494                 case 36+16: // LC16A
 495                         if ( !g_config.use_split_left_shift )
 496                                 point->x += 8;
 497                         break;
 498 #endif
 499 #if defined (RGB_BACKLIGHT_ZEAL60) || defined (RGB_BACKLIGHT_M60_A)
 500                 case 36+0: // LC0A
 501                         if ( g_config.use_7u_spacebar )
 502                                 point->x += 10;
 503                         break;
 504                 case 36+6: // LC6A
 505                         if ( g_config.use_7u_spacebar )
 506                                 point->x += 4;
 507                         break;
 508                 case 54+7: // LD7A
 509                         if ( !g_config.use_split_right_shift )
 510                                 point->x -= 8;
 511                         break;
 512 #endif
 513         }
 514 }
 515
 516 void map_led_to_point_polar( uint8_t index, Point *point )
 517 {
 518         // Slightly messy way to get Point structs out of progmem.
 519         uint8_t *addr = (uint8_t*)&g_map_led_to_point_polar[index];
 520         point->x = pgm_read_byte(addr);
 521         point->y = pgm_read_byte(addr+1);
 522 }
 523
 524 //
 525 // Maps switch matrix coordinate (row,col) to LED index
 526 //
 527
 528
 529 #if defined (RGB_BACKLIGHT_ZEAL65)
 530 // Note: Left spacebar stab is at 4,2 (LC7)
 531 // Right spacebar stab is at 4,9 (D14)
 532 //
 533 // A17, A16, A15, A14, A13, A12, A11, A10,  A9,  B0,  B1,  B2,  B3,  B4,  B6
 534 //  A7,  A6,  A5,  A4,  A3,  A2,  A1,  A0,  B9, B10, B11, B12, B13, B14,  B7
 535 //  A8, C14, C13, C12, C11, C10,  C9,  D0,  D1,  D2,  D3,  D4,  D5,  B5,  B8
 536 // C16, C15,  C5,  C4,  C3,  C2,  C1,  D9, D10, D11, D12,  D6,  D7,  D8, B15
 537 // C17,  C8,  C7, ---, ---, ---, ---,  C0, ---, D14, D15, D16, D17, B17, B16
 538 const uint8_t g_map_row_column_to_led[MATRIX_ROWS][MATRIX_COLS] PROGMEM = {
 539         {  0+17,  0+16,  0+15,  0+14,  0+13,  0+12,  0+11,  0+10,   0+9,  18+0,  18+1,  18+2,  18+3,  18+4,  18+6 },
 540         {   0+7,   0+6,   0+5,   0+4,   0+3,   0+2,   0+1,   0+0,  18+9, 18+10, 18+11, 18+12, 18+13, 18+14,  18+7 },
 541         {   0+8, 36+14, 36+13, 36+12, 36+11, 36+10,  36+9,  54+0,  54+1,  54+2,  54+3,  54+4,  54+5,  18+5,  18+8 },
 542         { 36+16, 36+15,  36+5,  36+4,  36+3,  36+2,  36+1,  54+9, 54+10, 54+11, 54+12,  54+6,  54+7,  54+8, 18+15 },
 543         { 36+17,  36+8,  36+7,   255,   255,   255,   255,  36+0,  255,  54+14, 54+15, 54+16, 54+17, 18+17, 18+16 }
 544 };
 545 #elif defined(RGB_BACKLIGHT_KOYU)
 546 // Note: Left spacebar stab is at 4,4 (LC6)
 547 // Right spacebar stab is at 4,10 (D14)
 548 //
 549 // A17, A16, A15, A14, A13, A12, A11, A10,  A9,  B0,  B1,  B2,  B3,  B4,  B6
 550 //  A7,  A6,  A5,  A4,  A3,  A2,  A1,  A0,  B9, B10, B11, B12, B13, B14,  B7
 551 //  A8, C14, C13, C12, C11, C10,  C9,  D0,  D1,  D2,  D3,  D4,  D5,  B5,  B8
 552 // C16, C15,  C5,  C4,  C3,  C2,  C1,  D9, D10, D11, D12,  D6,  D7,  D8, B15
 553 // C17,  C8,  C7,  C6, ---, ---, ---,  C0, ---, ---, D14, D15, D16, B17, B16
 554 const uint8_t g_map_row_column_to_led[MATRIX_ROWS][MATRIX_COLS] PROGMEM = {
 555         {  0+17,  0+16,  0+15,  0+14,  0+13,  0+12,  0+11,  0+10,   0+9,  18+0,  18+1,  18+2,  18+3,  18+4,  18+6 },
 556         {   0+7,   0+6,   0+5,   0+4,   0+3,   0+2,   0+1,   0+0,  18+9, 18+10, 18+11, 18+12, 18+13, 18+14,  18+7 },
 557         {   0+8, 36+14, 36+13, 36+12, 36+11, 36+10,  36+9,  54+0,  54+1,  54+2,  54+3,  54+4,  54+5,  18+5,  18+8 },
 558         { 36+16, 36+15,  36+5,  36+4,  36+3,  36+2,  36+1,  54+9, 54+10, 54+11, 54+12,  54+6,  54+7,  54+8, 18+15 },
 559         { 36+17,  36+8,  36+7,  36+6,   255,   255,   255,  36+0,  255,    255, 54+14, 54+15, 54+16, 18+17, 18+16 }
 560 };
 561 #elif defined (RGB_BACKLIGHT_ZEAL60) || defined (RGB_BACKLIGHT_M60_A)
 562 // Note: Left spacebar stab is at 4,3 (LC6)
 563 // Right spacebar stab is at 4,9 (LD13) or 4,10 (LD14)
 564 //
 565 // A17, A16, A15, A14, A13, A12, A11, A10,  A9,  B0,  B1,  B2,  B3,  B4,
 566 //  A7,  A6,  A5,  A4,  A3,  A2,  A1,  A0,  B9, B10, B11, B12, B13, B14,
 567 //  A8, C14, C13, C12, C11, C10,  C9,  D0,  D1,  D2,  D3,  D4,  D5,  B5,
 568 // C16, C15,  C5,  C4,  C3,  C2,  C1,  D9, D10, D11, D12,  D6,  D7,  D8,
 569 // C17,  C8,  C7,  C6, ---, ---, ---,  C0, ---, D13, D14, D15, D16, D17,
 570 const uint8_t g_map_row_column_to_led[MATRIX_ROWS][MATRIX_COLS] PROGMEM = {
 571         {  0+17,  0+16,  0+15,  0+14,  0+13,  0+12,  0+11,  0+10,   0+9,  18+0,  18+1,  18+2,  18+3,  18+4 },
 572         {   0+7,   0+6,   0+5,   0+4,   0+3,   0+2,   0+1,   0+0,  18+9, 18+10, 18+11, 18+12, 18+13, 18+14 },
 573         {   0+8, 36+14, 36+13, 36+12, 36+11, 36+10,  36+9,  54+0,  54+1,  54+2,  54+3,  54+4,  54+5,  18+5 },
 574         { 36+16, 36+15,  36+5,  36+4,  36+3,  36+2,  36+1,  54+9, 54+10, 54+11, 54+12,  54+6,  54+7,  54+8 },
 575         { 36+17,  36+8,  36+7,  36+6,   255,   255,   255,  36+0,  255,  54+13, 54+14, 54+15, 54+16, 54+17 }
 576 };
 577 #elif defined (RGB_BACKLIGHT_HS60) && defined (HS60_ANSI)
 578 //
 579 // LA1,  LA5,  LA9,  LA13, LA17, LA21, LA25, LA29, LA33, LA37, LA41, LA45, LA49, LA53,
 580 // LA2,  LA6,  LA10, LA14, LA18, LA22, LA26, LA30, LA34, LA38, LA42, LA46, LA50,  ---,
 581 // LA3,  LA7,  LA11, LA15, LA19, LA23, LA27, LA31, LA35, LA39, LA43, LA47, LA54, LA55,
 582 // LA4,  ---,   LA8, LA12, LA16, LA20, LA24, LA28, LA32, LA36, LA40, LA44,  ---, LA52,
 583 // LA57, LA58, LA59,  ---,  ---,  ---, LA60,  ---,  ---,  ---, LA62, LA63, LA64, LA56
 584 const uint8_t g_map_row_column_to_led[MATRIX_ROWS][MATRIX_COLS] PROGMEM = {
 585         {  1-1,  5-1,  9-1, 13-1, 17-1, 21-1, 25-1, 29-1, 33-1, 37-1, 41-1, 45-1, 49-1, 53-1 },
 586         {  2-1,  6-1, 10-1, 14-1, 18-1, 22-1, 26-1, 30-1, 34-1, 38-1, 42-1, 46-1, 50-1,  255 },
 587         {  3-1,  7-1, 11-1, 15-1, 19-1, 23-1, 27-1, 31-1, 35-1, 39-1, 43-1, 47-1, 54-1, 55-1 },
 588         {  4-1,  255,  8-1, 12-1, 16-1, 20-1, 24-1, 28-1, 32-1, 36-1, 40-1, 44-1,  255, 52-1 },
 589         { 57-1, 58-1, 59-1,  255,  255,  255, 60-1,  255,  255,  255, 62-1, 63-1, 64-1, 56-1 }
 590 };
 591 #elif defined (RGB_BACKLIGHT_HS60) && defined (HS60_HHKB)
 592 //
 593 // LA1,  LA5,   LA9, LA13, LA17, LA21, LA25, LA29, LA33, LA37, LA41, LA45, LA49, LA53,
 594 // LA2,  LA6,  LA10, LA14, LA18, LA22, LA26, LA30, LA34, LA38, LA42, LA46, LA50, LA48,
 595 // LA3,  LA7,  LA11, LA15, LA19, LA23, LA27, LA31, LA35, LA39, LA43, LA47, LA54, LA55,
 596 // LA4,  ---,   LA8, LA12, LA16, LA20, LA24, LA28, LA32, LA36, LA40, LA44, LA51, LA52,
 597 // LA57, LA58, LA59,  ---,  ---,  ---, LA60,  ---,  ---,  ---,  ---, LA63, LA64, LA56
 598 const uint8_t g_map_row_column_to_led[MATRIX_ROWS][MATRIX_COLS] PROGMEM = {
 599         {  1-1,  5-1,  9-1, 13-1, 17-1, 21-1, 25-1, 29-1, 33-1, 37-1, 41-1, 45-1, 49-1, 53-1 },
 600         {  2-1,  6-1, 10-1, 14-1, 18-1, 22-1, 26-1, 30-1, 34-1, 38-1, 42-1, 46-1, 50-1, 48-1 },
 601         {  3-1,  7-1, 11-1, 15-1, 19-1, 23-1, 27-1, 31-1, 35-1, 39-1, 43-1, 47-1, 54-1, 55-1 },
 602         {  4-1,  255,  8-1, 12-1, 16-1, 20-1, 24-1, 28-1, 32-1, 36-1, 40-1, 44-1, 51-1, 52-1 },
 603         { 57-1, 58-1, 59-1,  255,  255,  255, 60-1,  255,  255,  255,  255, 63-1, 64-1, 56-1 }
 604 };
 605 #elif defined (RGB_BACKLIGHT_HS60) //HS60_ISO
 606 //
 607 // LA1,  LA5,   LA9, LA13, LA17, LA21, LA25, LA29, LA33, LA37, LA41, LA45, LA49, LA53,
 608 // LA2,  LA6,  LA10, LA14, LA18, LA22, LA26, LA30, LA34, LA38, LA42, LA46, LA50,  ---,
 609 // LA3,  LA7,  LA11, LA15, LA19, LA23, LA27, LA31, LA35, LA39, LA43, LA47, LA54, LA55,
 610 // LA4,  LA48,  LA8, LA12, LA16, LA20, LA24, LA28, LA32, LA36, LA40, LA44,  ---, LA52,
 611 // LA57, LA58, LA59,  ---,  ---,  ---, LA60,  ---,  ---,  ---, LA62, LA63, LA64, LA56
 612 const uint8_t g_map_row_column_to_led[MATRIX_ROWS][MATRIX_COLS] PROGMEM = {
 613         {  1-1,  5-1,  9-1, 13-1, 17-1, 21-1, 25-1, 29-1, 33-1, 37-1, 41-1, 45-1, 49-1, 53-1 },
 614         {  2-1,  6-1, 10-1, 14-1, 18-1, 22-1, 26-1, 30-1, 34-1, 38-1, 42-1, 46-1, 50-1,  255 },
 615         {  3-1,  7-1, 11-1, 15-1, 19-1, 23-1, 27-1, 31-1, 35-1, 39-1, 43-1, 47-1, 54-1, 55-1 },
 616         {  4-1, 48-1,  8-1, 12-1, 16-1, 20-1, 24-1, 28-1, 32-1, 36-1, 40-1, 44-1,  255, 52-1 },
 617         { 57-1, 58-1, 59-1,  255,  255,  255, 60-1,  255,  255,  255, 62-1, 63-1, 64-1, 56-1 }
 618 };
 619 #elif defined (RGB_BACKLIGHT_M6_B)
 620 // M6-B is really simple:
 621 // 0 3 5
 622 // 1 2 4
 623 const uint8_t g_map_row_column_to_led[MATRIX_ROWS][MATRIX_COLS] PROGMEM = {
 624         {     0,     3,     5,     1,     2,     4 }
 625 };
 626 #endif
 627
 628 void map_row_column_to_led( uint8_t row, uint8_t column, uint8_t *led )
 629 {
 630         *led = 255;
 631         if ( row < MATRIX_ROWS && column < MATRIX_COLS )
 632         {
 633                 *led = pgm_read_byte(&g_map_row_column_to_led[row][column]);
 634         }
 635 }
 636
 637 void backlight_update_pwm_buffers(void)
 638 {
 639 #if defined (RGB_BACKLIGHT_M6_B)
 640         IS31FL3218_update_pwm_buffers();
 641 #elif defined (RGB_BACKLIGHT_HS60)
 642         IS31FL3733_update_pwm_buffers( ISSI_ADDR_1, ISSI_ADDR_2 );
 643         IS31FL3733_update_led_control_registers( ISSI_ADDR_1, ISSI_ADDR_2 );
 644 #else
 645         IS31FL3731_update_pwm_buffers( ISSI_ADDR_1, ISSI_ADDR_2 );
 646         IS31FL3731_update_led_control_registers( ISSI_ADDR_1, ISSI_ADDR_2 );
 647 #endif
 648 }
 649
 650 void backlight_set_color( int index, uint8_t red, uint8_t green, uint8_t blue )
 651 {
 652 #if defined (RGB_BACKLIGHT_M6_B)
 653         IS31FL3218_set_color( index, red, green, blue );
 654 #elif defined (RGB_BACKLIGHT_HS60)
 655         IS31FL3733_set_color( index, red, green, blue );
 656 #else
 657         IS31FL3731_set_color( index, red, green, blue );
 658 #endif
 659 }
 660
 661 void backlight_set_color_all( uint8_t red, uint8_t green, uint8_t blue )
 662 {
 663 #if defined (RGB_BACKLIGHT_M6_B)
 664         IS31FL3218_set_color_all( red, green, blue );
 665 #elif defined (RGB_BACKLIGHT_HS60)
 666         IS31FL3733_set_color_all( red, green, blue );
 667 #else
 668         IS31FL3731_set_color_all( red, green, blue );
 669 #endif
 670 }
 671
 672 void backlight_set_key_hit(uint8_t row, uint8_t column)
 673 {
 674         uint8_t led;
 675         map_row_column_to_led(row,column,&led);
 676         g_key_hit[led] = 0;
 677
 678         g_any_key_hit = 0;
 679 }
 680
 681 #if !defined(RGB_BACKLIGHT_HS60)
 682 // This is (F_CPU/1024) / 20 Hz
 683 // = 15625 Hz / 20 Hz
 684 // = 781
 685 #define TIMER3_TOP 781
 686
 687 void backlight_timer_init(void)
 688 {
 689         static uint8_t backlight_timer_is_init = 0;
 690         if ( backlight_timer_is_init )
 691         {
 692                 return;
 693         }
 694         backlight_timer_is_init = 1;
 695
 696         // Timer 3 setup
 697         TCCR3B = _BV(WGM32) |                   // CTC mode OCR3A as TOP
 698                          _BV(CS32) | _BV(CS30); // prescale by /1024
 699         // Set TOP value
 700         uint8_t sreg = SREG;
 701         cli();
 702
 703         OCR3AH = (TIMER3_TOP >> 8) & 0xff;
 704         OCR3AL = TIMER3_TOP & 0xff;
 705         SREG = sreg;
 706 }
 707
 708 void backlight_timer_enable(void)
 709 {
 710         TIMSK3 |= _BV(OCIE3A);
 711 }
 712
 713 void backlight_timer_disable(void)
 714 {
 715         TIMSK3 &= ~_BV(OCIE3A);
 716 }
 717 #else //STM32, use GPT with TIM4. Enable in halconf.h
 718 static void gpt_backlight_timer_task(GPTDriver *gptp);
 719 // Timer setup at 200Khz, callback at 10k ticks = 20Hz
 720 static GPTConfig gpt4cfg1 = {
 721         .frequency = 200000U,
 722         .callback  = gpt_backlight_timer_task
 723 };
 724
 725 void backlight_timer_init(void)
 726 {
 727         gptStart(&GPTD4, &gpt4cfg1);
 728 }
 729
 730 void backlight_timer_enable(void)
 731 {
 732         gptStartContinuous(&GPTD4, 10000);
 733 }
 734
 735 void backlight_timer_disable(void)
 736 {
 737         gptStopTimer(&GPTD4);
 738 }
 739 #endif //!defined(RGB_BACKLIGHT_HS60)
 740
 741 void backlight_set_suspend_state(bool state)
 742 {
 743         g_suspend_state = state;
 744 }
 745
 746 void backlight_set_indicator_state(uint8_t state)
 747 {
 748         g_indicator_state = state;
 749 }
 750
 751 void backlight_effect_rgb_test(void)
 752 {
 753         // Mask out bits 4 and 5
 754         // This 2-bit value will stay the same for 16 ticks.
 755         switch ( (g_tick & 0x30) >> 4 )
 756         {
 757                 case 0:
 758                 {
 759                         backlight_set_color_all( 255, 0, 0 );
 760                         break;
 761                 }
 762                 case 1:
 763                 {
 764                         backlight_set_color_all( 0, 255, 0 );
 765                         break;
 766                 }
 767                 case 2:
 768                 {
 769                         backlight_set_color_all( 0, 0, 255 );
 770                         break;
 771                 }
 772                 case 3:
 773                 {
 774                         backlight_set_color_all( 255, 255, 255 );
 775                         break;
 776                 }
 777         }
 778 }
 779
 780 #if defined(RGB_DEBUGGING_ONLY)
 781 // This tests the LEDs
 782 // Note that it will change the LED control registers
 783 // in the LED drivers, and leave them in an invalid
 784 // state for other backlight effects.
 785 // ONLY USE THIS FOR TESTING LEDS!
 786 void backlight_effect_single_LED_test(void)
 787 {
 788         static uint8_t color = 0; // 0,1,2 for R,G,B
 789         static uint8_t row = 0;
 790         static uint8_t column = 0;
 791
 792         static uint8_t tick = 0;
 793         tick++;
 794
 795         if ( tick > 2 )
 796         {
 797                 tick = 0;
 798                 column++;
 799         }
 800         if ( column > 14 )
 801         {
 802                 column = 0;
 803                 row++;
 804         }
 805         if ( row > 4 )
 806         {
 807                 row = 0;
 808                 color++;
 809         }
 810         if ( color > 2 )
 811         {
 812                 color = 0;
 813         }
 814
 815         uint8_t led;
 816         map_row_column_to_led( row, column, &led );
 817         backlight_set_color_all( 255, 255, 255 );
 818         backlight_test_led( led, color==0, color==1, color==2 );
 819 }
 820 #endif // defined(RGB_DEBUGGING_ONLY)
 821
 822 // All LEDs off
 823 void backlight_effect_all_off(void)
 824 {
 825         backlight_set_color_all( 0, 0, 0 );
 826 }
 827
 828 // Solid color
 829 void backlight_effect_solid_color(void)
 830 {
 831         HSV hsv = { .h = g_config.color_1.h, .s = g_config.color_1.s, .v = g_config.brightness };
 832         RGB rgb = hsv_to_rgb( hsv );
 833         backlight_set_color_all( rgb.r, rgb.g, rgb.b );
 834 }
 835
 836 // alphas = color1, mods = color2
 837 void backlight_effect_alphas_mods(void)
 838 {
 839         RGB rgb1 = hsv_to_rgb( (HSV){ .h = g_config.color_1.h, .s = g_config.color_1.s, .v = g_config.brightness } );
 840         RGB rgb2 = hsv_to_rgb( (HSV){ .h = g_config.color_2.h, .s = g_config.color_2.s, .v = g_config.brightness } );
 841
 842         for ( int row = 0; row < MATRIX_ROWS; row++ )
 843         {
 844                 for ( int column = 0; column < MATRIX_COLS; column++ )
 845                 {
 846                         uint8_t index;
 847                         map_row_column_to_led( row, column, &index );
 848                         if ( index < BACKLIGHT_LED_COUNT )
 849                         {
 850                                 if ( ( g_config.alphas_mods[row] & (1<<column) ) == 0 )
 851                                 {
 852                                         backlight_set_color( index, rgb1.r, rgb1.g, rgb1.b );
 853                                 }
 854                                 else
 855                                 {
 856                                         backlight_set_color( index, rgb2.r, rgb2.g, rgb2.b );
 857                                 }
 858                         }
 859                 }
 860         }
 861 }
 862
 863 void backlight_effect_gradient_up_down(void)
 864 {
 865         int16_t h1 = g_config.color_1.h;
 866         int16_t h2 = g_config.color_2.h;
 867         int16_t deltaH = h2 - h1;
 868
 869         // Take the shortest path between hues
 870         if ( deltaH > 127 )
 871         {
 872                 deltaH -= 256;
 873         }
 874         else if ( deltaH < -127 )
 875         {
 876                 deltaH += 256;
 877         }
 878         // Divide delta by 4, this gives the delta per row
 879         deltaH /= 4;
 880
 881         int16_t s1 = g_config.color_1.s;
 882         int16_t s2 = g_config.color_2.s;
 883         int16_t deltaS = ( s2 - s1 ) / 4;
 884
 885         HSV hsv = { .h = 0, .s = 255, .v = g_config.brightness };
 886         RGB rgb;
 887         Point point;
 888         for ( int i=0; i<BACKLIGHT_LED_COUNT; i++ )
 889         {
 890                 map_led_to_point( i, &point );
 891                 // The y range will be 0..64, map this to 0..4
 892                 uint8_t y = (point.y>>4);
 893                 // Relies on hue being 8-bit and wrapping
 894                 hsv.h = g_config.color_1.h + ( deltaH * y );
 895                 hsv.s = g_config.color_1.s + ( deltaS * y );
 896                 rgb = hsv_to_rgb( hsv );
 897                 backlight_set_color( i, rgb.r, rgb.g, rgb.b );
 898         }
 899 }
 900
 901 void backlight_effect_raindrops(bool initialize)
 902 {
 903         int16_t h1 = g_config.color_1.h;
 904         int16_t h2 = g_config.color_2.h;
 905         int16_t deltaH = h2 - h1;
 906         deltaH /= 4;
 907
 908         // Take the shortest path between hues
 909         if ( deltaH > 127 )
 910         {
 911                 deltaH -= 256;
 912         }
 913         else if ( deltaH < -127 )
 914         {
 915                 deltaH += 256;
 916         }
 917
 918         int16_t s1 = g_config.color_1.s;
 919         int16_t s2 = g_config.color_2.s;
 920         int16_t deltaS = ( s2 - s1 ) / 4;
 921
 922         HSV hsv;
 923         RGB rgb;
 924
 925         // Change one LED every tick
 926         uint8_t led_to_change = ( g_tick & 0x000 ) == 0 ? rand() % BACKLIGHT_LED_COUNT : 255;
 927
 928         for ( int i=0; i<BACKLIGHT_LED_COUNT; i++ )
 929         {
 930                 // If initialize, all get set to random colors
 931                 // If not, all but one will stay the same as before.
 932                 if ( initialize || i == led_to_change )
 933                 {
 934                         hsv.h = h1 + ( deltaH * ( rand() & 0x03 ) );
 935                         hsv.s = s1 + ( deltaS * ( rand() & 0x03 ) );
 936                         // Override brightness with global brightness control
 937                         hsv.v = g_config.brightness;;
 938
 939                         rgb = hsv_to_rgb( hsv );
 940                         backlight_set_color( i, rgb.r, rgb.g, rgb.b );
 941                 }
 942         }
 943 }
 944
 945 void backlight_effect_cycle_all(void)
 946 {
 947         uint8_t offset = ( g_tick << g_config.effect_speed ) & 0xFF;
 948
 949         // Relies on hue being 8-bit and wrapping
 950         for ( int i=0; i<BACKLIGHT_LED_COUNT; i++ )
 951         {
 952                 uint16_t offset2 = g_key_hit[i]<<2;
 953                 // stabilizer LEDs use spacebar hits
 954                 if ( i == 36+6 || i == 54+13 || // LC6, LD13
 955                                 ( g_config.use_7u_spacebar && i == 54+14 ) ) // LD14
 956                 {
 957                         offset2 = g_key_hit[36+0]<<2;
 958                 }
 959                 offset2 = (offset2<=63) ? (63-offset2) : 0;
 960
 961                 HSV hsv = { .h = offset+offset2, .s = 255, .v = g_config.brightness };
 962                 RGB rgb = hsv_to_rgb( hsv );
 963                 backlight_set_color( i, rgb.r, rgb.g, rgb.b );
 964         }
 965 }
 966
 967 void backlight_effect_cycle_left_right(void)
 968 {
 969         uint8_t offset = ( g_tick << g_config.effect_speed ) & 0xFF;
 970         HSV hsv = { .h = 0, .s = 255, .v = g_config.brightness };
 971         RGB rgb;
 972         Point point;
 973         for ( int i=0; i<BACKLIGHT_LED_COUNT; i++ )
 974         {
 975                 uint16_t offset2 = g_key_hit[i]<<2;
 976                 // stabilizer LEDs use spacebar hits
 977                 if ( i == 36+6 || i == 54+13 || // LC6, LD13
 978                                 ( g_config.use_7u_spacebar && i == 54+14 ) ) // LD14
 979                 {
 980                         offset2 = g_key_hit[36+0]<<2;
 981                 }
 982                 offset2 = (offset2<=63) ? (63-offset2) : 0;
 983
 984                 map_led_to_point( i, &point );
 985                 // Relies on hue being 8-bit and wrapping
 986                 hsv.h = point.x + offset + offset2;
 987                 rgb = hsv_to_rgb( hsv );
 988                 backlight_set_color( i, rgb.r, rgb.g, rgb.b );
 989         }
 990 }
 991
 992 void backlight_effect_cycle_up_down(void)
 993 {
 994         uint8_t offset = ( g_tick << g_config.effect_speed ) & 0xFF;
 995         HSV hsv = { .h = 0, .s = 255, .v = g_config.brightness };
 996         RGB rgb;
 997         Point point;
 998         for ( int i=0; i<BACKLIGHT_LED_COUNT; i++ )
 999         {
1000                 uint16_t offset2 = g_key_hit[i]<<2;
1001                 // stabilizer LEDs use spacebar hits
1002                 if ( i == 36+6 || i == 54+13 || // LC6, LD13
1003                                 ( g_config.use_7u_spacebar && i == 54+14 ) ) // LD14
1004                 {
1005                         offset2 = g_key_hit[36+0]<<2;
1006                 }
1007                 offset2 = (offset2<=63) ? (63-offset2) : 0;
1008
1009                 map_led_to_point( i, &point );
1010                 // Relies on hue being 8-bit and wrapping
1011                 hsv.h = point.y + offset + offset2;
1012                 rgb = hsv_to_rgb( hsv );
1013                 backlight_set_color( i, rgb.r, rgb.g, rgb.b );
1014         }
1015 }
1016
1017 void backlight_effect_jellybean_raindrops( bool initialize )
1018 {
1019         HSV hsv;
1020         RGB rgb;
1021
1022         // Change one LED every tick
1023         uint8_t led_to_change = ( g_tick & 0x000 ) == 0 ? rand() % BACKLIGHT_LED_COUNT : 255;
1024
1025         for ( int i=0; i<BACKLIGHT_LED_COUNT; i++ )
1026         {
1027                 // If initialize, all get set to random colors
1028                 // If not, all but one will stay the same as before.
1029                 if ( initialize || i == led_to_change )
1030                 {
1031                         hsv.h = rand() & 0xFF;
1032                         hsv.s = rand() & 0xFF;
1033                         // Override brightness with global brightness control
1034                         hsv.v = g_config.brightness;;
1035
1036                         rgb = hsv_to_rgb( hsv );
1037                         backlight_set_color( i, rgb.r, rgb.g, rgb.b );
1038                 }
1039         }
1040 }
1041
1042 void backlight_effect_cycle_radial1(void)
1043 {
1044         uint8_t offset = ( g_tick << g_config.effect_speed ) & 0xFF;
1045         HSV hsv = { .h = 0, .s = 255, .v = g_config.brightness };
1046         RGB rgb;
1047         Point point;
1048         for ( int i=0; i<BACKLIGHT_LED_COUNT; i++ )
1049         {
1050                 map_led_to_point_polar( i, &point );
1051                 // Relies on hue being 8-bit and wrapping
1052                 hsv.h = point.x + offset;
1053                 hsv.s = point.y;
1054                 rgb = hsv_to_rgb( hsv );
1055                 backlight_set_color( i, rgb.r, rgb.g, rgb.b );
1056         }
1057 }
1058
1059 void backlight_effect_cycle_radial2(void)
1060 {
1061         uint8_t offset = ( g_tick << g_config.effect_speed ) & 0xFF;
1062
1063         HSV hsv = { .h = 0, .s = g_config.color_1.s, .v = g_config.brightness };
1064         RGB rgb;
1065         Point point;
1066         for ( int i=0; i<BACKLIGHT_LED_COUNT; i++ )
1067         {
1068                 map_led_to_point_polar( i, &point );
1069                 uint8_t offset2 = offset + point.x;
1070                 if ( offset2 & 0x80 )
1071                 {
1072                         offset2 = ~offset2;
1073                 }
1074                 offset2 = offset2 >> 2;
1075                 hsv.h = g_config.color_1.h + offset2;
1076                 hsv.s = 127 + ( point.y >> 1 );
1077                 rgb = hsv_to_rgb( hsv );
1078                 backlight_set_color( i, rgb.r, rgb.g, rgb.b );
1079         }
1080 }
1081
1082 #if defined(RGB_BACKLIGHT_M6_B)
1083 void backlight_effect_custom_colors(void)
1084 {
1085         RGB rgb;
1086         for ( uint8_t i = 0; i < 6; i++ )
1087         {
1088                 HSV hsv = { .h = g_config.custom_color[i].h, .s = g_config.custom_color[i].s, .v = g_config.brightness };
1089                 rgb = hsv_to_rgb( hsv );
1090                 uint8_t led;
1091                 map_row_column_to_led( 0, i, &led );
1092                 backlight_set_color( led, rgb.r, rgb.g, rgb.b );
1093         }
1094 }
1095 #endif
1096
1097 void backlight_effect_indicators_set_colors( uint8_t index, HS color )
1098 {
1099         HSV hsv = { .h = color.h, .s = color.s, .v = g_config.brightness };
1100         RGB rgb = hsv_to_rgb( hsv );
1101         if ( index == 254 )
1102         {
1103                 backlight_set_color_all( rgb.r, rgb.g, rgb.b );
1104         }
1105         else
1106         {
1107                 backlight_set_color( index, rgb.r, rgb.g, rgb.b );
1108
1109                 // If the spacebar LED is the indicator,
1110                 // do the same for the spacebar stabilizers
1111                 if ( index == 36+0 ) // LC0
1112                 {
1113 #if defined (RGB_BACKLIGHT_ZEAL65)
1114                         backlight_set_color( 36+7, rgb.r, rgb.g, rgb.b ); // LC7
1115                         backlight_set_color( 54+14, rgb.r, rgb.g, rgb.b ); // LD14
1116 #elif defined (RGB_BACKLIGHT_KOYU)
1117                         backlight_set_color( 36+6, rgb.r, rgb.g, rgb.b ); // LC6
1118                         backlight_set_color( 54+14, rgb.r, rgb.g, rgb.b ); // LD14
1119 #elif defined (RGB_BACKLIGHT_ZEAL60) || defined (RGB_BACKLIGHT_M60_A)
1120                         backlight_set_color( 36+6, rgb.r, rgb.g, rgb.b ); // LC6
1121                         backlight_set_color( 54+13, rgb.r, rgb.g, rgb.b ); // LD13
1122                         if ( g_config.use_7u_spacebar )
1123                         {
1124                                 backlight_set_color( 54+14, rgb.r, rgb.g, rgb.b ); // LD14
1125                         }
1126 #endif
1127                 }
1128         }
1129 }
1130
1131 // This runs after another backlight effect and replaces
1132 // colors already set
1133 void backlight_effect_indicators(void)
1134 {
1135         if ( g_config.caps_lock_indicator.index != 255 &&
1136                         ( g_indicator_state & (1<<USB_LED_CAPS_LOCK) ) )
1137         {
1138                 backlight_effect_indicators_set_colors( g_config.caps_lock_indicator.index, g_config.caps_lock_indicator.color );
1139         }
1140
1141         // This if/else if structure allows higher layers to
1142         // override lower ones. If we set layer 3's indicator
1143         // to none, then it will NOT show layer 2 or layer 1
1144         // indicators, even if those layers are on via the
1145         // MO13/MO23 Fn combo magic.
1146         //
1147         // Basically we want to handle the case where layer 3 is
1148         // still the backlight configuration layer and we don't
1149         // want "all LEDs" indicators hiding the backlight effect,
1150         // but still allow end users to do whatever they want.
1151         if ( IS_LAYER_ON(3) )
1152         {
1153                 if ( g_config.layer_3_indicator.index != 255 )
1154                 {
1155                         backlight_effect_indicators_set_colors( g_config.layer_3_indicator.index, g_config.layer_3_indicator.color );
1156                 }
1157         }
1158         else if ( IS_LAYER_ON(2) )
1159         {
1160                 if ( g_config.layer_2_indicator.index != 255 )
1161                 {
1162                         backlight_effect_indicators_set_colors( g_config.layer_2_indicator.index, g_config.layer_2_indicator.color );
1163                 }
1164         }
1165         else if ( IS_LAYER_ON(1) )
1166         {
1167                 if ( g_config.layer_1_indicator.index != 255 )
1168                 {
1169                         backlight_effect_indicators_set_colors( g_config.layer_1_indicator.index, g_config.layer_1_indicator.color );
1170                 }
1171         }
1172 }
1173
1174 #if !defined(RGB_BACKLIGHT_HS60)
1175 ISR(TIMER3_COMPA_vect)
1176 #else //STM32 interrupt
1177 static void gpt_backlight_timer_task(GPTDriver *gptp)
1178 #endif
1179 {
1180         // delay 1 second before driving LEDs or doing anything else
1181         static uint8_t startup_tick = 0;
1182         if ( startup_tick < 20 )
1183         {
1184                 startup_tick++;
1185                 return;
1186         }
1187
1188         g_tick++;
1189
1190         if ( g_any_key_hit < 0xFFFFFFFF )
1191         {
1192                 g_any_key_hit++;
1193         }
1194
1195         for ( int led = 0; led < BACKLIGHT_LED_COUNT; led++ )
1196         {
1197                 if ( g_key_hit[led] < 255 )
1198                 {
1199                         g_key_hit[led]++;
1200                 }
1201         }
1202
1203         // Factory default magic value
1204         if ( g_config.effect == 255 )
1205         {
1206                 backlight_effect_rgb_test();
1207                 return;
1208         }
1209
1210         // Ideally we would also stop sending zeros to the LED driver PWM buffers
1211         // while suspended and just do a software shutdown. This is a cheap hack for now.
1212         bool suspend_backlight = ((g_suspend_state && g_config.disable_when_usb_suspended) ||
1213                         (g_config.disable_after_timeout > 0 && g_any_key_hit > g_config.disable_after_timeout * 60 * 20));
1214         uint8_t effect = suspend_backlight ? 0 : g_config.effect;
1215
1216         // Keep track of the effect used last time,
1217         // detect change in effect, so each effect can
1218         // have an optional initialization.
1219         static uint8_t effect_last = 255;
1220         bool initialize = effect != effect_last;
1221         effect_last = effect;
1222
1223         // this gets ticked at 20 Hz.
1224         // each effect can opt to do calculations
1225         // and/or request PWM buffer updates.
1226         switch ( effect )
1227         {
1228                 case 0:
1229                         backlight_effect_all_off();
1230                         break;
1231                 case 1:
1232                         backlight_effect_solid_color();
1233                         break;
1234                 case 2:
1235 #if defined(RGB_BACKLIGHT_M6_B)
1236                         backlight_effect_custom_colors();
1237 #else
1238                         backlight_effect_alphas_mods();
1239 #endif
1240                         break;
1241                 case 3:
1242                         backlight_effect_gradient_up_down();
1243                         break;
1244                 case 4:
1245                         backlight_effect_raindrops( initialize );
1246                         break;
1247                 case 5:
1248                         backlight_effect_cycle_all();
1249                         break;
1250                 case 6:
1251                         backlight_effect_cycle_left_right();
1252                         break;
1253                 case 7:
1254                         backlight_effect_cycle_up_down();
1255                         break;
1256                 case 8:
1257                         backlight_effect_jellybean_raindrops( initialize );
1258                         break;
1259                 case 9:
1260                         backlight_effect_cycle_radial1();
1261                         break;
1262                 case 10:
1263                         backlight_effect_cycle_radial2();
1264                         break;
1265                 default:
1266                         backlight_effect_all_off();
1267                         break;
1268         }
1269
1270         if ( ! suspend_backlight )
1271         {
1272 #if !defined(RGB_BACKLIGHT_M6_B)
1273                 backlight_effect_indicators();
1274 #endif
1275         }
1276 }
1277
1278 void backlight_set_indicator_index( uint8_t *index, uint8_t row, uint8_t column )
1279 {
1280         if ( row >= MATRIX_ROWS )
1281         {
1282                 // Special value, 255=none, 254=all
1283                 *index = row;
1284         }
1285         else
1286         {
1287                 map_row_column_to_led( row, column, index );
1288         }
1289 }
1290
1291 void backlight_get_indicator_row_col( uint8_t index, uint8_t *row, uint8_t *column )
1292 {
1293         if ( index == 255 || index == 254 )
1294         {
1295                 // Special value, 255=none, 254=all
1296                 *row = index;
1297                 *column = 0;
1298                 return;
1299         }
1300         for ( uint8_t r = 0; r < MATRIX_ROWS; r++ )
1301         {
1302                 for ( uint8_t c = 0; c < MATRIX_COLS; c++ )
1303                 {
1304                         uint8_t i = 255;
1305                         map_row_column_to_led( r, c, &i );
1306                         if ( i == index )
1307                         {
1308                                 *row = r;
1309                                 *column = c;
1310                                 return;
1311                         }
1312                 }
1313         }
1314 }
1315
1316 // Some helpers for setting/getting HSV
1317 void _set_color( HS *color, uint8_t *data )
1318 {
1319         color->h = data[0];
1320         color->s = data[1];
1321 }
1322
1323 void _get_color( HS *color, uint8_t *data )
1324 {
1325         data[0] = color->h;
1326         data[1] = color->s;
1327 }
1328
1329 void backlight_config_set_value( uint8_t *data )
1330 {
1331         bool reinitialize = false;
1332         uint8_t *value_id = &(data[0]);
1333         uint8_t *value_data = &(data[1]);
1334         switch ( *value_id )
1335         {
1336 #if defined (RGB_BACKLIGHT_ZEAL60) || defined(RGB_BACKLIGHT_ZEAL65)
1337                 case id_use_split_backspace:
1338                 {
1339                         g_config.use_split_backspace = (bool)*value_data;
1340                         reinitialize = true;
1341                         break;
1342                 }
1343 #endif
1344 #if defined (RGB_BACKLIGHT_ZEAL60)
1345                 case id_use_split_left_shift:
1346                 {
1347                         g_config.use_split_left_shift = (bool)*value_data;
1348                         reinitialize = true;
1349                         break;
1350                 }
1351                 case id_use_split_right_shift:
1352                 {
1353                         g_config.use_split_right_shift = (bool)*value_data;
1354                         reinitialize = true;
1355                         break;
1356                 }
1357                 case id_use_7u_spacebar:
1358                 {
1359                         g_config.use_7u_spacebar = (bool)*value_data;
1360                         reinitialize = true;
1361                         break;
1362                 }
1363                 case id_use_iso_enter:
1364                 {
1365                         g_config.use_iso_enter = (bool)*value_data;
1366                         reinitialize = true;
1367                         break;
1368                 }
1369                 case id_disable_hhkb_blocker_leds:
1370                 {
1371                         g_config.disable_hhkb_blocker_leds = (bool)*value_data;
1372                         reinitialize = true;
1373                         break;
1374                 }
1375 #endif
1376                 case id_disable_when_usb_suspended:
1377                 {
1378                         g_config.disable_when_usb_suspended = (bool)*value_data;
1379                         break;
1380                 }
1381                 case id_disable_after_timeout:
1382                 {
1383                         g_config.disable_after_timeout = *value_data;
1384                         break;
1385                 }
1386                 case id_brightness:
1387                 {
1388                         g_config.brightness = *value_data;
1389                         break;
1390                 }
1391                 case id_effect:
1392                 {
1393                         g_config.effect = *value_data;
1394                         break;
1395                 }
1396                 case id_effect_speed:
1397                 {
1398                         g_config.effect_speed = *value_data;
1399                         break;
1400                 }
1401                 case id_color_1:
1402                 {
1403                         _set_color( &(g_config.color_1), value_data );
1404                         break;
1405                 }
1406                 case id_color_2:
1407                 {
1408                         _set_color( &(g_config.color_2), value_data );
1409                         break;
1410                 }
1411                 case id_caps_lock_indicator_color:
1412                 {
1413                         _set_color( &(g_config.caps_lock_indicator.color), value_data );
1414                         break;
1415                 }
1416                 case id_caps_lock_indicator_row_col:
1417                 {
1418                         backlight_set_indicator_index( &(g_config.caps_lock_indicator.index), value_data[0], value_data[1] );
1419                         break;
1420                 }
1421                 case id_layer_1_indicator_color:
1422                 {
1423                         _set_color( &(g_config.layer_1_indicator.color), value_data );
1424                         break;
1425                 }
1426                 case id_layer_1_indicator_row_col:
1427                 {
1428                         backlight_set_indicator_index( &(g_config.layer_1_indicator.index), value_data[0], value_data[1] );
1429                         break;
1430                 }
1431                 case id_layer_2_indicator_color:
1432                 {
1433                         _set_color( &(g_config.layer_2_indicator.color), value_data );
1434                         break;
1435                 }
1436                 case id_layer_2_indicator_row_col:
1437                 {
1438                         backlight_set_indicator_index( &(g_config.layer_2_indicator.index), value_data[0], value_data[1] );
1439                         break;
1440                 }
1441                 case id_layer_3_indicator_color:
1442                 {
1443                         _set_color( &(g_config.layer_3_indicator.color), value_data );
1444                         break;
1445                 }
1446                 case id_layer_3_indicator_row_col:
1447                 {
1448                         backlight_set_indicator_index( &(g_config.layer_3_indicator.index), value_data[0], value_data[1] );
1449                         break;
1450                 }
1451                 case id_alphas_mods:
1452                 {
1453                         for ( int i=0; i<5; i++ )
1454                         {
1455                                 g_config.alphas_mods[i] = ( *(value_data+i*2) << 8 ) | ( *(value_data+i*2+1) );
1456                         }
1457                 }
1458 #if defined(RGB_BACKLIGHT_M6_B)
1459                 case id_custom_color:
1460                 {
1461                         uint8_t index = value_data[0];
1462                         if ( index >= 0 && index <= 6 )
1463                         {
1464                                 _set_color( &(g_config.custom_color[index]), &(value_data[1]) );
1465                         }
1466                 }
1467 #endif
1468         }
1469
1470         if ( reinitialize )
1471         {
1472                 backlight_init_drivers();
1473         }
1474 }
1475
1476 void backlight_config_get_value( uint8_t *data )
1477 {
1478         uint8_t *value_id = &(data[0]);
1479         uint8_t *value_data = &(data[1]);
1480         switch ( *value_id )
1481         {
1482                 case id_use_split_backspace:
1483                 {
1484                         *value_data = ( g_config.use_split_backspace ? 1 : 0 );
1485                         break;
1486                 }
1487                 case id_use_split_left_shift:
1488                 {
1489                         *value_data = ( g_config.use_split_left_shift ? 1 : 0 );
1490                         break;
1491                 }
1492                 case id_use_split_right_shift:
1493                 {
1494                         *value_data = ( g_config.use_split_right_shift ? 1 : 0 );
1495                         break;
1496                 }
1497                 case id_use_7u_spacebar:
1498                 {
1499                         *value_data = ( g_config.use_7u_spacebar ? 1 : 0 );
1500                         break;
1501                 }
1502                 case id_use_iso_enter:
1503                 {
1504                         *value_data = ( g_config.use_iso_enter ? 1 : 0 );
1505                         break;
1506                 }
1507                 case id_disable_when_usb_suspended:
1508                 {
1509                         *value_data = ( g_config.disable_when_usb_suspended ? 1 : 0 );
1510                         break;
1511                 }
1512                 case id_disable_hhkb_blocker_leds:
1513                 {
1514                         *value_data = ( g_config.disable_hhkb_blocker_leds ? 1 : 0 );
1515                         break;
1516                 }
1517                 case id_disable_after_timeout:
1518                 {
1519                         *value_data = g_config.disable_after_timeout;
1520                         break;
1521                 }
1522                 case id_brightness:
1523                 {
1524                         *value_data = g_config.brightness;
1525                         break;
1526                 }
1527                 case id_effect:
1528                 {
1529                         *value_data = g_config.effect;
1530                         break;
1531                 }
1532                 case id_effect_speed:
1533                 {
1534                         *value_data = g_config.effect_speed;
1535                         break;
1536                 }
1537                 case id_color_1:
1538                 {
1539                         _get_color( &(g_config.color_1), value_data );
1540                         break;
1541                 }
1542                 case id_color_2:
1543                 {
1544                         _get_color( &(g_config.color_2), value_data );
1545                         break;
1546                 }
1547                 case id_caps_lock_indicator_color:
1548                 {
1549                         _get_color( &(g_config.caps_lock_indicator.color), value_data );
1550                         break;
1551                 }
1552                 case id_caps_lock_indicator_row_col:
1553                 {
1554                         backlight_get_indicator_row_col( g_config.caps_lock_indicator.index, &(value_data[0]), &(value_data[1]) );
1555                         break;
1556                 }
1557                 case id_layer_1_indicator_color:
1558                 {
1559                         _get_color( &(g_config.layer_1_indicator.color), value_data );
1560                         break;
1561                 }
1562                 case id_layer_1_indicator_row_col:
1563                 {
1564                         backlight_get_indicator_row_col( g_config.layer_1_indicator.index, &(value_data[0]), &(value_data[1]) );
1565                         break;
1566                 }
1567                 case id_layer_2_indicator_color:
1568                 {
1569                         _get_color( &(g_config.layer_2_indicator.color), value_data );
1570                         break;
1571                 }
1572                 case id_layer_2_indicator_row_col:
1573                 {
1574                         backlight_get_indicator_row_col( g_config.layer_2_indicator.index, &(value_data[0]), &(value_data[1]) );
1575                         break;
1576                 }
1577                 case id_layer_3_indicator_color:
1578                 {
1579                         _get_color( &(g_config.layer_3_indicator.color), value_data );
1580                         break;
1581                 }
1582                 case id_layer_3_indicator_row_col:
1583                 {
1584                         backlight_get_indicator_row_col( g_config.layer_3_indicator.index, &(value_data[0]), &(value_data[1]) );
1585                         break;
1586                 }
1587                 case id_alphas_mods:
1588                 {
1589                         for ( int i=0; i<5; i++ )
1590                         {
1591                                 *(value_data+i*2) = g_config.alphas_mods[i] >> 8;
1592                                 *(value_data+i*2+1)     = g_config.alphas_mods[i] & 0xFF;
1593                         }
1594                 }
1595 #if defined(RGB_BACKLIGHT_M6_B)
1596                 case id_custom_color:
1597                 {
1598                         uint8_t index = value_data[0];
1599                         if ( index >= 0 && index <= 6 )
1600                         {
1601                                 _get_color( &(g_config.custom_color[index]), &(value_data[1]) );
1602                         }
1603                 }
1604 #endif
1605         }
1606 }
1607
1608 void backlight_config_set_alphas_mods( uint16_t *alphas_mods )
1609 {
1610         for ( int i=0; i<5; i++ )
1611         {
1612                 g_config.alphas_mods[i] = alphas_mods[i];
1613         }
1614
1615         backlight_config_save();
1616 }
1617
1618 void backlight_config_load(void)
1619 {
1620         eeprom_read_block( &g_config, ((void*)RGB_BACKLIGHT_CONFIG_EEPROM_ADDR), sizeof(backlight_config) );
1621 }
1622
1623 void backlight_config_save(void)
1624 {
1625         eeprom_update_block( &g_config, ((void*)RGB_BACKLIGHT_CONFIG_EEPROM_ADDR), sizeof(backlight_config) );
1626 }
1627
1628 void backlight_init_drivers(void)
1629 {
1630         // Initialize I2C
1631         i2c_init();
1632
1633 #if defined(RGB_BACKLIGHT_M6_B)
1634         IS31FL3218_init();
1635 #elif defined(RGB_BACKLIGHT_HS60)
1636         IS31FL3733_init( ISSI_ADDR_1 );
1637
1638         for ( int index = 0; index < BACKLIGHT_LED_COUNT; index++ )
1639         {
1640 #if defined (HS60_ANSI)
1641                 bool enabled = !( ( index == 48-1 ) || //LA48
1642                                                   ( index == 51-1 ) || //LA51
1643                                                   ( index == 61-1 ) ); //LA61
1644 #elif defined (HS60_HHKB)
1645                 bool enabled = !( ( index == 61-1 ) || //LA61
1646                                                   ( index == 62-1 ) ); //LA62
1647 #else //HS60_ISO
1648                 bool enabled = !( ( index == 51-1 ) || //LA51
1649                                                   ( index == 61-1 ) ); //LA61
1650 #endif
1651                                 // This only caches it for later
1652                 IS31FL3733_set_led_control_register( index, enabled, enabled, enabled );
1653         }
1654         // This actually updates the LED drivers
1655         IS31FL3733_update_led_control_registers( ISSI_ADDR_1, ISSI_ADDR_2 );
1656 #else
1657         IS31FL3731_init( ISSI_ADDR_1 );
1658         IS31FL3731_init( ISSI_ADDR_2 );
1659
1660         for ( int index = 0; index < BACKLIGHT_LED_COUNT; index++ )
1661         {
1662                 // OR the possible "disabled" cases together, then NOT the result to get the enabled state
1663                 // LC6 LD13 not present on Zeal65
1664 #if defined (RGB_BACKLIGHT_ZEAL65)
1665                 bool enabled = !( ( index == 18+5 && !g_config.use_split_backspace ) || // LB5
1666                                                   ( index == 36+6 ) || // LC6
1667                                                   ( index == 54+13 ) ); // LD13
1668 #elif defined (RGB_BACKLIGHT_KOYU)
1669                 bool enabled = !( ( index == 36+15 ) || // LC15
1670                                                   ( index == 54+13 ) || // LD13
1671                                                   ( index == 54+17 ) ); // LD17
1672 #elif defined (RGB_BACKLIGHT_M60_A)
1673                 bool enabled = !(
1674                 // LB6 LB7 LB8 LB15 LB16 LB17 not present on M60-A
1675                                                   ( index == 18+6 ) || // LB6
1676                                                   ( index == 18+7 ) || // LB7
1677                                                   ( index == 18+8 ) || // LB8
1678                                                   ( index == 18+15 ) || // LB15
1679                                                   ( index == 18+16 ) || // LB16
1680                                                   ( index == 18+17 ) || // LB17
1681                 // HHKB blockers (LC17, LD17) and ISO extra keys (LC15,LD13) not present on M60-A
1682                                                   ( index == 36+17 ) || // LC17
1683                                                   ( index == 54+17 ) || // LD17
1684                                                   ( index == 36+15 ) || // LC15
1685                                                   ( index == 54+13 ) ); // LD13
1686 #elif defined (RGB_BACKLIGHT_ZEAL60)
1687                 // LB6 LB7 LB8 LB15 LB16 LB17 not present on Zeal60
1688                 bool enabled = !( ( index == 18+5 && !g_config.use_split_backspace ) || // LB5
1689                                                   ( index == 36+15 && !g_config.use_split_left_shift ) || // LC15
1690                                                   ( index == 54+8 && !g_config.use_split_right_shift ) || // LD8
1691                                                   ( index == 54+13 && g_config.use_7u_spacebar ) || // LD13
1692                                                   ( index == 36+17 && g_config.disable_hhkb_blocker_leds ) || // LC17
1693                                                   ( index == 54+17 && g_config.disable_hhkb_blocker_leds ) ||  // LD17
1694                                                   ( index == 18+6 ) || // LB6
1695                                                   ( index == 18+7 ) || // LB7
1696                                                   ( index == 18+8 ) || // LB8
1697                                                   ( index == 18+15 ) || // LB15
1698                                                   ( index == 18+16 ) || // LB16
1699                                                   ( index == 18+17 ) ); // LB17
1700 #endif
1701                 // This only caches it for later
1702                 IS31FL3731_set_led_control_register( index, enabled, enabled, enabled );
1703         }
1704         // This actually updates the LED drivers
1705         IS31FL3731_update_led_control_registers( ISSI_ADDR_1, ISSI_ADDR_2 );
1706 #endif // !defined(RGB_BACKLIGHT_M6_B)
1707
1708         // TODO: put the 1 second startup delay here?
1709
1710         // clear the key hits
1711         for ( int led=0; led<BACKLIGHT_LED_COUNT; led++ )
1712         {
1713                 g_key_hit[led] = 255;
1714         }
1715 }
1716
1717 bool process_record_backlight(uint16_t keycode, keyrecord_t *record)
1718 {
1719         // Record keypresses for backlight effects
1720         if ( record->event.pressed )
1721         {
1722                 backlight_set_key_hit( record->event.key.row, record->event.key.col );
1723         }
1724
1725         switch(keycode)
1726         {
1727                 case BR_INC:
1728                         if (record->event.pressed)
1729                         {
1730                                 backlight_brightness_increase();
1731                         }
1732                         return false;
1733                         break;
1734                 case BR_DEC:
1735                         if (record->event.pressed)
1736                         {
1737                                 backlight_brightness_decrease();
1738                         }
1739                         return false;
1740                         break;
1741                 case EF_INC:
1742                         if (record->event.pressed)
1743                         {
1744                                 backlight_effect_increase();
1745                         }
1746                         return false;
1747                         break;
1748                 case EF_DEC:
1749                         if (record->event.pressed)
1750                         {
1751                                 backlight_effect_decrease();
1752                         }
1753                         return false;
1754                         break;
1755                 case ES_INC:
1756                         if (record->event.pressed)
1757                         {
1758                                 backlight_effect_speed_increase();
1759                         }
1760                         return false;
1761                         break;
1762                 case ES_DEC:
1763                         if (record->event.pressed)
1764                         {
1765                                 backlight_effect_speed_decrease();
1766                         }
1767                         return false;
1768                         break;
1769                 case H1_INC:
1770                         if (record->event.pressed)
1771                         {
1772                                 backlight_color_1_hue_increase();
1773                         }
1774                         return false;
1775                         break;
1776                 case H1_DEC:
1777                         if (record->event.pressed)
1778                         {
1779                                 backlight_color_1_hue_decrease();
1780                         }
1781                         return false;
1782                         break;
1783                 case S1_INC:
1784                         if (record->event.pressed)
1785                         {
1786                                 backlight_color_1_sat_increase();
1787                         }
1788                         return false;
1789                         break;
1790                 case S1_DEC:
1791                         if (record->event.pressed)
1792                         {
1793                                 backlight_color_1_sat_decrease();
1794                                 break;
1795                         }
1796                         return false;
1797                         break;
1798                 case H2_INC:
1799                         if (record->event.pressed)
1800                         {
1801                                 backlight_color_2_hue_increase();
1802                         }
1803                         return false;
1804                         break;
1805                 case H2_DEC:
1806                         if (record->event.pressed)
1807                         {
1808                                 backlight_color_2_hue_decrease();
1809                         }
1810                         return false;
1811                         break;
1812                 case S2_INC:
1813                         if (record->event.pressed)
1814                         {
1815                                 backlight_color_2_sat_increase();
1816                         }
1817                         return false;
1818                         break;
1819                 case S2_DEC:
1820                         if (record->event.pressed)
1821                         {
1822                                 backlight_color_2_sat_decrease();
1823                                 break;
1824                         }
1825                         return false;
1826                         break;
1827         }
1828
1829         return true;
1830 }
1831
1832 // Deals with the messy details of incrementing an integer
1833 uint8_t increment( uint8_t value, uint8_t step, uint8_t min, uint8_t max )
1834 {
1835         int16_t new_value = value;
1836         new_value += step;
1837         return MIN( MAX( new_value, min ), max );
1838 }
1839
1840 uint8_t decrement( uint8_t value, uint8_t step, uint8_t min, uint8_t max )
1841 {
1842         int16_t new_value = value;
1843         new_value -= step;
1844         return MIN( MAX( new_value, min ), max );
1845 }
1846
1847 void backlight_effect_increase(void)
1848 {
1849         g_config.effect = increment( g_config.effect, 1, 0, BACKLIGHT_EFFECT_MAX );
1850         backlight_config_save();
1851 }
1852
1853 void backlight_effect_decrease(void)
1854 {
1855         g_config.effect = decrement( g_config.effect, 1, 0, BACKLIGHT_EFFECT_MAX );
1856         backlight_config_save();
1857 }
1858
1859 void backlight_effect_speed_increase(void)
1860 {
1861         g_config.effect_speed = increment( g_config.effect_speed, 1, 0, 3 );
1862         backlight_config_save();
1863 }
1864
1865 void backlight_effect_speed_decrease(void)
1866 {
1867         g_config.effect_speed = decrement( g_config.effect_speed, 1, 0, 3 );
1868         backlight_config_save();
1869 }
1870
1871 void backlight_brightness_increase(void)
1872 {
1873         g_config.brightness = increment( g_config.brightness, 8, 0, 255 );
1874         backlight_config_save();
1875 }
1876
1877 void backlight_brightness_decrease(void)
1878 {
1879         g_config.brightness = decrement( g_config.brightness, 8, 0, 255 );
1880         backlight_config_save();
1881 }
1882
1883 void backlight_color_1_hue_increase(void)
1884 {
1885         g_config.color_1.h = increment( g_config.color_1.h, 8, 0, 255 );
1886         backlight_config_save();
1887 }
1888
1889 void backlight_color_1_hue_decrease(void)
1890 {
1891         g_config.color_1.h = decrement( g_config.color_1.h, 8, 0, 255 );
1892         backlight_config_save();
1893 }
1894
1895 void backlight_color_1_sat_increase(void)
1896 {
1897         g_config.color_1.s = increment( g_config.color_1.s, 8, 0, 255 );
1898         backlight_config_save();
1899 }
1900
1901 void backlight_color_1_sat_decrease(void)
1902 {
1903         g_config.color_1.s = decrement( g_config.color_1.s, 8, 0, 255 );
1904         backlight_config_save();
1905 }
1906
1907 void backlight_color_2_hue_increase(void)
1908 {
1909         g_config.color_2.h = increment( g_config.color_2.h, 8, 0, 255 );
1910         backlight_config_save();
1911 }
1912
1913 void backlight_color_2_hue_decrease(void)
1914 {
1915         g_config.color_2.h = decrement( g_config.color_2.h, 8, 0, 255 );
1916         backlight_config_save();
1917 }
1918
1919 void backlight_color_2_sat_increase(void)
1920 {
1921         g_config.color_2.s = increment( g_config.color_2.s, 8, 0, 255 );
1922         backlight_config_save();
1923 }
1924
1925 void backlight_color_2_sat_decrease(void)
1926 {
1927         g_config.color_2.s = decrement( g_config.color_2.s, 8, 0, 255 );
1928         backlight_config_save();
1929 }
1930
1931 #if defined(RGB_DEBUGGING_ONLY)
1932 void backlight_test_led( uint8_t index, bool red, bool green, bool blue )
1933 {
1934         for ( int i=0; i<BACKLIGHT_LED_COUNT; i++ )
1935         {
1936                 if ( i == index )
1937                 {
1938                         IS31FL3731_set_led_control_register( i, red, green, blue );
1939                 }
1940                 else
1941                 {
1942                         IS31FL3731_set_led_control_register( i, false, false, false );
1943                 }
1944         }
1945 }
1946
1947 void backlight_debug_led( bool state )
1948 {
1949         if (state)
1950         {
1951                 // Output high.
1952                 DDRE |= (1<<6);
1953                 PORTE |= (1<<6);
1954         }
1955         else
1956         {
1957                 // Output low.
1958                 DDRE &= ~(1<<6);
1959                 PORTE &= ~(1<<6);
1960         }
1961 }
1962 #endif // defined(RGB_DEBUGGING_ONLY)
1963
1964 #endif // BACKLIGHT_ENABLED