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