drivers: led: is31fl319x add is31fl3197 support

Add the registers and the like to the .c file plus add a Kconf file
plus bindings.

Updated sample: to also check for is31fl3197 boards

Signed-off-by: Kurt Eckhardt <[email protected]>

Author: KurtE

drivers/led/Kconfig.is31fl319x

@@ -4,8 +4,9 @@
 config IS31FL319X
 	bool "IS31FL319X LED driver"
 	default y
-	depends on DT_HAS_ISSI_IS31FL3194_ENABLED
+	depends on DT_HAS_ISSI_IS31FL3194_ENABLED || DT_HAS_ISSI_IS31FL3197_ENABLED
 	select I2C
 	help
 	  Enable LED driver for Lumissil Microsystems (a division of ISSI)
 	  IS31FL3194. This chip supports one RGB LED or 3 independent LEDs.
+	  IS31FL3197. This chip supports 4 LEDs.

drivers/led/is31fl319x.c

@@ -21,9 +21,15 @@
 #include <zephyr/dt-bindings/led/led.h>
 
 LOG_MODULE_REGISTER(is31fl319x, CONFIG_LED_LOG_LEVEL);
+
+/* define features that are specific subset of supported devices */
 #define REG_NOT_DEFINED 0xff
 
+#define FEATURE_ID_IS_ADDR	0x01	/* The id is the bus address */
+#define FEATURE_SET_CURRENT	0x02	/* the device supports setting current limits */
+
 struct is31f1319x_model {
+	const uint8_t features;
 	const uint8_t prod_id_reg;
 	const uint8_t shutdown_reg;
 	const uint8_t conf_reg;
@@ -38,7 +44,17 @@ struct is31f1319x_model {
 	const uint8_t led_channels[];
 };
 
+struct is31fl319x_config {
+	struct i2c_dt_spec bus;
+	uint8_t channel_count;
+	uint8_t num_leds;
+	const struct led_info *led_infos;
+	const uint8_t *current_limits;
+	const struct is31f1319x_model *model;
+};
 
+#ifdef CONFIG_DT_HAS_ISSI_IS31FL3194_ENABLED
+/* IS31FL3194 model registers and values */
 #define IS31FL3194_PROD_ID_REG		0x00
 #define IS31FL3194_CONF_REG		0x01
 #define IS31FL3194_CURRENT_REG		0x03
@@ -54,6 +70,8 @@ struct is31f1319x_model {
 #define IS31FL3194_CHANNEL_COUNT 3
 
 static const struct is31f1319x_model is31f13194_model = {
+	.features = FEATURE_SET_CURRENT,
+
 	/* register indexes */
 	.prod_id_reg = IS31FL3194_PROD_ID_REG,
 	.shutdown_reg = REG_NOT_DEFINED,
@@ -69,15 +87,46 @@ static const struct is31f1319x_model is31f13194_model = {
 
 	/* channel output registers */
 	.led_channels = {IS31FL3194_OUT1_REG, IS31FL3194_OUT2_REG, IS31FL3194_OUT3_REG}};
+#endif
 
-struct is31fl319x_config {
-	struct i2c_dt_spec bus;
-	uint8_t channel_count;
-	uint8_t num_leds;
-	const struct led_info *led_infos;
-	const uint8_t *current_limits;
-	const struct is31f1319x_model *regs;
+#ifdef CONFIG_DT_HAS_ISSI_IS31FL3197_ENABLED
+/* IS31FL3197 model registers and values */
+#define IS31FL3197_PROD_ID_REG		0x00
+#define IS31FL3197_SHUTDOWN_REG		0x01
+#define IS31FL3197_OPER_CONFIG_REG	0x02
+#define IS31FL3197_OUT1_REG		0x10
+#define IS31FL3197_OUT2_REG		0x11
+#define IS31FL3197_OUT3_REG		0x12
+#define IS31FL3197_OUT4_REG		0x13
+#define IS31FL3197_UPDATE_REG		0x2b
+
+#define IS31FL3197_SHUTDOWN_REG_VAL	0xf1 /* enable all channels */
+#define IS31FL3197_OPER_CONFIG_REG_VAL	0xff /* set all to current level */
+#define IS31FL3197_UPDATE_VAL		0xc5
+
+#define IS31FL3197_CHANNEL_COUNT 4
+
+static const struct is31f1319x_model is31f13197_model = {
+	.features = FEATURE_ID_IS_ADDR,
+
+	/* register indexes */
+	.prod_id_reg = IS31FL3197_PROD_ID_REG,
+	.shutdown_reg = IS31FL3197_SHUTDOWN_REG,
+	.conf_reg = IS31FL3197_OPER_CONFIG_REG,
+	.current_reg = REG_NOT_DEFINED,
+	.update_reg = IS31FL3197_UPDATE_REG,
+
+	/* values for those registers */
+	.prod_id_val = 0xff,
+	.shutdown_reg_val = IS31FL3197_SHUTDOWN_REG_VAL,
+	.conf_enable = IS31FL3197_OPER_CONFIG_REG_VAL,
+	.update_val = IS31FL3197_UPDATE_VAL,
+
+	/* channel output registers */
+	.led_channels = {IS31FL3197_OUT1_REG, IS31FL3197_OUT2_REG, IS31FL3197_OUT3_REG,
+			 IS31FL3197_OUT4_REG}
 };
+#endif
 
 static const struct led_info *is31fl319x_led_to_info(const struct is31fl319x_config *config,
 						     uint32_t led)
@@ -123,7 +172,7 @@ static int is31fl319x_write_channels(const struct device *dev, uint32_t start_ch
 				     uint32_t num_channels, const uint8_t *buf)
 {
 	const struct is31fl319x_config *config = dev->config;
-	const struct is31f1319x_model *regs = config->regs;
+	const struct is31f1319x_model *model = config->model;
 	int ret;
 	int i;
 
@@ -132,7 +181,7 @@ static int is31fl319x_write_channels(const struct device *dev, uint32_t start_ch
 	}
 
 	for (i = 0; i < num_channels; i++) {
-		ret = i2c_reg_write_byte_dt(&config->bus, regs->led_channels[i + start_channel],
+		ret = i2c_reg_write_byte_dt(&config->bus, model->led_channels[i + start_channel],
 					    buf[i]);
 		if (ret != 0) {
 			break;
@@ -141,8 +190,8 @@ static int is31fl319x_write_channels(const struct device *dev, uint32_t start_ch
 
 	if (ret == 0) {
 		ret = i2c_reg_write_byte_dt(&config->bus,
-					    regs->update_reg,
-					    regs->update_val);
+					    model->update_reg,
+					    model->update_val);
 	}
 
 	if (ret != 0) {
@@ -176,7 +225,7 @@ static int is31fl319x_set_brightness(const struct device *dev, uint32_t led, uin
 {
 	const struct is31fl319x_config *config = dev->config;
 	const struct led_info *info = is31fl319x_led_to_info(config, led);
-	const struct is31f1319x_model *regs = config->regs;
+	const struct is31f1319x_model *model = config->model;
 	uint8_t channel_start;
 
 	int ret = 0;
@@ -194,11 +243,11 @@ static int is31fl319x_set_brightness(const struct device *dev, uint32_t led, uin
 
 	channel_start = is31fl319x_map_led_to_start_channel(config, led);
 
-	ret = i2c_reg_write_byte_dt(&config->bus, regs->led_channels[channel_start], value);
+	ret = i2c_reg_write_byte_dt(&config->bus, model->led_channels[channel_start], value);
 	if (ret == 0) {
 		ret = i2c_reg_write_byte_dt(&config->bus,
-					    regs->update_reg,
-					    regs->update_val);
+					    model->update_reg,
+					    model->update_val);
 	}
 
 	if (ret != 0) {
@@ -232,8 +281,8 @@ static int is31fl319x_init(const struct device *dev)
 {
 	const struct is31fl319x_config *config = dev->config;
 	const struct led_info *info = NULL;
-	const struct is31f1319x_model *regs = config->regs;
-	int i, j, ret;
+	const struct is31f1319x_model *model = config->model;
+	int ret;
 	uint8_t prod_id, band, channel;
 	uint8_t current_reg = 0;
 	int i, j;
@@ -248,20 +297,30 @@ static int is31fl319x_init(const struct device *dev)
 		return -ENODEV;
 	}
 
-	ret = i2c_reg_read_byte_dt(&config->bus, regs->prod_id_reg, &prod_id);
+	ret = i2c_reg_read_byte_dt(&config->bus, model->prod_id_reg, &prod_id);
 	if (ret != 0) {
 		LOG_ERR("%s: failed to read product ID", dev->name);
 		return ret;
 	}
 
-	if (prod_id != regs->prod_id_val) {
-		LOG_ERR("%s: invalid product ID 0x%02x (expected 0x%02x)", dev->name, prod_id,
-			regs->prod_id_val);
-		return -ENODEV;
+
+	if (model->features & FEATURE_ID_IS_ADDR) {
+		/* The product ID (8 bit) should be the I2C address(7 bit) */
+		if (prod_id != (config->bus.addr << 1)) {
+			LOG_ERR("%s: invalid product ID 0x%02x (expected 0x%02x)", dev->name,
+				prod_id, config->bus.addr << 1);
+			return -ENODEV;
+		}
+	} else {
+		if (prod_id != model->prod_id_val) {
+			LOG_ERR("%s: invalid product ID 0x%02x (expected 0x%02x)", dev->name,
+				prod_id, model->prod_id_val);
+			return -ENODEV;
+		}
 	}
 
 	/* calc current limit register value */
-	if (regs->current_reg != REG_NOT_DEFINED) {
+	if (model->features & FEATURE_SET_CURRENT) {
 		channel = 0;
 		for (i = 0; i < config->num_leds; i++) {
 			info = &config->led_infos[i];
@@ -273,15 +332,24 @@ static int is31fl319x_init(const struct device *dev)
 			}
 		}
 
-		ret = i2c_reg_write_byte_dt(&config->bus, regs->current_reg, current_reg);
+		ret = i2c_reg_write_byte_dt(&config->bus, model->current_reg, current_reg);
 		if (ret != 0) {
 			LOG_ERR("%s: failed to set current limit", dev->name);
 			return ret;
 		}
 	}
+	if (model->shutdown_reg != REG_NOT_DEFINED) {
+		ret = i2c_reg_write_byte_dt(&config->bus, model->shutdown_reg,
+					    model->shutdown_reg_val);
+		if (ret != 0) {
+			LOG_ERR("%s: failed to set current limit", dev->name);
+			return ret;
+		}
+	}
+
 	/* enable device */
-	return i2c_reg_write_byte_dt(&config->bus, regs->conf_reg,
-				     regs->conf_enable);
+	return i2c_reg_write_byte_dt(&config->bus, model->conf_reg,
+				     model->conf_enable);
 }
 
 static DEVICE_API(led, is31fl319x_led_api) = {
@@ -305,7 +373,7 @@ static DEVICE_API(led, is31fl319x_led_api) = {
 #define LED_CURRENT(led_node_id)						\
 	DT_PROP(led_node_id, current_limit),
 
-#define IS31FL319X_DEVICE(n, id, nchannels, pregs)				\
+#define IS31FL319X_DEVICE(n, id, nchannels, pmodel)				\
 										\
 	DT_INST_FOREACH_CHILD(n, COLOR_MAPPING)					\
 										\
@@ -323,12 +391,21 @@ static DEVICE_API(led, is31fl319x_led_api) = {
 		.num_leds = ARRAY_SIZE(is31fl319##id##_leds_##n),		\
 		.led_infos = is31fl319##id##_leds_##n,				\
 		.current_limits = is31fl319##id##_currents_##n,			\
-		.regs = pregs,							\
+		.model = pmodel,						\
 	};									\
 	DEVICE_DT_INST_DEFINE(n, &is31fl319x_init, NULL, NULL,			\
 			      &is31fl319##id##_config_##n, POST_KERNEL,		\
 			      CONFIG_LED_INIT_PRIORITY, &is31fl319x_led_api);
 
+#ifdef CONFIG_DT_HAS_ISSI_IS31FL3194_ENABLED
 #define DT_DRV_COMPAT issi_is31fl3194
 DT_INST_FOREACH_STATUS_OKAY_VARGS(IS31FL319X_DEVICE, 4, IS31FL3194_CHANNEL_COUNT,
 				  &is31f13194_model)
+#endif
+
+#ifdef CONFIG_DT_HAS_ISSI_IS31FL3197_ENABLED
+#undef DT_DRV_COMPAT
+#define DT_DRV_COMPAT issi_is31fl3197
+DT_INST_FOREACH_STATUS_OKAY_VARGS(IS31FL319X_DEVICE, 7, IS31FL3197_CHANNEL_COUNT,
+				  &is31f13197_model)
+#endif

dts/bindings/led/issi,is31fl3197.yaml

@@ -0,0 +1,80 @@
+# Copyright (c) 2024 Arduino SA
+# SPDX-License-Identifier: Apache-2.0
+
+description: |
+  IS31FL3197 4-channel LED driver with programmable pattern sequencing
+
+  This driver supports single-channel and RGB LEDs. For single channel LEDs,
+  the led_set_brightness() API can be used to set the brightness of each LED.
+  For RGB LEDs, the led_set_color() API can be used to set the red, green and
+  blue components; the driver takes care of routing to the outputs described
+  by the color-mapping property.
+
+  The LED_SHELL application can be used for testing.
+
+  The following shows configuration for Arduino Giga Display shield
+
+  This driver supports single-channel and RGB and maybe RGBW LEDs. For single
+  channel LEDs, the led_set_brightness() API can be used to set the brightness
+  of each LED. For RGB LEDs, the led_set_color() API can be used to set the red,
+  green and blue and white components; the driver takes care of routing to the
+  outputs described by the color-mapping property.
+
+  The LED_SHELL application can be used for testing.
+
+  The following defines a single RGB LED in the is31fl3197 DT node:
+
+    is31fl3197@50 {
+      compatible = "issi,is31fl3197";
+      reg = <0x50>;
+
+      led_0 {
+        label = "RGB LED";
+        color-mapping =
+          <LED_COLOR_ID_RED>,
+          <LED_COLOR_ID_GREEN>,
+          <LED_COLOR_ID_BLUE>;
+      };
+    };
+
+  The following example defines three single-channel LEDs in the is31fl3197 DT node:
+
+    is31fl3197@50 {
+      compatible = "issi,is31fl3197";
+      reg = <0x50>;
+
+      led_0 {
+        label = "RED LED";
+        color-mapping = <LED_COLOR_ID_RED>;
+      };
+
+      led_1 {
+        label = "GREEN LED";
+        color-mapping = <LED_COLOR_ID_GREEN>;
+      };
+
+      led_2 {
+        label = "BLUE LED";
+        color-mapping = <LED_COLOR_ID_BLUE>;
+      };
+    };
+
+compatible: "issi,is31fl3197"
+
+include: ["i2c-device.yaml", "led-controller.yaml"]
+
+child-binding:
+  properties:
+    label:
+      required: true
+
+    color-mapping:
+      required: true
+
+    current-limit:
+      type: int
+      default: 10
+      enum:
+        - 10
+      description: |
+        The current limit for the LED in mA.

samples/drivers/led/is31fl319x/README.rst

@@ -25,22 +25,15 @@ Building and Running
 
 This sample can be built and executed on an Arduino Nicla Sense ME, or on
 any board where the devicetree has an I2C device node with compatible
-:dtcompatible:`issi,is31fl3194` enabled, along with the relevant bus
-controller node also being enabled.
+:dtcompatible:`issi,is31fl3194` or :dtcompatible:`issi,is31fl3197` with the
+relevant bus controller node also being enabled.
 
 .. zephyr-app-commands::
    :zephyr-app: samples/drivers/led/is31fl319x
    :board: arduino_nicla_sense_me
    :goals: build flash
    :compact:
 
-.. zephyr-app-commands::
-   :zephyr-app: samples/drivers/led/is31fl319x
-   :board: arduino_giga_r1//m7
-   :shield: arduino_giga_display_shield
-   :goals: build flash
-   :compact:
-
 After flashing, the LED starts to switch colors and messages with the current
 LED color are printed on the console. If a runtime error occurs, the sample
 exits without printing to the console.