Rename CKLED2001 driver to SNLED27351 (#22071)

builddefs/common_features.mk

@@ -352,9 +352,12 @@ endif
 ifeq ($(strip $(LED_MATRIX_DRIVER)), aw20216)
 LED_MATRIX_DRIVER := aw20216s
 endif
+ifeq ($(strip $(LED_MATRIX_DRIVER)), ckled2001)
+LED_MATRIX_DRIVER := snled27351
+endif
 
 LED_MATRIX_ENABLE ?= no
-VALID_LED_MATRIX_TYPES := is31fl3218 is31fl3731 is31fl3733 is31fl3736 is31fl3737 is31fl3741 is31fl3742a is31fl3743a is31fl3745 is31fl3746a ckled2001 custom
+VALID_LED_MATRIX_TYPES := is31fl3218 is31fl3731 is31fl3733 is31fl3736 is31fl3737 is31fl3741 is31fl3742a is31fl3743a is31fl3745 is31fl3746a snled27351 custom
 
 ifeq ($(strip $(LED_MATRIX_ENABLE)), yes)
     ifeq ($(filter $(LED_MATRIX_DRIVER),$(VALID_LED_MATRIX_TYPES)),)
@@ -446,10 +449,10 @@ endif
         QUANTUM_LIB_SRC += i2c_master.c
     endif
 
-    ifeq ($(strip $(LED_MATRIX_DRIVER)), ckled2001)
+    ifeq ($(strip $(LED_MATRIX_DRIVER)), snled27351)
         OPT_DEFS += -DHAL_USE_I2C=TRUE
         COMMON_VPATH += $(DRIVER_PATH)/led
-        SRC += ckled2001-simple.c
+        SRC += snled27351-simple.c
         QUANTUM_LIB_SRC += i2c_master.c
     endif
 
@@ -459,10 +462,13 @@ endif
 ifeq ($(strip $(RGB_MATRIX_DRIVER)), aw20216)
 RGB_MATRIX_DRIVER := aw20216s
 endif
+ifeq ($(strip $(RGB_MATRIX_DRIVER)), ckled2001)
+RGB_MATRIX_DRIVER := snled27351
+endif
 
 RGB_MATRIX_ENABLE ?= no
 
-VALID_RGB_MATRIX_TYPES := aw20216s is31fl3218 is31fl3731 is31fl3733 is31fl3736 is31fl3737 is31fl3741 is31fl3742a is31fl3743a is31fl3745 is31fl3746a ckled2001 ws2812 custom
+VALID_RGB_MATRIX_TYPES := aw20216s is31fl3218 is31fl3731 is31fl3733 is31fl3736 is31fl3737 is31fl3741 is31fl3742a is31fl3743a is31fl3745 is31fl3746a snled27351 ws2812 custom
 ifeq ($(strip $(RGB_MATRIX_ENABLE)), yes)
     ifeq ($(filter $(RGB_MATRIX_DRIVER),$(VALID_RGB_MATRIX_TYPES)),)
         $(call CATASTROPHIC_ERROR,Invalid RGB_MATRIX_DRIVER,RGB_MATRIX_DRIVER="$(RGB_MATRIX_DRIVER)" is not a valid matrix type)
@@ -561,10 +567,10 @@ endif
         QUANTUM_LIB_SRC += i2c_master.c
     endif
 
-    ifeq ($(strip $(RGB_MATRIX_DRIVER)), ckled2001)
+    ifeq ($(strip $(RGB_MATRIX_DRIVER)), snled27351)
         OPT_DEFS += -DHAL_USE_I2C=TRUE
         COMMON_VPATH += $(DRIVER_PATH)/led
-        SRC += ckled2001.c
+        SRC += snled27351.c
         QUANTUM_LIB_SRC += i2c_master.c
     endif
 

docs/reference_info_json.md

@@ -329,7 +329,7 @@ Configures the [LED Matrix](feature_led_matrix.md) feature.
         * The centroid (geometric center) of the LEDs. Used for certain effects.
         * Default: `[112, 32]`
     * `driver` (Required)
-        * The driver to use. Must be one of `ckled2001`, `custom`, `is31fl3218`, `is31fl3731`, `is31fl3733`, `is31fl3736`, `is31fl3737`, `is31fl3741`, `is31fl3742a`, `is31fl3743a`, `is31fl3745`, `is31fl3746a`.
+        * The driver to use. Must be one of `custom`, `is31fl3218`, `is31fl3731`, `is31fl3733`, `is31fl3736`, `is31fl3737`, `is31fl3741`, `is31fl3742a`, `is31fl3743a`, `is31fl3745`, `is31fl3746a`, `snled27351`.
     * `layout` (Required)
         * List of LED configuration dictionaries. Each dictionary contains:
             * `flags` (Required)
@@ -542,7 +542,7 @@ Configures the [RGB Matrix](feature_rgb_matrix.md) feature.
         * The centroid (geometric center) of the LEDs. Used for certain effects.
         * Default: `[112, 32]`
     * `driver` (Required)
-        * The driver to use. Must be one of `aw20216s`, `ckled2001`, `custom`, `is31fl3218`, `is31fl3731`, `is31fl3733`, `is31fl3736`, `is31fl3737`, `is31fl3741`, `is31fl3742a`, `is31fl3743a`, `is31fl3745`, `is31fl3746a`, `ws2812`.
+        * The driver to use. Must be one of `aw20216s`, `custom`, `is31fl3218`, `is31fl3731`, `is31fl3733`, `is31fl3736`, `is31fl3737`, `is31fl3741`, `is31fl3742a`, `is31fl3743a`, `is31fl3745`, `is31fl3746a`, `snled27351`, `ws2812`.
     * `hue_steps`
         * The number of hue adjustment steps.
         * Default: `8`

drivers/led/ckled2001-simple.c

@@ -1,220 +0,0 @@
-/* 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);
-}

drivers/led/ckled2001-simple.h

@@ -1,370 +0,0 @@
-/* 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/>.
- */
-
-#pragma once
-
-#include <stdint.h>
-#include <stdbool.h>
-#include "progmem.h"
-
-// ======== DEPRECATED DEFINES - DO NOT USE ========
-#ifdef DRIVER_COUNT
-#    define CKLED2001_DRIVER_COUNT DRIVER_COUNT
-#endif
-#ifdef CKLED2001_TIMEOUT
-#    define CKLED2001_I2C_TIMEOUT CKLED2001_TIMEOUT
-#endif
-#ifdef CKLED2001_PERSISTENCE
-#    define CKLED2001_I2C_PERSISTENCE CKLED2001_PERSISTENCE
-#endif
-#ifdef PHASE_CHANNEL
-#    define CKLED2001_PHASE_CHANNEL PHASE_CHANNEL
-#endif
-
-#define MSKPHASE_12CHANNEL CKLED2001_MSKPHASE_12CHANNEL
-#define MSKPHASE_11CHANNEL CKLED2001_MSKPHASE_11CHANNEL
-#define MSKPHASE_10CHANNEL CKLED2001_MSKPHASE_10CHANNEL
-#define MSKPHASE_9CHANNEL CKLED2001_MSKPHASE_9CHANNEL
-#define MSKPHASE_8CHANNEL CKLED2001_MSKPHASE_8CHANNEL
-#define MSKPHASE_7CHANNEL CKLED2001_MSKPHASE_7CHANNEL
-#define MSKPHASE_6CHANNEL CKLED2001_MSKPHASE_6CHANNEL
-#define MSKPHASE_5CHANNEL CKLED2001_MSKPHASE_5CHANNEL
-#define MSKPHASE_4CHANNEL CKLED2001_MSKPHASE_4CHANNEL
-#define MSKPHASE_3CHANNEL CKLED2001_MSKPHASE_3CHANNEL
-#define MSKPHASE_2CHANNEL CKLED2001_MSKPHASE_2CHANNEL
-#define MSKPHASE_1CHANNEL CKLED2001_MSKPHASE_1CHANNEL
-// ========
-
-#define CKLED2001_I2C_ADDRESS_GND 0x74
-#define CKLED2001_I2C_ADDRESS_SCL 0x75
-#define CKLED2001_I2C_ADDRESS_SDA 0x76
-#define CKLED2001_I2C_ADDRESS_VDDIO 0x77
-
-typedef struct ckled2001_led {
-    uint8_t driver : 2;
-    uint8_t v;
-} __attribute__((packed)) ckled2001_led;
-
-extern const ckled2001_led PROGMEM g_ckled2001_leds[LED_MATRIX_LED_COUNT];
-
-void ckled2001_init(uint8_t addr);
-bool ckled2001_write_register(uint8_t addr, uint8_t reg, uint8_t data);
-bool ckled2001_write_pwm_buffer(uint8_t addr, uint8_t *pwm_buffer);
-
-void ckled2001_set_value(int index, uint8_t value);
-void ckled2001_set_value_all(uint8_t value);
-
-void ckled2001_set_led_control_register(uint8_t index, bool value);
-
-// This should not be called from an interrupt
-// (eg. from a timer interrupt).
-// Call this while idle (in between matrix scans).
-// If the buffer is dirty, it will update the driver with the buffer.
-void ckled2001_update_pwm_buffers(uint8_t addr, uint8_t index);
-void ckled2001_update_led_control_registers(uint8_t addr, uint8_t index);
-
-void ckled2001_sw_return_normal(uint8_t addr);
-void ckled2001_sw_shutdown(uint8_t addr);
-
-// Registers Page Define
-#define CKLED2001_REG_CONFIGURE_CMD_PAGE 0xFD
-#define CKLED2001_LED_CONTROL_PAGE 0x00
-#define CKLED2001_LED_PWM_PAGE 0x01
-#define CKLED2001_FUNCTION_PAGE 0x03
-#define CKLED2001_CURRENT_TUNE_PAGE 0x04
-
-// Function Register: address 0x00
-#define CKLED2001_REG_CONFIGURATION 0x00
-#define CKLED2001_MSKSW_SHUT_DOWN_MODE (0x0 << 0)
-#define CKLED2001_MSKSW_NORMAL_MODE (0x1 << 0)
-
-#define CKLED2001_REG_DRIVER_ID 0x11
-#define CKLED2001_DRIVER_ID 0x8A
-
-#define CKLED2001_REG_PDU 0x13
-#define CKLED2001_MSKSET_CA_CB_CHANNEL 0xAA
-#define CKLED2001_MSKCLR_CA_CB_CHANNEL 0x00
-
-#define CKLED2001_REG_SCAN_PHASE 0x14
-#define CKLED2001_MSKPHASE_12CHANNEL 0x00
-#define CKLED2001_MSKPHASE_11CHANNEL 0x01
-#define CKLED2001_MSKPHASE_10CHANNEL 0x02
-#define CKLED2001_MSKPHASE_9CHANNEL 0x03
-#define CKLED2001_MSKPHASE_8CHANNEL 0x04
-#define CKLED2001_MSKPHASE_7CHANNEL 0x05
-#define CKLED2001_MSKPHASE_6CHANNEL 0x06
-#define CKLED2001_MSKPHASE_5CHANNEL 0x07
-#define CKLED2001_MSKPHASE_4CHANNEL 0x08
-#define CKLED2001_MSKPHASE_3CHANNEL 0x09
-#define CKLED2001_MSKPHASE_2CHANNEL 0x0A
-#define CKLED2001_MSKPHASE_1CHANNEL 0x0B
-
-#define CKLED2001_REG_SLEW_RATE_CONTROL_MODE1 0x15
-#define CKLED2001_MSKPWM_DELAY_PHASE_ENABLE 0x04
-#define CKLED2001_MSKPWM_DELAY_PHASE_DISABLE 0x00
-
-#define CKLED2001_REG_SLEW_RATE_CONTROL_MODE2 0x16
-#define CKLED2001_MSKDRIVING_SINKING_CHANNEL_SLEWRATE_ENABLE 0xC0
-#define CKLED2001_MSKDRIVING_SINKING_CHANNEL_SLEWRATE_DISABLE 0x00
-
-#define CKLED2001_REG_OPEN_SHORT_ENABLE 0x17
-#define CKLED2001_MSKOPEN_DETECTION_ENABLE (0x01 << 7)
-#define CKLED2001_MSKOPEN_DETECTION_DISABLE (0x00)
-
-#define CKLED2001_MSKSHORT_DETECTION_ENABLE (0x01 << 6)
-#define CKLED2001_MSKSHORT_DETECTION_DISABLE (0x00)
-
-#define CKLED2001_REG_OPEN_SHORT_DUTY 0x18
-#define CKLED2001_REG_OPEN_SHORT_FLAG 0x19
-
-#define CKLED2001_MSKOPEN_DETECTION_INTERRUPT_ENABLE (0x01 << 7)
-#define CKLED2001_MSKOPEN_DETECTION_INTERRUPT_DISABLE (0x00)
-
-#define CKLED2001_MSKSHORT_DETECTION_INTERRUPT_ENABLE (0x01 << 6)
-#define CKLED2001_MSKSHORT_DETECTION_INTERRUPT_DISABLE (0x00)
-
-#define CKLED2001_REG_SOFTWARE_SLEEP 0x1A
-#define CKLED2001_MSKSLEEP_ENABLE 0x02
-#define CKLED2001_MSKSLEEP_DISABLE 0x00
-
-// LED Control Registers
-#define CKLED2001_LED_CONTROL_ON_OFF_FIRST_ADDR 0x0
-#define CKLED2001_LED_CONTROL_ON_OFF_LAST_ADDR 0x17
-#define CKLED2001_LED_CONTROL_ON_OFF_LENGTH ((CKLED2001_LED_CONTROL_ON_OFF_LAST_ADDR - CKLED2001_LED_CONTROL_ON_OFF_FIRST_ADDR) + 1)
-
-#define CKLED2001_LED_CONTROL_OPEN_FIRST_ADDR 0x18
-#define CKLED2001_LED_CONTROL_OPEN_LAST_ADDR 0x2F
-#define CKLED2001_LED_CONTROL_OPEN_LENGTH ((CKLED2001_LED_CONTROL_OPEN_LAST_ADDR - CKLED2001_LED_CONTROL_OPEN_FIRST_ADDR) + 1)
-
-#define CKLED2001_LED_CONTROL_SHORT_FIRST_ADDR 0x30
-#define CKLED2001_LED_CONTROL_SHORT_LAST_ADDR 0x47
-#define CKLED2001_LED_CONTROL_SHORT_LENGTH ((CKLED2001_LED_CONTROL_SHORT_LAST_ADDR - CKLED2001_LED_CONTROL_SHORT_FIRST_ADDR) + 1)
-
-#define CKLED2001_LED_CONTROL_PAGE_LENGTH 0x48
-
-// LED Control Registers
-#define CKLED2001_LED_PWM_FIRST_ADDR 0x00
-#define CKLED2001_LED_PWM_LAST_ADDR 0xBF
-#define CKLED2001_LED_PWM_LENGTH 0xC0
-
-// Current Tune Registers
-#define CKLED2001_LED_CURRENT_TUNE_FIRST_ADDR 0x00
-#define CKLED2001_LED_CURRENT_TUNE_LAST_ADDR 0x0B
-#define CKLED2001_LED_CURRENT_TUNE_LENGTH 0x0C
-
-#define A_1 0x00
-#define A_2 0x01
-#define A_3 0x02
-#define A_4 0x03
-#define A_5 0x04
-#define A_6 0x05
-#define A_7 0x06
-#define A_8 0x07
-#define A_9 0x08
-#define A_10 0x09
-#define A_11 0x0A
-#define A_12 0x0B
-#define A_13 0x0C
-#define A_14 0x0D
-#define A_15 0x0E
-#define A_16 0x0F
-
-#define B_1 0x10
-#define B_2 0x11
-#define B_3 0x12
-#define B_4 0x13
-#define B_5 0x14
-#define B_6 0x15
-#define B_7 0x16
-#define B_8 0x17
-#define B_9 0x18
-#define B_10 0x19
-#define B_11 0x1A
-#define B_12 0x1B
-#define B_13 0x1C
-#define B_14 0x1D
-#define B_15 0x1E
-#define B_16 0x1F
-
-#define C_1 0x20
-#define C_2 0x21
-#define C_3 0x22
-#define C_4 0x23
-#define C_5 0x24
-#define C_6 0x25
-#define C_7 0x26
-#define C_8 0x27
-#define C_9 0x28
-#define C_10 0x29
-#define C_11 0x2A
-#define C_12 0x2B
-#define C_13 0x2C
-#define C_14 0x2D
-#define C_15 0x2E
-#define C_16 0x2F
-
-#define D_1 0x30
-#define D_2 0x31
-#define D_3 0x32
-#define D_4 0x33
-#define D_5 0x34
-#define D_6 0x35
-#define D_7 0x36
-#define D_8 0x37
-#define D_9 0x38
-#define D_10 0x39
-#define D_11 0x3A
-#define D_12 0x3B
-#define D_13 0x3C
-#define D_14 0x3D
-#define D_15 0x3E
-#define D_16 0x3F
-
-#define E_1 0x40
-#define E_2 0x41
-#define E_3 0x42
-#define E_4 0x43
-#define E_5 0x44
-#define E_6 0x45
-#define E_7 0x46
-#define E_8 0x47
-#define E_9 0x48
-#define E_10 0x49
-#define E_11 0x4A
-#define E_12 0x4B
-#define E_13 0x4C
-#define E_14 0x4D
-#define E_15 0x4E
-#define E_16 0x4F
-
-#define F_1 0x50
-#define F_2 0x51
-#define F_3 0x52
-#define F_4 0x53
-#define F_5 0x54
-#define F_6 0x55
-#define F_7 0x56
-#define F_8 0x57
-#define F_9 0x58
-#define F_10 0x59
-#define F_11 0x5A
-#define F_12 0x5B
-#define F_13 0x5C
-#define F_14 0x5D
-#define F_15 0x5E
-#define F_16 0x5F
-
-#define G_1 0x60
-#define G_2 0x61
-#define G_3 0x62
-#define G_4 0x63
-#define G_5 0x64
-#define G_6 0x65
-#define G_7 0x66
-#define G_8 0x67
-#define G_9 0x68
-#define G_10 0x69
-#define G_11 0x6A
-#define G_12 0x6B
-#define G_13 0x6C
-#define G_14 0x6D
-#define G_15 0x6E
-#define G_16 0x6F
-
-#define H_1 0x70
-#define H_2 0x71
-#define H_3 0x72
-#define H_4 0x73
-#define H_5 0x74
-#define H_6 0x75
-#define H_7 0x76
-#define H_8 0x77
-#define H_9 0x78
-#define H_10 0x79
-#define H_11 0x7A
-#define H_12 0x7B
-#define H_13 0x7C
-#define H_14 0x7D
-#define H_15 0x7E
-#define H_16 0x7F
-
-#define I_1 0x80
-#define I_2 0x81
-#define I_3 0x82
-#define I_4 0x83
-#define I_5 0x84
-#define I_6 0x85
-#define I_7 0x86
-#define I_8 0x87
-#define I_9 0x88
-#define I_10 0x89
-#define I_11 0x8A
-#define I_12 0x8B
-#define I_13 0x8C
-#define I_14 0x8D
-#define I_15 0x8E
-#define I_16 0x8F
-
-#define J_1 0x90
-#define J_2 0x91
-#define J_3 0x92
-#define J_4 0x93
-#define J_5 0x94
-#define J_6 0x95
-#define J_7 0x96
-#define J_8 0x97
-#define J_9 0x98
-#define J_10 0x99
-#define J_11 0x9A
-#define J_12 0x9B
-#define J_13 0x9C
-#define J_14 0x9D
-#define J_15 0x9E
-#define J_16 0x9F
-
-#define K_1 0xA0
-#define K_2 0xA1
-#define K_3 0xA2
-#define K_4 0xA3
-#define K_5 0xA4
-#define K_6 0xA5
-#define K_7 0xA6
-#define K_8 0xA7
-#define K_9 0xA8
-#define K_10 0xA9
-#define K_11 0xAA
-#define K_12 0xAB
-#define K_13 0xAC
-#define K_14 0xAD
-#define K_15 0xAE
-#define K_16 0xAF
-
-#define L_1 0xB0
-#define L_2 0xB1
-#define L_3 0xB2
-#define L_4 0xB3
-#define L_5 0xB4
-#define L_6 0xB5
-#define L_7 0xB6
-#define L_8 0xB7
-#define L_9 0xB8
-#define L_10 0xB9
-#define L_11 0xBA
-#define L_12 0xBB
-#define L_13 0xBC
-#define L_14 0xBD
-#define L_15 0xBE
-#define L_16 0xBF

drivers/led/ckled2001.c

@@ -1,235 +0,0 @@
-/* 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.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[65];
-
-// 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 3 transfers of 64 bytes.
-
-    // Iterate over the pwm_buffer contents at 64 byte intervals.
-    for (uint8_t i = 0; i < 192; i += 64) {
-        g_twi_transfer_buffer[0] = i;
-        // Copy the data from i to i+63.
-        // Device will auto-increment register for data after the first byte
-        // Thus this sets registers 0x00-0x0F, 0x10-0x1F, etc. in one transfer.
-        for (uint8_t j = 0; j < 64; 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, 65, CKLED2001_I2C_TIMEOUT) != 0) {
-                return false;
-            }
-        }
-#else
-        if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 65, 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_color(int index, uint8_t red, uint8_t green, uint8_t blue) {
-    ckled2001_led led;
-    if (index >= 0 && index < RGB_MATRIX_LED_COUNT) {
-        memcpy_P(&led, (&g_ckled2001_leds[index]), sizeof(led));
-
-        if (g_pwm_buffer[led.driver][led.r] == red && g_pwm_buffer[led.driver][led.g] == green && g_pwm_buffer[led.driver][led.b] == blue) {
-            return;
-        }
-        g_pwm_buffer[led.driver][led.r]          = red;
-        g_pwm_buffer[led.driver][led.g]          = green;
-        g_pwm_buffer[led.driver][led.b]          = blue;
-        g_pwm_buffer_update_required[led.driver] = true;
-    }
-}
-
-void ckled2001_set_color_all(uint8_t red, uint8_t green, uint8_t blue) {
-    for (int i = 0; i < RGB_MATRIX_LED_COUNT; i++) {
-        ckled2001_set_color(i, red, green, blue);
-    }
-}
-
-void ckled2001_set_led_control_register(uint8_t index, bool red, bool green, bool blue) {
-    ckled2001_led led;
-    memcpy_P(&led, (&g_ckled2001_leds[index]), sizeof(led));
-
-    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;
-
-    if (red) {
-        g_led_control_registers[led.driver][control_register_r] |= (1 << bit_r);
-    } else {
-        g_led_control_registers[led.driver][control_register_r] &= ~(1 << bit_r);
-    }
-    if (green) {
-        g_led_control_registers[led.driver][control_register_g] |= (1 << bit_g);
-    } else {
-        g_led_control_registers[led.driver][control_register_g] &= ~(1 << bit_g);
-    }
-    if (blue) {
-        g_led_control_registers[led.driver][control_register_b] |= (1 << bit_b);
-    } else {
-        g_led_control_registers[led.driver][control_register_b] &= ~(1 << bit_b);
-    }
-
-    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);
-}

drivers/led/ckled2001.h

@@ -1,372 +0,0 @@
-/* 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/>.
- */
-
-#pragma once
-
-#include <stdint.h>
-#include <stdbool.h>
-#include "progmem.h"
-
-// ======== DEPRECATED DEFINES - DO NOT USE ========
-#ifdef DRIVER_COUNT
-#    define CKLED2001_DRIVER_COUNT DRIVER_COUNT
-#endif
-#ifdef CKLED2001_TIMEOUT
-#    define CKLED2001_I2C_TIMEOUT CKLED2001_TIMEOUT
-#endif
-#ifdef CKLED2001_PERSISTENCE
-#    define CKLED2001_I2C_PERSISTENCE CKLED2001_PERSISTENCE
-#endif
-#ifdef PHASE_CHANNEL
-#    define CKLED2001_PHASE_CHANNEL PHASE_CHANNEL
-#endif
-
-#define MSKPHASE_12CHANNEL CKLED2001_MSKPHASE_12CHANNEL
-#define MSKPHASE_11CHANNEL CKLED2001_MSKPHASE_11CHANNEL
-#define MSKPHASE_10CHANNEL CKLED2001_MSKPHASE_10CHANNEL
-#define MSKPHASE_9CHANNEL CKLED2001_MSKPHASE_9CHANNEL
-#define MSKPHASE_8CHANNEL CKLED2001_MSKPHASE_8CHANNEL
-#define MSKPHASE_7CHANNEL CKLED2001_MSKPHASE_7CHANNEL
-#define MSKPHASE_6CHANNEL CKLED2001_MSKPHASE_6CHANNEL
-#define MSKPHASE_5CHANNEL CKLED2001_MSKPHASE_5CHANNEL
-#define MSKPHASE_4CHANNEL CKLED2001_MSKPHASE_4CHANNEL
-#define MSKPHASE_3CHANNEL CKLED2001_MSKPHASE_3CHANNEL
-#define MSKPHASE_2CHANNEL CKLED2001_MSKPHASE_2CHANNEL
-#define MSKPHASE_1CHANNEL CKLED2001_MSKPHASE_1CHANNEL
-// ========
-
-#define CKLED2001_I2C_ADDRESS_GND 0x74
-#define CKLED2001_I2C_ADDRESS_SCL 0x75
-#define CKLED2001_I2C_ADDRESS_SDA 0x76
-#define CKLED2001_I2C_ADDRESS_VDDIO 0x77
-
-typedef struct ckled2001_led {
-    uint8_t driver : 2;
-    uint8_t r;
-    uint8_t g;
-    uint8_t b;
-} __attribute__((packed)) ckled2001_led;
-
-extern const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT];
-
-void ckled2001_init(uint8_t addr);
-bool ckled2001_write_register(uint8_t addr, uint8_t reg, uint8_t data);
-bool ckled2001_write_pwm_buffer(uint8_t addr, uint8_t *pwm_buffer);
-
-void ckled2001_set_color(int index, uint8_t red, uint8_t green, uint8_t blue);
-void ckled2001_set_color_all(uint8_t red, uint8_t green, uint8_t blue);
-
-void ckled2001_set_led_control_register(uint8_t index, bool red, bool green, bool blue);
-
-// This should not be called from an interrupt
-// (eg. from a timer interrupt).
-// Call this while idle (in between matrix scans).
-// If the buffer is dirty, it will update the driver with the buffer.
-void ckled2001_update_pwm_buffers(uint8_t addr, uint8_t index);
-void ckled2001_update_led_control_registers(uint8_t addr, uint8_t index);
-
-void ckled2001_sw_return_normal(uint8_t addr);
-void ckled2001_sw_shutdown(uint8_t addr);
-
-// Registers Page Define
-#define CKLED2001_REG_CONFIGURE_CMD_PAGE 0xFD
-#define CKLED2001_LED_CONTROL_PAGE 0x00
-#define CKLED2001_LED_PWM_PAGE 0x01
-#define CKLED2001_FUNCTION_PAGE 0x03
-#define CKLED2001_CURRENT_TUNE_PAGE 0x04
-
-// Function Register: address 0x00
-#define CKLED2001_REG_CONFIGURATION 0x00
-#define CKLED2001_MSKSW_SHUT_DOWN_MODE (0x0 << 0)
-#define CKLED2001_MSKSW_NORMAL_MODE (0x1 << 0)
-
-#define CKLED2001_REG_DRIVER_ID 0x11
-#define CKLED2001_DRIVER_ID 0x8A
-
-#define CKLED2001_REG_PDU 0x13
-#define CKLED2001_MSKSET_CA_CB_CHANNEL 0xAA
-#define CKLED2001_MSKCLR_CA_CB_CHANNEL 0x00
-
-#define CKLED2001_REG_SCAN_PHASE 0x14
-#define CKLED2001_MSKPHASE_12CHANNEL 0x00
-#define CKLED2001_MSKPHASE_11CHANNEL 0x01
-#define CKLED2001_MSKPHASE_10CHANNEL 0x02
-#define CKLED2001_MSKPHASE_9CHANNEL 0x03
-#define CKLED2001_MSKPHASE_8CHANNEL 0x04
-#define CKLED2001_MSKPHASE_7CHANNEL 0x05
-#define CKLED2001_MSKPHASE_6CHANNEL 0x06
-#define CKLED2001_MSKPHASE_5CHANNEL 0x07
-#define CKLED2001_MSKPHASE_4CHANNEL 0x08
-#define CKLED2001_MSKPHASE_3CHANNEL 0x09
-#define CKLED2001_MSKPHASE_2CHANNEL 0x0A
-#define CKLED2001_MSKPHASE_1CHANNEL 0x0B
-
-#define CKLED2001_REG_SLEW_RATE_CONTROL_MODE1 0x15
-#define CKLED2001_MSKPWM_DELAY_PHASE_ENABLE 0x04
-#define CKLED2001_MSKPWM_DELAY_PHASE_DISABLE 0x00
-
-#define CKLED2001_REG_SLEW_RATE_CONTROL_MODE2 0x16
-#define CKLED2001_MSKDRIVING_SINKING_CHANNEL_SLEWRATE_ENABLE 0xC0
-#define CKLED2001_MSKDRIVING_SINKING_CHANNEL_SLEWRATE_DISABLE 0x00
-
-#define CKLED2001_REG_OPEN_SHORT_ENABLE 0x17
-#define CKLED2001_MSKOPEN_DETECTION_ENABLE (0x01 << 7)
-#define CKLED2001_MSKOPEN_DETECTION_DISABLE (0x00)
-
-#define CKLED2001_MSKSHORT_DETECTION_ENABLE (0x01 << 6)
-#define CKLED2001_MSKSHORT_DETECTION_DISABLE (0x00)
-
-#define CKLED2001_REG_OPEN_SHORT_DUTY 0x18
-#define CKLED2001_REG_OPEN_SHORT_FLAG 0x19
-
-#define CKLED2001_MSKOPEN_DETECTION_INTERRUPT_ENABLE (0x01 << 7)
-#define CKLED2001_MSKOPEN_DETECTION_INTERRUPT_DISABLE (0x00)
-
-#define CKLED2001_MSKSHORT_DETECTION_INTERRUPT_ENABLE (0x01 << 6)
-#define CKLED2001_MSKSHORT_DETECTION_INTERRUPT_DISABLE (0x00)
-
-#define CKLED2001_REG_SOFTWARE_SLEEP 0x1A
-#define CKLED2001_MSKSLEEP_ENABLE 0x02
-#define CKLED2001_MSKSLEEP_DISABLE 0x00
-
-// LED Control Registers
-#define CKLED2001_LED_CONTROL_ON_OFF_FIRST_ADDR 0x0
-#define CKLED2001_LED_CONTROL_ON_OFF_LAST_ADDR 0x17
-#define CKLED2001_LED_CONTROL_ON_OFF_LENGTH ((CKLED2001_LED_CONTROL_ON_OFF_LAST_ADDR - CKLED2001_LED_CONTROL_ON_OFF_FIRST_ADDR) + 1)
-
-#define CKLED2001_LED_CONTROL_OPEN_FIRST_ADDR 0x18
-#define CKLED2001_LED_CONTROL_OPEN_LAST_ADDR 0x2F
-#define CKLED2001_LED_CONTROL_OPEN_LENGTH ((CKLED2001_LED_CONTROL_OPEN_LAST_ADDR - CKLED2001_LED_CONTROL_OPEN_FIRST_ADDR) + 1)
-
-#define CKLED2001_LED_CONTROL_SHORT_FIRST_ADDR 0x30
-#define CKLED2001_LED_CONTROL_SHORT_LAST_ADDR 0x47
-#define CKLED2001_LED_CONTROL_SHORT_LENGTH ((CKLED2001_LED_CONTROL_SHORT_LAST_ADDR - CKLED2001_LED_CONTROL_SHORT_FIRST_ADDR) + 1)
-
-#define CKLED2001_LED_CONTROL_PAGE_LENGTH 0x48
-
-// LED Control Registers
-#define CKLED2001_LED_PWM_FIRST_ADDR 0x00
-#define CKLED2001_LED_PWM_LAST_ADDR 0xBF
-#define CKLED2001_LED_PWM_LENGTH 0xC0
-
-// Current Tune Registers
-#define CKLED2001_LED_CURRENT_TUNE_FIRST_ADDR 0x00
-#define CKLED2001_LED_CURRENT_TUNE_LAST_ADDR 0x0B
-#define CKLED2001_LED_CURRENT_TUNE_LENGTH 0x0C
-
-#define A_1 0x00
-#define A_2 0x01
-#define A_3 0x02
-#define A_4 0x03
-#define A_5 0x04
-#define A_6 0x05
-#define A_7 0x06
-#define A_8 0x07
-#define A_9 0x08
-#define A_10 0x09
-#define A_11 0x0A
-#define A_12 0x0B
-#define A_13 0x0C
-#define A_14 0x0D
-#define A_15 0x0E
-#define A_16 0x0F
-
-#define B_1 0x10
-#define B_2 0x11
-#define B_3 0x12
-#define B_4 0x13
-#define B_5 0x14
-#define B_6 0x15
-#define B_7 0x16
-#define B_8 0x17
-#define B_9 0x18
-#define B_10 0x19
-#define B_11 0x1A
-#define B_12 0x1B
-#define B_13 0x1C
-#define B_14 0x1D
-#define B_15 0x1E
-#define B_16 0x1F
-
-#define C_1 0x20
-#define C_2 0x21
-#define C_3 0x22
-#define C_4 0x23
-#define C_5 0x24
-#define C_6 0x25
-#define C_7 0x26
-#define C_8 0x27
-#define C_9 0x28
-#define C_10 0x29
-#define C_11 0x2A
-#define C_12 0x2B
-#define C_13 0x2C
-#define C_14 0x2D
-#define C_15 0x2E
-#define C_16 0x2F
-
-#define D_1 0x30
-#define D_2 0x31
-#define D_3 0x32
-#define D_4 0x33
-#define D_5 0x34
-#define D_6 0x35
-#define D_7 0x36
-#define D_8 0x37
-#define D_9 0x38
-#define D_10 0x39
-#define D_11 0x3A
-#define D_12 0x3B
-#define D_13 0x3C
-#define D_14 0x3D
-#define D_15 0x3E
-#define D_16 0x3F
-
-#define E_1 0x40
-#define E_2 0x41
-#define E_3 0x42
-#define E_4 0x43
-#define E_5 0x44
-#define E_6 0x45
-#define E_7 0x46
-#define E_8 0x47
-#define E_9 0x48
-#define E_10 0x49
-#define E_11 0x4A
-#define E_12 0x4B
-#define E_13 0x4C
-#define E_14 0x4D
-#define E_15 0x4E
-#define E_16 0x4F
-
-#define F_1 0x50
-#define F_2 0x51
-#define F_3 0x52
-#define F_4 0x53
-#define F_5 0x54
-#define F_6 0x55
-#define F_7 0x56
-#define F_8 0x57
-#define F_9 0x58
-#define F_10 0x59
-#define F_11 0x5A
-#define F_12 0x5B
-#define F_13 0x5C
-#define F_14 0x5D
-#define F_15 0x5E
-#define F_16 0x5F
-
-#define G_1 0x60
-#define G_2 0x61
-#define G_3 0x62
-#define G_4 0x63
-#define G_5 0x64
-#define G_6 0x65
-#define G_7 0x66
-#define G_8 0x67
-#define G_9 0x68
-#define G_10 0x69
-#define G_11 0x6A
-#define G_12 0x6B
-#define G_13 0x6C
-#define G_14 0x6D
-#define G_15 0x6E
-#define G_16 0x6F
-
-#define H_1 0x70
-#define H_2 0x71
-#define H_3 0x72
-#define H_4 0x73
-#define H_5 0x74
-#define H_6 0x75
-#define H_7 0x76
-#define H_8 0x77
-#define H_9 0x78
-#define H_10 0x79
-#define H_11 0x7A
-#define H_12 0x7B
-#define H_13 0x7C
-#define H_14 0x7D
-#define H_15 0x7E
-#define H_16 0x7F
-
-#define I_1 0x80
-#define I_2 0x81
-#define I_3 0x82
-#define I_4 0x83
-#define I_5 0x84
-#define I_6 0x85
-#define I_7 0x86
-#define I_8 0x87
-#define I_9 0x88
-#define I_10 0x89
-#define I_11 0x8A
-#define I_12 0x8B
-#define I_13 0x8C
-#define I_14 0x8D
-#define I_15 0x8E
-#define I_16 0x8F
-
-#define J_1 0x90
-#define J_2 0x91
-#define J_3 0x92
-#define J_4 0x93
-#define J_5 0x94
-#define J_6 0x95
-#define J_7 0x96
-#define J_8 0x97
-#define J_9 0x98
-#define J_10 0x99
-#define J_11 0x9A
-#define J_12 0x9B
-#define J_13 0x9C
-#define J_14 0x9D
-#define J_15 0x9E
-#define J_16 0x9F
-
-#define K_1 0xA0
-#define K_2 0xA1
-#define K_3 0xA2
-#define K_4 0xA3
-#define K_5 0xA4
-#define K_6 0xA5
-#define K_7 0xA6
-#define K_8 0xA7
-#define K_9 0xA8
-#define K_10 0xA9
-#define K_11 0xAA
-#define K_12 0xAB
-#define K_13 0xAC
-#define K_14 0xAD
-#define K_15 0xAE
-#define K_16 0xAF
-
-#define L_1 0xB0
-#define L_2 0xB1
-#define L_3 0xB2
-#define L_4 0xB3
-#define L_5 0xB4
-#define L_6 0xB5
-#define L_7 0xB6
-#define L_8 0xB7
-#define L_9 0xB8
-#define L_10 0xB9
-#define L_11 0xBA
-#define L_12 0xBB
-#define L_13 0xBC
-#define L_14 0xBD
-#define L_15 0xBE
-#define L_16 0xBF

