diff mbox series

[v9,9/9] leds: max77705: Add LEDs support

Message ID 20241202-starqltechn_integration_upstream-v9-9-a1adc3bae2b8@gmail.com
State New
Headers show
Series Add support for Maxim Integrated MAX77705 PMIC | expand

Commit Message

Dzmitry Sankouski Dec. 2, 2024, 9:48 a.m. UTC
This adds basic support for LEDs for the max77705 PMIC.

Signed-off-by: Dzmitry Sankouski <dsankouski@gmail.com>

---
Changes for v8:
- join line where possible to fit in 100 chars
- change comment style C++ -> C

Changes for v6:
- change compatible suffix to 'rgb'
- remove I2C dependency in Kconfig
- remove copyright and author from 'based on' header statement
- replace MFD abbreviation with PMIC
- MAINTAINERS: alphabetic order
- max77705_rgb_blink: replace ternary operators with if..else if sequence
- max77705_rgb_blink: move hardcoded numbers to constants
- max77705_led_brightness_set: move ret to the bottom
- s/map/regmap
- replace device_for_each_child_node with scoped version
- s/rv/ret
Changes for v5:
- use same hardware name in Kconfig and module descriptions
- remove copyrighter owner from module authors

Changes in v4:
- inline BLINK_(ON|OFF) macro
- remove camel case
- drop backwards compatibility(new driver)
- drop module alias
---
 MAINTAINERS                          |   1 +
 drivers/leds/Kconfig                 |   6 ++++++
 drivers/leds/Makefile                |   1 +
 drivers/leds/leds-max77705.c         | 167 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 include/linux/mfd/max77705-private.h |  18 ++++++++++++++++
 5 files changed, 193 insertions(+)

Comments

Krzysztof Kozlowski Dec. 2, 2024, 10:29 a.m. UTC | #1
On 02/12/2024 10:48, Dzmitry Sankouski wrote:
> This adds basic support for LEDs for the max77705 PMIC.
> 
> Signed-off-by: Dzmitry Sankouski <dsankouski@gmail.com>
> 
> ---
> Changes for v8:
> - join line where possible to fit in 100 chars


Coding style asks for 80. checkpatch is not a coding style, unless this
came from maintainer's review.

> - change comment style C++ -> C
> 

> Changes for v6:
> - change compatible suffix to 'rgb'
> - remove I2C dependency in Kconfig
> - remove copyright and author from 'based on' header statement
> - replace MFD abbreviation with PMIC
> - MAINTAINERS: alphabetic order
> - max77705_rgb_blink: replace ternary operators with if..else if sequence
> - max77705_rgb_blink: move hardcoded numbers to constants
> - max77705_led_brightness_set: move ret to the bottom
> - s/map/regmap
> - replace device_for_each_child_node with scoped version
> - s/rv/ret
> Changes for v5:
> - use same hardware name in Kconfig and module descriptions
> - remove copyrighter owner from module authors
> 
> Changes in v4:
> - inline BLINK_(ON|OFF) macro
> - remove camel case
> - drop backwards compatibility(new driver)
> - drop module alias
> ---
>  MAINTAINERS                          |   1 +
>  drivers/leds/Kconfig                 |   6 ++++++
>  drivers/leds/Makefile                |   1 +
>  drivers/leds/leds-max77705.c         | 167 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  include/linux/mfd/max77705-private.h |  18 ++++++++++++++++
>  5 files changed, 193 insertions(+)
> 
> diff --git a/MAINTAINERS b/MAINTAINERS


...

> diff --git a/include/linux/mfd/max77705-private.h b/include/linux/mfd/max77705-private.h
> index be781a0f9802..2140693ce747 100644
> --- a/include/linux/mfd/max77705-private.h
> +++ b/include/linux/mfd/max77705-private.h
> @@ -35,6 +35,24 @@
>  #define MAX77705_SYSTEM_IRQ_SYSOVLO_INT	BIT(5)
>  #define MAX77705_SYSTEM_IRQ_TSHDN_INT	BIT(6)
>  #define MAX77705_SYSTEM_IRQ_TM_INT	BIT(7)
> +/* MAX77705_RGBLED_REG_LEDEN register */
> +#define MAX77705_RGBLED_EN_WIDTH	2
> +/* MAX77705_RGBLED_REG_LEDBLNK register */
> +#define MAX77705_RGB_DELAY_100_STEP_LIM 500
> +#define MAX77705_RGB_DELAY_100_STEP_COUNT 4
> +#define MAX77705_RGB_DELAY_100_STEP 100
> +#define MAX77705_RGB_DELAY_250_STEP_LIM 3250
> +#define MAX77705_RGB_DELAY_250_STEP 250
> +#define MAX77705_RGB_DELAY_500_STEP 500
> +#define MAX77705_RGB_DELAY_500_STEP_COUNT 10
> +#define MAX77705_RGB_DELAY_500_STEP_LIM 5000
> +#define MAX77705_RGB_DELAY_1000_STEP_LIM 8000
> +#define MAX77705_RGB_DELAY_1000_STEP_COUNT 13
> +#define MAX77705_RGB_DELAY_1000_STEP 1000
> +#define MAX77705_RGB_DELAY_2000_STEP 2000
> +#define MAX77705_RGB_DELAY_2000_STEP_COUNT 13
> +#define MAX77705_RGB_DELAY_2000_STEP_LIM 12000
> +
>  

