aboutsummaryrefslogtreecommitdiff
path: root/quantum/rgblight/rgblight.h
diff options
context:
space:
mode:
Diffstat (limited to 'quantum/rgblight/rgblight.h')
-rw-r--r--quantum/rgblight/rgblight.h434
1 files changed, 434 insertions, 0 deletions
diff --git a/quantum/rgblight/rgblight.h b/quantum/rgblight/rgblight.h
new file mode 100644
index 000000000..5b90b8f49
--- /dev/null
+++ b/quantum/rgblight/rgblight.h
@@ -0,0 +1,434 @@
1/* Copyright 2017 Yang Liu
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16
17#pragma once
18
19/***** rgblight_mode(mode)/rgblight_mode_noeeprom(mode) ****
20
21 old mode number (before 0.6.117) to new mode name table
22
23|-----------------|-----------------------------------|
24| old mode number | new mode name |
25|-----------------|-----------------------------------|
26| 1 | RGBLIGHT_MODE_STATIC_LIGHT |
27| 2 | RGBLIGHT_MODE_BREATHING |
28| 3 | RGBLIGHT_MODE_BREATHING + 1 |
29| 4 | RGBLIGHT_MODE_BREATHING + 2 |
30| 5 | RGBLIGHT_MODE_BREATHING + 3 |
31| 6 | RGBLIGHT_MODE_RAINBOW_MOOD |
32| 7 | RGBLIGHT_MODE_RAINBOW_MOOD + 1 |
33| 8 | RGBLIGHT_MODE_RAINBOW_MOOD + 2 |
34| 9 | RGBLIGHT_MODE_RAINBOW_SWIRL |
35| 10 | RGBLIGHT_MODE_RAINBOW_SWIRL + 1 |
36| 11 | RGBLIGHT_MODE_RAINBOW_SWIRL + 2 |
37| 12 | RGBLIGHT_MODE_RAINBOW_SWIRL + 3 |
38| 13 | RGBLIGHT_MODE_RAINBOW_SWIRL + 4 |
39| 14 | RGBLIGHT_MODE_RAINBOW_SWIRL + 5 |
40| 15 | RGBLIGHT_MODE_SNAKE |
41| 16 | RGBLIGHT_MODE_SNAKE + 1 |
42| 17 | RGBLIGHT_MODE_SNAKE + 2 |
43| 18 | RGBLIGHT_MODE_SNAKE + 3 |
44| 19 | RGBLIGHT_MODE_SNAKE + 4 |
45| 20 | RGBLIGHT_MODE_SNAKE + 5 |
46| 21 | RGBLIGHT_MODE_KNIGHT |
47| 22 | RGBLIGHT_MODE_KNIGHT + 1 |
48| 23 | RGBLIGHT_MODE_KNIGHT + 2 |
49| 24 | RGBLIGHT_MODE_CHRISTMAS |
50| 25 | RGBLIGHT_MODE_STATIC_GRADIENT |
51| 26 | RGBLIGHT_MODE_STATIC_GRADIENT + 1 |
52| 27 | RGBLIGHT_MODE_STATIC_GRADIENT + 2 |
53| 28 | RGBLIGHT_MODE_STATIC_GRADIENT + 3 |
54| 29 | RGBLIGHT_MODE_STATIC_GRADIENT + 4 |
55| 30 | RGBLIGHT_MODE_STATIC_GRADIENT + 5 |
56| 31 | RGBLIGHT_MODE_STATIC_GRADIENT + 6 |
57| 32 | RGBLIGHT_MODE_STATIC_GRADIENT + 7 |
58| 33 | RGBLIGHT_MODE_STATIC_GRADIENT + 8 |
59| 34 | RGBLIGHT_MODE_STATIC_GRADIENT + 9 |
60| 35 | RGBLIGHT_MODE_RGB_TEST |
61| 36 | RGBLIGHT_MODE_ALTERNATING |
62| 37 | RGBLIGHT_MODE_TWINKLE |
63| 38 | RGBLIGHT_MODE_TWINKLE + 1 |
64| 39 | RGBLIGHT_MODE_TWINKLE + 2 |
65| 40 | RGBLIGHT_MODE_TWINKLE + 3 |
66| 41 | RGBLIGHT_MODE_TWINKLE + 4 |
67| 42 | RGBLIGHT_MODE_TWINKLE + 5 |
68|-----------------|-----------------------------------|
69 *****/
70
71#ifdef RGBLIGHT_ANIMATIONS
72// for backward compatibility
73# define RGBLIGHT_EFFECT_BREATHING
74# define RGBLIGHT_EFFECT_RAINBOW_MOOD
75# define RGBLIGHT_EFFECT_RAINBOW_SWIRL
76# define RGBLIGHT_EFFECT_SNAKE
77# define RGBLIGHT_EFFECT_KNIGHT
78# define RGBLIGHT_EFFECT_CHRISTMAS
79# define RGBLIGHT_EFFECT_STATIC_GRADIENT
80# define RGBLIGHT_EFFECT_RGB_TEST
81# define RGBLIGHT_EFFECT_ALTERNATING
82#endif
83
84#ifdef RGBLIGHT_STATIC_PATTERNS
85# define RGBLIGHT_EFFECT_STATIC_GRADIENT
86#endif
87
88// clang-format off
89
90// check dynamic animation effects chose ?
91#if defined(RGBLIGHT_EFFECT_BREATHING) \
92 || defined(RGBLIGHT_EFFECT_RAINBOW_MOOD) \
93 || defined(RGBLIGHT_EFFECT_RAINBOW_SWIRL) \
94 || defined(RGBLIGHT_EFFECT_SNAKE) \
95 || defined(RGBLIGHT_EFFECT_KNIGHT) \
96 || defined(RGBLIGHT_EFFECT_CHRISTMAS) \
97 || defined(RGBLIGHT_EFFECT_RGB_TEST) \
98 || defined(RGBLIGHT_EFFECT_ALTERNATING) \
99 || defined(RGBLIGHT_EFFECT_TWINKLE)
100# define RGBLIGHT_USE_TIMER
101#endif
102
103// clang-format on
104
105#define _RGBM_SINGLE_STATIC(sym) RGBLIGHT_MODE_##sym,
106#define _RGBM_SINGLE_DYNAMIC(sym) RGBLIGHT_MODE_##sym,
107#define _RGBM_MULTI_STATIC(sym) RGBLIGHT_MODE_##sym,
108#define _RGBM_MULTI_DYNAMIC(sym) RGBLIGHT_MODE_##sym,
109#define _RGBM_TMP_STATIC(sym, msym) RGBLIGHT_MODE_##sym,
110#define _RGBM_TMP_DYNAMIC(sym, msym) RGBLIGHT_MODE_##sym,
111enum RGBLIGHT_EFFECT_MODE {
112 RGBLIGHT_MODE_zero = 0,
113#include "rgblight_modes.h"
114 RGBLIGHT_MODE_last
115};
116
117#define RGBLIGHT_MODES (RGBLIGHT_MODE_last - 1)
118
119// sample: #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85
120
121#ifndef RGBLIGHT_EFFECT_BREATHE_MAX
122# define RGBLIGHT_EFFECT_BREATHE_MAX 255 // 0-255
123#endif
124
125#ifndef RGBLIGHT_EFFECT_SNAKE_LENGTH
126# define RGBLIGHT_EFFECT_SNAKE_LENGTH 4
127#endif
128
129#ifndef RGBLIGHT_EFFECT_KNIGHT_LENGTH
130# define RGBLIGHT_EFFECT_KNIGHT_LENGTH 3
131#endif
132
133#ifndef RGBLIGHT_EFFECT_KNIGHT_OFFSET
134# define RGBLIGHT_EFFECT_KNIGHT_OFFSET 0
135#endif
136
137#ifndef RGBLIGHT_EFFECT_KNIGHT_LED_NUM
138# define RGBLIGHT_EFFECT_KNIGHT_LED_NUM (rgblight_ranges.effect_num_leds)
139#endif
140
141#ifndef RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL
142# define RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL 40
143#endif
144
145#ifndef RGBLIGHT_EFFECT_CHRISTMAS_STEP
146# define RGBLIGHT_EFFECT_CHRISTMAS_STEP 2
147#endif
148
149#ifndef RGBLIGHT_EFFECT_TWINKLE_LIFE
150# define RGBLIGHT_EFFECT_TWINKLE_LIFE 200
151#endif
152
153#ifndef RGBLIGHT_EFFECT_TWINKLE_PROBABILITY
154# define RGBLIGHT_EFFECT_TWINKLE_PROBABILITY 1 / 127
155#endif
156
157#ifndef RGBLIGHT_HUE_STEP
158# define RGBLIGHT_HUE_STEP 8
159#endif
160#ifndef RGBLIGHT_SAT_STEP
161# define RGBLIGHT_SAT_STEP 17
162#endif
163#ifndef RGBLIGHT_VAL_STEP
164# define RGBLIGHT_VAL_STEP 17
165#endif
166#ifndef RGBLIGHT_LIMIT_VAL
167# define RGBLIGHT_LIMIT_VAL 255
168#endif
169
170#include <stdint.h>
171#include <stdbool.h>
172#include "progmem.h"
173#include "eeconfig.h"
174#include "ws2812.h"
175#include "color.h"
176#include "rgblight_list.h"
177
178#ifdef RGBLIGHT_LAYERS
179typedef struct {
180 uint8_t index; // The first LED to light
181 uint8_t count; // The number of LEDs to light
182 uint8_t hue;
183 uint8_t sat;
184 uint8_t val;
185} rgblight_segment_t;
186
187# define RGBLIGHT_END_SEGMENT_INDEX (255)
188# define RGBLIGHT_END_SEGMENTS \
189 { RGBLIGHT_END_SEGMENT_INDEX, 0, 0, 0 }
190# ifndef RGBLIGHT_MAX_LAYERS
191# define RGBLIGHT_MAX_LAYERS 8
192# endif
193# if RGBLIGHT_MAX_LAYERS <= 0
194# error invalid RGBLIGHT_MAX_LAYERS value (must be >= 1)
195# elif RGBLIGHT_MAX_LAYERS <= 8
196typedef uint8_t rgblight_layer_mask_t;
197# elif RGBLIGHT_MAX_LAYERS <= 16
198typedef uint16_t rgblight_layer_mask_t;
199# elif RGBLIGHT_MAX_LAYERS <= 32
200typedef uint32_t rgblight_layer_mask_t;
201# else
202# error invalid RGBLIGHT_MAX_LAYERS value (must be <= 32)
203# endif
204# define RGBLIGHT_LAYER_SEGMENTS(...) \
205 { __VA_ARGS__, RGBLIGHT_END_SEGMENTS }
206# define RGBLIGHT_LAYERS_LIST(...) \
207 { __VA_ARGS__, NULL }
208
209// Get/set enabled rgblight layers
210void rgblight_set_layer_state(uint8_t layer, bool enabled);
211bool rgblight_get_layer_state(uint8_t layer);
212
213// Point this to an array of rgblight_segment_t arrays in keyboard_post_init_user to use rgblight layers
214extern const rgblight_segment_t *const *rgblight_layers;
215
216# ifdef RGBLIGHT_LAYER_BLINK
217# define RGBLIGHT_USE_TIMER
218void rgblight_blink_layer(uint8_t layer, uint16_t duration_ms);
219void rgblight_blink_layer_repeat(uint8_t layer, uint16_t duration_ms, uint8_t times);
220# endif
221
222#endif
223
224extern LED_TYPE led[RGBLED_NUM];
225
226extern const uint8_t RGBLED_BREATHING_INTERVALS[4] PROGMEM;
227extern const uint8_t RGBLED_RAINBOW_MOOD_INTERVALS[3] PROGMEM;
228extern const uint8_t RGBLED_RAINBOW_SWIRL_INTERVALS[3] PROGMEM;
229extern const uint8_t RGBLED_SNAKE_INTERVALS[3] PROGMEM;
230extern const uint8_t RGBLED_KNIGHT_INTERVALS[3] PROGMEM;
231extern const uint16_t RGBLED_RGBTEST_INTERVALS[1] PROGMEM;
232extern const uint8_t RGBLED_TWINKLE_INTERVALS[3] PROGMEM;
233extern bool is_rgblight_initialized;
234
235// Should stay in sycn with rgb matrix config as we reuse eeprom storage for both (for now)
236typedef union {
237 uint32_t raw;
238 struct {
239 bool enable : 1;
240 uint8_t mode : 7;
241 uint8_t hue : 8;
242 uint8_t sat : 8;
243 uint8_t val : 8;
244 uint8_t speed : 8; // EECONFIG needs to be increased to support this
245 };
246} rgblight_config_t;
247
248typedef struct _rgblight_status_t {
249 uint8_t base_mode;
250 bool timer_enabled;
251#ifdef RGBLIGHT_SPLIT
252 uint8_t change_flags;
253#endif
254#ifdef RGBLIGHT_LAYERS
255 rgblight_layer_mask_t enabled_layer_mask;
256#endif
257} rgblight_status_t;
258
259/*
260 * Structure for RGB Light clipping ranges
261 */
262typedef struct _rgblight_ranges_t {
263 uint8_t clipping_start_pos;
264 uint8_t clipping_num_leds;
265 uint8_t effect_start_pos;
266 uint8_t effect_end_pos;
267 uint8_t effect_num_leds;
268} rgblight_ranges_t;
269
270extern rgblight_ranges_t rgblight_ranges;
271
272/* === Utility Functions ===*/
273void sethsv(uint8_t hue, uint8_t sat, uint8_t val, LED_TYPE *led1);
274void sethsv_raw(uint8_t hue, uint8_t sat, uint8_t val, LED_TYPE *led1); // without RGBLIGHT_LIMIT_VAL check
275void setrgb(uint8_t r, uint8_t g, uint8_t b, LED_TYPE *led1);
276
277/* === Low level Functions === */
278void rgblight_set(void);
279void rgblight_set_clipping_range(uint8_t start_pos, uint8_t num_leds);
280
281/* === Effects and Animations Functions === */
282/* effect range setting */
283void rgblight_set_effect_range(uint8_t start_pos, uint8_t num_leds);
284
285/* direct operation */
286void rgblight_setrgb_at(uint8_t r, uint8_t g, uint8_t b, uint8_t index);
287void rgblight_sethsv_at(uint8_t hue, uint8_t sat, uint8_t val, uint8_t index);
288void rgblight_setrgb_range(uint8_t r, uint8_t g, uint8_t b, uint8_t start, uint8_t end);
289void rgblight_sethsv_range(uint8_t hue, uint8_t sat, uint8_t val, uint8_t start, uint8_t end);
290void rgblight_setrgb(uint8_t r, uint8_t g, uint8_t b);
291
292#ifndef RGBLIGHT_SPLIT
293void rgblight_setrgb_master(uint8_t r, uint8_t g, uint8_t b);
294void rgblight_setrgb_slave(uint8_t r, uint8_t g, uint8_t b);
295void rgblight_sethsv_master(uint8_t hue, uint8_t sat, uint8_t val);
296void rgblight_sethsv_slave(uint8_t hue, uint8_t sat, uint8_t val);
297#endif
298
299/* effect mode change */
300void rgblight_mode(uint8_t mode);
301void rgblight_mode_noeeprom(uint8_t mode);
302void rgblight_increase(void);
303void rgblight_decrease(void);
304void rgblight_step(void);
305void rgblight_step_noeeprom(void);
306void rgblight_step_reverse(void);
307void rgblight_step_reverse_noeeprom(void);
308
309/* effects mode disable/enable */
310void rgblight_toggle(void);
311void rgblight_toggle_noeeprom(void);
312void rgblight_enable(void);
313void rgblight_enable_noeeprom(void);
314void rgblight_disable(void);
315void rgblight_disable_noeeprom(void);
316
317/* hue, sat, val change */
318void rgblight_increase_hue(void);
319void rgblight_increase_hue_noeeprom(void);
320void rgblight_decrease_hue(void);
321void rgblight_decrease_hue_noeeprom(void);
322void rgblight_increase_sat(void);
323void rgblight_increase_sat_noeeprom(void);
324void rgblight_decrease_sat(void);
325void rgblight_decrease_sat_noeeprom(void);
326void rgblight_increase_val(void);
327void rgblight_increase_val_noeeprom(void);
328void rgblight_decrease_val(void);
329void rgblight_decrease_val_noeeprom(void);
330void rgblight_increase_speed(void);
331void rgblight_increase_speed_noeeprom(void);
332void rgblight_decrease_speed(void);
333void rgblight_decrease_speed_noeeprom(void);
334void rgblight_sethsv(uint8_t hue, uint8_t sat, uint8_t val);
335void rgblight_sethsv_noeeprom(uint8_t hue, uint8_t sat, uint8_t val);
336
337/* effect speed */
338uint8_t rgblight_get_speed(void);
339void rgblight_set_speed(uint8_t speed);
340void rgblight_set_speed_noeeprom(uint8_t speed);
341
342/* reset */
343void rgblight_reload_from_eeprom(void);
344
345/* query */
346uint8_t rgblight_get_mode(void);
347uint8_t rgblight_get_hue(void);
348uint8_t rgblight_get_sat(void);
349uint8_t rgblight_get_val(void);
350bool rgblight_is_enabled(void);
351HSV rgblight_get_hsv(void);
352
353/* === qmk_firmware (core)internal Functions === */
354void rgblight_init(void);
355void rgblight_suspend(void);
356void rgblight_wakeup(void);
357uint32_t rgblight_read_dword(void);
358void rgblight_update_dword(uint32_t dword);
359uint32_t eeconfig_read_rgblight(void);
360void eeconfig_update_rgblight(uint32_t val);
361void eeconfig_update_rgblight_current(void);
362void eeconfig_update_rgblight_default(void);
363void eeconfig_debug_rgblight(void);
364
365void rgb_matrix_increase(void);
366void rgb_matrix_decrease(void);
367
368void rgblight_sethsv_eeprom_helper(uint8_t hue, uint8_t sat, uint8_t val, bool write_to_eeprom);
369void rgblight_mode_eeprom_helper(uint8_t mode, bool write_to_eeprom);
370
371#define EZ_RGB(val) rgblight_show_solid_color((val >> 16) & 0xFF, (val >> 8) & 0xFF, val & 0xFF)
372void rgblight_show_solid_color(uint8_t r, uint8_t g, uint8_t b);
373
374#ifdef RGBLIGHT_USE_TIMER
375void rgblight_task(void);
376void rgblight_timer_init(void);
377void rgblight_timer_enable(void);
378void rgblight_timer_disable(void);
379void rgblight_timer_toggle(void);
380#else
381# define rgblight_task()
382# define rgblight_timer_init()
383# define rgblight_timer_enable()
384# define rgblight_timer_disable()
385# define rgblight_timer_toggle()
386#endif
387
388#ifdef RGBLIGHT_SPLIT
389# define RGBLIGHT_STATUS_CHANGE_MODE (1 << 0)
390# define RGBLIGHT_STATUS_CHANGE_HSVS (1 << 1)
391# define RGBLIGHT_STATUS_CHANGE_TIMER (1 << 2)
392# define RGBLIGHT_STATUS_ANIMATION_TICK (1 << 3)
393# define RGBLIGHT_STATUS_CHANGE_LAYERS (1 << 4)
394
395typedef struct _rgblight_syncinfo_t {
396 rgblight_config_t config;
397 rgblight_status_t status;
398} rgblight_syncinfo_t;
399
400/* for split keyboard master side */
401uint8_t rgblight_get_change_flags(void);
402void rgblight_clear_change_flags(void);
403void rgblight_get_syncinfo(rgblight_syncinfo_t *syncinfo);
404/* for split keyboard slave side */
405void rgblight_update_sync(rgblight_syncinfo_t *syncinfo, bool write_to_eeprom);
406#endif
407
408#ifdef RGBLIGHT_USE_TIMER
409
410typedef struct _animation_status_t {
411 uint16_t last_timer;
412 uint8_t delta; /* mode - base_mode */
413 bool restart;
414 union {
415 uint16_t pos16;
416 uint8_t pos;
417 int8_t current_hue;
418 uint16_t current_offset;
419 };
420} animation_status_t;
421
422extern animation_status_t animation_status;
423
424void rgblight_effect_breathing(animation_status_t *anim);
425void rgblight_effect_rainbow_mood(animation_status_t *anim);
426void rgblight_effect_rainbow_swirl(animation_status_t *anim);
427void rgblight_effect_snake(animation_status_t *anim);
428void rgblight_effect_knight(animation_status_t *anim);
429void rgblight_effect_christmas(animation_status_t *anim);
430void rgblight_effect_rgbtest(animation_status_t *anim);
431void rgblight_effect_alternating(animation_status_t *anim);
432void rgblight_effect_twinkle(animation_status_t *anim);
433
434#endif
generated by cgit v1.2.3 (git 2.25.1) at 2025-11-25 21:25:58 +0000