| 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 "rgb_matrix_types.h" |
| 25 | #include "color.h" |
| 26 | #include "quantum.h" |
| 27 | #include "rgblight_list.h" |
| 28 | |
| 29 | #ifdef IS31FL3731 |
| 30 | # include "is31fl3731.h" |
| 31 | #elif defined(IS31FL3733) |
| 32 | # include "is31fl3733.h" |
| 33 | #elif defined(IS31FL3737) |
| 34 | # include "is31fl3737.h" |
| 35 | #elif defined(WS2812) |
| 36 | # include "ws2812.h" |
| 37 | #endif |
| 38 | |
| 39 | #ifndef RGB_MATRIX_LED_FLUSH_LIMIT |
| 40 | # define RGB_MATRIX_LED_FLUSH_LIMIT 16 |
| 41 | #endif |
| 42 | |
| 43 | #ifndef RGB_MATRIX_LED_PROCESS_LIMIT |
| 44 | # define RGB_MATRIX_LED_PROCESS_LIMIT (DRIVER_LED_TOTAL + 4) / 5 |
| 45 | #endif |
| 46 | |
| 47 | #if defined(RGB_MATRIX_LED_PROCESS_LIMIT) && RGB_MATRIX_LED_PROCESS_LIMIT > 0 && RGB_MATRIX_LED_PROCESS_LIMIT < DRIVER_LED_TOTAL |
| 48 | # define RGB_MATRIX_USE_LIMITS(min, max) \ |
| 49 | uint8_t min = RGB_MATRIX_LED_PROCESS_LIMIT * params->iter; \ |
| 50 | uint8_t max = min + RGB_MATRIX_LED_PROCESS_LIMIT; \ |
| 51 | if (max > DRIVER_LED_TOTAL) max = DRIVER_LED_TOTAL; |
| 52 | #else |
| 53 | # define RGB_MATRIX_USE_LIMITS(min, max) \ |
| 54 | uint8_t min = 0; \ |
| 55 | uint8_t max = DRIVER_LED_TOTAL; |
| 56 | #endif |
| 57 | |
| 58 | #define RGB_MATRIX_TEST_LED_FLAGS() \ |
| 59 | if (!HAS_ANY_FLAGS(g_led_config.flags[i], params->flags)) continue |
| 60 | |
| 61 | enum rgb_matrix_effects { |
| 62 | RGB_MATRIX_NONE = 0, |
| 63 | |
| 64 | // -------------------------------------- |
| 65 | // -----Begin rgb effect enum macros----- |
| 66 | #define RGB_MATRIX_EFFECT(name, ...) RGB_MATRIX_##name, |
| 67 | #include "rgb_matrix_animations/rgb_matrix_effects.inc" |
| 68 | #undef RGB_MATRIX_EFFECT |
| 69 | |
| 70 | #if defined(RGB_MATRIX_CUSTOM_KB) || defined(RGB_MATRIX_CUSTOM_USER) |
| 71 | # define RGB_MATRIX_EFFECT(name, ...) RGB_MATRIX_CUSTOM_##name, |
| 72 | # ifdef RGB_MATRIX_CUSTOM_KB |
| 73 | # include "rgb_matrix_kb.inc" |
| 74 | # endif |
| 75 | # ifdef RGB_MATRIX_CUSTOM_USER |
| 76 | # include "rgb_matrix_user.inc" |
| 77 | # endif |
| 78 | # undef RGB_MATRIX_EFFECT |
| 79 | #endif |
| 80 | // -------------------------------------- |
| 81 | // -----End rgb effect enum macros------- |
| 82 | |
| 83 | RGB_MATRIX_EFFECT_MAX |
| 84 | }; |
| 85 | |
| 86 | void eeconfig_update_rgb_matrix_default(void); |
| 87 | |
| 88 | uint8_t rgb_matrix_map_row_column_to_led_kb(uint8_t row, uint8_t column, uint8_t *led_i); |
| 89 | uint8_t rgb_matrix_map_row_column_to_led(uint8_t row, uint8_t column, uint8_t *led_i); |
| 90 | |
| 91 | void rgb_matrix_set_color(int index, uint8_t red, uint8_t green, uint8_t blue); |
| 92 | void rgb_matrix_set_color_all(uint8_t red, uint8_t green, uint8_t blue); |
| 93 | |
| 94 | bool process_rgb_matrix(uint16_t keycode, keyrecord_t *record); |
| 95 | |
| 96 | void rgb_matrix_task(void); |
| 97 | |
| 98 | // This runs after another backlight effect and replaces |
| 99 | // colors already set |
| 100 | void rgb_matrix_indicators(void); |
| 101 | void rgb_matrix_indicators_kb(void); |
| 102 | void rgb_matrix_indicators_user(void); |
| 103 | |
| 104 | void rgb_matrix_init(void); |
| 105 | |
| 106 | void rgb_matrix_set_suspend_state(bool state); |
| 107 | void rgb_matrix_toggle(void); |
| 108 | void rgb_matrix_enable(void); |
| 109 | void rgb_matrix_enable_noeeprom(void); |
| 110 | void rgb_matrix_disable(void); |
| 111 | void rgb_matrix_disable_noeeprom(void); |
| 112 | void rgb_matrix_step(void); |
| 113 | void rgb_matrix_step_reverse(void); |
| 114 | void rgb_matrix_increase_hue(void); |
| 115 | void rgb_matrix_decrease_hue(void); |
| 116 | void rgb_matrix_increase_sat(void); |
| 117 | void rgb_matrix_decrease_sat(void); |
| 118 | void rgb_matrix_increase_val(void); |
| 119 | void rgb_matrix_decrease_val(void); |
| 120 | void rgb_matrix_increase_speed(void); |
| 121 | void rgb_matrix_decrease_speed(void); |
| 122 | led_flags_t rgb_matrix_get_flags(void); |
| 123 | void rgb_matrix_set_flags(led_flags_t flags); |
| 124 | void rgb_matrix_mode(uint8_t mode); |
| 125 | void rgb_matrix_mode_noeeprom(uint8_t mode); |
| 126 | uint8_t rgb_matrix_get_mode(void); |
| 127 | void rgb_matrix_sethsv(uint16_t hue, uint8_t sat, uint8_t val); |
| 128 | void rgb_matrix_sethsv_noeeprom(uint16_t hue, uint8_t sat, uint8_t val); |
| 129 | |
| 130 | #ifndef RGBLIGHT_ENABLE |
| 131 | # define rgblight_toggle rgb_matrix_toggle |
| 132 | # define rgblight_enable rgb_matrix_enable |
| 133 | # define rgblight_enable_noeeprom rgb_matrix_enable_noeeprom |
| 134 | # define rgblight_disable rgb_matrix_disable |
| 135 | # define rgblight_disable_noeeprom rgb_matrix_disable_noeeprom |
| 136 | # define rgblight_step rgb_matrix_step |
| 137 | # define rgblight_sethsv rgb_matrix_sethsv |
| 138 | # define rgblight_sethsv_noeeprom rgb_matrix_sethsv_noeeprom |
| 139 | # define rgblight_step_reverse rgb_matrix_step_reverse |
| 140 | # define rgblight_increase_hue rgb_matrix_increase_hue |
| 141 | # define rgblight_decrease_hue rgb_matrix_decrease_hue |
| 142 | # define rgblight_increase_sat rgb_matrix_increase_sat |
| 143 | # define rgblight_decrease_sat rgb_matrix_decrease_sat |
| 144 | # define rgblight_increase_val rgb_matrix_increase_val |
| 145 | # define rgblight_decrease_val rgb_matrix_decrease_val |
| 146 | # define rgblight_increase_speed rgb_matrix_increase_speed |
| 147 | # define rgblight_decrease_speed rgb_matrix_decrease_speed |
| 148 | # define rgblight_mode rgb_matrix_mode |
| 149 | # define rgblight_mode_noeeprom rgb_matrix_mode_noeeprom |
| 150 | # define rgblight_get_mode rgb_matrix_get_mode |
| 151 | #endif |
| 152 | |
| 153 | typedef struct { |
| 154 | /* Perform any initialisation required for the other driver functions to work. */ |
| 155 | void (*init)(void); |
| 156 | /* Set the colour of a single LED in the buffer. */ |
| 157 | void (*set_color)(int index, uint8_t r, uint8_t g, uint8_t b); |
| 158 | /* Set the colour of all LEDS on the keyboard in the buffer. */ |
| 159 | void (*set_color_all)(uint8_t r, uint8_t g, uint8_t b); |
| 160 | /* Flush any buffered changes to the hardware. */ |
| 161 | void (*flush)(void); |
| 162 | } rgb_matrix_driver_t; |
| 163 | |
| 164 | extern const rgb_matrix_driver_t rgb_matrix_driver; |
| 165 | |
| 166 | extern rgb_config_t rgb_matrix_config; |
| 167 | |
| 168 | extern bool g_suspend_state; |
| 169 | extern rgb_counters_t g_rgb_counters; |
| 170 | extern led_config_t g_led_config; |
| 171 | #ifdef RGB_MATRIX_KEYREACTIVE_ENABLED |
| 172 | extern last_hit_t g_last_hit_tracker; |
| 173 | #endif |
| 174 | #ifdef RGB_MATRIX_FRAMEBUFFER_EFFECTS |
| 175 | extern uint8_t rgb_frame_buffer[MATRIX_ROWS][MATRIX_COLS]; |
| 176 | #endif |
| 177 | |
| 178 | #endif |