1 /* Copyright 2017 Jason Williams
2 * Copyright 2018 Jack Humbert
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.
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.
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/>.
19 #include <avr/interrupt.h>
21 #include <util/delay.h>
29 #include "is31fl3731-simple.h"
30 #include "i2c_master.h"
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
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
48 #define ISSI_CONF_PICTUREMODE 0x00
49 #define ISSI_CONF_AUTOFRAMEMODE 0x04
50 #define ISSI_CONF_AUDIOMODE 0x08
52 #define ISSI_REG_PICTUREFRAME 0x01
54 #define ISSI_REG_SHUTDOWN 0x0A
55 #define ISSI_REG_AUDIOSYNC 0x06
57 #define ISSI_COMMANDREGISTER 0xFD
58 #define ISSI_BANK_FUNCTIONREG 0x0B // helpfully called 'page nine'
61 #define ISSI_TIMEOUT 100
64 #ifndef ISSI_PERSISTENCE
65 #define ISSI_PERSISTENCE 0
68 // Transfer buffer for TWITransmitData()
69 uint8_t g_twi_transfer_buffer[20];
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;
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}};
89 bool g_led_control_registers_update_required = false;
91 // This is the bit pattern in the LED control registers
92 // (for matrix A, add one to register for matrix B)
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
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;
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) {
117 i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, ISSI_TIMEOUT);
121 void IS31FL3731_write_pwm_buffer(uint8_t addr, uint8_t *pwm_buffer) {
122 // assumes bank is already selected
124 // transmit PWM registers in 9 transfers of 16 bytes
125 // g_twi_transfer_buffer[] is 20 bytes
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];
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)
144 i2c_transmit(addr << 1, g_twi_transfer_buffer, 17, ISSI_TIMEOUT);
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.
155 // select "function register" bank
156 IS31FL3731_write_register(addr, ISSI_COMMANDREGISTER, ISSI_BANK_FUNCTIONREG);
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
164 IS31FL3731_write_register(addr, ISSI_REG_CONFIG, ISSI_REG_CONFIG_PICTUREMODE);
166 IS31FL3731_write_register(addr, ISSI_REG_PICTUREFRAME, 0x00);
168 IS31FL3731_write_register(addr, ISSI_REG_AUDIOSYNC, 0x00);
171 IS31FL3731_write_register(addr, ISSI_COMMANDREGISTER, 0);
173 // turn off all LEDs in the LED control register
174 for (int i = 0x00; i <= 0x11; i++) {
175 IS31FL3731_write_register(addr, i, 0x00);
178 // turn off all LEDs in the blink control register (not really needed)
179 for (int i = 0x12; i <= 0x23; i++) {
180 IS31FL3731_write_register(addr, i, 0x00);
183 // set PWM on all LEDs to 0
184 for (int i = 0x24; i <= 0xB3; i++) {
185 IS31FL3731_write_register(addr, i, 0x00);
188 // select "function register" bank
189 IS31FL3731_write_register(addr, ISSI_COMMANDREGISTER, ISSI_BANK_FUNCTIONREG);
191 // disable software shutdown
192 IS31FL3731_write_register(addr, ISSI_REG_SHUTDOWN, 0x01);
194 // select bank 0 and leave it selected.
195 // most usage after initialization is just writing PWM buffers in bank 0
196 // as there's not much point in double-buffering
197 IS31FL3731_write_register(addr, ISSI_COMMANDREGISTER, 0);
201 void IS31FL3731_set_value(int index, uint8_t value) {
202 if (index >= 0 && index < LED_DRIVER_LED_COUNT) {
203 is31_led led = g_is31_leds[index];
205 // Subtract 0x24 to get the second index of g_pwm_buffer
206 g_pwm_buffer[led.driver][led.v - 0x24] = value;
207 g_pwm_buffer_update_required = true;
211 void IS31FL3731_set_value_all(uint8_t value) {
212 for (int i = 0; i < LED_DRIVER_LED_COUNT; i++) {
213 IS31FL3731_set_value(i, value);
217 void IS31FL3731_set_led_control_register(uint8_t index, bool value) {
218 is31_led led = g_is31_leds[index];
220 uint8_t control_register = (led.v - 0x24) / 8;
221 uint8_t bit_value = (led.v - 0x24) % 8;
224 g_led_control_registers[led.driver][control_register] |= (1 << bit_value);
226 g_led_control_registers[led.driver][control_register] &= ~(1 << bit_value);
229 g_led_control_registers_update_required = true;
232 void IS31FL3731_update_pwm_buffers(uint8_t addr, uint8_t index) {
233 if (g_pwm_buffer_update_required) {
234 IS31FL3731_write_pwm_buffer(addr, g_pwm_buffer[index]);
235 g_pwm_buffer_update_required = false;
239 void IS31FL3731_update_led_control_registers(uint8_t addr, uint8_t index) {
240 if (g_led_control_registers_update_required) {
241 for (int i=0; i<18; i++) {
242 IS31FL3731_write_register(addr, i, g_led_control_registers[index][i]);