quantum/rgblight.h

   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 #ifndef RGBLIGHT_H
  17 #define RGBLIGHT_H
  18
  19 #include "rgblight_reconfig.h"
  20
  21 /***** rgblight_mode(mode)/rgblight_mode_noeeprom(mode) ****
  22
  23  old mode number (before 0.6.117) to new mode name table
  24
  25 |-----------------|-----------------------------------|
  26 | old mode number | new mode name                     |
  27 |-----------------|-----------------------------------|
  28 |        1        | RGBLIGHT_MODE_STATIC_LIGHT        |
  29 |        2        | RGBLIGHT_MODE_BREATHING           |
  30 |        3        | RGBLIGHT_MODE_BREATHING + 1       |
  31 |        4        | RGBLIGHT_MODE_BREATHING + 2       |
  32 |        5        | RGBLIGHT_MODE_BREATHING + 3       |
  33 |        6        | RGBLIGHT_MODE_RAINBOW_MOOD        |
  34 |        7        | RGBLIGHT_MODE_RAINBOW_MOOD + 1    |
  35 |        8        | RGBLIGHT_MODE_RAINBOW_MOOD + 2    |
  36 |        9        | RGBLIGHT_MODE_RAINBOW_SWIRL       |
  37 |       10        | RGBLIGHT_MODE_RAINBOW_SWIRL + 1   |
  38 |       11        | RGBLIGHT_MODE_RAINBOW_SWIRL + 2   |
  39 |       12        | RGBLIGHT_MODE_RAINBOW_SWIRL + 3   |
  40 |       13        | RGBLIGHT_MODE_RAINBOW_SWIRL + 4   |
  41 |       14        | RGBLIGHT_MODE_RAINBOW_SWIRL + 5   |
  42 |       15        | RGBLIGHT_MODE_SNAKE               |
  43 |       16        | RGBLIGHT_MODE_SNAKE + 1           |
  44 |       17        | RGBLIGHT_MODE_SNAKE + 2           |
  45 |       18        | RGBLIGHT_MODE_SNAKE + 3           |
  46 |       19        | RGBLIGHT_MODE_SNAKE + 4           |
  47 |       20        | RGBLIGHT_MODE_SNAKE + 5           |
  48 |       21        | RGBLIGHT_MODE_KNIGHT              |
  49 |       22        | RGBLIGHT_MODE_KNIGHT + 1          |
  50 |       23        | RGBLIGHT_MODE_KNIGHT + 2          |
  51 |       24        | RGBLIGHT_MODE_CHRISTMAS           |
  52 |       25        | RGBLIGHT_MODE_STATIC_GRADIENT     |
  53 |       26        | RGBLIGHT_MODE_STATIC_GRADIENT + 1 |
  54 |       27        | RGBLIGHT_MODE_STATIC_GRADIENT + 2 |
  55 |       28        | RGBLIGHT_MODE_STATIC_GRADIENT + 3 |
  56 |       29        | RGBLIGHT_MODE_STATIC_GRADIENT + 4 |
  57 |       30        | RGBLIGHT_MODE_STATIC_GRADIENT + 5 |
  58 |       31        | RGBLIGHT_MODE_STATIC_GRADIENT + 6 |
  59 |       32        | RGBLIGHT_MODE_STATIC_GRADIENT + 7 |
  60 |       33        | RGBLIGHT_MODE_STATIC_GRADIENT + 8 |
  61 |       34        | RGBLIGHT_MODE_STATIC_GRADIENT + 9 |
  62 |       35        | RGBLIGHT_MODE_RGB_TEST            |
  63 |       36        | RGBLIGHT_MODE_ALTERNATING         |
  64 |-----------------|-----------------------------------|
  65  *****/
  66
  67 #define _RGBM_SINGLE_STATIC(sym)   RGBLIGHT_MODE_ ## sym,
  68 #define _RGBM_SINGLE_DYNAMIC(sym)  RGBLIGHT_MODE_ ## sym,
  69 #define _RGBM_MULTI_STATIC(sym)    RGBLIGHT_MODE_ ## sym,
  70 #define _RGBM_MULTI_DYNAMIC(sym)   RGBLIGHT_MODE_ ## sym,
  71 #define _RGBM_TMP_STATIC(sym, msym)  RGBLIGHT_MODE_ ## sym,
  72 #define _RGBM_TMP_DYNAMIC(sym, msym) RGBLIGHT_MODE_ ## sym,
  73 enum RGBLIGHT_EFFECT_MODE {
  74     RGBLIGHT_MODE_zero = 0,
  75 #include "rgblight_modes.h"
  76     RGBLIGHT_MODE_last
  77 };
  78
  79 #ifndef RGBLIGHT_H_DUMMY_DEFINE
  80
  81 #define RGBLIGHT_MODES (RGBLIGHT_MODE_last-1)
  82
  83 #ifndef RGBLIGHT_EFFECT_BREATHE_CENTER
  84 #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85  // 1-2.7
  85 #endif
  86
  87 #ifndef RGBLIGHT_EFFECT_BREATHE_MAX
  88 #define RGBLIGHT_EFFECT_BREATHE_MAX 255   // 0-255
  89 #endif
  90
  91 #ifndef RGBLIGHT_EFFECT_SNAKE_LENGTH
  92 #define RGBLIGHT_EFFECT_SNAKE_LENGTH 4
  93 #endif
  94
  95 #ifndef RGBLIGHT_EFFECT_KNIGHT_LENGTH
  96 #define RGBLIGHT_EFFECT_KNIGHT_LENGTH 3
  97 #endif
  98
  99 #ifndef RGBLIGHT_EFFECT_KNIGHT_OFFSET
 100 #define RGBLIGHT_EFFECT_KNIGHT_OFFSET 0
 101 #endif
 102
 103 #ifndef RGBLIGHT_EFFECT_KNIGHT_LED_NUM
 104 #define RGBLIGHT_EFFECT_KNIGHT_LED_NUM RGBLED_NUM
 105 #endif
 106
 107 #ifndef RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL
 108 #define RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL 1000
 109 #endif
 110
 111 #ifndef RGBLIGHT_EFFECT_CHRISTMAS_STEP
 112 #define RGBLIGHT_EFFECT_CHRISTMAS_STEP 2
 113 #endif
 114
 115 #ifndef RGBLIGHT_HUE_STEP
 116 #define RGBLIGHT_HUE_STEP 10
 117 #endif
 118 #ifndef RGBLIGHT_SAT_STEP
 119 #define RGBLIGHT_SAT_STEP 17
 120 #endif
 121 #ifndef RGBLIGHT_VAL_STEP
 122 #define RGBLIGHT_VAL_STEP 17
 123 #endif
 124 #ifndef RGBLIGHT_LIMIT_VAL
 125 #define RGBLIGHT_LIMIT_VAL 255
 126 #endif
 127
 128 #define RGBLED_TIMER_TOP F_CPU/(256*64)
 129 // #define RGBLED_TIMER_TOP 0xFF10
 130
 131 #include <stdint.h>
 132 #include <stdbool.h>
 133 #include "eeconfig.h"
 134 #ifndef RGBLIGHT_CUSTOM_DRIVER
 135 #include "ws2812.h"
 136 #endif
 137 #include "rgblight_types.h"
 138 #include "rgblight_list.h"
 139
 140 #if defined(__AVR__)
 141     #include <avr/pgmspace.h>
 142 #endif
 143
 144 extern LED_TYPE led[RGBLED_NUM];
 145
 146 extern const uint8_t RGBLED_BREATHING_INTERVALS[4] PROGMEM;
 147 extern const uint8_t RGBLED_RAINBOW_MOOD_INTERVALS[3] PROGMEM;
 148 extern const uint8_t RGBLED_RAINBOW_SWIRL_INTERVALS[3] PROGMEM;
 149 extern const uint8_t RGBLED_SNAKE_INTERVALS[3] PROGMEM;
 150 extern const uint8_t RGBLED_KNIGHT_INTERVALS[3] PROGMEM;
 151 extern const uint16_t RGBLED_RGBTEST_INTERVALS[1] PROGMEM;
 152 extern bool is_rgblight_initialized;
 153
 154 typedef union {
 155   uint32_t raw;
 156   struct {
 157     bool     enable  :1;
 158     uint8_t  mode    :6;
 159     uint16_t hue     :9;
 160     uint8_t  sat     :8;
 161     uint8_t  val     :8;
 162     uint8_t  speed   :8;//EECONFIG needs to be increased to support this
 163   };
 164 } rgblight_config_t;
 165
 166 typedef struct _rgblight_status_t {
 167     uint8_t  base_mode;
 168     bool timer_enabled;
 169 #ifdef RGBLIGHT_SPLIT
 170     uint8_t change_flags;
 171 #endif
 172 } rgblight_status_t;
 173
 174 #ifdef RGBLIGHT_SPLIT
 175   #define RGBLIGHT_STATUS_CHANGE_MODE (1<<0)
 176   #define RGBLIGHT_STATUS_CHANGE_HSVS (1<<1)
 177   #define RGBLIGHT_STATUS_CHANGE_TIMER (1<<2)
 178   #define RGBLIGHT_STATUS_ANIMATION_TICK (1<<3)
 179
 180   typedef struct _rgblight_syncinfo_t {
 181     rgblight_config_t config;
 182     rgblight_status_t status;
 183   } rgblight_syncinfo_t;
 184
 185   /* for split keyboard master side */
 186   uint8_t rgblight_get_change_flags(void);
 187   void rgblight_clear_change_flags(void);
 188   void rgblight_get_syncinfo(rgblight_syncinfo_t *syncinfo);
 189   /* for split keyboard slave side */
 190   void rgblight_update_sync(rgblight_syncinfo_t *syncinfo, bool write_to_eeprom);
 191 #endif
 192
 193 void rgblight_init(void);
 194 void rgblight_increase(void);
 195 void rgblight_decrease(void);
 196 void rgblight_toggle(void);
 197 void rgblight_enable(void);
 198 void rgblight_disable(void);
 199 void rgblight_step(void);
 200 void rgblight_step_reverse(void);
 201 uint8_t rgblight_get_mode(void);
 202 void rgblight_mode(uint8_t mode);
 203 void rgblight_set(void);
 204 uint32_t rgblight_read_dword(void);
 205 void rgblight_update_dword(uint32_t dword);
 206 void rgblight_increase_hue(void);
 207 void rgblight_decrease_hue(void);
 208 void rgblight_increase_sat(void);
 209 void rgblight_decrease_sat(void);
 210 void rgblight_increase_val(void);
 211 void rgblight_decrease_val(void);
 212 void rgblight_increase_speed(void);
 213 void rgblight_decrease_speed(void);
 214 void rgblight_sethsv(uint16_t hue, uint8_t sat, uint8_t val);
 215 uint16_t rgblight_get_hue(void);
 216 uint8_t rgblight_get_sat(void);
 217 uint8_t rgblight_get_val(void);
 218 void rgblight_setrgb(uint8_t r, uint8_t g, uint8_t b);
 219 void rgblight_setrgb_at(uint8_t r, uint8_t g, uint8_t b, uint8_t index);
 220 void rgblight_sethsv_at(uint16_t hue, uint8_t sat, uint8_t val, uint8_t index);
 221 void rgblight_setrgb_range(uint8_t r, uint8_t g, uint8_t b, uint8_t start, uint8_t end);
 222 void rgblight_sethsv_range(uint16_t hue, uint8_t sat, uint8_t val, uint8_t start, uint8_t end);
 223 void rgblight_setrgb_master(uint8_t r, uint8_t g, uint8_t b);
 224 void rgblight_setrgb_slave(uint8_t r, uint8_t g, uint8_t b);
 225 void rgblight_sethsv_master(uint16_t hue, uint8_t sat, uint8_t val);
 226 void rgblight_sethsv_slave(uint16_t hue, uint8_t sat, uint8_t val);
 227 void rgblight_set_clipping_range(uint8_t start_pos, uint8_t num_leds);
 228
 229 uint32_t eeconfig_read_rgblight(void);
 230 void eeconfig_update_rgblight(uint32_t val);
 231 void eeconfig_update_rgblight_default(void);
 232 void eeconfig_debug_rgblight(void);
 233
 234 void rgb_matrix_increase(void);
 235 void rgb_matrix_decrease(void);
 236
 237 void sethsv(uint16_t hue, uint8_t sat, uint8_t val, LED_TYPE *led1);
 238 void setrgb(uint8_t r, uint8_t g, uint8_t b, LED_TYPE *led1);
 239
 240 void rgblight_sethsv_noeeprom(uint16_t hue, uint8_t sat, uint8_t val);
 241 void rgblight_mode_noeeprom(uint8_t mode);
 242 void rgblight_toggle_noeeprom(void);
 243 void rgblight_enable_noeeprom(void);
 244 void rgblight_disable_noeeprom(void);
 245 void rgblight_step_noeeprom(void);
 246 void rgblight_step_reverse_noeeprom(void);
 247 void rgblight_increase_hue_noeeprom(void);
 248 void rgblight_decrease_hue_noeeprom(void);
 249 void rgblight_increase_sat_noeeprom(void);
 250 void rgblight_decrease_sat_noeeprom(void);
 251 void rgblight_increase_val_noeeprom(void);
 252 void rgblight_decrease_val_noeeprom(void);
 253
 254 void rgblight_sethsv_eeprom_helper(uint16_t hue, uint8_t sat, uint8_t val, bool write_to_eeprom);
 255 void rgblight_mode_eeprom_helper(uint8_t mode, bool write_to_eeprom);
 256
 257
 258 #define EZ_RGB(val) rgblight_show_solid_color((val >> 16) & 0xFF, (val >> 8) & 0xFF, val & 0xFF)
 259 void rgblight_show_solid_color(uint8_t r, uint8_t g, uint8_t b);
 260
 261 void rgblight_task(void);
 262
 263 void rgblight_timer_init(void);
 264 void rgblight_timer_enable(void);
 265 void rgblight_timer_disable(void);
 266 void rgblight_timer_toggle(void);
 267
 268 #ifdef RGBLIGHT_USE_TIMER
 269
 270 typedef struct _animation_status_t {
 271     uint16_t last_timer;
 272     uint8_t  delta; /* mode - base_mode */
 273     bool     restart;
 274     union {
 275         uint16_t pos16;
 276         uint8_t  pos;
 277         int16_t  current_hue;
 278         uint16_t current_offset;
 279     };
 280 } animation_status_t;
 281
 282 extern animation_status_t animation_status;
 283
 284 void rgblight_effect_breathing(animation_status_t *anim);
 285 void rgblight_effect_rainbow_mood(animation_status_t *anim);
 286 void rgblight_effect_rainbow_swirl(animation_status_t *anim);
 287 void rgblight_effect_snake(animation_status_t *anim);
 288 void rgblight_effect_knight(animation_status_t *anim);
 289 void rgblight_effect_christmas(animation_status_t *anim);
 290 void rgblight_effect_rgbtest(animation_status_t *anim);
 291 void rgblight_effect_alternating(animation_status_t *anim);
 292
 293 #endif
 294
 295 #endif // #ifndef RGBLIGHT_H_DUMMY_DEFINE
 296 #endif // RGBLIGHT_H