220 lines
8.6 KiB
C
220 lines
8.6 KiB
C
/* Copyright 2021 @ Keychron (https://www.keychron.com)
|
|
*
|
|
* 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 "ckled2001-simple.h"
|
|
#include "i2c_master.h"
|
|
|
|
#ifndef CKLED2001_I2C_TIMEOUT
|
|
# define CKLED2001_I2C_TIMEOUT 100
|
|
#endif
|
|
|
|
#ifndef CKLED2001_I2C_PERSISTENCE
|
|
# define CKLED2001_I2C_PERSISTENCE 0
|
|
#endif
|
|
|
|
#ifndef CKLED2001_PHASE_CHANNEL
|
|
# define CKLED2001_PHASE_CHANNEL CKLED2001_MSKPHASE_12CHANNEL
|
|
#endif
|
|
|
|
#ifndef CKLED2001_CURRENT_TUNE
|
|
# define CKLED2001_CURRENT_TUNE \
|
|
{ 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF }
|
|
#endif
|
|
|
|
// Transfer buffer for TWITransmitData()
|
|
uint8_t g_twi_transfer_buffer[20];
|
|
|
|
// These buffers match the CKLED2001 PWM registers.
|
|
// The control buffers match the PG0 LED On/Off registers.
|
|
// 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 ckled2001_write_pwm_buffer() but it's
|
|
// probably not worth the extra complexity.
|
|
uint8_t g_pwm_buffer[CKLED2001_DRIVER_COUNT][192];
|
|
bool g_pwm_buffer_update_required[CKLED2001_DRIVER_COUNT] = {false};
|
|
|
|
uint8_t g_led_control_registers[CKLED2001_DRIVER_COUNT][24] = {0};
|
|
bool g_led_control_registers_update_required[CKLED2001_DRIVER_COUNT] = {false};
|
|
|
|
bool ckled2001_write_register(uint8_t addr, uint8_t reg, uint8_t data) {
|
|
// If the transaction fails function returns false.
|
|
g_twi_transfer_buffer[0] = reg;
|
|
g_twi_transfer_buffer[1] = data;
|
|
|
|
#if CKLED2001_I2C_PERSISTENCE > 0
|
|
for (uint8_t i = 0; i < CKLED2001_I2C_PERSISTENCE; i++) {
|
|
if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, CKLED2001_I2C_TIMEOUT) != 0) {
|
|
return false;
|
|
}
|
|
}
|
|
#else
|
|
if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, CKLED2001_I2C_TIMEOUT) != 0) {
|
|
return false;
|
|
}
|
|
#endif
|
|
return true;
|
|
}
|
|
|
|
bool ckled2001_write_pwm_buffer(uint8_t addr, uint8_t *pwm_buffer) {
|
|
// Assumes PG1 is already selected.
|
|
// If any of the transactions fails function returns false.
|
|
// Transmit PWM registers in 12 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 < 192; i += 16) {
|
|
g_twi_transfer_buffer[0] = i;
|
|
// Copy the data from i to i+15.
|
|
// Device will auto-increment register for data after the first byte
|
|
// Thus this sets registers 0x00-0x0F, 0x10-0x1F, etc. in one transfer.
|
|
for (int j = 0; j < 16; j++) {
|
|
g_twi_transfer_buffer[1 + j] = pwm_buffer[i + j];
|
|
}
|
|
|
|
#if CKLED2001_I2C_PERSISTENCE > 0
|
|
for (uint8_t i = 0; i < CKLED2001_I2C_PERSISTENCE; i++) {
|
|
if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 17, CKLED2001_I2C_TIMEOUT) != 0) {
|
|
return false;
|
|
}
|
|
}
|
|
#else
|
|
if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 17, CKLED2001_I2C_TIMEOUT) != 0) {
|
|
return false;
|
|
}
|
|
#endif
|
|
}
|
|
return true;
|
|
}
|
|
|
|
void ckled2001_init(uint8_t addr) {
|
|
// Select to function page
|
|
ckled2001_write_register(addr, CKLED2001_REG_CONFIGURE_CMD_PAGE, CKLED2001_FUNCTION_PAGE);
|
|
// Setting LED driver to shutdown mode
|
|
ckled2001_write_register(addr, CKLED2001_REG_CONFIGURATION, CKLED2001_MSKSW_SHUT_DOWN_MODE);
|
|
// Setting internal channel pulldown/pullup
|
|
ckled2001_write_register(addr, CKLED2001_REG_PDU, CKLED2001_MSKSET_CA_CB_CHANNEL);
|
|
// Select number of scan phase
|
|
ckled2001_write_register(addr, CKLED2001_REG_SCAN_PHASE, CKLED2001_PHASE_CHANNEL);
|
|
// Setting PWM Delay Phase
|
|
ckled2001_write_register(addr, CKLED2001_REG_SLEW_RATE_CONTROL_MODE1, CKLED2001_MSKPWM_DELAY_PHASE_ENABLE);
|
|
// Setting Driving/Sinking Channel Slew Rate
|
|
ckled2001_write_register(addr, CKLED2001_REG_SLEW_RATE_CONTROL_MODE2, CKLED2001_MSKDRIVING_SINKING_CHANNEL_SLEWRATE_ENABLE);
|
|
// Setting Iref
|
|
ckled2001_write_register(addr, CKLED2001_REG_SOFTWARE_SLEEP, CKLED2001_MSKSLEEP_DISABLE);
|
|
// Set LED CONTROL PAGE (Page 0)
|
|
ckled2001_write_register(addr, CKLED2001_REG_CONFIGURE_CMD_PAGE, CKLED2001_LED_CONTROL_PAGE);
|
|
for (int i = 0; i < CKLED2001_LED_CONTROL_ON_OFF_LENGTH; i++) {
|
|
ckled2001_write_register(addr, i, 0x00);
|
|
}
|
|
|
|
// Set PWM PAGE (Page 1)
|
|
ckled2001_write_register(addr, CKLED2001_REG_CONFIGURE_CMD_PAGE, CKLED2001_LED_PWM_PAGE);
|
|
for (int i = 0; i < CKLED2001_LED_CURRENT_TUNE_LENGTH; i++) {
|
|
ckled2001_write_register(addr, i, 0x00);
|
|
}
|
|
|
|
// Set CURRENT PAGE (Page 4)
|
|
uint8_t current_tune_reg_list[CKLED2001_LED_CURRENT_TUNE_LENGTH] = CKLED2001_CURRENT_TUNE;
|
|
ckled2001_write_register(addr, CKLED2001_REG_CONFIGURE_CMD_PAGE, CKLED2001_CURRENT_TUNE_PAGE);
|
|
for (int i = 0; i < CKLED2001_LED_CURRENT_TUNE_LENGTH; i++) {
|
|
ckled2001_write_register(addr, i, current_tune_reg_list[i]);
|
|
}
|
|
|
|
// Enable LEDs ON/OFF
|
|
ckled2001_write_register(addr, CKLED2001_REG_CONFIGURE_CMD_PAGE, CKLED2001_LED_CONTROL_PAGE);
|
|
for (int i = 0; i < CKLED2001_LED_CONTROL_ON_OFF_LENGTH; i++) {
|
|
ckled2001_write_register(addr, i, 0xFF);
|
|
}
|
|
|
|
// Select to function page
|
|
ckled2001_write_register(addr, CKLED2001_REG_CONFIGURE_CMD_PAGE, CKLED2001_FUNCTION_PAGE);
|
|
// Setting LED driver to normal mode
|
|
ckled2001_write_register(addr, CKLED2001_REG_CONFIGURATION, CKLED2001_MSKSW_NORMAL_MODE);
|
|
}
|
|
|
|
void ckled2001_set_value(int index, uint8_t value) {
|
|
ckled2001_led led;
|
|
if (index >= 0 && index < LED_MATRIX_LED_COUNT) {
|
|
memcpy_P(&led, (&g_ckled2001_leds[index]), sizeof(led));
|
|
|
|
if (g_pwm_buffer[led.driver][led.v] == value) {
|
|
return;
|
|
}
|
|
g_pwm_buffer[led.driver][led.v] = value;
|
|
g_pwm_buffer_update_required[led.driver] = true;
|
|
}
|
|
}
|
|
|
|
void ckled2001_set_value_all(uint8_t value) {
|
|
for (int i = 0; i < LED_MATRIX_LED_COUNT; i++) {
|
|
ckled2001_set_value(i, value);
|
|
}
|
|
}
|
|
|
|
void ckled2001_set_led_control_register(uint8_t index, bool value) {
|
|
ckled2001_led led;
|
|
memcpy_P(&led, (&g_ckled2001_leds[index]), sizeof(led));
|
|
|
|
uint8_t control_register = led.v / 8;
|
|
uint8_t bit_value = led.v % 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 ckled2001_update_pwm_buffers(uint8_t addr, uint8_t index) {
|
|
if (g_pwm_buffer_update_required[index]) {
|
|
ckled2001_write_register(addr, CKLED2001_REG_CONFIGURE_CMD_PAGE, CKLED2001_LED_PWM_PAGE);
|
|
|
|
// If any of the transactions fail we risk writing dirty PG0,
|
|
// refresh page 0 just in case.
|
|
if (!ckled2001_write_pwm_buffer(addr, g_pwm_buffer[index])) {
|
|
g_led_control_registers_update_required[index] = true;
|
|
}
|
|
}
|
|
g_pwm_buffer_update_required[index] = false;
|
|
}
|
|
|
|
void ckled2001_update_led_control_registers(uint8_t addr, uint8_t index) {
|
|
if (g_led_control_registers_update_required[index]) {
|
|
ckled2001_write_register(addr, CKLED2001_REG_CONFIGURE_CMD_PAGE, CKLED2001_LED_CONTROL_PAGE);
|
|
for (int i = 0; i < 24; i++) {
|
|
ckled2001_write_register(addr, i, g_led_control_registers[index][i]);
|
|
}
|
|
}
|
|
g_led_control_registers_update_required[index] = false;
|
|
}
|
|
|
|
void ckled2001_sw_return_normal(uint8_t addr) {
|
|
// Select to function page
|
|
ckled2001_write_register(addr, CKLED2001_REG_CONFIGURE_CMD_PAGE, CKLED2001_FUNCTION_PAGE);
|
|
// Setting LED driver to normal mode
|
|
ckled2001_write_register(addr, CKLED2001_REG_CONFIGURATION, CKLED2001_MSKSW_NORMAL_MODE);
|
|
}
|
|
|
|
void ckled2001_sw_shutdown(uint8_t addr) {
|
|
// Select to function page
|
|
ckled2001_write_register(addr, CKLED2001_REG_CONFIGURE_CMD_PAGE, CKLED2001_FUNCTION_PAGE);
|
|
// Setting LED driver to shutdown mode
|
|
ckled2001_write_register(addr, CKLED2001_REG_CONFIGURATION, CKLED2001_MSKSW_SHUT_DOWN_MODE);
|
|
// Write SW Sleep Register
|
|
ckled2001_write_register(addr, CKLED2001_REG_SOFTWARE_SLEEP, CKLED2001_MSKSLEEP_ENABLE);
|
|
}
|