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