Re: [PATCH v6 2/2] leds: ltc3208: Add driver for LTC3208 Multidisplay LED Driver
Lee Jones <[email protected]>
| Newsgroups | org.kernel.vger.linux-leds,org.kernel.vger.linux-devicetree,org.kernel.vger.linux-kernel |
|---|---|
| Message-ID | <[email protected]> |
Few things for you to chew on. /* Sashiko Automation: Issues Found (6 Findings) */ On Tue, 23 Jun 2026, Jan Carlo Roleda wrote: > Kernel driver implementation for LTC3208 Multidisplay LED Driver. > > The LTC3208 is a Multi-display LED driver, designed to control up to > 7 distinct LED channels (MAIN, SUB, AUX, CAMHI, CAMLO, RED, GREEN, BLUE), > each configurable with its own current level that is equally set to its > respective output current source pins for external LEDs. > > It is programmed via the I2C serial interface. > MAIN and SUB support 8-bit current level resolution, > while AUX, CAMHI/LO, RED, GREEN, and BLUE support 4-bit levels. > > The AUX LED channel can be configured to mirror the CAM, SUB, and MAIN > channel current levels, or as its own independent AUX channel. > > The CAM LED channel is configured as 2 separate CAMHI and CAMLO register > sub-channels, which currnet is selected via the CAMHL pin, or set to > CAMHI register only via setting the S_CAMHILO bit high in register G (0x7). [Severity: Low] This isn't a bug, but there's a typo in the commit message: 'currnet' instead of 'current'. > > Signed-off-by: Jan Carlo Roleda <[email protected]> > --- > MAINTAINERS | 1 + > drivers/leds/Kconfig | 12 +++ > drivers/leds/Makefile | 1 + > drivers/leds/leds-ltc3208.c | 244 ++++++++++++++++++++++++++++++++++++++++++++ > 4 files changed, 258 insertions(+) > > diff --git a/MAINTAINERS b/MAINTAINERS > index 2fd6ffdaaf04..e3b59485ecb3 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -15229,6 +15229,7 @@ L: [email protected] > S: Maintained > W: https://ez.analog.com/linux-software-drivers > F: Documentation/devicetree/bindings/leds/adi,ltc3208.yaml > +F: drivers/leds/leds-ltc3208.c > > LTC4282 HARDWARE MONITOR DRIVER > M: Nuno Sa <[email protected]> > diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig > index f4a0a3c8c870..d917ce3b72f4 100644 > --- a/drivers/leds/Kconfig > +++ b/drivers/leds/Kconfig > @@ -1028,6 +1028,18 @@ config LEDS_ACER_A500 > This option enables support for the Power Button LED of > Acer Iconia Tab A500. > > +config LEDS_LTC3208 > + tristate "LED Driver for Analog Devices LTC3208" > + depends on LEDS_CLASS && I2C > + select REGMAP_I2C > + help > + Say Y to enable the LTC3208 LED driver. > + This enables the LED device LTC3208, a 7-channel, 17-current source > + multidisplay high-current LED driver, configured via I2C. > + > + To compile this driver as a module, choose M here: the module will > + be called ltc3208. > + > source "drivers/leds/blink/Kconfig" > > comment "Flash and Torch LED drivers" > diff --git a/drivers/leds/Makefile b/drivers/leds/Makefile > index 7db3768912ca..0148b87e16ba 100644 > --- a/drivers/leds/Makefile > +++ b/drivers/leds/Makefile > @@ -61,6 +61,7 @@ obj-$(CONFIG_LEDS_LP8788) += leds-lp8788.o > obj-$(CONFIG_LEDS_LP8860) += leds-lp8860.o > obj-$(CONFIG_LEDS_LP8864) += leds-lp8864.o > obj-$(CONFIG_LEDS_LT3593) += leds-lt3593.o > +obj-$(CONFIG_LEDS_LTC3208) += leds-ltc3208.o > obj-$(CONFIG_LEDS_MAX5970) += leds-max5970.o > obj-$(CONFIG_LEDS_MAX77650) += leds-max77650.o > obj-$(CONFIG_LEDS_MAX77705) += leds-max77705.o > diff --git a/drivers/leds/leds-ltc3208.c b/drivers/leds/leds-ltc3208.c > new file mode 100644 > index 000000000000..3d6bec99e9ea > --- /dev/null > +++ b/drivers/leds/leds-ltc3208.c > @@ -0,0 +1,244 @@ > +// SPDX-License-Identifier: GPL-2.0 > +/* > + * LED driver for Analog Devices LTC3208 Multi-Display Driver > + * > + * Copyright 2026 Analog Devices Inc. > + * > + * Author: Jan Carlo Roleda <[email protected]> > + */ > +#include <linux/bitfield.h> > +#include <linux/errno.h> > +#include <linux/i2c.h> > +#include <linux/leds.h> > +#include <linux/mod_devicetable.h> > +#include <linux/module.h> > +#include <linux/property.h> > +#include <linux/regmap.h> > +#include <linux/types.h> > + > +/* Registers */ > +#define LTC3208_REG_A_GRNRED 0x1 /* Green and Red current DAC*/ > +#define LTC3208_REG_B_AUXBLU 0x2 /* AUX and Blue current DAC*/ > +#define LTC3208_REG_C_MAIN 0x3 /* Main current DAC */ > +#define LTC3208_REG_D_SUB 0x4 /* Sub current DAC */ > +#define LTC3208_REG_E_AUX_SELECT 0x5 /* AUX DAC Select */ > +#define LTC3208_AUX1_MASK GENMASK(1, 0) > +#define LTC3208_AUX2_MASK GENMASK(3, 2) > +#define LTC3208_AUX3_MASK GENMASK(5, 4) > +#define LTC3208_AUX4_MASK GENMASK(7, 6) > +#define LTC3208_REG_F_CAM 0x6 /* CAM (High and Low) current DAC*/ > +#define LTC3208_REG_G_OPT 0x7 /* Device Options */ > +#define LTC3208_OPT_CPO_MASK GENMASK(7, 6) [Severity: Low] Is this macro needed? It appears to be defined but never used in the driver. The same applies to LTC3208_MAX_CPO_OPT defined later. > +#define LTC3208_OPT_DIS_RGBDROP BIT(3) > +#define LTC3208_OPT_DIS_CAMHILO BIT(2) > +#define LTC3208_OPT_EN_RGBS BIT(1) > + > +#define LTC3208_MAX_BRIGHTNESS_4BIT 0xF > +#define LTC3208_MAX_BRIGHTNESS_8BIT 0xFF > + > +#define LTC3208_NUM_LED_GRPS 8 > +#define LTC3208_NUM_AUX_LEDS 4 > + > +#define LTC3208_NUM_AUX_OPT 4 > +#define LTC3208_MAX_CPO_OPT 3 > + > +enum ltc3208_aux_channel { > + LTC3208_AUX_CHAN_AUX = 0, > + LTC3208_AUX_CHAN_MAIN, > + LTC3208_AUX_CHAN_SUB, > + LTC3208_AUX_CHAN_CAM > +}; > + > +enum ltc3208_channel { > + LTC3208_CHAN_MAIN = 0, > + LTC3208_CHAN_SUB, > + LTC3208_CHAN_AUX, > + LTC3208_CHAN_CAML, > + LTC3208_CHAN_CAMH, > + LTC3208_CHAN_RED, > + LTC3208_CHAN_BLUE, > + LTC3208_CHAN_GREEN, > + LTC3208_CHAN_N_COUNT, > +}; > + > +static const char *const ltc3208_dt_aux_channels[] = { "adi,aux1-channel", > + "adi,aux2-channel", > + "adi,aux3-channel", > + "adi,aux4-channel" }; > + > +static const char *const ltc3208_aux_opt[] = { "aux", "main", "sub", "cam" }; > + > +struct ltc3208_led { > + struct led_classdev cdev; > + struct i2c_client *client; > + struct regmap_field *rfield; > + enum ltc3208_channel channel; > +}; > + > +struct ltc3208 { > + struct ltc3208_led leds[LTC3208_NUM_LED_GRPS]; > + struct regmap *regmap; > +}; [Severity: Low] Is the channel member in struct ltc3208_led used anywhere? It gets assigned during probe but doesn't seem to be read later. Similarly, the regmap pointer in struct ltc3208 appears to only be used locally in ltc3208_probe() and isn't needed in the struct. > + > +static const struct regmap_config ltc3208_regmap_cfg = { > + .reg_bits = 8, > + .val_bits = 8, > + .max_register = LTC3208_REG_G_OPT, > + .cache_type = REGCACHE_FLAT_S, > +}; [Severity: High] Does this regmap configuration need a .reg_defaults array to seed the cache? Since .reg_defaults is missing, the cache won't be seeded. Later, when ltc3208_led_set_brightness() calls regmap_field_write() for shared registers (like LTC3208_REG_A_GRNRED), it will trigger a read-modify-write operation that issues an I2C read. If the hardware is write-only, the read will fail and break LED functionality. If it supports reads, this still introduces unnecessary I2C read latency on a fast path. > + > +static const struct reg_field ltc3208_led_reg_field[LTC3208_CHAN_N_COUNT] = { > + [LTC3208_CHAN_MAIN] = REG_FIELD(LTC3208_REG_C_MAIN, 0, 7), > + [LTC3208_CHAN_SUB] = REG_FIELD(LTC3208_REG_D_SUB, 0, 7), > + [LTC3208_CHAN_BLUE] = REG_FIELD(LTC3208_REG_B_AUXBLU, 0, 3), > + [LTC3208_CHAN_AUX] = REG_FIELD(LTC3208_REG_B_AUXBLU, 4, 7), > + [LTC3208_CHAN_CAML] = REG_FIELD(LTC3208_REG_F_CAM, 0, 3), > + [LTC3208_CHAN_CAMH] = REG_FIELD(LTC3208_REG_F_CAM, 4, 7), > + [LTC3208_CHAN_RED] = REG_FIELD(LTC3208_REG_A_GRNRED, 0, 3), > + [LTC3208_CHAN_GREEN] = REG_FIELD(LTC3208_REG_A_GRNRED, 4, 7), > +}; > + > +static int ltc3208_led_set_brightness(struct led_classdev *led_cdev, > + enum led_brightness brightness) > +{ > + struct ltc3208_led *led = > + container_of(led_cdev, struct ltc3208_led, cdev); > + u8 current_level = brightness; > + > + return regmap_field_write(led->rfield, current_level); > +} > + > +static int ltc3208_probe(struct i2c_client *client) > +{ > + enum ltc3208_aux_channel aux_channels[LTC3208_NUM_AUX_LEDS]; > + struct ltc3208 *ddata; > + struct regmap *regmap; > + bool disable_rgb_aux4_dropout_signal; > + bool disable_camhl_pin; > + bool set_sub_control_pin; > + int ret; > + u8 reg_val; > + > + regmap = devm_regmap_init_i2c(client, <c3208_regmap_cfg); > + if (IS_ERR(regmap)) > + return dev_err_probe(&client->dev, PTR_ERR(regmap), > + "Failed to initialize regmap\n"); > + > + ddata = devm_kzalloc(&client->dev, sizeof(*ddata), GFP_KERNEL); > + if (!ddata) > + return -ENOMEM; > + > + ddata->regmap = regmap; > + > + disable_camhl_pin = device_property_read_bool(&client->dev, > + "adi,disable-camhl-pin"); > + set_sub_control_pin = > + device_property_read_bool(&client->dev, "adi,cfg-enrgbs-pin"); > + disable_rgb_aux4_dropout_signal = > + device_property_read_bool(&client->dev, > + "adi,disable-rgb-aux4-dropout"); > + > + reg_val = FIELD_PREP(LTC3208_OPT_EN_RGBS, set_sub_control_pin) | > + FIELD_PREP(LTC3208_OPT_DIS_CAMHILO, disable_camhl_pin) | > + FIELD_PREP(LTC3208_OPT_DIS_RGBDROP, > + disable_rgb_aux4_dropout_signal); > + > + ret = regmap_write(regmap, LTC3208_REG_G_OPT, reg_val); [Severity: Medium] Does this unconditional write wipe out the existing CPO bits (bits 7:6)? By using regmap_write() here, any initial hardware configuration done by the bootloader or hardware defaults (like Charge Pump mode) might be permanently erased. Would regmap_update_bits() be safer here to apply only the explicitly configured fields? > + if (ret) > + return dev_err_probe(&client->dev, ret, > + "error writing to options register\n"); > + > + /* Initialize aux channel configurations */ > + for (int i = 0; i < LTC3208_NUM_AUX_LEDS; i++) { > + ret = device_property_match_property_string( > + &client->dev, ltc3208_dt_aux_channels[i], > + ltc3208_aux_opt, LTC3208_NUM_AUX_OPT); > + /* Fallback to default value (AUX) if not found */ > + if (ret == -ENODATA || ret == -EINVAL) > + aux_channels[i] = LTC3208_AUX_CHAN_AUX; > + else if (ret < 0) > + return dev_err_probe(&client->dev, ret, > + "Error reading AUX Channel %d", i); > + else if (ret >= 0) > + aux_channels[i] = ret; > + } > + > + reg_val = FIELD_PREP(LTC3208_AUX1_MASK, aux_channels[0]) | > + FIELD_PREP(LTC3208_AUX2_MASK, aux_channels[1]) | > + FIELD_PREP(LTC3208_AUX3_MASK, aux_channels[2]) | > + FIELD_PREP(LTC3208_AUX4_MASK, aux_channels[3]); > + > + ret = regmap_write(regmap, LTC3208_REG_E_AUX_SELECT, reg_val); > + if (ret) > + return dev_err_probe(&client->dev, ret, > + "error writing to aux channel register.\n"); > + > + device_for_each_child_node_scoped(&client->dev, child) { > + struct ltc3208_led *led; > + struct led_init_data init_data = {}; > + u32 chan; > + > + ret = fwnode_property_read_u32(child, "reg", &chan); > + if (ret) > + return dev_err_probe(&client->dev, ret, > + "Failed to get reg value of LED\n"); > + else if (chan >= LTC3208_NUM_LED_GRPS) > + return dev_err_probe(&client->dev, -EINVAL, > + "%d is an invalid LED ID\n", chan); [Severity: Low] Could this dev_err_probe() use %u instead of %d? The chan variable is an unsigned u32, so %d produces a format string mismatch. > + else if (ddata->leds[chan].client) > + return dev_err_probe(&client->dev, -EINVAL, > + "%d is already registered\n", chan); > + > + led = &ddata->leds[chan]; > + > + led->rfield = > + devm_regmap_field_alloc(&client->dev, ddata->regmap, > + ltc3208_led_reg_field[chan]); > + if (IS_ERR(led->rfield)) > + return dev_err_probe(&client->dev, PTR_ERR(led->rfield), > + "cannot allocate regmap field\n"); > + led->client = client; > + led->channel = chan; > + led->cdev.brightness_set_blocking = ltc3208_led_set_brightness; > + led->cdev.max_brightness = LTC3208_MAX_BRIGHTNESS_4BIT; > + > + if (chan == LTC3208_CHAN_MAIN || chan == LTC3208_CHAN_SUB) > + led->cdev.max_brightness = LTC3208_MAX_BRIGHTNESS_8BIT; > + > + init_data.fwnode = child; > + > + ret = devm_led_classdev_register_ext(&client->dev, &led->cdev, > + &init_data); > + if (ret) > + return dev_err_probe(&client->dev, ret, > + "LED %u Register failed.\n", chan); > + } > + > + return 0; > +} > + > +static const struct of_device_id ltc3208_match_table[] = { > + { .compatible = "adi,ltc3208" }, > + { } > +}; > +MODULE_DEVICE_TABLE(of, ltc3208_match_table); > + > +static const struct i2c_device_id ltc3208_idtable[] = { > + { .name = "ltc3208" }, > + { } > +}; > +MODULE_DEVICE_TABLE(i2c, ltc3208_idtable); > + > +static struct i2c_driver ltc3208_driver = { > + .driver = { > + .name = "ltc3208", > + .of_match_table = ltc3208_match_table, > + }, > + .id_table = ltc3208_idtable, > + .probe = ltc3208_probe, > +}; > +module_i2c_driver(ltc3208_driver); > + > +MODULE_LICENSE("GPL"); > +MODULE_AUTHOR("Jan Carlo Roleda <[email protected]>"); > +MODULE_DESCRIPTION("LTC3208 LED Driver"); > > -- > 2.43.0 > -- Lee Jones