forked from mirrors/qmk_firmware
236 lines
8.4 KiB
C
236 lines
8.4 KiB
C
/* Copyright 2017 Jason Williams
|
|
* Copyright 2018 Jack Humbert
|
|
* Copyright 2019 Clueboard
|
|
* Copyright 2021 Doni Crosby
|
|
*
|
|
* 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-simple.h"
|
|
#include <string.h>
|
|
#include "i2c_master.h"
|
|
#include "wait.h"
|
|
|
|
#define IS31FL3731_REG_CONFIG 0x00
|
|
#define IS31FL3731_REG_CONFIG_PICTUREMODE 0x00
|
|
#define IS31FL3731_REG_CONFIG_AUTOPLAYMODE 0x08
|
|
#define IS31FL3731_REG_CONFIG_AUDIOPLAYMODE 0x18
|
|
|
|
#define IS31FL3731_CONF_PICTUREMODE 0x00
|
|
#define IS31FL3731_CONF_AUTOFRAMEMODE 0x04
|
|
#define IS31FL3731_CONF_AUDIOMODE 0x08
|
|
|
|
#define IS31FL3731_REG_PICTUREFRAME 0x01
|
|
|
|
// Not defined in the datasheet -- See AN for IC
|
|
#define IS31FL3731_REG_GHOST_IMAGE_PREVENTION 0xC2 // Set bit 4 to enable de-ghosting
|
|
|
|
#define IS31FL3731_REG_SHUTDOWN 0x0A
|
|
#define IS31FL3731_REG_AUDIOSYNC 0x06
|
|
|
|
#define IS31FL3731_COMMANDREGISTER 0xFD
|
|
#define IS31FL3731_BANK_FUNCTIONREG 0x0B // helpfully called 'page nine'
|
|
|
|
#ifndef IS31FL3731_I2C_TIMEOUT
|
|
# define IS31FL3731_I2C_TIMEOUT 100
|
|
#endif
|
|
|
|
#ifndef IS31FL3731_I2C_PERSISTENCE
|
|
# define IS31FL3731_I2C_PERSISTENCE 0
|
|
#endif
|
|
|
|
// Transfer buffer for TWITransmitData()
|
|
uint8_t g_twi_transfer_buffer[20];
|
|
|
|
// 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
|
|
// buffers and the transfers in is31fl3731_write_pwm_buffer() but it's
|
|
// probably not worth the extra complexity.
|
|
uint8_t g_pwm_buffer[IS31FL3731_DRIVER_COUNT][144];
|
|
bool g_pwm_buffer_update_required[IS31FL3731_DRIVER_COUNT] = {false};
|
|
|
|
/* There's probably a better way to init this... */
|
|
#if IS31FL3731_DRIVER_COUNT == 1
|
|
uint8_t g_led_control_registers[IS31FL3731_DRIVER_COUNT][18] = {{0}};
|
|
#elif IS31FL3731_DRIVER_COUNT == 2
|
|
uint8_t g_led_control_registers[IS31FL3731_DRIVER_COUNT][18] = {{0}, {0}};
|
|
#elif IS31FL3731_DRIVER_COUNT == 3
|
|
uint8_t g_led_control_registers[IS31FL3731_DRIVER_COUNT][18] = {{0}, {0}, {0}};
|
|
#elif IS31FL3731_DRIVER_COUNT == 4
|
|
uint8_t g_led_control_registers[IS31FL3731_DRIVER_COUNT][18] = {{0}, {0}, {0}, {0}};
|
|
#endif
|
|
bool g_led_control_registers_update_required[IS31FL3731_DRIVER_COUNT] = {false};
|
|
|
|
// This is the bit pattern in the LED control registers
|
|
// (for matrix A, add one to register for matrix B)
|
|
//
|
|
// reg - b7 b6 b5 b4 b3 b2 b1 b0
|
|
// 0x00 - R08,R07,R06,R05,R04,R03,R02,R01
|
|
// 0x02 - G08,G07,G06,G05,G04,G03,G02,R00
|
|
// 0x04 - B08,B07,B06,B05,B04,B03,G01,G00
|
|
// 0x06 - - , - , - , - , - ,B02,B01,B00
|
|
// 0x08 - - , - , - , - , - , - , - , -
|
|
// 0x0A - B17,B16,B15, - , - , - , - , -
|
|
// 0x0C - G17,G16,B14,B13,B12,B11,B10,B09
|
|
// 0x0E - R17,G15,G14,G13,G12,G11,G10,G09
|
|
// 0x10 - R16,R15,R14,R13,R12,R11,R10,R09
|
|
|
|
void is31fl3731_write_register(uint8_t addr, uint8_t reg, uint8_t data) {
|
|
g_twi_transfer_buffer[0] = reg;
|
|
g_twi_transfer_buffer[1] = data;
|
|
|
|
#if IS31FL3731_I2C_PERSISTENCE > 0
|
|
for (uint8_t i = 0; i < IS31FL3731_I2C_PERSISTENCE; i++) {
|
|
if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, IS31FL3731_I2C_TIMEOUT) == 0) {
|
|
break;
|
|
}
|
|
}
|
|
#else
|
|
i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, IS31FL3731_I2C_TIMEOUT);
|
|
#endif
|
|
}
|
|
|
|
void is31fl3731_write_pwm_buffer(uint8_t addr, uint8_t *pwm_buffer) {
|
|
// assumes bank is already selected
|
|
|
|
// transmit PWM registers in 9 transfers of 16 bytes
|
|
// g_twi_transfer_buffer[] is 20 bytes
|
|
|
|
// iterate over the pwm_buffer contents at 16 byte intervals
|
|
for (int i = 0; i < 144; i += 16) {
|
|
// set the first register, e.g. 0x24, 0x34, 0x44, etc.
|
|
g_twi_transfer_buffer[0] = 0x24 + i;
|
|
// copy the data from i to i+15
|
|
// device will auto-increment register for data after the first byte
|
|
// thus this sets registers 0x24-0x33, 0x34-0x43, etc. in one transfer
|
|
memcpy(g_twi_transfer_buffer + 1, pwm_buffer + i, 16);
|
|
|
|
#if IS31FL3731_I2C_PERSISTENCE > 0
|
|
for (uint8_t i = 0; i < IS31FL3731_I2C_PERSISTENCE; i++) {
|
|
if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 17, IS31FL3731_I2C_TIMEOUT) == 0) break;
|
|
}
|
|
#else
|
|
i2c_transmit(addr << 1, g_twi_transfer_buffer, 17, IS31FL3731_I2C_TIMEOUT);
|
|
#endif
|
|
}
|
|
}
|
|
|
|
void is31fl3731_init(uint8_t addr) {
|
|
// 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.
|
|
|
|
// select "function register" bank
|
|
is31fl3731_write_register(addr, IS31FL3731_COMMANDREGISTER, IS31FL3731_BANK_FUNCTIONREG);
|
|
|
|
// enable software shutdown
|
|
is31fl3731_write_register(addr, IS31FL3731_REG_SHUTDOWN, 0x00);
|
|
#ifdef IS31FL3731_DEGHOST // set to enable de-ghosting of the array
|
|
is31fl3731_write_register(addr, IS31FL3731_REG_GHOST_IMAGE_PREVENTION, 0x10);
|
|
#endif
|
|
|
|
// this delay was copied from other drivers, might not be needed
|
|
wait_ms(10);
|
|
|
|
// picture mode
|
|
is31fl3731_write_register(addr, IS31FL3731_REG_CONFIG, IS31FL3731_REG_CONFIG_PICTUREMODE);
|
|
// display frame 0
|
|
is31fl3731_write_register(addr, IS31FL3731_REG_PICTUREFRAME, 0x00);
|
|
// audio sync off
|
|
is31fl3731_write_register(addr, IS31FL3731_REG_AUDIOSYNC, 0x00);
|
|
|
|
// select bank 0
|
|
is31fl3731_write_register(addr, IS31FL3731_COMMANDREGISTER, 0);
|
|
|
|
// turn off all LEDs in the LED control register
|
|
for (int i = 0x00; i <= 0x11; i++) {
|
|
is31fl3731_write_register(addr, i, 0x00);
|
|
}
|
|
|
|
// turn off all LEDs in the blink control register (not really needed)
|
|
for (int i = 0x12; i <= 0x23; i++) {
|
|
is31fl3731_write_register(addr, i, 0x00);
|
|
}
|
|
|
|
// set PWM on all LEDs to 0
|
|
for (int i = 0x24; i <= 0xB3; i++) {
|
|
is31fl3731_write_register(addr, i, 0x00);
|
|
}
|
|
|
|
// select "function register" bank
|
|
is31fl3731_write_register(addr, IS31FL3731_COMMANDREGISTER, IS31FL3731_BANK_FUNCTIONREG);
|
|
|
|
// disable software shutdown
|
|
is31fl3731_write_register(addr, IS31FL3731_REG_SHUTDOWN, 0x01);
|
|
|
|
// select bank 0 and leave it selected.
|
|
// most usage after initialization is just writing PWM buffers in bank 0
|
|
// as there's not much point in double-buffering
|
|
is31fl3731_write_register(addr, IS31FL3731_COMMANDREGISTER, 0);
|
|
}
|
|
|
|
void is31fl3731_set_value(int index, uint8_t value) {
|
|
is31_led led;
|
|
if (index >= 0 && index < LED_MATRIX_LED_COUNT) {
|
|
memcpy_P(&led, (&g_is31_leds[index]), sizeof(led));
|
|
|
|
// Subtract 0x24 to get the second index of g_pwm_buffer
|
|
|
|
if (g_pwm_buffer[led.driver][led.v - 0x24] == value) {
|
|
return;
|
|
}
|
|
g_pwm_buffer[led.driver][led.v - 0x24] = value;
|
|
g_pwm_buffer_update_required[led.driver] = true;
|
|
}
|
|
}
|
|
|
|
void is31fl3731_set_value_all(uint8_t value) {
|
|
for (int i = 0; i < LED_MATRIX_LED_COUNT; i++) {
|
|
is31fl3731_set_value(i, value);
|
|
}
|
|
}
|
|
|
|
void is31fl3731_set_led_control_register(uint8_t index, bool value) {
|
|
is31_led led;
|
|
memcpy_P(&led, (&g_is31_leds[index]), sizeof(led));
|
|
|
|
uint8_t control_register = (led.v - 0x24) / 8;
|
|
uint8_t bit_value = (led.v - 0x24) % 8;
|
|
|
|
if (value) {
|
|
g_led_control_registers[led.driver][control_register] |= (1 << bit_value);
|
|
} else {
|
|
g_led_control_registers[led.driver][control_register] &= ~(1 << bit_value);
|
|
}
|
|
|
|
g_led_control_registers_update_required[led.driver] = true;
|
|
}
|
|
|
|
void is31fl3731_update_pwm_buffers(uint8_t addr, uint8_t index) {
|
|
if (g_pwm_buffer_update_required[index]) {
|
|
is31fl3731_write_pwm_buffer(addr, g_pwm_buffer[index]);
|
|
g_pwm_buffer_update_required[index] = false;
|
|
}
|
|
}
|
|
|
|
void is31fl3731_update_led_control_registers(uint8_t addr, uint8_t index) {
|
|
if (g_led_control_registers_update_required[index]) {
|
|
for (int i = 0; i < 18; i++) {
|
|
is31fl3731_write_register(addr, i, g_led_control_registers[index][i]);
|
|
}
|
|
g_led_control_registers_update_required[index] = false;
|
|
}
|
|
}
|