logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

rgblight.h (15565B)

    

  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.  */
  17. #pragma once
  19. #include "compiler_support.h"
  21. // DEPRECATED DEFINES - DO NOT USE
  22. #if defined(RGBLED_NUM)
  23. #    define RGBLIGHT_LED_COUNT RGBLED_NUM
  24. #endif
  25. // ========
  27. /***** rgblight_mode(mode)/rgblight_mode_noeeprom(mode) ****
  29.  old mode number (before 0.6.117) to new mode name table
  31. |-----------------|-----------------------------------|
  32. | old mode number | new mode name                     |
  33. |-----------------|-----------------------------------|
  34. |        1        | RGBLIGHT_MODE_STATIC_LIGHT        |
  35. |        2        | RGBLIGHT_MODE_BREATHING           |
  36. |        3        | RGBLIGHT_MODE_BREATHING + 1       |
  37. |        4        | RGBLIGHT_MODE_BREATHING + 2       |
  38. |        5        | RGBLIGHT_MODE_BREATHING + 3       |
  39. |        6        | RGBLIGHT_MODE_RAINBOW_MOOD        |
  40. |        7        | RGBLIGHT_MODE_RAINBOW_MOOD + 1    |
  41. |        8        | RGBLIGHT_MODE_RAINBOW_MOOD + 2    |
  42. |        9        | RGBLIGHT_MODE_RAINBOW_SWIRL       |
  43. |       10        | RGBLIGHT_MODE_RAINBOW_SWIRL + 1   |
  44. |       11        | RGBLIGHT_MODE_RAINBOW_SWIRL + 2   |
  45. |       12        | RGBLIGHT_MODE_RAINBOW_SWIRL + 3   |
  46. |       13        | RGBLIGHT_MODE_RAINBOW_SWIRL + 4   |
  47. |       14        | RGBLIGHT_MODE_RAINBOW_SWIRL + 5   |
  48. |       15        | RGBLIGHT_MODE_SNAKE               |
  49. |       16        | RGBLIGHT_MODE_SNAKE + 1           |
  50. |       17        | RGBLIGHT_MODE_SNAKE + 2           |
  51. |       18        | RGBLIGHT_MODE_SNAKE + 3           |
  52. |       19        | RGBLIGHT_MODE_SNAKE + 4           |
  53. |       20        | RGBLIGHT_MODE_SNAKE + 5           |
  54. |       21        | RGBLIGHT_MODE_KNIGHT              |
  55. |       22        | RGBLIGHT_MODE_KNIGHT + 1          |
  56. |       23        | RGBLIGHT_MODE_KNIGHT + 2          |
  57. |       24        | RGBLIGHT_MODE_CHRISTMAS           |
  58. |       25        | RGBLIGHT_MODE_STATIC_GRADIENT     |
  59. |       26        | RGBLIGHT_MODE_STATIC_GRADIENT + 1 |
  60. |       27        | RGBLIGHT_MODE_STATIC_GRADIENT + 2 |
  61. |       28        | RGBLIGHT_MODE_STATIC_GRADIENT + 3 |
  62. |       29        | RGBLIGHT_MODE_STATIC_GRADIENT + 4 |
  63. |       30        | RGBLIGHT_MODE_STATIC_GRADIENT + 5 |
  64. |       31        | RGBLIGHT_MODE_STATIC_GRADIENT + 6 |
  65. |       32        | RGBLIGHT_MODE_STATIC_GRADIENT + 7 |
  66. |       33        | RGBLIGHT_MODE_STATIC_GRADIENT + 8 |
  67. |       34        | RGBLIGHT_MODE_STATIC_GRADIENT + 9 |
  68. |       35        | RGBLIGHT_MODE_RGB_TEST            |
  69. |       36        | RGBLIGHT_MODE_ALTERNATING         |
  70. |       37        | RGBLIGHT_MODE_TWINKLE             |
  71. |       38        | RGBLIGHT_MODE_TWINKLE + 1         |
  72. |       39        | RGBLIGHT_MODE_TWINKLE + 2         |
  73. |       40        | RGBLIGHT_MODE_TWINKLE + 3         |
  74. |       41        | RGBLIGHT_MODE_TWINKLE + 4         |
  75. |       42        | RGBLIGHT_MODE_TWINKLE + 5         |
  76. |-----------------|-----------------------------------|
  77.  *****/
  79. // clang-format off
  81. // check dynamic animation effects chose ?
  82. #if  defined(RGBLIGHT_EFFECT_BREATHING)     \
  83.   || defined(RGBLIGHT_EFFECT_RAINBOW_MOOD)  \
  84.   || defined(RGBLIGHT_EFFECT_RAINBOW_SWIRL) \
  85.   || defined(RGBLIGHT_EFFECT_SNAKE)         \
  86.   || defined(RGBLIGHT_EFFECT_KNIGHT)        \
  87.   || defined(RGBLIGHT_EFFECT_CHRISTMAS)     \
  88.   || defined(RGBLIGHT_EFFECT_RGB_TEST)      \
  89.   || defined(RGBLIGHT_EFFECT_ALTERNATING)   \
  90.   || defined(RGBLIGHT_EFFECT_TWINKLE)
  91. #    define RGBLIGHT_USE_TIMER
  92. #endif
  94. // clang-format on
  96. #define _RGBM_SINGLE_STATIC(sym) RGBLIGHT_MODE_##sym,
  97. #define _RGBM_SINGLE_DYNAMIC(sym) RGBLIGHT_MODE_##sym,
  98. #define _RGBM_MULTI_STATIC(sym) RGBLIGHT_MODE_##sym,
  99. #define _RGBM_MULTI_DYNAMIC(sym) RGBLIGHT_MODE_##sym,
  100. #define _RGBM_TMP_STATIC(sym, msym) RGBLIGHT_MODE_##sym,
  101. #define _RGBM_TMP_DYNAMIC(sym, msym) RGBLIGHT_MODE_##sym,
  102. enum RGBLIGHT_EFFECT_MODE {
  103.     RGBLIGHT_MODE_zero = 0,
  104. #include "rgblight_modes.h"
  105.     RGBLIGHT_MODE_last
  106. };
  108. #define RGBLIGHT_MODES (RGBLIGHT_MODE_last - 1)
  110. // sample: #define RGBLIGHT_EFFECT_BREATHE_CENTER   1.85
  112. #ifndef RGBLIGHT_EFFECT_BREATHE_MAX
  113. #    define RGBLIGHT_EFFECT_BREATHE_MAX 255 // 0-255
  114. #endif
  116. #ifndef RGBLIGHT_EFFECT_SNAKE_LENGTH
  117. #    define RGBLIGHT_EFFECT_SNAKE_LENGTH 4
  118. #endif
  120. #ifndef RGBLIGHT_EFFECT_SNAKE_INCREMENT
  121. #    define RGBLIGHT_EFFECT_SNAKE_INCREMENT 1
  122. #endif
  124. #ifndef RGBLIGHT_EFFECT_KNIGHT_LENGTH
  125. #    define RGBLIGHT_EFFECT_KNIGHT_LENGTH 3
  126. #endif
  128. #ifndef RGBLIGHT_EFFECT_KNIGHT_INCREMENT
  129. #    define RGBLIGHT_EFFECT_KNIGHT_INCREMENT 1
  130. #endif
  132. #ifndef RGBLIGHT_EFFECT_KNIGHT_OFFSET
  133. #    define RGBLIGHT_EFFECT_KNIGHT_OFFSET 0
  134. #endif
  136. #ifndef RGBLIGHT_EFFECT_KNIGHT_LED_NUM
  137. #    define RGBLIGHT_EFFECT_KNIGHT_LED_NUM (rgblight_ranges.effect_num_leds)
  138. #endif
  140. #ifndef RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL
  141. #    define RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL 40
  142. #endif
  144. #ifndef RGBLIGHT_EFFECT_CHRISTMAS_STEP
  145. #    define RGBLIGHT_EFFECT_CHRISTMAS_STEP 2
  146. #endif
  148. #ifndef RGBLIGHT_EFFECT_TWINKLE_LIFE
  149. #    define RGBLIGHT_EFFECT_TWINKLE_LIFE 200
  150. #endif
  152. #ifndef RGBLIGHT_EFFECT_TWINKLE_PROBABILITY
  153. #    define RGBLIGHT_EFFECT_TWINKLE_PROBABILITY 1 / 127
  154. #endif
  156. #ifndef RGBLIGHT_HUE_STEP
  157. #    define RGBLIGHT_HUE_STEP 8
  158. #endif
  159. #ifndef RGBLIGHT_SAT_STEP
  160. #    define RGBLIGHT_SAT_STEP 17
  161. #endif
  162. #ifndef RGBLIGHT_VAL_STEP
  163. #    define RGBLIGHT_VAL_STEP 17
  164. #endif
  165. #ifndef RGBLIGHT_LIMIT_VAL
  166. #    define RGBLIGHT_LIMIT_VAL 255
  167. #endif
  169. #include <stdint.h>
  170. #include <stdbool.h>
  171. #include "rgblight_drivers.h"
  172. #include "progmem.h"
  173. #include "color.h"
  175. #ifdef RGBLIGHT_LAYERS
  176. typedef struct {
  177.     uint8_t index; // The first LED to light
  178.     uint8_t count; // The number of LEDs to light
  179.     uint8_t hue;
  180.     uint8_t sat;
  181.     uint8_t val;
  182. } rgblight_segment_t;
  184. // rgblight_set_layer_state doesn't take effect until the next time
  185. // rgblight_task runs, so timers must be enabled for layers to work.
  186. #    define RGBLIGHT_USE_TIMER
  188. #    define RGBLIGHT_END_SEGMENT_INDEX (255)
  189. #    define RGBLIGHT_END_SEGMENTS \
  190.         { RGBLIGHT_END_SEGMENT_INDEX, 0, 0, 0 }
  191. #    ifndef RGBLIGHT_MAX_LAYERS
  192. #        define RGBLIGHT_MAX_LAYERS 8
  193. #    endif
  194. #    if RGBLIGHT_MAX_LAYERS <= 0
  195. #        error invalid RGBLIGHT_MAX_LAYERS value (must be >= 1)
  196. #    elif RGBLIGHT_MAX_LAYERS <= 8
  197. typedef uint8_t rgblight_layer_mask_t;
  198. #    elif RGBLIGHT_MAX_LAYERS <= 16
  199. typedef uint16_t rgblight_layer_mask_t;
  200. #    elif RGBLIGHT_MAX_LAYERS <= 32
  201. typedef uint32_t rgblight_layer_mask_t;
  202. #    else
  203. #        error invalid RGBLIGHT_MAX_LAYERS value (must be <= 32)
  204. #    endif
  205. #    define RGBLIGHT_LAYER_SEGMENTS(...) \
  206.         { __VA_ARGS__, RGBLIGHT_END_SEGMENTS }
  207. #    define RGBLIGHT_LAYERS_LIST(...) \
  208.         { __VA_ARGS__, NULL }
  210. // Get/set enabled rgblight layers
  211. void rgblight_set_layer_state(uint8_t layer, bool enabled);
  212. bool rgblight_get_layer_state(uint8_t layer);
  214. // Point this to an array of rgblight_segment_t arrays in keyboard_post_init_user to use rgblight layers
  215. extern const rgblight_segment_t *const *rgblight_layers;
  217. #    ifdef RGBLIGHT_LAYER_BLINK
  218. #        define RGBLIGHT_USE_TIMER
  219. void rgblight_blink_layer(uint8_t layer, uint16_t duration_ms);
  220. void rgblight_blink_layer_repeat(uint8_t layer, uint16_t duration_ms, uint8_t times);
  221. /**
  222.  * \brief Stop blinking on one layer.
  223.  *
  224.  * Stop a layer that is blinking. If the layer is not blinking it will
  225.  * be unaffected.
  226.  *
  227.  * \param layer Layer number to stop blinking.
  228.  */
  229. void rgblight_unblink_layer(uint8_t layer);
  230. /**
  231.  * \brief Stop blinking all layers except one.
  232.  *
  233.  * Stop all layers that are blinking except for one specific layer.
  234.  * Layers that are not blinking are unaffected.
  235.  *
  236.  * \param layer Layer number to keep blinking.
  237.  */
  238. void rgblight_unblink_all_but_layer(uint8_t layer);
  239. #    endif
  241. #endif
  243. extern const uint8_t  RGBLED_BREATHING_INTERVALS[4] PROGMEM;
  244. extern const uint8_t  RGBLED_RAINBOW_MOOD_INTERVALS[3] PROGMEM;
  245. extern const uint8_t  RGBLED_RAINBOW_SWIRL_INTERVALS[3] PROGMEM;
  246. extern const uint8_t  RGBLED_SNAKE_INTERVALS[3] PROGMEM;
  247. extern const uint8_t  RGBLED_KNIGHT_INTERVALS[3] PROGMEM;
  248. extern const uint16_t RGBLED_RGBTEST_INTERVALS[1] PROGMEM;
  249. extern const uint8_t  RGBLED_TWINKLE_INTERVALS[3] PROGMEM;
  250. extern bool           is_rgblight_initialized;
  252. typedef union rgblight_config_t {
  253.     uint64_t raw;
  254.     struct {
  255.         bool    enable : 1;
  256.         bool    velocikey : 1;
  257.         uint8_t mode : 6;
  258.         uint8_t hue : 8;
  259.         uint8_t sat : 8;
  260.         uint8_t val : 8;
  261.         uint8_t speed : 8;
  262.     };
  263. } rgblight_config_t;
  265. STATIC_ASSERT(sizeof(rgblight_config_t) == sizeof(uint64_t), "RGB Light EECONFIG out of spec.");
  267. typedef struct _rgblight_status_t {
  268.     uint8_t base_mode;
  269.     bool    timer_enabled;
  270. #ifdef RGBLIGHT_SPLIT
  271.     uint8_t change_flags;
  272. #endif
  273. #ifdef RGBLIGHT_LAYERS
  274.     rgblight_layer_mask_t enabled_layer_mask;
  275. #endif
  276. } rgblight_status_t;
  278. /*
  279.  * Structure for RGB Light clipping ranges
  280.  */
  281. typedef struct _rgblight_ranges_t {
  282.     uint8_t clipping_start_pos;
  283.     uint8_t clipping_num_leds;
  284.     uint8_t effect_start_pos;
  285.     uint8_t effect_end_pos;
  286.     uint8_t effect_num_leds;
  287. } rgblight_ranges_t;
  289. extern rgblight_ranges_t rgblight_ranges;
  291. /* === Low level Functions === */
  292. void rgblight_set(void);
  293. void rgblight_set_clipping_range(uint8_t start_pos, uint8_t num_leds);
  295. /* === Effects and Animations Functions === */
  296. /*   effect range setting */
  297. void rgblight_set_effect_range(uint8_t start_pos, uint8_t num_leds);
  299. /*   direct operation */
  300. void rgblight_setrgb_at(uint8_t r, uint8_t g, uint8_t b, uint8_t index);
  301. void rgblight_sethsv_at(uint8_t hue, uint8_t sat, uint8_t val, uint8_t index);
  302. void rgblight_setrgb_range(uint8_t r, uint8_t g, uint8_t b, uint8_t start, uint8_t end);
  303. void rgblight_sethsv_range(uint8_t hue, uint8_t sat, uint8_t val, uint8_t start, uint8_t end);
  304. void rgblight_setrgb(uint8_t r, uint8_t g, uint8_t b);
  306. #ifndef RGBLIGHT_SPLIT
  307. void rgblight_setrgb_master(uint8_t r, uint8_t g, uint8_t b);
  308. void rgblight_setrgb_slave(uint8_t r, uint8_t g, uint8_t b);
  309. void rgblight_sethsv_master(uint8_t hue, uint8_t sat, uint8_t val);
  310. void rgblight_sethsv_slave(uint8_t hue, uint8_t sat, uint8_t val);
  311. #endif
  313. /*   effect mode change */
  314. void rgblight_mode(uint8_t mode);
  315. void rgblight_mode_noeeprom(uint8_t mode);
  316. void rgblight_increase(void);
  317. void rgblight_decrease(void);
  318. void rgblight_step(void);
  319. void rgblight_step_noeeprom(void);
  320. void rgblight_step_reverse(void);
  321. void rgblight_step_reverse_noeeprom(void);
  323. /*   effects mode disable/enable */
  324. void rgblight_toggle(void);
  325. void rgblight_toggle_noeeprom(void);
  326. void rgblight_enable(void);
  327. void rgblight_enable_noeeprom(void);
  328. void rgblight_disable(void);
  329. void rgblight_disable_noeeprom(void);
  330. void rgblight_enabled_noeeprom(bool state);
  332. /*   hue, sat, val change */
  333. void rgblight_increase_hue(void);
  334. void rgblight_increase_hue_noeeprom(void);
  335. void rgblight_decrease_hue(void);
  336. void rgblight_decrease_hue_noeeprom(void);
  337. void rgblight_increase_sat(void);
  338. void rgblight_increase_sat_noeeprom(void);
  339. void rgblight_decrease_sat(void);
  340. void rgblight_decrease_sat_noeeprom(void);
  341. void rgblight_increase_val(void);
  342. void rgblight_increase_val_noeeprom(void);
  343. void rgblight_decrease_val(void);
  344. void rgblight_decrease_val_noeeprom(void);
  345. void rgblight_increase_speed(void);
  346. void rgblight_increase_speed_noeeprom(void);
  347. void rgblight_decrease_speed(void);
  348. void rgblight_decrease_speed_noeeprom(void);
  349. void rgblight_sethsv(uint8_t hue, uint8_t sat, uint8_t val);
  350. void rgblight_sethsv_noeeprom(uint8_t hue, uint8_t sat, uint8_t val);
  352. /*   effect speed */
  353. uint8_t rgblight_get_speed(void);
  354. void    rgblight_set_speed(uint8_t speed);
  355. void    rgblight_set_speed_noeeprom(uint8_t speed);
  357. /*   reset */
  358. void rgblight_reload_from_eeprom(void);
  360. /*       query */
  361. uint8_t rgblight_get_mode(void);
  362. uint8_t rgblight_get_hue(void);
  363. uint8_t rgblight_get_sat(void);
  364. uint8_t rgblight_get_val(void);
  365. bool    rgblight_is_enabled(void);
  366. hsv_t   rgblight_get_hsv(void);
  368. /* === qmk_firmware (core)internal Functions === */
  369. void     rgblight_init(void);
  370. void     rgblight_suspend(void);
  371. void     rgblight_wakeup(void);
  372. uint64_t rgblight_read_qword(void);
  373. void     rgblight_update_qword(uint64_t qword);
  374. void     eeconfig_update_rgblight_current(void);
  375. void     eeconfig_update_rgblight_default(void);
  376. void     eeconfig_debug_rgblight(void);
  378. void rgb_matrix_increase(void);
  379. void rgb_matrix_decrease(void);
  381. void rgblight_sethsv_eeprom_helper(uint8_t hue, uint8_t sat, uint8_t val, bool write_to_eeprom);
  382. void rgblight_mode_eeprom_helper(uint8_t mode, bool write_to_eeprom);
  384. #define EZ_RGB(val) rgblight_show_solid_color((val >> 16) & 0xFF, (val >> 8) & 0xFF, val & 0xFF)
  385. void rgblight_show_solid_color(uint8_t r, uint8_t g, uint8_t b);
  387. void preprocess_rgblight(void);
  388. void rgblight_task(void);
  390. #ifdef RGBLIGHT_USE_TIMER
  391. void rgblight_timer_init(void);
  392. void rgblight_timer_enable(void);
  393. void rgblight_timer_disable(void);
  394. void rgblight_timer_toggle(void);
  395. #else
  396. #    define rgblight_timer_init()
  397. #    define rgblight_timer_enable()
  398. #    define rgblight_timer_disable()
  399. #    define rgblight_timer_toggle()
  400. #endif
  402. #ifdef RGBLIGHT_SPLIT
  403. #    define RGBLIGHT_STATUS_CHANGE_MODE (1 << 0)
  404. #    define RGBLIGHT_STATUS_CHANGE_HSVS (1 << 1)
  405. #    define RGBLIGHT_STATUS_CHANGE_TIMER (1 << 2)
  406. #    define RGBLIGHT_STATUS_ANIMATION_TICK (1 << 3)
  407. #    define RGBLIGHT_STATUS_CHANGE_LAYERS (1 << 4)
  409. typedef struct _rgblight_syncinfo_t {
  410.     rgblight_config_t config;
  411.     rgblight_status_t status;
  412. } rgblight_syncinfo_t;
  414. /* for split keyboard master side */
  415. uint8_t rgblight_get_change_flags(void);
  416. void    rgblight_clear_change_flags(void);
  417. void    rgblight_get_syncinfo(rgblight_syncinfo_t *syncinfo);
  418. /* for split keyboard slave side */
  419. void rgblight_update_sync(rgblight_syncinfo_t *syncinfo, bool write_to_eeprom);
  420. #endif
  422. #ifdef RGBLIGHT_USE_TIMER
  424. typedef struct _animation_status_t {
  425.     uint16_t last_timer;
  426.     uint8_t  delta; /* mode - base_mode */
  427.     bool     restart;
  428.     union {
  429.         uint16_t pos16;
  430.         uint8_t  pos;
  431.         int8_t   current_hue;
  432.         uint16_t current_offset;
  433.     };
  434. } animation_status_t;
  436. extern animation_status_t animation_status;
  438. void rgblight_effect_breathing(animation_status_t *anim);
  439. void rgblight_effect_rainbow_mood(animation_status_t *anim);
  440. void rgblight_effect_rainbow_swirl(animation_status_t *anim);
  441. void rgblight_effect_snake(animation_status_t *anim);
  442. void rgblight_effect_knight(animation_status_t *anim);
  443. void rgblight_effect_christmas(animation_status_t *anim);
  444. void rgblight_effect_rgbtest(animation_status_t *anim);
  445. void rgblight_effect_alternating(animation_status_t *anim);
  446. void rgblight_effect_twinkle(animation_status_t *anim);
  448. #endif
  450. #ifdef VELOCIKEY_ENABLE
  451. bool    rgblight_velocikey_enabled(void);
  452. void    rgblight_velocikey_toggle(void);
  453. void    rgblight_velocikey_accelerate(void);
  454. void    rgblight_velocikey_decelerate(void);
  455. uint8_t rgblight_velocikey_match_speed(uint8_t minValue, uint8_t maxValue);
  457. #    define velocikey_enabled rgblight_velocikey_enabled
  458. #    define velocikey_toggle rgblight_velocikey_toggle
  459. #endif