is31fl3736: driver naming cleanups (qmk#21903)

Author: fauxpark

docs/feature_rgb_matrix.md

@@ -170,31 +170,31 @@ Configure the hardware via your `config.h`:
 
 | Variable | Description | Default |
 |----------|-------------|---------|
-| `ISSI_TIMEOUT` | (Optional) How long to wait for i2c messages, in milliseconds | 100 |
-| `ISSI_PERSISTENCE` | (Optional) Retry failed messages this many times | 0 |
-| `ISSI_PWM_FREQUENCY` | (Optional) PWM Frequency Setting - IS31FL3736B only | 0 |
-| `ISSI_GLOBALCURRENT` | (Optional) Configuration for the Global Current Register | 0xFF |
-| `ISSI_SWPULLUP` | (Optional) Set the value of the SWx lines on-chip de-ghosting resistors | PUR_0R (Disabled) |
-| `ISSI_CSPULLUP` | (Optional) Set the value of the CSx lines on-chip de-ghosting resistors | PUR_0R (Disabled) |
-| `DRIVER_COUNT` | (Required) How many RGB driver IC's are present | |
+| `IS31FL3736_I2C_TIMEOUT` | (Optional) How long to wait for i2c messages, in milliseconds | 100 |
+| `IS31FL3736_PERSISTENCE` | (Optional) Retry failed messages this many times | 0 |
+| `IS31FL3736_PWM_FREQUENCY` | (Optional) PWM Frequency Setting - IS31FL3736B only | 0 |
+| `IS31FL3736_GLOBALCURRENT` | (Optional) Configuration for the Global Current Register | 0xFF |
+| `IS31FL3736_SWPULLUP` | (Optional) Set the value of the SWx lines on-chip de-ghosting resistors | PUR_0R (Disabled) |
+| `IS31FL3736_CSPULLUP` | (Optional) Set the value of the CSx lines on-chip de-ghosting resistors | PUR_0R (Disabled) |
+| `IS31FL3736_DRIVER_COUNT` | (Required) How many RGB driver IC's are present | |
 | `RGB_MATRIX_LED_COUNT` | (Required) How many RGB lights are present across all drivers | |
 | `DRIVER_ADDR_1` | (Required) Address for the first RGB driver | |
 | `DRIVER_ADDR_2` | (Optional) Address for the second RGB driver | |
 | `DRIVER_ADDR_3` | (Optional) Address for the third RGB driver | |
 | `DRIVER_ADDR_4` | (Optional) Address for the fourth RGB driver | |
 
-The IS31FL3736 IC's have on-chip resistors that can be enabled to allow for de-ghosting of the RGB matrix. By default these resistors are not enabled (`ISSI_SWPULLUP`/`ISSI_CSPULLUP` are given the value of`PUR_0R`), the values that can be set to enable de-ghosting are as follows:
+The IS31FL3736 IC's have on-chip resistors that can be enabled to allow for de-ghosting of the RGB matrix. By default these resistors are not enabled (`IS31FL3736_SWPULLUP`/`IS31FL3736_CSPULLUP` are given the value of `IS31FL3736_PUR_0R`), the values that can be set to enable de-ghosting are as follows:
 
-| `ISSI_SWPULLUP/ISSI_CSPULLUP` | Description |
+| `IS31FL3736_SWPULLUP/IS31FL3736_CSPULLUP` | Description |
 |----------------------|-------------|
-| `PUR_0R` | (default) Do not use the on-chip resistors/enable de-ghosting |
-| `PUR_05KR` | The 0.5k Ohm resistor used during blanking period (t_NOL) |
-| `PUR_1KR` | The 1k Ohm resistor used during blanking period (t_NOL) |
-| `PUR_2KR` | The 2k Ohm resistor used during blanking period (t_NOL) |
-| `PUR_4KR` | The 4k Ohm resistor used during blanking period (t_NOL) |
-| `PUR_8KR` | The 8k Ohm resistor during blanking period (t_NOL) |
-| `PUR_16KR` | The 16k Ohm resistor during blanking period (t_NOL) |
-| `PUR_32KR` | The 32k Ohm resistor used during blanking period (t_NOL) |
+| `IS31FL3736_PUR_0R` | (default) Do not use the on-chip resistors/enable de-ghosting |
+| `IS31FL3736_PUR_05KR` | The 0.5k Ohm resistor used during blanking period (t_NOL) |
+| `IS31FL3736_PUR_1KR` | The 1k Ohm resistor used during blanking period (t_NOL) |
+| `IS31FL3736_PUR_2KR` | The 2k Ohm resistor used during blanking period (t_NOL) |
+| `IS31FL3736_PUR_4KR` | The 4k Ohm resistor used during blanking period (t_NOL) |
+| `IS31FL3736_PUR_8KR` | The 8k Ohm resistor during blanking period (t_NOL) |
+| `IS31FL3736_PUR_16KR` | The 16k Ohm resistor during blanking period (t_NOL) |
+| `IS31FL3736_PUR_32KR` | The 32k Ohm resistor used during blanking period (t_NOL) |
 
 Here is an example using 2 drivers.
 
@@ -211,7 +211,7 @@ Here is an example using 2 drivers.
 #define DRIVER_ADDR_1 0b1010000
 #define DRIVER_ADDR_2 0b1010001
 
-#define DRIVER_COUNT 2
+#define IS31FL3736_DRIVER_COUNT 2
 #define DRIVER_1_LED_TOTAL 30
 #define DRIVER_2_LED_TOTAL 32
 #define RGB_MATRIX_LED_COUNT (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)

drivers/led/issi/is31fl3736.c

@@ -16,6 +16,7 @@
  */
 
 #include "is31fl3736.h"
+#include <string.h>
 #include "i2c_master.h"
 #include "wait.h"
 
@@ -29,42 +30,42 @@
 // ADDR1 represents A1:A0 of the 7-bit address.
 // ADDR2 represents A3:A2 of the 7-bit address.
 // The result is: 0b101(ADDR2)(ADDR1)
-#define ISSI_ADDR_DEFAULT 0x50
-
-#define ISSI_COMMANDREGISTER 0xFD
-#define ISSI_COMMANDREGISTER_WRITELOCK 0xFE
-#define ISSI_INTERRUPTMASKREGISTER 0xF0
-#define ISSI_INTERRUPTSTATUSREGISTER 0xF1
-
-#define ISSI_PAGE_LEDCONTROL 0x00 // PG0
-#define ISSI_PAGE_PWM 0x01        // PG1
-#define ISSI_PAGE_AUTOBREATH 0x02 // PG2
-#define ISSI_PAGE_FUNCTION 0x03   // PG3
-
-#define ISSI_REG_CONFIGURATION 0x00 // PG3
-#define ISSI_REG_GLOBALCURRENT 0x01 // PG3
-#define ISSI_REG_RESET 0x11         // PG3
-#define ISSI_REG_SWPULLUP 0x0F      // PG3
-#define ISSI_REG_CSPULLUP 0x10      // PG3
-
-#ifndef ISSI_TIMEOUT
-#    define ISSI_TIMEOUT 100
+#define IS31FL3736_I2C_ADDRESS_DEFAULT 0x50
+
+#define IS31FL3736_COMMANDREGISTER 0xFD
+#define IS31FL3736_COMMANDREGISTER_WRITELOCK 0xFE
+#define IS31FL3736_INTERRUPTMASKREGISTER 0xF0
+#define IS31FL3736_INTERRUPTSTATUSREGISTER 0xF1
+
+#define IS31FL3736_PAGE_LEDCONTROL 0x00 // PG0
+#define IS31FL3736_PAGE_PWM 0x01        // PG1
+#define IS31FL3736_PAGE_AUTOBREATH 0x02 // PG2
+#define IS31FL3736_PAGE_FUNCTION 0x03   // PG3
+
+#define IS31FL3736_REG_CONFIGURATION 0x00 // PG3
+#define IS31FL3736_REG_GLOBALCURRENT 0x01 // PG3
+#define IS31FL3736_REG_RESET 0x11         // PG3
+#define IS31FL3736_REG_SWPULLUP 0x0F      // PG3
+#define IS31FL3736_REG_CSPULLUP 0x10      // PG3
+
+#ifndef IS31FL3736_TIMEOUT
+#    define IS31FL3736_I2C_TIMEOUT 100
 #endif
 
-#ifndef ISSI_PERSISTENCE
-#    define ISSI_PERSISTENCE 0
+#ifndef IS31FL3736_I2C_PERSISTENCE
+#    define IS31FL3736_I2C_PERSISTENCE 0
 #endif
 
-#ifndef ISSI_SWPULLUP
-#    define ISSI_SWPULLUP PUR_0R
+#ifndef IS31FL3736_SWPULLUP
+#    define IS31FL3736_SWPULLUP IS31FL3736_PUR_0R
 #endif
 
-#ifndef ISSI_CSPULLUP
-#    define ISSI_CSPULLUP PUR_0R
+#ifndef IS31FL3736_CSPULLUP
+#    define IS31FL3736_CSPULLUP IS31FL3736_PUR_0R
 #endif
 
-#ifndef ISSI_GLOBALCURRENT
-#    define ISSI_GLOBALCURRENT 0xFF
+#ifndef IS31FL3736_GLOBALCURRENT
+#    define IS31FL3736_GLOBALCURRENT 0xFF
 #endif
 
 // Transfer buffer for TWITransmitData()
@@ -76,22 +77,22 @@ uint8_t g_twi_transfer_buffer[20];
 // We could optimize this and take out the unused registers from these
 // buffers and the transfers in is31fl3736_write_pwm_buffer() but it's
 // probably not worth the extra complexity.
-uint8_t g_pwm_buffer[DRIVER_COUNT][192];
-bool    g_pwm_buffer_update_required[DRIVER_COUNT] = {false};
+uint8_t g_pwm_buffer[IS31FL3736_DRIVER_COUNT][192];
+bool    g_pwm_buffer_update_required[IS31FL3736_DRIVER_COUNT] = {false};
 
-uint8_t g_led_control_registers[DRIVER_COUNT][24] = {{0}, {0}};
-bool    g_led_control_registers_update_required   = false;
+uint8_t g_led_control_registers[IS31FL3736_DRIVER_COUNT][24] = {{0}, {0}};
+bool    g_led_control_registers_update_required              = false;
 
 void is31fl3736_write_register(uint8_t addr, uint8_t reg, uint8_t data) {
     g_twi_transfer_buffer[0] = reg;
     g_twi_transfer_buffer[1] = data;
 
-#if ISSI_PERSISTENCE > 0
-    for (uint8_t i = 0; i < ISSI_PERSISTENCE; i++) {
-        if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, ISSI_TIMEOUT) == 0) break;
+#if IS31FL3736_I2C_PERSISTENCE > 0
+    for (uint8_t i = 0; i < IS31FL3736_I2C_PERSISTENCE; i++) {
+        if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, IS31FL3736_I2C_TIMEOUT) == 0) break;
     }
 #else
