1 /* Copyright 2017 Jason Williams (Wilba)
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.
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.
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/>.
16 #if RGB_BACKLIGHT_ENABLED
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) || defined(RGB_BACKLIGHT_NK65)
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, RGB_BACKLIGHT_HS60, RGB_BACKLIGHT_NK65
24 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
28 #define MIN(a,b) ((a) < (b)? (a): (b))
32 #include "rgb_backlight.h"
33 #include "rgb_backlight_api.h"
34 #include "rgb_backlight_keycodes.h"
36 #if !defined(RGB_BACKLIGHT_HS60) && !defined(RGB_BACKLIGHT_NK65)
38 #include <util/delay.h>
39 #include <avr/interrupt.h>
40 #include "drivers/avr/i2c_master.h"
44 #include "drivers/arm/i2c_master.h"
45 #include "tmk_core/common/eeprom.h"
48 #include "quantum/color.h"
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 #elif defined(RGB_BACKLIGHT_NK65)
57 #include "drivers/issi/is31fl3733.h"
58 #define BACKLIGHT_LED_COUNT 69
60 #include "drivers/issi/is31fl3731.h"
61 #define BACKLIGHT_LED_COUNT 72
64 #define BACKLIGHT_EFFECT_MAX 10
66 backlight_config g_config = {
67 .use_split_backspace = RGB_BACKLIGHT_USE_SPLIT_BACKSPACE,
68 .use_split_left_shift = RGB_BACKLIGHT_USE_SPLIT_LEFT_SHIFT,
69 .use_split_right_shift = RGB_BACKLIGHT_USE_SPLIT_RIGHT_SHIFT,
70 .use_7u_spacebar = RGB_BACKLIGHT_USE_7U_SPACEBAR,
71 .use_iso_enter = RGB_BACKLIGHT_USE_ISO_ENTER,
72 .disable_hhkb_blocker_leds = RGB_BACKLIGHT_DISABLE_HHKB_BLOCKER_LEDS,
73 .disable_when_usb_suspended = RGB_BACKLIGHT_DISABLE_WHEN_USB_SUSPENDED,
74 .disable_after_timeout = RGB_BACKLIGHT_DISABLE_AFTER_TIMEOUT,
75 .brightness = RGB_BACKLIGHT_BRIGHTNESS,
76 .effect = RGB_BACKLIGHT_EFFECT,
77 .effect_speed = RGB_BACKLIGHT_EFFECT_SPEED,
78 .color_1 = RGB_BACKLIGHT_COLOR_1,
79 .color_2 = RGB_BACKLIGHT_COLOR_2,
80 .caps_lock_indicator = RGB_BACKLIGHT_CAPS_LOCK_INDICATOR,
81 .layer_1_indicator = RGB_BACKLIGHT_LAYER_1_INDICATOR,
82 .layer_2_indicator = RGB_BACKLIGHT_LAYER_2_INDICATOR,
83 .layer_3_indicator = RGB_BACKLIGHT_LAYER_3_INDICATOR,
85 RGB_BACKLIGHT_ALPHAS_MODS_ROW_0,
86 RGB_BACKLIGHT_ALPHAS_MODS_ROW_1,
87 RGB_BACKLIGHT_ALPHAS_MODS_ROW_2,
88 RGB_BACKLIGHT_ALPHAS_MODS_ROW_3,
89 RGB_BACKLIGHT_ALPHAS_MODS_ROW_4 },
90 #if defined(RGB_BACKLIGHT_M6_B)
91 .custom_color = { { 0, 255 }, { 43, 255 }, { 85, 255 }, { 128, 255 }, { 171, 255 }, { 213, 255 } }
95 bool g_suspend_state = false;
96 uint8_t g_indicator_state = 0;
98 // Global tick at 20 Hz
101 // Ticks since this key was last hit.
102 uint8_t g_key_hit[BACKLIGHT_LED_COUNT];
104 // Ticks since any key was last hit.
105 uint32_t g_any_key_hit = 0;
107 #if defined(RGB_BACKLIGHT_HS60)
109 // This is a 7-bit address, that gets left-shifted and bit 0
110 // set to 0 for write, 1 for read (as per I2C protocol)
111 // ADDR_2 is not needed. it is here as a dummy
112 #define ISSI_ADDR_1 0x50
114 const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
115 /* Refer to IS31 manual for these locations
121 {0, B_1, A_1, C_1}, //LA1
122 {0, E_1, D_1, F_1}, //LA2
123 {0, H_1, G_1, I_1}, //LA3
124 {0, K_1, J_1, L_1}, //LA4
125 {0, B_2, A_2, C_2}, //LA5
126 {0, E_2, D_2, F_2}, //LA6
127 {0, H_2, G_2, I_2}, //LA7
128 {0, K_2, J_2, L_2}, //LA8
129 {0, B_3, A_3, C_3}, //LA9
130 {0, E_3, D_3, F_3}, //LA10
131 {0, H_3, G_3, I_3}, //LA11
132 {0, K_3, J_3, L_3}, //LA12
133 {0, B_4, A_4, C_4}, //LA13
134 {0, E_4, D_4, F_4}, //LA14
135 {0, H_4, G_4, I_4}, //LA15
136 {0, K_4, J_4, L_4}, //LA16
137 {0, B_5, A_5, C_5}, //LA17
138 {0, E_5, D_5, F_5}, //LA18
139 {0, H_5, G_5, I_5}, //LA19
140 {0, K_5, J_5, L_5}, //LA20
141 {0, B_6, A_6, C_6}, //LA21
142 {0, E_6, D_6, F_6}, //LA22
143 {0, H_6, G_6, I_6}, //LA23
144 {0, K_6, J_6, L_6}, //LA24
145 {0, B_7, A_7, C_7}, //LA25
146 {0, E_7, D_7, F_7}, //LA26
147 {0, H_7, G_7, I_7}, //LA27
148 {0, K_7, J_7, L_7}, //LA28
149 {0, B_8, A_8, C_8}, //LA29
150 {0, E_8, D_8, F_8}, //LA30
151 {0, H_8, G_8, I_8}, //LA31
152 {0, K_8, J_8, L_8}, //LA32
153 {0, B_9, A_9, C_9}, //LA33
154 {0, E_9, D_9, F_9}, //LA34
155 {0, H_9, G_9, I_9}, //LA35
156 {0, K_9, J_9, L_9}, //LA36
157 {0, B_10, A_10, C_10}, //LA37
158 {0, E_10, D_10, F_10}, //LA38
159 {0, H_10, G_10, I_10}, //LA39
160 {0, K_10, J_10, L_10}, //LA40
161 {0, B_11, A_11, C_11}, //LA41
162 {0, E_11, D_11, F_11}, //LA42
163 {0, H_11, G_11, I_11}, //LA43
164 {0, K_11, J_11, L_11}, //LA44
165 {0, B_12, A_12, C_12}, //LA45
166 {0, E_12, D_12, F_12}, //LA46
167 {0, H_12, G_12, I_12}, //LA47
168 {0, K_12, J_12, L_12}, //LA48
169 {0, B_13, A_13, C_13}, //LA49
170 {0, E_13, D_13, F_13}, //LA50
171 {0, H_13, G_13, I_13}, //LA51
172 {0, K_13, J_13, L_13}, //LA52
173 {0, B_14, A_14, C_14}, //LA53
174 {0, E_14, D_14, F_14}, //LA54
175 {0, H_14, G_14, I_14}, //LA55
176 {0, K_14, J_14, L_14}, //LA56
177 {0, B_15, A_15, C_15}, //LA57
178 {0, E_15, D_15, F_15}, //LA58
179 {0, H_15, G_15, I_15}, //LA59
180 {0, K_15, J_15, L_15}, //LA60
181 {0, B_16, A_16, C_16}, //LA61
182 {0, E_16, D_16, F_16}, //LA62
183 {0, H_16, G_16, I_16}, //LA63
184 {0, K_16, J_16, L_16}, //LA64
187 #elif defined(RGB_BACKLIGHT_NK65)
189 // This is a 7-bit address, that gets left-shifted and bit 0
190 // set to 0 for write, 1 for read (as per I2C protocol)
191 // ADDR_2 is not needed. it is here as a dummy
192 #define ISSI_ADDR_1 0x50
193 #define ISSI_ADDR_2 0x52
195 const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
196 /* Refer to IS31 manual for these locations
202 {0, B_1, A_1, C_1}, //LA1
203 {0, E_1, D_1, F_1}, //LA2
204 {0, H_1, G_1, I_1}, //LA3
205 {0, K_1, J_1, L_1}, //LA4
206 {0, B_2, A_2, C_2}, //LA5
207 {0, E_2, D_2, F_2}, //LA6
208 {0, H_2, G_2, I_2}, //LA7
209 {0, K_2, J_2, L_2}, //LA8
210 {0, B_3, A_3, C_3}, //LA9
211 {0, E_3, D_3, F_3}, //LA10
212 {0, H_3, G_3, I_3}, //LA11
213 {0, K_3, J_3, L_3}, //LA12
214 {0, B_4, A_4, C_4}, //LA13
215 {0, E_4, D_4, F_4}, //LA14
216 {0, H_4, G_4, I_4}, //LA15
217 {0, K_4, J_4, L_4}, //LA16
218 {0, B_5, A_5, C_5}, //LA17
219 {0, E_5, D_5, F_5}, //LA18
220 {0, H_5, G_5, I_5}, //LA19
221 {0, K_5, J_5, L_5}, //LA20
222 {0, B_6, A_6, C_6}, //LA21
223 {0, E_6, D_6, F_6}, //LA22
224 {0, H_6, G_6, I_6}, //LA23
225 {0, K_6, J_6, L_6}, //LA24
226 {0, B_7, A_7, C_7}, //LA25
227 {0, E_7, D_7, F_7}, //LA26
228 {0, H_7, G_7, I_7}, //LA27
229 {0, K_7, J_7, L_7}, //LA28
230 {0, B_8, A_8, C_8}, //LA29
231 {0, E_8, D_8, F_8}, //LA30
232 {0, H_8, G_8, I_8}, //LA31
233 {0, K_8, J_8, L_8}, //LA32
234 {0, B_9, A_9, C_9}, //LA33
235 {0, E_9, D_9, F_9}, //LA34
236 {0, H_9, G_9, I_9}, //LA35
237 {0, K_9, J_9, L_9}, //LA36
238 {0, B_10, A_10, C_10}, //LA37
239 {0, E_10, D_10, F_10}, //LA38
240 {0, H_10, G_10, I_10}, //LA39
241 {0, K_10, J_10, L_10}, //LA40
242 {0, B_11, A_11, C_11}, //LA41
243 {0, E_11, D_11, F_11}, //LA42
244 {0, H_11, G_11, I_11}, //LA43
245 {0, K_11, J_11, L_11}, //LA44
246 {0, B_12, A_12, C_12}, //LA45
247 {0, E_12, D_12, F_12}, //LA46
248 {0, H_12, G_12, I_12}, //LA47
249 {0, K_12, J_12, L_12}, //LA48
250 {0, B_13, A_13, C_13}, //LA49
251 {0, E_13, D_13, F_13}, //LA50
252 {0, H_13, G_13, I_13}, //LA51
253 {0, K_13, J_13, L_13}, //LA52
254 {0, B_14, A_14, C_14}, //LA53
255 {0, E_14, D_14, F_14}, //LA54
256 {0, H_14, G_14, I_14}, //LA55
257 {0, K_14, J_14, L_14}, //LA56
258 {0, B_15, A_15, C_15}, //LA57
259 {0, E_15, D_15, F_15}, //LA58
260 {0, H_15, G_15, I_15}, //LA59
261 {0, K_15, J_15, L_15}, //LA60
262 {0, B_16, A_16, C_16}, //LA61
263 {0, E_16, D_16, F_16}, //LA62
264 {0, H_16, G_16, I_16}, //LA63
265 {0, K_16, J_16, L_16}, //LA64
267 {1, B_1, A_1, C_1}, //LB1
268 {1, E_1, D_1, F_1}, //LB2
269 {1, H_1, G_1, I_1}, //LB3
270 {1, K_1, J_1, L_1}, //LB4
271 {1, B_2, A_2, C_2}, //LB5
272 {1, E_2, D_2, F_2}, //LB6
273 {1, H_2, G_2, I_2}, //LB7
274 {1, K_2, J_2, L_2}, //LB8
275 {1, B_3, A_3, C_3}, //LB9
276 {1, E_3, D_3, F_3}, //LB10
277 {1, H_3, G_3, I_3}, //LB11
278 {1, K_3, J_3, L_3}, //LB12
279 {1, B_4, A_4, C_4}, //LB13
280 {1, E_4, D_4, F_4}, //LB14
281 {1, H_4, G_4, I_4}, //LB15
282 {1, K_4, J_4, L_4}, //LB16
283 {1, B_5, A_5, C_5}, //LB17
284 {1, E_5, D_5, F_5}, //LB18
285 {1, H_5, G_5, I_5}, //LB19
286 {1, K_5, J_5, L_5}, //LB20
287 {1, B_6, A_6, C_6}, //LB21
288 {1, E_6, D_6, F_6}, //LB22
289 {1, H_6, G_6, I_6}, //LB23
290 {1, K_6, J_6, L_6}, //LB24
291 {1, B_7, A_7, C_7}, //LB25
292 {1, E_7, D_7, F_7}, //LB26
293 {1, H_7, G_7, I_7}, //LB27
294 {1, K_7, J_7, L_7}, //LB28
295 {1, B_8, A_8, C_8}, //LB29
296 {1, E_8, D_8, F_8}, //LB30
297 {1, H_8, G_8, I_8}, //LB31
298 {1, K_8, J_8, L_8}, //LB32
299 {1, B_9, A_9, C_9}, //LB33
300 {1, E_9, D_9, F_9}, //LB34
301 {1, H_9, G_9, I_9}, //LB35
302 {1, K_9, J_9, L_9}, //LB36
303 {1, B_10, A_10, C_10}, //LB37
304 {1, E_10, D_10, F_10}, //LB38
305 {1, H_10, G_10, I_10}, //LB39
306 {1, K_10, J_10, L_10}, //LB40
307 {1, B_11, A_11, C_11}, //LB41
308 {1, E_11, D_11, F_11}, //LB42
309 {1, H_11, G_11, I_11}, //LB43
310 {1, K_11, J_11, L_11}, //LB44
311 {1, B_12, A_12, C_12}, //LB45
312 {1, E_12, D_12, F_12}, //LB46
313 {1, H_12, G_12, I_12}, //LB47
314 {1, K_12, J_12, L_12}, //LB48
315 {1, B_13, A_13, C_13}, //LB49
316 {1, E_13, D_13, F_13}, //LB50
317 {1, H_13, G_13, I_13}, //LB51
318 {1, K_13, J_13, L_13}, //LB52
319 {1, B_14, A_14, C_14}, //LB53
320 {1, E_14, D_14, F_14}, //LB54
321 {1, H_14, G_14, I_14}, //LB55
322 {1, K_14, J_14, L_14}, //LB56
323 {1, B_15, A_15, C_15}, //LB57
324 {1, E_15, D_15, F_15}, //LB58
325 {1, H_15, G_15, I_15}, //LB59
326 {1, K_15, J_15, L_15}, //LB60
327 {1, B_16, A_16, C_16}, //LB61
328 {1, E_16, D_16, F_16}, //LB62
329 {1, H_16, G_16, I_16}, //LB63
330 {1, K_16, J_16, L_16}, //LB64
333 #elif !defined(RGB_BACKLIGHT_M6_B)
334 // This is a 7-bit address, that gets left-shifted and bit 0
335 // set to 0 for write, 1 for read (as per I2C protocol)
336 #define ISSI_ADDR_1 0x74
337 #define ISSI_ADDR_2 0x76
339 const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
340 /* Refer to IS31 manual for these locations
346 {0, C2_1, C3_1, C4_1}, // LA0
347 {0, C1_1, C3_2, C4_2}, // LA1
348 {0, C1_2, C2_2, C4_3}, // LA2
349 {0, C1_3, C2_3, C3_3}, // LA3
350 {0, C1_4, C2_4, C3_4}, // LA4
351 {0, C1_5, C2_5, C3_5}, // LA5
352 {0, C1_6, C2_6, C3_6}, // LA6
353 {0, C1_7, C2_7, C3_7}, // LA7
354 {0, C1_8, C2_8, C3_8}, // LA8
355 {0, C9_1, C8_1, C7_1}, // LA9
356 {0, C9_2, C8_2, C7_2}, // LA10
357 {0, C9_3, C8_3, C7_3}, // LA11
358 {0, C9_4, C8_4, C7_4}, // LA12
359 {0, C9_5, C8_5, C7_5}, // LA13
360 {0, C9_6, C8_6, C7_6}, // LA14
361 {0, C9_7, C8_7, C6_6}, // LA15
362 {0, C9_8, C7_7, C6_7}, // LA16
363 {0, C8_8, C7_8, C6_8}, // LA17
365 {0, C2_9, C3_9, C4_9}, // LB0
366 {0, C1_9, C3_10, C4_10}, // LB1
367 {0, C1_10, C2_10, C4_11}, // LB2
368 {0, C1_11, C2_11, C3_11}, // LB3
369 {0, C1_12, C2_12, C3_12}, // LB4
370 {0, C1_13, C2_13, C3_13}, // LB5
371 {0, C1_14, C2_14, C3_14}, // LB6
372 {0, C1_15, C2_15, C3_15}, // LB7
373 {0, C1_16, C2_16, C3_16}, // LB8
374 {0, C9_9, C8_9, C7_9}, // LB9
375 {0, C9_10, C8_10, C7_10}, // LB10
376 {0, C9_11, C8_11, C7_11}, // LB11
377 {0, C9_12, C8_12, C7_12}, // LB12
378 {0, C9_13, C8_13, C7_13}, // LB13
379 {0, C9_14, C8_14, C7_14}, // LB14
380 {0, C9_15, C8_15, C6_14}, // LB15
381 {0, C9_16, C7_15, C6_15}, // LB16
382 {0, C8_16, C7_16, C6_16}, // LB17
384 {1, C2_1, C3_1, C4_1}, // LC0
385 {1, C1_1, C3_2, C4_2}, // LC1
386 {1, C1_2, C2_2, C4_3}, // LC2
387 {1, C1_3, C2_3, C3_3}, // LC3
388 {1, C1_4, C2_4, C3_4}, // LC4
389 {1, C1_5, C2_5, C3_5}, // LC5
390 {1, C1_6, C2_6, C3_6}, // LC6
391 {1, C1_7, C2_7, C3_7}, // LC7
392 {1, C1_8, C2_8, C3_8}, // LC8
393 {1, C9_1, C8_1, C7_1}, // LC9
394 {1, C9_2, C8_2, C7_2}, // LC10
395 {1, C9_3, C8_3, C7_3}, // LC11
396 {1, C9_4, C8_4, C7_4}, // LC12
397 {1, C9_5, C8_5, C7_5}, // LC13
398 {1, C9_6, C8_6, C7_6}, // LC14
399 {1, C9_7, C8_7, C6_6}, // LC15
400 {1, C9_8, C7_7, C6_7}, // LC16
401 {1, C8_8, C7_8, C6_8}, // LC17
403 {1, C2_9, C3_9, C4_9}, // LD0
404 {1, C1_9, C3_10, C4_10}, // LD1
405 {1, C1_10, C2_10, C4_11}, // LD2
406 {1, C1_11, C2_11, C3_11}, // LD3
407 {1, C1_12, C2_12, C3_12}, // LD4
408 {1, C1_13, C2_13, C3_13}, // LD5
409 {1, C1_14, C2_14, C3_14}, // LD6
410 {1, C1_15, C2_15, C3_15}, // LD7
411 {1, C1_16, C2_16, C3_16}, // LD8
412 {1, C9_9, C8_9, C7_9}, // LD9
413 {1, C9_10, C8_10, C7_10}, // LD10
414 {1, C9_11, C8_11, C7_11}, // LD11
415 {1, C9_12, C8_12, C7_12}, // LD12
416 {1, C9_13, C8_13, C7_13}, // LD13
417 {1, C9_14, C8_14, C7_14}, // LD14
418 {1, C9_15, C8_15, C6_14}, // LD15
419 {1, C9_16, C7_15, C6_15}, // LD16
420 {1, C8_16, C7_16, C6_16}, // LD17
422 #endif // !defined(RGB_BACKLIGHT_M6_B)
425 typedef struct Point {
431 // index in range 0..71 (LA0..LA17, LB0..LB17, LC0..LC17, LD0..LD17)
432 // point values in range x=0..224 y=0..64
433 // origin is center of top-left key (i.e Esc)
434 #if defined(RGB_BACKLIGHT_ZEAL65)
435 const Point g_map_led_to_point[BACKLIGHT_LED_COUNT] PROGMEM = {
437 {120,16}, {104,16}, {88,16}, {72,16}, {56,16}, {40,16}, {24,16}, {4,16}, {4,32},
438 {128,0}, {112,0}, {96,0}, {80,0}, {64,0}, {48,0}, {32,0}, {16,0}, {0,0},
440 {144,0}, {160,0}, {176,0}, {192,0}, {216,0}, {224,0}, {240,0}, {240,16}, {240,32},
441 {136,16}, {152,16}, {168,16}, {184,16}, {200,16}, {220,16}, {240,48}, {240,64}, {224,64},
443 {96,64}, {100,48}, {84,48}, {68,48}, {52,48}, {36,48}, {255,255}, {48,60}, {28,64},
444 {108,32}, {92,32}, {76,32}, {60,32}, {44,32}, {28,32}, {20,44}, {10,48}, {4,64},
446 {124,32}, {140,32}, {156,32}, {172,32}, {188,32}, {214,32}, {180,48}, {202,48}, {224,48},
447 {116,48}, {132,48}, {148,48}, {164,48}, {255,255}, {144,60}, {164,64}, {188,64}, {208,64}
449 const Point g_map_led_to_point_polar[BACKLIGHT_LED_COUNT] PROGMEM = {
451 {64,128}, {75,132}, {84,145}, {91,164}, {97,187}, {102,213}, {105,242}, {109,255}, {128,243},
452 {61,255}, {67,255}, {72,255}, {77,255}, {82,255}, {86,255}, {90,255}, {93,255}, {96,255},
454 {56,255}, {51,255}, {46,255}, {42,255}, {37,255}, {35,255}, {32,255}, {19,255}, {0,255},
455 {53,132}, {44,145}, {37,164}, {31,187}, {26,213}, {22,249}, {237,255}, {224,255}, {221,255},
457 {184,255}, {179,135}, {170,149}, {163,169}, {157,193}, {153,220}, {255,255}, {167,255}, {165,255},
458 {128,26}, {128,60}, {128,94}, {128,128}, {128,162}, {128,196}, {145,233}, {148,255}, {161,255},
460 {0,9}, {0,43}, {0,77}, {0,111}, {0,145}, {0,201}, {224,181}, {230,217}, {235,255},
461 {189,128}, {200,131}, {210,141}, {218,159}, {255,255}, {201,228}, {206,255}, {213,255}, {218,255}
463 #elif defined(RGB_BACKLIGHT_KOYU)
464 const Point g_map_led_to_point[BACKLIGHT_LED_COUNT] PROGMEM = {
466 {120,16}, {104,16}, {88,16}, {72,16}, {56,16}, {40,16}, {24,16}, {4,16}, {4,32},
467 {128,0}, {112,0}, {96,0}, {80,0}, {64,0}, {48,0}, {32,0}, {16,0}, {0,0},
469 {144,0}, {160,0}, {176,0}, {192,0}, {208,0}, {224,0}, {240,0}, {240,16}, {240,32},
470 {136,16}, {152,16}, {168,16}, {184,16}, {200,16}, {220,16}, {240,48}, {240,64}, {224,64},
472 {112,64}, {100,48}, {84,48}, {68,48}, {52,48}, {36,48}, {64,60}, {44,60}, {24,64},
473 {108,32}, {92,32}, {76,32}, {60,32}, {44,32}, {28,32}, {255,255}, {10,48}, {4,64},
475 {124,32}, {140,32}, {156,32}, {172,32}, {188,32}, {214,32}, {180,48}, {202,48}, {224,48},
476 {116,48}, {132,48}, {148,48}, {164,48}, {255,255}, {160,60}, {180,64}, {208,64}, {255,255}
478 const Point g_map_led_to_point_polar[BACKLIGHT_LED_COUNT] PROGMEM = {
480 {64,128}, {75,132}, {84,145}, {91,164}, {97,187}, {102,213}, {105,242}, {109,255}, {128,243},
481 {61,255}, {67,255}, {72,255}, {77,255}, {82,255}, {86,255}, {90,255}, {93,255}, {96,255},
483 {56,255}, {51,255}, {46,255}, {42,255}, {38,255}, {35,255}, {32,255}, {19,255}, {0,255},
484 {53,132}, {44,145}, {37,164}, {31,187}, {26,213}, {22,249}, {237,255}, {224,255}, {221,255},
486 {189,255}, {179,135}, {170,149}, {163,169}, {157,193}, {153,220}, {172,252}, {169,255}, {165,255},
487 {128,26}, {128,60}, {128,94}, {128,128}, {128,162}, {128,196}, {255,255}, {148,255}, {161,255},
489 {0,9}, {0,43}, {0,77}, {0,111}, {0,145}, {0,201}, {224,181}, {230,217}, {235,255},
490 {189,128}, {200,131}, {210,141}, {218,159}, {255,255}, {207,238}, {211,255}, {218,255}, {255,255}
492 #elif defined(RGB_BACKLIGHT_ZEAL60) || defined(RGB_BACKLIGHT_M60_A)
493 const Point g_map_led_to_point[BACKLIGHT_LED_COUNT] PROGMEM = {
495 {120,16}, {104,16}, {88,16}, {72,16}, {56,16}, {40,16}, {24,16}, {4,16}, {4,32},
496 {128,0}, {112,0}, {96,0}, {80,0}, {64,0}, {48,0}, {32,0}, {16,0}, {0,0},
498 {144,0}, {160,0}, {176,0}, {192,0}, {216,0}, {224,0}, {255,255}, {255,255}, {255,255},
499 {136,16}, {152,16}, {168,16}, {184,16}, {200,16}, {220,16}, {255,255}, {255,255}, {255,255},
501 {102,64}, {100,48}, {84,48}, {68,48}, {52,48}, {36,48}, {60,64}, {43,64}, {23,64},
502 {108,32}, {92,32}, {76,32}, {60,32}, {44,32}, {28,32}, {20,48}, {2,48}, {3,64},
504 {124,32}, {140,32}, {156,32}, {172,32}, {188,32}, {214,32}, {180,48}, {210,48}, {224,48},
505 {116,48}, {132,48}, {148,48}, {164,48}, {144,64}, {161,64}, {181,64}, {201,64}, {221,64}
507 const Point g_map_led_to_point_polar[BACKLIGHT_LED_COUNT] PROGMEM = {
509 {58,129}, {70,129}, {80,139}, {89,157}, {96,181}, {101,208}, {105,238}, {109,255}, {128,247}, {58,255},
510 {64,255}, {70,255}, {75,255}, {80,255}, {85,255}, {89,255}, {93,255}, {96,255},
512 {53,255}, {48,255}, {43,255}, {39,255}, {34,255}, {32,255}, {255,255}, {255,255}, {255,255},
513 {48,139}, {39,157}, {32,181}, {27,208}, {23,238}, {19,255}, {255,255}, {255,255}, {255,255},
515 {188,255}, {183,131}, {173,143}, {165,163}, {159,188}, {154,216}, {172,252}, {170,255}, {165,255},
516 {128,9}, {128,46}, {128,82}, {128,119}, {128,155}, {128,192}, {150,244}, {147,255}, {161,255},
518 {0,27}, {0,64}, {0,101}, {0,137}, {0,174}, {255,233}, {228,201}, {235,255}, {237,255},
519 {195,128}, {206,136}, {215,152}, {222,175}, {205,234}, {209,255}, {214,255}, {219,255}, {223,255}
521 #elif defined(RGB_BACKLIGHT_HS60) && defined(HS60_ANSI)
522 const Point g_map_led_to_point[BACKLIGHT_LED_COUNT] PROGMEM = {
524 {0,0}, {4,16}, {6,32}, {10,48}, {16,0}, {24,16}, {28,32}, {36,48}, {32,0}, {40,16}, {44,32}, {52,48},
525 {48,0}, {56,16}, {60,32}, {68,48}, {64,0}, {72,16}, {76,32}, {84,48}, {80,0}, {88,16}, {92,32}, {100,48},
526 {96,0}, {104,16}, {108,32}, {116,48}, {112,0}, {120,16}, {124,32}, {132,48}, {128,0}, {136,16}, {140,32},
527 {148,48}, {144,0}, {152,16}, {156,32}, {164,48}, {160,0}, {168,16}, {172,32}, {180,48}, {176,0}, {184, 16}, {188,32},
528 {255,255},// LA48 does not exist, dummy
531 {255,255},// LA51 does not exit, dummy
533 {210,48}, {216,0}, {220,16}, {214,32}, {222,64}, {2,64}, {22,64}, {42,64}, {102,64},
534 {255,255},// LA61 does not exit, dummy
535 {162,64}, {182,64}, {202,64}
537 const Point g_map_led_to_point_polar[BACKLIGHT_LED_COUNT] PROGMEM = {
539 {96,255}, {109,255}, {128,242}, {148,255}, {93,255}, {105,238}, {128,192}, {154,216}, {89,255}, {101,208}, {128,155}, {159,188},
540 {85,255}, {96,181}, {128,119}, {165,163}, {81,255}, {89,157}, {128,82}, {173,143}, {75,255}, {81,139}, {128,46}, {183,131},
541 {70,255}, {70,129}, {129,9}, {195,128}, {64,255}, {58,129}, {255,27}, {206,136}, {58,255}, {47,139}, {255,64}, {215,152},
542 {53,255}, {39,157}, {255,101}, {222,175}, {47,255}, {32,181}, {255,137}, {228,201}, {43,255}, {27,208}, {255, 174},
543 {255,255},// LA48 does not exist, dummy
546 {255,255},// LA51 does not exit, dummy
548 {235,255}, {33,255}, {19,255}, {255,233}, {224,255}, {160,255}, {164,255}, {169,255}, {188,255},
549 {255,255},// LA61 does not exit, dummy
550 {209,255}, {215,255}, {220,255}
552 #elif defined(RGB_BACKLIGHT_HS60) && defined(HS60_HHKB)
553 const Point g_map_led_to_point[BACKLIGHT_LED_COUNT] PROGMEM = {
555 {0,0}, {4,16}, {6,32}, {10,48}, {16,0}, {24,16}, {28,32}, {36,48}, {32,0}, {40,16}, {44,32}, {52,48},
556 {48,0}, {56,16}, {60,32}, {68,48}, {64,0}, {72,16}, {76,32}, {84,48}, {80,0}, {88,16}, {92,32}, {100,48},
557 {96,0}, {104,16}, {108,32}, {116,48}, {112,0}, {120,16}, {124,32}, {132,48}, {128,0}, {136,16}, {140,32},
558 {148,48}, {144,0}, {152,16}, {156,32}, {164,48}, {160,0}, {168,16}, {172,32}, {180,48}, {176,0}, {184, 16}, {188,32},
559 {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},
560 {255,255}, {255,255}, // LA61..LA62 does not exit, dummy
564 const Point g_map_led_to_point_polar[BACKLIGHT_LED_COUNT] PROGMEM = {
566 {96,255}, {109,255}, {128,242}, {148,255}, {93,255}, {105,238}, {128,192}, {154,216}, {89,255}, {101,208}, {128,155}, {159,188},
567 {85,255}, {96,181}, {128,119}, {165,163}, {81,255}, {89,157}, {128,82}, {173,143}, {75,255}, {81,139}, {128,46}, {183,131},
568 {70,255}, {70,129}, {129,9}, {195,128}, {64,255}, {58,129}, {255,27}, {206,136}, {58,255}, {47,139}, {255,64}, {215,152},
569 {53,255}, {39,157}, {255,101}, {222,175}, {47,255}, {32,181}, {255,137}, {228,201}, {43,255}, {27,208}, {255, 174}, {32,255},
570 {39,255}, {23,238}, {233,242}, {237,255}, {35,255}, {19,255}, {255,233}, {223,255}, {161,255}, {165,255}, {170,255}, {192,255},
571 {255,255}, {255,255}, // LA61..LA62 does not exit, dummy
575 #elif defined(RGB_BACKLIGHT_HS60) //HS60_ISO
576 const Point g_map_led_to_point[BACKLIGHT_LED_COUNT] PROGMEM = {
578 {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},
579 {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},
580 {108,32}, {116,48}, {112,0}, {120,16}, {124,32}, {132,48}, {128,0}, {136,16}, {140,32}, {148,48}, {144,0}, {152,16},
581 {156,32}, {164,48}, {160,0}, {168,16}, {172,32}, {180,48}, {176,0}, {184, 16}, {188,32}, {20,48}, {192,0}, {200,16},
582 {255,255},// LA51 does not exit, dummy
584 {210,48}, {216,0}, {220,16}, {222,24}, {222,64}, {2,64}, {22,64}, {42,64}, {102,64},
585 {255,255},// LA61 does not exit, dummy
586 {162,64}, {182,64}, {202,64}
588 const Point g_map_led_to_point_polar[BACKLIGHT_LED_COUNT] PROGMEM = {
590 {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},
591 {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},
592 {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},
593 {222,175}, {47,255}, {32,181}, {255,137}, {228,201}, {43,255}, {27,208}, {255, 174}, {150,246}, {39,255}, {23,238},
594 {255,255},// LA51 does not exit, dummy
596 {235,255}, {33,255}, {19,255}, {10,255}, {224,255}, {160,255}, {164,255}, {169,255}, {188,255},
597 {255,255},// LA61 does not exit, dummy
598 {209,255}, {215,255}, {220,255}
600 #elif defined(RGB_BACKLIGHT_NK65)
601 const Point g_map_led_to_point[BACKLIGHT_LED_COUNT] PROGMEM = {
603 {0,0}, {4,16}, {6,32}, {10,48}, {16,0}, {24,16}, {28,32}, {36,48}, {32,0}, {40,16}, {44,32}, {52,48},
604 {48,0}, {56,16}, {60,32}, {68,48}, {64,0}, {72,16}, {76,32}, {84,48}, {80,0}, {88,16}, {92,32}, {100,48},
605 {96,0}, {104,16}, {108,32}, {116,48}, {112,0}, {120,16}, {124,32}, {132,48}, {128,0}, {136,16}, {140,32},
606 {148,48}, {144,0}, {152,16}, {156,32}, {164,48}, {160,0}, {168,16}, {172,32}, {180,48}, {176,0}, {184, 16}, {188,32},
607 {160,64}, {192,0}, {200,16}, {210,48}, {224,48}, {216,0}, {220,16}, {214,32}, {224,64}, {2,64}, {22,64}, {42,64}, {102,64},
608 {255,255},// LA61 does not exit, dummy
610 {176,64}, {192,64}, {208,64}, {240,0}, {240,16}, {240,48}, {240,64}, {240,32}
612 const Point g_map_led_to_point_polar[BACKLIGHT_LED_COUNT] PROGMEM = {
614 {96,255}, {109,255}, {128,242}, {148,255}, {93,255}, {105,238}, {128,192}, {154,216}, {89,255}, {101,208}, {128,155}, {159,188},
615 {85,255}, {96,181}, {128,119}, {165,163}, {81,255}, {89,157}, {128,82}, {173,143}, {75,255}, {81,139}, {128,46}, {183,131},
616 {70,255}, {70,129}, {129,9}, {195,128}, {64,255}, {58,129}, {255,27}, {206,136}, {58,255}, {47,139}, {255,64}, {215,152},
617 {53,255}, {39,157}, {255,101}, {222,175}, {47,255}, {32,181}, {255,137}, {228,201}, {43,255}, {27,208}, {255, 174},
618 {208,255}, {39,255}, {23,238}, {235,255}, {235,255}, {33,255}, {19,255}, {255,233}, {224,255}, {160,255}, {164,255}, {169,255}, {188,255},
619 {255,255},// LA61 does not exit, dummy
621 {221,255}, {225,255}, {229,255}, {22,255}, {12,255}, {244,255}, {234,255}, {255,255},
623 #elif defined(RGB_BACKLIGHT_M6_B)
624 // M6-B is really simple:
627 const Point g_map_led_to_point[BACKLIGHT_LED_COUNT] PROGMEM = {
628 {0,0}, {0,16}, {16,16}, {16,0}, {32,16}, {32,0}
630 const Point g_map_led_to_point_polar[BACKLIGHT_LED_COUNT] PROGMEM = {
631 {160,255}, {96,255}, {77,255}, {179,255}, {51,255}, {205,255}
635 // This may seem counter-intuitive, but it's quite flexible.
636 // For each LED, get it's position to decide what color to make it.
637 // This solves the issue of LEDs (and switches) not aligning to a grid,
638 // or having a large "bitmap" and sampling them.
639 void map_led_to_point( uint8_t index, Point *point )
641 // Slightly messy way to get Point structs out of progmem.
642 uint8_t *addr = (uint8_t*)&g_map_led_to_point[index];
643 point->x = pgm_read_byte(addr);
644 point->y = pgm_read_byte(addr+1);
646 #if defined(RGB_BACKLIGHT_M6_B) || defined(RGB_BACKLIGHT_HS60) || defined(RGB_BACKLIGHT_NK65)
653 if ( g_config.use_split_backspace )
656 #if defined(RGB_BACKLIGHT_ZEAL60)
658 if ( g_config.use_iso_enter )
659 point->y += 8; // extremely pedantic
662 if ( !g_config.use_iso_enter )
666 if ( !g_config.use_split_left_shift )
670 #if defined(RGB_BACKLIGHT_ZEAL60) || defined(RGB_BACKLIGHT_M60_A)
672 if ( g_config.use_7u_spacebar )
676 if ( g_config.use_7u_spacebar )
680 if ( !g_config.use_split_right_shift )
687 void map_led_to_point_polar( uint8_t index, Point *point )
689 // Slightly messy way to get Point structs out of progmem.
690 uint8_t *addr = (uint8_t*)&g_map_led_to_point_polar[index];
691 point->x = pgm_read_byte(addr);
692 point->y = pgm_read_byte(addr+1);
696 // Maps switch matrix coordinate (row,col) to LED index
700 #if defined(RGB_BACKLIGHT_ZEAL65)
701 // Note: Left spacebar stab is at 4,2 (LC7)
702 // Right spacebar stab is at 4,9 (D14)
704 // A17, A16, A15, A14, A13, A12, A11, A10, A9, B0, B1, B2, B3, B4, B6
705 // A7, A6, A5, A4, A3, A2, A1, A0, B9, B10, B11, B12, B13, B14, B7
706 // A8, C14, C13, C12, C11, C10, C9, D0, D1, D2, D3, D4, D5, B5, B8
707 // C16, C15, C5, C4, C3, C2, C1, D9, D10, D11, D12, D6, D7, D8, B15
708 // C17, C8, C7, ---, ---, ---, ---, C0, ---, D14, D15, D16, D17, B17, B16
709 const uint8_t g_map_row_column_to_led[MATRIX_ROWS][MATRIX_COLS] PROGMEM = {
710 { 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 },
711 { 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 },
712 { 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 },
713 { 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 },
714 { 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 }
716 #elif defined(RGB_BACKLIGHT_KOYU)
717 // Note: Left spacebar stab is at 4,4 (LC6)
718 // Right spacebar stab is at 4,10 (D14)
720 // A17, A16, A15, A14, A13, A12, A11, A10, A9, B0, B1, B2, B3, B4, B6
721 // A7, A6, A5, A4, A3, A2, A1, A0, B9, B10, B11, B12, B13, B14, B7
722 // A8, C14, C13, C12, C11, C10, C9, D0, D1, D2, D3, D4, D5, B5, B8
723 // C16, C15, C5, C4, C3, C2, C1, D9, D10, D11, D12, D6, D7, D8, B15
724 // C17, C8, C7, C6, ---, ---, ---, C0, ---, ---, D14, D15, D16, B17, B16
725 const uint8_t g_map_row_column_to_led[MATRIX_ROWS][MATRIX_COLS] PROGMEM = {
726 { 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 },
727 { 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 },
728 { 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 },
729 { 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 },
730 { 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 }
732 #elif defined(RGB_BACKLIGHT_ZEAL60) || defined(RGB_BACKLIGHT_M60_A)
733 // Note: Left spacebar stab is at 4,3 (LC6)
734 // Right spacebar stab is at 4,9 (LD13) or 4,10 (LD14)
736 // A17, A16, A15, A14, A13, A12, A11, A10, A9, B0, B1, B2, B3, B4,
737 // A7, A6, A5, A4, A3, A2, A1, A0, B9, B10, B11, B12, B13, B14,
738 // A8, C14, C13, C12, C11, C10, C9, D0, D1, D2, D3, D4, D5, B5,
739 // C16, C15, C5, C4, C3, C2, C1, D9, D10, D11, D12, D6, D7, D8,
740 // C17, C8, C7, C6, ---, ---, ---, C0, ---, D13, D14, D15, D16, D17,
741 const uint8_t g_map_row_column_to_led[MATRIX_ROWS][MATRIX_COLS] PROGMEM = {
742 { 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 },
743 { 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 },
744 { 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 },
745 { 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 },
746 { 36+17, 36+8, 36+7, 36+6, 255, 255, 255, 36+0, 255, 54+13, 54+14, 54+15, 54+16, 54+17 }
748 #elif defined(RGB_BACKLIGHT_HS60) && defined(HS60_ANSI)
750 // LA1, LA5, LA9, LA13, LA17, LA21, LA25, LA29, LA33, LA37, LA41, LA45, LA49, LA53,
751 // LA2, LA6, LA10, LA14, LA18, LA22, LA26, LA30, LA34, LA38, LA42, LA46, LA50, ---,
752 // LA3, LA7, LA11, LA15, LA19, LA23, LA27, LA31, LA35, LA39, LA43, LA47, LA54, LA55,
753 // LA4, ---, LA8, LA12, LA16, LA20, LA24, LA28, LA32, LA36, LA40, LA44, ---, LA52,
754 // LA57, LA58, LA59, ---, ---, ---, LA60, ---, ---, ---, LA62, LA63, LA64, LA56
755 const uint8_t g_map_row_column_to_led[MATRIX_ROWS][MATRIX_COLS] PROGMEM = {
756 { 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 },
757 { 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 },
758 { 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 },
759 { 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 },
760 { 57-1, 58-1, 59-1, 255, 255, 255, 60-1, 255, 255, 255, 62-1, 63-1, 64-1, 56-1 }
762 #elif defined(RGB_BACKLIGHT_HS60) && defined(HS60_HHKB)
764 // LA1, LA5, LA9, LA13, LA17, LA21, LA25, LA29, LA33, LA37, LA41, LA45, LA49, LA53,
765 // LA2, LA6, LA10, LA14, LA18, LA22, LA26, LA30, LA34, LA38, LA42, LA46, LA50, LA48,
766 // LA3, LA7, LA11, LA15, LA19, LA23, LA27, LA31, LA35, LA39, LA43, LA47, LA54, LA55,
767 // LA4, ---, LA8, LA12, LA16, LA20, LA24, LA28, LA32, LA36, LA40, LA44, LA51, LA52,
768 // LA57, LA58, LA59, ---, ---, ---, LA60, ---, ---, ---, ---, LA63, LA64, LA56
769 const uint8_t g_map_row_column_to_led[MATRIX_ROWS][MATRIX_COLS] PROGMEM = {
770 { 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 },
771 { 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 },
772 { 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 },
773 { 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 },
774 { 57-1, 58-1, 59-1, 255, 255, 255, 60-1, 255, 255, 255, 255, 63-1, 64-1, 56-1 }
776 #elif defined(RGB_BACKLIGHT_HS60) //HS60_ISO
778 // LA1, LA5, LA9, LA13, LA17, LA21, LA25, LA29, LA33, LA37, LA41, LA45, LA49, LA53,
779 // LA2, LA6, LA10, LA14, LA18, LA22, LA26, LA30, LA34, LA38, LA42, LA46, LA50, ---,
780 // LA3, LA7, LA11, LA15, LA19, LA23, LA27, LA31, LA35, LA39, LA43, LA47, LA54, LA55,
781 // LA4, LA48, LA8, LA12, LA16, LA20, LA24, LA28, LA32, LA36, LA40, LA44, ---, LA52,
782 // LA57, LA58, LA59, ---, ---, ---, LA60, ---, ---, ---, LA62, LA63, LA64, LA56
783 const uint8_t g_map_row_column_to_led[MATRIX_ROWS][MATRIX_COLS] PROGMEM = {
784 { 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 },
785 { 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 },
786 { 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 },
787 { 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 },
788 { 57-1, 58-1, 59-1, 255, 255, 255, 60-1, 255, 255, 255, 62-1, 63-1, 64-1, 56-1 }
790 #elif defined(RGB_BACKLIGHT_NK65)
792 // LA1, LA5, LA9, LA13, LA17, LA21, LA25, LA29, LA33, LA37, LA41, LA45, LA49, LA53, LB1,
793 // LA2, LA6, LA10, LA14, LA18, LA22, LA26, LA30, LA34, LA38, LA42, LA46, LA50, ---, LB2,
794 // LA3, LA7, LA11, LA15, LA19, LA23, LA27, LA31, LA35, LA39, LA43, LA47, LA54, LA55, LB5,
795 // LA4, ---, LA8, LA12, LA16, LA20, LA24, LA28, LA32, LA36, LA40, LA44, LA51, LA52, LB3,
796 // LA57, LA58, LA59, ---, ---, ---, LA60, ---, ---, LA48, LA62, LA63, LA64, LA56, LB4
797 const uint8_t g_map_row_column_to_led[MATRIX_ROWS][MATRIX_COLS] PROGMEM = {
798 { 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, 1+64-1 },
799 { 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, 2+64-1 },
800 { 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, 5+64-1 },
801 { 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, 3+64-1 },
802 { 57-1, 58-1, 59-1, 255, 255, 255, 60-1, 255, 255, 48-1, 62-1, 63-1, 64-1, 56-1, 4+64-1 }
804 #elif defined(RGB_BACKLIGHT_M6_B)
805 // M6-B is really simple:
808 const uint8_t g_map_row_column_to_led[MATRIX_ROWS][MATRIX_COLS] PROGMEM = {
813 void map_row_column_to_led( uint8_t row, uint8_t column, uint8_t *led )
816 if ( row < MATRIX_ROWS && column < MATRIX_COLS )
818 *led = pgm_read_byte(&g_map_row_column_to_led[row][column]);
822 void backlight_update_pwm_buffers(void)
824 #if defined(RGB_BACKLIGHT_M6_B)
825 IS31FL3218_update_pwm_buffers();
826 #elif defined(RGB_BACKLIGHT_HS60)
827 IS31FL3733_update_pwm_buffers( ISSI_ADDR_1, 0 );
828 IS31FL3733_update_led_control_registers( ISSI_ADDR_1, 0 );
829 #elif defined(RGB_BACKLIGHT_NK65)
830 IS31FL3733_update_pwm_buffers( ISSI_ADDR_1, 0 );
831 IS31FL3733_update_pwm_buffers( ISSI_ADDR_2, 1 );
832 IS31FL3733_update_led_control_registers( ISSI_ADDR_1, 0 );
833 IS31FL3733_update_led_control_registers( ISSI_ADDR_2, 1 );
835 IS31FL3731_update_pwm_buffers( ISSI_ADDR_1, ISSI_ADDR_2 );
836 IS31FL3731_update_led_control_registers( ISSI_ADDR_1, ISSI_ADDR_2 );
840 void backlight_set_color( int index, uint8_t red, uint8_t green, uint8_t blue )
842 #if defined(RGB_BACKLIGHT_M6_B)
843 IS31FL3218_set_color( index, red, green, blue );
844 #elif defined(RGB_BACKLIGHT_HS60) || defined(RGB_BACKLIGHT_NK65)
845 IS31FL3733_set_color( index, red, green, blue );
847 IS31FL3731_set_color( index, red, green, blue );
851 void backlight_set_color_all( uint8_t red, uint8_t green, uint8_t blue )
853 #if defined(RGB_BACKLIGHT_M6_B)
854 IS31FL3218_set_color_all( red, green, blue );
855 #elif defined(RGB_BACKLIGHT_HS60) || defined(RGB_BACKLIGHT_NK65)
856 IS31FL3733_set_color_all( red, green, blue );
858 IS31FL3731_set_color_all( red, green, blue );
862 void backlight_set_key_hit(uint8_t row, uint8_t column)
865 map_row_column_to_led(row,column,&led);
871 #if !defined(RGB_BACKLIGHT_HS60) && !defined(RGB_BACKLIGHT_NK65)
872 // This is (F_CPU/1024) / 20 Hz
873 // = 15625 Hz / 20 Hz
875 #define TIMER3_TOP 781
877 void backlight_timer_init(void)
879 static uint8_t backlight_timer_is_init = 0;
880 if ( backlight_timer_is_init )
884 backlight_timer_is_init = 1;
887 TCCR3B = _BV(WGM32) | // CTC mode OCR3A as TOP
888 _BV(CS32) | _BV(CS30); // prescale by /1024
893 OCR3AH = (TIMER3_TOP >> 8) & 0xff;
894 OCR3AL = TIMER3_TOP & 0xff;
898 void backlight_timer_enable(void)
900 TIMSK3 |= _BV(OCIE3A);
903 void backlight_timer_disable(void)
905 TIMSK3 &= ~_BV(OCIE3A);
907 #else //STM32, use GPT with TIM4. Enable in halconf.h
908 static void gpt_backlight_timer_task(GPTDriver *gptp);
909 // Timer setup at 200Khz, callback at 10k ticks = 20Hz
910 static GPTConfig gpt4cfg1 = {
911 .frequency = 200000U,
912 .callback = gpt_backlight_timer_task
915 void backlight_timer_init(void)
917 gptStart(&GPTD4, &gpt4cfg1);
920 void backlight_timer_enable(void)
922 gptStartContinuous(&GPTD4, 10000);
925 void backlight_timer_disable(void)
927 gptStopTimer(&GPTD4);
929 #endif //!defined(RGB_BACKLIGHT_HS60) && !defined(RGB_BACKLIGHT_NK65)
931 void backlight_set_suspend_state(bool state)
933 g_suspend_state = state;
936 void backlight_set_indicator_state(uint8_t state)
938 g_indicator_state = state;
941 void backlight_effect_rgb_test(void)
943 // Mask out bits 4 and 5
944 // This 2-bit value will stay the same for 16 ticks.
945 switch ( (g_tick & 0x30) >> 4 )
949 backlight_set_color_all( 255, 0, 0 );
954 backlight_set_color_all( 0, 255, 0 );
959 backlight_set_color_all( 0, 0, 255 );
964 backlight_set_color_all( 255, 255, 255 );
970 #if defined(RGB_DEBUGGING_ONLY)
971 // This tests the LEDs
972 // Note that it will change the LED control registers
973 // in the LED drivers, and leave them in an invalid
974 // state for other backlight effects.
975 // ONLY USE THIS FOR TESTING LEDS!
976 void backlight_effect_single_LED_test(void)
978 static uint8_t color = 0; // 0,1,2 for R,G,B
979 static uint8_t row = 0;
980 static uint8_t column = 0;
982 static uint8_t tick = 0;
1006 map_row_column_to_led( row, column, &led );
1007 backlight_set_color_all( 255, 255, 255 );
1008 backlight_test_led( led, color==0, color==1, color==2 );
1010 #endif // defined(RGB_DEBUGGING_ONLY)
1013 void backlight_effect_all_off(void)
1015 backlight_set_color_all( 0, 0, 0 );
1019 void backlight_effect_solid_color(void)
1021 HSV hsv = { .h = g_config.color_1.h, .s = g_config.color_1.s, .v = g_config.brightness };
1022 RGB rgb = hsv_to_rgb( hsv );
1023 backlight_set_color_all( rgb.r, rgb.g, rgb.b );
1026 // alphas = color1, mods = color2
1027 void backlight_effect_alphas_mods(void)
1029 RGB rgb1 = hsv_to_rgb( (HSV){ .h = g_config.color_1.h, .s = g_config.color_1.s, .v = g_config.brightness } );
1030 RGB rgb2 = hsv_to_rgb( (HSV){ .h = g_config.color_2.h, .s = g_config.color_2.s, .v = g_config.brightness } );
1032 for ( int row = 0; row < MATRIX_ROWS; row++ )
1034 for ( int column = 0; column < MATRIX_COLS; column++ )
1037 map_row_column_to_led( row, column, &index );
1038 if ( index < BACKLIGHT_LED_COUNT )
1040 if ( ( g_config.alphas_mods[row] & (1<<column) ) == 0 )
1042 backlight_set_color( index, rgb1.r, rgb1.g, rgb1.b );
1046 backlight_set_color( index, rgb2.r, rgb2.g, rgb2.b );
1053 void backlight_effect_gradient_up_down(void)
1055 int16_t h1 = g_config.color_1.h;
1056 int16_t h2 = g_config.color_2.h;
1057 int16_t deltaH = h2 - h1;
1059 // Take the shortest path between hues
1064 else if ( deltaH < -127 )
1068 // Divide delta by 4, this gives the delta per row
1071 int16_t s1 = g_config.color_1.s;
1072 int16_t s2 = g_config.color_2.s;
1073 int16_t deltaS = ( s2 - s1 ) / 4;
1075 HSV hsv = { .h = 0, .s = 255, .v = g_config.brightness };
1078 for ( int i=0; i<BACKLIGHT_LED_COUNT; i++ )
1080 map_led_to_point( i, &point );
1081 // The y range will be 0..64, map this to 0..4
1082 uint8_t y = (point.y>>4);
1083 // Relies on hue being 8-bit and wrapping
1084 hsv.h = g_config.color_1.h + ( deltaH * y );
1085 hsv.s = g_config.color_1.s + ( deltaS * y );
1086 rgb = hsv_to_rgb( hsv );
1087 backlight_set_color( i, rgb.r, rgb.g, rgb.b );
1091 void backlight_effect_raindrops(bool initialize)
1093 int16_t h1 = g_config.color_1.h;
1094 int16_t h2 = g_config.color_2.h;
1095 int16_t deltaH = h2 - h1;
1098 // Take the shortest path between hues
1103 else if ( deltaH < -127 )
1108 int16_t s1 = g_config.color_1.s;
1109 int16_t s2 = g_config.color_2.s;
1110 int16_t deltaS = ( s2 - s1 ) / 4;
1115 // Change one LED every tick
1116 uint8_t led_to_change = ( g_tick & 0x000 ) == 0 ? rand() % BACKLIGHT_LED_COUNT : 255;
1118 for ( int i=0; i<BACKLIGHT_LED_COUNT; i++ )
1120 // If initialize, all get set to random colors
1121 // If not, all but one will stay the same as before.
1122 if ( initialize || i == led_to_change )
1124 hsv.h = h1 + ( deltaH * ( rand() & 0x03 ) );
1125 hsv.s = s1 + ( deltaS * ( rand() & 0x03 ) );
1126 // Override brightness with global brightness control
1127 hsv.v = g_config.brightness;;
1129 rgb = hsv_to_rgb( hsv );
1130 backlight_set_color( i, rgb.r, rgb.g, rgb.b );
1135 void backlight_effect_cycle_all(void)
1137 uint8_t offset = ( g_tick << g_config.effect_speed ) & 0xFF;
1139 // Relies on hue being 8-bit and wrapping
1140 for ( int i=0; i<BACKLIGHT_LED_COUNT; i++ )
1142 uint16_t offset2 = g_key_hit[i]<<2;
1143 #if !defined(RGB_BACKLIGHT_HS60) && !defined(RGB_BACKLIGHT_NK65)
1144 // stabilizer LEDs use spacebar hits
1145 if ( i == 36+6 || i == 54+13 || // LC6, LD13
1146 ( g_config.use_7u_spacebar && i == 54+14 ) ) // LD14
1148 offset2 = g_key_hit[36+0]<<2;
1151 offset2 = (offset2<=63) ? (63-offset2) : 0;
1153 HSV hsv = { .h = offset+offset2, .s = 255, .v = g_config.brightness };
1154 RGB rgb = hsv_to_rgb( hsv );
1155 backlight_set_color( i, rgb.r, rgb.g, rgb.b );
1159 void backlight_effect_cycle_left_right(void)
1161 uint8_t offset = ( g_tick << g_config.effect_speed ) & 0xFF;
1162 HSV hsv = { .h = 0, .s = 255, .v = g_config.brightness };
1165 for ( int i=0; i<BACKLIGHT_LED_COUNT; i++ )
1167 uint16_t offset2 = g_key_hit[i]<<2;
1168 #if !defined(RGB_BACKLIGHT_HS60) && !defined(RGB_BACKLIGHT_NK65)
1169 // stabilizer LEDs use spacebar hits
1170 if ( i == 36+6 || i == 54+13 || // LC6, LD13
1171 ( g_config.use_7u_spacebar && i == 54+14 ) ) // LD14
1173 offset2 = g_key_hit[36+0]<<2;
1176 offset2 = (offset2<=63) ? (63-offset2) : 0;
1178 map_led_to_point( i, &point );
1179 // Relies on hue being 8-bit and wrapping
1180 hsv.h = point.x + offset + offset2;
1181 rgb = hsv_to_rgb( hsv );
1182 backlight_set_color( i, rgb.r, rgb.g, rgb.b );
1186 void backlight_effect_cycle_up_down(void)
1188 uint8_t offset = ( g_tick << g_config.effect_speed ) & 0xFF;
1189 HSV hsv = { .h = 0, .s = 255, .v = g_config.brightness };
1192 for ( int i=0; i<BACKLIGHT_LED_COUNT; i++ )
1194 uint16_t offset2 = g_key_hit[i]<<2;
1195 #if !defined(RGB_BACKLIGHT_HS60) && !defined(RGB_BACKLIGHT_NK65)
1196 // stabilizer LEDs use spacebar hits
1197 if ( i == 36+6 || i == 54+13 || // LC6, LD13
1198 ( g_config.use_7u_spacebar && i == 54+14 ) ) // LD14
1200 offset2 = g_key_hit[36+0]<<2;
1203 offset2 = (offset2<=63) ? (63-offset2) : 0;
1205 map_led_to_point( i, &point );
1206 // Relies on hue being 8-bit and wrapping
1207 hsv.h = point.y + offset + offset2;
1208 rgb = hsv_to_rgb( hsv );
1209 backlight_set_color( i, rgb.r, rgb.g, rgb.b );
1213 void backlight_effect_jellybean_raindrops( bool initialize )
1218 // Change one LED every tick
1219 uint8_t led_to_change = ( g_tick & 0x000 ) == 0 ? rand() % BACKLIGHT_LED_COUNT : 255;
1221 for ( int i=0; i<BACKLIGHT_LED_COUNT; i++ )
1223 // If initialize, all get set to random colors
1224 // If not, all but one will stay the same as before.
1225 if ( initialize || i == led_to_change )
1227 hsv.h = rand() & 0xFF;
1228 hsv.s = rand() & 0xFF;
1229 // Override brightness with global brightness control
1230 hsv.v = g_config.brightness;;
1232 rgb = hsv_to_rgb( hsv );
1233 backlight_set_color( i, rgb.r, rgb.g, rgb.b );
1238 void backlight_effect_cycle_radial1(void)
1240 uint8_t offset = ( g_tick << g_config.effect_speed ) & 0xFF;
1241 HSV hsv = { .h = 0, .s = 255, .v = g_config.brightness };
1244 for ( int i=0; i<BACKLIGHT_LED_COUNT; i++ )
1246 map_led_to_point_polar( i, &point );
1247 // Relies on hue being 8-bit and wrapping
1248 hsv.h = point.x + offset;
1250 rgb = hsv_to_rgb( hsv );
1251 backlight_set_color( i, rgb.r, rgb.g, rgb.b );
1255 void backlight_effect_cycle_radial2(void)
1257 uint8_t offset = ( g_tick << g_config.effect_speed ) & 0xFF;
1259 HSV hsv = { .h = 0, .s = g_config.color_1.s, .v = g_config.brightness };
1262 for ( int i=0; i<BACKLIGHT_LED_COUNT; i++ )
1264 map_led_to_point_polar( i, &point );
1265 uint8_t offset2 = offset + point.x;
1266 if ( offset2 & 0x80 )
1270 offset2 = offset2 >> 2;
1271 hsv.h = g_config.color_1.h + offset2;
1272 hsv.s = 127 + ( point.y >> 1 );
1273 rgb = hsv_to_rgb( hsv );
1274 backlight_set_color( i, rgb.r, rgb.g, rgb.b );
1278 #if defined(RGB_BACKLIGHT_M6_B)
1279 void backlight_effect_custom_colors(void)
1282 for ( uint8_t i = 0; i < 6; i++ )
1284 HSV hsv = { .h = g_config.custom_color[i].h, .s = g_config.custom_color[i].s, .v = g_config.brightness };
1285 rgb = hsv_to_rgb( hsv );
1287 map_row_column_to_led( 0, i, &led );
1288 backlight_set_color( led, rgb.r, rgb.g, rgb.b );
1293 void backlight_effect_indicators_set_colors( uint8_t index, HS color )
1295 HSV hsv = { .h = color.h, .s = color.s, .v = g_config.brightness };
1296 RGB rgb = hsv_to_rgb( hsv );
1299 backlight_set_color_all( rgb.r, rgb.g, rgb.b );
1303 backlight_set_color( index, rgb.r, rgb.g, rgb.b );
1305 // If the spacebar LED is the indicator,
1306 // do the same for the spacebar stabilizers
1307 if ( index == 36+0 ) // LC0
1309 #if defined(RGB_BACKLIGHT_ZEAL65)
1310 backlight_set_color( 36+7, rgb.r, rgb.g, rgb.b ); // LC7
1311 backlight_set_color( 54+14, rgb.r, rgb.g, rgb.b ); // LD14
1312 #elif defined(RGB_BACKLIGHT_KOYU)
1313 backlight_set_color( 36+6, rgb.r, rgb.g, rgb.b ); // LC6
1314 backlight_set_color( 54+14, rgb.r, rgb.g, rgb.b ); // LD14
1315 #elif defined(RGB_BACKLIGHT_ZEAL60) || defined(RGB_BACKLIGHT_M60_A)
1316 backlight_set_color( 36+6, rgb.r, rgb.g, rgb.b ); // LC6
1317 backlight_set_color( 54+13, rgb.r, rgb.g, rgb.b ); // LD13
1318 if ( g_config.use_7u_spacebar )
1320 backlight_set_color( 54+14, rgb.r, rgb.g, rgb.b ); // LD14
1327 // This runs after another backlight effect and replaces
1328 // colors already set
1329 void backlight_effect_indicators(void)
1331 if ( g_config.caps_lock_indicator.index != 255 &&
1332 ( g_indicator_state & (1<<USB_LED_CAPS_LOCK) ) )
1334 backlight_effect_indicators_set_colors( g_config.caps_lock_indicator.index, g_config.caps_lock_indicator.color );
1337 #if defined(RGB_BACKLIGHT_NK65)
1338 if ( g_indicator_state & (1<<USB_LED_CAPS_LOCK) )
1340 IS31FL3733_set_color( 7+64-1, 0, 255, 0 );
1342 IS31FL3733_set_color( 7+64-1, 0, 0, 0 );
1344 if ( g_indicator_state & (1<<USB_LED_SCROLL_LOCK) )
1346 IS31FL3733_set_color( 6+64-1, 255, 0, 255 );
1348 IS31FL3733_set_color( 6+64-1, 0, 0, 0 );
1350 if ( g_indicator_state & (1<<USB_LED_NUM_LOCK) )
1352 IS31FL3733_set_color( 6+64-1, 0, 255, 0 );
1354 IS31FL3733_set_color( 6+64-1, 0, 0, 0 );
1358 // This if/else if structure allows higher layers to
1359 // override lower ones. If we set layer 3's indicator
1360 // to none, then it will NOT show layer 2 or layer 1
1361 // indicators, even if those layers are on via the
1362 // MO13/MO23 Fn combo magic.
1364 // Basically we want to handle the case where layer 3 is
1365 // still the backlight configuration layer and we don't
1366 // want "all LEDs" indicators hiding the backlight effect,
1367 // but still allow end users to do whatever they want.
1368 if ( IS_LAYER_ON(3) )
1370 if ( g_config.layer_3_indicator.index != 255 )
1372 backlight_effect_indicators_set_colors( g_config.layer_3_indicator.index, g_config.layer_3_indicator.color );
1375 else if ( IS_LAYER_ON(2) )
1377 if ( g_config.layer_2_indicator.index != 255 )
1379 backlight_effect_indicators_set_colors( g_config.layer_2_indicator.index, g_config.layer_2_indicator.color );
1382 else if ( IS_LAYER_ON(1) )
1384 if ( g_config.layer_1_indicator.index != 255 )
1386 backlight_effect_indicators_set_colors( g_config.layer_1_indicator.index, g_config.layer_1_indicator.color );
1391 #if !defined(RGB_BACKLIGHT_HS60) && !defined(RGB_BACKLIGHT_NK65)
1392 ISR(TIMER3_COMPA_vect)
1393 #else //STM32 interrupt
1394 static void gpt_backlight_timer_task(GPTDriver *gptp)
1397 // delay 1 second before driving LEDs or doing anything else
1398 static uint8_t startup_tick = 0;
1399 if ( startup_tick < 20 )
1407 if ( g_any_key_hit < 0xFFFFFFFF )
1412 for ( int led = 0; led < BACKLIGHT_LED_COUNT; led++ )
1414 if ( g_key_hit[led] < 255 )
1420 // Factory default magic value
1421 if ( g_config.effect == 255 )
1423 backlight_effect_rgb_test();
1427 // Ideally we would also stop sending zeros to the LED driver PWM buffers
1428 // while suspended and just do a software shutdown. This is a cheap hack for now.
1429 bool suspend_backlight = ((g_suspend_state && g_config.disable_when_usb_suspended) ||
1430 (g_config.disable_after_timeout > 0 && g_any_key_hit > g_config.disable_after_timeout * 60 * 20));
1431 uint8_t effect = suspend_backlight ? 0 : g_config.effect;
1433 // Keep track of the effect used last time,
1434 // detect change in effect, so each effect can
1435 // have an optional initialization.
1436 static uint8_t effect_last = 255;
1437 bool initialize = effect != effect_last;
1438 effect_last = effect;
1440 // this gets ticked at 20 Hz.
1441 // each effect can opt to do calculations
1442 // and/or request PWM buffer updates.
1446 backlight_effect_all_off();
1449 backlight_effect_solid_color();
1452 #if defined(RGB_BACKLIGHT_M6_B)
1453 backlight_effect_custom_colors();
1455 backlight_effect_alphas_mods();
1459 backlight_effect_gradient_up_down();
1462 backlight_effect_raindrops( initialize );
1465 backlight_effect_cycle_all();
1468 backlight_effect_cycle_left_right();
1471 backlight_effect_cycle_up_down();
1474 backlight_effect_jellybean_raindrops( initialize );
1477 backlight_effect_cycle_radial1();
1480 backlight_effect_cycle_radial2();
1483 backlight_effect_all_off();
1487 if ( ! suspend_backlight )
1489 #if !defined(RGB_BACKLIGHT_M6_B)
1490 backlight_effect_indicators();
1495 void backlight_set_indicator_index( uint8_t *index, uint8_t row, uint8_t column )
1497 if ( row >= MATRIX_ROWS )
1499 // Special value, 255=none, 254=all
1504 map_row_column_to_led( row, column, index );
1508 void backlight_get_indicator_row_col( uint8_t index, uint8_t *row, uint8_t *column )
1510 if ( index == 255 || index == 254 )
1512 // Special value, 255=none, 254=all
1517 for ( uint8_t r = 0; r < MATRIX_ROWS; r++ )
1519 for ( uint8_t c = 0; c < MATRIX_COLS; c++ )
1522 map_row_column_to_led( r, c, &i );
1533 // Some helpers for setting/getting HSV
1534 void _set_color( HS *color, uint8_t *data )
1540 void _get_color( HS *color, uint8_t *data )
1546 void backlight_config_set_value( uint8_t *data )
1548 bool reinitialize = false;
1549 uint8_t *value_id = &(data[0]);
1550 uint8_t *value_data = &(data[1]);
1551 switch ( *value_id )
1553 #if defined (RGB_BACKLIGHT_ZEAL60) || defined(RGB_BACKLIGHT_ZEAL65)
1554 case id_use_split_backspace:
1556 g_config.use_split_backspace = (bool)*value_data;
1557 reinitialize = true;
1561 #if defined (RGB_BACKLIGHT_ZEAL60)
1562 case id_use_split_left_shift:
1564 g_config.use_split_left_shift = (bool)*value_data;
1565 reinitialize = true;
1568 case id_use_split_right_shift:
1570 g_config.use_split_right_shift = (bool)*value_data;
1571 reinitialize = true;
1574 case id_use_7u_spacebar:
1576 g_config.use_7u_spacebar = (bool)*value_data;
1577 reinitialize = true;
1580 case id_use_iso_enter:
1582 g_config.use_iso_enter = (bool)*value_data;
1583 reinitialize = true;
1586 case id_disable_hhkb_blocker_leds:
1588 g_config.disable_hhkb_blocker_leds = (bool)*value_data;
1589 reinitialize = true;
1593 case id_disable_when_usb_suspended:
1595 g_config.disable_when_usb_suspended = (bool)*value_data;
1598 case id_disable_after_timeout:
1600 g_config.disable_after_timeout = *value_data;
1605 g_config.brightness = *value_data;
1610 g_config.effect = *value_data;
1613 case id_effect_speed:
1615 g_config.effect_speed = *value_data;
1620 _set_color( &(g_config.color_1), value_data );
1625 _set_color( &(g_config.color_2), value_data );
1628 case id_caps_lock_indicator_color:
1630 _set_color( &(g_config.caps_lock_indicator.color), value_data );
1633 case id_caps_lock_indicator_row_col:
1635 backlight_set_indicator_index( &(g_config.caps_lock_indicator.index), value_data[0], value_data[1] );
1638 case id_layer_1_indicator_color:
1640 _set_color( &(g_config.layer_1_indicator.color), value_data );
1643 case id_layer_1_indicator_row_col:
1645 backlight_set_indicator_index( &(g_config.layer_1_indicator.index), value_data[0], value_data[1] );
1648 case id_layer_2_indicator_color:
1650 _set_color( &(g_config.layer_2_indicator.color), value_data );
1653 case id_layer_2_indicator_row_col:
1655 backlight_set_indicator_index( &(g_config.layer_2_indicator.index), value_data[0], value_data[1] );
1658 case id_layer_3_indicator_color:
1660 _set_color( &(g_config.layer_3_indicator.color), value_data );
1663 case id_layer_3_indicator_row_col:
1665 backlight_set_indicator_index( &(g_config.layer_3_indicator.index), value_data[0], value_data[1] );
1668 case id_alphas_mods:
1670 for ( int i=0; i<5; i++ )
1672 g_config.alphas_mods[i] = ( *(value_data+i*2) << 8 ) | ( *(value_data+i*2+1) );
1675 #if defined(RGB_BACKLIGHT_M6_B)
1676 case id_custom_color:
1678 uint8_t index = value_data[0];
1679 if ( index >= 0 && index <= 6 )
1681 _set_color( &(g_config.custom_color[index]), &(value_data[1]) );
1689 backlight_init_drivers();
1693 void backlight_config_get_value( uint8_t *data )
1695 uint8_t *value_id = &(data[0]);
1696 uint8_t *value_data = &(data[1]);
1697 switch ( *value_id )
1699 case id_use_split_backspace:
1701 *value_data = ( g_config.use_split_backspace ? 1 : 0 );
1704 case id_use_split_left_shift:
1706 *value_data = ( g_config.use_split_left_shift ? 1 : 0 );
1709 case id_use_split_right_shift:
1711 *value_data = ( g_config.use_split_right_shift ? 1 : 0 );
1714 case id_use_7u_spacebar:
1716 *value_data = ( g_config.use_7u_spacebar ? 1 : 0 );
1719 case id_use_iso_enter:
1721 *value_data = ( g_config.use_iso_enter ? 1 : 0 );
1724 case id_disable_when_usb_suspended:
1726 *value_data = ( g_config.disable_when_usb_suspended ? 1 : 0 );
1729 case id_disable_hhkb_blocker_leds:
1731 *value_data = ( g_config.disable_hhkb_blocker_leds ? 1 : 0 );
1734 case id_disable_after_timeout:
1736 *value_data = g_config.disable_after_timeout;
1741 *value_data = g_config.brightness;
1746 *value_data = g_config.effect;
1749 case id_effect_speed:
1751 *value_data = g_config.effect_speed;
1756 _get_color( &(g_config.color_1), value_data );
1761 _get_color( &(g_config.color_2), value_data );
1764 case id_caps_lock_indicator_color:
1766 _get_color( &(g_config.caps_lock_indicator.color), value_data );
1769 case id_caps_lock_indicator_row_col:
1771 backlight_get_indicator_row_col( g_config.caps_lock_indicator.index, &(value_data[0]), &(value_data[1]) );
1774 case id_layer_1_indicator_color:
1776 _get_color( &(g_config.layer_1_indicator.color), value_data );
1779 case id_layer_1_indicator_row_col:
1781 backlight_get_indicator_row_col( g_config.layer_1_indicator.index, &(value_data[0]), &(value_data[1]) );
1784 case id_layer_2_indicator_color:
1786 _get_color( &(g_config.layer_2_indicator.color), value_data );
1789 case id_layer_2_indicator_row_col:
1791 backlight_get_indicator_row_col( g_config.layer_2_indicator.index, &(value_data[0]), &(value_data[1]) );
1794 case id_layer_3_indicator_color:
1796 _get_color( &(g_config.layer_3_indicator.color), value_data );
1799 case id_layer_3_indicator_row_col:
1801 backlight_get_indicator_row_col( g_config.layer_3_indicator.index, &(value_data[0]), &(value_data[1]) );
1804 case id_alphas_mods:
1806 for ( int i=0; i<5; i++ )
1808 *(value_data+i*2) = g_config.alphas_mods[i] >> 8;
1809 *(value_data+i*2+1) = g_config.alphas_mods[i] & 0xFF;
1812 #if defined(RGB_BACKLIGHT_M6_B)
1813 case id_custom_color:
1815 uint8_t index = value_data[0];
1816 if ( index >= 0 && index <= 6 )
1818 _get_color( &(g_config.custom_color[index]), &(value_data[1]) );
1825 void backlight_config_set_alphas_mods( uint16_t *alphas_mods )
1827 for ( int i=0; i<5; i++ )
1829 g_config.alphas_mods[i] = alphas_mods[i];
1832 backlight_config_save();
1835 void backlight_config_load(void)
1837 eeprom_read_block( &g_config, ((void*)RGB_BACKLIGHT_CONFIG_EEPROM_ADDR), sizeof(backlight_config) );
1840 void backlight_config_save(void)
1842 eeprom_update_block( &g_config, ((void*)RGB_BACKLIGHT_CONFIG_EEPROM_ADDR), sizeof(backlight_config) );
1845 void backlight_init_drivers(void)
1850 #if defined(RGB_BACKLIGHT_M6_B)
1852 #elif defined(RGB_BACKLIGHT_HS60)
1853 IS31FL3733_init( ISSI_ADDR_1, 0 );
1855 for ( int index = 0; index < DRIVER_LED_TOTAL; index++ )
1857 #if defined(HS60_ANSI)
1858 bool enabled = !( ( index == 48-1 ) || //LA48
1859 ( index == 51-1 ) || //LA51
1860 ( index == 61-1 ) ); //LA61
1861 #elif defined(HS60_HHKB)
1862 bool enabled = !( ( index == 61-1 ) || //LA61
1863 ( index == 62-1 ) ); //LA62
1865 bool enabled = !( ( index == 51-1 ) || //LA51
1866 ( index == 61-1 ) ); //LA61
1868 // This only caches it for later
1869 IS31FL3733_set_led_control_register( index, enabled, enabled, enabled );
1871 // This actually updates the LED drivers
1872 IS31FL3733_update_led_control_registers( ISSI_ADDR_1, 0 );
1873 #elif defined(RGB_BACKLIGHT_NK65)
1874 IS31FL3733_init( ISSI_ADDR_1, 0 );
1875 IS31FL3733_init( ISSI_ADDR_2, 0 );
1877 for ( int index = 0; index < DRIVER_LED_TOTAL; index++ )
1879 bool enabled = !( ( index == 61-1 ) || //LA61
1880 ( index > 6+64-1 ) ); //LB7-LB64
1881 // This only caches it for later
1882 IS31FL3733_set_led_control_register( index, enabled, enabled, enabled );
1884 IS31FL3733_set_led_control_register( 7+64-1, 0, 1, 0 ); //Enable LB7 green enable for indicators
1885 // This actually updates the LED drivers
1886 IS31FL3733_update_led_control_registers( ISSI_ADDR_1, 0 );
1887 IS31FL3733_update_led_control_registers( ISSI_ADDR_2, 1 );
1889 IS31FL3731_init( ISSI_ADDR_1 );
1890 IS31FL3731_init( ISSI_ADDR_2 );
1892 for ( int index = 0; index < DRIVER_LED_TOTAL; index++ )
1894 // OR the possible "disabled" cases together, then NOT the result to get the enabled state
1895 // LC6 LD13 not present on Zeal65
1896 #if defined(RGB_BACKLIGHT_ZEAL65)
1897 bool enabled = !( ( index == 18+5 && !g_config.use_split_backspace ) || // LB5
1898 ( index == 36+6 ) || // LC6
1899 ( index == 54+13 ) ); // LD13
1900 #elif defined(RGB_BACKLIGHT_KOYU)
1901 bool enabled = !( ( index == 36+15 ) || // LC15
1902 ( index == 54+13 ) || // LD13
1903 ( index == 54+17 ) ); // LD17
1904 #elif defined(RGB_BACKLIGHT_M60_A)
1906 // LB6 LB7 LB8 LB15 LB16 LB17 not present on M60-A
1907 ( index == 18+6 ) || // LB6
1908 ( index == 18+7 ) || // LB7
1909 ( index == 18+8 ) || // LB8
1910 ( index == 18+15 ) || // LB15
1911 ( index == 18+16 ) || // LB16
1912 ( index == 18+17 ) || // LB17
1913 // HHKB blockers (LC17, LD17) and ISO extra keys (LC15,LD13) not present on M60-A
1914 ( index == 36+17 ) || // LC17
1915 ( index == 54+17 ) || // LD17
1916 ( index == 36+15 ) || // LC15
1917 ( index == 54+13 ) ); // LD13
1918 #elif defined(RGB_BACKLIGHT_ZEAL60)
1919 // LB6 LB7 LB8 LB15 LB16 LB17 not present on Zeal60
1920 bool enabled = !( ( index == 18+5 && !g_config.use_split_backspace ) || // LB5
1921 ( index == 36+15 && !g_config.use_split_left_shift ) || // LC15
1922 ( index == 54+8 && !g_config.use_split_right_shift ) || // LD8
1923 ( index == 54+13 && g_config.use_7u_spacebar ) || // LD13
1924 ( index == 36+17 && g_config.disable_hhkb_blocker_leds ) || // LC17
1925 ( index == 54+17 && g_config.disable_hhkb_blocker_leds ) || // LD17
1926 ( index == 18+6 ) || // LB6
1927 ( index == 18+7 ) || // LB7
1928 ( index == 18+8 ) || // LB8
1929 ( index == 18+15 ) || // LB15
1930 ( index == 18+16 ) || // LB16
1931 ( index == 18+17 ) ); // LB17
1933 // This only caches it for later
1934 IS31FL3731_set_led_control_register( index, enabled, enabled, enabled );
1936 // This actually updates the LED drivers
1937 IS31FL3731_update_led_control_registers( ISSI_ADDR_1, ISSI_ADDR_2 );
1938 #endif // !defined(RGB_BACKLIGHT_M6_B)
1940 // TODO: put the 1 second startup delay here?
1942 // clear the key hits
1943 for ( int led=0; led<BACKLIGHT_LED_COUNT; led++ )
1945 g_key_hit[led] = 255;
1949 bool process_record_backlight(uint16_t keycode, keyrecord_t *record)
1951 // Record keypresses for backlight effects
1952 if ( record->event.pressed )
1954 backlight_set_key_hit( record->event.key.row, record->event.key.col );
1960 if (record->event.pressed)
1962 backlight_brightness_increase();
1967 if (record->event.pressed)
1969 backlight_brightness_decrease();
1974 if (record->event.pressed)
1976 backlight_effect_increase();
1981 if (record->event.pressed)
1983 backlight_effect_decrease();
1988 if (record->event.pressed)
1990 backlight_effect_speed_increase();
1995 if (record->event.pressed)
1997 backlight_effect_speed_decrease();
2002 if (record->event.pressed)
2004 backlight_color_1_hue_increase();
2009 if (record->event.pressed)
2011 backlight_color_1_hue_decrease();
2016 if (record->event.pressed)
2018 backlight_color_1_sat_increase();
2023 if (record->event.pressed)
2025 backlight_color_1_sat_decrease();
2031 if (record->event.pressed)
2033 backlight_color_2_hue_increase();
2038 if (record->event.pressed)
2040 backlight_color_2_hue_decrease();
2045 if (record->event.pressed)
2047 backlight_color_2_sat_increase();
2052 if (record->event.pressed)
2054 backlight_color_2_sat_decrease();
2064 // Deals with the messy details of incrementing an integer
2065 uint8_t increment( uint8_t value, uint8_t step, uint8_t min, uint8_t max )
2067 int16_t new_value = value;
2069 return MIN( MAX( new_value, min ), max );
2072 uint8_t decrement( uint8_t value, uint8_t step, uint8_t min, uint8_t max )
2074 int16_t new_value = value;
2076 return MIN( MAX( new_value, min ), max );
2079 void backlight_effect_increase(void)
2081 g_config.effect = increment( g_config.effect, 1, 0, BACKLIGHT_EFFECT_MAX );
2082 backlight_config_save();
2085 void backlight_effect_decrease(void)
2087 g_config.effect = decrement( g_config.effect, 1, 0, BACKLIGHT_EFFECT_MAX );
2088 backlight_config_save();
2091 void backlight_effect_speed_increase(void)
2093 g_config.effect_speed = increment( g_config.effect_speed, 1, 0, 3 );
2094 backlight_config_save();
2097 void backlight_effect_speed_decrease(void)
2099 g_config.effect_speed = decrement( g_config.effect_speed, 1, 0, 3 );
2100 backlight_config_save();
2103 void backlight_brightness_increase(void)
2105 g_config.brightness = increment( g_config.brightness, 8, 0, 255 );
2106 backlight_config_save();
2109 void backlight_brightness_decrease(void)
2111 g_config.brightness = decrement( g_config.brightness, 8, 0, 255 );
2112 backlight_config_save();
2115 void backlight_color_1_hue_increase(void)
2117 g_config.color_1.h = increment( g_config.color_1.h, 8, 0, 255 );
2118 backlight_config_save();
2121 void backlight_color_1_hue_decrease(void)
2123 g_config.color_1.h = decrement( g_config.color_1.h, 8, 0, 255 );
2124 backlight_config_save();
2127 void backlight_color_1_sat_increase(void)
2129 g_config.color_1.s = increment( g_config.color_1.s, 8, 0, 255 );
2130 backlight_config_save();
2133 void backlight_color_1_sat_decrease(void)
2135 g_config.color_1.s = decrement( g_config.color_1.s, 8, 0, 255 );
2136 backlight_config_save();
2139 void backlight_color_2_hue_increase(void)
2141 g_config.color_2.h = increment( g_config.color_2.h, 8, 0, 255 );
2142 backlight_config_save();
2145 void backlight_color_2_hue_decrease(void)
2147 g_config.color_2.h = decrement( g_config.color_2.h, 8, 0, 255 );
2148 backlight_config_save();
2151 void backlight_color_2_sat_increase(void)
2153 g_config.color_2.s = increment( g_config.color_2.s, 8, 0, 255 );
2154 backlight_config_save();
2157 void backlight_color_2_sat_decrease(void)
2159 g_config.color_2.s = decrement( g_config.color_2.s, 8, 0, 255 );
2160 backlight_config_save();
2163 #if defined(RGB_DEBUGGING_ONLY)
2164 void backlight_test_led( uint8_t index, bool red, bool green, bool blue )
2166 for ( int i=0; i<BACKLIGHT_LED_COUNT; i++ )
2170 IS31FL3731_set_led_control_register( i, red, green, blue );
2174 IS31FL3731_set_led_control_register( i, false, false, false );
2179 void backlight_debug_led( bool state )
2194 #endif // defined(RGB_DEBUGGING_ONLY)
2196 #endif // BACKLIGHT_ENABLED