]> git.donarmstrong.com Git - qmk_firmware.git/blob - drivers/issi/is31fl3736.h
Add user-overridable callback for cancelling UCIS input (#5564)
[qmk_firmware.git] / drivers / issi / is31fl3736.h
1 /* Copyright 2018 Jason Williams (Wilba)
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
17 #pragma once
18
19 #include <stdint.h>
20 #include <stdbool.h>
21
22
23 // Simple interface option.
24 // If these aren't defined, just define them to make it compile
25
26
27 #ifndef DRIVER_COUNT
28 #define DRIVER_COUNT 2
29 #endif
30
31 #ifndef DRIVER_LED_TOTAL
32 #define DRIVER_LED_TOTAL 96
33 #endif
34
35
36 typedef struct is31_led {
37   uint8_t driver:2;
38   uint8_t r;
39   uint8_t g;
40   uint8_t b;
41 } __attribute__((packed)) is31_led;
42
43 extern const is31_led g_is31_leds[DRIVER_LED_TOTAL];
44
45 void IS31FL3736_init( uint8_t addr );
46 void IS31FL3736_write_register( uint8_t addr, uint8_t reg, uint8_t data );
47 void IS31FL3736_write_pwm_buffer( uint8_t addr, uint8_t *pwm_buffer );
48
49 void IS31FL3736_set_color( int index, uint8_t red, uint8_t green, uint8_t blue );
50 void IS31FL3736_set_color_all( uint8_t red, uint8_t green, uint8_t blue );
51
52 void IS31FL3736_set_led_control_register( uint8_t index, bool red, bool green, bool blue );
53
54 void IS31FL3736_mono_set_brightness( int index, uint8_t value );
55 void IS31FL3736_mono_set_brightness_all( uint8_t value );
56 void IS31FL3736_mono_set_led_control_register( uint8_t index, bool enabled );
57
58 // This should not be called from an interrupt
59 // (eg. from a timer interrupt).
60 // Call this while idle (in between matrix scans).
61 // If the buffer is dirty, it will update the driver with the buffer.
62 void IS31FL3736_update_pwm_buffers( uint8_t addr1, uint8_t addr2 );
63 void IS31FL3736_update_led_control_registers( uint8_t addr1, uint8_t addr2 );
64
65 #define A_1  0x00
66 #define A_2  0x02
67 #define A_3  0x04
68 #define A_4  0x06
69 #define A_5  0x08
70 #define A_6  0x0A
71 #define A_7  0x0C
72 #define A_8  0x0E
73
74 #define B_1  0x10
75 #define B_2  0x12
76 #define B_3  0x14
77 #define B_4  0x16
78 #define B_5  0x18
79 #define B_6  0x1A
80 #define B_7  0x1C
81 #define B_8  0x1E
82
83 #define C_1  0x20
84 #define C_2  0x22
85 #define C_3  0x24
86 #define C_4  0x26
87 #define C_5  0x28
88 #define C_6  0x2A
89 #define C_7  0x2C
90 #define C_8  0x2E
91
92 #define D_1  0x30
93 #define D_2  0x32
94 #define D_3  0x34
95 #define D_4  0x36
96 #define D_5  0x38
97 #define D_6  0x3A
98 #define D_7  0x3C
99 #define D_8  0x3E
100
101 #define E_1  0x40
102 #define E_2  0x42
103 #define E_3  0x44
104 #define E_4  0x46
105 #define E_5  0x48
106 #define E_6  0x4A
107 #define E_7  0x4C
108 #define E_8  0x4E
109
110 #define F_1  0x50
111 #define F_2  0x52
112 #define F_3  0x54
113 #define F_4  0x56
114 #define F_5  0x58
115 #define F_6  0x5A
116 #define F_7  0x5C
117 #define F_8  0x5E
118
119 #define G_1  0x60
120 #define G_2  0x62
121 #define G_3  0x64
122 #define G_4  0x66
123 #define G_5  0x68
124 #define G_6  0x6A
125 #define G_7  0x6C
126 #define G_8  0x6E
127
128 #define H_1  0x70
129 #define H_2  0x72
130 #define H_3  0x74
131 #define H_4  0x76
132 #define H_5  0x78
133 #define H_6  0x7A
134 #define H_7  0x7C
135 #define H_8  0x7E
136
137 #define I_1  0x80
138 #define I_2  0x82
139 #define I_3  0x84
140 #define I_4  0x86
141 #define I_5  0x88
142 #define I_6  0x8A
143 #define I_7  0x8C
144 #define I_8  0x8E
145
146 #define J_1  0x90
147 #define J_2  0x92
148 #define J_3  0x94
149 #define J_4  0x96
150 #define J_5  0x98
151 #define J_6  0x9A
152 #define J_7  0x9C
153 #define J_8  0x9E
154
155 #define K_1  0xA0
156 #define K_2  0xA2
157 #define K_3  0xA4
158 #define K_4  0xA6
159 #define K_5  0xA8
160 #define K_6  0xAA
161 #define K_7  0xAC
162 #define K_8  0xAE
163
164 #define L_1  0xB0
165 #define L_2  0xB2
166 #define L_3  0xB4
167 #define L_4  0xB6
168 #define L_5  0xB8
169 #define L_6  0xBA
170 #define L_7  0xBC
171 #define L_8  0xBE
172