drivers: led: is31fl319x add is31fl3197 support

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

Updated example sketch:
It manually computes which channel maps to red, green and blue and then
uses those indexes to map the table of colors to the right channels.

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

Author: KurtE

drivers/led/CMakeLists.txt

@@ -7,6 +7,7 @@ zephyr_library()
 # zephyr-keep-sorted-start
 zephyr_library_sources_ifdef(CONFIG_HT16K33 ht16k33.c)
 zephyr_library_sources_ifdef(CONFIG_IS31FL3194 is31fl319x.c)
+zephyr_library_sources_ifdef(CONFIG_IS31FL3197 is31fl319x.c)
 zephyr_library_sources_ifdef(CONFIG_IS31FL3216A is31fl3216a.c)
 zephyr_library_sources_ifdef(CONFIG_IS31FL3733 is31fl3733.c)
 zephyr_library_sources_ifdef(CONFIG_LEDS_GROUP_MULTICOLOR leds_group_multicolor.c)

drivers/led/Kconfig

@@ -32,6 +32,7 @@ source "drivers/led/Kconfig.dac"
 source "drivers/led/Kconfig.gpio"
 source "drivers/led/Kconfig.ht16k33"
 source "drivers/led/Kconfig.is31fl3194"
+source "drivers/led/Kconfig.is31fl3197"
 source "drivers/led/Kconfig.is31fl3216a"
 source "drivers/led/Kconfig.is31fl3733"
 source "drivers/led/Kconfig.leds-group-multicolor"

drivers/led/Kconfig.is31fl3197

@@ -0,0 +1,11 @@
+# Copyright (c) 2024 Arduino SA
+# SPDX-License-Identifier: Apache-2.0
+
+config IS31FL3197
+	bool "IS31FL3197 LED driver"
+	default y
+	depends on DT_HAS_ISSI_IS31FL3197_ENABLED
+	select I2C
+	help
+	  Enable LED driver for Lumissil Microsystems (a division of ISSI)
+	  IS31FL3197. This chip supports one RGB LED or 4 independent LEDs.

drivers/led/is31fl319x.c

@@ -38,7 +38,16 @@ 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 *regs;
+};
 
+/* IS31FL3194 model registers and values */
 #define IS31FL3194_PROD_ID_REG		0x00
 #define IS31FL3194_CONF_REG		0x01
 #define IS31FL3194_CURRENT_REG		0x03
@@ -53,6 +62,7 @@ struct is31f1319x_model {
 
 #define IS31FL3194_CHANNEL_COUNT 3
 
+#ifdef CONFIG_IS31FL3194
 static const struct is31f1319x_model is31f13194_model = {
 	/* register indexes */
 	.prod_id_reg = IS31FL3194_PROD_ID_REG,
@@ -69,15 +79,44 @@ static const struct is31f1319x_model is31f13194_model = {
 
 	/* channel output registers */
 	.led_channels = {IS31FL3194_OUT1_REG, IS31FL3194_OUT2_REG, IS31FL3194_OUT3_REG}};
+#endif
+
+/* 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
+
+#ifdef CONFIG_IS31FL3197
+static const struct is31f1319x_model is31f13197_model = {
+	/* 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,
 
-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;
+	/* 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)
@@ -124,7 +163,7 @@ static int is31fl319x_write_channels(const struct device *dev, uint32_t start_ch
 {
 	const struct is31fl319x_config *config = dev->config;
 	const struct is31f1319x_model *regs = config->regs;
-	int ret;
+	int ret = 0;
 
 	if ((start_channel + num_channels) > config->channel_count) {
 		return -ENOTSUP;
@@ -250,10 +289,20 @@ static int is31fl319x_init(const struct device *dev)
 		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 (regs->prod_id_val != 0xff) {
+		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;
+		}
+	} else {
+
+		/* 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;
+		}
 	}
 
 	/* calc current limit register value */
@@ -275,6 +324,15 @@ static int is31fl319x_init(const struct device *dev)
 			return ret;
 		}
 	}
