is31fl3743a.h (9004B)
1 /* Copyright 2017 Jason Williams 2 * Copyright 2018 Jack Humbert 3 * Copyright 2018 Yiancar 4 * Copyright 2020 MelGeek 5 * Copyright 2021 MasterSpoon 6 * 7 * This program is free software: you can redistribute it and/or modify 8 * it under the terms of the GNU General Public License as published by 9 * the Free Software Foundation, either version 2 of the License, or 10 * (at your option) any later version. 11 * 12 * This program is distributed in the hope that it will be useful, 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * GNU General Public License for more details. 16 * 17 * You should have received a copy of the GNU General Public License 18 * along with this program. If not, see <http://www.gnu.org/licenses/>. 19 */ 20 21 #pragma once 22 23 #include <stdint.h> 24 #include <stdbool.h> 25 #include "progmem.h" 26 #include "util.h" 27 28 #define IS31FL3743A_REG_ID 0xFC 29 30 #define IS31FL3743A_REG_COMMAND 0xFD 31 32 #define IS31FL3743A_COMMAND_PWM 0x00 33 #define IS31FL3743A_COMMAND_SCALING 0x01 34 #define IS31FL3743A_COMMAND_FUNCTION 0x02 35 36 #define IS31FL3743A_FUNCTION_REG_CONFIGURATION 0x00 37 #define IS31FL3743A_FUNCTION_REG_GLOBAL_CURRENT 0x01 38 #define IS31FL3743A_FUNCTION_REG_PULLDOWNUP 0x02 39 #define IS31FL3743A_FUNCTION_REG_TEMPERATURE 0x24 40 #define IS31FL3743A_FUNCTION_REG_SPREAD_SPECTRUM 0x25 41 #define IS31FL3743A_FUNCTION_REG_RESET 0x2F 42 43 #define IS31FL3743A_REG_COMMAND_WRITE_LOCK 0xFE 44 #define IS31FL3743A_COMMAND_WRITE_LOCK_MAGIC 0xC5 45 46 #define IS31FL3743A_I2C_ADDRESS_GND_GND 0x20 47 #define IS31FL3743A_I2C_ADDRESS_GND_SCL 0x21 48 #define IS31FL3743A_I2C_ADDRESS_GND_SDA 0x22 49 #define IS31FL3743A_I2C_ADDRESS_GND_VCC 0x23 50 #define IS31FL3743A_I2C_ADDRESS_SCL_GND 0x24 51 #define IS31FL3743A_I2C_ADDRESS_SCL_SCL 0x25 52 #define IS31FL3743A_I2C_ADDRESS_SCL_SDA 0x26 53 #define IS31FL3743A_I2C_ADDRESS_SCL_VCC 0x27 54 #define IS31FL3743A_I2C_ADDRESS_SDA_GND 0x28 55 #define IS31FL3743A_I2C_ADDRESS_SDA_SCL 0x29 56 #define IS31FL3743A_I2C_ADDRESS_SDA_SDA 0x2A 57 #define IS31FL3743A_I2C_ADDRESS_SDA_VCC 0x2B 58 #define IS31FL3743A_I2C_ADDRESS_VCC_GND 0x2C 59 #define IS31FL3743A_I2C_ADDRESS_VCC_SCL 0x2D 60 #define IS31FL3743A_I2C_ADDRESS_VCC_SDA 0x2E 61 #define IS31FL3743A_I2C_ADDRESS_VCC_VCC 0x2F 62 63 #if defined(RGB_MATRIX_IS31FL3743A) 64 # define IS31FL3743A_LED_COUNT RGB_MATRIX_LED_COUNT 65 #endif 66 67 #if defined(IS31FL3743A_I2C_ADDRESS_4) 68 # define IS31FL3743A_DRIVER_COUNT 4 69 #elif defined(IS31FL3743A_I2C_ADDRESS_3) 70 # define IS31FL3743A_DRIVER_COUNT 3 71 #elif defined(IS31FL3743A_I2C_ADDRESS_2) 72 # define IS31FL3743A_DRIVER_COUNT 2 73 #elif defined(IS31FL3743A_I2C_ADDRESS_1) 74 # define IS31FL3743A_DRIVER_COUNT 1 75 #endif 76 77 typedef struct is31fl3743a_led_t { 78 uint8_t driver : 2; 79 uint8_t r; 80 uint8_t g; 81 uint8_t b; 82 } PACKED is31fl3743a_led_t; 83 84 extern const is31fl3743a_led_t PROGMEM g_is31fl3743a_leds[IS31FL3743A_LED_COUNT]; 85 86 void is31fl3743a_init_drivers(void); 87 void is31fl3743a_init(uint8_t index); 88 void is31fl3743a_write_register(uint8_t index, uint8_t reg, uint8_t data); 89 void is31fl3743a_select_page(uint8_t index, uint8_t page); 90 91 void is31fl3743a_set_color(int index, uint8_t red, uint8_t green, uint8_t blue); 92 void is31fl3743a_set_color_all(uint8_t red, uint8_t green, uint8_t blue); 93 94 void is31fl3743a_set_scaling_register(uint8_t index, uint8_t red, uint8_t green, uint8_t blue); 95 96 void is31fl3743a_update_pwm_buffers(uint8_t index); 97 void is31fl3743a_update_scaling_registers(uint8_t index); 98 99 void is31fl3743a_flush(void); 100 101 #define IS31FL3743A_PDR_0_OHM 0b000 // No pull-down resistor 102 #define IS31FL3743A_PDR_0K5_OHM_SW_OFF 0b001 // 0.5 kOhm resistor in SWx off time 103 #define IS31FL3743A_PDR_1K_OHM_SW_OFF 0b010 // 1 kOhm resistor in SWx off time 104 #define IS31FL3743A_PDR_2K_OHM_SW_OFF 0b011 // 2 kOhm resistor in SWx off time 105 #define IS31FL3743A_PDR_1K_OHM 0b100 // 1 kOhm resistor 106 #define IS31FL3743A_PDR_2K_OHM 0b101 // 2 kOhm resistor 107 #define IS31FL3743A_PDR_4K_OHM 0b110 // 4 kOhm resistor 108 #define IS31FL3743A_PDR_8K_OHM 0b111 // 8 kOhm resistor 109 110 #define IS31FL3743A_PUR_0_OHM 0b000 // No pull-up resistor 111 #define IS31FL3743A_PUR_0K5_OHM_CS_OFF 0b001 // 0.5 kOhm resistor in CSy off time 112 #define IS31FL3743A_PUR_1K_OHM_CS_OFF 0b010 // 1 kOhm resistor in CSy off time 113 #define IS31FL3743A_PUR_2K_OHM_CS_OFF 0b011 // 2 kOhm resistor in CSy off time 114 #define IS31FL3743A_PUR_1K_OHM 0b100 // 1 kOhm resistor 115 #define IS31FL3743A_PUR_2K_OHM 0b101 // 2 kOhm resistor 116 #define IS31FL3743A_PUR_4K_OHM 0b110 // 4 kOhm resistor 117 #define IS31FL3743A_PUR_8K_OHM 0b111 // 8 kOhm resistor 118 119 #define IS31FL3743A_SYNC_NONE 0b00 120 #define IS31FL3743A_SYNC_SLAVE 0b10 121 #define IS31FL3743A_SYNC_MASTER 0b11 122 123 #define SW1_CS1 0x00 124 #define SW1_CS2 0x01 125 #define SW1_CS3 0x02 126 #define SW1_CS4 0x03 127 #define SW1_CS5 0x04 128 #define SW1_CS6 0x05 129 #define SW1_CS7 0x06 130 #define SW1_CS8 0x07 131 #define SW1_CS9 0x08 132 #define SW1_CS10 0x09 133 #define SW1_CS11 0x0A 134 #define SW1_CS12 0x0B 135 #define SW1_CS13 0x0C 136 #define SW1_CS14 0x0D 137 #define SW1_CS15 0x0E 138 #define SW1_CS16 0x0F 139 #define SW1_CS17 0x10 140 #define SW1_CS18 0x11 141 142 #define SW2_CS1 0x12 143 #define SW2_CS2 0x13 144 #define SW2_CS3 0x14 145 #define SW2_CS4 0x15 146 #define SW2_CS5 0x16 147 #define SW2_CS6 0x17 148 #define SW2_CS7 0x18 149 #define SW2_CS8 0x19 150 #define SW2_CS9 0x1A 151 #define SW2_CS10 0x1B 152 #define SW2_CS11 0x1C 153 #define SW2_CS12 0x1D 154 #define SW2_CS13 0x1E 155 #define SW2_CS14 0x1F 156 #define SW2_CS15 0x20 157 #define SW2_CS16 0x21 158 #define SW2_CS17 0x22 159 #define SW2_CS18 0x23 160 161 #define SW3_CS1 0x24 162 #define SW3_CS2 0x25 163 #define SW3_CS3 0x26 164 #define SW3_CS4 0x27 165 #define SW3_CS5 0x28 166 #define SW3_CS6 0x29 167 #define SW3_CS7 0x2A 168 #define SW3_CS8 0x2B 169 #define SW3_CS9 0x2C 170 #define SW3_CS10 0x2D 171 #define SW3_CS11 0x2E 172 #define SW3_CS12 0x2F 173 #define SW3_CS13 0x30 174 #define SW3_CS14 0x31 175 #define SW3_CS15 0x32 176 #define SW3_CS16 0x33 177 #define SW3_CS17 0x34 178 #define SW3_CS18 0x35 179 180 #define SW4_CS1 0x36 181 #define SW4_CS2 0x37 182 #define SW4_CS3 0x38 183 #define SW4_CS4 0x39 184 #define SW4_CS5 0x3A 185 #define SW4_CS6 0x3B 186 #define SW4_CS7 0x3C 187 #define SW4_CS8 0x3D 188 #define SW4_CS9 0x3E 189 #define SW4_CS10 0x3F 190 #define SW4_CS11 0x40 191 #define SW4_CS12 0x41 192 #define SW4_CS13 0x42 193 #define SW4_CS14 0x43 194 #define SW4_CS15 0x44 195 #define SW4_CS16 0x45 196 #define SW4_CS17 0x46 197 #define SW4_CS18 0x47 198 199 #define SW5_CS1 0x48 200 #define SW5_CS2 0x49 201 #define SW5_CS3 0x4A 202 #define SW5_CS4 0x4B 203 #define SW5_CS5 0x4C 204 #define SW5_CS6 0x4D 205 #define SW5_CS7 0x4E 206 #define SW5_CS8 0x4F 207 #define SW5_CS9 0x50 208 #define SW5_CS10 0x51 209 #define SW5_CS11 0x52 210 #define SW5_CS12 0x53 211 #define SW5_CS13 0x54 212 #define SW5_CS14 0x55 213 #define SW5_CS15 0x56 214 #define SW5_CS16 0x57 215 #define SW5_CS17 0x58 216 #define SW5_CS18 0x59 217 218 #define SW6_CS1 0x5A 219 #define SW6_CS2 0x5B 220 #define SW6_CS3 0x5C 221 #define SW6_CS4 0x5D 222 #define SW6_CS5 0x5E 223 #define SW6_CS6 0x5F 224 #define SW6_CS7 0x60 225 #define SW6_CS8 0x61 226 #define SW6_CS9 0x62 227 #define SW6_CS10 0x63 228 #define SW6_CS11 0x64 229 #define SW6_CS12 0x65 230 #define SW6_CS13 0x66 231 #define SW6_CS14 0x67 232 #define SW6_CS15 0x68 233 #define SW6_CS16 0x69 234 #define SW6_CS17 0x6A 235 #define SW6_CS18 0x6B 236 237 #define SW7_CS1 0x6C 238 #define SW7_CS2 0x6D 239 #define SW7_CS3 0x6E 240 #define SW7_CS4 0x6F 241 #define SW7_CS5 0x70 242 #define SW7_CS6 0x71 243 #define SW7_CS7 0x72 244 #define SW7_CS8 0x73 245 #define SW7_CS9 0x74 246 #define SW7_CS10 0x75 247 #define SW7_CS11 0x76 248 #define SW7_CS12 0x77 249 #define SW7_CS13 0x78 250 #define SW7_CS14 0x79 251 #define SW7_CS15 0x7A 252 #define SW7_CS16 0x7B 253 #define SW7_CS17 0x7C 254 #define SW7_CS18 0x7D 255 256 #define SW8_CS1 0x7E 257 #define SW8_CS2 0x7F 258 #define SW8_CS3 0x80 259 #define SW8_CS4 0x81 260 #define SW8_CS5 0x82 261 #define SW8_CS6 0x83 262 #define SW8_CS7 0x84 263 #define SW8_CS8 0x85 264 #define SW8_CS9 0x86 265 #define SW8_CS10 0x87 266 #define SW8_CS11 0x88 267 #define SW8_CS12 0x89 268 #define SW8_CS13 0x8A 269 #define SW8_CS14 0x8B 270 #define SW8_CS15 0x8C 271 #define SW8_CS16 0x8D 272 #define SW8_CS17 0x8E 273 #define SW8_CS18 0x8F 274 275 #define SW9_CS1 0x90 276 #define SW9_CS2 0x91 277 #define SW9_CS3 0x92 278 #define SW9_CS4 0x93 279 #define SW9_CS5 0x94 280 #define SW9_CS6 0x95 281 #define SW9_CS7 0x96 282 #define SW9_CS8 0x97 283 #define SW9_CS9 0x98 284 #define SW9_CS10 0x99 285 #define SW9_CS11 0x9A 286 #define SW9_CS12 0x9B 287 #define SW9_CS13 0x9C 288 #define SW9_CS14 0x9D 289 #define SW9_CS15 0x9E 290 #define SW9_CS16 0x9F 291 #define SW9_CS17 0xA0 292 #define SW9_CS18 0xA1 293 294 #define SW10_CS1 0xA2 295 #define SW10_CS2 0xA3 296 #define SW10_CS3 0xA4 297 #define SW10_CS4 0xA5 298 #define SW10_CS5 0xA6 299 #define SW10_CS6 0xA7 300 #define SW10_CS7 0xA8 301 #define SW10_CS8 0xA9 302 #define SW10_CS9 0xAA 303 #define SW10_CS10 0xAB 304 #define SW10_CS11 0xAC 305 #define SW10_CS12 0xAD 306 #define SW10_CS13 0xAE 307 #define SW10_CS14 0xAF 308 #define SW10_CS15 0xB0 309 #define SW10_CS16 0xB1 310 #define SW10_CS17 0xB2 311 #define SW10_CS18 0xB3 312 313 #define SW11_CS1 0xB4 314 #define SW11_CS2 0xB5 315 #define SW11_CS3 0xB6 316 #define SW11_CS4 0xB7 317 #define SW11_CS5 0xB8 318 #define SW11_CS6 0xB9 319 #define SW11_CS7 0xBA 320 #define SW11_CS8 0xBB 321 #define SW11_CS9 0xBC 322 #define SW11_CS10 0xBD 323 #define SW11_CS11 0xBE 324 #define SW11_CS12 0xBF 325 #define SW11_CS13 0xC0 326 #define SW11_CS14 0xC1 327 #define SW11_CS15 0xC2 328 #define SW11_CS16 0xC3 329 #define SW11_CS17 0xC4 330 #define SW11_CS18 0xC5