1 /* Copyright 2017 Jason Williams
2 * Copyright 2017 Jack Humbert
3 * Copyright 2018 Yiancar
4 * Copyright 2019 Clueboard
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include "ledmatrix.h"
30 led_config_t led_matrix_config;
33 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
37 #define MIN(a,b) ((a) < (b)? (a): (b))
40 #ifndef LED_DISABLE_AFTER_TIMEOUT
41 #define LED_DISABLE_AFTER_TIMEOUT 0
44 #ifndef LED_DISABLE_WHEN_USB_SUSPENDED
45 #define LED_DISABLE_WHEN_USB_SUSPENDED false
48 #ifndef EECONFIG_LED_MATRIX
49 #define EECONFIG_LED_MATRIX EECONFIG_RGBLIGHT
52 #if !defined(LED_MATRIX_MAXIMUM_BRIGHTNESS) || LED_MATRIX_MAXIMUM_BRIGHTNESS > 255
53 #define LED_MATRIX_MAXIMUM_BRIGHTNESS 255
56 bool g_suspend_state = false;
58 // Global tick at 20 Hz
61 // Ticks since this key was last hit.
62 uint8_t g_key_hit[LED_DRIVER_LED_COUNT];
64 // Ticks since any key was last hit.
65 uint32_t g_any_key_hit = 0;
67 uint32_t eeconfig_read_led_matrix(void) {
68 return eeprom_read_dword(EECONFIG_LED_MATRIX);
71 void eeconfig_update_led_matrix(uint32_t config_value) {
72 eeprom_update_dword(EECONFIG_LED_MATRIX, config_value);
75 void eeconfig_update_led_matrix_default(void) {
76 dprintf("eeconfig_update_led_matrix_default\n");
77 led_matrix_config.enable = 1;
78 led_matrix_config.mode = LED_MATRIX_UNIFORM_BRIGHTNESS;
79 led_matrix_config.val = 128;
80 led_matrix_config.speed = 0;
81 eeconfig_update_led_matrix(led_matrix_config.raw);
84 void eeconfig_debug_led_matrix(void) {
85 dprintf("led_matrix_config eeprom\n");
86 dprintf("led_matrix_config.enable = %d\n", led_matrix_config.enable);
87 dprintf("led_matrix_config.mode = %d\n", led_matrix_config.mode);
88 dprintf("led_matrix_config.val = %d\n", led_matrix_config.val);
89 dprintf("led_matrix_config.speed = %d\n", led_matrix_config.speed);
93 #ifndef LED_HITS_TO_REMEMBER
94 #define LED_HITS_TO_REMEMBER 8
96 uint8_t g_last_led_hit[LED_HITS_TO_REMEMBER] = {255};
97 uint8_t g_last_led_count = 0;
99 void map_row_column_to_led(uint8_t row, uint8_t column, uint8_t *led_i, uint8_t *led_count) {
103 for (uint8_t i = 0; i < LED_DRIVER_LED_COUNT; i++) {
104 // map_index_to_led(i, &led);
106 if (row == led.matrix_co.row && column == led.matrix_co.col) {
107 led_i[*led_count] = i;
113 void led_matrix_update_pwm_buffers(void) {
114 led_matrix_driver.flush();
117 void led_matrix_set_index_value(int index, uint8_t value) {
118 led_matrix_driver.set_value(index, value);
121 void led_matrix_set_index_value_all(uint8_t value) {
122 led_matrix_driver.set_value_all(value);
125 bool process_led_matrix(uint16_t keycode, keyrecord_t *record) {
126 if (record->event.pressed) {
127 uint8_t led[8], led_count;
128 map_row_column_to_led(record->event.key.row, record->event.key.col, led, &led_count);
130 for (uint8_t i = LED_HITS_TO_REMEMBER; i > 1; i--) {
131 g_last_led_hit[i - 1] = g_last_led_hit[i - 2];
133 g_last_led_hit[0] = led[0];
134 g_last_led_count = MIN(LED_HITS_TO_REMEMBER, g_last_led_count + 1);
136 for(uint8_t i = 0; i < led_count; i++)
137 g_key_hit[led[i]] = 0;
140 #ifdef LED_MATRIX_KEYRELEASES
141 uint8_t led[8], led_count;
142 map_row_column_to_led(record->event.key.row, record->event.key.col, led, &led_count);
143 for(uint8_t i = 0; i < led_count; i++)
144 g_key_hit[led[i]] = 255;
152 void led_matrix_set_suspend_state(bool state) {
153 g_suspend_state = state;
157 void led_matrix_all_off(void) {
158 led_matrix_set_index_value_all(0);
161 // Uniform brightness
162 void led_matrix_uniform_brightness(void) {
163 led_matrix_set_index_value_all(LED_MATRIX_MAXIMUM_BRIGHTNESS / BACKLIGHT_LEVELS * led_matrix_config.val);
166 void led_matrix_custom(void) {}
168 void led_matrix_task(void) {
169 if (!led_matrix_config.enable) {
170 led_matrix_all_off();
171 led_matrix_indicators();
177 if (g_any_key_hit < 0xFFFFFFFF) {
181 for (int led = 0; led < LED_DRIVER_LED_COUNT; led++) {
182 if (g_key_hit[led] < 255) {
183 if (g_key_hit[led] == 254)
184 g_last_led_count = MAX(g_last_led_count - 1, 0);
189 // Ideally we would also stop sending zeros to the LED driver PWM buffers
190 // while suspended and just do a software shutdown. This is a cheap hack for now.
191 bool suspend_backlight = ((g_suspend_state && LED_DISABLE_WHEN_USB_SUSPENDED) ||
192 (LED_DISABLE_AFTER_TIMEOUT > 0 && g_any_key_hit > LED_DISABLE_AFTER_TIMEOUT * 60 * 20));
193 uint8_t effect = suspend_backlight ? 0 : led_matrix_config.mode;
195 // this gets ticked at 20 Hz.
196 // each effect can opt to do calculations
197 // and/or request PWM buffer updates.
199 case LED_MATRIX_UNIFORM_BRIGHTNESS:
200 led_matrix_uniform_brightness();
207 if (!suspend_backlight) {
208 led_matrix_indicators();
211 // Tell the LED driver to update its state
212 led_matrix_driver.flush();
215 void led_matrix_indicators(void) {
216 led_matrix_indicators_kb();
217 led_matrix_indicators_user();
220 __attribute__((weak))
221 void led_matrix_indicators_kb(void) {}
223 __attribute__((weak))
224 void led_matrix_indicators_user(void) {}
227 // void led_matrix_set_indicator_index(uint8_t *index, uint8_t row, uint8_t column)
229 // if (row >= MATRIX_ROWS)
231 // // Special value, 255=none, 254=all
236 // // This needs updated to something like
237 // // uint8_t led[8], led_count;
238 // // map_row_column_to_led(row,column,led,&led_count);
239 // // for(uint8_t i = 0; i < led_count; i++)
240 // map_row_column_to_led(row, column, index);
244 void led_matrix_init(void) {
245 led_matrix_driver.init();
247 // Wait half a second for the driver to finish initializing
250 // clear the key hits
251 for (int led=0; led<LED_DRIVER_LED_COUNT; led++) {
252 g_key_hit[led] = 255;
255 if (!eeconfig_is_enabled()) {
256 dprintf("led_matrix_init_drivers eeconfig is not enabled.\n");
258 eeconfig_update_led_matrix_default();
261 led_matrix_config.raw = eeconfig_read_led_matrix();
263 if (!led_matrix_config.mode) {
264 dprintf("led_matrix_init_drivers led_matrix_config.mode = 0. Write default values to EEPROM.\n");
265 eeconfig_update_led_matrix_default();
266 led_matrix_config.raw = eeconfig_read_led_matrix();
269 eeconfig_debug_led_matrix(); // display current eeprom values
272 // Deals with the messy details of incrementing an integer
273 static uint8_t increment(uint8_t value, uint8_t step, uint8_t min, uint8_t max) {
274 int16_t new_value = value;
276 return MIN(MAX(new_value, min), max);
279 static uint8_t decrement(uint8_t value, uint8_t step, uint8_t min, uint8_t max) {
280 int16_t new_value = value;
282 return MIN(MAX(new_value, min), max);
285 // void *backlight_get_custom_key_value_eeprom_address(uint8_t led) {
286 // // 3 bytes per value
287 // return EECONFIG_LED_MATRIX + (led * 3);
290 // void backlight_get_key_value(uint8_t led, uint8_t *value) {
291 // void *address = backlight_get_custom_key_value_eeprom_address(led);
292 // value = eeprom_read_byte(address);
295 // void backlight_set_key_value(uint8_t row, uint8_t column, uint8_t value) {
296 // uint8_t led[8], led_count;
297 // map_row_column_to_led(row,column,led,&led_count);
298 // for(uint8_t i = 0; i < led_count; i++) {
299 // if (led[i] < LED_DRIVER_LED_COUNT) {
300 // void *address = backlight_get_custom_key_value_eeprom_address(led[i]);
301 // eeprom_update_byte(address, value);
306 uint32_t led_matrix_get_tick(void) {
310 void led_matrix_toggle(void) {
311 led_matrix_config.enable ^= 1;
312 eeconfig_update_led_matrix(led_matrix_config.raw);
315 void led_matrix_enable(void) {
316 led_matrix_config.enable = 1;
317 eeconfig_update_led_matrix(led_matrix_config.raw);
320 void led_matrix_enable_noeeprom(void) {
321 led_matrix_config.enable = 1;
324 void led_matrix_disable(void) {
325 led_matrix_config.enable = 0;
326 eeconfig_update_led_matrix(led_matrix_config.raw);
329 void led_matrix_disable_noeeprom(void) {
330 led_matrix_config.enable = 0;
333 void led_matrix_step(void) {
334 led_matrix_config.mode++;
335 if (led_matrix_config.mode >= LED_MATRIX_EFFECT_MAX) {
336 led_matrix_config.mode = 1;
338 eeconfig_update_led_matrix(led_matrix_config.raw);
341 void led_matrix_step_reverse(void) {
342 led_matrix_config.mode--;
343 if (led_matrix_config.mode < 1) {
344 led_matrix_config.mode = LED_MATRIX_EFFECT_MAX - 1;
346 eeconfig_update_led_matrix(led_matrix_config.raw);
349 void led_matrix_increase_val(void) {
350 led_matrix_config.val = increment(led_matrix_config.val, 8, 0, LED_MATRIX_MAXIMUM_BRIGHTNESS);
351 eeconfig_update_led_matrix(led_matrix_config.raw);
354 void led_matrix_decrease_val(void) {
355 led_matrix_config.val = decrement(led_matrix_config.val, 8, 0, LED_MATRIX_MAXIMUM_BRIGHTNESS);
356 eeconfig_update_led_matrix(led_matrix_config.raw);
359 void led_matrix_increase_speed(void) {
360 led_matrix_config.speed = increment(led_matrix_config.speed, 1, 0, 3);
361 eeconfig_update_led_matrix(led_matrix_config.raw);//EECONFIG needs to be increased to support this
364 void led_matrix_decrease_speed(void) {
365 led_matrix_config.speed = decrement(led_matrix_config.speed, 1, 0, 3);
366 eeconfig_update_led_matrix(led_matrix_config.raw);//EECONFIG needs to be increased to support this
369 void led_matrix_mode(uint8_t mode, bool eeprom_write) {
370 led_matrix_config.mode = mode;
372 eeconfig_update_led_matrix(led_matrix_config.raw);
376 uint8_t led_matrix_get_mode(void) {
377 return led_matrix_config.mode;
380 void led_matrix_set_value_noeeprom(uint8_t val) {
381 led_matrix_config.val = val;
384 void led_matrix_set_value(uint8_t val) {
385 led_matrix_set_value_noeeprom(val);
386 eeconfig_update_led_matrix(led_matrix_config.raw);
389 void backlight_set(uint8_t val) {
390 led_matrix_set_value(val);