+	if (regs->shutdown_reg != REG_NOT_DEFINED) {
+		ret = i2c_reg_write_byte_dt(&config->bus, regs->shutdown_reg,
+					    regs->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);
@@ -329,3 +387,8 @@ static DEVICE_API(led, is31fl319x_led_api) = {
 #define DT_DRV_COMPAT issi_is31fl3194
 DT_INST_FOREACH_STATUS_OKAY_VARGS(IS31FL319X_DEVICE, 4, IS31FL3194_CHANNEL_COUNT,
 				  &is31f13194_model)
+#undef DT_DRV_COMPAT
+#define DT_DRV_COMPAT issi_is31fl3197
+DT_INST_FOREACH_STATUS_OKAY_VARGS(IS31FL319X_DEVICE, 7, IS31FL3194_CHANNEL_COUNT,
+				  &is31f13197_model)
+#undef DT_DRV_COMPAT

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

@@ -1,28 +1,45 @@
-.. zephyr:code-sample:: is31fl3194
+.. zephyr:code-sample:: is31fl319x
    :name: IS31FL3194 RGB LED
    :relevant-api: led_interface
 
-   Cycle colors on an RGB LED connected to the IS31FL3194 using the LED API.
+   Cycle colors on an RGB LED connected to the IS31FL3194 or IS31FL3197
+   using the LED API.
 
 Overview
 ********
 
-This sample cycles several colors on an RGB LED forever using the LED API.
+This sample first looks through the color table to map which channels
+map to Red, Green and Blue.  It then fade in and out each of these colors
+one at a time.  It then cycles through several colors on an RGB LED
+forever using the LED API.  For each of these colors it maps the Red,
+Green and Blue colors to the appropriate channels.
 
 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` long with the relevant bus controller
+node also being enabled.
+
+likewise it can be build for an Arduino Giga with the Giga Display shield,
+or on and board where the devicetree has an I2C device with compatible
+:dtcompatible:`issi,is31fl3197` enabled along with the relevant bus controller
+node also being enabled.
 
 .. zephyr-app-commands::
-   :zephyr-app: samples/drivers/led/is31fl3194
+   :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.

samples/drivers/led/is31fl319x/src/main.c

@@ -7,6 +7,7 @@
 #include <stdio.h>
 #include <zephyr/kernel.h>
 #include <zephyr/drivers/led.h>
+#include <zephyr/dt-bindings/led/led.h>
 
 /* 1000 msec = 1 sec */
 #define SLEEP_TIME_MS   1000
@@ -29,22 +30,70 @@ static const struct color_data color_sequence[] = {
 	{ 0xF4, 0x79, 0x20, "Orange" },
 };
 
+static const uint8_t one_color[] = {0x3f, 0x7f, 0xbf, 0xff, 0xbf, 0x7f, 0x3f, 0};
+
 /*
- * A build error on this line means your board is unsupported.
+ * A build error on these lines means your board is unsupported.
  */
+#ifdef CONFIG_IS31FL3194
 const struct device *led = DEVICE_DT_GET_ANY(issi_is31fl3194);
+#elif defined(CONFIG_IS31FL3197)
+const struct device *led = DEVICE_DT_GET_ANY(issi_is31fl3197);
+#endif
 
 int main(void)
 {
 	int ret;
 	int i = 0;
+	int j = 0;
+	uint8_t color_index[3]= {0, 0, 0}; /* R G B */
+	uint8_t colors[3] = {0, 0, 0};
+	const struct led_info *info;
 
 	if (!device_is_ready(led)) {
 		return 0;
 	}
 
+	/* find the Red, Green, and blue color indexes */
+	ret = led_get_info(led, 0, &info);
+	if (ret < 0) {
+		printk("Failed to retrieve LED info\n");
+		return 0;
+	}
+	/* generate color mapping table for this device */
+	for (i = 0; i < info->num_colors; i++) {
+		switch (info->color_mapping[i]) {
+		case LED_COLOR_ID_RED:
+			color_index[0] = i;
+			break;
+		case LED_COLOR_ID_GREEN:
+			color_index[1] = i;
+			break;
+		case LED_COLOR_ID_BLUE:
+			color_index[2] = i;
+			break;
+		}
+	}
+
+	printk("Color indexes: R:%u G:%u B:%u\n", color_index[0],
+		color_index[1], color_index[2]);
+
+	/* lets try to verify the indexes */
+	ret = led_set_color(led, 0, 3, colors);
+	for (i=0; i < 3; i++) {
+		for (j = 0; j < ARRAY_SIZE(one_color); j++) {
+			led_set_channel(led, color_index[i], one_color[j]);
+			k_msleep(SLEEP_TIME_MS);
+		}
+	}
+
+	i = 0;
 	while (1) {
-		ret = led_set_color(led, 0, 3, &(color_sequence[i].r));
+		/* map the colors */
+		colors[color_index[0]] = color_sequence[i].r;
+		colors[color_index[1]] = color_sequence[i].g;
+		colors[color_index[2]] = color_sequence[i].b;
+		ret = led_set_color(led, 0, 3, colors);
 		if (ret < 0) {
 			return 0;
 		}