From patchwork Fri Jan 21 14:01:49 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Florian Eckert X-Patchwork-Id: 534188 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 73B90C4332F for ; Fri, 21 Jan 2022 14:02:10 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1380898AbiAUOCH (ORCPT ); Fri, 21 Jan 2022 09:02:07 -0500 Received: from mxout70.expurgate.net ([194.37.255.70]:54725 "EHLO mxout70.expurgate.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1380888AbiAUOCG (ORCPT ); Fri, 21 Jan 2022 09:02:06 -0500 Received: from [127.0.0.1] (helo=localhost) by relay.expurgate.net with smtp (Exim 4.92) (envelope-from ) id 1nAuUG-0007fz-J8; Fri, 21 Jan 2022 15:01:56 +0100 Received: from [195.243.126.94] (helo=securemail.tdt.de) by relay.expurgate.net with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1nAuUF-0001nb-Ow; Fri, 21 Jan 2022 15:01:55 +0100 Received: from securemail.tdt.de (localhost [127.0.0.1]) by securemail.tdt.de (Postfix) with ESMTP id 609A224004B; Fri, 21 Jan 2022 15:01:55 +0100 (CET) Received: from mail.dev.tdt.de (unknown [10.2.4.42]) by securemail.tdt.de (Postfix) with ESMTP id D4E73240040; Fri, 21 Jan 2022 15:01:54 +0100 (CET) Received: from localhost.localdomain (unknown [10.2.3.40]) by mail.dev.tdt.de (Postfix) with ESMTPSA id B98FA247F9; Fri, 21 Jan 2022 15:01:53 +0100 (CET) From: Florian Eckert To: pavel@ucw.cz, robh+dt@kernel.org, andy.shevchenko@gmail.com Cc: Eckert.Florian@googlemail.com, linux-kernel@vger.kernel.org, linux-leds@vger.kernel.org, devicetree@vger.kernel.org Subject: [PATCH v4 1/2] leds: ktd20xx: Extension of the KTD20xx family of LED drivers from Kinetic Date: Fri, 21 Jan 2022 15:01:49 +0100 Message-ID: <20220121140150.1729-2-fe@dev.tdt.de> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20220121140150.1729-1-fe@dev.tdt.de> References: <20220121140150.1729-1-fe@dev.tdt.de> MIME-Version: 1.0 X-purgate-ID: 151534::1642773716-000044EC-66783DF6/0/0 X-purgate: clean X-purgate-type: clean Precedence: bulk List-ID: X-Mailing-List: linux-leds@vger.kernel.org Introducing the KTD2061/58/59/60 RGB LED drivers. The difference in these are the address numbers on the I2C bus that the device listens to. All KT20xx units can drive up to 12 LEDs. Due to the hardware limitation, we can only set 7 colors and the color black (LED off) for each LED independently and not the full RGB range. This is because the chip only has two color registers. To control the LEDs independently, the chip has to be configured in a special way. Color register 0 must be loaded with the current value 0mA, and color register 1 must be loaded with the value 'kinetic,led-current' from the device tree node. If the property is omitted, the register is loaded with the default value (0x28 = 5mA). To select a color for an LED, a combination must be written to the color selection register of that LED. This range for selecting the value is 3 bits wide (RGB). A '0' in any of the bits uses color register '0' and a '1' uses color register '1'. So we could choose the following combination for each LED: R G B 0 0 0 = Black (off) 0 0 1 = Blue 0 1 0 = green 0 1 1 = Cyan 1 0 0 = Red 1 0 1 = Magenta 1 1 0 = Yellow 1 1 1 = White Signed-off-by: Florian Eckert --- MAINTAINERS | 6 + drivers/leds/Kconfig | 12 + drivers/leds/Makefile | 1 + drivers/leds/leds-ktd20xx.c | 582 ++++++++++++++++++++++++++++++++++++ 4 files changed, 601 insertions(+) create mode 100644 drivers/leds/leds-ktd20xx.c diff --git a/MAINTAINERS b/MAINTAINERS index a58544f7b699..04d68985d348 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -10739,6 +10739,12 @@ S: Maintained F: Documentation/devicetree/bindings/leds/backlight/kinetic,ktd253.yaml F: drivers/video/backlight/ktd253-backlight.c +KTD20XX LED CONTROLLER DRIVER +M: Florian Eckert +L: linux-leds@vger.kernel.org +S: Maintained +F: drivers/leds/leds-ktd20xx.c + KTEST M: Steven Rostedt M: John Hawley diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig index 6090e647daee..a96e6bf7918b 100644 --- a/drivers/leds/Kconfig +++ b/drivers/leds/Kconfig @@ -157,6 +157,18 @@ config LEDS_EL15203000 To compile this driver as a module, choose M here: the module will be called leds-el15203000. +config LEDS_KTD20XX + tristate "LED Support for KTD2061/58/59/60 LED driver chip" + depends on LEDS_CLASS && I2C + depends on LEDS_CLASS_MULTICOLOR + select REGMAP_I2C + help + If you say yes here you get support for the Kinetic + KTD2061, KTD2058, KTD2059 and KTD2060 LED driver. + + To compile this driver as a module, choose M here: the + module will be called leds-ktd20xx. + config LEDS_TURRIS_OMNIA tristate "LED support for CZ.NIC's Turris Omnia" depends on LEDS_CLASS_MULTICOLOR diff --git a/drivers/leds/Makefile b/drivers/leds/Makefile index e58ecb36360f..5a86e72ea722 100644 --- a/drivers/leds/Makefile +++ b/drivers/leds/Makefile @@ -34,6 +34,7 @@ obj-$(CONFIG_LEDS_IP30) += leds-ip30.o obj-$(CONFIG_LEDS_IPAQ_MICRO) += leds-ipaq-micro.o obj-$(CONFIG_LEDS_IS31FL319X) += leds-is31fl319x.o obj-$(CONFIG_LEDS_IS31FL32XX) += leds-is31fl32xx.o +obj-${CONFIG_LEDS_KTD20XX} += leds-ktd20xx.o obj-$(CONFIG_LEDS_LM3530) += leds-lm3530.o obj-$(CONFIG_LEDS_LM3532) += leds-lm3532.o obj-$(CONFIG_LEDS_LM3533) += leds-lm3533.o diff --git a/drivers/leds/leds-ktd20xx.c b/drivers/leds/leds-ktd20xx.c new file mode 100644 index 000000000000..7e2a1a603b50 --- /dev/null +++ b/drivers/leds/leds-ktd20xx.c @@ -0,0 +1,582 @@ +// SPDX-License-Identifier: GPL-2.0-only +/* + * LEDs driver for the Kinetic KDT20xx device + * + * Copyright (C) 2021 TDT AG Florian Eckert + * + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +/* I2C Register Map */ +#define KTD20XX_ID 0x00 +#define KTD20XX_MONITOR 0x01 +#define KTD20XX_CONTROL 0x02 + +/* Color0 Configuration Registers */ +#define KTD20XX_IRED0 0x03 +#define KTD20XX_IGRN0 0x04 +#define KTD20XX_IBLU0 0x05 + +/* Color1 Configuration Registers */ +#define KTD20XX_IRED1 0x06 +#define KTD20XX_IGRN1 0x07 +#define KTD20XX_IBLU1 0x08 + +/* Selection Configuration Register */ +#define KTD20XX_ISELA12 0x09 +#define KTD20XX_ISELA34 0x0A +#define KTD20XX_ISELB12 0x0B +#define KTD20XX_ISELB34 0x0C +#define KTD20XX_ISELC12 0x0D +#define KTD20XX_ISELC34 0x0E + +#define KTD20XX_MAX_LEDS 12 +#define KTD20XX_LED_CHANNELS 3 + +enum ktd20xx_led_number { + /* ISELA12 */ + RGB_A1, + RGB_A2, + /* ISELA34 */ + RGB_A3, + RGB_A4, + /* ISELB12 */ + RGB_B1, + RGB_B2, + /* ISELB34 */ + RGB_B3, + RGB_B4, + /* ISELC12 */ + RGB_C1, + RGB_C2, + /* ISELC34 */ + RGB_C3, + RGB_C4, +}; + +enum ktd20xx_control_mode { + CONTROL_MODE_OFF, + CONTROL_MODE_NIGHT, + CONTROL_MODE_NORMAL, + CONTROL_MODE_RESET, +}; + +static const struct reg_default ktd20xx_reg_defs[] = { + /* Color0 Configuration Registers */ + {KTD20XX_IRED0, 0x28}, + {KTD20XX_IGRN0, 0x28}, + {KTD20XX_IBLU0, 0x28}, + /* Color1 Configuration Registers */ + {KTD20XX_IRED1, 0x60}, + {KTD20XX_IGRN1, 0x60}, + {KTD20XX_IBLU1, 0x60}, + /* Selection Configuration Register */ + {KTD20XX_ISELA12, 0x00}, + {KTD20XX_ISELA34, 0x00}, + {KTD20XX_ISELB12, 0x00}, + {KTD20XX_ISELB34, 0x00}, + {KTD20XX_ISELC12, 0x00}, + {KTD20XX_ISELC34, 0x00} +}; + +/* Chip values */ +static const struct reg_field kt20xx_control_mode = REG_FIELD(KTD20XX_CONTROL, 6, 7); +static const struct reg_field kt20xx_faderate = REG_FIELD(KTD20XX_CONTROL, 0, 2); +static const struct reg_field kt20xx_vendor = REG_FIELD(KTD20XX_ID, 5, 7); +static const struct reg_field kt20xx_chip_id = REG_FIELD(KTD20XX_ID, 0, 4); +static const struct reg_field kt20xx_chip_rev = REG_FIELD(KTD20XX_MONITOR, 4, 7); + +/* ISELA1 and ISELA2 */ +static const struct reg_field kt20xx_a1_select = REG_FIELD(KTD20XX_ISELA12, 4, 6); +static const struct reg_field kt20xx_a1_enable = REG_FIELD(KTD20XX_ISELA12, 7, 7); +static const struct reg_field kt20xx_a2_select = REG_FIELD(KTD20XX_ISELA12, 0, 2); +static const struct reg_field kt20xx_a2_enable = REG_FIELD(KTD20XX_ISELA12, 3, 3); + +/* ISELA3 and ISELA4 */ +static const struct reg_field kt20xx_a3_select = REG_FIELD(KTD20XX_ISELA34, 4, 6); +static const struct reg_field kt20xx_a3_enable = REG_FIELD(KTD20XX_ISELA34, 7, 7); +static const struct reg_field kt20xx_a4_select = REG_FIELD(KTD20XX_ISELA34, 0, 2); +static const struct reg_field kt20xx_a4_enable = REG_FIELD(KTD20XX_ISELA34, 3, 3); + +/* ISELB1 and ISELB2 */ +static const struct reg_field kt20xx_b1_select = REG_FIELD(KTD20XX_ISELB12, 4, 6); +static const struct reg_field kt20xx_b1_enable = REG_FIELD(KTD20XX_ISELB12, 7, 7); +static const struct reg_field kt20xx_b2_select = REG_FIELD(KTD20XX_ISELB12, 0, 2); +static const struct reg_field kt20xx_b2_enable = REG_FIELD(KTD20XX_ISELB12, 3, 3); + +/* ISELB3 and ISELB4 */ +static const struct reg_field kt20xx_b3_select = REG_FIELD(KTD20XX_ISELB34, 4, 6); +static const struct reg_field kt20xx_b3_enable = REG_FIELD(KTD20XX_ISELB34, 7, 7); +static const struct reg_field kt20xx_b4_select = REG_FIELD(KTD20XX_ISELB34, 0, 2); +static const struct reg_field kt20xx_b4_enable = REG_FIELD(KTD20XX_ISELB34, 3, 3); + +/* ISELC1 and ISELC2 */ +static const struct reg_field kt20xx_c1_select = REG_FIELD(KTD20XX_ISELC12, 4, 6); +static const struct reg_field kt20xx_c1_enable = REG_FIELD(KTD20XX_ISELC12, 7, 7); +static const struct reg_field kt20xx_c2_select = REG_FIELD(KTD20XX_ISELC12, 0, 2); +static const struct reg_field kt20xx_c2_enable = REG_FIELD(KTD20XX_ISELC12, 3, 3); + +/* ISELC3 and ISELC4 */ +static const struct reg_field kt20xx_c3_select = REG_FIELD(KTD20XX_ISELC34, 4, 6); +static const struct reg_field kt20xx_c3_enable = REG_FIELD(KTD20XX_ISELC34, 7, 7); +static const struct reg_field kt20xx_c4_select = REG_FIELD(KTD20XX_ISELC34, 0, 2); +static const struct reg_field kt20xx_c4_enable = REG_FIELD(KTD20XX_ISELC34, 3, 3); + +static const struct regmap_range ktd20xx_volatile_ranges = { + .range_min = KTD20XX_ID, + .range_max = KTD20XX_CONTROL, +}; + +static const struct regmap_access_table ktd20xx_volatile_table = { + .yes_ranges = &ktd20xx_volatile_ranges, + .n_yes_ranges = 1, +}; + +static const struct regmap_range ktd20xx_readable_ranges = { + .range_min = KTD20XX_ID, + .range_max = KTD20XX_MONITOR, +}; + +static const struct regmap_access_table ktd20xx_readable_table = { + .yes_ranges = &ktd20xx_readable_ranges, + .n_yes_ranges = 1, +}; + +static const struct regmap_config ktd20xx_regmap_config = { + .name = "ktd20xx_regmap", + .reg_bits = 8, + .val_bits = 8, + + .max_register = KTD20XX_ISELC34, + + .volatile_table = &ktd20xx_volatile_table, + .rd_table = &ktd20xx_readable_table, + + .reg_defaults = ktd20xx_reg_defs, + .num_reg_defaults = ARRAY_SIZE(ktd20xx_reg_defs), + .cache_type = REGCACHE_FLAT, +}; + +struct ktd20xx_led { + struct led_classdev_mc mc_cdev; + struct mc_subled subled_info[KTD20XX_LED_CHANNELS]; + int index; + struct regmap_field *enable; + struct regmap_field *select; + struct ktd20xx *chip; +}; + +struct ktd20xx { + struct mutex lock; + struct i2c_client *client; + struct regmap *regmap; + struct regmap_field *control_mode; + struct regmap_field *faderate; + struct regmap_field *vendor; + struct regmap_field *chip_id; + struct regmap_field *chip_rev; + struct ktd20xx_led leds[KTD20XX_MAX_LEDS]; +}; + +static int ktd20xx_hwinit(struct ktd20xx *chip) +{ + struct device *dev = &chip->client->dev; + int ret; + unsigned int value; + + /* + * If the device tree property 'kinetc,led-current' is found + * then set this value into the color0 register as the max current + * for all color channel LEDs. If this poperty is not set then + * use the default value 0x28 set by the chip after a hardware reset. + * The hardware default value 0x28 corresponds to 5mA. + */ + /* Set color1 register current value to 0x00 and therefor 0mA */ + regmap_write(chip->regmap, KTD20XX_IRED1, 0); + regmap_write(chip->regmap, KTD20XX_IGRN1, 0); + regmap_write(chip->regmap, KTD20XX_IBLU1, 0); + + ret = device_property_read_u32(dev, "kinetic,led-current", &value); + if (ret) { + dev_warn(dev, "property 'kinetic,led-current' not found. Using default hardware value 0x28 (5mA).\n"); + } else { + dev_dbg(dev, "property 'kinetic,led-current' found. Using value 0x%02x.\n", + value); + regmap_write(chip->regmap, KTD20XX_IRED0, value); + regmap_write(chip->regmap, KTD20XX_IGRN0, value); + regmap_write(chip->regmap, KTD20XX_IBLU0, value); + } + + /* Enable chip to run in 'normal mode' */ + regmap_field_write(chip->control_mode, CONTROL_MODE_NORMAL); + + return 0; +} + +static struct ktd20xx_led *mcled_cdev_to_led(struct led_classdev_mc *mc_cdev) +{ + return container_of(mc_cdev, struct ktd20xx_led, mc_cdev); +} + +static int ktd20xx_brightness_set(struct led_classdev *cdev, + enum led_brightness brightness) +{ + struct led_classdev_mc *mc_dev = lcdev_to_mccdev(cdev); + struct ktd20xx_led *led = mcled_cdev_to_led(mc_dev); + struct device *dev = &led->chip->client->dev; + int ret; + int i; + unsigned long rgb = 0; + + mutex_lock(&led->chip->lock); + ret = regmap_field_write(led->enable, brightness ? 1 : 0); + if (ret) { + dev_err(dev, "Cannot set enable flag of LED %d error: %d\n", + led->index, ret); + goto unlock_out; + } + + for (i = 0; i < led->mc_cdev.num_colors; i++) { + unsigned int intensity = mc_dev->subled_info[i].intensity; + unsigned int channel = mc_dev->subled_info[i].channel; + + if (intensity > 0) + set_bit(channel, &rgb); + } + + /* + * To use the color0 registers default value after an hadware reset, + * if the device tree property 'kinetc,led-current' is not set, + * we have to 'invert' the rgb channel! + */ + ret = regmap_field_write(led->select, ~rgb); + if (ret) { + dev_err(dev, "Can not set RGB for LED %d error: %d\n", + led->index, ret); + goto unlock_out; + } + +unlock_out: + mutex_unlock(&led->chip->lock); + return ret; +} + +static int ktd20xx_probe_dt(struct ktd20xx *chip) +{ + struct fwnode_handle *child = NULL; + struct led_init_data init_data = {}; + struct led_classdev *led_cdev; + struct ktd20xx_led *led; + struct device *dev = &chip->client->dev; + int color; + int ret; + int i = 0; + + device_for_each_child_node(dev, child) { + led = &chip->leds[i]; + + ret = fwnode_property_read_u32(child, "reg", &led->index); + if (ret) { + dev_err(dev, "missing property 'reg'\n"); + goto child_out; + } + if (led->index >= KTD20XX_MAX_LEDS) { + dev_warn(dev, "property 'reg' is greater then '%i'\n", + KTD20XX_MAX_LEDS); + ret = -EINVAL; + goto child_out; + } + + ret = fwnode_property_read_u32(child, "color", &color); + if (ret) { + dev_err(dev, "missing property 'color'\n"); + goto child_out; + } + if (color != LED_COLOR_ID_MULTI) { + dev_warn(dev, "property 'color' is not equal to the value 'LED_COLOR_ID_MULTI'\n"); + ret = -EINVAL; + goto child_out; + } + + led->subled_info[0].color_index = LED_COLOR_ID_RED; + led->subled_info[0].channel = 2; + led->subled_info[0].intensity = 1; + led->subled_info[1].color_index = LED_COLOR_ID_GREEN; + led->subled_info[1].channel = 1; + led->subled_info[1].intensity = 1; + led->subled_info[2].color_index = LED_COLOR_ID_BLUE; + led->subled_info[2].channel = 0; + led->subled_info[2].intensity = 1; + + led->mc_cdev.subled_info = led->subled_info; + led->mc_cdev.num_colors = KTD20XX_LED_CHANNELS; + + init_data.fwnode = child; + + led->chip = chip; + led_cdev = &led->mc_cdev.led_cdev; + led_cdev->brightness_set_blocking = ktd20xx_brightness_set; + + switch (led->index) { + case RGB_A1: + led->select = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_a1_select); + led->enable = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_a1_enable); + break; + case RGB_A2: + led->select = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_a2_select); + led->enable = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_a2_enable); + break; + case RGB_A3: + led->select = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_a3_select); + led->enable = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_a3_enable); + break; + case RGB_A4: + led->select = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_a4_select); + led->enable = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_a4_enable); + break; + case RGB_B1: + led->select = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_b1_select); + led->enable = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_b1_enable); + break; + case RGB_B2: + led->select = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_b2_select); + led->enable = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_b2_enable); + break; + case RGB_B3: + led->select = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_b3_select); + led->enable = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_b3_enable); + break; + case RGB_B4: + led->select = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_b4_select); + led->enable = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_b4_enable); + break; + case RGB_C1: + led->select = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_c1_select); + led->enable = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_c1_enable); + break; + case RGB_C2: + led->select = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_c2_select); + led->enable = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_c2_enable); + break; + case RGB_C3: + led->select = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_c3_select); + led->enable = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_c3_enable); + break; + case RGB_C4: + led->select = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_c4_select); + led->enable = devm_regmap_field_alloc(dev, + chip->regmap, kt20xx_c4_enable); + break; + } + + ret = devm_led_classdev_multicolor_register_ext(dev, + &led->mc_cdev, + &init_data); + + if (ret) { + dev_err(dev, "led register err: %d\n", ret); + goto child_out; + } + + i++; + } + + return 0; + +child_out: + fwnode_handle_put(child); + return ret; +} + +/* + * The chip also offers the option "Night Mode". + * All LED current settings are divided by 16 for a 0 to 1.5mA current + * setting range. + */ +static ssize_t nightmode_show(struct device *dev, struct device_attribute *a, + char *buf) +{ + struct ktd20xx *chip = dev_get_drvdata(dev); + unsigned int value; + + mutex_lock(&chip->lock); + regmap_field_read(chip->control_mode, &value); + mutex_unlock(&chip->lock); + + return sysfs_emit(buf, "%d\n", value == CONTROL_MODE_NIGHT ? 1 : 0); +} + +static ssize_t nightmode_store(struct device *dev, struct device_attribute *a, + const char *buf, size_t count) +{ + struct ktd20xx *chip = dev_get_drvdata(dev); + bool value; + int ret; + + ret = kstrtobool(buf, &value); + if (ret) + return ret; + + mutex_lock(&chip->lock); + ret = regmap_field_write(chip->control_mode, + value == 1 ? CONTROL_MODE_NIGHT : CONTROL_MODE_NORMAL); + mutex_unlock(&chip->lock); + + if (ret) + return ret; + + return count; +} +static DEVICE_ATTR_RW(nightmode); + +static struct attribute *ktd20xx_led_controller_attrs[] = { + &dev_attr_nightmode.attr, + NULL +}; +ATTRIBUTE_GROUPS(ktd20xx_led_controller); + +static int ktd20xx_probe(struct i2c_client *client, + const struct i2c_device_id *id) +{ + struct ktd20xx *chip; + unsigned int vendor; + unsigned int chip_id; + unsigned int chip_rev; + struct device *dev; + int ret; + + chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL); + if (!chip) + return -ENOMEM; + + mutex_init(&chip->lock); + chip->client = client; + dev = &client->dev; + i2c_set_clientdata(client, chip); + + chip->regmap = devm_regmap_init_i2c(client, &ktd20xx_regmap_config); + if (IS_ERR(chip->regmap)) { + dev_err_probe(dev, PTR_ERR(chip->regmap), + "Failed to allocate register map\n"); + goto error; + } + + chip->control_mode = devm_regmap_field_alloc(dev, chip->regmap, + kt20xx_control_mode); + chip->faderate = devm_regmap_field_alloc(dev, chip->regmap, + kt20xx_faderate); + chip->vendor = devm_regmap_field_alloc(dev, chip->regmap, + kt20xx_vendor); + chip->chip_id = devm_regmap_field_alloc(dev, chip->regmap, + kt20xx_chip_id); + chip->chip_rev = devm_regmap_field_alloc(dev, chip->regmap, + kt20xx_chip_rev); + + /* Reset all registers to hardware device default settings */ + regmap_field_write(chip->control_mode, CONTROL_MODE_RESET); + + ret = regmap_field_read(chip->vendor, &vendor); + if (ret) { + dev_err_probe(dev, ret, "Failed to read vendor\n"); + goto error; + } + + ret = regmap_field_read(chip->chip_id, &chip_id); + if (ret) { + dev_err_probe(dev, ret, "Failed to read chip id\n"); + goto error; + } + + ret = regmap_field_read(chip->chip_rev, &chip_rev); + if (ret) { + dev_err_probe(dev, ret, "Failed to read chip rev\n"); + goto error; + } + + dev_info(dev, "vendor: 0x%02x chip-id: 0x%02x chip-rev: 0x%02x\n", + vendor, chip_id, chip_rev); + + ret = ktd20xx_probe_dt(chip); + if (ret) + goto error; + + ret = ktd20xx_hwinit(chip); + if (ret) + goto error; + + return 0; + +error: + return ret; +} + +static int ktd20xx_remove(struct i2c_client *client) +{ + struct ktd20xx *chip = i2c_get_clientdata(client); + + mutex_lock(&chip->lock); + regmap_field_write(chip->control_mode, CONTROL_MODE_OFF); + mutex_unlock(&chip->lock); + + return 0; +} + +static const struct i2c_device_id ktd20xx_id[] = { + { "ktd20xx", 0 }, + {} +}; +MODULE_DEVICE_TABLE(i2c, ktd20xx_id); + +static const struct of_device_id of_ktd20xx_leds_match[] = { + { .compatible = "kinetic,ktd20xx", }, + {} +}; +MODULE_DEVICE_TABLE(of, of_ktd20xx_leds_match); + +static struct i2c_driver ktd20xx_driver = { + .driver = { + .name = "ktd20xx", + .dev_groups = ktd20xx_led_controller_groups, + .of_match_table = of_ktd20xx_leds_match, + }, + .probe = ktd20xx_probe, + .remove = ktd20xx_remove, + .id_table = ktd20xx_id +}; +module_i2c_driver(ktd20xx_driver); + +MODULE_DESCRIPTION("Kinetic KTD20xx LED driver"); +MODULE_AUTHOR("Florian Eckert "); +MODULE_LICENSE("GPL v2"); From patchwork Fri Jan 21 14:01:50 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Florian Eckert X-Patchwork-Id: 533991 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 7D514C433F5 for ; Fri, 21 Jan 2022 14:02:09 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1380895AbiAUOCH (ORCPT ); Fri, 21 Jan 2022 09:02:07 -0500 Received: from mxout70.expurgate.net ([194.37.255.70]:48855 "EHLO mxout70.expurgate.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1380887AbiAUOCF (ORCPT ); Fri, 21 Jan 2022 09:02:05 -0500 Received: from [127.0.0.1] (helo=localhost) by relay.expurgate.net with smtp (Exim 4.92) (envelope-from ) id 1nAuUG-0001kS-VN; Fri, 21 Jan 2022 15:01:57 +0100 Received: from [195.243.126.94] (helo=securemail.tdt.de) by relay.expurgate.net with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1nAuUG-0008SD-6x; Fri, 21 Jan 2022 15:01:56 +0100 Received: from securemail.tdt.de (localhost [127.0.0.1]) by securemail.tdt.de (Postfix) with ESMTP id CB9C3240040; Fri, 21 Jan 2022 15:01:55 +0100 (CET) Received: from mail.dev.tdt.de (unknown [10.2.4.42]) by securemail.tdt.de (Postfix) with ESMTP id 3BE75240049; Fri, 21 Jan 2022 15:01:55 +0100 (CET) Received: from localhost.localdomain (unknown [10.2.3.40]) by mail.dev.tdt.de (Postfix) with ESMTPSA id D76B020065; Fri, 21 Jan 2022 15:01:54 +0100 (CET) From: Florian Eckert To: pavel@ucw.cz, robh+dt@kernel.org, andy.shevchenko@gmail.com Cc: Eckert.Florian@googlemail.com, linux-kernel@vger.kernel.org, linux-leds@vger.kernel.org, devicetree@vger.kernel.org, Rob Herring Subject: [PATCH v4 2/2] dt: bindings: KTD20xx: Introduce the ktd20xx family of RGB drivers Date: Fri, 21 Jan 2022 15:01:50 +0100 Message-ID: <20220121140150.1729-3-fe@dev.tdt.de> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20220121140150.1729-1-fe@dev.tdt.de> References: <20220121140150.1729-1-fe@dev.tdt.de> MIME-Version: 1.0 X-purgate: clean X-purgate-type: clean X-purgate-ID: 151534::1642773716-00005ED7-2D86A72C/0/0 Precedence: bulk List-ID: X-Mailing-List: linux-leds@vger.kernel.org Introduce the bindings for the Kinetic KTD2061/58/59/60RGB LED device driver. The KTD20xx can control RGB LEDs individually. Because of the hardware limitations, only 7 colors and the color black (off) can be set. Signed-off-by: Florian Eckert Reviewed-by: Rob Herring --- .../bindings/leds/leds-ktd20xx.yaml | 130 ++++++++++++++++++ MAINTAINERS | 1 + 2 files changed, 131 insertions(+) create mode 100644 Documentation/devicetree/bindings/leds/leds-ktd20xx.yaml diff --git a/Documentation/devicetree/bindings/leds/leds-ktd20xx.yaml b/Documentation/devicetree/bindings/leds/leds-ktd20xx.yaml new file mode 100644 index 000000000000..c4e440cc6945 --- /dev/null +++ b/Documentation/devicetree/bindings/leds/leds-ktd20xx.yaml @@ -0,0 +1,130 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/leds/leds-ktd20xx.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: LED driver for KTD20xx RGB LED from Kinetic. + +maintainers: + - Florian Eckert + +description: | + The KTD20XX is multi-channel, I2C LED driver. Into can control up to 12 + LEDs per device. The RGB value can be set for each LED. Due to hardware + limitations, the full RGB range cannot be used. Only 7 colors and the + color black can be set (black means off). + R G B + 0 0 0 = Black (off) + 0 0 1 = Blue + 0 1 0 = Green + 0 1 1 = Cyan + 1 0 0 = Red + 1 0 1 = Magenta + 1 1 0 = Yellow + 1 1 1 = White + +properties: + compatible: + enum: + - kinetic,ktd20xx + + reg: + maxItems: 1 + description: + I2C slave address + ktd2061/58/59/60 0x68 0x69 0x6A 0x6B + + '#address-cells': + const: 1 + + '#size-cells': + const: 0 + + 'kinetic,led-current': + $ref: /schemas/types.yaml#/definitions/uint8 + description: + This value is a current setting for all LEDs connected to this device. + If this value is not set then the default value off 0x28 (5mA) is set. + This means all LEDs get 5mA. The max value is 24mA. We have the + following mapping in 125uA steps. We can set a maximum of 24mA. + 0000 0000 (0x00) = 0uA + 0000 0001 (0x01) = 125uA + .... .... + 0010 1000 (0x28) = 5mA + .... .... + 1100 0000 (0xC0) = 24mA + 1100 0001 (0xC1) = 24mA + .... .... + 1111 1111 (0xFF) = 24mA + minimum: 0 + maximum: 255 + +patternProperties: + '^multi-led@[0-9a-f]$': + type: object + allOf: + - $ref: leds-class-multicolor.yaml# + description: + This node represents one of the Multicolor LED. No subnodes need to + be added for subchannels since this controller only supports 1bit + RGB values. We could display seven different colors and the color + black which means off. + + properties: + reg: + minimum: 0 + maximum: 11 + description: + This property identifies wired connection of the LED to this device. + 0x00 LEDA1 + 0x01 LEDA2 + 0x02 LEDA3 + 0x03 LEDA4 + 0x04 LEDB1 + 0x05 LEDB2 + 0x06 LEDB3 + 0x07 LEDB4 + 0x08 LEDC1 + 0x09 LEDC2 + 0x0A LEDC3 + 0x0B LEDC4 + +required: + - compatible + - reg + +additionalProperties: false + +examples: + - | + #include + + i2c { + #address-cells = <1>; + #size-cells = <0>; + + led-controller@14 { + compatible = "kinetic,ktd20xx"; + reg = <0x68>; + #address-cells = <1>; + #size-cells = <0>; + kinetic,led-current = <0x28>; // Current for all LEDs is 5mA + + multi-led@0 { + reg = <0x0>; + color = ; + function = LED_FUNCTION_CHARGING; + linux,default-trigger = "default-on"; + }; + + multi-led@2 { + reg = <0x2>; + color = ; + function = LED_FUNCTION_STANDBY; + linux,default-trigger = "default-on"; + }; + }; + }; + +... diff --git a/MAINTAINERS b/MAINTAINERS index 04d68985d348..b56d8392119c 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -10743,6 +10743,7 @@ KTD20XX LED CONTROLLER DRIVER M: Florian Eckert L: linux-leds@vger.kernel.org S: Maintained +F: Documentation/devicetree/bindings/leds/leds-ktd20xx.yaml F: drivers/leds/leds-ktd20xx.c KTEST