qmk_firmware/quantum/led_matrix.h

98 lines
3.1 KiB
C
Raw Normal View History

/* Copyright 2017 Jason Williams
* Copyright 2017 Jack Humbert
* Copyright 2018 Yiancar
* Copyright 2019 Clueboard
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
2021-03-13 01:38:26 +01:00
#include <stdint.h>
#include <stdbool.h>
#include "led_matrix_types.h"
2021-03-13 01:38:26 +01:00
#include "quantum.h"
#ifdef IS31FL3731
# include "is31fl3731-simple.h"
#endif
enum led_matrix_effects {
2019-01-28 02:07:07 +01:00
LED_MATRIX_UNIFORM_BRIGHTNESS = 1,
// All new effects go above this line
LED_MATRIX_EFFECT_MAX
};
void led_matrix_set_index_value(int index, uint8_t value);
void led_matrix_set_index_value_all(uint8_t value);
// This runs after another backlight effect and replaces
// colors already set
void led_matrix_indicators(void);
void led_matrix_indicators_kb(void);
void led_matrix_indicators_user(void);
void led_matrix_init(void);
void led_matrix_setup_drivers(void);
void led_matrix_set_suspend_state(bool state);
void led_matrix_set_indicator_state(uint8_t state);
void led_matrix_task(void);
// This should not be called from an interrupt
// (eg. from a timer interrupt).
// Call this while idle (in between matrix scans).
// If the buffer is dirty, it will update the driver with the buffer.
void led_matrix_update_pwm_buffers(void);
bool process_led_matrix(uint16_t keycode, keyrecord_t *record);
uint32_t led_matrix_get_tick(void);
2019-08-30 20:19:03 +02:00
void led_matrix_toggle(void);
void led_matrix_enable(void);
void led_matrix_enable_noeeprom(void);
void led_matrix_disable(void);
void led_matrix_disable_noeeprom(void);
void led_matrix_step(void);
void led_matrix_step_reverse(void);
void led_matrix_increase_val(void);
void led_matrix_decrease_val(void);
void led_matrix_increase_speed(void);
void led_matrix_decrease_speed(void);
void led_matrix_mode(uint8_t mode, bool eeprom_write);
void led_matrix_mode_noeeprom(uint8_t mode);
uint8_t led_matrix_get_mode(void);
2019-08-30 20:19:03 +02:00
void led_matrix_set_value(uint8_t mode);
void led_matrix_set_value_noeeprom(uint8_t mode);
typedef struct {
/* Perform any initialisation required for the other driver functions to work. */
void (*init)(void);
/* Set the brightness of a single LED in the buffer. */
void (*set_value)(int index, uint8_t value);
/* Set the brightness of all LEDS on the keyboard in the buffer. */
void (*set_value_all)(uint8_t value);
/* Flush any buffered changes to the hardware. */
void (*flush)(void);
} led_matrix_driver_t;
extern const led_matrix_driver_t led_matrix_driver;
extern led_eeconfig_t led_matrix_eeconfig;
extern led_config_t g_led_config;