quantum/rgb_matrix.h

   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 #ifndef RGB_MATRIX_H
  20 #define RGB_MATRIX_H
  21
  22 #include <stdint.h>
  23 #include <stdbool.h>
  24 #include "color.h"
  25 #include "quantum.h"
  26
  27 #ifdef IS31FL3731
  28     #include "is31fl3731.h"
  29 #elif defined (IS31FL3733)
  30     #include "is31fl3733.h"
  31 #endif
  32
  33 typedef struct Point {
  34         uint8_t x;
  35         uint8_t y;
  36 } __attribute__((packed)) Point;
  37
  38 typedef struct rgb_led {
  39         union {
  40                 uint8_t raw;
  41                 struct {
  42                         uint8_t row:4; // 16 max
  43                         uint8_t col:4; // 16 max
  44                 };
  45         } matrix_co;
  46         Point point;
  47         uint8_t modifier:1;
  48 } __attribute__((packed)) rgb_led;
  49
  50
  51 extern const rgb_led g_rgb_leds[DRIVER_LED_TOTAL];
  52
  53 typedef struct
  54 {
  55         HSV color;
  56         uint8_t index;
  57 } rgb_indicator;
  58
  59 typedef union {
  60   uint32_t raw;
  61   struct {
  62     bool     enable  :1;
  63     uint8_t  mode    :6;
  64     uint16_t hue     :9;
  65     uint8_t  sat     :8;
  66     uint8_t  val     :8;
  67     uint8_t  speed   :8;//EECONFIG needs to be increased to support this
  68   };
  69 } rgb_config_t;
  70
  71 enum rgb_matrix_effects {
  72         RGB_MATRIX_SOLID_COLOR = 1,
  73     RGB_MATRIX_ALPHAS_MODS,
  74     RGB_MATRIX_DUAL_BEACON,
  75     RGB_MATRIX_GRADIENT_UP_DOWN,
  76     RGB_MATRIX_RAINDROPS,
  77     RGB_MATRIX_CYCLE_ALL,
  78     RGB_MATRIX_CYCLE_LEFT_RIGHT,
  79     RGB_MATRIX_CYCLE_UP_DOWN,
  80     RGB_MATRIX_RAINBOW_BEACON,
  81     RGB_MATRIX_RAINBOW_PINWHEELS,
  82     RGB_MATRIX_RAINBOW_MOVING_CHEVRON,
  83     RGB_MATRIX_JELLYBEAN_RAINDROPS,
  84     RGB_MATRIX_DIGITAL_RAIN,
  85 #ifdef RGB_MATRIX_KEYPRESSES
  86     RGB_MATRIX_SOLID_REACTIVE,
  87     RGB_MATRIX_SPLASH,
  88     RGB_MATRIX_MULTISPLASH,
  89     RGB_MATRIX_SOLID_SPLASH,
  90     RGB_MATRIX_SOLID_MULTISPLASH,
  91 #endif
  92     RGB_MATRIX_EFFECT_MAX
  93 };
  94
  95 void rgb_matrix_set_color( int index, uint8_t red, uint8_t green, uint8_t blue );
  96
  97 // This runs after another backlight effect and replaces
  98 // colors already set
  99 void rgb_matrix_indicators(void);
 100 void rgb_matrix_indicators_kb(void);
 101 void rgb_matrix_indicators_user(void);
 102
 103 void rgb_matrix_init(void);
 104 void rgb_matrix_setup_drivers(void);
 105
 106 void rgb_matrix_set_suspend_state(bool state);
 107 void rgb_matrix_set_indicator_state(uint8_t state);
 108
 109
 110 void rgb_matrix_task(void);
 111
 112 // This should not be called from an interrupt
 113 // (eg. from a timer interrupt).
 114 // Call this while idle (in between matrix scans).
 115 // If the buffer is dirty, it will update the driver with the buffer.
 116 void rgb_matrix_update_pwm_buffers(void);
 117
 118 bool process_rgb_matrix(uint16_t keycode, keyrecord_t *record);
 119
 120 void rgb_matrix_increase(void);
 121 void rgb_matrix_decrease(void);
 122
 123 // void *backlight_get_key_color_eeprom_address(uint8_t led);
 124 // void backlight_get_key_color( uint8_t led, HSV *hsv );
 125 // void backlight_set_key_color( uint8_t row, uint8_t column, HSV hsv );
 126
 127 uint32_t rgb_matrix_get_tick(void);
 128
 129 void rgblight_toggle(void);
 130 void rgblight_step(void);
 131 void rgblight_sethsv(uint16_t hue, uint8_t sat, uint8_t val);
 132 void rgblight_step_reverse(void);
 133 void rgblight_increase_hue(void);
 134 void rgblight_decrease_hue(void);
 135 void rgblight_increase_sat(void);
 136 void rgblight_decrease_sat(void);
 137 void rgblight_increase_val(void);
 138 void rgblight_decrease_val(void);
 139 void rgblight_increase_speed(void);
 140 void rgblight_decrease_speed(void);
 141 void rgblight_mode(uint8_t mode);
 142 uint32_t rgblight_get_mode(void);
 143
 144 typedef struct {
 145     /* Perform any initialisation required for the other driver functions to work. */
 146     void (*init)(void);
 147
 148     /* Set the colour of a single LED in the buffer. */
 149     void (*set_color)(int index, uint8_t r, uint8_t g, uint8_t b);
 150     /* Set the colour of all LEDS on the keyboard in the buffer. */
 151     void (*set_color_all)(uint8_t r, uint8_t g, uint8_t b);
 152     /* Flush any buffered changes to the hardware. */
 153     void (*flush)(void);
 154 } rgb_matrix_driver_t;
 155
 156 extern const rgb_matrix_driver_t rgb_matrix_driver;
 157
 158 #endif