drivers/led/snled27351-simple.c

@@ -0,0 +1,220 @@
+/* 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 "snled27351-simple.h"
+#include "i2c_master.h"
+
+#ifndef SNLED27351_I2C_TIMEOUT
+#    define SNLED27351_I2C_TIMEOUT 100
+#endif
+
+#ifndef SNLED27351_I2C_PERSISTENCE
+#    define SNLED27351_I2C_PERSISTENCE 0
+#endif
+
+#ifndef SNLED27351_PHASE_CHANNEL
+#    define SNLED27351_PHASE_CHANNEL SNLED27351_MSKPHASE_12CHANNEL
+#endif
+
+#ifndef SNLED27351_CURRENT_TUNE
+#    define SNLED27351_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 SNLED27351 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 snled27351_write_pwm_buffer() but it's
+// probably not worth the extra complexity.
+uint8_t g_pwm_buffer[SNLED27351_DRIVER_COUNT][192];
+bool    g_pwm_buffer_update_required[SNLED27351_DRIVER_COUNT] = {false};
+
+uint8_t g_led_control_registers[SNLED27351_DRIVER_COUNT][24]             = {0};
+bool    g_led_control_registers_update_required[SNLED27351_DRIVER_COUNT] = {false};
+
+bool snled27351_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 SNLED27351_I2C_PERSISTENCE > 0
+    for (uint8_t i = 0; i < SNLED27351_I2C_PERSISTENCE; i++) {
+        if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, SNLED27351_I2C_TIMEOUT) != 0) {
+            return false;
+        }
+    }
+#else
+    if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, SNLED27351_I2C_TIMEOUT) != 0) {
+        return false;
+    }
+#endif
+    return true;
+}
+
+bool snled27351_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 SNLED27351_I2C_PERSISTENCE > 0
+        for (uint8_t i = 0; i < SNLED27351_I2C_PERSISTENCE; i++) {
+            if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 17, SNLED27351_I2C_TIMEOUT) != 0) {
+                return false;
+            }
+        }
+#else
+        if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 17, SNLED27351_I2C_TIMEOUT) != 0) {
+            return false;
+        }
+#endif
+    }
+    return true;
+}
+
+void snled27351_init(uint8_t addr) {
+    // Select to function page
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURE_CMD_PAGE, SNLED27351_FUNCTION_PAGE);
+    // Setting LED driver to shutdown mode
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURATION, SNLED27351_MSKSW_SHUT_DOWN_MODE);
+    // Setting internal channel pulldown/pullup
+    snled27351_write_register(addr, SNLED27351_REG_PDU, SNLED27351_MSKSET_CA_CB_CHANNEL);
+    // Select number of scan phase
+    snled27351_write_register(addr, SNLED27351_REG_SCAN_PHASE, SNLED27351_PHASE_CHANNEL);
+    // Setting PWM Delay Phase
+    snled27351_write_register(addr, SNLED27351_REG_SLEW_RATE_CONTROL_MODE1, SNLED27351_MSKPWM_DELAY_PHASE_ENABLE);
+    // Setting Driving/Sinking Channel Slew Rate
+    snled27351_write_register(addr, SNLED27351_REG_SLEW_RATE_CONTROL_MODE2, SNLED27351_MSKDRIVING_SINKING_CHANNEL_SLEWRATE_ENABLE);
+    // Setting Iref
+    snled27351_write_register(addr, SNLED27351_REG_SOFTWARE_SLEEP, SNLED27351_MSKSLEEP_DISABLE);
+    // Set LED CONTROL PAGE (Page 0)
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURE_CMD_PAGE, SNLED27351_LED_CONTROL_PAGE);
+    for (int i = 0; i < SNLED27351_LED_CONTROL_ON_OFF_LENGTH; i++) {
+        snled27351_write_register(addr, i, 0x00);
+    }
+
+    // Set PWM PAGE (Page 1)
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURE_CMD_PAGE, SNLED27351_LED_PWM_PAGE);
+    for (int i = 0; i < SNLED27351_LED_CURRENT_TUNE_LENGTH; i++) {
+        snled27351_write_register(addr, i, 0x00);
+    }
+
+    // Set CURRENT PAGE (Page 4)
+    uint8_t current_tune_reg_list[SNLED27351_LED_CURRENT_TUNE_LENGTH] = SNLED27351_CURRENT_TUNE;
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURE_CMD_PAGE, SNLED27351_CURRENT_TUNE_PAGE);
+    for (int i = 0; i < SNLED27351_LED_CURRENT_TUNE_LENGTH; i++) {
+        snled27351_write_register(addr, i, current_tune_reg_list[i]);
+    }
+
+    // Enable LEDs ON/OFF
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURE_CMD_PAGE, SNLED27351_LED_CONTROL_PAGE);
+    for (int i = 0; i < SNLED27351_LED_CONTROL_ON_OFF_LENGTH; i++) {
+        snled27351_write_register(addr, i, 0xFF);
+    }
+
+    // Select to function page
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURE_CMD_PAGE, SNLED27351_FUNCTION_PAGE);
+    // Setting LED driver to normal mode
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURATION, SNLED27351_MSKSW_NORMAL_MODE);
+}
+
+void snled27351_set_value(int index, uint8_t value) {
+    snled27351_led_t led;
+    if (index >= 0 && index < LED_MATRIX_LED_COUNT) {
+        memcpy_P(&led, (&g_snled27351_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 snled27351_set_value_all(uint8_t value) {
+    for (int i = 0; i < LED_MATRIX_LED_COUNT; i++) {
+        snled27351_set_value(i, value);
+    }
+}
+
+void snled27351_set_led_control_register(uint8_t index, bool value) {
+    snled27351_led_t led;
+    memcpy_P(&led, (&g_snled27351_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 snled27351_update_pwm_buffers(uint8_t addr, uint8_t index) {
+    if (g_pwm_buffer_update_required[index]) {
+        snled27351_write_register(addr, SNLED27351_REG_CONFIGURE_CMD_PAGE, SNLED27351_LED_PWM_PAGE);
+
+        // If any of the transactions fail we risk writing dirty PG0,
+        // refresh page 0 just in case.
+        if (!snled27351_write_pwm_buffer(addr, g_pwm_buffer[index])) {
+            g_led_control_registers_update_required[index] = true;
+        }
+    }
+    g_pwm_buffer_update_required[index] = false;
+}
+
+void snled27351_update_led_control_registers(uint8_t addr, uint8_t index) {
+    if (g_led_control_registers_update_required[index]) {
+        snled27351_write_register(addr, SNLED27351_REG_CONFIGURE_CMD_PAGE, SNLED27351_LED_CONTROL_PAGE);
+        for (int i = 0; i < 24; i++) {
+            snled27351_write_register(addr, i, g_led_control_registers[index][i]);
+        }
+    }
+    g_led_control_registers_update_required[index] = false;
+}
+
+void snled27351_sw_return_normal(uint8_t addr) {
+    // Select to function page
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURE_CMD_PAGE, SNLED27351_FUNCTION_PAGE);
+    // Setting LED driver to normal mode
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURATION, SNLED27351_MSKSW_NORMAL_MODE);
+}
+
+void snled27351_sw_shutdown(uint8_t addr) {
+    // Select to function page
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURE_CMD_PAGE, SNLED27351_FUNCTION_PAGE);
+    // Setting LED driver to shutdown mode
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURATION, SNLED27351_MSKSW_SHUT_DOWN_MODE);
+    // Write SW Sleep Register
+    snled27351_write_register(addr, SNLED27351_REG_SOFTWARE_SLEEP, SNLED27351_MSKSLEEP_ENABLE);
+}

drivers/led/snled27351-simple.h

@@ -0,0 +1,376 @@
+/* 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/>.
+ */
+
+#pragma once
+
+#include <stdint.h>
+#include <stdbool.h>
+#include "progmem.h"
+
+// ======== DEPRECATED DEFINES - DO NOT USE ========
+#ifdef DRIVER_COUNT
+#    define SNLED27351_DRIVER_COUNT DRIVER_COUNT
+#endif
+#ifdef CKLED2001_TIMEOUT
+#    define SNLED27351_I2C_TIMEOUT CKLED2001_TIMEOUT
+#endif
+#ifdef CKLED2001_PERSISTENCE
+#    define SNLED27351_I2C_PERSISTENCE CKLED2001_PERSISTENCE
+#endif
+#ifdef PHASE_CHANNEL
+#    define SNLED27351_PHASE_CHANNEL PHASE_CHANNEL
+#endif
+#ifdef CKLED2001_CURRENT_TUNE
+#    define SNLED27351_CURRENT_TUNE CKLED2001_CURRENT_TUNE
+#endif
+
+#define MSKPHASE_12CHANNEL SNLED27351_MSKPHASE_12CHANNEL
+#define MSKPHASE_11CHANNEL SNLED27351_MSKPHASE_11CHANNEL
+#define MSKPHASE_10CHANNEL SNLED27351_MSKPHASE_10CHANNEL
+#define MSKPHASE_9CHANNEL SNLED27351_MSKPHASE_9CHANNEL
+#define MSKPHASE_8CHANNEL SNLED27351_MSKPHASE_8CHANNEL
+#define MSKPHASE_7CHANNEL SNLED27351_MSKPHASE_7CHANNEL
+#define MSKPHASE_6CHANNEL SNLED27351_MSKPHASE_6CHANNEL
+#define MSKPHASE_5CHANNEL SNLED27351_MSKPHASE_5CHANNEL
+#define MSKPHASE_4CHANNEL SNLED27351_MSKPHASE_4CHANNEL
+#define MSKPHASE_3CHANNEL SNLED27351_MSKPHASE_3CHANNEL
+#define MSKPHASE_2CHANNEL SNLED27351_MSKPHASE_2CHANNEL
+#define MSKPHASE_1CHANNEL SNLED27351_MSKPHASE_1CHANNEL
+
+#define ckled2001_led snled27351_led_t
+#define g_ckled2001_leds g_snled27351_leds
+// ========
+
+#define SNLED27351_I2C_ADDRESS_GND 0x74
+#define SNLED27351_I2C_ADDRESS_SCL 0x75
+#define SNLED27351_I2C_ADDRESS_SDA 0x76
+#define SNLED27351_I2C_ADDRESS_VDDIO 0x77
+
+typedef struct snled27351_led_t {
+    uint8_t driver : 2;
+    uint8_t v;
+} __attribute__((packed)) snled27351_led_t;
+
+extern const snled27351_led_t PROGMEM g_snled27351_leds[LED_MATRIX_LED_COUNT];
+
+void snled27351_init(uint8_t addr);
+bool snled27351_write_register(uint8_t addr, uint8_t reg, uint8_t data);
+bool snled27351_write_pwm_buffer(uint8_t addr, uint8_t *pwm_buffer);
+
+void snled27351_set_value(int index, uint8_t value);
+void snled27351_set_value_all(uint8_t value);
+
+void snled27351_set_led_control_register(uint8_t index, bool value);
+
+// This should not be called from an interrupt
+// (eg. from a timer interrupt).
+// Call this while idle (in between matrix scans).
+// If the buffer is dirty, it will update the driver with the buffer.
+void snled27351_update_pwm_buffers(uint8_t addr, uint8_t index);
+void snled27351_update_led_control_registers(uint8_t addr, uint8_t index);
+
+void snled27351_sw_return_normal(uint8_t addr);
+void snled27351_sw_shutdown(uint8_t addr);
+
+// Registers Page Define
+#define SNLED27351_REG_CONFIGURE_CMD_PAGE 0xFD
+#define SNLED27351_LED_CONTROL_PAGE 0x00
+#define SNLED27351_LED_PWM_PAGE 0x01
+#define SNLED27351_FUNCTION_PAGE 0x03
+#define SNLED27351_CURRENT_TUNE_PAGE 0x04
+
+// Function Register: address 0x00
+#define SNLED27351_REG_CONFIGURATION 0x00
+#define SNLED27351_MSKSW_SHUT_DOWN_MODE (0x0 << 0)
+#define SNLED27351_MSKSW_NORMAL_MODE (0x1 << 0)
+
+#define SNLED27351_REG_DRIVER_ID 0x11
+#define SNLED27351_DRIVER_ID 0x8A
+
+#define SNLED27351_REG_PDU 0x13
+#define SNLED27351_MSKSET_CA_CB_CHANNEL 0xAA
+#define SNLED27351_MSKCLR_CA_CB_CHANNEL 0x00
+
+#define SNLED27351_REG_SCAN_PHASE 0x14
+#define SNLED27351_MSKPHASE_12CHANNEL 0x00
+#define SNLED27351_MSKPHASE_11CHANNEL 0x01
+#define SNLED27351_MSKPHASE_10CHANNEL 0x02
+#define SNLED27351_MSKPHASE_9CHANNEL 0x03
+#define SNLED27351_MSKPHASE_8CHANNEL 0x04
+#define SNLED27351_MSKPHASE_7CHANNEL 0x05
+#define SNLED27351_MSKPHASE_6CHANNEL 0x06
+#define SNLED27351_MSKPHASE_5CHANNEL 0x07
+#define SNLED27351_MSKPHASE_4CHANNEL 0x08
+#define SNLED27351_MSKPHASE_3CHANNEL 0x09
+#define SNLED27351_MSKPHASE_2CHANNEL 0x0A
+#define SNLED27351_MSKPHASE_1CHANNEL 0x0B
+
+#define SNLED27351_REG_SLEW_RATE_CONTROL_MODE1 0x15
+#define SNLED27351_MSKPWM_DELAY_PHASE_ENABLE 0x04
+#define SNLED27351_MSKPWM_DELAY_PHASE_DISABLE 0x00
+
+#define SNLED27351_REG_SLEW_RATE_CONTROL_MODE2 0x16
+#define SNLED27351_MSKDRIVING_SINKING_CHANNEL_SLEWRATE_ENABLE 0xC0
+#define SNLED27351_MSKDRIVING_SINKING_CHANNEL_SLEWRATE_DISABLE 0x00
+
+#define SNLED27351_REG_OPEN_SHORT_ENABLE 0x17
+#define SNLED27351_MSKOPEN_DETECTION_ENABLE (0x01 << 7)
+#define SNLED27351_MSKOPEN_DETECTION_DISABLE (0x00)
+
+#define SNLED27351_MSKSHORT_DETECTION_ENABLE (0x01 << 6)
+#define SNLED27351_MSKSHORT_DETECTION_DISABLE (0x00)
+
+#define SNLED27351_REG_OPEN_SHORT_DUTY 0x18
+#define SNLED27351_REG_OPEN_SHORT_FLAG 0x19
+
+#define SNLED27351_MSKOPEN_DETECTION_INTERRUPT_ENABLE (0x01 << 7)
+#define SNLED27351_MSKOPEN_DETECTION_INTERRUPT_DISABLE (0x00)
+
+#define SNLED27351_MSKSHORT_DETECTION_INTERRUPT_ENABLE (0x01 << 6)
+#define SNLED27351_MSKSHORT_DETECTION_INTERRUPT_DISABLE (0x00)
+
+#define SNLED27351_REG_SOFTWARE_SLEEP 0x1A
+#define SNLED27351_MSKSLEEP_ENABLE 0x02
+#define SNLED27351_MSKSLEEP_DISABLE 0x00
+
+// LED Control Registers
+#define SNLED27351_LED_CONTROL_ON_OFF_FIRST_ADDR 0x0
+#define SNLED27351_LED_CONTROL_ON_OFF_LAST_ADDR 0x17
+#define SNLED27351_LED_CONTROL_ON_OFF_LENGTH ((SNLED27351_LED_CONTROL_ON_OFF_LAST_ADDR - SNLED27351_LED_CONTROL_ON_OFF_FIRST_ADDR) + 1)
+
+#define SNLED27351_LED_CONTROL_OPEN_FIRST_ADDR 0x18
+#define SNLED27351_LED_CONTROL_OPEN_LAST_ADDR 0x2F
+#define SNLED27351_LED_CONTROL_OPEN_LENGTH ((SNLED27351_LED_CONTROL_OPEN_LAST_ADDR - SNLED27351_LED_CONTROL_OPEN_FIRST_ADDR) + 1)
+
+#define SNLED27351_LED_CONTROL_SHORT_FIRST_ADDR 0x30
+#define SNLED27351_LED_CONTROL_SHORT_LAST_ADDR 0x47
+#define SNLED27351_LED_CONTROL_SHORT_LENGTH ((SNLED27351_LED_CONTROL_SHORT_LAST_ADDR - SNLED27351_LED_CONTROL_SHORT_FIRST_ADDR) + 1)
+
+#define SNLED27351_LED_CONTROL_PAGE_LENGTH 0x48
+
+// LED Control Registers
+#define SNLED27351_LED_PWM_FIRST_ADDR 0x00
+#define SNLED27351_LED_PWM_LAST_ADDR 0xBF
+#define SNLED27351_LED_PWM_LENGTH 0xC0
+
+// Current Tune Registers
+#define SNLED27351_LED_CURRENT_TUNE_FIRST_ADDR 0x00
+#define SNLED27351_LED_CURRENT_TUNE_LAST_ADDR 0x0B
+#define SNLED27351_LED_CURRENT_TUNE_LENGTH 0x0C
+
+#define A_1 0x00
+#define A_2 0x01
+#define A_3 0x02
+#define A_4 0x03
+#define A_5 0x04
+#define A_6 0x05
+#define A_7 0x06
+#define A_8 0x07
+#define A_9 0x08
+#define A_10 0x09
+#define A_11 0x0A
+#define A_12 0x0B
+#define A_13 0x0C
+#define A_14 0x0D
+#define A_15 0x0E
+#define A_16 0x0F
+
+#define B_1 0x10
+#define B_2 0x11
+#define B_3 0x12
+#define B_4 0x13
+#define B_5 0x14
+#define B_6 0x15
+#define B_7 0x16
+#define B_8 0x17
+#define B_9 0x18
+#define B_10 0x19
+#define B_11 0x1A
+#define B_12 0x1B
+#define B_13 0x1C
+#define B_14 0x1D
+#define B_15 0x1E
+#define B_16 0x1F
+
+#define C_1 0x20
+#define C_2 0x21
+#define C_3 0x22
+#define C_4 0x23
+#define C_5 0x24
+#define C_6 0x25
+#define C_7 0x26
+#define C_8 0x27
+#define C_9 0x28
+#define C_10 0x29
+#define C_11 0x2A
+#define C_12 0x2B
+#define C_13 0x2C
+#define C_14 0x2D
+#define C_15 0x2E
+#define C_16 0x2F
+
+#define D_1 0x30
+#define D_2 0x31
+#define D_3 0x32
+#define D_4 0x33
+#define D_5 0x34
+#define D_6 0x35
+#define D_7 0x36
+#define D_8 0x37
+#define D_9 0x38
+#define D_10 0x39
+#define D_11 0x3A
+#define D_12 0x3B
+#define D_13 0x3C
+#define D_14 0x3D
+#define D_15 0x3E
+#define D_16 0x3F
+
+#define E_1 0x40
+#define E_2 0x41
+#define E_3 0x42
+#define E_4 0x43
+#define E_5 0x44
+#define E_6 0x45
+#define E_7 0x46
+#define E_8 0x47
+#define E_9 0x48
+#define E_10 0x49
+#define E_11 0x4A
+#define E_12 0x4B
+#define E_13 0x4C
+#define E_14 0x4D
+#define E_15 0x4E
+#define E_16 0x4F
+
+#define F_1 0x50
+#define F_2 0x51
+#define F_3 0x52
+#define F_4 0x53
+#define F_5 0x54
+#define F_6 0x55
+#define F_7 0x56
+#define F_8 0x57
+#define F_9 0x58
+#define F_10 0x59
+#define F_11 0x5A
+#define F_12 0x5B
+#define F_13 0x5C
+#define F_14 0x5D
+#define F_15 0x5E
+#define F_16 0x5F
+
+#define G_1 0x60
+#define G_2 0x61
+#define G_3 0x62
+#define G_4 0x63
+#define G_5 0x64
+#define G_6 0x65
+#define G_7 0x66
+#define G_8 0x67
+#define G_9 0x68
+#define G_10 0x69
+#define G_11 0x6A
+#define G_12 0x6B
+#define G_13 0x6C
+#define G_14 0x6D
+#define G_15 0x6E
+#define G_16 0x6F
+
+#define H_1 0x70
+#define H_2 0x71
+#define H_3 0x72
+#define H_4 0x73
+#define H_5 0x74
+#define H_6 0x75
+#define H_7 0x76
+#define H_8 0x77
+#define H_9 0x78
+#define H_10 0x79
+#define H_11 0x7A
+#define H_12 0x7B
+#define H_13 0x7C
+#define H_14 0x7D
+#define H_15 0x7E
+#define H_16 0x7F
+
+#define I_1 0x80
+#define I_2 0x81
+#define I_3 0x82
+#define I_4 0x83
+#define I_5 0x84
+#define I_6 0x85
+#define I_7 0x86
+#define I_8 0x87
+#define I_9 0x88
+#define I_10 0x89
+#define I_11 0x8A
+#define I_12 0x8B
+#define I_13 0x8C
+#define I_14 0x8D
+#define I_15 0x8E
+#define I_16 0x8F
+
+#define J_1 0x90
+#define J_2 0x91
+#define J_3 0x92
+#define J_4 0x93
+#define J_5 0x94
+#define J_6 0x95
+#define J_7 0x96
+#define J_8 0x97
+#define J_9 0x98
+#define J_10 0x99
+#define J_11 0x9A
+#define J_12 0x9B
+#define J_13 0x9C
+#define J_14 0x9D
+#define J_15 0x9E
+#define J_16 0x9F
+
+#define K_1 0xA0
+#define K_2 0xA1
+#define K_3 0xA2
+#define K_4 0xA3
+#define K_5 0xA4
+#define K_6 0xA5
+#define K_7 0xA6
+#define K_8 0xA7
+#define K_9 0xA8
+#define K_10 0xA9
+#define K_11 0xAA
+#define K_12 0xAB
+#define K_13 0xAC
+#define K_14 0xAD
+#define K_15 0xAE
+#define K_16 0xAF
+
+#define L_1 0xB0
+#define L_2 0xB1
+#define L_3 0xB2
+#define L_4 0xB3
+#define L_5 0xB4
+#define L_6 0xB5
+#define L_7 0xB6
+#define L_8 0xB7
+#define L_9 0xB8
+#define L_10 0xB9
+#define L_11 0xBA
+#define L_12 0xBB
+#define L_13 0xBC
+#define L_14 0xBD
+#define L_15 0xBE
+#define L_16 0xBF

