1 /* Copyright 2017 Jason Williams
2 * Copyright 2017 Jack Humbert
3 * Copyright 2018 Yiancar
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.
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.
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/>.
24 #include "rgb_matrix_types.h"
27 #include "rgblight_list.h"
30 #include "is31fl3731.h"
31 #elif defined (IS31FL3733)
32 #include "is31fl3733.h"
33 #elif defined (IS31FL3737)
34 #include "is31fl3737.h"
35 #elif defined (WS2812)
39 #ifndef RGB_MATRIX_LED_FLUSH_LIMIT
40 #define RGB_MATRIX_LED_FLUSH_LIMIT 16
43 #ifndef RGB_MATRIX_LED_PROCESS_LIMIT
44 #define RGB_MATRIX_LED_PROCESS_LIMIT (DRIVER_LED_TOTAL + 4) / 5
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;
53 #define RGB_MATRIX_USE_LIMITS(min, max) uint8_t min = 0; \
54 uint8_t max = DRIVER_LED_TOTAL;
57 extern const rgb_led g_rgb_leds
[DRIVER_LED_TOTAL
];
65 enum rgb_matrix_effects
{
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
76 #endif // DISABLE_RGB_MATRIX_BREATHING
77 #ifndef DISABLE_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
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_SOLID_REACTIVE_WIDE
115 RGB_MATRIX_SOLID_REACTIVE_WIDE
,
116 #endif // DISABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE
117 #ifndef DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
118 RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
,
119 #endif // DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
120 #ifndef DISABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
121 RGB_MATRIX_SOLID_REACTIVE_CROSS
,
122 #endif // DISABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
123 #ifndef DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
124 RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
,
125 #endif // DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
126 #ifndef DISABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
127 RGB_MATRIX_SOLID_REACTIVE_NEXUS
,
128 #endif // DISABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
129 #ifndef DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
130 RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
,
131 #endif // DISABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
132 #ifndef DISABLE_RGB_MATRIX_SPLASH
134 #endif // DISABLE_RGB_MATRIX_SPLASH
135 #ifndef DISABLE_RGB_MATRIX_MULTISPLASH
136 RGB_MATRIX_MULTISPLASH
,
137 #endif // DISABLE_RGB_MATRIX_MULTISPLASH
138 #ifndef DISABLE_RGB_MATRIX_SOLID_SPLASH
139 RGB_MATRIX_SOLID_SPLASH
,
140 #endif // DISABLE_RGB_MATRIX_SOLID_SPLASH
141 #ifndef DISABLE_RGB_MATRIX_SOLID_MULTISPLASH
142 RGB_MATRIX_SOLID_MULTISPLASH
,
143 #endif // DISABLE_RGB_MATRIX_SOLID_MULTISPLASH
144 #endif // RGB_MATRIX_KEYREACTIVE_ENABLED
146 #if defined(RGB_MATRIX_CUSTOM_KB) || defined(RGB_MATRIX_CUSTOM_USER)
147 #define RGB_MATRIX_EFFECT(name, ...) RGB_MATRIX_CUSTOM_##name,
148 #ifdef RGB_MATRIX_CUSTOM_KB
149 #include "rgb_matrix_kb.inc"
151 #ifdef RGB_MATRIX_CUSTOM_USER
152 #include "rgb_matrix_user.inc"
154 #undef RGB_MATRIX_EFFECT
157 RGB_MATRIX_EFFECT_MAX
160 uint8_t rgb_matrix_map_row_column_to_led( uint8_t row
, uint8_t column
, uint8_t *led_i
);
162 void rgb_matrix_set_color( int index
, uint8_t red
, uint8_t green
, uint8_t blue
);
163 void rgb_matrix_set_color_all( uint8_t red
, uint8_t green
, uint8_t blue
);
165 // This runs after another backlight effect and replaces
166 // colors already set
167 void rgb_matrix_indicators(void);
168 void rgb_matrix_indicators_kb(void);
169 void rgb_matrix_indicators_user(void);
171 void rgb_matrix_init(void);
172 void rgb_matrix_setup_drivers(void);
174 void rgb_matrix_set_suspend_state(bool state
);
175 void rgb_matrix_set_indicator_state(uint8_t state
);
178 void rgb_matrix_task(void);
180 // This should not be called from an interrupt
181 // (eg. from a timer interrupt).
182 // Call this while idle (in between matrix scans).
183 // If the buffer is dirty, it will update the driver with the buffer.
184 void rgb_matrix_update_pwm_buffers(void);
186 bool process_rgb_matrix(uint16_t keycode
, keyrecord_t
*record
);
188 void rgb_matrix_increase(void);
189 void rgb_matrix_decrease(void);
191 // void *backlight_get_key_color_eeprom_address(uint8_t led);
192 // void backlight_get_key_color( uint8_t led, HSV *hsv );
193 // void backlight_set_key_color( uint8_t row, uint8_t column, HSV hsv );
195 void rgb_matrix_toggle(void);
196 void rgb_matrix_enable(void);
197 void rgb_matrix_enable_noeeprom(void);
198 void rgb_matrix_disable(void);
199 void rgb_matrix_disable_noeeprom(void);
200 void rgb_matrix_step(void);
201 void rgb_matrix_sethsv(uint16_t hue
, uint8_t sat
, uint8_t val
);
202 void rgb_matrix_sethsv_noeeprom(uint16_t hue
, uint8_t sat
, uint8_t val
);
203 void rgb_matrix_step_reverse(void);
204 void rgb_matrix_increase_hue(void);
205 void rgb_matrix_decrease_hue(void);
206 void rgb_matrix_increase_sat(void);
207 void rgb_matrix_decrease_sat(void);
208 void rgb_matrix_increase_val(void);
209 void rgb_matrix_decrease_val(void);
210 void rgb_matrix_increase_speed(void);
211 void rgb_matrix_decrease_speed(void);
212 void rgb_matrix_mode(uint8_t mode
);
213 void rgb_matrix_mode_noeeprom(uint8_t mode
);
214 uint8_t rgb_matrix_get_mode(void);
216 #ifndef RGBLIGHT_ENABLE
217 #define rgblight_toggle() rgb_matrix_toggle()
218 #define rgblight_enable() rgb_matrix_enable()
219 #define rgblight_enable_noeeprom() rgb_matrix_enable_noeeprom()
220 #define rgblight_disable() rgb_matrix_disable()
221 #define rgblight_disable_noeeprom() rgb_matrix_disable_noeeprom()
222 #define rgblight_step() rgb_matrix_step()
223 #define rgblight_sethsv(hue, sat, val) rgb_matrix_sethsv(hue, sat, val)
224 #define rgblight_sethsv_noeeprom(hue, sat, val) rgb_matrix_sethsv_noeeprom(hue, sat, val)
225 #define rgblight_step_reverse() rgb_matrix_step_reverse()
226 #define rgblight_increase_hue() rgb_matrix_increase_hue()
227 #define rgblight_decrease_hue() rgb_matrix_decrease_hue()
228 #define rgblight_increase_sat() rgb_matrix_increase_sat()
229 #define rgblight_decrease_sat() rgb_matrix_decrease_sat()
230 #define rgblight_increase_val() rgb_matrix_increase_val()
231 #define rgblight_decrease_val() rgb_matrix_decrease_val()
232 #define rgblight_increase_speed() rgb_matrix_increase_speed()
233 #define rgblight_decrease_speed() rgb_matrix_decrease_speed()
234 #define rgblight_mode(mode) rgb_matrix_mode(mode)
235 #define rgblight_mode_noeeprom(mode) rgb_matrix_mode_noeeprom(mode)
236 #define rgblight_get_mode() rgb_matrix_get_mode()
241 /* Perform any initialisation required for the other driver functions to work. */
243 /* Set the colour of a single LED in the buffer. */
244 void (*set_color
)(int index
, uint8_t r
, uint8_t g
, uint8_t b
);
245 /* Set the colour of all LEDS on the keyboard in the buffer. */
246 void (*set_color_all
)(uint8_t r
, uint8_t g
, uint8_t b
);
247 /* Flush any buffered changes to the hardware. */
249 } rgb_matrix_driver_t
;
251 extern const rgb_matrix_driver_t rgb_matrix_driver
;