-    i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, ISSI_TIMEOUT);
+    i2c_transmit(addr << 1, g_twi_transfer_buffer, 2, IS31FL3736_I2C_TIMEOUT);
 #endif
 }
 
@@ -109,12 +110,12 @@ void is31fl3736_write_pwm_buffer(uint8_t addr, uint8_t *pwm_buffer) {
         // thus this sets registers 0x00-0x0F, 0x10-0x1F, etc. in one transfer
         memcpy(g_twi_transfer_buffer + 1, pwm_buffer + i, 16);
 
-#if ISSI_PERSISTENCE > 0
-        for (uint8_t i = 0; i < ISSI_PERSISTENCE; i++) {
-            if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 17, ISSI_TIMEOUT) == 0) break;
+#if IS31FL3736_I2C_PERSISTENCE > 0
+        for (uint8_t i = 0; i < IS31FL3736_I2C_PERSISTENCE; i++) {
+            if (i2c_transmit(addr << 1, g_twi_transfer_buffer, 17, IS31FL3736_I2C_TIMEOUT) == 0) break;
         }
 #else
-        i2c_transmit(addr << 1, g_twi_transfer_buffer, 17, ISSI_TIMEOUT);
+        i2c_transmit(addr << 1, g_twi_transfer_buffer, 17, IS31FL3736_I2C_TIMEOUT);
 #endif
     }
 }
