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