No need for multiple line breaks.

Best regards,
Krzysztof
Dzmitry Sankouski Dec. 3, 2024, 12:21 p.m. UTC | #2
пн, 2 дек. 2024 г. в 13:30, Krzysztof Kozlowski <krzk@kernel.org>:
>
> On 02/12/2024 10:48, Dzmitry Sankouski wrote:
> > This adds basic support for LEDs for the max77705 PMIC.
> >
> > Signed-off-by: Dzmitry Sankouski <dsankouski@gmail.com>
> >
> > ---
> > Changes for v8:
> > - join line where possible to fit in 100 chars
>
>
> Coding style asks for 80. checkpatch is not a coding style, unless this
> came from maintainer's review.
>

On v6 discussion, Lee Jones stated 'This is old guidance':
https://patchwork.kernel.org/project/linux-input/patch/20241007-starqltechn_integration_upstream-v6-7-0d38b5090c57@gmail.com/
Lee Jones Dec. 5, 2024, 4:42 p.m. UTC | #3
On Tue, 03 Dec 2024, Dzmitry Sankouski wrote:

> пн, 2 дек. 2024 г. в 13:30, Krzysztof Kozlowski <krzk@kernel.org>:
> >
> > On 02/12/2024 10:48, Dzmitry Sankouski wrote:
> > > This adds basic support for LEDs for the max77705 PMIC.
> > >
> > > Signed-off-by: Dzmitry Sankouski <dsankouski@gmail.com>
> > >
> > > ---
> > > Changes for v8:
> > > - join line where possible to fit in 100 chars
> >
> >
> > Coding style asks for 80. checkpatch is not a coding style, unless this
> > came from maintainer's review.
> >
> 
> On v6 discussion, Lee Jones stated 'This is old guidance':
> https://patchwork.kernel.org/project/linux-input/patch/20241007-starqltechn_integration_upstream-v6-7-0d38b5090c57@gmail.com/

I prefer 100-chars where it makes sense.  The future is bright!
diff mbox series

Patch

diff --git a/MAINTAINERS b/MAINTAINERS
index b269d0456da3..7a21e871ba7c 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -14188,6 +14188,7 @@  F:	Documentation/devicetree/bindings/*/maxim,max77693.yaml
 F:	Documentation/devicetree/bindings/*/maxim,max77705*.yaml
 F:	Documentation/devicetree/bindings/*/maxim,max77843.yaml
 F:	Documentation/devicetree/bindings/clock/maxim,max77686.txt
+F:	drivers/leds/leds-max77705.c
 F:	drivers/*/*max77843.c
 F:	drivers/*/max14577*.c
 F:	drivers/*/max77686*.c
diff --git a/drivers/leds/Kconfig b/drivers/leds/Kconfig
index b784bb74a837..27ce55b32543 100644
--- a/drivers/leds/Kconfig
+++ b/drivers/leds/Kconfig
@@ -753,6 +753,12 @@  config LEDS_MAX77650
 	help
 	  LEDs driver for MAX77650 family of PMICs from Maxim Integrated.
 
+config LEDS_MAX77705
+	tristate "LED support for Maxim MAX77705 PMIC"
+	depends on MFD_MAX77705 && LEDS_CLASS
+	help
+	  LED driver for MAX77705 PMIC from Maxim Integrated.
+
 config LEDS_MAX8997
 	tristate "LED support for MAX8997 PMIC"
 	depends on LEDS_CLASS && MFD_MAX8997
diff --git a/drivers/leds/Makefile b/drivers/leds/Makefile
index 18afbb5a23ee..096bf244527d 100644
--- a/drivers/leds/Makefile
+++ b/drivers/leds/Makefile
@@ -60,6 +60,7 @@  obj-$(CONFIG_LEDS_LP8860)		+= leds-lp8860.o
 obj-$(CONFIG_LEDS_LT3593)		+= leds-lt3593.o
 obj-$(CONFIG_LEDS_MAX5970)		+= leds-max5970.o
 obj-$(CONFIG_LEDS_MAX77650)		+= leds-max77650.o
