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