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