is31fl3736-mono.c (8343B)
1 /* Copyright 2018 Jason Williams (Wilba) 2 * Copyright 2021 Doni Crosby 3 * 4 * This program is free software: you can redistribute it and/or modify 5 * it under the terms of the GNU General Public License as published by 6 * the Free Software Foundation, either version 2 of the License, or 7 * (at your option) any later version. 8 * 9 * This program is distributed in the hope that it will be useful, 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 * GNU General Public License for more details. 13 * 14 * You should have received a copy of the GNU General Public License 15 * along with this program. If not, see <http://www.gnu.org/licenses/>. 16 */ 17 18 #include "is31fl3736-mono.h" 19 #include "i2c_master.h" 20 #include "gpio.h" 21 #include "wait.h" 22 23 #define IS31FL3736_PWM_REGISTER_COUNT 192 // actually 96 24 #define IS31FL3736_LED_CONTROL_REGISTER_COUNT 24 25 26 #ifndef IS31FL3736_I2C_TIMEOUT 27 # define IS31FL3736_I2C_TIMEOUT 100 28 #endif 29 30 #ifndef IS31FL3736_I2C_PERSISTENCE 31 # define IS31FL3736_I2C_PERSISTENCE 0 32 #endif 33 34 #ifndef IS31FL3736_PWM_FREQUENCY 35 # define IS31FL3736_PWM_FREQUENCY IS31FL3736_PWM_FREQUENCY_8K4_HZ // PFS - IS31FL3736B only 36 #endif 37 38 #ifndef IS31FL3736_SW_PULLUP 39 # define IS31FL3736_SW_PULLUP IS31FL3736_PUR_0_OHM 40 #endif 41 42 #ifndef IS31FL3736_CS_PULLDOWN 43 # define IS31FL3736_CS_PULLDOWN IS31FL3736_PDR_0_OHM 44 #endif 45 46 #ifndef IS31FL3736_GLOBAL_CURRENT 47 # define IS31FL3736_GLOBAL_CURRENT 0xFF 48 #endif 49 50 const uint8_t i2c_addresses[IS31FL3736_DRIVER_COUNT] = { 51 IS31FL3736_I2C_ADDRESS_1, 52 #ifdef IS31FL3736_I2C_ADDRESS_2 53 IS31FL3736_I2C_ADDRESS_2, 54 # ifdef IS31FL3736_I2C_ADDRESS_3 55 IS31FL3736_I2C_ADDRESS_3, 56 # ifdef IS31FL3736_I2C_ADDRESS_4 57 IS31FL3736_I2C_ADDRESS_4, 58 # endif 59 # endif 60 #endif 61 }; 62 63 // These buffers match the IS31FL3736 PWM registers. 64 // The control buffers match the page 0 LED On/Off registers. 65 // Storing them like this is optimal for I2C transfers to the registers. 66 // We could optimize this and take out the unused registers from these 67 // buffers and the transfers in is31fl3736_write_pwm_buffer() but it's 68 // probably not worth the extra complexity. 69 typedef struct is31fl3736_driver_t { 70 uint8_t pwm_buffer[IS31FL3736_PWM_REGISTER_COUNT]; 71 bool pwm_buffer_dirty; 72 uint8_t led_control_buffer[IS31FL3736_LED_CONTROL_REGISTER_COUNT]; 73 bool led_control_buffer_dirty; 74 } PACKED is31fl3736_driver_t; 75 76 is31fl3736_driver_t driver_buffers[IS31FL3736_DRIVER_COUNT] = {{ 77 .pwm_buffer = {0}, 78 .pwm_buffer_dirty = false, 79 .led_control_buffer = {0}, 80 .led_control_buffer_dirty = false, 81 }}; 82 83 void is31fl3736_write_register(uint8_t index, uint8_t reg, uint8_t data) { 84 #if IS31FL3736_I2C_PERSISTENCE > 0 85 for (uint8_t i = 0; i < IS31FL3736_I2C_PERSISTENCE; i++) { 86 if (i2c_write_register(i2c_addresses[index] << 1, reg, &data, 1, IS31FL3736_I2C_TIMEOUT) == I2C_STATUS_SUCCESS) break; 87 } 88 #else 89 i2c_write_register(i2c_addresses[index] << 1, reg, &data, 1, IS31FL3736_I2C_TIMEOUT); 90 #endif 91 } 92 93 void is31fl3736_select_page(uint8_t index, uint8_t page) { 94 is31fl3736_write_register(index, IS31FL3736_REG_COMMAND_WRITE_LOCK, IS31FL3736_COMMAND_WRITE_LOCK_MAGIC); 95 is31fl3736_write_register(index, IS31FL3736_REG_COMMAND, page); 96 } 97 98 void is31fl3736_write_pwm_buffer(uint8_t index) { 99 // Assumes page 1 is already selected. 100 // Transmit PWM registers in 12 transfers of 16 bytes. 101 102 // Iterate over the pwm_buffer contents at 16 byte intervals. 103 for (uint8_t i = 0; i < IS31FL3736_PWM_REGISTER_COUNT; i += 16) { 104 #if IS31FL3736_I2C_PERSISTENCE > 0 105 for (uint8_t j = 0; j < IS31FL3736_I2C_PERSISTENCE; j++) { 106 if (i2c_write_register(i2c_addresses[index] << 1, i, driver_buffers[index].pwm_buffer + i, 16, IS31FL3736_I2C_TIMEOUT) == I2C_STATUS_SUCCESS) break; 107 } 108 #else 109 i2c_write_register(i2c_addresses[index] << 1, i, driver_buffers[index].pwm_buffer + i, 16, IS31FL3736_I2C_TIMEOUT); 110 #endif 111 } 112 } 113 114 void is31fl3736_init_drivers(void) { 115 i2c_init(); 116 117 #if defined(IS31FL3736_SDB_PIN) 118 gpio_set_pin_output(IS31FL3736_SDB_PIN); 119 gpio_write_pin_high(IS31FL3736_SDB_PIN); 120 #endif 121 122 for (uint8_t i = 0; i < IS31FL3736_DRIVER_COUNT; i++) { 123 is31fl3736_init(i); 124 } 125 126 for (int i = 0; i < IS31FL3736_LED_COUNT; i++) { 127 is31fl3736_set_led_control_register(i, true); 128 } 129 130 for (uint8_t i = 0; i < IS31FL3736_DRIVER_COUNT; i++) { 131 is31fl3736_update_led_control_registers(i); 132 } 133 } 134 135 void is31fl3736_init(uint8_t index) { 136 // In order to avoid the LEDs being driven with garbage data 137 // in the LED driver's PWM registers, shutdown is enabled last. 138 // Set up the mode and other settings, clear the PWM registers, 139 // then disable software shutdown. 140 141 is31fl3736_select_page(index, IS31FL3736_COMMAND_LED_CONTROL); 142 143 // Turn off all LEDs. 144 for (uint8_t i = 0; i < IS31FL3736_LED_CONTROL_REGISTER_COUNT; i++) { 145 is31fl3736_write_register(index, i, 0x00); 146 } 147 148 is31fl3736_select_page(index, IS31FL3736_COMMAND_PWM); 149 150 // Set PWM on all LEDs to 0 151 // No need to setup Breath registers to PWM as that is the default. 152 for (uint8_t i = 0; i < IS31FL3736_PWM_REGISTER_COUNT; i++) { 153 is31fl3736_write_register(index, i, 0x00); 154 } 155 156 is31fl3736_select_page(index, IS31FL3736_COMMAND_FUNCTION); 157 158 // Set de-ghost pull-up resistors (SWx) 159 is31fl3736_write_register(index, IS31FL3736_FUNCTION_REG_SW_PULLUP, IS31FL3736_SW_PULLUP); 160 // Set de-ghost pull-down resistors (CSx) 161 is31fl3736_write_register(index, IS31FL3736_FUNCTION_REG_CS_PULLDOWN, IS31FL3736_CS_PULLDOWN); 162 // Set global current to maximum. 163 is31fl3736_write_register(index, IS31FL3736_FUNCTION_REG_GLOBAL_CURRENT, IS31FL3736_GLOBAL_CURRENT); 164 // Disable software shutdown. 165 is31fl3736_write_register(index, IS31FL3736_FUNCTION_REG_CONFIGURATION, ((IS31FL3736_PWM_FREQUENCY & 0b111) << 3) | 0x01); 166 167 // Wait 10ms to ensure the device has woken up. 168 wait_ms(10); 169 } 170 171 void is31fl3736_set_value(int index, uint8_t value) { 172 is31fl3736_led_t led; 173 174 if (index >= 0 && index < IS31FL3736_LED_COUNT) { 175 memcpy_P(&led, (&g_is31fl3736_leds[index]), sizeof(led)); 176 177 if (driver_buffers[led.driver].pwm_buffer[led.v] == value) { 178 return; 179 } 180 181 driver_buffers[led.driver].pwm_buffer[led.v] = value; 182 driver_buffers[led.driver].pwm_buffer_dirty = true; 183 } 184 } 185 186 void is31fl3736_set_value_all(uint8_t value) { 187 for (int i = 0; i < IS31FL3736_LED_COUNT; i++) { 188 is31fl3736_set_value(i, value); 189 } 190 } 191 192 void is31fl3736_set_led_control_register(uint8_t index, bool value) { 193 is31fl3736_led_t led; 194 memcpy_P(&led, (&g_is31fl3736_leds[index]), sizeof(led)); 195 196 // The PWM register for a matrix position (0x00 to 0xBF) is interleaved, so: 197 // A1=0x00 A2=0x02 A3=0x04 A4=0x06 A5=0x08 A6=0x0A A7=0x0C A8=0x0E 198 // B1=0x10 B2=0x12 B3=0x14 199 // But also, the LED control registers (0x00 to 0x17) are also interleaved, so: 200 // A1-A4=0x00 A5-A8=0x01 201 202 uint8_t control_register = led.v / 8; 203 uint8_t bit_value = led.v % 8; 204 205 if (value) { 206 driver_buffers[led.driver].led_control_buffer[control_register] |= (1 << bit_value); 207 } else { 208 driver_buffers[led.driver].led_control_buffer[control_register] &= ~(1 << bit_value); 209 } 210 211 driver_buffers[led.driver].led_control_buffer_dirty = true; 212 } 213 214 void is31fl3736_update_pwm_buffers(uint8_t index) { 215 if (driver_buffers[index].pwm_buffer_dirty) { 216 is31fl3736_select_page(index, IS31FL3736_COMMAND_PWM); 217 218 is31fl3736_write_pwm_buffer(index); 219 220 driver_buffers[index].pwm_buffer_dirty = false; 221 } 222 } 223 224 void is31fl3736_update_led_control_registers(uint8_t index) { 225 if (driver_buffers[index].led_control_buffer_dirty) { 226 is31fl3736_select_page(index, IS31FL3736_COMMAND_LED_CONTROL); 227 228 for (uint8_t i = 0; i < IS31FL3736_LED_CONTROL_REGISTER_COUNT; i++) { 229 is31fl3736_write_register(index, i, driver_buffers[index].led_control_buffer[i]); 230 } 231 232 driver_buffers[index].led_control_buffer_dirty = false; 233 } 234 } 235 236 void is31fl3736_flush(void) { 237 for (uint8_t i = 0; i < IS31FL3736_DRIVER_COUNT; i++) { 238 is31fl3736_update_pwm_buffers(i); 239 } 240 }