quantum/rgb_matrix.h

   1 /* Copyright 2017 Jason Williams
   2  * Copyright 2017 Jack Humbert
   3  * Copyright 2018 Yiancar
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef RGB_MATRIX_H
  20 #define RGB_MATRIX_H
  21
  22 #include <stdint.h>
  23 #include <stdbool.h>
  24 #include "color.h"
  25 #include "quantum.h"
  26
  27 #ifdef IS31FL3731
  28     #include "is31fl3731.h"
  29 #elif defined (IS31FL3733)
  30     #include "is31fl3733.h"
  31 #endif
  32
  33 typedef struct Point {
  34         uint8_t x;
  35         uint8_t y;
  36 } __attribute__((packed)) Point;
  37
  38 typedef struct rgb_led {
  39         union {
  40                 uint8_t raw;
  41                 struct {
  42                         uint8_t row:4; // 16 max
  43                         uint8_t col:4; // 16 max
  44                 };
  45         } matrix_co;
  46         Point point;
  47         uint8_t modifier:1;
  48 } __attribute__((packed)) rgb_led;
  49
  50
  51 extern const rgb_led g_rgb_leds[DRIVER_LED_TOTAL];
  52
  53 typedef struct
  54 {
  55         HSV color;
  56         uint8_t index;
  57 } rgb_indicator;
  58
  59 typedef union {
  60   uint32_t raw;
  61   struct {
  62     bool     enable  :1;
  63     uint8_t  mode    :6;
  64     uint16_t hue     :9;
  65     uint8_t  sat     :8;
  66     uint8_t  val     :8;
  67     uint8_t  speed   :8;//EECONFIG needs to be increased to support this
  68   };
  69 } rgb_config_t;
  70
  71 enum rgb_matrix_effects {
  72         RGB_MATRIX_SOLID_COLOR = 1,
  73 #ifndef DISABLE_RGB_MATRIX_ALPHAS_MODS
  74     RGB_MATRIX_ALPHAS_MODS,
  75 #endif
  76 #ifndef DISABLE_RGB_MATRIX_DUAL_BEACON
  77     RGB_MATRIX_DUAL_BEACON,
  78 #endif
  79 #ifndef DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN
  80     RGB_MATRIX_GRADIENT_UP_DOWN,
  81 #endif
  82 #ifndef DISABLE_RGB_MATRIX_RAINDROPS
  83     RGB_MATRIX_RAINDROPS,
  84 #endif
  85 #ifndef DISABLE_RGB_MATRIX_CYCLE_ALL
  86     RGB_MATRIX_CYCLE_ALL,
  87 #endif
  88 #ifndef DISABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
  89     RGB_MATRIX_CYCLE_LEFT_RIGHT,
  90 #endif
  91 #ifndef DISABLE_RGB_MATRIX_CYCLE_UP_DOWN
  92     RGB_MATRIX_CYCLE_UP_DOWN,
  93 #endif
  94 #ifndef DISABLE_RGB_MATRIX_RAINBOW_BEACON
  95     RGB_MATRIX_RAINBOW_BEACON,
  96 #endif
  97 #ifndef DISABLE_RGB_MATRIX_RAINBOW_PINWHEELS
  98     RGB_MATRIX_RAINBOW_PINWHEELS,
  99 #endif
 100 #ifndef DISABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
 101     RGB_MATRIX_RAINBOW_MOVING_CHEVRON,
 102 #endif
 103 #ifndef DISABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS
 104     RGB_MATRIX_JELLYBEAN_RAINDROPS,
 105 #endif
 106 #ifndef DISABLE_RGB_MATRIX_DIGITAL_RAIN
 107     RGB_MATRIX_DIGITAL_RAIN,
 108 #endif
 109 #ifdef RGB_MATRIX_KEYPRESSES
 110    #ifndef DISABLE_RGB_MATRIX_SOLID_REACTIVE
 111        RGB_MATRIX_SOLID_REACTIVE,
 112    #endif
 113    #ifndef DISABLE_RGB_MATRIX_SPLASH
 114        RGB_MATRIX_SPLASH,
 115    #endif
 116    #ifndef DISABLE_RGB_MATRIX_MULTISPLASH
 117        RGB_MATRIX_MULTISPLASH,
 118    #endif
 119    #ifndef DISABLE_RGB_MATRIX_SOLID_SPLASH
 120        RGB_MATRIX_SOLID_SPLASH,
 121    #endif
 122    #ifndef DISABLE_RGB_MATRIX_SOLID_MULTISPLASH
 123        RGB_MATRIX_SOLID_MULTISPLASH,
 124    #endif
 125 #endif
 126     RGB_MATRIX_EFFECT_MAX
 127 };
 128
 129 void rgb_matrix_set_color( int index, uint8_t red, uint8_t green, uint8_t blue );
 130 void rgb_matrix_set_color_all( uint8_t red, uint8_t green, uint8_t blue );
 131
 132 // This runs after another backlight effect and replaces
 133 // colors already set
 134 void rgb_matrix_indicators(void);
 135 void rgb_matrix_indicators_kb(void);
 136 void rgb_matrix_indicators_user(void);
 137
 138 void rgb_matrix_init(void);
 139 void rgb_matrix_setup_drivers(void);
 140
 141 void rgb_matrix_set_suspend_state(bool state);
 142 void rgb_matrix_set_indicator_state(uint8_t state);
 143
 144
 145 void rgb_matrix_task(void);
 146
 147 // This should not be called from an interrupt
 148 // (eg. from a timer interrupt).
 149 // Call this while idle (in between matrix scans).
 150 // If the buffer is dirty, it will update the driver with the buffer.
 151 void rgb_matrix_update_pwm_buffers(void);
 152
 153 bool process_rgb_matrix(uint16_t keycode, keyrecord_t *record);
 154
 155 void rgb_matrix_increase(void);
 156 void rgb_matrix_decrease(void);
 157
 158 // void *backlight_get_key_color_eeprom_address(uint8_t led);
 159 // void backlight_get_key_color( uint8_t led, HSV *hsv );
 160 // void backlight_set_key_color( uint8_t row, uint8_t column, HSV hsv );
 161
 162 uint32_t rgb_matrix_get_tick(void);
 163
 164 void rgb_matrix_toggle(void);
 165 void rgb_matrix_enable(void);
 166 void rgb_matrix_enable_noeeprom(void);
 167 void rgb_matrix_disable(void);
 168 void rgb_matrix_disable_noeeprom(void);
 169 void rgb_matrix_step(void);
 170 void rgb_matrix_sethsv(uint16_t hue, uint8_t sat, uint8_t val);
 171 void rgb_matrix_sethsv_noeeprom(uint16_t hue, uint8_t sat, uint8_t val);
 172 void rgb_matrix_step_reverse(void);
 173 void rgb_matrix_increase_hue(void);
 174 void rgb_matrix_decrease_hue(void);
 175 void rgb_matrix_increase_sat(void);
 176 void rgb_matrix_decrease_sat(void);
 177 void rgb_matrix_increase_val(void);
 178 void rgb_matrix_decrease_val(void);
 179 void rgb_matrix_increase_speed(void);
 180 void rgb_matrix_decrease_speed(void);
 181 void rgb_matrix_mode(uint8_t mode);
 182 void rgb_matrix_mode_noeeprom(uint8_t mode);
 183 uint8_t rgb_matrix_get_mode(void);
 184
 185 #ifndef RGBLIGHT_ENABLE
 186 #define rgblight_toggle() rgb_matrix_toggle()
 187 #define rgblight_enable() rgb_matrix_enable()
 188 #define rgblight_enable_noeeprom() rgb_matrix_enable_noeeprom()
 189 #define rgblight_disable() rgb_matrix_disable()
 190 #define rgblight_disable_noeeprom() rgb_matrix_disable_noeeprom()
 191 #define rgblight_step() rgb_matrix_step()
 192 #define rgblight_sethsv(hue, sat, val) rgb_matrix_sethsv(hue, sat, val)
 193 #define rgblight_sethsv_noeeprom(hue, sat, val) rgb_matrix_sethsv_noeeprom(hue, sat, val)
 194 #define rgblight_step_reverse() rgb_matrix_step_reverse()
 195 #define rgblight_increase_hue() rgb_matrix_increase_hue()
 196 #define rgblight_decrease_hue() rgb_matrix_decrease_hue()
 197 #define rgblight_increase_sat() rgb_matrix_increase_sat()
 198 #define rgblight_decrease_sat() rgb_matrix_decrease_sat()
 199 #define rgblight_increase_val() rgb_matrix_increase_val()
 200 #define rgblight_decrease_val() rgb_matrix_decrease_val()
 201 #define rgblight_increase_speed() rgb_matrix_increase_speed()
 202 #define rgblight_decrease_speed() rgb_matrix_decrease_speed()
 203 #define rgblight_mode(mode) rgb_matrix_mode(mode)
 204 #define rgblight_mode_noeeprom(mode) rgb_matrix_mode_noeeprom(mode)
 205 #define rgblight_get_mode() rgb_matrix_get_mode()
 206
 207 #endif
 208
 209 typedef struct {
 210     /* Perform any initialisation required for the other driver functions to work. */
 211     void (*init)(void);
 212
 213     /* Set the colour of a single LED in the buffer. */
 214     void (*set_color)(int index, uint8_t r, uint8_t g, uint8_t b);
 215     /* Set the colour of all LEDS on the keyboard in the buffer. */
 216     void (*set_color_all)(uint8_t r, uint8_t g, uint8_t b);
 217     /* Flush any buffered changes to the hardware. */
 218     void (*flush)(void);
 219 } rgb_matrix_driver_t;
 220
 221 extern const rgb_matrix_driver_t rgb_matrix_driver;
 222
 223 #endif