+obj-$(CONFIG_LEDS_MAX77705)		+= leds-max77705.o
 obj-$(CONFIG_LEDS_MAX8997)		+= leds-max8997.o
 obj-$(CONFIG_LEDS_MC13783)		+= leds-mc13783.o
 obj-$(CONFIG_LEDS_MENF21BMC)		+= leds-menf21bmc.o
diff --git a/drivers/leds/leds-max77705.c b/drivers/leds/leds-max77705.c
new file mode 100644
index 000000000000..29db23702231
--- /dev/null
+++ b/drivers/leds/leds-max77705.c
@@ -0,0 +1,167 @@ 
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Based on leds-max77650 driver
+ *
+ * LED driver for MAXIM 77705 PMIC.
+ * Copyright (C) 2024 Dzmitry Sankouski <dsankouski@gmail.org>
+ */
+
+#include <linux/i2c.h>
+#include <linux/leds.h>
+#include <linux/mfd/max77705-private.h>
+#include <linux/module.h>
+#include <linux/platform_device.h>
+#include <linux/regmap.h>
+
+#define MAX77705_LED_NUM_LEDS		4
+#define MAX77705_LED_EN_MASK		GENMASK(1, 0)
+#define MAX77705_LED_MAX_BRIGHTNESS	0xff
+
+struct max77705_led {
+	struct led_classdev cdev;
+	struct regmap *regmap;
+	unsigned int en_shift;
+	unsigned int reg_brightness;
+};
+
+static struct max77705_led *max77705_to_led(struct led_classdev *cdev)
+{
+	return container_of(cdev, struct max77705_led, cdev);
+}
+
+static int max77705_rgb_blink(struct led_classdev *cdev,
+				unsigned long *delay_on,
+				unsigned long *delay_off)
+{
+	struct max77705_led *led = max77705_to_led(cdev);
+	int value, on_value, off_value;
+
+	if (*delay_on < MAX77705_RGB_DELAY_100_STEP)
+		on_value = 0;
+	else if (*delay_on < MAX77705_RGB_DELAY_100_STEP_LIM)
+		on_value = *delay_on / MAX77705_RGB_DELAY_100_STEP - 1;
+	else if (*delay_on < MAX77705_RGB_DELAY_250_STEP_LIM)
+		on_value = (*delay_on - MAX77705_RGB_DELAY_100_STEP_LIM) /
+				MAX77705_RGB_DELAY_250_STEP +
+				MAX77705_RGB_DELAY_100_STEP_COUNT;
+	else
+		on_value = 15;
+
+	on_value <<= 4;
+
+	if (*delay_off < 1)
+		off_value = 0;
+	else if (*delay_off < MAX77705_RGB_DELAY_500_STEP)
+		off_value = 1;
+	else if (*delay_off < MAX77705_RGB_DELAY_500_STEP_LIM)
+		off_value = *delay_off / MAX77705_RGB_DELAY_500_STEP;
+	else if (*delay_off < MAX77705_RGB_DELAY_1000_STEP_LIM)
+		off_value = (*delay_off - MAX77705_RGB_DELAY_1000_STEP_LIM) /
+				MAX77705_RGB_DELAY_1000_STEP +
+				MAX77705_RGB_DELAY_500_STEP_COUNT;
+	else if (*delay_off < MAX77705_RGB_DELAY_2000_STEP_LIM)
+		off_value = (*delay_off - MAX77705_RGB_DELAY_2000_STEP_LIM) /
+				MAX77705_RGB_DELAY_2000_STEP +
+				MAX77705_RGB_DELAY_1000_STEP_COUNT;
+	else
+		off_value = 15;
+
+	value = on_value | off_value;
+	return regmap_write(led->regmap, MAX77705_RGBLED_REG_LEDBLNK, value);
+}
+
+static int max77705_led_brightness_set(struct led_classdev *cdev,
+					enum led_brightness brightness)
+{
+	struct max77705_led *led = max77705_to_led(cdev);
+	unsigned long blink_default = 0;
+	int ret;
+
+	if (brightness == LED_OFF) {
+		/* Flash OFF */
+		ret = regmap_update_bits(led->regmap,
+					MAX77705_RGBLED_REG_LEDEN,
+					MAX77705_LED_EN_MASK << led->en_shift, 0);
+		max77705_rgb_blink(cdev, &blink_default, &blink_default);
+	} else {
+		/* Set current */
+		ret = regmap_write(led->regmap, led->reg_brightness, brightness);
+		if (ret < 0)
+			return ret;
+
+		ret = regmap_update_bits(led->regmap,
+					MAX77705_RGBLED_REG_LEDEN, LED_ON << led->en_shift,
+					MAX77705_LED_EN_MASK << led->en_shift);
+	}
+
+	return ret;
+}
+
+static int max77705_led_probe(struct platform_device *pdev)
+{
+	struct max77705_led *leds, *led;
+	struct device *dev = &pdev->dev;
+	struct regmap *regmap;
+	int ret, num_leds;
+	u32 reg;
+
+	leds = devm_kcalloc(dev, sizeof(*leds), MAX77705_LED_NUM_LEDS, GFP_KERNEL);
+	if (!leds)
+		return -ENOMEM;
+
+	regmap = dev_get_regmap(dev->parent, NULL);
+	if (!regmap)
+		return -ENODEV;
+
+	num_leds = device_get_child_node_count(dev);
+	if (num_leds < 0 || num_leds > MAX77705_LED_NUM_LEDS)
+		return -ENODEV;
+
+	device_for_each_child_node_scoped(dev, child) {
+		struct led_init_data init_data = {};
+
+		ret = fwnode_property_read_u32(child, "reg", &reg);
+		if (ret || reg >= MAX77705_LED_NUM_LEDS)
+			ret = -EINVAL;
+
+		led = &leds[reg];
+		led->regmap = regmap;
+		led->reg_brightness = MAX77705_RGBLED_REG_LED0BRT + reg;
+		led->en_shift = MAX77705_RGBLED_EN_WIDTH * reg;
+		led->cdev.brightness_set_blocking = max77705_led_brightness_set;
+		led->cdev.blink_set = max77705_rgb_blink;
+		led->cdev.max_brightness = MAX77705_LED_MAX_BRIGHTNESS;
+
+		init_data.fwnode = child;
+
+		ret = devm_led_classdev_register_ext(dev, &led->cdev,
+							&init_data);
+		if (ret)
+			return ret;
+
+		ret = max77705_led_brightness_set(&led->cdev, LED_OFF);
+		if (ret)
+			return ret;
+	}
+
+	return 0;
+}
+
+static const struct of_device_id max77705_led_of_match[] = {
+	{ .compatible = "maxim,max77705-rgb" },
+	{ }
+};
+MODULE_DEVICE_TABLE(of, max77705_led_of_match);
+
+static struct platform_driver max77705_led_driver = {
+	.driver = {
+		.name = "max77705-led",
+		.of_match_table = max77705_led_of_match,
+	},
+	.probe = max77705_led_probe,
+};
+module_platform_driver(max77705_led_driver);
+
+MODULE_DESCRIPTION("Maxim MAX77705 LED driver");
+MODULE_AUTHOR("Dzmitry Sankouski <dsankouski@gmail.com>");
+MODULE_LICENSE("GPL");
diff --git a/include/linux/mfd/max77705-private.h b/include/linux/mfd/max77705-private.h
index be781a0f9802..2140693ce747 100644
--- a/include/linux/mfd/max77705-private.h
+++ b/include/linux/mfd/max77705-private.h
@@ -35,6 +35,24 @@ 
 #define MAX77705_SYSTEM_IRQ_SYSOVLO_INT	BIT(5)
 #define MAX77705_SYSTEM_IRQ_TSHDN_INT	BIT(6)
 #define MAX77705_SYSTEM_IRQ_TM_INT	BIT(7)
