drivers/is31fl3731.c

   1 /* Copyright 2017 Jason Williams
   2  * Copyright 2018 Jack Humbert
   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 #ifdef __AVR__
  19 #include <avr/interrupt.h>
  20 #include <avr/io.h>
  21 #include <util/delay.h>
  22 #else
  23 #include "wait.h"
  24 #endif
  25
  26 #include "is31fl3731.h"
  27 #include <string.h>
  28 #include "i2c_master.h"
  29 #include "progmem.h"
  30
  31 // This is a 7-bit address, that gets left-shifted and bit 0
  32 // set to 0 for write, 1 for read (as per I2C protocol)
  33 // The address will vary depending on your wiring:
  34 // 0b1110100 AD <-> GND
  35 // 0b1110111 AD <-> VCC
  36 // 0b1110101 AD <-> SCL
  37 // 0b1110110 AD <-> SDA
  38 #define ISSI_ADDR_DEFAULT 0x74
  39
  40 #define ISSI_REG_CONFIG  0x00
  41 #define ISSI_REG_CONFIG_PICTUREMODE 0x00
  42 #define ISSI_REG_CONFIG_AUTOPLAYMODE 0x08
  43 #define ISSI_REG_CONFIG_AUDIOPLAYMODE 0x18
  44
  45 #define ISSI_CONF_PICTUREMODE 0x00
  46 #define ISSI_CONF_AUTOFRAMEMODE 0x04
  47 #define ISSI_CONF_AUDIOMODE 0x08
  48
  49 #define ISSI_REG_PICTUREFRAME  0x01
  50
  51 #define ISSI_REG_SHUTDOWN 0x0A
  52 #define ISSI_REG_AUDIOSYNC 0x06
  53
  54 #define ISSI_COMMANDREGISTER 0xFD
  55 #define ISSI_BANK_FUNCTIONREG 0x0B    // helpfully called 'page nine'
  56
  57 #ifndef ISSI_TIMEOUT
  58   #define ISSI_TIMEOUT 100
  59 #endif
  60
  61 #ifndef ISSI_PERSISTENCE
  62   #define ISSI_PERSISTENCE 0
  63 #endif
  64
  65 // Transfer buffer for TWITransmitData()
  66 uint8_t g_twi_transfer_buffer[20];
  67
  68 // These buffers match the IS31FL3731 PWM registers 0x24-0xB3.
  69 // Storing them like this is optimal for I2C transfers to the registers.
  70 // We could optimize this and take out the unused registers from these
  71 // buffers and the transfers in IS31FL3731_write_pwm_buffer() but it's
  72 // probably not worth the extra complexity.
  73 uint8_t g_pwm_buffer[DRIVER_COUNT][144];
  74 bool g_pwm_buffer_update_required = false;
  75
  76 uint8_t g_led_control_registers[DRIVER_COUNT][18] = { { 0 }, { 0 } };
  77 bool g_led_control_registers_update_required = false;
  78
  79 // This is the bit pattern in the LED control registers
  80 // (for matrix A, add one to register for matrix B)
  81 //
  82 //  reg -  b7  b6  b5  b4  b3  b2  b1  b0
  83 // 0x00 - R08,R07,R06,R05,R04,R03,R02,R01
  84 // 0x02 - G08,G07,G06,G05,G04,G03,G02,R00
  85 // 0x04 - B08,B07,B06,B05,B04,B03,G01,G00
  86 // 0x06 -  - , - , - , - , - ,B02,B01,B00
  87 // 0x08 -  - , - , - , - , - , - , - , -
  88 // 0x0A - B17,B16,B15, - , - , - , - , -
  89 // 0x0C - G17,G16,B14,B13,B12,B11,B10,B09
  90 // 0x0E - R17,G15,G14,G13,G12,G11,G10,G09
  91 // 0x10 - R16,R15,R14,R13,R12,R11,R10,R09
  92
  93
  94 void IS31_write_register( uint8_t addr, uint8_t reg, uint8_t data )
  95 {
  96     g_twi_transfer_buffer[0] = reg;
  97     g_twi_transfer_buffer[1] = data;
  98
  99   #if ISSI_PERSISTENCE > 0
 100     for (uint8_t i = 0; i < ISSI_PERSISTENCE; i++) {
 101       if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, ISSI_TIMEOUT) == 0)
 102         break;
 103     }
 104   #else
 105     i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, ISSI_TIMEOUT);
 106   #endif
 107 }
 108
 109 void IS31_write_pwm_buffer( uint8_t addr, uint8_t *pwm_buffer )
 110 {
 111     // assumes bank is already selected
 112
 113     // transmit PWM registers in 9 transfers of 16 bytes
 114     // g_twi_transfer_buffer[] is 20 bytes
 115
 116     // iterate over the pwm_buffer contents at 16 byte intervals
 117     for ( int i = 0; i < 144; i += 16 ) {
 118         // set the first register, e.g. 0x24, 0x34, 0x44, etc.
 119         g_twi_transfer_buffer[0] = 0x24 + i;
 120         // copy the data from i to i+15
 121         // device will auto-increment register for data after the first byte
 122         // thus this sets registers 0x24-0x33, 0x34-0x43, etc. in one transfer
 123         for ( int j = 0; j < 16; j++ ) {
 124             g_twi_transfer_buffer[1 + j] = pwm_buffer[i + j];
 125         }
 126
 127     #if ISSI_PERSISTENCE > 0
 128       for (uint8_t i = 0; i < ISSI_PERSISTENCE; i++) {
 129         if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 17, ISSI_TIMEOUT) == 0)
 130           break;
 131       }
 132     #else
 133       i2c_transmit(addr << 1, g_twi_transfer_buffer, 17, ISSI_TIMEOUT);
 134     #endif
 135     }
 136 }
 137
 138 void IS31_init( uint8_t addr )
 139 {
 140     // In order to avoid the LEDs being driven with garbage data
 141     // in the LED driver's PWM registers, first enable software shutdown,
 142     // then set up the mode and other settings, clear the PWM registers,
 143     // then disable software shutdown.
 144
 145     // select "function register" bank
 146     IS31_write_register( addr, ISSI_COMMANDREGISTER, ISSI_BANK_FUNCTIONREG );
 147
 148     // enable software shutdown
 149     IS31_write_register( addr, ISSI_REG_SHUTDOWN, 0x00 );
 150     // this delay was copied from other drivers, might not be needed
 151     #ifdef __AVR__
 152     _delay_ms( 10 );
 153     #else
 154     wait_ms(10);
 155     #endif
 156
 157     // picture mode
 158     IS31_write_register( addr, ISSI_REG_CONFIG, ISSI_REG_CONFIG_PICTUREMODE );
 159     // display frame 0
 160     IS31_write_register( addr, ISSI_REG_PICTUREFRAME, 0x00 );
 161     // audio sync off
 162     IS31_write_register( addr, ISSI_REG_AUDIOSYNC, 0x00 );
 163
 164     // select bank 0
 165     IS31_write_register( addr, ISSI_COMMANDREGISTER, 0 );
 166
 167     // turn off all LEDs in the LED control register
 168     for ( int i = 0x00; i <= 0x11; i++ )
 169     {
 170         IS31_write_register( addr, i, 0x00 );
 171     }
 172
 173     // turn off all LEDs in the blink control register (not really needed)
 174     for ( int i = 0x12; i <= 0x23; i++ )
 175     {
 176         IS31_write_register( addr, i, 0x00 );
 177     }
 178
 179     // set PWM on all LEDs to 0
 180     for ( int i = 0x24; i <= 0xB3; i++ )
 181     {
 182         IS31_write_register( addr, i, 0x00 );
 183     }
 184
 185     // select "function register" bank
 186     IS31_write_register( addr, ISSI_COMMANDREGISTER, ISSI_BANK_FUNCTIONREG );
 187
 188     // disable software shutdown
 189     IS31_write_register( addr, ISSI_REG_SHUTDOWN, 0x01 );
 190
 191     // select bank 0 and leave it selected.
 192     // most usage after initialization is just writing PWM buffers in bank 0
 193     // as there's not much point in double-buffering
 194     IS31_write_register( addr, ISSI_COMMANDREGISTER, 0 );
 195
 196 }
 197
 198 void IS31_set_color( int index, uint8_t red, uint8_t green, uint8_t blue )
 199 {
 200     if ( index >= 0 && index < DRIVER_LED_TOTAL ) {
 201         is31_led led = g_is31_leds[index];
 202
 203         // Subtract 0x24 to get the second index of g_pwm_buffer
 204         g_pwm_buffer[led.driver][led.r - 0x24] = red;
 205         g_pwm_buffer[led.driver][led.g - 0x24] = green;
 206         g_pwm_buffer[led.driver][led.b - 0x24] = blue;
 207         g_pwm_buffer_update_required = true;
 208     }
 209 }
 210
 211 void IS31_set_color_all( uint8_t red, uint8_t green, uint8_t blue )
 212 {
 213     for ( int i = 0; i < DRIVER_LED_TOTAL; i++ )
 214     {
 215         IS31_set_color( i, red, green, blue );
 216     }
 217 }
 218
 219 void IS31_set_led_control_register( uint8_t index, bool red, bool green, bool blue )
 220 {
 221     is31_led led = g_is31_leds[index];
 222
 223   uint8_t control_register_r = (led.r - 0x24) / 8;
 224   uint8_t control_register_g = (led.g - 0x24) / 8;
 225   uint8_t control_register_b = (led.b - 0x24) / 8;
 226   uint8_t bit_r = (led.r - 0x24) % 8;
 227   uint8_t bit_g = (led.g - 0x24) % 8;
 228   uint8_t bit_b = (led.b - 0x24) % 8;
 229
 230     if ( red ) {
 231         g_led_control_registers[led.driver][control_register_r] |= (1 << bit_r);
 232     } else {
 233         g_led_control_registers[led.driver][control_register_r] &= ~(1 << bit_r);
 234     }
 235     if ( green ) {
 236         g_led_control_registers[led.driver][control_register_g] |= (1 << bit_g);
 237     } else {
 238         g_led_control_registers[led.driver][control_register_g] &= ~(1 << bit_g);
 239     }
 240     if ( blue ) {
 241         g_led_control_registers[led.driver][control_register_b] |= (1 << bit_b);
 242     } else {
 243         g_led_control_registers[led.driver][control_register_b] &= ~(1 << bit_b);
 244     }
 245
 246     g_led_control_registers_update_required = true;
 247
 248 }
 249
 250 void IS31_update_pwm_buffers( uint8_t addr1, uint8_t addr2 )
 251 {
 252     if ( g_pwm_buffer_update_required )
 253     {
 254         IS31_write_pwm_buffer( addr1, g_pwm_buffer[0] );
 255         IS31_write_pwm_buffer( addr2, g_pwm_buffer[1] );
 256     }
 257     g_pwm_buffer_update_required = false;
 258 }
 259
 260 void IS31_update_led_control_registers( uint8_t addr1, uint8_t addr2 )
 261 {
 262     if ( g_led_control_registers_update_required )
 263     {
 264         for ( int i=0; i<18; i++ )
 265         {
 266             IS31_write_register(addr1, i, g_led_control_registers[0][i] );
 267             IS31_write_register(addr2, i, g_led_control_registers[1][i] );
 268         }
 269     }
 270 }
 271