1 /* Copyright 2018 Jason Williams (Wilba)
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.
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.
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/>.
19 #include <avr/interrupt.h>
21 #include <util/delay.h>
26 #include "is31fl3736.h"
28 #include "i2c_master.h"
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:
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
45 #define ISSI_COMMANDREGISTER 0xFD
46 #define ISSI_COMMANDREGISTER_WRITELOCK 0xFE
47 #define ISSI_INTERRUPTMASKREGISTER 0xF0
48 #define ISSI_INTERRUPTSTATUSREGISTER 0xF1
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
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
62 #define ISSI_TIMEOUT 100
65 #ifndef ISSI_PERSISTENCE
66 #define ISSI_PERSISTENCE 0
69 // Transfer buffer for TWITransmitData()
70 uint8_t g_twi_transfer_buffer[20];
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;
81 uint8_t g_led_control_registers[DRIVER_COUNT][24] = { { 0 }, { 0 } };
82 bool g_led_control_registers_update_required = false;
84 void IS31FL3736_write_register( uint8_t addr, uint8_t reg, uint8_t data )
86 g_twi_transfer_buffer[0] = reg;
87 g_twi_transfer_buffer[1] = data;
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)
95 i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, ISSI_TIMEOUT);
99 void IS31FL3736_write_pwm_buffer( uint8_t addr, uint8_t *pwm_buffer )
101 // assumes PG1 is already selected
103 // transmit PWM registers in 12 transfers of 16 bytes
104 // g_twi_transfer_buffer[] is 20 bytes
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];
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)
122 i2c_transmit(addr << 1, g_twi_transfer_buffer, 17, ISSI_TIMEOUT);
127 void IS31FL3736_init( uint8_t addr )
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.
134 // Unlock the command register.
135 IS31FL3736_write_register( addr, ISSI_COMMANDREGISTER_WRITELOCK, 0xC5 );
138 IS31FL3736_write_register( addr, ISSI_COMMANDREGISTER, ISSI_PAGE_LEDCONTROL );
139 // Turn off all LEDs.
140 for ( int i = 0x00; i <= 0x17; i++ )
142 IS31FL3736_write_register( addr, i, 0x00 );
145 // Unlock the command register.
146 IS31FL3736_write_register( addr, ISSI_COMMANDREGISTER_WRITELOCK, 0xC5 );
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++ )
154 IS31FL3736_write_register( addr, i, 0x00 );
157 // Unlock the command register.
158 IS31FL3736_write_register( addr, ISSI_COMMANDREGISTER_WRITELOCK, 0xC5 );
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 );
167 // Wait 10ms to ensure the device has woken up.
175 void IS31FL3736_set_color( int index, uint8_t red, uint8_t green, uint8_t blue )
177 if ( index >= 0 && index < DRIVER_LED_TOTAL ) {
178 is31_led led = g_is31_leds[index];
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;
187 void IS31FL3736_set_color_all( uint8_t red, uint8_t green, uint8_t blue )
189 for ( int i = 0; i < DRIVER_LED_TOTAL; i++ )
191 IS31FL3736_set_color( i, red, green, blue );
195 void IS31FL3736_set_led_control_register( uint8_t index, bool red, bool green, bool blue )
197 is31_led led = g_is31_leds[index];
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.
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.
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;
216 uint8_t bit_r = led.r % 8;
217 uint8_t bit_g = led.g % 8;
218 uint8_t bit_b = led.b % 8;
221 g_led_control_registers[led.driver][control_register_r] |= (1 << bit_r);
223 g_led_control_registers[led.driver][control_register_r] &= ~(1 << bit_r);
226 g_led_control_registers[led.driver][control_register_g] |= (1 << bit_g);
228 g_led_control_registers[led.driver][control_register_g] &= ~(1 << bit_g);
231 g_led_control_registers[led.driver][control_register_b] |= (1 << bit_b);
233 g_led_control_registers[led.driver][control_register_b] &= ~(1 << bit_b);
236 g_led_control_registers_update_required = true;
240 void IS31FL3736_mono_set_brightness( int index, uint8_t value )
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;
251 void IS31FL3736_mono_set_brightness_all( uint8_t value )
253 for ( int i = 0; i < 96; i++ )
255 IS31FL3736_mono_set_brightness( i, value );
259 void IS31FL3736_mono_set_led_control_register( uint8_t index, bool enabled )
261 // Index in range 0..95 -> A1..A8, B1..B8, etc.
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;
270 g_led_control_registers[0][control_register] |= (1 << bit);
272 g_led_control_registers[0][control_register] &= ~(1 << bit);
275 g_led_control_registers_update_required = true;
278 void IS31FL3736_update_pwm_buffers( uint8_t addr1, uint8_t addr2 )
280 if ( g_pwm_buffer_update_required )
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 );
286 IS31FL3736_write_pwm_buffer( addr1, g_pwm_buffer[0] );
287 //IS31FL3736_write_pwm_buffer( addr2, g_pwm_buffer[1] );
289 g_pwm_buffer_update_required = false;
292 void IS31FL3736_update_led_control_registers( uint8_t addr1, uint8_t addr2 )
294 if ( g_led_control_registers_update_required )
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++ )
301 IS31FL3736_write_register(addr1, i, g_led_control_registers[0][i] );
302 //IS31FL3736_write_register(addr2, i, g_led_control_registers[1][i] );