quantum/rgb_matrix.c

   1 /* Copyright 2017 Jason Williams
   2  * Copyright 2017 Jack Humbert
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18
  19 #include "rgb_matrix.h"
  20 #include <avr/io.h>
  21 #include "TWIlib.h"
  22 #include <util/delay.h>
  23 #include <avr/interrupt.h>
  24 #include "progmem.h"
  25 #include "config.h"
  26 #include "eeprom.h"
  27 #include "lufa.h"
  28 #include <math.h>
  29
  30 rgb_config_t rgb_matrix_config;
  31
  32 #ifndef RGB_DISABLE_AFTER_TIMEOUT
  33     #define RGB_DISABLE_AFTER_TIMEOUT 0
  34 #endif
  35
  36 #ifndef RGB_DISABLE_WHEN_USB_SUSPENDED
  37     #define RGB_DISABLE_WHEN_USB_SUSPENDED false
  38 #endif
  39
  40 #ifndef EECONFIG_RGB_MATRIX
  41     #define EECONFIG_RGB_MATRIX EECONFIG_RGBLIGHT
  42 #endif
  43
  44 bool g_suspend_state = false;
  45
  46 // Global tick at 20 Hz
  47 uint32_t g_tick = 0;
  48
  49 // Ticks since this key was last hit.
  50 uint8_t g_key_hit[DRIVER_LED_TOTAL];
  51
  52 // Ticks since any key was last hit.
  53 uint32_t g_any_key_hit = 0;
  54
  55 #ifndef PI
  56 #define PI 3.14159265
  57 #endif
  58
  59 uint32_t eeconfig_read_rgb_matrix(void) {
  60   return eeprom_read_dword(EECONFIG_RGB_MATRIX);
  61 }
  62 void eeconfig_update_rgb_matrix(uint32_t val) {
  63   eeprom_update_dword(EECONFIG_RGB_MATRIX, val);
  64 }
  65 void eeconfig_update_rgb_matrix_default(void) {
  66   dprintf("eeconfig_update_rgb_matrix_default\n");
  67   rgb_matrix_config.enable = 1;
  68   rgb_matrix_config.mode = RGB_MATRIX_CYCLE_LEFT_RIGHT;
  69   rgb_matrix_config.hue = 0;
  70   rgb_matrix_config.sat = 255;
  71   rgb_matrix_config.val = 255;
  72   eeconfig_update_rgb_matrix(rgb_matrix_config.raw);
  73 }
  74 void eeconfig_debug_rgb_matrix(void) {
  75   dprintf("rgb_matrix_config eprom\n");
  76   dprintf("rgb_matrix_config.enable = %d\n", rgb_matrix_config.enable);
  77   dprintf("rgb_matrix_config.mode = %d\n", rgb_matrix_config.mode);
  78   dprintf("rgb_matrix_config.hue = %d\n", rgb_matrix_config.hue);
  79   dprintf("rgb_matrix_config.sat = %d\n", rgb_matrix_config.sat);
  80   dprintf("rgb_matrix_config.val = %d\n", rgb_matrix_config.val);
  81 }
  82
  83 // Last led hit
  84 #define LED_HITS_TO_REMEMBER 8
  85 uint8_t g_last_led_hit[LED_HITS_TO_REMEMBER] = {255};
  86 uint8_t g_last_led_count = 0;
  87
  88 void map_row_column_to_led( uint8_t row, uint8_t column, uint8_t *led_i, uint8_t *led_count) {
  89     rgb_led led;
  90     *led_count = 0;
  91
  92     for (uint8_t i = 0; i < DRIVER_LED_TOTAL; i++) {
  93         // map_index_to_led(i, &led);
  94         led = g_rgb_leds[i];
  95         if (row == led.matrix_co.row && column == led.matrix_co.col) {
  96             led_i[*led_count] = i;
  97             (*led_count)++;
  98         }
  99     }
 100 }
 101
 102
 103 void rgb_matrix_update_pwm_buffers(void) {
 104     IS31FL3731_update_pwm_buffers( DRIVER_ADDR_1, DRIVER_ADDR_2 );
 105     IS31FL3731_update_led_control_registers( DRIVER_ADDR_1, DRIVER_ADDR_2 );
 106 }
 107
 108 void rgb_matrix_set_color( int index, uint8_t red, uint8_t green, uint8_t blue ) {
 109     IS31FL3731_set_color( index, red, green, blue );
 110 }
 111
 112 void rgb_matrix_set_color_all( uint8_t red, uint8_t green, uint8_t blue ) {
 113     IS31FL3731_set_color_all( red, green, blue );
 114 }
 115
 116
 117 bool process_rgb_matrix(uint16_t keycode, keyrecord_t *record) {
 118     if ( record->event.pressed ) {
 119         uint8_t led[8], led_count;
 120         map_row_column_to_led(record->event.key.row, record->event.key.col, led, &led_count);
 121         if (led_count > 0) {
 122             for (uint8_t i = LED_HITS_TO_REMEMBER; i > 1; i--) {
 123                 g_last_led_hit[i - 1] = g_last_led_hit[i - 2];
 124             }
 125             g_last_led_hit[0] = led[0];
 126             g_last_led_count = MIN(LED_HITS_TO_REMEMBER, g_last_led_count + 1);
 127         }
 128         for(uint8_t i = 0; i < led_count; i++)
 129             g_key_hit[led[i]] = 0;
 130         g_any_key_hit = 0;
 131     } else {
 132         #ifdef RGB_MATRIX_KEYRELEASES
 133         uint8_t led[8], led_count;
 134         map_row_column_to_led(record->event.key.row, record->event.key.col, led, &led_count);
 135         for(uint8_t i = 0; i < led_count; i++)
 136             g_key_hit[led[i]] = 255;
 137
 138         g_any_key_hit = 255;
 139         #endif
 140     }
 141     return true;
 142 }
 143
 144 void rgb_matrix_set_suspend_state(bool state) {
 145     g_suspend_state = state;
 146 }
 147
 148 void rgb_matrix_test(void) {
 149     // Mask out bits 4 and 5
 150     // This 2-bit value will stay the same for 16 ticks.
 151     switch ( (g_tick & 0x30) >> 4 )
 152     {
 153         case 0:
 154         {
 155             rgb_matrix_set_color_all( 20, 0, 0 );
 156             break;
 157         }
 158         case 1:
 159         {
 160             rgb_matrix_set_color_all( 0, 20, 0 );
 161             break;
 162         }
 163         case 2:
 164         {
 165             rgb_matrix_set_color_all( 0, 0, 20 );
 166             break;
 167         }
 168         case 3:
 169         {
 170             rgb_matrix_set_color_all( 20, 20, 20 );
 171             break;
 172         }
 173     }
 174 }
 175
 176 // This tests the LEDs
 177 // Note that it will change the LED control registers
 178 // in the LED drivers, and leave them in an invalid
 179 // state for other backlight effects.
 180 // ONLY USE THIS FOR TESTING LEDS!
 181 void rgb_matrix_single_LED_test(void) {
 182     static uint8_t color = 0; // 0,1,2 for R,G,B
 183     static uint8_t row = 0;
 184     static uint8_t column = 0;
 185
 186     static uint8_t tick = 0;
 187     tick++;
 188
 189     if ( tick > 2 )
 190     {
 191         tick = 0;
 192         column++;
 193     }
 194     if ( column > MATRIX_COLS )
 195     {
 196         column = 0;
 197         row++;
 198     }
 199     if ( row > MATRIX_ROWS )
 200     {
 201         row = 0;
 202         color++;
 203     }
 204     if ( color > 2 )
 205     {
 206         color = 0;
 207     }
 208
 209     uint8_t led[8], led_count;
 210     map_row_column_to_led(row,column,led,&led_count);
 211     for(uint8_t i = 0; i < led_count; i++) {
 212         rgb_matrix_set_color_all( 40, 40, 40 );
 213         rgb_matrix_test_led( led[i], color==0, color==1, color==2 );
 214     }
 215 }
 216
 217 // All LEDs off
 218 void rgb_matrix_all_off(void) {
 219     rgb_matrix_set_color_all( 0, 0, 0 );
 220 }
 221
 222 // Solid color
 223 void rgb_matrix_solid_color(void) {
 224     HSV hsv = { .h = rgb_matrix_config.hue, .s = rgb_matrix_config.sat, .v = rgb_matrix_config.val };
 225     RGB rgb = hsv_to_rgb( hsv );
 226     rgb_matrix_set_color_all( rgb.r, rgb.g, rgb.b );
 227 }
 228
 229 void rgb_matrix_solid_reactive(void) {
 230         // Relies on hue being 8-bit and wrapping
 231         for ( int i=0; i<DRIVER_LED_TOTAL; i++ )
 232         {
 233                 uint16_t offset2 = g_key_hit[i]<<2;
 234                 offset2 = (offset2<=130) ? (130-offset2) : 0;
 235
 236                 HSV hsv = { .h = rgb_matrix_config.hue+offset2, .s = 255, .v = rgb_matrix_config.val };
 237                 RGB rgb = hsv_to_rgb( hsv );
 238                 rgb_matrix_set_color( i, rgb.r, rgb.g, rgb.b );
 239         }
 240 }
 241
 242 // alphas = color1, mods = color2
 243 void rgb_matrix_alphas_mods(void) {
 244
 245     RGB rgb1 = hsv_to_rgb( (HSV){ .h = rgb_matrix_config.hue, .s = rgb_matrix_config.sat, .v = rgb_matrix_config.val } );
 246     RGB rgb2 = hsv_to_rgb( (HSV){ .h = (rgb_matrix_config.hue + 180) % 360, .s = rgb_matrix_config.sat, .v = rgb_matrix_config.val } );
 247
 248     rgb_led led;
 249     for (int i = 0; i < DRIVER_LED_TOTAL; i++) {
 250         led = g_rgb_leds[i];
 251         if ( led.matrix_co.raw < 0xFF ) {
 252             if ( led.modifier )
 253             {
 254                 rgb_matrix_set_color( i, rgb2.r, rgb2.g, rgb2.b );
 255             }
 256             else
 257             {
 258                 rgb_matrix_set_color( i, rgb1.r, rgb1.g, rgb1.b );
 259             }
 260         }
 261     }
 262 }
 263
 264 void rgb_matrix_gradient_up_down(void) {
 265     int16_t h1 = rgb_matrix_config.hue;
 266     int16_t h2 = (rgb_matrix_config.hue + 180) % 360;
 267     int16_t deltaH = h2 - h1;
 268
 269     // Take the shortest path between hues
 270     if ( deltaH > 127 )
 271     {
 272         deltaH -= 256;
 273     }
 274     else if ( deltaH < -127 )
 275     {
 276         deltaH += 256;
 277     }
 278     // Divide delta by 4, this gives the delta per row
 279     deltaH /= 4;
 280
 281     int16_t s1 = rgb_matrix_config.sat;
 282     int16_t s2 = rgb_matrix_config.hue;
 283     int16_t deltaS = ( s2 - s1 ) / 4;
 284
 285     HSV hsv = { .h = 0, .s = 255, .v = rgb_matrix_config.val };
 286     RGB rgb;
 287     Point point;
 288     for ( int i=0; i<DRIVER_LED_TOTAL; i++ )
 289     {
 290         // map_led_to_point( i, &point );
 291         point = g_rgb_leds[i].point;
 292         // The y range will be 0..64, map this to 0..4
 293         uint8_t y = (point.y>>4);
 294         // Relies on hue being 8-bit and wrapping
 295         hsv.h = rgb_matrix_config.hue + ( deltaH * y );
 296         hsv.s = rgb_matrix_config.sat + ( deltaS * y );
 297         rgb = hsv_to_rgb( hsv );
 298         rgb_matrix_set_color( i, rgb.r, rgb.g, rgb.b );
 299     }
 300 }
 301
 302 void rgb_matrix_raindrops(bool initialize) {
 303     int16_t h1 = rgb_matrix_config.hue;
 304     int16_t h2 = (rgb_matrix_config.hue + 180) % 360;
 305     int16_t deltaH = h2 - h1;
 306     deltaH /= 4;
 307
 308     // Take the shortest path between hues
 309     if ( deltaH > 127 )
 310     {
 311         deltaH -= 256;
 312     }
 313     else if ( deltaH < -127 )
 314     {
 315         deltaH += 256;
 316     }
 317
 318     int16_t s1 = rgb_matrix_config.sat;
 319     int16_t s2 = rgb_matrix_config.sat;
 320     int16_t deltaS = ( s2 - s1 ) / 4;
 321
 322     HSV hsv;
 323     RGB rgb;
 324
 325     // Change one LED every tick
 326     uint8_t led_to_change = ( g_tick & 0x000 ) == 0 ? rand() % DRIVER_LED_TOTAL : 255;
 327
 328     for ( int i=0; i<DRIVER_LED_TOTAL; i++ )
 329     {
 330         // If initialize, all get set to random colors
 331         // If not, all but one will stay the same as before.
 332         if ( initialize || i == led_to_change )
 333         {
 334             hsv.h = h1 + ( deltaH * ( rand() & 0x03 ) );
 335             hsv.s = s1 + ( deltaS * ( rand() & 0x03 ) );
 336             // Override brightness with global brightness control
 337             hsv.v = rgb_matrix_config.val;
 338
 339             rgb = hsv_to_rgb( hsv );
 340             rgb_matrix_set_color( i, rgb.r, rgb.g, rgb.b );
 341         }
 342     }
 343 }
 344
 345 void rgb_matrix_cycle_all(void) {
 346     uint8_t offset = g_tick & 0xFF;
 347
 348     rgb_led led;
 349
 350     // Relies on hue being 8-bit and wrapping
 351     for ( int i=0; i<DRIVER_LED_TOTAL; i++ )
 352     {
 353         // map_index_to_led(i, &led);
 354         led = g_rgb_leds[i];
 355         if (led.matrix_co.raw < 0xFF) {
 356             uint16_t offset2 = g_key_hit[i]<<2;
 357             offset2 = (offset2<=63) ? (63-offset2) : 0;
 358
 359             HSV hsv = { .h = offset+offset2, .s = 255, .v = rgb_matrix_config.val };
 360             RGB rgb = hsv_to_rgb( hsv );
 361             rgb_matrix_set_color( i, rgb.r, rgb.g, rgb.b );
 362         }
 363     }
 364 }
 365
 366 void rgb_matrix_cycle_left_right(void) {
 367     uint8_t offset = g_tick & 0xFF;
 368     HSV hsv = { .h = 0, .s = 255, .v = rgb_matrix_config.val };
 369     RGB rgb;
 370     Point point;
 371     rgb_led led;
 372     for ( int i=0; i<DRIVER_LED_TOTAL; i++ )
 373     {
 374         // map_index_to_led(i, &led);
 375         led = g_rgb_leds[i];
 376         if (led.matrix_co.raw < 0xFF) {
 377             uint16_t offset2 = g_key_hit[i]<<2;
 378             offset2 = (offset2<=63) ? (63-offset2) : 0;
 379
 380             // map_led_to_point( i, &point );
 381             point = g_rgb_leds[i].point;
 382             // Relies on hue being 8-bit and wrapping
 383             hsv.h = point.x + offset + offset2;
 384             rgb = hsv_to_rgb( hsv );
 385             rgb_matrix_set_color( i, rgb.r, rgb.g, rgb.b );
 386         }
 387     }
 388 }
 389
 390 void rgb_matrix_cycle_up_down(void) {
 391     uint8_t offset = g_tick & 0xFF;
 392     HSV hsv = { .h = 0, .s = 255, .v = rgb_matrix_config.val };
 393     RGB rgb;
 394     Point point;
 395     rgb_led led;
 396     for ( int i=0; i<DRIVER_LED_TOTAL; i++ )
 397     {
 398         // map_index_to_led(i, &led);
 399         led = g_rgb_leds[i];
 400         if (led.matrix_co.raw < 0xFF) {
 401             uint16_t offset2 = g_key_hit[i]<<2;
 402             offset2 = (offset2<=63) ? (63-offset2) : 0;
 403
 404             // map_led_to_point( i, &point );
 405             point = g_rgb_leds[i].point;
 406             // Relies on hue being 8-bit and wrapping
 407             hsv.h = point.y + offset + offset2;
 408             rgb = hsv_to_rgb( hsv );
 409             rgb_matrix_set_color( i, rgb.r, rgb.g, rgb.b );
 410         }
 411     }
 412 }
 413
 414
 415 void rgb_matrix_dual_beacon(void) {
 416     HSV hsv = { .h = rgb_matrix_config.hue, .s = rgb_matrix_config.sat, .v = rgb_matrix_config.val };
 417     RGB rgb;
 418     rgb_led led;
 419     for (uint8_t i = 0; i < DRIVER_LED_TOTAL; i++) {
 420         led = g_rgb_leds[i];
 421         hsv.h = ((led.point.y - 32.0)* cos(g_tick * PI / 128) / 32 + (led.point.x - 112.0) * sin(g_tick * PI / 128) / (112)) * (180) + rgb_matrix_config.hue;
 422         rgb = hsv_to_rgb( hsv );
 423         rgb_matrix_set_color( i, rgb.r, rgb.g, rgb.b );
 424     }
 425 }
 426
 427 void rgb_matrix_rainbow_beacon(void) {
 428     HSV hsv = { .h = rgb_matrix_config.hue, .s = rgb_matrix_config.sat, .v = rgb_matrix_config.val };
 429     RGB rgb;
 430     rgb_led led;
 431     for (uint8_t i = 0; i < DRIVER_LED_TOTAL; i++) {
 432         led = g_rgb_leds[i];
 433         hsv.h = 1.5 * (led.point.y - 32.0)* cos(g_tick * PI / 128) + 1.5 * (led.point.x - 112.0) * sin(g_tick * PI / 128) + rgb_matrix_config.hue;
 434         rgb = hsv_to_rgb( hsv );
 435         rgb_matrix_set_color( i, rgb.r, rgb.g, rgb.b );
 436     }
 437 }
 438
 439 void rgb_matrix_rainbow_pinwheels(void) {
 440     HSV hsv = { .h = rgb_matrix_config.hue, .s = rgb_matrix_config.sat, .v = rgb_matrix_config.val };
 441     RGB rgb;
 442     rgb_led led;
 443     for (uint8_t i = 0; i < DRIVER_LED_TOTAL; i++) {
 444         led = g_rgb_leds[i];
 445         hsv.h = 2 * (led.point.y - 32.0)* cos(g_tick * PI / 128) + 2 * (66 - abs(led.point.x - 112.0)) * sin(g_tick * PI / 128) + rgb_matrix_config.hue;
 446         rgb = hsv_to_rgb( hsv );
 447         rgb_matrix_set_color( i, rgb.r, rgb.g, rgb.b );
 448     }
 449 }
 450
 451 void rgb_matrix_rainbow_moving_chevron(void) {
 452     HSV hsv = { .h = rgb_matrix_config.hue, .s = rgb_matrix_config.sat, .v = rgb_matrix_config.val };
 453     RGB rgb;
 454     rgb_led led;
 455     for (uint8_t i = 0; i < DRIVER_LED_TOTAL; i++) {
 456         led = g_rgb_leds[i];
 457         // uint8_t r = g_tick;
 458         uint8_t r = 32;
 459         hsv.h = 1.5 * abs(led.point.y - 32.0)* sin(r * PI / 128) + 1.5 * (led.point.x - (g_tick / 256.0 * 224)) * cos(r * PI / 128) + rgb_matrix_config.hue;
 460         rgb = hsv_to_rgb( hsv );
 461         rgb_matrix_set_color( i, rgb.r, rgb.g, rgb.b );
 462     }
 463 }
 464
 465
 466 void rgb_matrix_jellybean_raindrops( bool initialize ) {
 467     HSV hsv;
 468     RGB rgb;
 469
 470     // Change one LED every tick
 471     uint8_t led_to_change = ( g_tick & 0x000 ) == 0 ? rand() % DRIVER_LED_TOTAL : 255;
 472
 473     for ( int i=0; i<DRIVER_LED_TOTAL; i++ )
 474     {
 475         // If initialize, all get set to random colors
 476         // If not, all but one will stay the same as before.
 477         if ( initialize || i == led_to_change )
 478         {
 479             hsv.h = rand() & 0xFF;
 480             hsv.s = rand() & 0xFF;
 481             // Override brightness with global brightness control
 482             hsv.v = rgb_matrix_config.val;
 483
 484             rgb = hsv_to_rgb( hsv );
 485             rgb_matrix_set_color( i, rgb.r, rgb.g, rgb.b );
 486         }
 487     }
 488 }
 489
 490 void rgb_matrix_multisplash(void) {
 491     // if (g_any_key_hit < 0xFF) {
 492         HSV hsv = { .h = rgb_matrix_config.hue, .s = rgb_matrix_config.sat, .v = rgb_matrix_config.val };
 493         RGB rgb;
 494         rgb_led led;
 495         for (uint8_t i = 0; i < DRIVER_LED_TOTAL; i++) {
 496             led = g_rgb_leds[i];
 497             uint16_t c = 0, d = 0;
 498             rgb_led last_led;
 499             // if (g_last_led_count) {
 500                 for (uint8_t last_i = 0; last_i < g_last_led_count; last_i++) {
 501                     last_led = g_rgb_leds[g_last_led_hit[last_i]];
 502                     uint16_t dist = (uint16_t)sqrt(pow(led.point.x - last_led.point.x, 2) + pow(led.point.y - last_led.point.y, 2));
 503                     uint16_t effect = (g_key_hit[g_last_led_hit[last_i]] << 2) - dist;
 504                     c += MIN(MAX(effect, 0), 255);
 505                     d += 255 - MIN(MAX(effect, 0), 255);
 506                 }
 507             // } else {
 508             //     d = 255;
 509             // }
 510             hsv.h = (rgb_matrix_config.hue + c) % 256;
 511             hsv.v = MAX(MIN(d, 255), 0);
 512             rgb = hsv_to_rgb( hsv );
 513             rgb_matrix_set_color( i, rgb.r, rgb.g, rgb.b );
 514         }
 515     // } else {
 516         // rgb_matrix_set_color_all( 0, 0, 0 );
 517     // }
 518 }
 519
 520
 521 void rgb_matrix_splash(void) {
 522     g_last_led_count = MIN(g_last_led_count, 1);
 523     rgb_matrix_multisplash();
 524 }
 525
 526
 527 void rgb_matrix_solid_multisplash(void) {
 528     // if (g_any_key_hit < 0xFF) {
 529         HSV hsv = { .h = rgb_matrix_config.hue, .s = rgb_matrix_config.sat, .v = rgb_matrix_config.val };
 530         RGB rgb;
 531         rgb_led led;
 532         for (uint8_t i = 0; i < DRIVER_LED_TOTAL; i++) {
 533             led = g_rgb_leds[i];
 534             uint16_t d = 0;
 535             rgb_led last_led;
 536             // if (g_last_led_count) {
 537                 for (uint8_t last_i = 0; last_i < g_last_led_count; last_i++) {
 538                     last_led = g_rgb_leds[g_last_led_hit[last_i]];
 539                     uint16_t dist = (uint16_t)sqrt(pow(led.point.x - last_led.point.x, 2) + pow(led.point.y - last_led.point.y, 2));
 540                     uint16_t effect = (g_key_hit[g_last_led_hit[last_i]] << 2) - dist;
 541                     d += 255 - MIN(MAX(effect, 0), 255);
 542                 }
 543             // } else {
 544             //     d = 255;
 545             // }
 546             hsv.v = MAX(MIN(d, 255), 0);
 547             rgb = hsv_to_rgb( hsv );
 548             rgb_matrix_set_color( i, rgb.r, rgb.g, rgb.b );
 549         }
 550     // } else {
 551         // rgb_matrix_set_color_all( 0, 0, 0 );
 552     // }
 553 }
 554
 555
 556 void rgb_matrix_solid_splash(void) {
 557     g_last_led_count = MIN(g_last_led_count, 1);
 558     rgb_matrix_solid_multisplash();
 559 }
 560
 561
 562 // Needs eeprom access that we don't have setup currently
 563
 564 void rgb_matrix_custom(void) {
 565 //     HSV hsv;
 566 //     RGB rgb;
 567 //     for ( int i=0; i<DRIVER_LED_TOTAL; i++ )
 568 //     {
 569 //         backlight_get_key_color(i, &hsv);
 570 //         // Override brightness with global brightness control
 571 //         hsv.v = rgb_matrix_config.val;
 572 //         rgb = hsv_to_rgb( hsv );
 573 //         rgb_matrix_set_color( i, rgb.r, rgb.g, rgb.b );
 574 //     }
 575 }
 576
 577 void rgb_matrix_task(void) {
 578         if (!rgb_matrix_config.enable) {
 579         rgb_matrix_all_off();
 580         return;
 581     }
 582     // delay 1 second before driving LEDs or doing anything else
 583     static uint8_t startup_tick = 0;
 584     if ( startup_tick < 20 ) {
 585         startup_tick++;
 586         return;
 587     }
 588
 589     g_tick++;
 590
 591     if ( g_any_key_hit < 0xFFFFFFFF ) {
 592         g_any_key_hit++;
 593     }
 594
 595     for ( int led = 0; led < DRIVER_LED_TOTAL; led++ ) {
 596         if ( g_key_hit[led] < 255 ) {
 597             if (g_key_hit[led] == 254)
 598                 g_last_led_count = MAX(g_last_led_count - 1, 0);
 599             g_key_hit[led]++;
 600         }
 601     }
 602
 603     // Factory default magic value
 604     if ( rgb_matrix_config.mode == 255 ) {
 605         rgb_matrix_test();
 606         return;
 607     }
 608
 609     // Ideally we would also stop sending zeros to the LED driver PWM buffers
 610     // while suspended and just do a software shutdown. This is a cheap hack for now.
 611     bool suspend_backlight = ((g_suspend_state && RGB_DISABLE_WHEN_USB_SUSPENDED) ||
 612             (RGB_DISABLE_AFTER_TIMEOUT > 0 && g_any_key_hit > RGB_DISABLE_AFTER_TIMEOUT * 60 * 20));
 613     uint8_t effect = suspend_backlight ? 0 : rgb_matrix_config.mode;
 614
 615     // Keep track of the effect used last time,
 616     // detect change in effect, so each effect can
 617     // have an optional initialization.
 618     static uint8_t effect_last = 255;
 619     bool initialize = effect != effect_last;
 620     effect_last = effect;
 621
 622     // this gets ticked at 20 Hz.
 623     // each effect can opt to do calculations
 624     // and/or request PWM buffer updates.
 625     switch ( effect ) {
 626         case RGB_MATRIX_SOLID_COLOR:
 627             rgb_matrix_solid_color();
 628             break;
 629         case RGB_MATRIX_SOLID_REACTIVE:
 630             rgb_matrix_solid_reactive();
 631             break;
 632         case RGB_MATRIX_ALPHAS_MODS:
 633             rgb_matrix_alphas_mods();
 634             break;
 635         case RGB_MATRIX_DUAL_BEACON:
 636             rgb_matrix_dual_beacon();
 637             break;
 638         case RGB_MATRIX_GRADIENT_UP_DOWN:
 639             rgb_matrix_gradient_up_down();
 640             break;
 641         case RGB_MATRIX_RAINDROPS:
 642             rgb_matrix_raindrops( initialize );
 643             break;
 644         case RGB_MATRIX_CYCLE_ALL:
 645             rgb_matrix_cycle_all();
 646             break;
 647         case RGB_MATRIX_CYCLE_LEFT_RIGHT:
 648             rgb_matrix_cycle_left_right();
 649             break;
 650         case RGB_MATRIX_CYCLE_UP_DOWN:
 651             rgb_matrix_cycle_up_down();
 652             break;
 653         case RGB_MATRIX_RAINBOW_BEACON:
 654             rgb_matrix_rainbow_beacon();
 655             break;
 656         case RGB_MATRIX_RAINBOW_PINWHEELS:
 657             rgb_matrix_rainbow_pinwheels();
 658             break;
 659         case RGB_MATRIX_RAINBOW_MOVING_CHEVRON:
 660             rgb_matrix_rainbow_moving_chevron();
 661             break;
 662         case RGB_MATRIX_JELLYBEAN_RAINDROPS:
 663             rgb_matrix_jellybean_raindrops( initialize );
 664             break;
 665         #ifdef RGB_MATRIX_KEYPRESSES
 666             case RGB_MATRIX_SPLASH:
 667                 rgb_matrix_splash();
 668                 break;
 669             case RGB_MATRIX_MULTISPLASH:
 670                 rgb_matrix_multisplash();
 671                 break;
 672             case RGB_MATRIX_SOLID_SPLASH:
 673                 rgb_matrix_solid_splash();
 674                 break;
 675             case RGB_MATRIX_SOLID_MULTISPLASH:
 676                 rgb_matrix_solid_multisplash();
 677                 break;
 678         #endif
 679         default:
 680             rgb_matrix_custom();
 681             break;
 682     }
 683
 684     if ( ! suspend_backlight ) {
 685         rgb_matrix_indicators();
 686     }
 687
 688 }
 689
 690 void rgb_matrix_indicators(void) {
 691     rgb_matrix_indicators_kb();
 692     rgb_matrix_indicators_user();
 693 }
 694
 695 __attribute__((weak))
 696 void rgb_matrix_indicators_kb(void) {}
 697
 698 __attribute__((weak))
 699 void rgb_matrix_indicators_user(void) {}
 700
 701
 702 // void rgb_matrix_set_indicator_index( uint8_t *index, uint8_t row, uint8_t column )
 703 // {
 704 //  if ( row >= MATRIX_ROWS )
 705 //  {
 706 //      // Special value, 255=none, 254=all
 707 //      *index = row;
 708 //  }
 709 //  else
 710 //  {
 711 //      // This needs updated to something like
 712 //      // uint8_t led[8], led_count;
 713 //      // map_row_column_to_led(row,column,led,&led_count);
 714 //      // for(uint8_t i = 0; i < led_count; i++)
 715 //      map_row_column_to_led( row, column, index );
 716 //  }
 717 // }
 718
 719 void rgb_matrix_init_drivers(void) {
 720     //sei();
 721
 722     // Initialize TWI
 723     TWIInit();
 724     IS31FL3731_init( DRIVER_ADDR_1 );
 725     IS31FL3731_init( DRIVER_ADDR_2 );
 726
 727     for ( int index = 0; index < DRIVER_LED_TOTAL; index++ ) {
 728         bool enabled = true;
 729         // This only caches it for later
 730         IS31FL3731_set_led_control_register( index, enabled, enabled, enabled );
 731     }
 732     // This actually updates the LED drivers
 733     IS31FL3731_update_led_control_registers( DRIVER_ADDR_1, DRIVER_ADDR_2 );
 734
 735     // TODO: put the 1 second startup delay here?
 736
 737     // clear the key hits
 738     for ( int led=0; led<DRIVER_LED_TOTAL; led++ ) {
 739         g_key_hit[led] = 255;
 740     }
 741
 742
 743     if (!eeconfig_is_enabled()) {
 744         dprintf("rgb_matrix_init_drivers eeconfig is not enabled.\n");
 745         eeconfig_init();
 746         eeconfig_update_rgb_matrix_default();
 747     }
 748     rgb_matrix_config.raw = eeconfig_read_rgb_matrix();
 749     if (!rgb_matrix_config.mode) {
 750         dprintf("rgb_matrix_init_drivers rgb_matrix_config.mode = 0. Write default values to EEPROM.\n");
 751         eeconfig_update_rgb_matrix_default();
 752         rgb_matrix_config.raw = eeconfig_read_rgb_matrix();
 753     }
 754     eeconfig_debug_rgb_matrix(); // display current eeprom values
 755 }
 756
 757 // Deals with the messy details of incrementing an integer
 758 uint8_t increment( uint8_t value, uint8_t step, uint8_t min, uint8_t max ) {
 759     int16_t new_value = value;
 760     new_value += step;
 761     return MIN( MAX( new_value, min ), max );
 762 }
 763
 764 uint8_t decrement( uint8_t value, uint8_t step, uint8_t min, uint8_t max ) {
 765     int16_t new_value = value;
 766     new_value -= step;
 767     return MIN( MAX( new_value, min ), max );
 768 }
 769
 770 // void *backlight_get_custom_key_color_eeprom_address( uint8_t led )
 771 // {
 772 //     // 3 bytes per color
 773 //     return EECONFIG_RGB_MATRIX + ( led * 3 );
 774 // }
 775
 776 // void backlight_get_key_color( uint8_t led, HSV *hsv )
 777 // {
 778 //     void *address = backlight_get_custom_key_color_eeprom_address( led );
 779 //     hsv->h = eeprom_read_byte(address);
 780 //     hsv->s = eeprom_read_byte(address+1);
 781 //     hsv->v = eeprom_read_byte(address+2);
 782 // }
 783
 784 // void backlight_set_key_color( uint8_t row, uint8_t column, HSV hsv )
 785 // {
 786 //     uint8_t led[8], led_count;
 787 //     map_row_column_to_led(row,column,led,&led_count);
 788 //     for(uint8_t i = 0; i < led_count; i++) {
 789 //         if ( led[i] < DRIVER_LED_TOTAL )
 790 //         {
 791 //             void *address = backlight_get_custom_key_color_eeprom_address(led[i]);
 792 //             eeprom_update_byte(address, hsv.h);
 793 //             eeprom_update_byte(address+1, hsv.s);
 794 //             eeprom_update_byte(address+2, hsv.v);
 795 //         }
 796 //     }
 797 // }
 798
 799 void rgb_matrix_test_led( uint8_t index, bool red, bool green, bool blue ) {
 800     for ( int i=0; i<DRIVER_LED_TOTAL; i++ )
 801     {
 802         if ( i == index )
 803         {
 804             IS31FL3731_set_led_control_register( i, red, green, blue );
 805         }
 806         else
 807         {
 808             IS31FL3731_set_led_control_register( i, false, false, false );
 809         }
 810     }
 811 }
 812
 813 uint32_t rgb_matrix_get_tick(void) {
 814     return g_tick;
 815 }
 816
 817 void rgblight_toggle(void) {
 818         rgb_matrix_config.enable ^= 1;
 819     eeconfig_update_rgb_matrix(rgb_matrix_config.raw);
 820 }
 821
 822 void rgblight_step(void) {
 823     rgb_matrix_config.mode++;
 824     if (rgb_matrix_config.mode >= RGB_MATRIX_EFFECT_MAX)
 825         rgb_matrix_config.mode = 1;
 826     eeconfig_update_rgb_matrix(rgb_matrix_config.raw);
 827 }
 828
 829 void rgblight_step_reverse(void) {
 830     rgb_matrix_config.mode--;
 831     if (rgb_matrix_config.mode <= 1)
 832         rgb_matrix_config.mode = (RGB_MATRIX_EFFECT_MAX - 1);
 833     eeconfig_update_rgb_matrix(rgb_matrix_config.raw);
 834 }
 835
 836 void rgblight_increase_hue(void) {
 837     rgb_matrix_config.hue = increment( rgb_matrix_config.hue, 8, 0, 255 );
 838     eeconfig_update_rgb_matrix(rgb_matrix_config.raw);
 839 }
 840
 841 void rgblight_decrease_hue(void) {
 842     rgb_matrix_config.hue = decrement( rgb_matrix_config.hue, 8, 0, 255 );
 843     eeconfig_update_rgb_matrix(rgb_matrix_config.raw);
 844 }
 845
 846 void rgblight_increase_sat(void) {
 847     rgb_matrix_config.sat = increment( rgb_matrix_config.sat, 8, 0, 255 );
 848     eeconfig_update_rgb_matrix(rgb_matrix_config.raw);
 849 }
 850
 851 void rgblight_decrease_sat(void) {
 852     rgb_matrix_config.sat = decrement( rgb_matrix_config.sat, 8, 0, 255 );
 853     eeconfig_update_rgb_matrix(rgb_matrix_config.raw);
 854 }
 855
 856 void rgblight_increase_val(void) {
 857     rgb_matrix_config.val = increment( rgb_matrix_config.val, 8, 0, 255 );
 858     eeconfig_update_rgb_matrix(rgb_matrix_config.raw);
 859 }
 860
 861 void rgblight_decrease_val(void) {
 862     rgb_matrix_config.val = decrement( rgb_matrix_config.val, 8, 0, 255 );
 863     eeconfig_update_rgb_matrix(rgb_matrix_config.raw);
 864 }
 865
 866 void rgblight_mode(uint8_t mode) {
 867     rgb_matrix_config.mode = mode;
 868     eeconfig_update_rgb_matrix(rgb_matrix_config.raw);
 869 }
 870
 871 uint32_t rgblight_get_mode(void) {
 872     return rgb_matrix_config.mode;
 873 }