]> git.donarmstrong.com Git - qmk_firmware.git/blob - quantum/rgblight.c
Apply the dim curve to the RGB output
[qmk_firmware.git] / quantum / rgblight.c
1 #include <avr/eeprom.h>
2 #include <avr/interrupt.h>
3 #include <util/delay.h>
4 #include "progmem.h"
5 #include "timer.h"
6 #include "rgblight.h"
7 #include "debug.h"
8
9 const uint8_t DIM_CURVE[] PROGMEM = {
10   0, 1, 1, 2, 2, 2, 2, 2, 2, 3, 3, 3, 3, 3, 3, 3,
11   3, 3, 3, 3, 3, 3, 3, 4, 4, 4, 4, 4, 4, 4, 4, 4,
12   4, 4, 4, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 6, 6, 6,
13   6, 6, 6, 6, 6, 7, 7, 7, 7, 7, 7, 7, 8, 8, 8, 8,
14   8, 8, 9, 9, 9, 9, 9, 9, 10, 10, 10, 10, 10, 11, 11, 11,
15   11, 11, 12, 12, 12, 12, 12, 13, 13, 13, 13, 14, 14, 14, 14, 15,
16   15, 15, 16, 16, 16, 16, 17, 17, 17, 18, 18, 18, 19, 19, 19, 20,
17   20, 20, 21, 21, 22, 22, 22, 23, 23, 24, 24, 25, 25, 25, 26, 26,
18   27, 27, 28, 28, 29, 29, 30, 30, 31, 32, 32, 33, 33, 34, 35, 35,
19   36, 36, 37, 38, 38, 39, 40, 40, 41, 42, 43, 43, 44, 45, 46, 47,
20   48, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62,
21   63, 64, 65, 66, 68, 69, 70, 71, 73, 74, 75, 76, 78, 79, 81, 82,
22   83, 85, 86, 88, 90, 91, 93, 94, 96, 98, 99, 101, 103, 105, 107, 109,
23   110, 112, 114, 116, 118, 121, 123, 125, 127, 129, 132, 134, 136, 139, 141, 144,
24   146, 149, 151, 154, 157, 159, 162, 165, 168, 171, 174, 177, 180, 183, 186, 190,
25   193, 196, 200, 203, 207, 211, 214, 218, 222, 226, 230, 234, 238, 242, 248, 255
26 };
27 const uint8_t RGBLED_BREATHING_TABLE[] PROGMEM = {
28   0, 0, 0, 0, 1, 1, 1, 2, 2, 3, 4, 5, 5, 6, 7, 9,
29   10, 11, 12, 14, 15, 17, 18, 20, 21, 23, 25, 27, 29, 31, 33, 35,
30   37, 40, 42, 44, 47, 49, 52, 54, 57, 59, 62, 65, 67, 70, 73, 76,
31   79, 82, 85, 88, 90, 93, 97, 100, 103, 106, 109, 112, 115, 118, 121, 124,
32   127, 131, 134, 137, 140, 143, 146, 149, 152, 155, 158, 162, 165, 167, 170, 173,
33   176, 179, 182, 185, 188, 190, 193, 196, 198, 201, 203, 206, 208, 211, 213, 215,
34   218, 220, 222, 224, 226, 228, 230, 232, 234, 235, 237, 238, 240, 241, 243, 244,
35   245, 246, 248, 249, 250, 250, 251, 252, 253, 253, 254, 254, 254, 255, 255, 255,
36   255, 255, 255, 255, 254, 254, 254, 253, 253, 252, 251, 250, 250, 249, 248, 246,
37   245, 244, 243, 241, 240, 238, 237, 235, 234, 232, 230, 228, 226, 224, 222, 220,
38   218, 215, 213, 211, 208, 206, 203, 201, 198, 196, 193, 190, 188, 185, 182, 179,
39   176, 173, 170, 167, 165, 162, 158, 155, 152, 149, 146, 143, 140, 137, 134, 131,
40   128, 124, 121, 118, 115, 112, 109, 106, 103, 100, 97, 93, 90, 88, 85, 82,
41   79, 76, 73, 70, 67, 65, 62, 59, 57, 54, 52, 49, 47, 44, 42, 40,
42   37, 35, 33, 31, 29, 27, 25, 23, 21, 20, 18, 17, 15, 14, 12, 11,
43   10, 9, 7, 6, 5, 5, 4, 3, 2, 2, 1, 1, 1, 0, 0, 0
44 };
45 const uint8_t RGBLED_BREATHING_INTERVALS[] PROGMEM = {30, 20, 10, 5};
46 const uint8_t RGBLED_RAINBOW_MOOD_INTERVALS[] PROGMEM = {120, 60, 30};
47 const uint8_t RGBLED_RAINBOW_SWIRL_INTERVALS[] PROGMEM = {100, 50, 20};
48 const uint8_t RGBLED_SNAKE_INTERVALS[] PROGMEM = {100, 50, 20};
49 const uint8_t RGBLED_KNIGHT_INTERVALS[] PROGMEM = {100, 50, 20};
50
51 rgblight_config_t rgblight_config;
52 rgblight_config_t inmem_config;
53 struct cRGB led[RGBLED_NUM];
54 uint8_t rgblight_inited = 0;
55
56
57 void sethsv(uint16_t hue, uint8_t sat, uint8_t val, struct cRGB *led1) {
58   uint8_t r = 0, g = 0, b = 0, base, color;
59
60   if (sat == 0) { // Acromatic color (gray). Hue doesn't mind.
61     r = val;
62     g = val;
63     b = val;
64   } else {
65     base = ((255 - sat) * val) >> 8;
66     color = (val - base) * (hue % 60) / 60;
67
68     switch (hue / 60) {
69       case 0:
70         r = val;
71         g = base + color;
72         b = base;
73         break;
74       case 1:
75         r = val - color;
76         g = val;
77         b = base;
78         break;
79       case 2:
80         r = base;
81         g = val;
82         b = base + color;
83         break;
84       case 3:
85         r = base;
86         g = val - color;
87         b = val;
88         break;
89       case 4:
90         r = base + color;
91         g = base;
92         b = val;
93         break;
94       case 5:
95         r = val;
96         g = base;
97         b = val - color;
98         break;
99     }
100   }
101   r = pgm_read_byte(&DIM_CURVE[r]);
102   g = pgm_read_byte(&DIM_CURVE[g]);
103   b = pgm_read_byte(&DIM_CURVE[b]);
104
105   setrgb(r, g, b, led1);
106 }
107
108 void setrgb(uint8_t r, uint8_t g, uint8_t b, struct cRGB *led1) {
109   (*led1).r = r;
110   (*led1).g = g;
111   (*led1).b = b;
112 }
113
114
115 uint32_t eeconfig_read_rgblight(void) {
116   return eeprom_read_dword(EECONFIG_RGBLIGHT);
117 }
118 void eeconfig_update_rgblight(uint32_t val) {
119   eeprom_update_dword(EECONFIG_RGBLIGHT, val);
120 }
121 void eeconfig_update_rgblight_default(void) {
122   dprintf("eeconfig_update_rgblight_default\n");
123   rgblight_config.enable = 1;
124   rgblight_config.mode = 1;
125   rgblight_config.hue = 200;
126   rgblight_config.sat = 204;
127   rgblight_config.val = 204;
128   eeconfig_update_rgblight(rgblight_config.raw);
129 }
130 void eeconfig_debug_rgblight(void) {
131   dprintf("rgblight_config eprom\n");
132   dprintf("rgblight_config.enable = %d\n", rgblight_config.enable);
133   dprintf("rghlight_config.mode = %d\n", rgblight_config.mode);
134   dprintf("rgblight_config.hue = %d\n", rgblight_config.hue);
135   dprintf("rgblight_config.sat = %d\n", rgblight_config.sat);
136   dprintf("rgblight_config.val = %d\n", rgblight_config.val);
137 }
138
139 void rgblight_init(void) {
140   debug_enable = 1; // Debug ON!
141   dprintf("rgblight_init called.\n");
142   rgblight_inited = 1;
143   dprintf("rgblight_init start!\n");
144   if (!eeconfig_is_enabled()) {
145     dprintf("rgblight_init eeconfig is not enabled.\n");
146     eeconfig_init();
147     eeconfig_update_rgblight_default();
148   }
149   rgblight_config.raw = eeconfig_read_rgblight();
150   if (!rgblight_config.mode) {
151     dprintf("rgblight_init rgblight_config.mode = 0. Write default values to EEPROM.\n");
152     eeconfig_update_rgblight_default();
153     rgblight_config.raw = eeconfig_read_rgblight();
154   }
155   eeconfig_debug_rgblight(); // display current eeprom values
156
157   #if !defined(AUDIO_ENABLE) && defined(RGBLIGHT_TIMER)
158     rgblight_timer_init(); // setup the timer
159   #endif
160
161   if (rgblight_config.enable) {
162     rgblight_mode(rgblight_config.mode);
163   }
164 }
165
166 void rgblight_increase(void) {
167   uint8_t mode = 0;
168   if (rgblight_config.mode < RGBLIGHT_MODES) {
169     mode = rgblight_config.mode + 1;
170   }
171   rgblight_mode(mode);
172 }
173 void rgblight_decrease(void) {
174   uint8_t mode = 0;
175   // Mode will never be < 1. If it ever is, eeprom needs to be initialized.
176   if (rgblight_config.mode > 1) {
177     mode = rgblight_config.mode - 1;
178   }
179   rgblight_mode(mode);
180 }
181 void rgblight_step(void) {
182   uint8_t mode = 0;
183   mode = rgblight_config.mode + 1;
184   if (mode > RGBLIGHT_MODES) {
185     mode = 1;
186   }
187   rgblight_mode(mode);
188 }
189
190 void rgblight_mode(uint8_t mode) {
191   if (!rgblight_config.enable) {
192     return;
193   }
194   if (mode < 1) {
195     rgblight_config.mode = 1;
196   } else if (mode > RGBLIGHT_MODES) {
197     rgblight_config.mode = RGBLIGHT_MODES;
198   } else {
199     rgblight_config.mode = mode;
200   }
201   eeconfig_update_rgblight(rgblight_config.raw);
202   xprintf("rgblight mode: %u\n", rgblight_config.mode);
203   if (rgblight_config.mode == 1) {
204     #if !defined(AUDIO_ENABLE) && defined(RGBLIGHT_TIMER)
205       rgblight_timer_disable();
206     #endif
207   } else if (rgblight_config.mode >= 2 && rgblight_config.mode <= 23) {
208     // MODE 2-5, breathing
209     // MODE 6-8, rainbow mood
210     // MODE 9-14, rainbow swirl
211     // MODE 15-20, snake
212     // MODE 21-23, knight
213
214     #if !defined(AUDIO_ENABLE) && defined(RGBLIGHT_TIMER)
215       rgblight_timer_enable();
216     #endif
217   }
218   rgblight_sethsv(rgblight_config.hue, rgblight_config.sat, rgblight_config.val);
219 }
220
221 void rgblight_toggle(void) {
222   rgblight_config.enable ^= 1;
223   eeconfig_update_rgblight(rgblight_config.raw);
224   xprintf("rgblight toggle: rgblight_config.enable = %u\n", rgblight_config.enable);
225   if (rgblight_config.enable) {
226     rgblight_mode(rgblight_config.mode);
227   } else {
228     #if !defined(AUDIO_ENABLE) && defined(RGBLIGHT_TIMER)
229       rgblight_timer_disable();
230     #endif
231     _delay_ms(50);
232     rgblight_set();
233   }
234 }
235
236
237 void rgblight_increase_hue(void) {
238   uint16_t hue;
239   hue = (rgblight_config.hue+RGBLIGHT_HUE_STEP) % 360;
240   rgblight_sethsv(hue, rgblight_config.sat, rgblight_config.val);
241 }
242 void rgblight_decrease_hue(void) {
243   uint16_t hue;
244   if (rgblight_config.hue-RGBLIGHT_HUE_STEP < 0) {
245     hue = (rgblight_config.hue + 360 - RGBLIGHT_HUE_STEP) % 360;
246   } else {
247     hue = (rgblight_config.hue - RGBLIGHT_HUE_STEP) % 360;
248   }
249   rgblight_sethsv(hue, rgblight_config.sat, rgblight_config.val);
250 }
251 void rgblight_increase_sat(void) {
252   uint8_t sat;
253   if (rgblight_config.sat + RGBLIGHT_SAT_STEP > 255) {
254     sat = 255;
255   } else {
256     sat = rgblight_config.sat + RGBLIGHT_SAT_STEP;
257   }
258   rgblight_sethsv(rgblight_config.hue, sat, rgblight_config.val);
259 }
260 void rgblight_decrease_sat(void) {
261   uint8_t sat;
262   if (rgblight_config.sat - RGBLIGHT_SAT_STEP < 0) {
263     sat = 0;
264   } else {
265     sat = rgblight_config.sat - RGBLIGHT_SAT_STEP;
266   }
267   rgblight_sethsv(rgblight_config.hue, sat, rgblight_config.val);
268 }
269 void rgblight_increase_val(void) {
270   uint8_t val;
271   if (rgblight_config.val + RGBLIGHT_VAL_STEP > 255) {
272     val = 255;
273   } else {
274     val = rgblight_config.val + RGBLIGHT_VAL_STEP;
275   }
276   rgblight_sethsv(rgblight_config.hue, rgblight_config.sat, val);
277 }
278 void rgblight_decrease_val(void) {
279   uint8_t val;
280   if (rgblight_config.val - RGBLIGHT_VAL_STEP < 0) {
281     val = 0;
282   } else {
283     val = rgblight_config.val - RGBLIGHT_VAL_STEP;
284   }
285   rgblight_sethsv(rgblight_config.hue, rgblight_config.sat, val);
286 }
287
288 void rgblight_sethsv_noeeprom(uint16_t hue, uint8_t sat, uint8_t val) {
289   inmem_config.raw = rgblight_config.raw;
290   if (rgblight_config.enable) {
291     struct cRGB tmp_led;
292     sethsv(hue, sat, val, &tmp_led);
293     inmem_config.hue = hue;
294     inmem_config.sat = sat;
295     inmem_config.val = val;
296     // dprintf("rgblight set hue [MEMORY]: %u,%u,%u\n", inmem_config.hue, inmem_config.sat, inmem_config.val);
297     rgblight_setrgb(tmp_led.r, tmp_led.g, tmp_led.b);
298   }
299 }
300 void rgblight_sethsv(uint16_t hue, uint8_t sat, uint8_t val) {
301   if (rgblight_config.enable) {
302     if (rgblight_config.mode == 1) {
303       // same static color
304       rgblight_sethsv_noeeprom(hue, sat, val);
305     } else {
306       // all LEDs in same color
307       if (rgblight_config.mode >= 2 && rgblight_config.mode <= 5) {
308         // breathing mode, ignore the change of val, use in memory value instead
309         val = rgblight_config.val;
310       } else if (rgblight_config.mode >= 6 && rgblight_config.mode <= 14) {
311         // rainbow mood and rainbow swirl, ignore the change of hue
312         hue = rgblight_config.hue;
313       }
314     }
315     rgblight_config.hue = hue;
316     rgblight_config.sat = sat;
317     rgblight_config.val = val;
318     eeconfig_update_rgblight(rgblight_config.raw);
319     xprintf("rgblight set hsv [EEPROM]: %u,%u,%u\n", rgblight_config.hue, rgblight_config.sat, rgblight_config.val);
320   }
321 }
322
323 void rgblight_setrgb(uint8_t r, uint8_t g, uint8_t b) {
324   // dprintf("rgblight set rgb: %u,%u,%u\n", r,g,b);
325   for (uint8_t i = 0; i < RGBLED_NUM; i++) {
326     led[i].r = r;
327     led[i].g = g;
328     led[i].b = b;
329   }
330   rgblight_set();
331 }
332
333 void rgblight_set(void) {
334   if (rgblight_config.enable) {
335     ws2812_setleds(led, RGBLED_NUM);
336   } else {
337     for (uint8_t i = 0; i < RGBLED_NUM; i++) {
338       led[i].r = 0;
339       led[i].g = 0;
340       led[i].b = 0;
341     }
342     ws2812_setleds(led, RGBLED_NUM);
343   }
344 }
345
346 #if !defined(AUDIO_ENABLE) && defined(RGBLIGHT_TIMER)
347
348 // Animation timer -- AVR Timer3
349 void rgblight_timer_init(void) {
350   static uint8_t rgblight_timer_is_init = 0;
351   if (rgblight_timer_is_init) {
352     return;
353   }
354   rgblight_timer_is_init = 1;
355   /* Timer 3 setup */
356   TCCR3B = _BV(WGM32) //CTC mode OCR3A as TOP
357         | _BV(CS30); //Clock selelct: clk/1
358   /* Set TOP value */
359   uint8_t sreg = SREG;
360   cli();
361   OCR3AH = (RGBLED_TIMER_TOP >> 8) & 0xff;
362   OCR3AL = RGBLED_TIMER_TOP & 0xff;
363   SREG = sreg;
364 }
365 void rgblight_timer_enable(void) {
366   TIMSK3 |= _BV(OCIE3A);
367   dprintf("TIMER3 enabled.\n");
368 }
369 void rgblight_timer_disable(void) {
370   TIMSK3 &= ~_BV(OCIE3A);
371   dprintf("TIMER3 disabled.\n");
372 }
373 void rgblight_timer_toggle(void) {
374   TIMSK3 ^= _BV(OCIE3A);
375   dprintf("TIMER3 toggled.\n");
376 }
377
378 ISR(TIMER3_COMPA_vect) {
379   // mode = 1, static light, do nothing here
380   if (rgblight_config.mode >= 2 && rgblight_config.mode <= 5) {
381     // mode = 2 to 5, breathing mode
382     rgblight_effect_breathing(rgblight_config.mode - 2);
383   } else if (rgblight_config.mode >= 6 && rgblight_config.mode <= 8) {
384     // mode = 6 to 8, rainbow mood mod
385     rgblight_effect_rainbow_mood(rgblight_config.mode - 6);
386   } else if (rgblight_config.mode >= 9 && rgblight_config.mode <= 14) {
387     // mode = 9 to 14, rainbow swirl mode
388     rgblight_effect_rainbow_swirl(rgblight_config.mode - 9);
389   } else if (rgblight_config.mode >= 15 && rgblight_config.mode <= 20) {
390     // mode = 15 to 20, snake mode
391     rgblight_effect_snake(rgblight_config.mode - 15);
392   } else if (rgblight_config.mode >= 21 && rgblight_config.mode <= 23) {
393     // mode = 21 to 23, knight mode
394     rgblight_effect_knight(rgblight_config.mode - 21);
395   }
396 }
397
398 // Effects
399 void rgblight_effect_breathing(uint8_t interval) {
400   static uint8_t pos = 0;
401   static uint16_t last_timer = 0;
402
403   if (timer_elapsed(last_timer) < pgm_read_byte(&RGBLED_BREATHING_INTERVALS[interval])) {
404     return;
405   }
406   last_timer = timer_read();
407
408   rgblight_sethsv_noeeprom(rgblight_config.hue, rgblight_config.sat, pgm_read_byte(&RGBLED_BREATHING_TABLE[pos]));
409   pos = (pos + 1) % 256;
410 }
411 void rgblight_effect_rainbow_mood(uint8_t interval) {
412   static uint16_t current_hue = 0;
413   static uint16_t last_timer = 0;
414
415   if (timer_elapsed(last_timer) < pgm_read_byte(&RGBLED_RAINBOW_MOOD_INTERVALS[interval])) {
416     return;
417   }
418   last_timer = timer_read();
419   rgblight_sethsv_noeeprom(current_hue, rgblight_config.sat, rgblight_config.val);
420   current_hue = (current_hue + 1) % 360;
421 }
422 void rgblight_effect_rainbow_swirl(uint8_t interval) {
423   static uint16_t current_hue = 0;
424   static uint16_t last_timer = 0;
425   uint16_t hue;
426   uint8_t i;
427   if (timer_elapsed(last_timer) < pgm_read_byte(&RGBLED_RAINBOW_MOOD_INTERVALS[interval / 2])) {
428     return;
429   }
430   last_timer = timer_read();
431   for (i = 0; i < RGBLED_NUM; i++) {
432     hue = (360 / RGBLED_NUM * i + current_hue) % 360;
433     sethsv(hue, rgblight_config.sat, rgblight_config.val, &led[i]);
434   }
435   rgblight_set();
436
437   if (interval % 2) {
438     current_hue = (current_hue + 1) % 360;
439   } else {
440     if (current_hue - 1 < 0) {
441       current_hue = 359;
442     } else {
443       current_hue = current_hue - 1;
444     }
445   }
446 }
447 void rgblight_effect_snake(uint8_t interval) {
448   static uint8_t pos = 0;
449   static uint16_t last_timer = 0;
450   uint8_t i, j;
451   int8_t k;
452   int8_t increment = 1;
453   if (interval % 2) {
454     increment = -1;
455   }
456   if (timer_elapsed(last_timer) < pgm_read_byte(&RGBLED_SNAKE_INTERVALS[interval / 2])) {
457     return;
458   }
459   last_timer = timer_read();
460   for (i = 0; i < RGBLED_NUM; i++) {
461     led[i].r = 0;
462     led[i].g = 0;
463     led[i].b = 0;
464     for (j = 0; j < RGBLIGHT_EFFECT_SNAKE_LENGTH; j++) {
465       k = pos + j * increment;
466       if (k < 0) {
467         k = k + RGBLED_NUM;
468       }
469       if (i == k) {
470         sethsv(rgblight_config.hue, rgblight_config.sat, (uint8_t)(rgblight_config.val*(RGBLIGHT_EFFECT_SNAKE_LENGTH-j)/RGBLIGHT_EFFECT_SNAKE_LENGTH), &led[i]);
471       }
472     }
473   }
474   rgblight_set();
475   if (increment == 1) {
476     if (pos - 1 < 0) {
477       pos = RGBLED_NUM - 1;
478     } else {
479       pos -= 1;
480     }
481   } else {
482     pos = (pos + 1) % RGBLED_NUM;
483   }
484 }
485 void rgblight_effect_knight(uint8_t interval) {
486   static int8_t pos = 0;
487   static uint16_t last_timer = 0;
488   uint8_t i, j, cur;
489   int8_t k;
490   struct cRGB preled[RGBLED_NUM];
491   static int8_t increment = -1;
492   if (timer_elapsed(last_timer) < pgm_read_byte(&RGBLED_KNIGHT_INTERVALS[interval])) {
493     return;
494   }
495   last_timer = timer_read();
496   for (i = 0; i < RGBLED_NUM; i++) {
497     preled[i].r = 0;
498     preled[i].g = 0;
499     preled[i].b = 0;
500     for (j = 0; j < RGBLIGHT_EFFECT_KNIGHT_LENGTH; j++) {
501       k = pos + j * increment;
502       if (k < 0) {
503         k = 0;
504       }
505       if (k >= RGBLED_NUM) {
506         k = RGBLED_NUM - 1;
507       }
508       if (i == k) {
509         sethsv(rgblight_config.hue, rgblight_config.sat, rgblight_config.val, &preled[i]);
510       }
511     }
512   }
513   if (RGBLIGHT_EFFECT_KNIGHT_OFFSET) {
514     for (i = 0; i < RGBLED_NUM; i++) {
515       cur = (i + RGBLIGHT_EFFECT_KNIGHT_OFFSET) % RGBLED_NUM;
516       led[i].r = preled[cur].r;
517       led[i].g = preled[cur].g;
518       led[i].b = preled[cur].b;
519     }
520   }
521   rgblight_set();
522   if (increment == 1) {
523     if (pos - 1 < 0 - RGBLIGHT_EFFECT_KNIGHT_LENGTH) {
524       pos = 0 - RGBLIGHT_EFFECT_KNIGHT_LENGTH;
525       increment = -1;
526     } else {
527       pos -= 1;
528     }
529   } else {
530     if (pos + 1 > RGBLED_NUM + RGBLIGHT_EFFECT_KNIGHT_LENGTH) {
531       pos = RGBLED_NUM + RGBLIGHT_EFFECT_KNIGHT_LENGTH - 1;
532       increment = 1;
533     } else {
534       pos += 1;
535     }
536   }
537 }
538
539 #endif