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 extern const rgb_led g_rgb_leds[DRIVER_LED_TOTAL];
  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 #ifndef DISABLE_RGB_MATRIX_DIGITAL_RAIN
 105   RGB_MATRIX_DIGITAL_RAIN,
 106 #endif // DISABLE_RGB_MATRIX_DIGITAL_RAIN
 107 #ifdef RGB_MATRIX_KEYREACTIVE_ENABLED
 108 #ifndef DISABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
 109   RGB_MATRIX_SOLID_REACTIVE_SIMPLE,
 110 #endif // DISABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
 111 #ifndef DISABLE_RGB_MATRIX_SOLID_REACTIVE
 112   RGB_MATRIX_SOLID_REACTIVE,
 113 #endif // DISABLE_RGB_MATRIX_SOLID_REACTIVE
 114 #ifndef DISABLE_RGB_MATRIX_SPLASH
 115   RGB_MATRIX_SPLASH,
 116 #endif // DISABLE_RGB_MATRIX_SPLASH
 117 #ifndef DISABLE_RGB_MATRIX_MULTISPLASH
 118   RGB_MATRIX_MULTISPLASH,
 119 #endif // DISABLE_RGB_MATRIX_MULTISPLASH
 120 #ifndef DISABLE_RGB_MATRIX_SOLID_SPLASH
 121   RGB_MATRIX_SOLID_SPLASH,
 122 #endif // DISABLE_RGB_MATRIX_SOLID_SPLASH
 123 #ifndef DISABLE_RGB_MATRIX_SOLID_MULTISPLASH
 124   RGB_MATRIX_SOLID_MULTISPLASH,
 125 #endif // DISABLE_RGB_MATRIX_SOLID_MULTISPLASH
 126 #endif // RGB_MATRIX_KEYREACTIVE_ENABLED
 127   RGB_MATRIX_EFFECT_MAX
 128 };
 129
 130 uint8_t rgb_matrix_map_row_column_to_led( uint8_t row, uint8_t column, uint8_t *led_i);
 131
 132 void rgb_matrix_set_color( int index, uint8_t red, uint8_t green, uint8_t blue );
 133 void rgb_matrix_set_color_all( uint8_t red, uint8_t green, uint8_t blue );
 134
 135 // This runs after another backlight effect and replaces
 136 // colors already set
 137 void rgb_matrix_indicators(void);
 138 void rgb_matrix_indicators_kb(void);
 139 void rgb_matrix_indicators_user(void);
 140
 141 void rgb_matrix_init(void);
 142 void rgb_matrix_setup_drivers(void);
 143
 144 void rgb_matrix_set_suspend_state(bool state);
 145 void rgb_matrix_set_indicator_state(uint8_t state);
 146
 147
 148 void rgb_matrix_task(void);
 149
 150 // This should not be called from an interrupt
 151 // (eg. from a timer interrupt).
 152 // Call this while idle (in between matrix scans).
 153 // If the buffer is dirty, it will update the driver with the buffer.
 154 void rgb_matrix_update_pwm_buffers(void);
 155
 156 bool process_rgb_matrix(uint16_t keycode, keyrecord_t *record);
 157
 158 void rgb_matrix_increase(void);
 159 void rgb_matrix_decrease(void);
 160
 161 // void *backlight_get_key_color_eeprom_address(uint8_t led);
 162 // void backlight_get_key_color( uint8_t led, HSV *hsv );
 163 // void backlight_set_key_color( uint8_t row, uint8_t column, HSV hsv );
 164
 165 void rgb_matrix_toggle(void);
 166 void rgb_matrix_enable(void);
 167 void rgb_matrix_enable_noeeprom(void);
 168 void rgb_matrix_disable(void);
 169 void rgb_matrix_disable_noeeprom(void);
 170 void rgb_matrix_step(void);
 171 void rgb_matrix_sethsv(uint16_t hue, uint8_t sat, uint8_t val);
 172 void rgb_matrix_sethsv_noeeprom(uint16_t hue, uint8_t sat, uint8_t val);
 173 void rgb_matrix_step_reverse(void);
 174 void rgb_matrix_increase_hue(void);
 175 void rgb_matrix_decrease_hue(void);
 176 void rgb_matrix_increase_sat(void);
 177 void rgb_matrix_decrease_sat(void);
 178 void rgb_matrix_increase_val(void);
 179 void rgb_matrix_decrease_val(void);
 180 void rgb_matrix_increase_speed(void);
 181 void rgb_matrix_decrease_speed(void);
 182 void rgb_matrix_mode(uint8_t mode);
 183 void rgb_matrix_mode_noeeprom(uint8_t mode);
 184 uint8_t rgb_matrix_get_mode(void);
 185
 186 #ifndef RGBLIGHT_ENABLE
 187 #define rgblight_toggle() rgb_matrix_toggle()
 188 #define rgblight_enable() rgb_matrix_enable()
 189 #define rgblight_enable_noeeprom() rgb_matrix_enable_noeeprom()
 190 #define rgblight_disable() rgb_matrix_disable()
 191 #define rgblight_disable_noeeprom() rgb_matrix_disable_noeeprom()
 192 #define rgblight_step() rgb_matrix_step()
 193 #define rgblight_sethsv(hue, sat, val) rgb_matrix_sethsv(hue, sat, val)
 194 #define rgblight_sethsv_noeeprom(hue, sat, val) rgb_matrix_sethsv_noeeprom(hue, sat, val)
 195 #define rgblight_step_reverse() rgb_matrix_step_reverse()
 196 #define rgblight_increase_hue() rgb_matrix_increase_hue()
 197 #define rgblight_decrease_hue() rgb_matrix_decrease_hue()
 198 #define rgblight_increase_sat() rgb_matrix_increase_sat()
 199 #define rgblight_decrease_sat() rgb_matrix_decrease_sat()
 200 #define rgblight_increase_val() rgb_matrix_increase_val()
 201 #define rgblight_decrease_val() rgb_matrix_decrease_val()
 202 #define rgblight_increase_speed() rgb_matrix_increase_speed()
 203 #define rgblight_decrease_speed() rgb_matrix_decrease_speed()
 204 #define rgblight_mode(mode) rgb_matrix_mode(mode)
 205 #define rgblight_mode_noeeprom(mode) rgb_matrix_mode_noeeprom(mode)
 206 #define rgblight_get_mode() rgb_matrix_get_mode()
 207
 208 #endif
 209
 210 typedef struct {
 211     /* Perform any initialisation required for the other driver functions to work. */
 212     void (*init)(void);
 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