is31fl3741.h (12315B)
1 /* Copyright 2017 Jason Williams 2 * Copyright 2018 Jack Humbert 3 * Copyright 2018 Yiancar 4 * Copyright 2020 MelGeek 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 IS31FL3741_REG_INTERRUPT_MASK 0xF0 28 #define IS31FL3741_REG_INTERRUPT_STATUS 0xF1 29 #define IS31FL3741_REG_ID 0xFC 30 31 #define IS31FL3741_REG_COMMAND 0xFD 32 33 #define IS31FL3741_COMMAND_PWM_0 0x00 34 #define IS31FL3741_COMMAND_PWM_1 0x01 35 #define IS31FL3741_COMMAND_SCALING_0 0x02 36 #define IS31FL3741_COMMAND_SCALING_1 0x03 37 #define IS31FL3741_COMMAND_FUNCTION 0x04 38 39 #define IS31FL3741_FUNCTION_REG_CONFIGURATION 0x00 40 #define IS31FL3741_FUNCTION_REG_GLOBAL_CURRENT 0x01 41 #define IS31FL3741_FUNCTION_REG_PULLDOWNUP 0x02 42 #define IS31FL3741_FUNCTION_REG_PWM_FREQUENCY 0x36 43 #define IS31FL3741_FUNCTION_REG_RESET 0x3F 44 45 #define IS31FL3741_REG_COMMAND_WRITE_LOCK 0xFE 46 #define IS31FL3741_COMMAND_WRITE_LOCK_MAGIC 0xC5 47 48 #define IS31FL3741_I2C_ADDRESS_GND 0x30 49 #define IS31FL3741_I2C_ADDRESS_SCL 0x31 50 #define IS31FL3741_I2C_ADDRESS_SDA 0x32 51 #define IS31FL3741_I2C_ADDRESS_VCC 0x33 52 53 #if defined(RGB_MATRIX_IS31FL3741) 54 # define IS31FL3741_LED_COUNT RGB_MATRIX_LED_COUNT 55 #endif 56 57 #if defined(IS31FL3741_I2C_ADDRESS_4) 58 # define IS31FL3741_DRIVER_COUNT 4 59 #elif defined(IS31FL3741_I2C_ADDRESS_3) 60 # define IS31FL3741_DRIVER_COUNT 3 61 #elif defined(IS31FL3741_I2C_ADDRESS_2) 62 # define IS31FL3741_DRIVER_COUNT 2 63 #elif defined(IS31FL3741_I2C_ADDRESS_1) 64 # define IS31FL3741_DRIVER_COUNT 1 65 #endif 66 67 typedef struct is31fl3741_led_t { 68 uint8_t driver : 2; 69 uint16_t r : 9; 70 uint16_t g : 9; 71 uint16_t b : 9; 72 } PACKED is31fl3741_led_t; 73 74 extern const is31fl3741_led_t PROGMEM g_is31fl3741_leds[IS31FL3741_LED_COUNT]; 75 76 void is31fl3741_init_drivers(void); 77 void is31fl3741_init(uint8_t index); 78 void is31fl3741_write_register(uint8_t index, uint8_t reg, uint8_t data); 79 void is31fl3741_select_page(uint8_t index, uint8_t page); 80 81 void is31fl3741_set_color(int index, uint8_t red, uint8_t green, uint8_t blue); 82 void is31fl3741_set_color_all(uint8_t red, uint8_t green, uint8_t blue); 83 84 void is31fl3741_set_led_control_register(uint8_t index, bool red, bool green, bool blue); 85 86 // This should not be called from an interrupt 87 // (eg. from a timer interrupt). 88 // Call this while idle (in between matrix scans). 89 // If the buffer is dirty, it will update the driver with the buffer. 90 void is31fl3741_update_pwm_buffers(uint8_t index); 91 void is31fl3741_update_led_control_registers(uint8_t index); 92 void is31fl3741_set_scaling_registers(const is31fl3741_led_t *pled, uint8_t red, uint8_t green, uint8_t blue); 93 94 void is31fl3741_set_pwm_buffer(const is31fl3741_led_t *pled, uint8_t red, uint8_t green, uint8_t blue); 95 96 void is31fl3741_flush(void); 97 98 #define IS31FL3741_PDR_0_OHM 0b000 // No pull-down resistor 99 #define IS31FL3741_PDR_0K5_OHM 0b001 // 0.5 kOhm resistor 100 #define IS31FL3741_PDR_1K_OHM 0b010 // 1 kOhm resistor 101 #define IS31FL3741_PDR_2K_OHM 0b011 // 2 kOhm resistor 102 #define IS31FL3741_PDR_4K_OHM 0b100 // 4 kOhm resistor 103 #define IS31FL3741_PDR_8K_OHM 0b101 // 8 kOhm resistor 104 #define IS31FL3741_PDR_16K_OHM 0b110 // 16 kOhm resistor 105 #define IS31FL3741_PDR_32K_OHM 0b111 // 32 kOhm resistor 106 107 #define IS31FL3741_PUR_0_OHM 0b000 // No pull-up resistor 108 #define IS31FL3741_PUR_0K5_OHM 0b001 // 0.5 kOhm resistor 109 #define IS31FL3741_PUR_1K_OHM 0b010 // 1 kOhm resistor 110 #define IS31FL3741_PUR_2K_OHM 0b011 // 2 kOhm resistor 111 #define IS31FL3741_PUR_4K_OHM 0b100 // 4 kOhm resistor 112 #define IS31FL3741_PUR_8K_OHM 0b101 // 8 kOhm resistor 113 #define IS31FL3741_PUR_16K_OHM 0b110 // 16 kOhm resistor 114 #define IS31FL3741_PUR_32K_OHM 0b111 // 32 kOhm resistor 115 116 #define IS31FL3741_PWM_FREQUENCY_29K_HZ 0b0000 117 #define IS31FL3741_PWM_FREQUENCY_3K6_HZ 0b0011 118 #define IS31FL3741_PWM_FREQUENCY_1K8_HZ 0b0111 119 #define IS31FL3741_PWM_FREQUENCY_900_HZ 0b1011 120 121 #define SW1_CS1 0x00 122 #define SW1_CS2 0x01 123 #define SW1_CS3 0x02 124 #define SW1_CS4 0x03 125 #define SW1_CS5 0x04 126 #define SW1_CS6 0x05 127 #define SW1_CS7 0x06 128 #define SW1_CS8 0x07 129 #define SW1_CS9 0x08 130 #define SW1_CS10 0x09 131 #define SW1_CS11 0x0A 132 #define SW1_CS12 0x0B 133 #define SW1_CS13 0x0C 134 #define SW1_CS14 0x0D 135 #define SW1_CS15 0x0E 136 #define SW1_CS16 0x0F 137 #define SW1_CS17 0x10 138 #define SW1_CS18 0x11 139 #define SW1_CS19 0x12 140 #define SW1_CS20 0x13 141 #define SW1_CS21 0x14 142 #define SW1_CS22 0x15 143 #define SW1_CS23 0x16 144 #define SW1_CS24 0x17 145 #define SW1_CS25 0x18 146 #define SW1_CS26 0x19 147 #define SW1_CS27 0x1A 148 #define SW1_CS28 0x1B 149 #define SW1_CS29 0x1C 150 #define SW1_CS30 0x1D 151 152 #define SW2_CS1 0x1E 153 #define SW2_CS2 0x1F 154 #define SW2_CS3 0x20 155 #define SW2_CS4 0x21 156 #define SW2_CS5 0x22 157 #define SW2_CS6 0x23 158 #define SW2_CS7 0x24 159 #define SW2_CS8 0x25 160 #define SW2_CS9 0x26 161 #define SW2_CS10 0x27 162 #define SW2_CS11 0x28 163 #define SW2_CS12 0x29 164 #define SW2_CS13 0x2A 165 #define SW2_CS14 0x2B 166 #define SW2_CS15 0x2C 167 #define SW2_CS16 0x2D 168 #define SW2_CS17 0x2E 169 #define SW2_CS18 0x2F 170 #define SW2_CS19 0x30 171 #define SW2_CS20 0x31 172 #define SW2_CS21 0x32 173 #define SW2_CS22 0x33 174 #define SW2_CS23 0x34 175 #define SW2_CS24 0x35 176 #define SW2_CS25 0x36 177 #define SW2_CS26 0x37 178 #define SW2_CS27 0x38 179 #define SW2_CS28 0x39 180 #define SW2_CS29 0x3A 181 #define SW2_CS30 0x3B 182 183 #define SW3_CS1 0x3C 184 #define SW3_CS2 0x3D 185 #define SW3_CS3 0x3E 186 #define SW3_CS4 0x3F 187 #define SW3_CS5 0x40 188 #define SW3_CS6 0x41 189 #define SW3_CS7 0x42 190 #define SW3_CS8 0x43 191 #define SW3_CS9 0x44 192 #define SW3_CS10 0x45 193 #define SW3_CS11 0x46 194 #define SW3_CS12 0x47 195 #define SW3_CS13 0x48 196 #define SW3_CS14 0x49 197 #define SW3_CS15 0x4A 198 #define SW3_CS16 0x4B 199 #define SW3_CS17 0x4C 200 #define SW3_CS18 0x4D 201 #define SW3_CS19 0x4E 202 #define SW3_CS20 0x4F 203 #define SW3_CS21 0x50 204 #define SW3_CS22 0x51 205 #define SW3_CS23 0x52 206 #define SW3_CS24 0x53 207 #define SW3_CS25 0x54 208 #define SW3_CS26 0x55 209 #define SW3_CS27 0x56 210 #define SW3_CS28 0x57 211 #define SW3_CS29 0x58 212 #define SW3_CS30 0x59 213 214 #define SW4_CS1 0x5A 215 #define SW4_CS2 0x5B 216 #define SW4_CS3 0x5C 217 #define SW4_CS4 0x5D 218 #define SW4_CS5 0x5E 219 #define SW4_CS6 0x5F 220 #define SW4_CS7 0x60 221 #define SW4_CS8 0x61 222 #define SW4_CS9 0x62 223 #define SW4_CS10 0x63 224 #define SW4_CS11 0x64 225 #define SW4_CS12 0x65 226 #define SW4_CS13 0x66 227 #define SW4_CS14 0x67 228 #define SW4_CS15 0x68 229 #define SW4_CS16 0x69 230 #define SW4_CS17 0x6A 231 #define SW4_CS18 0x6B 232 #define SW4_CS19 0x6C 233 #define SW4_CS20 0x6D 234 #define SW4_CS21 0x6E 235 #define SW4_CS22 0x6F 236 #define SW4_CS23 0x70 237 #define SW4_CS24 0x71 238 #define SW4_CS25 0x72 239 #define SW4_CS26 0x73 240 #define SW4_CS27 0x74 241 #define SW4_CS28 0x75 242 #define SW4_CS29 0x76 243 #define SW4_CS30 0x77 244 245 #define SW5_CS1 0x78 246 #define SW5_CS2 0x79 247 #define SW5_CS3 0x7A 248 #define SW5_CS4 0x7B 249 #define SW5_CS5 0x7C 250 #define SW5_CS6 0x7D 251 #define SW5_CS7 0x7E 252 #define SW5_CS8 0x7F 253 #define SW5_CS9 0x80 254 #define SW5_CS10 0x81 255 #define SW5_CS11 0x82 256 #define SW5_CS12 0x83 257 #define SW5_CS13 0x84 258 #define SW5_CS14 0x85 259 #define SW5_CS15 0x86 260 #define SW5_CS16 0x87 261 #define SW5_CS17 0x88 262 #define SW5_CS18 0x89 263 #define SW5_CS19 0x8A 264 #define SW5_CS20 0x8B 265 #define SW5_CS21 0x8C 266 #define SW5_CS22 0x8D 267 #define SW5_CS23 0x8E 268 #define SW5_CS24 0x8F 269 #define SW5_CS25 0x90 270 #define SW5_CS26 0x91 271 #define SW5_CS27 0x92 272 #define SW5_CS28 0x93 273 #define SW5_CS29 0x94 274 #define SW5_CS30 0x95 275 276 #define SW6_CS1 0x96 277 #define SW6_CS2 0x97 278 #define SW6_CS3 0x98 279 #define SW6_CS4 0x99 280 #define SW6_CS5 0x9A 281 #define SW6_CS6 0x9B 282 #define SW6_CS7 0x9C 283 #define SW6_CS8 0x9D 284 #define SW6_CS9 0x9E 285 #define SW6_CS10 0x9F 286 #define SW6_CS11 0xA0 287 #define SW6_CS12 0xA1 288 #define SW6_CS13 0xA2 289 #define SW6_CS14 0xA3 290 #define SW6_CS15 0xA4 291 #define SW6_CS16 0xA5 292 #define SW6_CS17 0xA6 293 #define SW6_CS18 0xA7 294 #define SW6_CS19 0xA8 295 #define SW6_CS20 0xA9 296 #define SW6_CS21 0xAA 297 #define SW6_CS22 0xAB 298 #define SW6_CS23 0xAC 299 #define SW6_CS24 0xAD 300 #define SW6_CS25 0xAE 301 #define SW6_CS26 0xAF 302 #define SW6_CS27 0xB0 303 #define SW6_CS28 0xB1 304 #define SW6_CS29 0xB2 305 #define SW6_CS30 0xB3 306 307 #define SW7_CS1 0x100 308 #define SW7_CS2 0x101 309 #define SW7_CS3 0x102 310 #define SW7_CS4 0x103 311 #define SW7_CS5 0x104 312 #define SW7_CS6 0x105 313 #define SW7_CS7 0x106 314 #define SW7_CS8 0x107 315 #define SW7_CS9 0x108 316 #define SW7_CS10 0x109 317 #define SW7_CS11 0x10A 318 #define SW7_CS12 0x10B 319 #define SW7_CS13 0x10C 320 #define SW7_CS14 0x10D 321 #define SW7_CS15 0x10E 322 #define SW7_CS16 0x10F 323 #define SW7_CS17 0x110 324 #define SW7_CS18 0x111 325 #define SW7_CS19 0x112 326 #define SW7_CS20 0x113 327 #define SW7_CS21 0x114 328 #define SW7_CS22 0x115 329 #define SW7_CS23 0x116 330 #define SW7_CS24 0x117 331 #define SW7_CS25 0x118 332 #define SW7_CS26 0x119 333 #define SW7_CS27 0x11A 334 #define SW7_CS28 0x11B 335 #define SW7_CS29 0x11C 336 #define SW7_CS30 0x11D 337 338 #define SW8_CS1 0x11E 339 #define SW8_CS2 0x11F 340 #define SW8_CS3 0x120 341 #define SW8_CS4 0x121 342 #define SW8_CS5 0x122 343 #define SW8_CS6 0x123 344 #define SW8_CS7 0x124 345 #define SW8_CS8 0x125 346 #define SW8_CS9 0x126 347 #define SW8_CS10 0x127 348 #define SW8_CS11 0x128 349 #define SW8_CS12 0x129 350 #define SW8_CS13 0x12A 351 #define SW8_CS14 0x12B 352 #define SW8_CS15 0x12C 353 #define SW8_CS16 0x12D 354 #define SW8_CS17 0x12E 355 #define SW8_CS18 0x12F 356 #define SW8_CS19 0x130 357 #define SW8_CS20 0x131 358 #define SW8_CS21 0x132 359 #define SW8_CS22 0x133 360 #define SW8_CS23 0x134 361 #define SW8_CS24 0x135 362 #define SW8_CS25 0x136 363 #define SW8_CS26 0x137 364 #define SW8_CS27 0x138 365 #define SW8_CS28 0x139 366 #define SW8_CS29 0x13A 367 #define SW8_CS30 0x13B 368 369 #define SW9_CS1 0x13C 370 #define SW9_CS2 0x13D 371 #define SW9_CS3 0x13E 372 #define SW9_CS4 0x13F 373 #define SW9_CS5 0x140 374 #define SW9_CS6 0x141 375 #define SW9_CS7 0x142 376 #define SW9_CS8 0x143 377 #define SW9_CS9 0x144 378 #define SW9_CS10 0x145 379 #define SW9_CS11 0x146 380 #define SW9_CS12 0x147 381 #define SW9_CS13 0x148 382 #define SW9_CS14 0x149 383 #define SW9_CS15 0x14A 384 #define SW9_CS16 0x14B 385 #define SW9_CS17 0x14C 386 #define SW9_CS18 0x14D 387 #define SW9_CS19 0x14E 388 #define SW9_CS20 0x14F 389 #define SW9_CS21 0x150 390 #define SW9_CS22 0x151 391 #define SW9_CS23 0x152 392 #define SW9_CS24 0x153 393 #define SW9_CS25 0x154 394 #define SW9_CS26 0x155 395 #define SW9_CS27 0x156 396 #define SW9_CS28 0x157 397 #define SW9_CS29 0x158 398 #define SW9_CS30 0x159 399 400 #define SW1_CS31 0x15A 401 #define SW1_CS32 0x15B 402 #define SW1_CS33 0x15C 403 #define SW1_CS34 0x15D 404 #define SW1_CS35 0x15E 405 #define SW1_CS36 0x15F 406 #define SW1_CS37 0x160 407 #define SW1_CS38 0x161 408 #define SW1_CS39 0x162 409 410 #define SW2_CS31 0x163 411 #define SW2_CS32 0x164 412 #define SW2_CS33 0x165 413 #define SW2_CS34 0x166 414 #define SW2_CS35 0x167 415 #define SW2_CS36 0x168 416 #define SW2_CS37 0x169 417 #define SW2_CS38 0x16A 418 #define SW2_CS39 0x16B 419 420 #define SW3_CS31 0x16C 421 #define SW3_CS32 0x16D 422 #define SW3_CS33 0x16E 423 #define SW3_CS34 0x16F 424 #define SW3_CS35 0x170 425 #define SW3_CS36 0x171 426 #define SW3_CS37 0x172 427 #define SW3_CS38 0x173 428 #define SW3_CS39 0x174 429 430 #define SW4_CS31 0x175 431 #define SW4_CS32 0x176 432 #define SW4_CS33 0x177 433 #define SW4_CS34 0x178 434 #define SW4_CS35 0x179 435 #define SW4_CS36 0x17A 436 #define SW4_CS37 0x17B 437 #define SW4_CS38 0x17C 438 #define SW4_CS39 0x17D 439 440 #define SW5_CS31 0x17E 441 #define SW5_CS32 0x17F 442 #define SW5_CS33 0x180 443 #define SW5_CS34 0x181 444 #define SW5_CS35 0x182 445 #define SW5_CS36 0x183 446 #define SW5_CS37 0x184 447 #define SW5_CS38 0x185 448 #define SW5_CS39 0x186 449 450 #define SW6_CS31 0x187 451 #define SW6_CS32 0x188 452 #define SW6_CS33 0x189 453 #define SW6_CS34 0x18A 454 #define SW6_CS35 0x18B 455 #define SW6_CS36 0x18C 456 #define SW6_CS37 0x18D 457 #define SW6_CS38 0x18E 458 #define SW6_CS39 0x18F 459 460 #define SW7_CS31 0x190 461 #define SW7_CS32 0x191 462 #define SW7_CS33 0x192 463 #define SW7_CS34 0x193 464 #define SW7_CS35 0x194 465 #define SW7_CS36 0x195 466 #define SW7_CS37 0x196 467 #define SW7_CS38 0x197 468 #define SW7_CS39 0x198 469 470 #define SW8_CS31 0x199 471 #define SW8_CS32 0x19A 472 #define SW8_CS33 0x19B 473 #define SW8_CS34 0x19C 474 #define SW8_CS35 0x19D 475 #define SW8_CS36 0x19E 476 #define SW8_CS37 0x19F 477 #define SW8_CS38 0x1A0 478 #define SW8_CS39 0x1A1 479 480 #define SW9_CS31 0x1A2 481 #define SW9_CS32 0x1A3 482 #define SW9_CS33 0x1A4 483 #define SW9_CS34 0x1A5 484 #define SW9_CS35 0x1A6 485 #define SW9_CS36 0x1A7 486 #define SW9_CS37 0x1A8 487 #define SW9_CS38 0x1A9 488 #define SW9_CS39 0x1AA