drivers/led/snled27351.c

@@ -0,0 +1,235 @@
+/* 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 "snled27351.h"
+#include "i2c_master.h"
+
+#ifndef SNLED27351_I2C_TIMEOUT
+#    define SNLED27351_I2C_TIMEOUT 100
+#endif
+
+#ifndef SNLED27351_I2C_PERSISTENCE
+#    define SNLED27351_I2C_PERSISTENCE 0
+#endif
+
+#ifndef SNLED27351_PHASE_CHANNEL
+#    define SNLED27351_PHASE_CHANNEL SNLED27351_MSKPHASE_12CHANNEL
+#endif
+
+#ifndef SNLED27351_CURRENT_TUNE
+#    define SNLED27351_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[65];
+
+// These buffers match the SNLED27351 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 snled27351_write_pwm_buffer() but it's
+// probably not worth the extra complexity.
+uint8_t g_pwm_buffer[SNLED27351_DRIVER_COUNT][192];
+bool    g_pwm_buffer_update_required[SNLED27351_DRIVER_COUNT] = {false};
+
+uint8_t g_led_control_registers[SNLED27351_DRIVER_COUNT][24]             = {0};
+bool    g_led_control_registers_update_required[SNLED27351_DRIVER_COUNT] = {false};
+
+bool snled27351_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 SNLED27351_I2C_PERSISTENCE > 0
+    for (uint8_t i = 0; i < SNLED27351_I2C_PERSISTENCE; i++) {
+        if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, SNLED27351_I2C_TIMEOUT) != 0) {
+            return false;
+        }
+    }
+#else
+    if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, SNLED27351_I2C_TIMEOUT) != 0) {
+        return false;
+    }
+#endif
+    return true;
+}
+
+bool snled27351_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 3 transfers of 64 bytes.
+
+    // Iterate over the pwm_buffer contents at 64 byte intervals.
+    for (uint8_t i = 0; i < 192; i += 64) {
+        g_twi_transfer_buffer[0] = i;
+        // Copy the data from i to i+63.
+        // Device will auto-increment register for data after the first byte
+        // Thus this sets registers 0x00-0x0F, 0x10-0x1F, etc. in one transfer.
+        for (uint8_t j = 0; j < 64; j++) {
+            g_twi_transfer_buffer[1 + j] = pwm_buffer[i + j];
+        }
+
+#if SNLED27351_I2C_PERSISTENCE > 0
+        for (uint8_t i = 0; i < SNLED27351_I2C_PERSISTENCE; i++) {
+            if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 65, SNLED27351_I2C_TIMEOUT) != 0) {
+                return false;
+            }
+        }
+#else
+        if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 65, SNLED27351_I2C_TIMEOUT) != 0) {
+            return false;
+        }
+#endif
+    }
+    return true;
+}
+
+void snled27351_init(uint8_t addr) {
+    // Select to function page
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURE_CMD_PAGE, SNLED27351_FUNCTION_PAGE);
+    // Setting LED driver to shutdown mode
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURATION, SNLED27351_MSKSW_SHUT_DOWN_MODE);
+    // Setting internal channel pulldown/pullup
+    snled27351_write_register(addr, SNLED27351_REG_PDU, SNLED27351_MSKSET_CA_CB_CHANNEL);
+    // Select number of scan phase
+    snled27351_write_register(addr, SNLED27351_REG_SCAN_PHASE, SNLED27351_PHASE_CHANNEL);
+    // Setting PWM Delay Phase
+    snled27351_write_register(addr, SNLED27351_REG_SLEW_RATE_CONTROL_MODE1, SNLED27351_MSKPWM_DELAY_PHASE_ENABLE);
+    // Setting Driving/Sinking Channel Slew Rate
+    snled27351_write_register(addr, SNLED27351_REG_SLEW_RATE_CONTROL_MODE2, SNLED27351_MSKDRIVING_SINKING_CHANNEL_SLEWRATE_ENABLE);
+    // Setting Iref
+    snled27351_write_register(addr, SNLED27351_REG_SOFTWARE_SLEEP, SNLED27351_MSKSLEEP_DISABLE);
+    // Set LED CONTROL PAGE (Page 0)
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURE_CMD_PAGE, SNLED27351_LED_CONTROL_PAGE);
+    for (int i = 0; i < SNLED27351_LED_CONTROL_ON_OFF_LENGTH; i++) {
+        snled27351_write_register(addr, i, 0x00);
+    }
+
+    // Set PWM PAGE (Page 1)
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURE_CMD_PAGE, SNLED27351_LED_PWM_PAGE);
+    for (int i = 0; i < SNLED27351_LED_CURRENT_TUNE_LENGTH; i++) {
+        snled27351_write_register(addr, i, 0x00);
+    }
+
+    // Set CURRENT PAGE (Page 4)
+    uint8_t current_tune_reg_list[SNLED27351_LED_CURRENT_TUNE_LENGTH] = SNLED27351_CURRENT_TUNE;
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURE_CMD_PAGE, SNLED27351_CURRENT_TUNE_PAGE);
+    for (int i = 0; i < SNLED27351_LED_CURRENT_TUNE_LENGTH; i++) {
+        snled27351_write_register(addr, i, current_tune_reg_list[i]);
+    }
+
+    // Enable LEDs ON/OFF
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURE_CMD_PAGE, SNLED27351_LED_CONTROL_PAGE);
+    for (int i = 0; i < SNLED27351_LED_CONTROL_ON_OFF_LENGTH; i++) {
+        snled27351_write_register(addr, i, 0xFF);
+    }
+
+    // Select to function page
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURE_CMD_PAGE, SNLED27351_FUNCTION_PAGE);
+    // Setting LED driver to normal mode
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURATION, SNLED27351_MSKSW_NORMAL_MODE);
+}
+
+void snled27351_set_color(int index, uint8_t red, uint8_t green, uint8_t blue) {
+    snled27351_led_t led;
+    if (index >= 0 && index < RGB_MATRIX_LED_COUNT) {
+        memcpy_P(&led, (&g_snled27351_leds[index]), sizeof(led));
+
+        if (g_pwm_buffer[led.driver][led.r] == red && g_pwm_buffer[led.driver][led.g] == green && g_pwm_buffer[led.driver][led.b] == blue) {
+            return;
+        }
+        g_pwm_buffer[led.driver][led.r]          = red;
+        g_pwm_buffer[led.driver][led.g]          = green;
+        g_pwm_buffer[led.driver][led.b]          = blue;
+        g_pwm_buffer_update_required[led.driver] = true;
+    }
+}
+
+void snled27351_set_color_all(uint8_t red, uint8_t green, uint8_t blue) {
+    for (int i = 0; i < RGB_MATRIX_LED_COUNT; i++) {
+        snled27351_set_color(i, red, green, blue);
+    }
+}
+
+void snled27351_set_led_control_register(uint8_t index, bool red, bool green, bool blue) {
+    snled27351_led_t led;
+    memcpy_P(&led, (&g_snled27351_leds[index]), sizeof(led));
+
+    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;
+
+    if (red) {
+        g_led_control_registers[led.driver][control_register_r] |= (1 << bit_r);
+    } else {
+        g_led_control_registers[led.driver][control_register_r] &= ~(1 << bit_r);
+    }
+    if (green) {
+        g_led_control_registers[led.driver][control_register_g] |= (1 << bit_g);
+    } else {
+        g_led_control_registers[led.driver][control_register_g] &= ~(1 << bit_g);
+    }
+    if (blue) {
+        g_led_control_registers[led.driver][control_register_b] |= (1 << bit_b);
+    } else {
+        g_led_control_registers[led.driver][control_register_b] &= ~(1 << bit_b);
+    }
+
+    g_led_control_registers_update_required[led.driver] = true;
+}
+
+void snled27351_update_pwm_buffers(uint8_t addr, uint8_t index) {
+    if (g_pwm_buffer_update_required[index]) {
+        snled27351_write_register(addr, SNLED27351_REG_CONFIGURE_CMD_PAGE, SNLED27351_LED_PWM_PAGE);
+
+        // If any of the transactions fail we risk writing dirty PG0,
+        // refresh page 0 just in case.
+        if (!snled27351_write_pwm_buffer(addr, g_pwm_buffer[index])) {
+            g_led_control_registers_update_required[index] = true;
+        }
+    }
+    g_pwm_buffer_update_required[index] = false;
+}
+
+void snled27351_update_led_control_registers(uint8_t addr, uint8_t index) {
+    if (g_led_control_registers_update_required[index]) {
+        snled27351_write_register(addr, SNLED27351_REG_CONFIGURE_CMD_PAGE, SNLED27351_LED_CONTROL_PAGE);
+        for (int i = 0; i < 24; i++) {
+            snled27351_write_register(addr, i, g_led_control_registers[index][i]);
+        }
+    }
+    g_led_control_registers_update_required[index] = false;
+}
+
+void snled27351_sw_return_normal(uint8_t addr) {
+    // Select to function page
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURE_CMD_PAGE, SNLED27351_FUNCTION_PAGE);
+    // Setting LED driver to normal mode
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURATION, SNLED27351_MSKSW_NORMAL_MODE);
+}
+
+void snled27351_sw_shutdown(uint8_t addr) {
+    // Select to function page
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURE_CMD_PAGE, SNLED27351_FUNCTION_PAGE);
+    // Setting LED driver to shutdown mode
+    snled27351_write_register(addr, SNLED27351_REG_CONFIGURATION, SNLED27351_MSKSW_SHUT_DOWN_MODE);
+    // Write SW Sleep Register
+    snled27351_write_register(addr, SNLED27351_REG_SOFTWARE_SLEEP, SNLED27351_MSKSLEEP_ENABLE);
+}

drivers/led/snled27351.h

@@ -0,0 +1,378 @@
+/* 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/>.
+ */
+
+#pragma once
+
+#include <stdint.h>
+#include <stdbool.h>
+#include "progmem.h"
+
+// ======== DEPRECATED DEFINES - DO NOT USE ========
+#ifdef DRIVER_COUNT
+#    define SNLED27351_DRIVER_COUNT DRIVER_COUNT
+#endif
+#ifdef CKLED2001_TIMEOUT
+#    define SNLED27351_I2C_TIMEOUT CKLED2001_TIMEOUT
+#endif
+#ifdef CKLED2001_PERSISTENCE
+#    define SNLED27351_I2C_PERSISTENCE CKLED2001_PERSISTENCE
+#endif
+#ifdef PHASE_CHANNEL
+#    define SNLED27351_PHASE_CHANNEL PHASE_CHANNEL
+#endif
+#ifdef CKLED2001_CURRENT_TUNE
+#    define SNLED27351_CURRENT_TUNE CKLED2001_CURRENT_TUNE
+#endif
+
+#define MSKPHASE_12CHANNEL SNLED27351_MSKPHASE_12CHANNEL
+#define MSKPHASE_11CHANNEL SNLED27351_MSKPHASE_11CHANNEL
+#define MSKPHASE_10CHANNEL SNLED27351_MSKPHASE_10CHANNEL
+#define MSKPHASE_9CHANNEL SNLED27351_MSKPHASE_9CHANNEL
+#define MSKPHASE_8CHANNEL SNLED27351_MSKPHASE_8CHANNEL
+#define MSKPHASE_7CHANNEL SNLED27351_MSKPHASE_7CHANNEL
+#define MSKPHASE_6CHANNEL SNLED27351_MSKPHASE_6CHANNEL
+#define MSKPHASE_5CHANNEL SNLED27351_MSKPHASE_5CHANNEL
+#define MSKPHASE_4CHANNEL SNLED27351_MSKPHASE_4CHANNEL
+#define MSKPHASE_3CHANNEL SNLED27351_MSKPHASE_3CHANNEL
+#define MSKPHASE_2CHANNEL SNLED27351_MSKPHASE_2CHANNEL
+#define MSKPHASE_1CHANNEL SNLED27351_MSKPHASE_1CHANNEL
+
+#define ckled2001_led snled27351_led_t
+#define g_ckled2001_leds g_snled27351_leds
+// ========
+
+#define SNLED27351_I2C_ADDRESS_GND 0x74
+#define SNLED27351_I2C_ADDRESS_SCL 0x75
+#define SNLED27351_I2C_ADDRESS_SDA 0x76
+#define SNLED27351_I2C_ADDRESS_VDDIO 0x77
+
+typedef struct snled27351_led_t {
+    uint8_t driver : 2;
+    uint8_t r;
+    uint8_t g;
+    uint8_t b;
+} __attribute__((packed)) snled27351_led_t;
+
+extern const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT];
+
+void snled27351_init(uint8_t addr);
+bool snled27351_write_register(uint8_t addr, uint8_t reg, uint8_t data);
+bool snled27351_write_pwm_buffer(uint8_t addr, uint8_t *pwm_buffer);
+
+void snled27351_set_color(int index, uint8_t red, uint8_t green, uint8_t blue);
+void snled27351_set_color_all(uint8_t red, uint8_t green, uint8_t blue);
+
+void snled27351_set_led_control_register(uint8_t index, bool red, bool green, bool blue);
+
+// This should not be called from an interrupt
+// (eg. from a timer interrupt).
+// Call this while idle (in between matrix scans).
+// If the buffer is dirty, it will update the driver with the buffer.
+void snled27351_update_pwm_buffers(uint8_t addr, uint8_t index);
+void snled27351_update_led_control_registers(uint8_t addr, uint8_t index);
+
+void snled27351_sw_return_normal(uint8_t addr);
+void snled27351_sw_shutdown(uint8_t addr);
+
+// Registers Page Define
+#define SNLED27351_REG_CONFIGURE_CMD_PAGE 0xFD
+#define SNLED27351_LED_CONTROL_PAGE 0x00
+#define SNLED27351_LED_PWM_PAGE 0x01
+#define SNLED27351_FUNCTION_PAGE 0x03
+#define SNLED27351_CURRENT_TUNE_PAGE 0x04
+
+// Function Register: address 0x00
+#define SNLED27351_REG_CONFIGURATION 0x00
+#define SNLED27351_MSKSW_SHUT_DOWN_MODE (0x0 << 0)
+#define SNLED27351_MSKSW_NORMAL_MODE (0x1 << 0)
+
+#define SNLED27351_REG_DRIVER_ID 0x11
+#define SNLED27351_DRIVER_ID 0x8A
+
+#define SNLED27351_REG_PDU 0x13
+#define SNLED27351_MSKSET_CA_CB_CHANNEL 0xAA
+#define SNLED27351_MSKCLR_CA_CB_CHANNEL 0x00
+
+#define SNLED27351_REG_SCAN_PHASE 0x14
+#define SNLED27351_MSKPHASE_12CHANNEL 0x00
+#define SNLED27351_MSKPHASE_11CHANNEL 0x01
+#define SNLED27351_MSKPHASE_10CHANNEL 0x02
+#define SNLED27351_MSKPHASE_9CHANNEL 0x03
+#define SNLED27351_MSKPHASE_8CHANNEL 0x04
+#define SNLED27351_MSKPHASE_7CHANNEL 0x05
+#define SNLED27351_MSKPHASE_6CHANNEL 0x06
+#define SNLED27351_MSKPHASE_5CHANNEL 0x07
+#define SNLED27351_MSKPHASE_4CHANNEL 0x08
+#define SNLED27351_MSKPHASE_3CHANNEL 0x09
+#define SNLED27351_MSKPHASE_2CHANNEL 0x0A
+#define SNLED27351_MSKPHASE_1CHANNEL 0x0B
+
+#define SNLED27351_REG_SLEW_RATE_CONTROL_MODE1 0x15
+#define SNLED27351_MSKPWM_DELAY_PHASE_ENABLE 0x04
+#define SNLED27351_MSKPWM_DELAY_PHASE_DISABLE 0x00
+
+#define SNLED27351_REG_SLEW_RATE_CONTROL_MODE2 0x16
+#define SNLED27351_MSKDRIVING_SINKING_CHANNEL_SLEWRATE_ENABLE 0xC0
+#define SNLED27351_MSKDRIVING_SINKING_CHANNEL_SLEWRATE_DISABLE 0x00
+
+#define SNLED27351_REG_OPEN_SHORT_ENABLE 0x17
+#define SNLED27351_MSKOPEN_DETECTION_ENABLE (0x01 << 7)
+#define SNLED27351_MSKOPEN_DETECTION_DISABLE (0x00)
+
+#define SNLED27351_MSKSHORT_DETECTION_ENABLE (0x01 << 6)
+#define SNLED27351_MSKSHORT_DETECTION_DISABLE (0x00)
+
+#define SNLED27351_REG_OPEN_SHORT_DUTY 0x18
+#define SNLED27351_REG_OPEN_SHORT_FLAG 0x19
+
+#define SNLED27351_MSKOPEN_DETECTION_INTERRUPT_ENABLE (0x01 << 7)
+#define SNLED27351_MSKOPEN_DETECTION_INTERRUPT_DISABLE (0x00)
+
+#define SNLED27351_MSKSHORT_DETECTION_INTERRUPT_ENABLE (0x01 << 6)
+#define SNLED27351_MSKSHORT_DETECTION_INTERRUPT_DISABLE (0x00)
+
+#define SNLED27351_REG_SOFTWARE_SLEEP 0x1A
+#define SNLED27351_MSKSLEEP_ENABLE 0x02
+#define SNLED27351_MSKSLEEP_DISABLE 0x00
+
+// LED Control Registers
+#define SNLED27351_LED_CONTROL_ON_OFF_FIRST_ADDR 0x0
+#define SNLED27351_LED_CONTROL_ON_OFF_LAST_ADDR 0x17
+#define SNLED27351_LED_CONTROL_ON_OFF_LENGTH ((SNLED27351_LED_CONTROL_ON_OFF_LAST_ADDR - SNLED27351_LED_CONTROL_ON_OFF_FIRST_ADDR) + 1)
+
+#define SNLED27351_LED_CONTROL_OPEN_FIRST_ADDR 0x18
+#define SNLED27351_LED_CONTROL_OPEN_LAST_ADDR 0x2F
+#define SNLED27351_LED_CONTROL_OPEN_LENGTH ((SNLED27351_LED_CONTROL_OPEN_LAST_ADDR - SNLED27351_LED_CONTROL_OPEN_FIRST_ADDR) + 1)
+
+#define SNLED27351_LED_CONTROL_SHORT_FIRST_ADDR 0x30
+#define SNLED27351_LED_CONTROL_SHORT_LAST_ADDR 0x47
+#define SNLED27351_LED_CONTROL_SHORT_LENGTH ((SNLED27351_LED_CONTROL_SHORT_LAST_ADDR - SNLED27351_LED_CONTROL_SHORT_FIRST_ADDR) + 1)
+
+#define SNLED27351_LED_CONTROL_PAGE_LENGTH 0x48
+
+// LED Control Registers
+#define SNLED27351_LED_PWM_FIRST_ADDR 0x00
+#define SNLED27351_LED_PWM_LAST_ADDR 0xBF
+#define SNLED27351_LED_PWM_LENGTH 0xC0
+
+// Current Tune Registers
+#define SNLED27351_LED_CURRENT_TUNE_FIRST_ADDR 0x00
+#define SNLED27351_LED_CURRENT_TUNE_LAST_ADDR 0x0B
+#define SNLED27351_LED_CURRENT_TUNE_LENGTH 0x0C
+
+#define A_1 0x00
+#define A_2 0x01
+#define A_3 0x02
+#define A_4 0x03
+#define A_5 0x04
+#define A_6 0x05
+#define A_7 0x06
+#define A_8 0x07
+#define A_9 0x08
+#define A_10 0x09
+#define A_11 0x0A
+#define A_12 0x0B
+#define A_13 0x0C
+#define A_14 0x0D
+#define A_15 0x0E
+#define A_16 0x0F
+
+#define B_1 0x10
+#define B_2 0x11
+#define B_3 0x12
+#define B_4 0x13
+#define B_5 0x14
+#define B_6 0x15
+#define B_7 0x16
+#define B_8 0x17
+#define B_9 0x18
+#define B_10 0x19
+#define B_11 0x1A
+#define B_12 0x1B
+#define B_13 0x1C
+#define B_14 0x1D
+#define B_15 0x1E
+#define B_16 0x1F
+
+#define C_1 0x20
+#define C_2 0x21
+#define C_3 0x22
+#define C_4 0x23
+#define C_5 0x24
+#define C_6 0x25
+#define C_7 0x26
+#define C_8 0x27
+#define C_9 0x28
+#define C_10 0x29
+#define C_11 0x2A
+#define C_12 0x2B
+#define C_13 0x2C
+#define C_14 0x2D
+#define C_15 0x2E
+#define C_16 0x2F
+
+#define D_1 0x30
+#define D_2 0x31
+#define D_3 0x32
+#define D_4 0x33
+#define D_5 0x34
+#define D_6 0x35
+#define D_7 0x36
+#define D_8 0x37
+#define D_9 0x38
+#define D_10 0x39
+#define D_11 0x3A
+#define D_12 0x3B
+#define D_13 0x3C
+#define D_14 0x3D
+#define D_15 0x3E
+#define D_16 0x3F
+
+#define E_1 0x40
+#define E_2 0x41
+#define E_3 0x42
+#define E_4 0x43
+#define E_5 0x44
+#define E_6 0x45
+#define E_7 0x46
+#define E_8 0x47
+#define E_9 0x48
+#define E_10 0x49
+#define E_11 0x4A
+#define E_12 0x4B
+#define E_13 0x4C
+#define E_14 0x4D
+#define E_15 0x4E
+#define E_16 0x4F
+
+#define F_1 0x50
+#define F_2 0x51
+#define F_3 0x52
+#define F_4 0x53
+#define F_5 0x54
+#define F_6 0x55
+#define F_7 0x56
+#define F_8 0x57
+#define F_9 0x58
+#define F_10 0x59
+#define F_11 0x5A
+#define F_12 0x5B
+#define F_13 0x5C
+#define F_14 0x5D
+#define F_15 0x5E
+#define F_16 0x5F
+
+#define G_1 0x60
+#define G_2 0x61
+#define G_3 0x62
+#define G_4 0x63
+#define G_5 0x64
+#define G_6 0x65
+#define G_7 0x66
+#define G_8 0x67
+#define G_9 0x68
+#define G_10 0x69
+#define G_11 0x6A
+#define G_12 0x6B
+#define G_13 0x6C
+#define G_14 0x6D
+#define G_15 0x6E
+#define G_16 0x6F
+
+#define H_1 0x70
+#define H_2 0x71
+#define H_3 0x72
+#define H_4 0x73
+#define H_5 0x74
+#define H_6 0x75
+#define H_7 0x76
+#define H_8 0x77
+#define H_9 0x78
+#define H_10 0x79
+#define H_11 0x7A
+#define H_12 0x7B
+#define H_13 0x7C
+#define H_14 0x7D
+#define H_15 0x7E
+#define H_16 0x7F
+
+#define I_1 0x80
+#define I_2 0x81
+#define I_3 0x82
+#define I_4 0x83
+#define I_5 0x84
+#define I_6 0x85
+#define I_7 0x86
+#define I_8 0x87
+#define I_9 0x88
+#define I_10 0x89
+#define I_11 0x8A
+#define I_12 0x8B
+#define I_13 0x8C
+#define I_14 0x8D
+#define I_15 0x8E
+#define I_16 0x8F
+
+#define J_1 0x90
+#define J_2 0x91
+#define J_3 0x92
+#define J_4 0x93
+#define J_5 0x94
+#define J_6 0x95
+#define J_7 0x96
+#define J_8 0x97
+#define J_9 0x98
+#define J_10 0x99
+#define J_11 0x9A
+#define J_12 0x9B
+#define J_13 0x9C
+#define J_14 0x9D
+#define J_15 0x9E
+#define J_16 0x9F
+
+#define K_1 0xA0
+#define K_2 0xA1
+#define K_3 0xA2
+#define K_4 0xA3
+#define K_5 0xA4
+#define K_6 0xA5
+#define K_7 0xA6
+#define K_8 0xA7
+#define K_9 0xA8
+#define K_10 0xA9
+#define K_11 0xAA
+#define K_12 0xAB
+#define K_13 0xAC
+#define K_14 0xAD
+#define K_15 0xAE
+#define K_16 0xAF
+
+#define L_1 0xB0
+#define L_2 0xB1
+#define L_3 0xB2
+#define L_4 0xB3
+#define L_5 0xB4
+#define L_6 0xB5
+#define L_7 0xB6
+#define L_8 0xB7
+#define L_9 0xB8
+#define L_10 0xB9
+#define L_11 0xBA
+#define L_12 0xBB
+#define L_13 0xBC
+#define L_14 0xBD
+#define L_15 0xBE
+#define L_16 0xBF

