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 "rgb_matrix_types.h"
  25 #include "color.h"
  26 #include "quantum.h"
  27 #include "rgblight_list.h"
  28
  29 #ifdef IS31FL3731
  30   #include "is31fl3731.h"
  31 #elif defined (IS31FL3733)
  32   #include "is31fl3733.h"
  33 #elif defined (IS31FL3737)
  34   #include "is31fl3737.h"
  35 #elif defined (WS2812)
  36   #include "ws2812.h"
  37 #endif
  38
  39 #ifndef RGB_MATRIX_LED_FLUSH_LIMIT
  40   #define RGB_MATRIX_LED_FLUSH_LIMIT 16
  41 #endif
  42
  43 #ifndef RGB_MATRIX_LED_PROCESS_LIMIT
  44   #define RGB_MATRIX_LED_PROCESS_LIMIT (DRIVER_LED_TOTAL + 4) / 5
  45 #endif
  46
  47 #if defined(RGB_MATRIX_LED_PROCESS_LIMIT) && RGB_MATRIX_LED_PROCESS_LIMIT > 0 && RGB_MATRIX_LED_PROCESS_LIMIT < DRIVER_LED_TOTAL
  48 #define RGB_MATRIX_USE_LIMITS(min, max) uint8_t min = RGB_MATRIX_LED_PROCESS_LIMIT * params->iter; \
  49   uint8_t max = min + RGB_MATRIX_LED_PROCESS_LIMIT; \
  50   if (max > DRIVER_LED_TOTAL) \
  51     max = DRIVER_LED_TOTAL;
  52 #else
  53 #define RGB_MATRIX_USE_LIMITS(min, max) uint8_t min = 0; \
  54   uint8_t max = DRIVER_LED_TOTAL;
  55 #endif
  56
  57 #define RGB_MATRIX_TEST_LED_FLAGS() if (!HAS_ANY_FLAGS(g_led_config.flags[i], params->flags)) continue
  58
  59 typedef struct
  60 {
  61         HSV color;
  62         uint8_t index;
  63 } rgb_indicator;
  64
  65 enum rgb_matrix_effects {
  66   RGB_MATRIX_NONE = 0,
  67         RGB_MATRIX_SOLID_COLOR = 1,
  68 #ifndef DISABLE_RGB_MATRIX_ALPHAS_MODS
  69   RGB_MATRIX_ALPHAS_MODS,
  70 #endif // DISABLE_RGB_MATRIX_ALPHAS_MODS
  71 #ifndef DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN
  72   RGB_MATRIX_GRADIENT_UP_DOWN,
  73 #endif // DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN
  74 #ifndef DISABLE_RGB_MATRIX_BREATHING
  75   RGB_MATRIX_BREATHING,
  76 #endif // DISABLE_RGB_MATRIX_BREATHING
  77 #ifndef DISABLE_RGB_MATRIX_CYCLE_ALL
  78   RGB_MATRIX_CYCLE_ALL,
  79 #endif // DISABLE_RGB_MATRIX_CYCLE_ALL
  80 #ifndef DISABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
  81   RGB_MATRIX_CYCLE_LEFT_RIGHT,
  82 #endif // DISABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
  83 #ifndef DISABLE_RGB_MATRIX_CYCLE_UP_DOWN
  84   RGB_MATRIX_CYCLE_UP_DOWN,
  85 #endif // DISABLE_RGB_MATRIX_CYCLE_UP_DOWN
  86 #ifndef DISABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
  87   RGB_MATRIX_RAINBOW_MOVING_CHEVRON,
  88 #endif // DISABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
  89 #ifndef DISABLE_RGB_MATRIX_DUAL_BEACON
  90   RGB_MATRIX_DUAL_BEACON,
  91 #endif // DISABLE_RGB_MATRIX_DUAL_BEACON
  92 #ifndef DISABLE_RGB_MATRIX_RAINBOW_BEACON
  93   RGB_MATRIX_RAINBOW_BEACON,
  94 #endif // DISABLE_RGB_MATRIX_RAINBOW_BEACON
  95 #ifndef DISABLE_RGB_MATRIX_RAINBOW_PINWHEELS
  96   RGB_MATRIX_RAINBOW_PINWHEELS,
  97 #endif // DISABLE_RGB_MATRIX_RAINBOW_PINWHEELS
  98 #ifndef DISABLE_RGB_MATRIX_RAINDROPS
  99   RGB_MATRIX_RAINDROPS,
 100 #endif // DISABLE_RGB_MATRIX_RAINDROPS
 101 #ifndef DISABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS
 102   RGB_MATRIX_JELLYBEAN_RAINDROPS,
 103 #endif // DISABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS
 104 #ifdef RGB_MATRIX_FRAMEBUFFER_EFFECTS
 105 #ifndef DISABLE_RGB_MATRIX_TYPING_HEATMAP
 106   RGB_MATRIX_TYPING_HEATMAP,
 107 #endif // DISABLE_RGB_MATRIX_TYPING_HEATMAP
 108 #ifndef DISABLE_RGB_MATRIX_DIGITAL_RAIN
 109   RGB_MATRIX_DIGITAL_RAIN,
 110 #endif // DISABLE_RGB_MATRIX_DIGITAL_RAIN
 111 #endif // RGB_MATRIX_FRAMEBUFFER_EFFECTS
 112 #ifdef RGB_MATRIX_KEYREACTIVE_ENABLED
 113 #ifndef DISABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
 114   RGB_MATRIX_SOLID_REACTIVE_SIMPLE,
 115 #endif // DISABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
 116 #ifndef DISABLE_RGB_MATRIX_SOLID_REACTIVE
 117   RGB_MATRIX_SOLID_REACTIVE,
 118 #endif // DISABLE_RGB_MATRIX_SOLID_REACTIVE
 119 #ifndef DISABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE
 120   RGB_MATRIX_SOLID_REACTIVE_WIDE,
 121 #endif // DISABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE
 122 #ifndef DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
 123   RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE,
 124 #endif // DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
 125 #ifndef DISABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
 126   RGB_MATRIX_SOLID_REACTIVE_CROSS,
 127 #endif // DISABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
 128 #ifndef DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
 129   RGB_MATRIX_SOLID_REACTIVE_MULTICROSS,
 130 #endif // DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
 131 #ifndef DISABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
 132   RGB_MATRIX_SOLID_REACTIVE_NEXUS,
 133 #endif // DISABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
 134 #ifndef DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
 135   RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS,
 136 #endif // DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
 137 #ifndef DISABLE_RGB_MATRIX_SPLASH
 138   RGB_MATRIX_SPLASH,
 139 #endif // DISABLE_RGB_MATRIX_SPLASH
 140 #ifndef DISABLE_RGB_MATRIX_MULTISPLASH
 141   RGB_MATRIX_MULTISPLASH,
 142 #endif // DISABLE_RGB_MATRIX_MULTISPLASH
 143 #ifndef DISABLE_RGB_MATRIX_SOLID_SPLASH
 144   RGB_MATRIX_SOLID_SPLASH,
 145 #endif // DISABLE_RGB_MATRIX_SOLID_SPLASH
 146 #ifndef DISABLE_RGB_MATRIX_SOLID_MULTISPLASH
 147   RGB_MATRIX_SOLID_MULTISPLASH,
 148 #endif // DISABLE_RGB_MATRIX_SOLID_MULTISPLASH
 149 #endif // RGB_MATRIX_KEYREACTIVE_ENABLED
 150
 151 #if defined(RGB_MATRIX_CUSTOM_KB) || defined(RGB_MATRIX_CUSTOM_USER)
 152   #define RGB_MATRIX_EFFECT(name, ...) RGB_MATRIX_CUSTOM_##name,
 153   #ifdef RGB_MATRIX_CUSTOM_KB
 154     #include "rgb_matrix_kb.inc"
 155   #endif
 156   #ifdef RGB_MATRIX_CUSTOM_USER
 157     #include "rgb_matrix_user.inc"
 158   #endif
 159   #undef RGB_MATRIX_EFFECT
 160 #endif
 161
 162   RGB_MATRIX_EFFECT_MAX
 163 };
 164
 165 uint8_t rgb_matrix_map_row_column_to_led( uint8_t row, uint8_t column, uint8_t *led_i);
 166
 167 void rgb_matrix_set_color( int index, uint8_t red, uint8_t green, uint8_t blue );
 168 void rgb_matrix_set_color_all( uint8_t red, uint8_t green, uint8_t blue );
 169
 170 // This runs after another backlight effect and replaces
 171 // colors already set
 172 void rgb_matrix_indicators(void);
 173 void rgb_matrix_indicators_kb(void);
 174 void rgb_matrix_indicators_user(void);
 175
 176 void rgb_matrix_init(void);
 177 void rgb_matrix_setup_drivers(void);
 178
 179 void rgb_matrix_set_suspend_state(bool state);
 180 void rgb_matrix_set_indicator_state(uint8_t state);
 181
 182
 183 void rgb_matrix_task(void);
 184
 185 // This should not be called from an interrupt
 186 // (eg. from a timer interrupt).
 187 // Call this while idle (in between matrix scans).
 188 // If the buffer is dirty, it will update the driver with the buffer.
 189 void rgb_matrix_update_pwm_buffers(void);
 190
 191 bool process_rgb_matrix(uint16_t keycode, keyrecord_t *record);
 192
 193 void rgb_matrix_increase(void);
 194 void rgb_matrix_decrease(void);
 195
 196 // void *backlight_get_key_color_eeprom_address(uint8_t led);
 197 // void backlight_get_key_color( uint8_t led, HSV *hsv );
 198 // void backlight_set_key_color( uint8_t row, uint8_t column, HSV hsv );
 199
 200 void rgb_matrix_toggle(void);
 201 void rgb_matrix_enable(void);
 202 void rgb_matrix_enable_noeeprom(void);
 203 void rgb_matrix_disable(void);
 204 void rgb_matrix_disable_noeeprom(void);
 205 void rgb_matrix_step(void);
 206 void rgb_matrix_sethsv(uint16_t hue, uint8_t sat, uint8_t val);
 207 void rgb_matrix_sethsv_noeeprom(uint16_t hue, uint8_t sat, uint8_t val);
 208 void rgb_matrix_step_reverse(void);
 209 void rgb_matrix_increase_hue(void);
 210 void rgb_matrix_decrease_hue(void);
 211 void rgb_matrix_increase_sat(void);
 212 void rgb_matrix_decrease_sat(void);
 213 void rgb_matrix_increase_val(void);
 214 void rgb_matrix_decrease_val(void);
 215 void rgb_matrix_increase_speed(void);
 216 void rgb_matrix_decrease_speed(void);
 217 led_flags_t rgb_matrix_get_flags(void);
 218 void rgb_matrix_set_flags(led_flags_t flags);
 219 void rgb_matrix_mode(uint8_t mode);
 220 void rgb_matrix_mode_noeeprom(uint8_t mode);
 221 uint8_t rgb_matrix_get_mode(void);
 222
 223 #ifndef RGBLIGHT_ENABLE
 224 #define rgblight_toggle() rgb_matrix_toggle()
 225 #define rgblight_enable() rgb_matrix_enable()
 226 #define rgblight_enable_noeeprom() rgb_matrix_enable_noeeprom()
 227 #define rgblight_disable() rgb_matrix_disable()
 228 #define rgblight_disable_noeeprom() rgb_matrix_disable_noeeprom()
 229 #define rgblight_step() rgb_matrix_step()
 230 #define rgblight_sethsv(hue, sat, val) rgb_matrix_sethsv(hue, sat, val)
 231 #define rgblight_sethsv_noeeprom(hue, sat, val) rgb_matrix_sethsv_noeeprom(hue, sat, val)
 232 #define rgblight_step_reverse() rgb_matrix_step_reverse()
 233 #define rgblight_increase_hue() rgb_matrix_increase_hue()
 234 #define rgblight_decrease_hue() rgb_matrix_decrease_hue()
 235 #define rgblight_increase_sat() rgb_matrix_increase_sat()
 236 #define rgblight_decrease_sat() rgb_matrix_decrease_sat()
 237 #define rgblight_increase_val() rgb_matrix_increase_val()
 238 #define rgblight_decrease_val() rgb_matrix_decrease_val()
 239 #define rgblight_increase_speed() rgb_matrix_increase_speed()
 240 #define rgblight_decrease_speed() rgb_matrix_decrease_speed()
 241 #define rgblight_mode(mode) rgb_matrix_mode(mode)
 242 #define rgblight_mode_noeeprom(mode) rgb_matrix_mode_noeeprom(mode)
 243 #define rgblight_get_mode() rgb_matrix_get_mode()
 244
 245 #endif
 246
 247 typedef struct {
 248     /* Perform any initialisation required for the other driver functions to work. */
 249     void (*init)(void);
 250     /* Set the colour of a single LED in the buffer. */
 251     void (*set_color)(int index, uint8_t r, uint8_t g, uint8_t b);
 252     /* Set the colour of all LEDS on the keyboard in the buffer. */
 253     void (*set_color_all)(uint8_t r, uint8_t g, uint8_t b);
 254     /* Flush any buffered changes to the hardware. */
 255     void (*flush)(void);
 256 } rgb_matrix_driver_t;
 257
 258 extern const rgb_matrix_driver_t rgb_matrix_driver;
 259
 260 #endif