rgb_matrix.h
10323 bytes
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#pragma once
20
21#include <stdint.h>
22#include <stdbool.h>
23#include "rgb_matrix_types.h"
24#include "rgb_matrix_drivers.h"
25#include "color.h"
26#include "keyboard.h"
27
28#ifndef RGB_MATRIX_TIMEOUT
29# define RGB_MATRIX_TIMEOUT 0
30#endif
31
32#ifndef RGB_MATRIX_MAXIMUM_BRIGHTNESS
33# define RGB_MATRIX_MAXIMUM_BRIGHTNESS UINT8_MAX
34#endif
35
36#ifndef RGB_MATRIX_HUE_STEP
37# define RGB_MATRIX_HUE_STEP 8
38#endif
39
40#ifndef RGB_MATRIX_SAT_STEP
41# define RGB_MATRIX_SAT_STEP 16
42#endif
43
44#ifndef RGB_MATRIX_VAL_STEP
45# define RGB_MATRIX_VAL_STEP 16
46#endif
47
48#ifndef RGB_MATRIX_SPD_STEP
49# define RGB_MATRIX_SPD_STEP 16
50#endif
51
52#ifndef RGB_MATRIX_DEFAULT_ON
53# define RGB_MATRIX_DEFAULT_ON true
54#endif
55
56#ifndef RGB_MATRIX_DEFAULT_MODE
57# ifdef ENABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
58# define RGB_MATRIX_DEFAULT_MODE RGB_MATRIX_CYCLE_LEFT_RIGHT
59# else
60// fallback to solid colors if RGB_MATRIX_CYCLE_LEFT_RIGHT is disabled in userspace
61# define RGB_MATRIX_DEFAULT_MODE RGB_MATRIX_SOLID_COLOR
62# endif
63#endif
64
65#ifndef RGB_MATRIX_DEFAULT_HUE
66# define RGB_MATRIX_DEFAULT_HUE 0
67#endif
68
69#ifndef RGB_MATRIX_DEFAULT_SAT
70# define RGB_MATRIX_DEFAULT_SAT UINT8_MAX
71#endif
72
73#ifndef RGB_MATRIX_DEFAULT_VAL
74# define RGB_MATRIX_DEFAULT_VAL RGB_MATRIX_MAXIMUM_BRIGHTNESS
75#endif
76
77#ifndef RGB_MATRIX_DEFAULT_SPD
78# define RGB_MATRIX_DEFAULT_SPD UINT8_MAX / 2
79#endif
80
81#ifndef RGB_MATRIX_DEFAULT_FLAGS
82# define RGB_MATRIX_DEFAULT_FLAGS LED_FLAG_ALL
83#endif
84
85#ifndef RGB_MATRIX_LED_FLUSH_LIMIT
86# define RGB_MATRIX_LED_FLUSH_LIMIT 16
87#endif
88
89#ifndef RGB_MATRIX_LED_PROCESS_LIMIT
90# define RGB_MATRIX_LED_PROCESS_LIMIT ((RGB_MATRIX_LED_COUNT + 4) / 5)
91#endif
92
93struct rgb_matrix_limits_t {
94 uint8_t led_min_index;
95 uint8_t led_max_index;
96};
97
98struct rgb_matrix_limits_t rgb_matrix_get_limits(uint8_t iter);
99
100#define RGB_MATRIX_USE_LIMITS_ITER(min, max, iter) \
101 struct rgb_matrix_limits_t limits = rgb_matrix_get_limits(iter); \
102 uint8_t min = limits.led_min_index; \
103 uint8_t max = limits.led_max_index; \
104 (void)min; \
105 (void)max;
106
107#define RGB_MATRIX_USE_LIMITS(min, max) RGB_MATRIX_USE_LIMITS_ITER(min, max, params->iter)
108
109#define RGB_MATRIX_INDICATOR_SET_COLOR(i, r, g, b) \
110 if (i >= led_min && i < led_max) { \
111 rgb_matrix_set_color(i, r, g, b); \
112 }
113
114#define RGB_MATRIX_TEST_LED_FLAGS() \
115 if (!HAS_ANY_FLAGS(g_led_config.flags[i], params->flags)) continue
116
117enum rgb_matrix_effects {
118 RGB_MATRIX_NONE = 0,
119
120// --------------------------------------
121// -----Begin rgb effect enum macros-----
122#define RGB_MATRIX_EFFECT(name, ...) RGB_MATRIX_##name,
123#include "rgb_matrix_effects.inc"
124#undef RGB_MATRIX_EFFECT
125
126#if defined(RGB_MATRIX_CUSTOM_KB) || defined(RGB_MATRIX_CUSTOM_USER)
127# define RGB_MATRIX_EFFECT(name, ...) RGB_MATRIX_CUSTOM_##name,
128# ifdef RGB_MATRIX_CUSTOM_KB
129# include "rgb_matrix_kb.inc"
130# endif
131# ifdef RGB_MATRIX_CUSTOM_USER
132# include "rgb_matrix_user.inc"
133# endif
134# undef RGB_MATRIX_EFFECT
135#endif
136 // --------------------------------------
137 // -----End rgb effect enum macros-------
138
139 RGB_MATRIX_EFFECT_MAX
140};
141
142void eeconfig_update_rgb_matrix_default(void);
143void eeconfig_update_rgb_matrix(void);
144
145uint8_t rgb_matrix_map_row_column_to_led_kb(uint8_t row, uint8_t column, uint8_t *led_i);
146uint8_t rgb_matrix_map_row_column_to_led(uint8_t row, uint8_t column, uint8_t *led_i);
147
148int rgb_matrix_led_index(int index);
149
150void rgb_matrix_set_color(int index, uint8_t red, uint8_t green, uint8_t blue);
151void rgb_matrix_set_color_all(uint8_t red, uint8_t green, uint8_t blue);
152
153void rgb_matrix_handle_key_event(uint8_t row, uint8_t col, bool pressed);
154
155void rgb_matrix_task(void);
156
157// This runs after another backlight effect and replaces
158// colors already set
159void rgb_matrix_indicators(void);
160bool rgb_matrix_indicators_kb(void);
161bool rgb_matrix_indicators_user(void);
162
163void rgb_matrix_indicators_advanced(effect_params_t *params);
164bool rgb_matrix_indicators_advanced_kb(uint8_t led_min, uint8_t led_max);
165bool rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max);
166
167void rgb_matrix_init(void);
168
169void rgb_matrix_reload_from_eeprom(void);
170
171void rgb_matrix_set_suspend_state(bool state);
172bool rgb_matrix_get_suspend_state(void);
173void rgb_matrix_toggle(void);
174void rgb_matrix_toggle_noeeprom(void);
175void rgb_matrix_enable(void);
176void rgb_matrix_enable_noeeprom(void);
177void rgb_matrix_disable(void);
178void rgb_matrix_disable_noeeprom(void);
179uint8_t rgb_matrix_is_enabled(void);
180void rgb_matrix_mode(uint8_t mode);
181void rgb_matrix_mode_noeeprom(uint8_t mode);
182uint8_t rgb_matrix_get_mode(void);
183void rgb_matrix_step(void);
184void rgb_matrix_step_noeeprom(void);
185void rgb_matrix_step_reverse(void);
186void rgb_matrix_step_reverse_noeeprom(void);
187void rgb_matrix_sethsv(uint16_t hue, uint8_t sat, uint8_t val);
188void rgb_matrix_sethsv_noeeprom(uint16_t hue, uint8_t sat, uint8_t val);
189hsv_t rgb_matrix_get_hsv(void);
190uint8_t rgb_matrix_get_hue(void);
191uint8_t rgb_matrix_get_sat(void);
192uint8_t rgb_matrix_get_val(void);
193void rgb_matrix_increase_hue(void);
194void rgb_matrix_increase_hue_noeeprom(void);
195void rgb_matrix_decrease_hue(void);
196void rgb_matrix_decrease_hue_noeeprom(void);
197void rgb_matrix_increase_sat(void);
198void rgb_matrix_increase_sat_noeeprom(void);
199void rgb_matrix_decrease_sat(void);
200void rgb_matrix_decrease_sat_noeeprom(void);
201void rgb_matrix_increase_val(void);
202void rgb_matrix_increase_val_noeeprom(void);
203void rgb_matrix_decrease_val(void);
204void rgb_matrix_decrease_val_noeeprom(void);
205void rgb_matrix_set_speed(uint8_t speed);
206void rgb_matrix_set_speed_noeeprom(uint8_t speed);
207uint8_t rgb_matrix_get_speed(void);
208void rgb_matrix_increase_speed(void);
209void rgb_matrix_increase_speed_noeeprom(void);
210void rgb_matrix_decrease_speed(void);
211void rgb_matrix_decrease_speed_noeeprom(void);
212led_flags_t rgb_matrix_get_flags(void);
213void rgb_matrix_set_flags(led_flags_t flags);
214void rgb_matrix_set_flags_noeeprom(led_flags_t flags);
215void rgb_matrix_update_pwm_buffers(void);
216
217#ifndef RGBLIGHT_ENABLE
218# define eeconfig_update_rgblight_current eeconfig_update_rgb_matrix
219# define rgblight_reload_from_eeprom rgb_matrix_reload_from_eeprom
220# define rgblight_toggle rgb_matrix_toggle
221# define rgblight_toggle_noeeprom rgb_matrix_toggle_noeeprom
222# define rgblight_enable rgb_matrix_enable
223# define rgblight_enable_noeeprom rgb_matrix_enable_noeeprom
224# define rgblight_disable rgb_matrix_disable
225# define rgblight_disable_noeeprom rgb_matrix_disable_noeeprom
226# define rgblight_is_enabled rgb_matrix_is_enabled
227# define rgblight_mode rgb_matrix_mode
228# define rgblight_mode_noeeprom rgb_matrix_mode_noeeprom
229# define rgblight_get_mode rgb_matrix_get_mode
230# define rgblight_get_hue rgb_matrix_get_hue
231# define rgblight_get_sat rgb_matrix_get_sat
232# define rgblight_get_val rgb_matrix_get_val
233# define rgblight_get_hsv rgb_matrix_get_hsv
234# define rgblight_step rgb_matrix_step
235# define rgblight_step_noeeprom rgb_matrix_step_noeeprom
236# define rgblight_step_reverse rgb_matrix_step_reverse
237# define rgblight_step_reverse_noeeprom rgb_matrix_step_reverse_noeeprom
238# define rgblight_sethsv rgb_matrix_sethsv
239# define rgblight_sethsv_noeeprom rgb_matrix_sethsv_noeeprom
240# define rgblight_increase_hue rgb_matrix_increase_hue
241# define rgblight_increase_hue_noeeprom rgb_matrix_increase_hue_noeeprom
242# define rgblight_decrease_hue rgb_matrix_decrease_hue
243# define rgblight_decrease_hue_noeeprom rgb_matrix_decrease_hue_noeeprom
244# define rgblight_increase_sat rgb_matrix_increase_sat
245# define rgblight_increase_sat_noeeprom rgb_matrix_increase_sat_noeeprom
246# define rgblight_decrease_sat rgb_matrix_decrease_sat
247# define rgblight_decrease_sat_noeeprom rgb_matrix_decrease_sat_noeeprom
248# define rgblight_increase_val rgb_matrix_increase_val
249# define rgblight_increase_val_noeeprom rgb_matrix_increase_val_noeeprom
250# define rgblight_decrease_val rgb_matrix_decrease_val
251# define rgblight_decrease_val_noeeprom rgb_matrix_decrease_val_noeeprom
252# define rgblight_set_speed rgb_matrix_set_speed
253# define rgblight_set_speed_noeeprom rgb_matrix_set_speed_noeeprom
254# define rgblight_get_speed rgb_matrix_get_speed
255# define rgblight_increase_speed rgb_matrix_increase_speed
256# define rgblight_increase_speed_noeeprom rgb_matrix_increase_speed_noeeprom
257# define rgblight_decrease_speed rgb_matrix_decrease_speed
258# define rgblight_decrease_speed_noeeprom rgb_matrix_decrease_speed_noeeprom
259#endif
260
261static inline bool rgb_matrix_check_finished_leds(uint8_t led_idx) {
262#if defined(RGB_MATRIX_SPLIT)
263 if (is_keyboard_left()) {
264 uint8_t k_rgb_matrix_split[2] = RGB_MATRIX_SPLIT;
265 return led_idx < k_rgb_matrix_split[0];
266 } else
267 return led_idx < RGB_MATRIX_LED_COUNT;
268#else
269 return led_idx < RGB_MATRIX_LED_COUNT;
270#endif
271}
272
273extern rgb_config_t rgb_matrix_config;
274
275extern uint32_t g_rgb_timer;
276extern led_config_t g_led_config;
277#ifdef RGB_MATRIX_KEYREACTIVE_ENABLED
278extern last_hit_t g_last_hit_tracker;
279#endif
280#ifdef RGB_MATRIX_FRAMEBUFFER_EFFECTS
281extern uint8_t g_rgb_frame_buffer[MATRIX_ROWS][MATRIX_COLS];
282#endif