is31fl3733.h (9057B)
1 /* Copyright 2017 Jason Williams 2 * Copyright 2018 Jack Humbert 3 * Copyright 2018 Yiancar 4 * Copyright 2021 Doni Crosby 5 * 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. 10 * 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. 15 * 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/>. 18 */ 19 20 #pragma once 21 22 #include <stdint.h> 23 #include <stdbool.h> 24 #include "progmem.h" 25 #include "util.h" 26 27 #define IS31FL3733_REG_INTERRUPT_MASK 0xF0 28 #define IS31FL3733_REG_INTERRUPT_STATUS 0xF1 29 30 #define IS31FL3733_REG_COMMAND 0xFD 31 32 #define IS31FL3733_COMMAND_LED_CONTROL 0x00 33 #define IS31FL3733_COMMAND_PWM 0x01 34 #define IS31FL3733_COMMAND_AUTO_BREATH 0x02 35 #define IS31FL3733_COMMAND_FUNCTION 0x03 36 37 #define IS31FL3733_FUNCTION_REG_CONFIGURATION 0x00 38 #define IS31FL3733_FUNCTION_REG_GLOBAL_CURRENT 0x01 39 #define IS31FL3733_FUNCTION_REG_SW_PULLUP 0x0F 40 #define IS31FL3733_FUNCTION_REG_CS_PULLDOWN 0x10 41 #define IS31FL3733_FUNCTION_REG_RESET 0x11 42 43 #define IS31FL3733_REG_COMMAND_WRITE_LOCK 0xFE 44 #define IS31FL3733_COMMAND_WRITE_LOCK_MAGIC 0xC5 45 46 #define IS31FL3733_I2C_ADDRESS_GND_GND 0x50 47 #define IS31FL3733_I2C_ADDRESS_GND_SCL 0x51 48 #define IS31FL3733_I2C_ADDRESS_GND_SDA 0x52 49 #define IS31FL3733_I2C_ADDRESS_GND_VCC 0x53 50 #define IS31FL3733_I2C_ADDRESS_SCL_GND 0x54 51 #define IS31FL3733_I2C_ADDRESS_SCL_SCL 0x55 52 #define IS31FL3733_I2C_ADDRESS_SCL_SDA 0x56 53 #define IS31FL3733_I2C_ADDRESS_SCL_VCC 0x57 54 #define IS31FL3733_I2C_ADDRESS_SDA_GND 0x58 55 #define IS31FL3733_I2C_ADDRESS_SDA_SCL 0x59 56 #define IS31FL3733_I2C_ADDRESS_SDA_SDA 0x5A 57 #define IS31FL3733_I2C_ADDRESS_SDA_VCC 0x5B 58 #define IS31FL3733_I2C_ADDRESS_VCC_GND 0x5C 59 #define IS31FL3733_I2C_ADDRESS_VCC_SCL 0x5D 60 #define IS31FL3733_I2C_ADDRESS_VCC_SDA 0x5E 61 #define IS31FL3733_I2C_ADDRESS_VCC_VCC 0x5F 62 63 #if defined(RGB_MATRIX_IS31FL3733) 64 # define IS31FL3733_LED_COUNT RGB_MATRIX_LED_COUNT 65 #endif 66 67 #if defined(IS31FL3733_I2C_ADDRESS_4) 68 # define IS31FL3733_DRIVER_COUNT 4 69 #elif defined(IS31FL3733_I2C_ADDRESS_3) 70 # define IS31FL3733_DRIVER_COUNT 3 71 #elif defined(IS31FL3733_I2C_ADDRESS_2) 72 # define IS31FL3733_DRIVER_COUNT 2 73 #elif defined(IS31FL3733_I2C_ADDRESS_1) 74 # define IS31FL3733_DRIVER_COUNT 1 75 #endif 76 77 typedef struct is31fl3733_led_t { 78 uint8_t driver : 2; 79 uint8_t r; 80 uint8_t g; 81 uint8_t b; 82 } PACKED is31fl3733_led_t; 83 84 extern const is31fl3733_led_t PROGMEM g_is31fl3733_leds[IS31FL3733_LED_COUNT]; 85 86 void is31fl3733_init_drivers(void); 87 void is31fl3733_init(uint8_t index); 88 void is31fl3733_write_register(uint8_t index, uint8_t reg, uint8_t data); 89 void is31fl3733_select_page(uint8_t index, uint8_t page); 90 91 void is31fl3733_set_color(int index, uint8_t red, uint8_t green, uint8_t blue); 92 void is31fl3733_set_color_all(uint8_t red, uint8_t green, uint8_t blue); 93 94 void is31fl3733_set_led_control_register(uint8_t index, bool red, bool green, bool blue); 95 96 // This should not be called from an interrupt 97 // (eg. from a timer interrupt). 98 // Call this while idle (in between matrix scans). 99 // If the buffer is dirty, it will update the driver with the buffer. 100 void is31fl3733_update_pwm_buffers(uint8_t index); 101 void is31fl3733_update_led_control_registers(uint8_t index); 102 103 void is31fl3733_flush(void); 104 105 #define IS31FL3733_PDR_0_OHM 0b000 // No pull-down resistor 106 #define IS31FL3733_PDR_0K5_OHM 0b001 // 0.5 kOhm resistor 107 #define IS31FL3733_PDR_1K_OHM 0b010 // 1 kOhm resistor 108 #define IS31FL3733_PDR_2K_OHM 0b011 // 2 kOhm resistor 109 #define IS31FL3733_PDR_4K_OHM 0b100 // 4 kOhm resistor 110 #define IS31FL3733_PDR_8K_OHM 0b101 // 8 kOhm resistor 111 #define IS31FL3733_PDR_16K_OHM 0b110 // 16 kOhm resistor 112 #define IS31FL3733_PDR_32K_OHM 0b111 // 32 kOhm resistor 113 114 #define IS31FL3733_PUR_0_OHM 0b000 // No pull-up resistor 115 #define IS31FL3733_PUR_0K5_OHM 0b001 // 0.5 kOhm resistor 116 #define IS31FL3733_PUR_1K_OHM 0b010 // 1 kOhm resistor 117 #define IS31FL3733_PUR_2K_OHM 0b011 // 2 kOhm resistor 118 #define IS31FL3733_PUR_4K_OHM 0b100 // 4 kOhm resistor 119 #define IS31FL3733_PUR_8K_OHM 0b101 // 8 kOhm resistor 120 #define IS31FL3733_PUR_16K_OHM 0b110 // 16 kOhm resistor 121 #define IS31FL3733_PUR_32K_OHM 0b111 // 32 kOhm resistor 122 123 #define IS31FL3733_PWM_FREQUENCY_8K4_HZ 0b000 124 #define IS31FL3733_PWM_FREQUENCY_4K2_HZ 0b001 125 #define IS31FL3733_PWM_FREQUENCY_26K7_HZ 0b010 126 #define IS31FL3733_PWM_FREQUENCY_2K1_HZ 0b011 127 #define IS31FL3733_PWM_FREQUENCY_1K05_HZ 0b100 128 129 #define IS31FL3733_SYNC_NONE 0b00 130 #define IS31FL3733_SYNC_MASTER 0b01 131 #define IS31FL3733_SYNC_SLAVE 0b10 132 133 #define SW1_CS1 0x00 134 #define SW1_CS2 0x01 135 #define SW1_CS3 0x02 136 #define SW1_CS4 0x03 137 #define SW1_CS5 0x04 138 #define SW1_CS6 0x05 139 #define SW1_CS7 0x06 140 #define SW1_CS8 0x07 141 #define SW1_CS9 0x08 142 #define SW1_CS10 0x09 143 #define SW1_CS11 0x0A 144 #define SW1_CS12 0x0B 145 #define SW1_CS13 0x0C 146 #define SW1_CS14 0x0D 147 #define SW1_CS15 0x0E 148 #define SW1_CS16 0x0F 149 150 #define SW2_CS1 0x10 151 #define SW2_CS2 0x11 152 #define SW2_CS3 0x12 153 #define SW2_CS4 0x13 154 #define SW2_CS5 0x14 155 #define SW2_CS6 0x15 156 #define SW2_CS7 0x16 157 #define SW2_CS8 0x17 158 #define SW2_CS9 0x18 159 #define SW2_CS10 0x19 160 #define SW2_CS11 0x1A 161 #define SW2_CS12 0x1B 162 #define SW2_CS13 0x1C 163 #define SW2_CS14 0x1D 164 #define SW2_CS15 0x1E 165 #define SW2_CS16 0x1F 166 167 #define SW3_CS1 0x20 168 #define SW3_CS2 0x21 169 #define SW3_CS3 0x22 170 #define SW3_CS4 0x23 171 #define SW3_CS5 0x24 172 #define SW3_CS6 0x25 173 #define SW3_CS7 0x26 174 #define SW3_CS8 0x27 175 #define SW3_CS9 0x28 176 #define SW3_CS10 0x29 177 #define SW3_CS11 0x2A 178 #define SW3_CS12 0x2B 179 #define SW3_CS13 0x2C 180 #define SW3_CS14 0x2D 181 #define SW3_CS15 0x2E 182 #define SW3_CS16 0x2F 183 184 #define SW4_CS1 0x30 185 #define SW4_CS2 0x31 186 #define SW4_CS3 0x32 187 #define SW4_CS4 0x33 188 #define SW4_CS5 0x34 189 #define SW4_CS6 0x35 190 #define SW4_CS7 0x36 191 #define SW4_CS8 0x37 192 #define SW4_CS9 0x38 193 #define SW4_CS10 0x39 194 #define SW4_CS11 0x3A 195 #define SW4_CS12 0x3B 196 #define SW4_CS13 0x3C 197 #define SW4_CS14 0x3D 198 #define SW4_CS15 0x3E 199 #define SW4_CS16 0x3F 200 201 #define SW5_CS1 0x40 202 #define SW5_CS2 0x41 203 #define SW5_CS3 0x42 204 #define SW5_CS4 0x43 205 #define SW5_CS5 0x44 206 #define SW5_CS6 0x45 207 #define SW5_CS7 0x46 208 #define SW5_CS8 0x47 209 #define SW5_CS9 0x48 210 #define SW5_CS10 0x49 211 #define SW5_CS11 0x4A 212 #define SW5_CS12 0x4B 213 #define SW5_CS13 0x4C 214 #define SW5_CS14 0x4D 215 #define SW5_CS15 0x4E 216 #define SW5_CS16 0x4F 217 218 #define SW6_CS1 0x50 219 #define SW6_CS2 0x51 220 #define SW6_CS3 0x52 221 #define SW6_CS4 0x53 222 #define SW6_CS5 0x54 223 #define SW6_CS6 0x55 224 #define SW6_CS7 0x56 225 #define SW6_CS8 0x57 226 #define SW6_CS9 0x58 227 #define SW6_CS10 0x59 228 #define SW6_CS11 0x5A 229 #define SW6_CS12 0x5B 230 #define SW6_CS13 0x5C 231 #define SW6_CS14 0x5D 232 #define SW6_CS15 0x5E 233 #define SW6_CS16 0x5F 234 235 #define SW7_CS1 0x60 236 #define SW7_CS2 0x61 237 #define SW7_CS3 0x62 238 #define SW7_CS4 0x63 239 #define SW7_CS5 0x64 240 #define SW7_CS6 0x65 241 #define SW7_CS7 0x66 242 #define SW7_CS8 0x67 243 #define SW7_CS9 0x68 244 #define SW7_CS10 0x69 245 #define SW7_CS11 0x6A 246 #define SW7_CS12 0x6B 247 #define SW7_CS13 0x6C 248 #define SW7_CS14 0x6D 249 #define SW7_CS15 0x6E 250 #define SW7_CS16 0x6F 251 252 #define SW8_CS1 0x70 253 #define SW8_CS2 0x71 254 #define SW8_CS3 0x72 255 #define SW8_CS4 0x73 256 #define SW8_CS5 0x74 257 #define SW8_CS6 0x75 258 #define SW8_CS7 0x76 259 #define SW8_CS8 0x77 260 #define SW8_CS9 0x78 261 #define SW8_CS10 0x79 262 #define SW8_CS11 0x7A 263 #define SW8_CS12 0x7B 264 #define SW8_CS13 0x7C 265 #define SW8_CS14 0x7D 266 #define SW8_CS15 0x7E 267 #define SW8_CS16 0x7F 268 269 #define SW9_CS1 0x80 270 #define SW9_CS2 0x81 271 #define SW9_CS3 0x82 272 #define SW9_CS4 0x83 273 #define SW9_CS5 0x84 274 #define SW9_CS6 0x85 275 #define SW9_CS7 0x86 276 #define SW9_CS8 0x87 277 #define SW9_CS9 0x88 278 #define SW9_CS10 0x89 279 #define SW9_CS11 0x8A 280 #define SW9_CS12 0x8B 281 #define SW9_CS13 0x8C 282 #define SW9_CS14 0x8D 283 #define SW9_CS15 0x8E 284 #define SW9_CS16 0x8F 285 286 #define SW10_CS1 0x90 287 #define SW10_CS2 0x91 288 #define SW10_CS3 0x92 289 #define SW10_CS4 0x93 290 #define SW10_CS5 0x94 291 #define SW10_CS6 0x95 292 #define SW10_CS7 0x96 293 #define SW10_CS8 0x97 294 #define SW10_CS9 0x98 295 #define SW10_CS10 0x99 296 #define SW10_CS11 0x9A 297 #define SW10_CS12 0x9B 298 #define SW10_CS13 0x9C 299 #define SW10_CS14 0x9D 300 #define SW10_CS15 0x9E 301 #define SW10_CS16 0x9F 302 303 #define SW11_CS1 0xA0 304 #define SW11_CS2 0xA1 305 #define SW11_CS3 0xA2 306 #define SW11_CS4 0xA3 307 #define SW11_CS5 0xA4 308 #define SW11_CS6 0xA5 309 #define SW11_CS7 0xA6 310 #define SW11_CS8 0xA7 311 #define SW11_CS9 0xA8 312 #define SW11_CS10 0xA9 313 #define SW11_CS11 0xAA 314 #define SW11_CS12 0xAB 315 #define SW11_CS13 0xAC 316 #define SW11_CS14 0xAD 317 #define SW11_CS15 0xAE 318 #define SW11_CS16 0xAF 319 320 #define SW12_CS1 0xB0 321 #define SW12_CS2 0xB1 322 #define SW12_CS3 0xB2 323 #define SW12_CS4 0xB3 324 #define SW12_CS5 0xB4 325 #define SW12_CS6 0xB5 326 #define SW12_CS7 0xB6 327 #define SW12_CS8 0xB7 328 #define SW12_CS9 0xB8 329 #define SW12_CS10 0xB9 330 #define SW12_CS11 0xBA 331 #define SW12_CS12 0xBB 332 #define SW12_CS13 0xBC 333 #define SW12_CS14 0xBD 334 #define SW12_CS15 0xBE 335 #define SW12_CS16 0xBF