is31fl3737.h (7339B)
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 IS31FL3737_REG_INTERRUPT_MASK 0xF0 28 #define IS31FL3737_REG_INTERRUPT_STATUS 0xF1 29 30 #define IS31FL3737_REG_COMMAND 0xFD 31 32 #define IS31FL3737_COMMAND_LED_CONTROL 0x00 33 #define IS31FL3737_COMMAND_PWM 0x01 34 #define IS31FL3737_COMMAND_AUTO_BREATH 0x02 35 #define IS31FL3737_COMMAND_FUNCTION 0x03 36 37 #define IS31FL3737_FUNCTION_REG_CONFIGURATION 0x00 38 #define IS31FL3737_FUNCTION_REG_GLOBAL_CURRENT 0x01 39 #define IS31FL3737_FUNCTION_REG_SW_PULLUP 0x0F 40 #define IS31FL3737_FUNCTION_REG_CS_PULLDOWN 0x10 41 #define IS31FL3737_FUNCTION_REG_RESET 0x11 42 43 #define IS31FL3737_REG_COMMAND_WRITE_LOCK 0xFE 44 #define IS31FL3737_COMMAND_WRITE_LOCK_MAGIC 0xC5 45 46 #define IS31FL3737_I2C_ADDRESS_GND 0x50 47 #define IS31FL3737_I2C_ADDRESS_SCL 0x55 48 #define IS31FL3737_I2C_ADDRESS_SDA 0x5A 49 #define IS31FL3737_I2C_ADDRESS_VCC 0x5F 50 51 #if defined(RGB_MATRIX_IS31FL3737) 52 # define IS31FL3737_LED_COUNT RGB_MATRIX_LED_COUNT 53 #endif 54 55 #if defined(IS31FL3737_I2C_ADDRESS_4) 56 # define IS31FL3737_DRIVER_COUNT 4 57 #elif defined(IS31FL3737_I2C_ADDRESS_3) 58 # define IS31FL3737_DRIVER_COUNT 3 59 #elif defined(IS31FL3737_I2C_ADDRESS_2) 60 # define IS31FL3737_DRIVER_COUNT 2 61 #elif defined(IS31FL3737_I2C_ADDRESS_1) 62 # define IS31FL3737_DRIVER_COUNT 1 63 #endif 64 65 typedef struct is31fl3737_led_t { 66 uint8_t driver : 2; 67 uint8_t r; 68 uint8_t g; 69 uint8_t b; 70 } PACKED is31fl3737_led_t; 71 72 extern const is31fl3737_led_t PROGMEM g_is31fl3737_leds[IS31FL3737_LED_COUNT]; 73 74 void is31fl3737_init_drivers(void); 75 void is31fl3737_init(uint8_t index); 76 void is31fl3737_write_register(uint8_t index, uint8_t reg, uint8_t data); 77 void is31fl3737_select_page(uint8_t index, uint8_t page); 78 79 void is31fl3737_set_color(int index, uint8_t red, uint8_t green, uint8_t blue); 80 void is31fl3737_set_color_all(uint8_t red, uint8_t green, uint8_t blue); 81 82 void is31fl3737_set_led_control_register(uint8_t index, bool red, bool green, bool blue); 83 84 // This should not be called from an interrupt 85 // (eg. from a timer interrupt). 86 // Call this while idle (in between matrix scans). 87 // If the buffer is dirty, it will update the driver with the buffer. 88 void is31fl3737_update_pwm_buffers(uint8_t index); 89 void is31fl3737_update_led_control_registers(uint8_t index); 90 91 void is31fl3737_flush(void); 92 93 #define IS31FL3737_PDR_0_OHM 0b000 // No pull-down resistor 94 #define IS31FL3737_PDR_0K5_OHM 0b001 // 0.5 kOhm resistor 95 #define IS31FL3737_PDR_1K_OHM 0b010 // 1 kOhm resistor 96 #define IS31FL3737_PDR_2K_OHM 0b011 // 2 kOhm resistor 97 #define IS31FL3737_PDR_4K_OHM 0b100 // 4 kOhm resistor 98 #define IS31FL3737_PDR_8K_OHM 0b101 // 8 kOhm resistor 99 #define IS31FL3737_PDR_16K_OHM 0b110 // 16 kOhm resistor 100 #define IS31FL3737_PDR_32K_OHM 0b111 // 32 kOhm resistor 101 102 #define IS31FL3737_PUR_0_OHM 0b000 // No pull-up resistor 103 #define IS31FL3737_PUR_0K5_OHM 0b001 // 0.5 kOhm resistor 104 #define IS31FL3737_PUR_1K_OHM 0b010 // 1 kOhm resistor 105 #define IS31FL3737_PUR_2K_OHM 0b011 // 2 kOhm resistor 106 #define IS31FL3737_PUR_4K_OHM 0b100 // 4 kOhm resistor 107 #define IS31FL3737_PUR_8K_OHM 0b101 // 8 kOhm resistor 108 #define IS31FL3737_PUR_16K_OHM 0b110 // 16 kOhm resistor 109 #define IS31FL3737_PUR_32K_OHM 0b111 // 32 kOhm resistor 110 111 #define IS31FL3737_PWM_FREQUENCY_8K4_HZ 0b000 112 #define IS31FL3737_PWM_FREQUENCY_4K2_HZ 0b001 113 #define IS31FL3737_PWM_FREQUENCY_26K7_HZ 0b010 114 #define IS31FL3737_PWM_FREQUENCY_2K1_HZ 0b011 115 #define IS31FL3737_PWM_FREQUENCY_1K05_HZ 0b100 116 117 #define SW1_CS1 0x00 118 #define SW1_CS2 0x01 119 #define SW1_CS3 0x02 120 #define SW1_CS4 0x03 121 #define SW1_CS5 0x04 122 #define SW1_CS6 0x05 123 #define SW1_CS7 0x08 124 #define SW1_CS8 0x09 125 #define SW1_CS9 0x0A 126 #define SW1_CS10 0x0B 127 #define SW1_CS11 0x0C 128 #define SW1_CS12 0x0D 129 130 #define SW2_CS1 0x10 131 #define SW2_CS2 0x11 132 #define SW2_CS3 0x12 133 #define SW2_CS4 0x13 134 #define SW2_CS5 0x14 135 #define SW2_CS6 0x15 136 #define SW2_CS7 0x18 137 #define SW2_CS8 0x19 138 #define SW2_CS9 0x1A 139 #define SW2_CS10 0x1B 140 #define SW2_CS11 0x1C 141 #define SW2_CS12 0x1D 142 143 #define SW3_CS1 0x20 144 #define SW3_CS2 0x21 145 #define SW3_CS3 0x22 146 #define SW3_CS4 0x23 147 #define SW3_CS5 0x24 148 #define SW3_CS6 0x25 149 #define SW3_CS7 0x28 150 #define SW3_CS8 0x29 151 #define SW3_CS9 0x2A 152 #define SW3_CS10 0x2B 153 #define SW3_CS11 0x2C 154 #define SW3_CS12 0x2D 155 156 #define SW4_CS1 0x30 157 #define SW4_CS2 0x31 158 #define SW4_CS3 0x32 159 #define SW4_CS4 0x33 160 #define SW4_CS5 0x34 161 #define SW4_CS6 0x35 162 #define SW4_CS7 0x38 163 #define SW4_CS8 0x39 164 #define SW4_CS9 0x3A 165 #define SW4_CS10 0x3B 166 #define SW4_CS11 0x3C 167 #define SW4_CS12 0x3D 168 169 #define SW5_CS1 0x40 170 #define SW5_CS2 0x41 171 #define SW5_CS3 0x42 172 #define SW5_CS4 0x43 173 #define SW5_CS5 0x44 174 #define SW5_CS6 0x45 175 #define SW5_CS7 0x48 176 #define SW5_CS8 0x49 177 #define SW5_CS9 0x4A 178 #define SW5_CS10 0x4B 179 #define SW5_CS11 0x4C 180 #define SW5_CS12 0x4D 181 182 #define SW6_CS1 0x50 183 #define SW6_CS2 0x51 184 #define SW6_CS3 0x52 185 #define SW6_CS4 0x53 186 #define SW6_CS5 0x54 187 #define SW6_CS6 0x55 188 #define SW6_CS7 0x58 189 #define SW6_CS8 0x59 190 #define SW6_CS9 0x5A 191 #define SW6_CS10 0x5B 192 #define SW6_CS11 0x5C 193 #define SW6_CS12 0x5D 194 195 #define SW7_CS1 0x60 196 #define SW7_CS2 0x61 197 #define SW7_CS3 0x62 198 #define SW7_CS4 0x63 199 #define SW7_CS5 0x64 200 #define SW7_CS6 0x65 201 #define SW7_CS7 0x68 202 #define SW7_CS8 0x69 203 #define SW7_CS9 0x6A 204 #define SW7_CS10 0x6B 205 #define SW7_CS11 0x6C 206 #define SW7_CS12 0x6D 207 208 #define SW8_CS1 0x70 209 #define SW8_CS2 0x71 210 #define SW8_CS3 0x72 211 #define SW8_CS4 0x73 212 #define SW8_CS5 0x74 213 #define SW8_CS6 0x75 214 #define SW8_CS7 0x78 215 #define SW8_CS8 0x79 216 #define SW8_CS9 0x7A 217 #define SW8_CS10 0x7B 218 #define SW8_CS11 0x7C 219 #define SW8_CS12 0x7D 220 221 #define SW9_CS1 0x80 222 #define SW9_CS2 0x81 223 #define SW9_CS3 0x82 224 #define SW9_CS4 0x83 225 #define SW9_CS5 0x84 226 #define SW9_CS6 0x85 227 #define SW9_CS7 0x88 228 #define SW9_CS8 0x89 229 #define SW9_CS9 0x8A 230 #define SW9_CS10 0x8B 231 #define SW9_CS11 0x8C 232 #define SW9_CS12 0x8D 233 234 #define SW10_CS1 0x90 235 #define SW10_CS2 0x91 236 #define SW10_CS3 0x92 237 #define SW10_CS4 0x93 238 #define SW10_CS5 0x94 239 #define SW10_CS6 0x95 240 #define SW10_CS7 0x98 241 #define SW10_CS8 0x99 242 #define SW10_CS9 0x9A 243 #define SW10_CS10 0x9B 244 #define SW10_CS11 0x9C 245 #define SW10_CS12 0x9D 246 247 #define SW11_CS1 0xA0 248 #define SW11_CS2 0xA1 249 #define SW11_CS3 0xA2 250 #define SW11_CS4 0xA3 251 #define SW11_CS5 0xA4 252 #define SW11_CS6 0xA5 253 #define SW11_CS7 0xA8 254 #define SW11_CS8 0xA9 255 #define SW11_CS9 0xAA 256 #define SW11_CS10 0xAB 257 #define SW11_CS11 0xAC 258 #define SW11_CS12 0xAD 259 260 #define SW12_CS1 0xB0 261 #define SW12_CS2 0xB1 262 #define SW12_CS3 0xB2 263 #define SW12_CS4 0xB3 264 #define SW12_CS5 0xB4 265 #define SW12_CS6 0xB5 266 #define SW12_CS7 0xB8 267 #define SW12_CS8 0xB9 268 #define SW12_CS9 0xBA 269 #define SW12_CS10 0xBB 270 #define SW12_CS11 0xBC 271 #define SW12_CS12 0xBD