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