keyboards/akko/5108/5108.c

@@ -17,8 +17,8 @@
 #include "quantum.h"
 // clang-format off
 #ifdef RGB_MATRIX_ENABLE
-const is31_led PROGMEM g_is31_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/akko/5108/config.h

@@ -34,9 +34,9 @@
 #define EXTERNAL_FLASH_SPI_SLAVE_SELECT_PIN C12
 
 /* I2C Config for LED Driver */
-#define IS31FL3733_DRIVER_COUNT 2
-#define DRIVER_ADDR_1 0b1110100
-#define DRIVER_ADDR_2 0b1110111
+#define SNLED27351_DRIVER_COUNT 2
+#define DRIVER_ADDR_1 SNLED27351_I2C_ADDRESS_GND
+#define DRIVER_ADDR_2 SNLED27351_I2C_ADDRESS_VDDIO
 #define I2C1_SCL_PAL_MODE 4
 #define I2C1_OPMODE OPMODE_I2C
 #define I2C1_CLOCK_SPEED 400000 /* 400000 */

keyboards/akko/5108/info.json

@@ -41,7 +41,7 @@
         "caps_lock": "C10"
     },
     "rgb_matrix": {
-        "driver": "is31fl3733",
+        "driver": "snled27351",
         "max_brightness": 180,
         "animations": {
             "breathing": true,

keyboards/akko/acr87/acr87.c

@@ -17,8 +17,8 @@
 #include "quantum.h"
 // clang-format off
 #ifdef RGB_MATRIX_ENABLE
-const is31_led PROGMEM g_is31_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/akko/acr87/config.h

@@ -31,10 +31,10 @@
 #define EXTERNAL_FLASH_SPI_SLAVE_SELECT_PIN C12
 
 /* I2C Config for LED Driver */
-#define IS31FL3733_DRIVER_COUNT 3
-#define DRIVER_ADDR_1 0b1110100
-#define DRIVER_ADDR_2 0b1110111
-#define DRIVER_ADDR_3 0b1110110
+#define SNLED27351_DRIVER_COUNT 3
+#define DRIVER_ADDR_1 SNLED27351_I2C_ADDRESS_GND
+#define DRIVER_ADDR_2 SNLED27351_I2C_ADDRESS_VDDIO
+#define DRIVER_ADDR_3 SNLED27351_I2C_ADDRESS_SDA
 
 #define I2C1_SCL_PAL_MODE 4
 #define I2C1_OPMODE OPMODE_I2C

keyboards/akko/acr87/info.json

@@ -37,7 +37,7 @@
         }
     },
     "rgb_matrix": {
-        "driver": "is31fl3733",
+        "driver": "snled27351",
         "max_brightness": 180,
         "animations": {
             "breathing": true,

keyboards/akko/top40/config.h

@@ -31,9 +31,9 @@
 #define EXTERNAL_FLASH_SPI_SLAVE_SELECT_PIN C12
 
 /* I2C Config for LED Driver */
-#define IS31FL3733_DRIVER_COUNT 2
-#define DRIVER_ADDR_1 0b1110100
-#define DRIVER_ADDR_2 0b1110111
+#define SNLED27351_DRIVER_COUNT 2
+#define DRIVER_ADDR_1 SNLED27351_I2C_ADDRESS_GND
+#define DRIVER_ADDR_2 SNLED27351_I2C_ADDRESS_VDDIO
 #define I2C1_SCL_PAL_MODE 4
 #define I2C1_OPMODE OPMODE_I2C
 #define I2C1_CLOCK_SPEED 400000 /* 400000 */

keyboards/akko/top40/info.json

@@ -37,7 +37,7 @@
         }
     },
     "rgb_matrix": {
-        "driver": "is31fl3733",
+        "driver": "snled27351",
         "max_brightness": 180,
         "animations": {
             "breathing": true,

keyboards/akko/top40/top40.c

@@ -17,8 +17,8 @@
 #include "quantum.h"
 // clang-format off
 #ifdef RGB_MATRIX_ENABLE
-const is31_led PROGMEM g_is31_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/chosfox/cf81/cf81.c

@@ -18,8 +18,8 @@
 
 // clang-format off
 #ifdef RGB_MATRIX_ENABLE
-const is31_led PROGMEM g_is31_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/chosfox/cf81/config.h

@@ -31,9 +31,9 @@
 #define EXTERNAL_FLASH_SPI_SLAVE_SELECT_PIN C12
 
 /* I2C Config for LED Driver */
-#define IS31FL3733_DRIVER_COUNT 2
-#define DRIVER_ADDR_1 0b1110100
-#define DRIVER_ADDR_2 0b1110111
+#define SNLED27351_DRIVER_COUNT 2
+#define DRIVER_ADDR_1 SNLED27351_I2C_ADDRESS_GND
+#define DRIVER_ADDR_2 SNLED27351_I2C_ADDRESS_VDDIO
 #define I2C1_OPMODE OPMODE_I2C
 #define I2C1_CLOCK_SPEED 400000 /* 400000 */
 

keyboards/chosfox/cf81/info.json

@@ -39,7 +39,7 @@
         ]
     },
     "rgb_matrix": {
-        "driver": "is31fl3733",
+        "driver": "snled27351",
         "animations": {
             "breathing": true,
             "cycle_all": true,

keyboards/inland/kb83/config.h

@@ -38,9 +38,9 @@
 #define EXTERNAL_FLASH_SPI_SLAVE_SELECT_PIN C12
 
 /* I2C Config for LED Driver */
-#define IS31FL3733_DRIVER_COUNT 2
-#define DRIVER_ADDR_1 0b1110100
-#define DRIVER_ADDR_2 0b1110111
+#define SNLED27351_DRIVER_COUNT 2
+#define DRIVER_ADDR_1 SNLED27351_I2C_ADDRESS_GND
+#define DRIVER_ADDR_2 SNLED27351_I2C_ADDRESS_VDDIO
 #define I2C1_SDA_PIN B7
 #define I2C1_SCL_PIN B6
 #define I2C1_SCL_PAL_MODE 4

keyboards/inland/kb83/info.json

@@ -9,7 +9,7 @@
         "force_nkro": true
     },
     "rgb_matrix": {
-        "driver": "is31fl3733"
+        "driver": "snled27351"
     },
     "processor": "WB32FQ95",
     "bootloader": "wb32-dfu",

keyboards/inland/kb83/kb83.c

@@ -18,8 +18,8 @@
 
 // clang-format off
 #ifdef RGB_MATRIX_ENABLE
-const is31_led PROGMEM g_is31_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/inland/mk47/config.h

@@ -25,8 +25,9 @@
 #define EXTERNAL_FLASH_SPI_SLAVE_SELECT_PIN C12
 
 /* I2C Config for LED Driver */
-#define IS31FL3733_DRIVER_COUNT 1
-#define DRIVER_ADDR_1 0b1110100
+#define SNLED27351_DRIVER_COUNT 1
+#define DRIVER_ADDR_1 SNLED27351_I2C_ADDRESS_GND
+
 /* WB32 MCU has no default definition */
 #define I2C1_OPMODE OPMODE_I2C
 #define I2C1_CLOCK_SPEED 400000

keyboards/inland/mk47/info.json

@@ -34,7 +34,7 @@
         }
     },
     "rgb_matrix": {
-        "driver": "is31fl3733",
+        "driver": "snled27351",
         "max_brightness": 200,
         "animations": {
             "breathing": true,

keyboards/inland/mk47/mk47.c

@@ -16,8 +16,8 @@
 
 #include "quantum.h"
 #ifdef RGB_MATRIX_ENABLE
-const is31_led PROGMEM g_is31_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/c1_pro/ansi/rgb/config.h

@@ -20,18 +20,18 @@
 // #define MATRIX_UNSELECT_DRIVE_HIGH
 
 /* RGB Matrix Driver Configuration */
-#define CKLED2001_DRIVER_COUNT 2
-#define DRIVER_ADDR_1 CKLED2001_I2C_ADDRESS_VDDIO
-#define DRIVER_ADDR_2 CKLED2001_I2C_ADDRESS_GND
+#define SNLED27351_DRIVER_COUNT 2
+#define DRIVER_ADDR_1 SNLED27351_I2C_ADDRESS_VDDIO
+#define DRIVER_ADDR_2 SNLED27351_I2C_ADDRESS_GND
 
 /* RGB Matrix Configuration */
 #define DRIVER_1_LED_TOTAL 49
 #define DRIVER_2_LED_TOTAL 39
 #define RGB_MATRIX_LED_COUNT (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)
 
-#define CKLED2001_PHASE_CHANNEL CKLED2001_MSKPHASE_9CHANNEL
+#define SNLED27351_PHASE_CHANNEL SNLED27351_MSKPHASE_9CHANNEL
 /* Set led driver current */
-#define CKLED2001_CURRENT_TUNE \
+#define SNLED27351_CURRENT_TUNE \
     { 0x9D, 0x9D, 0x44, 0x9D, 0x9D, 0x44, 0x9D, 0x9D, 0x44, 0x9D, 0x9D, 0x44 }
 
 /* turn off effects when suspended */

keyboards/keychron/c1_pro/ansi/rgb/info.json

@@ -105,7 +105,7 @@
         }
     },
     "rgb_matrix": {
-        "driver": "ckled2001",
+        "driver": "snled27351",
         "animations": {
             "breathing": true,
             "band_spiral_val": true,

keyboards/keychron/c1_pro/ansi/rgb/rgb.c

@@ -18,8 +18,8 @@
 
 // clang-format off
 #ifdef RGB_MATRIX_ENABLE
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to CKLED2001 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/c1_pro/ansi/white/config.h

@@ -20,15 +20,15 @@
 // #define MATRIX_UNSELECT_DRIVE_HIGH
 
 /* LED Matrix Driver Configuration */
-#define CKLED2001_DRIVER_COUNT 1
-#define DRIVER_ADDR_1 CKLED2001_I2C_ADDRESS_GND
+#define SNLED27351_DRIVER_COUNT 1
+#define DRIVER_ADDR_1 SNLED27351_I2C_ADDRESS_GND
 
 /* LED Matrix Configuration */
 #define LED_MATRIX_LED_COUNT 90
 
-#define CKLED2001_PHASE_CHANNEL CKLED2001_MSKPHASE_9CHANNEL
+#define SNLED27351_PHASE_CHANNEL SNLED27351_MSKPHASE_9CHANNEL
 /* Set led driver current */
-#define CKLED2001_CURRENT_TUNE \
+#define SNLED27351_CURRENT_TUNE \
     { 0x9D, 0x9D, 0x44, 0x9D, 0x9D, 0x44, 0x9D, 0x9D, 0x44, 0x9D, 0x9D, 0x44 }
 
 /* turn off effects when suspended */

keyboards/keychron/c1_pro/ansi/white/info.json

@@ -105,7 +105,7 @@
         }
     },
     "led_matrix": {
-        "driver": "ckled2001",
+        "driver": "snled27351",
         "animations": {
             "none": true,
             "solid": true,

keyboards/keychron/c1_pro/ansi/white/white.c

@@ -18,8 +18,8 @@
 
 // clang-format off
 #ifdef LED_MATRIX_ENABLE
-const ckled2001_led PROGMEM g_ckled2001_leds[LED_MATRIX_LED_COUNT] = {
-/* Refer to CKLED2001 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[LED_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  LED address
  *   |  |   */

keyboards/keychron/c2_pro/ansi/rgb/config.h

@@ -17,12 +17,12 @@
 #pragma once
 
 /* RGB Matrix Driver Configuration */
-#define CKLED2001_DRIVER_COUNT 2
-#define DRIVER_ADDR_1 CKLED2001_I2C_ADDRESS_VDDIO
-#define DRIVER_ADDR_2 CKLED2001_I2C_ADDRESS_GND
+#define SNLED27351_DRIVER_COUNT 2
+#define DRIVER_ADDR_1 SNLED27351_I2C_ADDRESS_VDDIO
+#define DRIVER_ADDR_2 SNLED27351_I2C_ADDRESS_GND
 
 /* Set LED driver current */
-#define CKLED2001_CURRENT_TUNE \
+#define SNLED27351_CURRENT_TUNE \
     { 0xAA, 0xAA, 0x56, 0xAA, 0xAA, 0x56, 0xAA, 0xAA, 0x56, 0xAA, 0xAA, 0x56 }
 
 /* RGB Matrix Configuration */

keyboards/keychron/c2_pro/ansi/rgb/info.json

@@ -122,7 +122,7 @@
         }
     },
     "rgb_matrix": {
-        "driver": "ckled2001",
+        "driver": "snled27351",
         "animations": {
             "breathing": true,
             "band_spiral_val": true,

keyboards/keychron/c2_pro/ansi/rgb/rgb.c

@@ -17,8 +17,8 @@
 #include "quantum.h"
 
 #ifdef RGB_MATRIX_ENABLE
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to CKLED2001 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/c2_pro/ansi/white/config.h

@@ -17,11 +17,11 @@
 #pragma once
 
 /* LED Matrix Driver Configuration */
-#define CKLED2001_DRIVER_COUNT 1
-#define DRIVER_ADDR_1 CKLED2001_I2C_ADDRESS_GND
+#define SNLED27351_DRIVER_COUNT 1
+#define DRIVER_ADDR_1 SNLED27351_I2C_ADDRESS_GND
 
 /* Set LED driver current */
-#define CKLED2001_CURRENT_TUNE \
+#define SNLED27351_CURRENT_TUNE \
     { 0xA0, 0xA0, 0xA0, 0xA0, 0xA0, 0xA0, 0xA0, 0xA0, 0xA0, 0xA0, 0xA0, 0xA0 }
 
 /* LED Matrix Configuration */

keyboards/keychron/c2_pro/ansi/white/info.json

@@ -122,7 +122,7 @@
         }
     },
     "led_matrix": {
-        "driver": "ckled2001",
+        "driver": "snled27351",
         "animations": {
             "none": true,
             "solid": true,

keyboards/keychron/c2_pro/ansi/white/white.c

@@ -18,8 +18,8 @@
 
 // clang-format off
 #ifdef LED_MATRIX_ENABLE
-const ckled2001_led PROGMEM g_ckled2001_leds[LED_MATRIX_LED_COUNT] = {
-/* Refer to CKLED2001 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[LED_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  LED address
  *   |  |   */

keyboards/keychron/q0/config.h

@@ -16,7 +16,7 @@
 
 #pragma once
 
-#define CKLED2001_CURRENT_TUNE { 0xFF, 0xFF, 0x70, 0xFF, 0xFF, 0x70, 0xFF, 0xFF, 0x70, 0xFF, 0xFF, 0x70 }
+#define SNLED27351_CURRENT_TUNE { 0xFF, 0xFF, 0x70, 0xFF, 0xFF, 0x70, 0xFF, 0xFF, 0x70, 0xFF, 0xFF, 0x70 }
 
 /* turn off effects when suspended */
 #define RGB_DISABLE_WHEN_USB_SUSPENDED

keyboards/keychron/q0/rev_0130/config.h

@@ -17,8 +17,8 @@
 #pragma once
 
 /* RGB Matrix Driver Configuration */
-#define CKLED2001_DRIVER_COUNT 1
-#define DRIVER_ADDR_1 CKLED2001_I2C_ADDRESS_GND
+#define SNLED27351_DRIVER_COUNT 1
+#define DRIVER_ADDR_1 SNLED27351_I2C_ADDRESS_GND
 
 /* RGB Matrix Configuration */
 #define DRIVER_1_LED_TOTAL 21

keyboards/keychron/q0/rev_0130/info.json

@@ -29,7 +29,7 @@
     "processor": "STM32L432",
     "bootloader": "stm32-dfu",
     "rgb_matrix": {
-        "driver": "ckled2001",
+        "driver": "snled27351",
         "animations": {
             "band_spiral_val": true,
             "breathing": true,

keyboards/keychron/q0/rev_0130/rev_0130.c

@@ -20,8 +20,8 @@
 
 // clang-format off
 
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to CKLED manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q0/rev_0131/config.h

@@ -17,14 +17,14 @@
 #pragma once
 
 /* RGB Matrix Driver Configuration */
-#define CKLED2001_DRIVER_COUNT 1
-#define DRIVER_ADDR_1 CKLED2001_I2C_ADDRESS_VDDIO
+#define SNLED27351_DRIVER_COUNT 1
+#define DRIVER_ADDR_1 SNLED27351_I2C_ADDRESS_VDDIO
 
 /* RGB Matrix Configuration */
 #define DRIVER_1_LED_TOTAL 26
 #define RGB_MATRIX_LED_COUNT DRIVER_1_LED_TOTAL
 
-#define CKLED2001_PHASE_CHANNEL CKLED2001_MSKPHASE_9CHANNEL
+#define SNLED27351_PHASE_CHANNEL SNLED27351_MSKPHASE_9CHANNEL
 
 /* Enable num-lock LED */
 #define NUM_LOCK_LED_INDEX 5

keyboards/keychron/q0/rev_0131/info.json

@@ -38,7 +38,7 @@
     "processor": "STM32L432",
     "bootloader": "stm32-dfu",
     "rgb_matrix": {
-        "driver": "ckled2001",
+        "driver": "snled27351",
         "animations": {
             "band_spiral_val": true,
             "breathing": true,

keyboards/keychron/q0/rev_0131/rev_0131.c

@@ -20,8 +20,8 @@
 
 // clang-format off
 
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to CKLED manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q10/ansi_encoder/ansi_encoder.c

@@ -20,8 +20,8 @@
 
 // clang-format off
 
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q10/ansi_encoder/info.json

@@ -9,7 +9,7 @@
         "device_version": "1.0.0"
     },
     "rgb_matrix": {
-        "driver": "ckled2001"
+        "driver": "snled27351"
     },
     "encoder": {
         "rotary": [

keyboards/keychron/q10/config.h

@@ -30,9 +30,9 @@
 #define DIODE_DIRECTION ROW2COL
 
 /* RGB Matrix Driver Configuration */
-#define CKLED2001_DRIVER_COUNT 2
-#define DRIVER_ADDR_1 CKLED2001_I2C_ADDRESS_VDDIO
-#define DRIVER_ADDR_2 CKLED2001_I2C_ADDRESS_GND
+#define SNLED27351_DRIVER_COUNT 2
+#define DRIVER_ADDR_1 SNLED27351_I2C_ADDRESS_VDDIO
+#define DRIVER_ADDR_2 SNLED27351_I2C_ADDRESS_GND
 
 /* Increase I2C speed to 1000 KHz */
 #define I2C1_TIMINGR_PRESC 0U
@@ -41,8 +41,8 @@
 #define I2C1_TIMINGR_SCLH 15U
 #define I2C1_TIMINGR_SCLL 51U
 
-#define CKLED2001_PHASE_CHANNEL CKLED2001_MSKPHASE_9CHANNEL
-#define CKLED2001_CURRENT_TUNE \
+#define SNLED27351_PHASE_CHANNEL SNLED27351_MSKPHASE_9CHANNEL
+#define SNLED27351_CURRENT_TUNE \
     { 0x98, 0x98, 0x4A, 0x98, 0x98, 0x4A, 0x98, 0x98, 0x4A, 0x98, 0x98, 0x4A }
 
 /* DIP switch */

keyboards/keychron/q10/iso_encoder/info.json

@@ -9,7 +9,7 @@
         "device_version": "1.0.0"
     },
     "rgb_matrix": {
-        "driver": "ckled2001"
+        "driver": "snled27351"
     },
     "encoder": {
         "rotary": [

keyboards/keychron/q10/iso_encoder/iso_encoder.c

@@ -20,8 +20,8 @@
 
 // clang-format off
 
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q11/ansi_encoder/ansi_encoder.c

@@ -17,8 +17,8 @@
 #include "quantum.h"
 
 #ifdef RGB_MATRIX_ENABLE
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q11/config.h

@@ -27,8 +27,8 @@
 #define MATRIX_MASKED // actual mask is defined by `matrix_mask` in `q11.c`
 
 /* RGB Matrix Driver Configuration */
-#define CKLED2001_DRIVER_COUNT 1
-#define DRIVER_ADDR_1 CKLED2001_I2C_ADDRESS_GND
+#define SNLED27351_DRIVER_COUNT 1
+#define DRIVER_ADDR_1 SNLED27351_I2C_ADDRESS_GND
 
 /* Increase I2C speed to 1000 KHz */
 #define I2C1_TIMINGR_PRESC 0U
@@ -37,7 +37,7 @@
 #define I2C1_TIMINGR_SCLH 15U
 #define I2C1_TIMINGR_SCLL 51U
 
-#define CKLED2001_CURRENT_TUNE \
+#define SNLED27351_CURRENT_TUNE \
     { 0x80, 0xFF, 0xFF, 0x80, 0xFF, 0xFF, 0x80, 0xFF, 0xFF, 0x80, 0xFF, 0xFF } // 300mA
 
 /* EEPROM Driver Configuration */

keyboards/keychron/q11/info.json

@@ -59,7 +59,7 @@
         ]
     },
     "rgb_matrix": {
-        "driver": "ckled2001",
+        "driver": "snled27351",
         "animations": {
             "breathing": true,
             "band_spiral_val": true,

keyboards/keychron/q11/iso_encoder/iso_encoder.c

@@ -17,8 +17,8 @@
 #include "quantum.h"
 
 #ifdef RGB_MATRIX_ENABLE
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to CKLED2001 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |     G location

keyboards/keychron/q12/ansi_encoder/ansi_encoder.c

@@ -17,8 +17,8 @@
 #include "quantum.h"
 
 #ifdef RGB_MATRIX_ENABLE
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q12/ansi_encoder/info.json

@@ -9,7 +9,7 @@
         "device_version": "1.0.0"
     },
     "rgb_matrix": {
-        "driver": "ckled2001"
+        "driver": "snled27351"
     },
     "encoder": {
         "rotary": [

keyboards/keychron/q12/config.h

@@ -26,9 +26,9 @@
 #define DIODE_DIRECTION ROW2COL
 
 /* RGB Matrix Driver Configuration */
-#define CKLED2001_DRIVER_COUNT 2
-#define DRIVER_ADDR_1 CKLED2001_I2C_ADDRESS_VDDIO
-#define DRIVER_ADDR_2 CKLED2001_I2C_ADDRESS_GND
+#define SNLED27351_DRIVER_COUNT 2
+#define DRIVER_ADDR_1 SNLED27351_I2C_ADDRESS_VDDIO
+#define DRIVER_ADDR_2 SNLED27351_I2C_ADDRESS_GND
 
 /* Increase I2C speed to 1000 KHz */
 #define I2C1_TIMINGR_PRESC 0U
@@ -37,7 +37,7 @@
 #define I2C1_TIMINGR_SCLH 15U
 #define I2C1_TIMINGR_SCLL 51U
 
-#define CKLED2001_CURRENT_TUNE \
+#define SNLED27351_CURRENT_TUNE \
     { 0xAD, 0xAD, 0x55, 0xAD, 0xAD, 0x55, 0xAD, 0xAD, 0x55, 0xAD, 0xAD, 0x55 }
 
 /* DIP switch */

keyboards/keychron/q12/iso_encoder/info.json

@@ -9,7 +9,7 @@
         "device_version": "1.0.0"
     },
     "rgb_matrix": {
-        "driver": "ckled2001"
+        "driver": "snled27351"
     },
     "encoder": {
         "rotary": [

keyboards/keychron/q12/iso_encoder/iso_encoder.c

@@ -18,8 +18,8 @@
 
 #ifdef RGB_MATRIX_ENABLE
 
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q2/ansi/ansi.c

@@ -17,8 +17,8 @@
 #include "quantum.h"
 
 #ifdef RGB_MATRIX_ENABLE
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to CKLED manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q2/ansi_encoder/ansi_encoder.c

@@ -17,8 +17,8 @@
 #include "quantum.h"
 
 #ifdef RGB_MATRIX_ENABLE
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to CKLED manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q2/config.h

@@ -22,11 +22,11 @@
 #define DIP_SWITCH_MATRIX_GRID  { {4, 4} }
 
 /* RGB Matrix Driver Configuration */
-#define CKLED2001_DRIVER_COUNT 2
-#define DRIVER_ADDR_1 CKLED2001_I2C_ADDRESS_VDDIO
-#define DRIVER_ADDR_2 CKLED2001_I2C_ADDRESS_GND
+#define SNLED27351_DRIVER_COUNT 2
+#define DRIVER_ADDR_1 SNLED27351_I2C_ADDRESS_VDDIO
+#define DRIVER_ADDR_2 SNLED27351_I2C_ADDRESS_GND
 
-#define CKLED2001_PHASE_CHANNEL CKLED2001_MSKPHASE_9CHANNEL
+#define SNLED27351_PHASE_CHANNEL SNLED27351_MSKPHASE_9CHANNEL
 
 /* Disable DIP switch in matrix data */
 #define MATRIX_MASKED

keyboards/keychron/q2/info.json

@@ -51,7 +51,7 @@
             "splash": true,
             "typing_heatmap": true
         },
-        "driver": "ckled2001"
+        "driver": "snled27351"
     },
     "url": "https://github.com/Keychron",
     "usb": {

keyboards/keychron/q2/iso/iso.c

@@ -17,8 +17,8 @@
 #include "quantum.h"
 
 #ifdef RGB_MATRIX_ENABLE
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q2/iso_encoder/iso_encoder.c

@@ -17,8 +17,8 @@
 #include "quantum.h"
 
 #ifdef RGB_MATRIX_ENABLE
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q2/jis/config.h

@@ -19,7 +19,7 @@
 /* RGB Matrix Configuration */
 #define RGB_MATRIX_LED_COUNT 71
 
-#define CKLED2001_CURRENT_TUNE { 0xC0, 0xC0, 0x5D, 0xC0, 0xC0, 0x5D, 0xC0, 0xC0, 0x5D, 0xC0, 0xC0, 0x5D }
+#define SNLED27351_CURRENT_TUNE { 0xC0, 0xC0, 0x5D, 0xC0, 0xC0, 0x5D, 0xC0, 0xC0, 0x5D, 0xC0, 0xC0, 0x5D }
 
 /* Enable caps-lock LED */
 #define CAPS_LOCK_LED_INDEX 30

keyboards/keychron/q2/jis/jis.c

@@ -18,8 +18,8 @@
 
 #ifdef RGB_MATRIX_ENABLE
 
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q2/jis_encoder/config.h

@@ -19,7 +19,7 @@
 /* RGB Matrix Configuration */
 #define RGB_MATRIX_LED_COUNT 71
 
-#define CKLED2001_CURRENT_TUNE { 0xC0, 0xC0, 0x5D, 0xC0, 0xC0, 0x5D, 0xC0, 0xC0, 0x5D, 0xC0, 0xC0, 0x5D }
+#define SNLED27351_CURRENT_TUNE { 0xC0, 0xC0, 0x5D, 0xC0, 0xC0, 0x5D, 0xC0, 0xC0, 0x5D, 0xC0, 0xC0, 0x5D }
 
 /* Enable caps-lock LED */
 #define CAPS_LOCK_LED_INDEX 30

keyboards/keychron/q2/jis_encoder/jis_encoder.c

@@ -18,8 +18,8 @@
 
 #ifdef RGB_MATRIX_ENABLE
 
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q3/ansi/ansi.c

@@ -18,8 +18,8 @@
 
 #ifdef RGB_MATRIX_ENABLE
 
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q3/ansi/config.h

@@ -22,7 +22,7 @@
 /* RGB Matrix Configuration */
 #define RGB_MATRIX_LED_COUNT 87
 
-#define CKLED2001_CURRENT_TUNE \
+#define SNLED27351_CURRENT_TUNE \
     { 0x9D, 0x9D, 0x44, 0x9D, 0x9D, 0x44, 0x9D, 0x9D, 0x44, 0x9D, 0x9D, 0x44 }
 
 /* Enable CapsLcok LED */

keyboards/keychron/q3/ansi_encoder/ansi_encoder.c

@@ -18,8 +18,8 @@
 
 #ifdef RGB_MATRIX_ENABLE
 
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q3/ansi_encoder/config.h

@@ -23,7 +23,7 @@
 /* RGB Matrix Configuration */
 #define RGB_MATRIX_LED_COUNT 87
 
-#define CKLED2001_CURRENT_TUNE \
+#define SNLED27351_CURRENT_TUNE \
     { 0x9D, 0x9D, 0x44, 0x9D, 0x9D, 0x44, 0x9D, 0x9D, 0x44, 0x9D, 0x9D, 0x44 }
 
 /* Enable CapsLcok LED */

keyboards/keychron/q3/config.h

@@ -17,9 +17,9 @@
 #pragma once
 
 /* RGB Matrix Driver Configuration */
-#define CKLED2001_DRIVER_COUNT 2
-#define DRIVER_ADDR_1 CKLED2001_I2C_ADDRESS_VDDIO
-#define DRIVER_ADDR_2 CKLED2001_I2C_ADDRESS_GND
+#define SNLED27351_DRIVER_COUNT 2
+#define DRIVER_ADDR_1 SNLED27351_I2C_ADDRESS_VDDIO
+#define DRIVER_ADDR_2 SNLED27351_I2C_ADDRESS_GND
 
 /* Increase I2C speed to 1000 KHz */
 #define I2C1_TIMINGR_PRESC 0U
@@ -28,7 +28,7 @@
 #define I2C1_TIMINGR_SCLH 15U
 #define I2C1_TIMINGR_SCLL 51U
 
-#define CKLED2001_PHASE_CHANNEL CKLED2001_MSKPHASE_9CHANNEL
+#define SNLED27351_PHASE_CHANNEL SNLED27351_MSKPHASE_9CHANNEL
 
 /* DIP switch */
 #define DIP_SWITCH_MATRIX_GRID  { {5, 4} }

keyboards/keychron/q3/info.json

@@ -43,7 +43,7 @@
             "splash": true,
             "typing_heatmap": true
         },
-        "driver": "ckled2001"
+        "driver": "snled27351"
     },
     "url": "https://github.com/Keychron",
     "usb": {

keyboards/keychron/q3/iso/config.h

@@ -22,7 +22,7 @@
 /* RGB Matrix Configuration */
 #define RGB_MATRIX_LED_COUNT 88
 
-#define CKLED2001_CURRENT_TUNE \
+#define SNLED27351_CURRENT_TUNE \
     { 0x9D, 0x9D, 0x44, 0x9D, 0x9D, 0x44, 0x9D, 0x9D, 0x44, 0x9D, 0x9D, 0x44 }
 
 /* Enable caps-lock LED */

keyboards/keychron/q3/iso/iso.c

@@ -18,8 +18,8 @@
 
 #ifdef RGB_MATRIX_ENABLE
 
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q3/iso_encoder/config.h

@@ -23,7 +23,7 @@
 /* RGB Matrix Configuration */
 #define RGB_MATRIX_LED_COUNT 88
 
-#define CKLED2001_CURRENT_TUNE \
+#define SNLED27351_CURRENT_TUNE \
     { 0x9D, 0x9D, 0x44, 0x9D, 0x9D, 0x44, 0x9D, 0x9D, 0x44, 0x9D, 0x9D, 0x44 }
 
 /* Enable caps-lock LED */

keyboards/keychron/q3/iso_encoder/iso_encoder.c

@@ -18,8 +18,8 @@
 
 #ifdef RGB_MATRIX_ENABLE
 
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q3/jis/config.h

@@ -22,7 +22,7 @@
 /* RGB Matrix Configuration */
 #define RGB_MATRIX_LED_COUNT 91
 
-#define CKLED2001_CURRENT_TUNE \
+#define SNLED27351_CURRENT_TUNE \
     { 0x94, 0x94, 0x44, 0x94, 0x94, 0x44, 0x94, 0x94, 0x44, 0x94, 0x94, 0x44 }
 
 /* Enable CapsLcok LED */

keyboards/keychron/q3/jis/jis.c

@@ -18,8 +18,8 @@
 
 #ifdef RGB_MATRIX_ENABLE
 
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q3/jis_encoder/config.h

@@ -23,7 +23,7 @@
 /* RGB Matrix Configuration */
 #define RGB_MATRIX_LED_COUNT 92
 
-#define CKLED2001_CURRENT_TUNE \
+#define SNLED27351_CURRENT_TUNE \
     { 0x94, 0x94, 0x44, 0x94, 0x94, 0x44, 0x94, 0x94, 0x44, 0x94, 0x94, 0x44 }
 
 /* Enable CapsLcok LED */

keyboards/keychron/q3/jis_encoder/jis_encoder.c

@@ -18,8 +18,8 @@
 
 #ifdef RGB_MATRIX_ENABLE
 
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q4/ansi_v1/ansi_v1.c

@@ -18,8 +18,8 @@
 
 #ifdef RGB_MATRIX_ENABLE
 
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to CKLED manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q4/ansi_v1/config.h

@@ -17,17 +17,17 @@
 #pragma once
 
 /* RGB Matrix Driver Configuration */
-#define CKLED2001_DRIVER_COUNT 2
-#define DRIVER_ADDR_1 CKLED2001_I2C_ADDRESS_VDDIO
-#define DRIVER_ADDR_2 CKLED2001_I2C_ADDRESS_GND
+#define SNLED27351_DRIVER_COUNT 2
+#define DRIVER_ADDR_1 SNLED27351_I2C_ADDRESS_VDDIO
+#define DRIVER_ADDR_2 SNLED27351_I2C_ADDRESS_GND
 
 /* RGB Matrix Configuration */
 #define DRIVER_1_LED_TOTAL 31
 #define DRIVER_2_LED_TOTAL 30
 #define RGB_MATRIX_LED_COUNT (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)
 
-#define CKLED2001_PHASE_CHANNEL CKLED2001_MSKPHASE_9CHANNEL
-#define CKLED2001_CURRENT_TUNE \
+#define SNLED27351_PHASE_CHANNEL SNLED27351_MSKPHASE_9CHANNEL
+#define SNLED27351_CURRENT_TUNE \
     { 0xCA, 0xCA, 0x60, 0xCA, 0xCA, 0x60, 0xCA, 0xCA, 0x60, 0xCA, 0xCA, 0x60 }
 
 /* Enable CapsLcok LED*/

keyboards/keychron/q4/ansi_v1/info.json

@@ -9,7 +9,7 @@
         "device_version": "1.0.0"
     },
     "rgb_matrix": {
-        "driver": "ckled2001"
+        "driver": "snled27351"
     },
     "matrix_pins": {
         "cols": ["C14", "C15", "A0", "A1", "A2", "A3", "A4", "A5", "A6", "A7", "B0", "B1", "A8", "A9"],

keyboards/keychron/q4/ansi_v2/ansi_v2.c

@@ -18,8 +18,8 @@
 
 #ifdef RGB_MATRIX_ENABLE
 
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to CKLED manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q4/ansi_v2/config.h

@@ -17,14 +17,14 @@
 #pragma once
 
 /* RGB Matrix Driver Configuration */
-#define CKLED2001_DRIVER_COUNT 1
-#define DRIVER_ADDR_1 CKLED2001_I2C_ADDRESS_GND
+#define SNLED27351_DRIVER_COUNT 1
+#define DRIVER_ADDR_1 SNLED27351_I2C_ADDRESS_GND
 
 /* RGB Matrix Configuration */
 #define DRIVER_1_LED_TOTAL 61
 #define RGB_MATRIX_LED_COUNT DRIVER_1_LED_TOTAL
 
-#define CKLED2001_CURRENT_TUNE \
+#define SNLED27351_CURRENT_TUNE \
     { 0xCA, 0xCA, 0x60, 0xCA, 0xCA, 0x60, 0xCA, 0xCA, 0x60, 0xCA, 0xCA, 0x60 }
 
 /* Enable CapsLcok LED*/

keyboards/keychron/q4/ansi_v2/info.json

@@ -9,7 +9,7 @@
         "device_version": "1.0.0"
     },
     "rgb_matrix": {
-        "driver": "ckled2001"
+        "driver": "snled27351"
     },
     "matrix_pins": {
         "cols": ["C14", "C15", "A0", "A1", "A2", "A3", "A4", "A5", "A6", "A7", "B0", "B1", "A8", "A9"],

keyboards/keychron/q4/iso/config.h

@@ -17,14 +17,14 @@
 #pragma once
 
 /* RGB Matrix Driver Configuration */
-#define CKLED2001_DRIVER_COUNT 1
-#define DRIVER_ADDR_1 CKLED2001_I2C_ADDRESS_GND
+#define SNLED27351_DRIVER_COUNT 1
+#define DRIVER_ADDR_1 SNLED27351_I2C_ADDRESS_GND
 
 /* RGB Matrix Configuration */
 #define DRIVER_1_LED_TOTAL 62
 #define RGB_MATRIX_LED_COUNT DRIVER_1_LED_TOTAL
 
-#define CKLED2001_CURRENT_TUNE \
+#define SNLED27351_CURRENT_TUNE \
     { 0xCA, 0xCA, 0x60, 0xCA, 0xCA, 0x60, 0xCA, 0xCA, 0x60, 0xCA, 0xCA, 0x60 }
 
 /* Enable CapsLcok LED*/

keyboards/keychron/q4/iso/info.json

@@ -9,7 +9,7 @@
         "device_version": "1.0.0"
     },
     "rgb_matrix": {
-        "driver": "ckled2001"
+        "driver": "snled27351"
     },
     "matrix_pins": {
         "cols": ["C14", "C15", "A0", "A1", "A2", "A3", "A4", "A5", "A6", "A7", "B0", "B1", "A8", "A9"],

keyboards/keychron/q4/iso/iso.c

@@ -18,8 +18,8 @@
 
 #ifdef RGB_MATRIX_ENABLE
 
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to CKLED manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q5/ansi/ansi.c

@@ -18,8 +18,8 @@
 
 #ifdef RGB_MATRIX_ENABLE
 
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q5/ansi/info.json

@@ -9,7 +9,7 @@
         "device_version": "1.0.0"
     },
     "rgb_matrix": {
-        "driver": "ckled2001"
+        "driver": "snled27351"
     },
     "processor": "STM32L432",
     "bootloader": "stm32-dfu",

keyboards/keychron/q5/ansi_encoder/ansi_encoder.c

@@ -20,8 +20,8 @@
 
 // clang-format off
 
-const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
-/* Refer to IS31 manual for these locations
+const snled27351_led_t PROGMEM g_snled27351_leds[RGB_MATRIX_LED_COUNT] = {
+/* Refer to SNLED27351 manual for these locations
  *   driver
  *   |  R location
  *   |  |       G location

keyboards/keychron/q5/ansi_encoder/info.json

@@ -9,7 +9,7 @@
         "device_version": "1.0.0"
     },
     "rgb_matrix": {
-        "driver": "ckled2001"
+        "driver": "snled27351"
     },
     "encoder": {
         "rotary": [

keyboards/keychron/q5/config.h

@@ -30,11 +30,11 @@
 #define DIODE_DIRECTION ROW2COL
 
 /* RGB Matrix Driver Configuration */
-#define CKLED2001_DRIVER_COUNT 2
-#define DRIVER_ADDR_1 CKLED2001_I2C_ADDRESS_VDDIO
-#define DRIVER_ADDR_2 CKLED2001_I2C_ADDRESS_GND
+#define SNLED27351_DRIVER_COUNT 2
+#define DRIVER_ADDR_1 SNLED27351_I2C_ADDRESS_VDDIO
+#define DRIVER_ADDR_2 SNLED27351_I2C_ADDRESS_GND
 
-#define CKLED2001_CURRENT_TUNE \
+#define SNLED27351_CURRENT_TUNE \
     { 0xB6, 0xB6, 0x56, 0xB6, 0xB6, 0x56, 0xB6, 0xB6, 0x56, 0xB6, 0xB6, 0x56 }
 
 /* DIP switch */

keyboards/keychron/q5/iso/info.json

@@ -9,7 +9,7 @@
         "device_version": "1.0.0"
     },
     "rgb_matrix": {
-        "driver": "ckled2001"
+        "driver": "snled27351"
     },
     "processor": "STM32L432",
     "bootloader": "stm32-dfu",