+/* MAX77705_RGBLED_REG_LEDEN register */
+#define MAX77705_RGBLED_EN_WIDTH	2
+/* MAX77705_RGBLED_REG_LEDBLNK register */
+#define MAX77705_RGB_DELAY_100_STEP_LIM 500
+#define MAX77705_RGB_DELAY_100_STEP_COUNT 4
+#define MAX77705_RGB_DELAY_100_STEP 100
+#define MAX77705_RGB_DELAY_250_STEP_LIM 3250
+#define MAX77705_RGB_DELAY_250_STEP 250
+#define MAX77705_RGB_DELAY_500_STEP 500
+#define MAX77705_RGB_DELAY_500_STEP_COUNT 10
+#define MAX77705_RGB_DELAY_500_STEP_LIM 5000
+#define MAX77705_RGB_DELAY_1000_STEP_LIM 8000
+#define MAX77705_RGB_DELAY_1000_STEP_COUNT 13
+#define MAX77705_RGB_DELAY_1000_STEP 1000
+#define MAX77705_RGB_DELAY_2000_STEP 2000
+#define MAX77705_RGB_DELAY_2000_STEP_COUNT 13
+#define MAX77705_RGB_DELAY_2000_STEP_LIM 12000
+
 
 enum max77705_hw_rev {
 	MAX77705_PASS1 = 1,