2018-08-15 07:19:38 +02:00
|
|
|
/* Copyright 2017 Jason Williams
|
|
|
|
* Copyright 2018 Jack Humbert
|
2021-11-02 00:40:01 +01:00
|
|
|
* Copyright 2021 Doni Crosby
|
2018-08-15 07:19:38 +02:00
|
|
|
*
|
|
|
|
* This program is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation, either version 2 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include "is31fl3731.h"
|
|
|
|
#include "i2c_master.h"
|
2019-12-29 19:21:58 +01:00
|
|
|
#include "wait.h"
|
2018-08-15 07:19:38 +02:00
|
|
|
|
2023-11-01 20:13:25 +01:00
|
|
|
#define IS31FL3731_PWM_REGISTER_COUNT 144
|
|
|
|
#define IS31FL3731_LED_CONTROL_REGISTER_COUNT 18
|
|
|
|
|
2023-09-13 14:53:15 +02:00
|
|
|
#ifndef IS31FL3731_I2C_TIMEOUT
|
|
|
|
# define IS31FL3731_I2C_TIMEOUT 100
|
2018-08-15 07:19:38 +02:00
|
|
|
#endif
|
|
|
|
|
2023-09-13 14:53:15 +02:00
|
|
|
#ifndef IS31FL3731_I2C_PERSISTENCE
|
|
|
|
# define IS31FL3731_I2C_PERSISTENCE 0
|
2018-08-15 07:19:38 +02:00
|
|
|
#endif
|
|
|
|
|
2024-02-09 12:37:18 +01:00
|
|
|
const uint8_t i2c_addresses[IS31FL3731_DRIVER_COUNT] = {
|
|
|
|
IS31FL3731_I2C_ADDRESS_1,
|
|
|
|
#ifdef IS31FL3731_I2C_ADDRESS_2
|
|
|
|
IS31FL3731_I2C_ADDRESS_2,
|
|
|
|
# ifdef IS31FL3731_I2C_ADDRESS_3
|
|
|
|
IS31FL3731_I2C_ADDRESS_3,
|
|
|
|
# ifdef IS31FL3731_I2C_ADDRESS_4
|
|
|
|
IS31FL3731_I2C_ADDRESS_4,
|
|
|
|
# endif
|
|
|
|
# endif
|
|
|
|
#endif
|
|
|
|
};
|
|
|
|
|
2018-08-15 07:19:38 +02:00
|
|
|
// These buffers match the IS31FL3731 PWM registers 0x24-0xB3.
|
|
|
|
// Storing them like this is optimal for I2C transfers to the registers.
|
|
|
|
// We could optimize this and take out the unused registers from these
|
2023-08-23 02:00:03 +02:00
|
|
|
// buffers and the transfers in is31fl3731_write_pwm_buffer() but it's
|
2018-08-15 07:19:38 +02:00
|
|
|
// probably not worth the extra complexity.
|
2024-02-10 08:48:13 +01:00
|
|
|
typedef struct is31fl3731_driver_t {
|
|
|
|
uint8_t pwm_buffer[IS31FL3731_PWM_REGISTER_COUNT];
|
|
|
|
bool pwm_buffer_dirty;
|
|
|
|
uint8_t led_control_buffer[IS31FL3731_LED_CONTROL_REGISTER_COUNT];
|
|
|
|
bool led_control_buffer_dirty;
|
|
|
|
} PACKED is31fl3731_driver_t;
|
|
|
|
|
|
|
|
is31fl3731_driver_t driver_buffers[IS31FL3731_DRIVER_COUNT] = {{
|
|
|
|
.pwm_buffer = {0},
|
|
|
|
.pwm_buffer_dirty = false,
|
|
|
|
.led_control_buffer = {0},
|
|
|
|
.led_control_buffer_dirty = false,
|
|
|
|
}};
|
2018-08-15 07:19:38 +02:00
|
|
|
|
2024-02-09 12:37:18 +01:00
|
|
|
void is31fl3731_write_register(uint8_t index, uint8_t reg, uint8_t data) {
|
2023-09-13 14:53:15 +02:00
|
|
|
#if IS31FL3731_I2C_PERSISTENCE > 0
|
|
|
|
for (uint8_t i = 0; i < IS31FL3731_I2C_PERSISTENCE; i++) {
|
2024-02-09 12:37:18 +01:00
|
|
|
if (i2c_write_register(i2c_addresses[index] << 1, reg, &data, 1, IS31FL3731_I2C_TIMEOUT) == I2C_STATUS_SUCCESS) break;
|
2018-08-15 07:19:38 +02:00
|
|
|
}
|
2019-08-30 20:19:03 +02:00
|
|
|
#else
|
2024-02-09 12:37:18 +01:00
|
|
|
i2c_write_register(i2c_addresses[index] << 1, reg, &data, 1, IS31FL3731_I2C_TIMEOUT);
|
2019-08-30 20:19:03 +02:00
|
|
|
#endif
|
2018-08-15 07:19:38 +02:00
|
|
|
}
|
|
|
|
|
2024-02-09 12:37:18 +01:00
|
|
|
void is31fl3731_select_page(uint8_t index, uint8_t page) {
|
|
|
|
is31fl3731_write_register(index, IS31FL3731_REG_COMMAND, page);
|
2023-12-04 07:52:40 +01:00
|
|
|
}
|
|
|
|
|
2024-02-09 12:37:18 +01:00
|
|
|
void is31fl3731_write_pwm_buffer(uint8_t index) {
|
2024-01-10 07:25:34 +01:00
|
|
|
// Assumes page 0 is already selected.
|
|
|
|
// Transmit PWM registers in 9 transfers of 16 bytes.
|
2018-08-15 07:19:38 +02:00
|
|
|
|
2024-01-10 07:25:34 +01:00
|
|
|
// Iterate over the pwm_buffer contents at 16 byte intervals.
|
|
|
|
for (uint8_t i = 0; i < IS31FL3731_PWM_REGISTER_COUNT; i += 16) {
|
2023-09-13 14:53:15 +02:00
|
|
|
#if IS31FL3731_I2C_PERSISTENCE > 0
|
2024-01-10 07:25:34 +01:00
|
|
|
for (uint8_t j = 0; j < IS31FL3731_I2C_PERSISTENCE; j++) {
|
2024-02-10 08:48:13 +01:00
|
|
|
if (i2c_write_register(i2c_addresses[index] << 1, IS31FL3731_FRAME_REG_PWM + i, driver_buffers[index].pwm_buffer + i, 16, IS31FL3731_I2C_TIMEOUT) == I2C_STATUS_SUCCESS) break;
|
2019-08-30 20:19:03 +02:00
|
|
|
}
|
|
|
|
#else
|
2024-02-10 08:48:13 +01:00
|
|
|
i2c_write_register(i2c_addresses[index] << 1, IS31FL3731_FRAME_REG_PWM + i, driver_buffers[index].pwm_buffer + i, 16, IS31FL3731_I2C_TIMEOUT);
|
2019-08-30 20:19:03 +02:00
|
|
|
#endif
|
2018-08-15 07:19:38 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-11-01 01:53:45 +01:00
|
|
|
void is31fl3731_init_drivers(void) {
|
|
|
|
i2c_init();
|
|
|
|
|
2024-02-09 12:37:18 +01:00
|
|
|
for (uint8_t i = 0; i < IS31FL3731_DRIVER_COUNT; i++) {
|
|
|
|
is31fl3731_init(i);
|
|
|
|
}
|
2023-11-01 01:53:45 +01:00
|
|
|
|
|
|
|
for (int i = 0; i < IS31FL3731_LED_COUNT; i++) {
|
|
|
|
is31fl3731_set_led_control_register(i, true, true, true);
|
|
|
|
}
|
|
|
|
|
2024-02-09 12:37:18 +01:00
|
|
|
for (uint8_t i = 0; i < IS31FL3731_DRIVER_COUNT; i++) {
|
|
|
|
is31fl3731_update_led_control_registers(i);
|
|
|
|
}
|
2023-11-01 01:53:45 +01:00
|
|
|
}
|
|
|
|
|
2024-02-09 12:37:18 +01:00
|
|
|
void is31fl3731_init(uint8_t index) {
|
2018-08-15 07:19:38 +02:00
|
|
|
// In order to avoid the LEDs being driven with garbage data
|
|
|
|
// in the LED driver's PWM registers, first enable software shutdown,
|
|
|
|
// then set up the mode and other settings, clear the PWM registers,
|
|
|
|
// then disable software shutdown.
|
|
|
|
|
2024-02-09 12:37:18 +01:00
|
|
|
is31fl3731_select_page(index, IS31FL3731_COMMAND_FUNCTION);
|
2018-08-15 07:19:38 +02:00
|
|
|
|
|
|
|
// enable software shutdown
|
2024-02-09 12:37:18 +01:00
|
|
|
is31fl3731_write_register(index, IS31FL3731_FUNCTION_REG_SHUTDOWN, 0x00);
|
2023-09-13 14:53:15 +02:00
|
|
|
#ifdef IS31FL3731_DEGHOST // set to enable de-ghosting of the array
|
2024-02-09 12:37:18 +01:00
|
|
|
is31fl3731_write_register(index, IS31FL3731_FUNCTION_REG_GHOST_IMAGE_PREVENTION, IS31FL3731_GHOST_IMAGE_PREVENTION_GEN);
|
2021-11-02 00:40:01 +01:00
|
|
|
#endif
|
2019-12-29 19:21:58 +01:00
|
|
|
|
|
|
|
// this delay was copied from other drivers, might not be needed
|
2018-08-15 07:19:38 +02:00
|
|
|
wait_ms(10);
|
|
|
|
|
|
|
|
// picture mode
|
2024-02-09 12:37:18 +01:00
|
|
|
is31fl3731_write_register(index, IS31FL3731_FUNCTION_REG_CONFIG, IS31FL3731_CONFIG_MODE_PICTURE);
|
2018-08-15 07:19:38 +02:00
|
|
|
// display frame 0
|
2024-02-09 12:37:18 +01:00
|
|
|
is31fl3731_write_register(index, IS31FL3731_FUNCTION_REG_PICTURE_DISPLAY, 0x00);
|
2018-08-15 07:19:38 +02:00
|
|
|
// audio sync off
|
2024-02-09 12:37:18 +01:00
|
|
|
is31fl3731_write_register(index, IS31FL3731_FUNCTION_REG_AUDIO_SYNC, 0x00);
|
2018-08-15 07:19:38 +02:00
|
|
|
|
2024-02-09 12:37:18 +01:00
|
|
|
is31fl3731_select_page(index, IS31FL3731_COMMAND_FRAME_1);
|
2018-08-15 07:19:38 +02:00
|
|
|
|
|
|
|
// turn off all LEDs in the LED control register
|
2024-01-13 20:21:15 +01:00
|
|
|
for (uint8_t i = 0; i < IS31FL3731_LED_CONTROL_REGISTER_COUNT; i++) {
|
2024-02-09 12:37:18 +01:00
|
|
|
is31fl3731_write_register(index, IS31FL3731_FRAME_REG_LED_CONTROL + i, 0x00);
|
2018-08-15 07:19:38 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
// turn off all LEDs in the blink control register (not really needed)
|
2024-01-13 20:21:15 +01:00
|
|
|
for (uint8_t i = 0; i < IS31FL3731_LED_CONTROL_REGISTER_COUNT; i++) {
|
2024-02-09 12:37:18 +01:00
|
|
|
is31fl3731_write_register(index, IS31FL3731_FRAME_REG_BLINK_CONTROL + i, 0x00);
|
2018-08-15 07:19:38 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
// set PWM on all LEDs to 0
|
2024-01-13 20:21:15 +01:00
|
|
|
for (uint8_t i = 0; i < IS31FL3731_PWM_REGISTER_COUNT; i++) {
|
2024-02-09 12:37:18 +01:00
|
|
|
is31fl3731_write_register(index, IS31FL3731_FRAME_REG_PWM + i, 0x00);
|
2018-08-15 07:19:38 +02:00
|
|
|
}
|
|
|
|
|
2024-02-09 12:37:18 +01:00
|
|
|
is31fl3731_select_page(index, IS31FL3731_COMMAND_FUNCTION);
|
2018-08-15 07:19:38 +02:00
|
|
|
|
|
|
|
// disable software shutdown
|
2024-02-09 12:37:18 +01:00
|
|
|
is31fl3731_write_register(index, IS31FL3731_FUNCTION_REG_SHUTDOWN, 0x01);
|
2018-08-15 07:19:38 +02:00
|
|
|
|
2023-12-04 07:52:40 +01:00
|
|
|
// select page 0 and leave it selected.
|
|
|
|
// most usage after initialization is just writing PWM buffers in page 0
|
2018-08-15 07:19:38 +02:00
|
|
|
// as there's not much point in double-buffering
|
2024-02-09 12:37:18 +01:00
|
|
|
is31fl3731_select_page(index, IS31FL3731_COMMAND_FRAME_1);
|
2018-08-15 07:19:38 +02:00
|
|
|
}
|
|
|
|
|
2023-08-23 02:00:03 +02:00
|
|
|
void is31fl3731_set_color(int index, uint8_t red, uint8_t green, uint8_t blue) {
|
2023-10-04 11:12:50 +02:00
|
|
|
is31fl3731_led_t led;
|
2024-01-08 02:24:10 +01:00
|
|
|
|
2023-11-01 01:53:45 +01:00
|
|
|
if (index >= 0 && index < IS31FL3731_LED_COUNT) {
|
2023-10-04 11:12:50 +02:00
|
|
|
memcpy_P(&led, (&g_is31fl3731_leds[index]), sizeof(led));
|
2018-08-15 07:19:38 +02:00
|
|
|
|
2024-02-10 08:48:13 +01:00
|
|
|
if (driver_buffers[led.driver].pwm_buffer[led.r] == red && driver_buffers[led.driver].pwm_buffer[led.g] == green && driver_buffers[led.driver].pwm_buffer[led.b] == blue) {
|
2023-06-08 03:58:53 +02:00
|
|
|
return;
|
|
|
|
}
|
2024-01-08 02:24:10 +01:00
|
|
|
|
2024-02-10 08:48:13 +01:00
|
|
|
driver_buffers[led.driver].pwm_buffer[led.r] = red;
|
|
|
|
driver_buffers[led.driver].pwm_buffer[led.g] = green;
|
|
|
|
driver_buffers[led.driver].pwm_buffer[led.b] = blue;
|
|
|
|
driver_buffers[led.driver].pwm_buffer_dirty = true;
|
2018-08-15 07:19:38 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-08-23 02:00:03 +02:00
|
|
|
void is31fl3731_set_color_all(uint8_t red, uint8_t green, uint8_t blue) {
|
2023-11-01 01:53:45 +01:00
|
|
|
for (int i = 0; i < IS31FL3731_LED_COUNT; i++) {
|
2023-08-23 02:00:03 +02:00
|
|
|
is31fl3731_set_color(i, red, green, blue);
|
2018-08-15 07:19:38 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-08-23 02:00:03 +02:00
|
|
|
void is31fl3731_set_led_control_register(uint8_t index, bool red, bool green, bool blue) {
|
2023-10-04 11:12:50 +02:00
|
|
|
is31fl3731_led_t led;
|
|
|
|
memcpy_P(&led, (&g_is31fl3731_leds[index]), sizeof(led));
|
2018-08-15 07:19:38 +02:00
|
|
|
|
2024-01-13 20:21:15 +01:00
|
|
|
uint8_t control_register_r = led.r / 8;
|
|
|
|
uint8_t control_register_g = led.g / 8;
|
|
|
|
uint8_t control_register_b = led.b / 8;
|
|
|
|
uint8_t bit_r = led.r % 8;
|
|
|
|
uint8_t bit_g = led.g % 8;
|
|
|
|
uint8_t bit_b = led.b % 8;
|
2018-08-15 07:19:38 +02:00
|
|
|
|
2019-08-30 20:19:03 +02:00
|
|
|
if (red) {
|
2024-02-10 08:48:13 +01:00
|
|
|
driver_buffers[led.driver].led_control_buffer[control_register_r] |= (1 << bit_r);
|
2018-08-15 07:19:38 +02:00
|
|
|
} else {
|
2024-02-10 08:48:13 +01:00
|
|
|
driver_buffers[led.driver].led_control_buffer[control_register_r] &= ~(1 << bit_r);
|
2018-08-15 07:19:38 +02:00
|
|
|
}
|
2019-08-30 20:19:03 +02:00
|
|
|
if (green) {
|
2024-02-10 08:48:13 +01:00
|
|
|
driver_buffers[led.driver].led_control_buffer[control_register_g] |= (1 << bit_g);
|
2018-08-15 07:19:38 +02:00
|
|
|
} else {
|
2024-02-10 08:48:13 +01:00
|
|
|
driver_buffers[led.driver].led_control_buffer[control_register_g] &= ~(1 << bit_g);
|
2018-08-15 07:19:38 +02:00
|
|
|
}
|
2019-08-30 20:19:03 +02:00
|
|
|
if (blue) {
|
2024-02-10 08:48:13 +01:00
|
|
|
driver_buffers[led.driver].led_control_buffer[control_register_b] |= (1 << bit_b);
|
2018-08-15 07:19:38 +02:00
|
|
|
} else {
|
2024-02-10 08:48:13 +01:00
|
|
|
driver_buffers[led.driver].led_control_buffer[control_register_b] &= ~(1 << bit_b);
|
2018-08-15 07:19:38 +02:00
|
|
|
}
|
|
|
|
|
2024-02-10 08:48:13 +01:00
|
|
|
driver_buffers[led.driver].led_control_buffer_dirty = true;
|
2018-08-15 07:19:38 +02:00
|
|
|
}
|
|
|
|
|
2024-02-09 12:37:18 +01:00
|
|
|
void is31fl3731_update_pwm_buffers(uint8_t index) {
|
2024-02-10 08:48:13 +01:00
|
|
|
if (driver_buffers[index].pwm_buffer_dirty) {
|
2024-02-09 12:37:18 +01:00
|
|
|
is31fl3731_write_pwm_buffer(index);
|
2024-01-08 02:24:10 +01:00
|
|
|
|
2024-02-10 08:48:13 +01:00
|
|
|
driver_buffers[index].pwm_buffer_dirty = false;
|
2018-08-15 07:19:38 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2024-02-09 12:37:18 +01:00
|
|
|
void is31fl3731_update_led_control_registers(uint8_t index) {
|
2024-02-10 08:48:13 +01:00
|
|
|
if (driver_buffers[index].led_control_buffer_dirty) {
|
2024-01-13 20:21:15 +01:00
|
|
|
for (uint8_t i = 0; i < IS31FL3731_LED_CONTROL_REGISTER_COUNT; i++) {
|
2024-02-10 08:48:13 +01:00
|
|
|
is31fl3731_write_register(index, i, driver_buffers[index].led_control_buffer[i]);
|
2018-08-15 07:19:38 +02:00
|
|
|
}
|
2024-01-08 02:24:10 +01:00
|
|
|
|
2024-02-10 08:48:13 +01:00
|
|
|
driver_buffers[index].led_control_buffer_dirty = false;
|
2018-08-15 07:19:38 +02:00
|
|
|
}
|
|
|
|
}
|
2023-10-22 19:32:27 +02:00
|
|
|
|
|
|
|
void is31fl3731_flush(void) {
|
2024-02-09 12:37:18 +01:00
|
|
|
for (uint8_t i = 0; i < IS31FL3731_DRIVER_COUNT; i++) {
|
|
|
|
is31fl3731_update_pwm_buffers(i);
|
|
|
|
}
|
2023-10-22 19:32:27 +02:00
|
|
|
}
|