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 "TWIlib.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[TXMAXBUFLEN];
  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] = (addr << 1) | 0x00;
  84         g_twi_transfer_buffer[1] = reg;
  85         g_twi_transfer_buffer[2] = data;
  86
  87         // Set the error code to have no relevant information
  88         TWIInfo.errorCode = TWI_NO_RELEVANT_INFO;
  89         // Continuously attempt to transmit data until a successful transmission occurs
  90         //while ( TWIInfo.errorCode != 0xFF )
  91         //{
  92                 TWITransmitData( g_twi_transfer_buffer, 3, 0 );
  93         //}
  94 }
  95
  96 void IS31FL3731_write_pwm_buffer( uint8_t addr, uint8_t *pwm_buffer )
  97 {
  98         // assumes bank is already selected
  99
 100         // transmit PWM registers in 9 transfers of 16 bytes
 101         // g_twi_transfer_buffer[] is 20 bytes
 102
 103         // set the I2C address
 104         g_twi_transfer_buffer[0] = (addr << 1) | 0x00;
 105
 106         // iterate over the pwm_buffer contents at 16 byte intervals
 107         for ( int i = 0; i < 144; i += 16 )
 108         {
 109                 // set the first register, e.g. 0x24, 0x34, 0x44, etc.
 110                 g_twi_transfer_buffer[1] = 0x24 + i;
 111                 // copy the data from i to i+15
 112                 // device will auto-increment register for data after the first byte
 113                 // thus this sets registers 0x24-0x33, 0x34-0x43, etc. in one transfer
 114                 for ( int j = 0; j < 16; j++ )
 115                 {
 116                         g_twi_transfer_buffer[2 + j] = pwm_buffer[i + j];
 117                 }
 118
 119                 // Set the error code to have no relevant information
 120                 TWIInfo.errorCode = TWI_NO_RELEVANT_INFO;
 121                 // Continuously attempt to transmit data until a successful transmission occurs
 122                 while ( TWIInfo.errorCode != 0xFF )
 123                 {
 124                         TWITransmitData( g_twi_transfer_buffer, 16 + 2, 0 );
 125                 }
 126         }
 127 }
 128
 129 void IS31FL3731_init( uint8_t addr )
 130 {
 131         // In order to avoid the LEDs being driven with garbage data
 132         // in the LED driver's PWM registers, first enable software shutdown,
 133         // then set up the mode and other settings, clear the PWM registers,
 134         // then disable software shutdown.
 135
 136         // select "function register" bank
 137         IS31FL3731_write_register( addr, ISSI_COMMANDREGISTER, ISSI_BANK_FUNCTIONREG );
 138
 139         // enable software shutdown
 140         IS31FL3731_write_register( addr, ISSI_REG_SHUTDOWN, 0x00 );
 141         // this delay was copied from other drivers, might not be needed
 142         _delay_ms( 10 );
 143
 144         // picture mode
 145         IS31FL3731_write_register( addr, ISSI_REG_CONFIG, ISSI_REG_CONFIG_PICTUREMODE );
 146         // display frame 0
 147         IS31FL3731_write_register( addr, ISSI_REG_PICTUREFRAME, 0x00 );
 148         // audio sync off
 149         IS31FL3731_write_register( addr, ISSI_REG_AUDIOSYNC, 0x00 );
 150
 151         // select bank 0
 152         IS31FL3731_write_register( addr, ISSI_COMMANDREGISTER, 0 );
 153
 154         // turn off all LEDs in the LED control register
 155         for ( int i = 0x00; i <= 0x11; i++ )
 156         {
 157                 IS31FL3731_write_register( addr, i, 0x00 );
 158         }
 159
 160         // turn off all LEDs in the blink control register (not really needed)
 161         for ( int i = 0x12; i <= 0x23; i++ )
 162         {
 163                 IS31FL3731_write_register( addr, i, 0x00 );
 164         }
 165
 166         // set PWM on all LEDs to 0
 167         for ( int i = 0x24; i <= 0xB3; i++ )
 168         {
 169                 IS31FL3731_write_register( addr, i, 0x00 );
 170         }
 171
 172         // select "function register" bank
 173         IS31FL3731_write_register( addr, ISSI_COMMANDREGISTER, ISSI_BANK_FUNCTIONREG );
 174
 175         // disable software shutdown
 176         IS31FL3731_write_register( addr, ISSI_REG_SHUTDOWN, 0x01 );
 177
 178         // select bank 0 and leave it selected.
 179         // most usage after initialization is just writing PWM buffers in bank 0
 180         // as there's not much point in double-buffering
 181         IS31FL3731_write_register( addr, ISSI_COMMANDREGISTER, 0 );
 182 }
 183
 184 void IS31FL3731_set_color( int index, uint8_t red, uint8_t green, uint8_t blue )
 185 {
 186         if ( index >= 0 && index < DRIVER_LED_TOTAL ) {
 187                 is31_led led = g_is31_leds[index];
 188
 189                 // Subtract 0x24 to get the second index of g_pwm_buffer
 190                 g_pwm_buffer[led.driver][led.r - 0x24] = red;
 191                 g_pwm_buffer[led.driver][led.g - 0x24] = green;
 192                 g_pwm_buffer[led.driver][led.b - 0x24] = blue;
 193                 g_pwm_buffer_update_required = true;
 194         }
 195 }
 196
 197 void IS31FL3731_set_color_all( uint8_t red, uint8_t green, uint8_t blue )
 198 {
 199         for ( int i = 0; i < DRIVER_LED_TOTAL; i++ )
 200         {
 201                 IS31FL3731_set_color( i, red, green, blue );
 202         }
 203 }
 204
 205 void IS31FL3731_set_led_control_register( uint8_t index, bool red, bool green, bool blue )
 206 {
 207         is31_led led = g_is31_leds[index];
 208
 209   uint8_t control_register_r = (led.r - 0x24) / 8;
 210   uint8_t control_register_g = (led.g - 0x24) / 8;
 211   uint8_t control_register_b = (led.b - 0x24) / 8;
 212   uint8_t bit_r = (led.r - 0x24) % 8;
 213   uint8_t bit_g = (led.g - 0x24) % 8;
 214   uint8_t bit_b = (led.b - 0x24) % 8;
 215
 216         if ( red ) {
 217                 g_led_control_registers[led.driver][control_register_r] |= (1 << bit_r);
 218         } else {
 219                 g_led_control_registers[led.driver][control_register_r] &= ~(1 << bit_r);
 220         }
 221         if ( green ) {
 222                 g_led_control_registers[led.driver][control_register_g] |= (1 << bit_g);
 223         } else {
 224                 g_led_control_registers[led.driver][control_register_g] &= ~(1 << bit_g);
 225         }
 226         if ( blue ) {
 227                 g_led_control_registers[led.driver][control_register_b] |= (1 << bit_b);
 228         } else {
 229                 g_led_control_registers[led.driver][control_register_b] &= ~(1 << bit_b);
 230         }
 231
 232         g_led_control_registers_update_required = true;
 233
 234
 235 }
 236
 237 void IS31FL3731_update_pwm_buffers( uint8_t addr1, uint8_t addr2 )
 238 {
 239         if ( g_pwm_buffer_update_required )
 240         {
 241                 IS31FL3731_write_pwm_buffer( addr1, g_pwm_buffer[0] );
 242                 IS31FL3731_write_pwm_buffer( addr2, g_pwm_buffer[1] );
 243         }
 244         g_pwm_buffer_update_required = false;
 245 }
 246
 247 void IS31FL3731_update_led_control_registers( uint8_t addr1, uint8_t addr2 )
 248 {
 249         if ( g_led_control_registers_update_required )
 250         {
 251                 for ( int i=0; i<18; i++ )
 252                 {
 253                         IS31FL3731_write_register(addr1, i, g_led_control_registers[0][i] );
 254                         IS31FL3731_write_register(addr2, i, g_led_control_registers[1][i] );
 255                 }
 256         }
 257 }
 258