is31fl3746a.h (6578B)
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 IS31FL3746A_REG_ID 0xFC 29 30 #define IS31FL3746A_REG_COMMAND 0xFD 31 32 #define IS31FL3746A_COMMAND_PWM 0x00 33 #define IS31FL3746A_COMMAND_SCALING 0x01 34 #define IS31FL3746A_COMMAND_FUNCTION 0x01 35 36 #define IS31FL3746A_FUNCTION_REG_CONFIGURATION 0x50 37 #define IS31FL3746A_FUNCTION_REG_GLOBAL_CURRENT 0x51 38 #define IS31FL3746A_FUNCTION_REG_PULLDOWNUP 0x52 39 #define IS31FL3746A_FUNCTION_REG_TEMPERATURE 0x5F 40 #define IS31FL3746A_FUNCTION_REG_SPREAD_SPECTRUM 0x60 41 #define IS31FL3746A_FUNCTION_REG_RESET 0x8F 42 #define IS31FL3746A_FUNCTION_REG_PWM_ENABLE 0xE0 43 #define IS31FL3746A_FUNCTION_REG_PWM_FREQUENCY 0xE2 44 45 #define IS31FL3746A_REG_COMMAND_WRITE_LOCK 0xFE 46 #define IS31FL3746A_COMMAND_WRITE_LOCK_MAGIC 0xC5 47 48 #define IS31FL3746A_I2C_ADDRESS_GND_GND 0x60 49 #define IS31FL3746A_I2C_ADDRESS_GND_SCL 0x61 50 #define IS31FL3746A_I2C_ADDRESS_GND_SDA 0x62 51 #define IS31FL3746A_I2C_ADDRESS_GND_VCC 0x63 52 #define IS31FL3746A_I2C_ADDRESS_SCL_GND 0x64 53 #define IS31FL3746A_I2C_ADDRESS_SCL_SCL 0x65 54 #define IS31FL3746A_I2C_ADDRESS_SCL_SDA 0x66 55 #define IS31FL3746A_I2C_ADDRESS_SCL_VCC 0x67 56 #define IS31FL3746A_I2C_ADDRESS_SDA_GND 0x68 57 #define IS31FL3746A_I2C_ADDRESS_SDA_SCL 0x69 58 #define IS31FL3746A_I2C_ADDRESS_SDA_SDA 0x6A 59 #define IS31FL3746A_I2C_ADDRESS_SDA_VCC 0x6B 60 #define IS31FL3746A_I2C_ADDRESS_VCC_GND 0x6C 61 #define IS31FL3746A_I2C_ADDRESS_VCC_SCL 0x6D 62 #define IS31FL3746A_I2C_ADDRESS_VCC_SDA 0x6E 63 #define IS31FL3746A_I2C_ADDRESS_VCC_VCC 0x6F 64 65 #if defined(RGB_MATRIX_IS31FL3746A) 66 # define IS31FL3746A_LED_COUNT RGB_MATRIX_LED_COUNT 67 #endif 68 69 #if defined(IS31FL3746A_I2C_ADDRESS_4) 70 # define IS31FL3746A_DRIVER_COUNT 4 71 #elif defined(IS31FL3746A_I2C_ADDRESS_3) 72 # define IS31FL3746A_DRIVER_COUNT 3 73 #elif defined(IS31FL3746A_I2C_ADDRESS_2) 74 # define IS31FL3746A_DRIVER_COUNT 2 75 #elif defined(IS31FL3746A_I2C_ADDRESS_1) 76 # define IS31FL3746A_DRIVER_COUNT 1 77 #endif 78 79 typedef struct is31fl3746a_led_t { 80 uint8_t driver : 2; 81 uint8_t r; 82 uint8_t g; 83 uint8_t b; 84 } PACKED is31fl3746a_led_t; 85 86 extern const is31fl3746a_led_t PROGMEM g_is31fl3746a_leds[IS31FL3746A_LED_COUNT]; 87 88 void is31fl3746a_init_drivers(void); 89 void is31fl3746a_init(uint8_t index); 90 void is31fl3746a_write_register(uint8_t index, uint8_t reg, uint8_t data); 91 void is31fl3746a_select_page(uint8_t index, uint8_t page); 92 93 void is31fl3746a_set_color(int index, uint8_t red, uint8_t green, uint8_t blue); 94 void is31fl3746a_set_color_all(uint8_t red, uint8_t green, uint8_t blue); 95 96 void is31fl3746a_set_scaling_register(uint8_t index, uint8_t red, uint8_t green, uint8_t blue); 97 98 void is31fl3746a_update_pwm_buffers(uint8_t index); 99 void is31fl3746a_update_scaling_registers(uint8_t index); 100 101 void is31fl3746a_flush(void); 102 103 #define IS31FL3746A_PDR_0_OHM 0b000 // No pull-down resistor 104 #define IS31FL3746A_PDR_0K5_OHM_SW_OFF 0b001 // 0.5 kOhm resistor in SWx off time 105 #define IS31FL3746A_PDR_1K_OHM_SW_OFF 0b010 // 1 kOhm resistor in SWx off time 106 #define IS31FL3746A_PDR_2K_OHM_SW_OFF 0b011 // 2 kOhm resistor in SWx off time 107 #define IS31FL3746A_PDR_1K_OHM 0b100 // 1 kOhm resistor 108 #define IS31FL3746A_PDR_2K_OHM 0b101 // 2 kOhm resistor 109 #define IS31FL3746A_PDR_4K_OHM 0b110 // 4 kOhm resistor 110 #define IS31FL3746A_PDR_8K_OHM 0b111 // 8 kOhm resistor 111 112 #define IS31FL3746A_PUR_0_OHM 0b000 // No pull-up resistor 113 #define IS31FL3746A_PUR_0K5_OHM_CS_OFF 0b001 // 0.5 kOhm resistor in CSy off time 114 #define IS31FL3746A_PUR_1K_OHM_CS_OFF 0b010 // 1 kOhm resistor in CSy off time 115 #define IS31FL3746A_PUR_2K_OHM_CS_OFF 0b011 // 2 kOhm resistor in CSy off time 116 #define IS31FL3746A_PUR_1K_OHM 0b100 // 1 kOhm resistor 117 #define IS31FL3746A_PUR_2K_OHM 0b101 // 2 kOhm resistor 118 #define IS31FL3746A_PUR_4K_OHM 0b110 // 4 kOhm resistor 119 #define IS31FL3746A_PUR_8K_OHM 0b111 // 8 kOhm resistor 120 121 #define IS31FL3746A_PWM_FREQUENCY_29K_HZ 0b000 122 #define IS31FL3746A_PWM_FREQUENCY_14K5_HZ 0b001 123 #define IS31FL3746A_PWM_FREQUENCY_7K25_HZ 0b010 124 #define IS31FL3746A_PWM_FREQUENCY_3K63_HZ 0b011 125 #define IS31FL3746A_PWM_FREQUENCY_1K81_HZ 0b100 126 #define IS31FL3746A_PWM_FREQUENCY_906_HZ 0b101 127 #define IS31FL3746A_PWM_FREQUENCY_453_HZ 0b110 128 129 #define SW1_CS1 0x00 130 #define SW1_CS2 0x01 131 #define SW1_CS3 0x02 132 #define SW1_CS4 0x03 133 #define SW1_CS5 0x04 134 #define SW1_CS6 0x05 135 #define SW1_CS7 0x06 136 #define SW1_CS8 0x07 137 #define SW1_CS9 0x08 138 #define SW1_CS10 0x09 139 #define SW1_CS11 0x0A 140 #define SW1_CS12 0x0B 141 #define SW1_CS13 0x0C 142 #define SW1_CS14 0x0D 143 #define SW1_CS15 0x0E 144 #define SW1_CS16 0x0F 145 #define SW1_CS17 0x10 146 #define SW1_CS18 0x11 147 148 #define SW2_CS1 0x12 149 #define SW2_CS2 0x13 150 #define SW2_CS3 0x14 151 #define SW2_CS4 0x15 152 #define SW2_CS5 0x16 153 #define SW2_CS6 0x17 154 #define SW2_CS7 0x18 155 #define SW2_CS8 0x19 156 #define SW2_CS9 0x1A 157 #define SW2_CS10 0x1B 158 #define SW2_CS11 0x1C 159 #define SW2_CS12 0x1D 160 #define SW2_CS13 0x1E 161 #define SW2_CS14 0x1F 162 #define SW2_CS15 0x20 163 #define SW2_CS16 0x21 164 #define SW2_CS17 0x22 165 #define SW2_CS18 0x23 166 167 #define SW3_CS1 0x24 168 #define SW3_CS2 0x25 169 #define SW3_CS3 0x26 170 #define SW3_CS4 0x27 171 #define SW3_CS5 0x28 172 #define SW3_CS6 0x29 173 #define SW3_CS7 0x2A 174 #define SW3_CS8 0x2B 175 #define SW3_CS9 0x2C 176 #define SW3_CS10 0x2D 177 #define SW3_CS11 0x2E 178 #define SW3_CS12 0x2F 179 #define SW3_CS13 0x30 180 #define SW3_CS14 0x31 181 #define SW3_CS15 0x32 182 #define SW3_CS16 0x33 183 #define SW3_CS17 0x34 184 #define SW3_CS18 0x35 185 186 #define SW4_CS1 0x36 187 #define SW4_CS2 0x37 188 #define SW4_CS3 0x38 189 #define SW4_CS4 0x39 190 #define SW4_CS5 0x3A 191 #define SW4_CS6 0x3B 192 #define SW4_CS7 0x3C 193 #define SW4_CS8 0x3D 194 #define SW4_CS9 0x3E 195 #define SW4_CS10 0x3F 196 #define SW4_CS11 0x40 197 #define SW4_CS12 0x41 198 #define SW4_CS13 0x42 199 #define SW4_CS14 0x43 200 #define SW4_CS15 0x44 201 #define SW4_CS16 0x45 202 #define SW4_CS17 0x46 203 #define SW4_CS18 0x47