@@ -126,39 +127,39 @@ void is31fl3736_init(uint8_t addr) {
     // then disable software shutdown.
 
     // Unlock the command register.
-    is31fl3736_write_register(addr, ISSI_COMMANDREGISTER_WRITELOCK, 0xC5);
+    is31fl3736_write_register(addr, IS31FL3736_COMMANDREGISTER_WRITELOCK, 0xC5);
 
     // Select PG0
-    is31fl3736_write_register(addr, ISSI_COMMANDREGISTER, ISSI_PAGE_LEDCONTROL);
+    is31fl3736_write_register(addr, IS31FL3736_COMMANDREGISTER, IS31FL3736_PAGE_LEDCONTROL);
     // Turn off all LEDs.
     for (int i = 0x00; i <= 0x17; i++) {
         is31fl3736_write_register(addr, i, 0x00);
     }
 
     // Unlock the command register.
-    is31fl3736_write_register(addr, ISSI_COMMANDREGISTER_WRITELOCK, 0xC5);
+    is31fl3736_write_register(addr, IS31FL3736_COMMANDREGISTER_WRITELOCK, 0xC5);
 
     // Select PG1
-    is31fl3736_write_register(addr, ISSI_COMMANDREGISTER, ISSI_PAGE_PWM);
+    is31fl3736_write_register(addr, IS31FL3736_COMMANDREGISTER, IS31FL3736_PAGE_PWM);
     // Set PWM on all LEDs to 0
     // No need to setup Breath registers to PWM as that is the default.
     for (int i = 0x00; i <= 0xBF; i++) {
         is31fl3736_write_register(addr, i, 0x00);
     }
 
     // Unlock the command register.
-    is31fl3736_write_register(addr, ISSI_COMMANDREGISTER_WRITELOCK, 0xC5);
+    is31fl3736_write_register(addr, IS31FL3736_COMMANDREGISTER_WRITELOCK, 0xC5);
 
     // Select PG3
-    is31fl3736_write_register(addr, ISSI_COMMANDREGISTER, ISSI_PAGE_FUNCTION);
+    is31fl3736_write_register(addr, IS31FL3736_COMMANDREGISTER, IS31FL3736_PAGE_FUNCTION);
     // Set de-ghost pull-up resistors (SWx)
-    is31fl3736_write_register(addr, ISSI_REG_SWPULLUP, ISSI_SWPULLUP);
+    is31fl3736_write_register(addr, IS31FL3736_REG_SWPULLUP, IS31FL3736_SWPULLUP);
     // Set de-ghost pull-down resistors (CSx)
-    is31fl3736_write_register(addr, ISSI_REG_CSPULLUP, ISSI_CSPULLUP);
+    is31fl3736_write_register(addr, IS31FL3736_REG_CSPULLUP, IS31FL3736_CSPULLUP);
     // Set global current to maximum.
-    is31fl3736_write_register(addr, ISSI_REG_GLOBALCURRENT, ISSI_GLOBALCURRENT);
+    is31fl3736_write_register(addr, IS31FL3736_REG_GLOBALCURRENT, IS31FL3736_GLOBALCURRENT);
     // Disable software shutdown.
-    is31fl3736_write_register(addr, ISSI_REG_CONFIGURATION, 0x01);
+    is31fl3736_write_register(addr, IS31FL3736_REG_CONFIGURATION, 0x01);
 
     // Wait 10ms to ensure the device has woken up.
     wait_ms(10);
@@ -266,19 +267,19 @@ void is31fl3736_mono_set_led_control_register(uint8_t index, bool enabled) {
 void is31fl3736_update_pwm_buffers(uint8_t addr, uint8_t index) {
     if (g_pwm_buffer_update_required[index]) {
         // Firstly we need to unlock the command register and select PG1
-        is31fl3736_write_register(addr, ISSI_COMMANDREGISTER_WRITELOCK, 0xC5);
-        is31fl3736_write_register(addr, ISSI_COMMANDREGISTER, ISSI_PAGE_PWM);
+        is31fl3736_write_register(addr, IS31FL3736_COMMANDREGISTER_WRITELOCK, 0xC5);
+        is31fl3736_write_register(addr, IS31FL3736_COMMANDREGISTER, IS31FL3736_PAGE_PWM);
 
         is31fl3736_write_pwm_buffer(addr, g_pwm_buffer[index]);
+        g_pwm_buffer_update_required[index] = false;
     }
-    g_pwm_buffer_update_required[index] = false;
 }
 
 void is31fl3736_update_led_control_registers(uint8_t addr1, uint8_t addr2) {
     if (g_led_control_registers_update_required) {
         // Firstly we need to unlock the command register and select PG0
-        is31fl3736_write_register(addr1, ISSI_COMMANDREGISTER_WRITELOCK, 0xC5);
-        is31fl3736_write_register(addr1, ISSI_COMMANDREGISTER, ISSI_PAGE_LEDCONTROL);
+        is31fl3736_write_register(addr1, IS31FL3736_COMMANDREGISTER_WRITELOCK, 0xC5);
+        is31fl3736_write_register(addr1, IS31FL3736_COMMANDREGISTER, IS31FL3736_PAGE_LEDCONTROL);
         for (int i = 0; i < 24; i++) {
             is31fl3736_write_register(addr1, i, g_led_control_registers[0][i]);
             // is31fl3736_write_register(addr2, i, g_led_control_registers[1][i]);

drivers/led/issi/is31fl3736.h

@@ -19,19 +19,37 @@
 
 #include <stdint.h>
 #include <stdbool.h>
-#include <string.h>
 #include "progmem.h"
 
-// Simple interface option.
-// If these aren't defined, just define them to make it compile
-
-#ifndef DRIVER_COUNT
-#    define DRIVER_COUNT 2
+// ======== DEPRECATED DEFINES - DO NOT USE ========
+#ifdef DRIVER_COUNT
+#    define IS31FL3736_DRIVER_COUNT DRIVER_COUNT
 #endif
-
-#ifndef RGB_MATRIX_LED_COUNT
-#    define RGB_MATRIX_LED_COUNT 96
+#ifdef ISSI_TIMEOUT
+#    define IS31FL3736_I2C_TIMEOUT ISSI_TIMEOUT
+#endif
+#ifdef ISSI_PERSISTENCE
+#    define IS31FL3736_I2C_PERSISTENCE ISSI_PERSISTENCE
+#endif
+#ifdef ISSI_SWPULLUP
+#    define IS31FL3736_SWPULLUP ISSI_SWPULLUP
 #endif
+#ifdef ISSI_CSPULLUP
+#    define IS31FL3736_CSPULLUP ISSI_CSPULLUP
+#endif
+#ifdef ISSI_GLOBALCURRENT
+#    define IS31FL3736_GLOBALCURRENT ISSI_GLOBALCURRENT
+#endif
+
+#define PUR_0R IS31FL3736_PUR_0R
+#define PUR_05KR IS31FL3736_PUR_05KR
+#define PUR_1KR IS31FL3736_PUR_1KR
+#define PUR_2KR IS31FL3736_PUR_2KR
+#define PUR_4KR IS31FL3736_PUR_4KR
+#define PUR_8KR IS31FL3736_PUR_8KR
+#define PUR_16KR IS31FL3736_PUR_16KR
+#define PUR_32KR IS31FL3736_PUR_32KR
+// ========
 
 typedef struct is31_led {
     uint8_t driver : 2;
@@ -62,14 +80,14 @@ void is31fl3736_mono_set_led_control_register(uint8_t index, bool enabled);
 void is31fl3736_update_pwm_buffers(uint8_t addr, uint8_t index);
 void is31fl3736_update_led_control_registers(uint8_t addr, uint8_t index);
 
-#define PUR_0R 0x00   // No PUR resistor
-#define PUR_05KR 0x01 // 0.5k Ohm resistor
-#define PUR_1KR 0x02  // 1.0k Ohm resistor
-#define PUR_2KR 0x03  // 2.0k Ohm resistor
-#define PUR_4KR 0x04  // 4.0k Ohm resistor
-#define PUR_8KR 0x05  // 8.0k Ohm resistor
-#define PUR_16KR 0x06 // 16k Ohm resistor
-#define PUR_32KR 0x07 // 32k Ohm resistor
+#define IS31FL3736_PUR_0R 0x00   // No PUR resistor
+#define IS31FL3736_PUR_05KR 0x01 // 0.5k Ohm resistor
+#define IS31FL3736_PUR_1KR 0x02  // 1.0k Ohm resistor
+#define IS31FL3736_PUR_2KR 0x03  // 2.0k Ohm resistor
+#define IS31FL3736_PUR_4KR 0x04  // 4.0k Ohm resistor
+#define IS31FL3736_PUR_8KR 0x05  // 8.0k Ohm resistor
+#define IS31FL3736_PUR_16KR 0x06 // 16k Ohm resistor
+#define IS31FL3736_PUR_32KR 0x07 // 32k Ohm resistor
 
 #define A_1 0x00
 #define A_2 0x02

keyboards/wilba_tech/wt60_a/config.h

@@ -61,3 +61,6 @@
 // Backlight config starts after VIA's EEPROM usage,
 // dynamic keymaps start after this.
 #define VIA_EEPROM_CUSTOM_CONFIG_SIZE 7
+
+#define IS31FL3736_DRIVER_COUNT 2
+#define RGB_MATRIX_LED_COUNT 96

keyboards/wilba_tech/wt65_a/config.h

@@ -61,3 +61,6 @@
 // Backlight config starts after VIA's EEPROM usage,
 // dynamic keymaps start after this.
 #define VIA_EEPROM_CUSTOM_CONFIG_SIZE 7
+
+#define IS31FL3736_DRIVER_COUNT 2
+#define RGB_MATRIX_LED_COUNT 96

keyboards/wilba_tech/wt65_b/config.h

@@ -61,3 +61,6 @@
 // Backlight config starts after VIA's EEPROM usage,
 // dynamic keymaps start after this.
 #define VIA_EEPROM_CUSTOM_CONFIG_SIZE 7
+
+#define IS31FL3736_DRIVER_COUNT 2
+#define RGB_MATRIX_LED_COUNT 96

keyboards/wilba_tech/wt75_a/config.h

@@ -61,3 +61,6 @@
 // Backlight config starts after VIA's EEPROM usage,
 // dynamic keymaps start after this.
 #define VIA_EEPROM_CUSTOM_CONFIG_SIZE 7
+
+#define IS31FL3736_DRIVER_COUNT 2
+#define RGB_MATRIX_LED_COUNT 96

keyboards/wilba_tech/wt75_b/config.h

@@ -61,3 +61,6 @@
 // Backlight config starts after VIA's EEPROM usage,
 // dynamic keymaps start after this.
 #define VIA_EEPROM_CUSTOM_CONFIG_SIZE 7
+
+#define IS31FL3736_DRIVER_COUNT 2
+#define RGB_MATRIX_LED_COUNT 96

keyboards/wilba_tech/wt75_c/config.h

@@ -61,3 +61,6 @@
 // Backlight config starts after VIA's EEPROM usage,
 // dynamic keymaps start after this.
 #define VIA_EEPROM_CUSTOM_CONFIG_SIZE 7
+
+#define IS31FL3736_DRIVER_COUNT 2
+#define RGB_MATRIX_LED_COUNT 96

keyboards/wilba_tech/wt80_a/config.h

@@ -61,3 +61,6 @@
 // Backlight config starts after VIA's EEPROM usage,
 // dynamic keymaps start after this.
 #define VIA_EEPROM_CUSTOM_CONFIG_SIZE 7
+
+#define IS31FL3736_DRIVER_COUNT 2
+#define RGB_MATRIX_LED_COUNT 96