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