drivers/issi/is31fl3736.c

   1 /* Copyright 2018 Jason Williams (Wilba)
   2  *
   3  * This program is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16
  17 #ifdef __AVR__
  18 #    include <avr/interrupt.h>
  19 #    include <avr/io.h>
  20 #    include <util/delay.h>
  21 #else
  22 #    include "wait.h"
  23 #endif
  24
  25 #include "is31fl3736.h"
  26 #include <string.h>
  27 #include "i2c_master.h"
  28 #include "progmem.h"
  29
  30 // This is a 7-bit address, that gets left-shifted and bit 0
  31 // set to 0 for write, 1 for read (as per I2C protocol)
  32 // The address will vary depending on your wiring:
  33 // 00 <-> GND
  34 // 01 <-> SCL
  35 // 10 <-> SDA
  36 // 11 <-> VCC
  37 // ADDR1 represents A1:A0 of the 7-bit address.
  38 // ADDR2 represents A3:A2 of the 7-bit address.
  39 // The result is: 0b101(ADDR2)(ADDR1)
  40 #define ISSI_ADDR_DEFAULT 0x50
  41
  42 #define ISSI_COMMANDREGISTER 0xFD
  43 #define ISSI_COMMANDREGISTER_WRITELOCK 0xFE
  44 #define ISSI_INTERRUPTMASKREGISTER 0xF0
  45 #define ISSI_INTERRUPTSTATUSREGISTER 0xF1
  46
  47 #define ISSI_PAGE_LEDCONTROL 0x00  // PG0
  48 #define ISSI_PAGE_PWM 0x01         // PG1
  49 #define ISSI_PAGE_AUTOBREATH 0x02  // PG2
  50 #define ISSI_PAGE_FUNCTION 0x03    // PG3
  51
  52 #define ISSI_REG_CONFIGURATION 0x00  // PG3
  53 #define ISSI_REG_GLOBALCURRENT 0x01  // PG3
  54 #define ISSI_REG_RESET 0x11          // PG3
  55 #define ISSI_REG_SWPULLUP 0x0F       // PG3
  56 #define ISSI_REG_CSPULLUP 0x10       // PG3
  57
  58 #ifndef ISSI_TIMEOUT
  59 #    define ISSI_TIMEOUT 100
  60 #endif
  61
  62 #ifndef ISSI_PERSISTENCE
  63 #    define ISSI_PERSISTENCE 0
  64 #endif
  65
  66 // Transfer buffer for TWITransmitData()
  67 uint8_t g_twi_transfer_buffer[20];
  68
  69 // These buffers match the IS31FL3736 PWM registers.
  70 // The control buffers match the PG0 LED On/Off registers.
  71 // Storing them like this is optimal for I2C transfers to the registers.
  72 // We could optimize this and take out the unused registers from these
  73 // buffers and the transfers in IS31FL3736_write_pwm_buffer() but it's
  74 // probably not worth the extra complexity.
  75 uint8_t g_pwm_buffer[DRIVER_COUNT][192];
  76 bool    g_pwm_buffer_update_required = false;
  77
  78 uint8_t g_led_control_registers[DRIVER_COUNT][24] = {{0}, {0}};
  79 bool    g_led_control_registers_update_required   = false;
  80
  81 void IS31FL3736_write_register(uint8_t addr, uint8_t reg, uint8_t data) {
  82     g_twi_transfer_buffer[0] = reg;
  83     g_twi_transfer_buffer[1] = data;
  84
  85 #if ISSI_PERSISTENCE > 0
  86     for (uint8_t i = 0; i < ISSI_PERSISTENCE; i++) {
  87         if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, ISSI_TIMEOUT) == 0) break;
  88     }
  89 #else
  90     i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, ISSI_TIMEOUT);
  91 #endif
  92 }
  93
  94 void IS31FL3736_write_pwm_buffer(uint8_t addr, uint8_t *pwm_buffer) {
  95     // assumes PG1 is already selected
  96
  97     // transmit PWM registers in 12 transfers of 16 bytes
  98     // g_twi_transfer_buffer[] is 20 bytes
  99
 100     // iterate over the pwm_buffer contents at 16 byte intervals
 101     for (int i = 0; i < 192; i += 16) {
 102         g_twi_transfer_buffer[0] = i;
 103         // copy the data from i to i+15
 104         // device will auto-increment register for data after the first byte
 105         // thus this sets registers 0x00-0x0F, 0x10-0x1F, etc. in one transfer
 106         for (int j = 0; j < 16; j++) {
 107             g_twi_transfer_buffer[1 + j] = pwm_buffer[i + j];
 108         }
 109
 110 #if ISSI_PERSISTENCE > 0
 111         for (uint8_t i = 0; i < ISSI_PERSISTENCE; i++) {
 112             if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 17, ISSI_TIMEOUT) == 0) break;
 113         }
 114 #else
 115         i2c_transmit(addr << 1, g_twi_transfer_buffer, 17, ISSI_TIMEOUT);
 116 #endif
 117     }
 118 }
 119
 120 void IS31FL3736_init(uint8_t addr) {
 121     // In order to avoid the LEDs being driven with garbage data
 122     // in the LED driver's PWM registers, shutdown is enabled last.
 123     // Set up the mode and other settings, clear the PWM registers,
 124     // then disable software shutdown.
 125
 126     // Unlock the command register.
 127     IS31FL3736_write_register(addr, ISSI_COMMANDREGISTER_WRITELOCK, 0xC5);
 128
 129     // Select PG0
 130     IS31FL3736_write_register(addr, ISSI_COMMANDREGISTER, ISSI_PAGE_LEDCONTROL);
 131     // Turn off all LEDs.
 132     for (int i = 0x00; i <= 0x17; i++) {
 133         IS31FL3736_write_register(addr, i, 0x00);
 134     }
 135
 136     // Unlock the command register.
 137     IS31FL3736_write_register(addr, ISSI_COMMANDREGISTER_WRITELOCK, 0xC5);
 138
 139     // Select PG1
 140     IS31FL3736_write_register(addr, ISSI_COMMANDREGISTER, ISSI_PAGE_PWM);
 141     // Set PWM on all LEDs to 0
 142     // No need to setup Breath registers to PWM as that is the default.
 143     for (int i = 0x00; i <= 0xBF; i++) {
 144         IS31FL3736_write_register(addr, i, 0x00);
 145     }
 146
 147     // Unlock the command register.
 148     IS31FL3736_write_register(addr, ISSI_COMMANDREGISTER_WRITELOCK, 0xC5);
 149
 150     // Select PG3
 151     IS31FL3736_write_register(addr, ISSI_COMMANDREGISTER, ISSI_PAGE_FUNCTION);
 152     // Set global current to maximum.
 153     IS31FL3736_write_register(addr, ISSI_REG_GLOBALCURRENT, 0xFF);
 154     // Disable software shutdown.
 155     IS31FL3736_write_register(addr, ISSI_REG_CONFIGURATION, 0x01);
 156
 157 // Wait 10ms to ensure the device has woken up.
 158 #ifdef __AVR__
 159     _delay_ms(10);
 160 #else
 161     wait_ms(10);
 162 #endif
 163 }
 164
 165 void IS31FL3736_set_color(int index, uint8_t red, uint8_t green, uint8_t blue) {
 166     if (index >= 0 && index < DRIVER_LED_TOTAL) {
 167         is31_led led = g_is31_leds[index];
 168
 169         g_pwm_buffer[led.driver][led.r] = red;
 170         g_pwm_buffer[led.driver][led.g] = green;
 171         g_pwm_buffer[led.driver][led.b] = blue;
 172         g_pwm_buffer_update_required    = true;
 173     }
 174 }
 175
 176 void IS31FL3736_set_color_all(uint8_t red, uint8_t green, uint8_t blue) {
 177     for (int i = 0; i < DRIVER_LED_TOTAL; i++) {
 178         IS31FL3736_set_color(i, red, green, blue);
 179     }
 180 }
 181
 182 void IS31FL3736_set_led_control_register(uint8_t index, bool red, bool green, bool blue) {
 183     is31_led led = g_is31_leds[index];
 184
 185     // IS31FL3733
 186     // The PWM register for a matrix position (0x00 to 0xBF) can be
 187     // divided by 8 to get the LED control register (0x00 to 0x17),
 188     // then mod 8 to get the bit position within that register.
 189
 190     // IS31FL3736
 191     // The PWM register for a matrix position (0x00 to 0xBF) is interleaved, so:
 192     // A1=0x00 A2=0x02 A3=0x04 A4=0x06 A5=0x08 A6=0x0A A7=0x0C A8=0x0E
 193     // B1=0x10 B2=0x12 B3=0x14
 194     // But also, the LED control registers (0x00 to 0x17) are also interleaved, so:
 195     // A1-A4=0x00 A5-A8=0x01
 196     // So, the same math applies.
 197
 198     uint8_t control_register_r = led.r / 8;
 199     uint8_t control_register_g = led.g / 8;
 200     uint8_t control_register_b = led.b / 8;
 201
 202     uint8_t bit_r = led.r % 8;
 203     uint8_t bit_g = led.g % 8;
 204     uint8_t bit_b = led.b % 8;
 205
 206     if (red) {
 207         g_led_control_registers[led.driver][control_register_r] |= (1 << bit_r);
 208     } else {
 209         g_led_control_registers[led.driver][control_register_r] &= ~(1 << bit_r);
 210     }
 211     if (green) {
 212         g_led_control_registers[led.driver][control_register_g] |= (1 << bit_g);
 213     } else {
 214         g_led_control_registers[led.driver][control_register_g] &= ~(1 << bit_g);
 215     }
 216     if (blue) {
 217         g_led_control_registers[led.driver][control_register_b] |= (1 << bit_b);
 218     } else {
 219         g_led_control_registers[led.driver][control_register_b] &= ~(1 << bit_b);
 220     }
 221
 222     g_led_control_registers_update_required = true;
 223 }
 224
 225 void IS31FL3736_mono_set_brightness(int index, uint8_t value) {
 226     if (index >= 0 && index < 96) {
 227         // Index in range 0..95 -> A1..A8, B1..B8, etc.
 228         // Map index 0..95 to registers 0x00..0xBE (interleaved)
 229         uint8_t pwm_register          = index * 2;
 230         g_pwm_buffer[0][pwm_register] = value;
 231         g_pwm_buffer_update_required  = true;
 232     }
 233 }
 234
 235 void IS31FL3736_mono_set_brightness_all(uint8_t value) {
 236     for (int i = 0; i < 96; i++) {
 237         IS31FL3736_mono_set_brightness(i, value);
 238     }
 239 }
 240
 241 void IS31FL3736_mono_set_led_control_register(uint8_t index, bool enabled) {
 242     // Index in range 0..95 -> A1..A8, B1..B8, etc.
 243
 244     // Map index 0..95 to registers 0x00..0xBE (interleaved)
 245     uint8_t pwm_register = index * 2;
 246     // Map register 0x00..0xBE (interleaved) into control register and bit
 247     uint8_t control_register = pwm_register / 8;
 248     uint8_t bit              = pwm_register % 8;
 249
 250     if (enabled) {
 251         g_led_control_registers[0][control_register] |= (1 << bit);
 252     } else {
 253         g_led_control_registers[0][control_register] &= ~(1 << bit);
 254     }
 255
 256     g_led_control_registers_update_required = true;
 257 }
 258
 259 void IS31FL3736_update_pwm_buffers(uint8_t addr1, uint8_t addr2) {
 260     if (g_pwm_buffer_update_required) {
 261         // Firstly we need to unlock the command register and select PG1
 262         IS31FL3736_write_register(addr1, ISSI_COMMANDREGISTER_WRITELOCK, 0xC5);
 263         IS31FL3736_write_register(addr1, ISSI_COMMANDREGISTER, ISSI_PAGE_PWM);
 264
 265         IS31FL3736_write_pwm_buffer(addr1, g_pwm_buffer[0]);
 266         // IS31FL3736_write_pwm_buffer( addr2, g_pwm_buffer[1] );
 267     }
 268     g_pwm_buffer_update_required = false;
 269 }
 270
 271 void IS31FL3736_update_led_control_registers(uint8_t addr1, uint8_t addr2) {
 272     if (g_led_control_registers_update_required) {
 273         // Firstly we need to unlock the command register and select PG0
 274         IS31FL3736_write_register(addr1, ISSI_COMMANDREGISTER_WRITELOCK, 0xC5);
 275         IS31FL3736_write_register(addr1, ISSI_COMMANDREGISTER, ISSI_PAGE_LEDCONTROL);
 276         for (int i = 0; i < 24; i++) {
 277             IS31FL3736_write_register(addr1, i, g_led_control_registers[0][i]);
 278             // IS31FL3736_write_register(addr2, i, g_led_control_registers[1][i] );
 279         }
 280     }
 281 }