Skip to contentSkip to conversation

leds: lm3692x: Probing and flag fixes

PATCH Superseded Guido Günther 3 participants 9 messages Sep 20, 2019 – Sep 22, 2019 LED

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

v2 cover leds: lm3692x: Probing and flag fixes

The driver currently returns success on init although probing fails and register setup uses flag values from other registers which is confusing when reading the driver. This series cleans this up.

Changes from v1:
- Add reviewed by's from Dan Murphy, thanks!
https://lore.kernel.org/linux-leds/[email protected]/T/#mc183f3f65931371fa9f9ca2e0e83e0b85010f24b
https://lore.kernel.org/linux-leds/[email protected]/T/#mb845fac36327a5d5dd03fe7e988eef0eb5626f82
https://lore.kernel.org/linux-leds/[email protected]/T/#m995bce73dda3e3bd4f0c2e8f98cbd04a39c13832
- As per review comment from Dan Murphy
- Don't drop error message when disabling the regulator fails

    https://lore.kernel.org/linux-leds/[email protected]/T/#m2ab6dc33b7277b71a197c3747847f1c4d9d9c1d8
  - Handle -ENODEV (when the regulator is not set)
    https://lore.kernel.org/linux-leds/[email protected]/T/#mf6212c29bbfa37b43200ea2c9744074de4f068ee

- Add Acked-by from Pavel Machek, thanks!
https://lore.kernel.org/linux-leds/20190919095415.GA29939@amd/

To: Jacek Anaszewski <[email protected]>,Pavel Machek <[email protected]>,Dan Murphy <[email protected]>,[email protected],[email protected]

Guido Günther (5):
leds: lm3692x: Print error value on dev_err
leds: lm3692x: Don't overwrite return value in error path
leds: lm3692x: Handle failure to probe the regulator
leds: lm3692x: Use flags from LM3692X_BOOST_CTRL
leds: lm3692x: Use flags from LM3692X_BRT_CTRL

 drivers/leds/leds-lm3692x.c | 45 ++++++++++++++++++++++++-------------
 1 file changed, 29 insertions(+), 16 deletions(-)
Signature · 1 line
2.23.0.rc1
#1 lore raw

PATCH v2 1/5 leds: lm3692x: Print error value on dev_err

This gives a way better idea what is going on.

---
 drivers/leds/leds-lm3692x.c | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)
drivers/leds/leds-lm3692x.c +10 -7
index 3d381f2f73d0..487228c2bed2 100644
@@ -174,19 +174,20 @@ static int lm3692x_brightness_set(struct led_classdev *led_cdev,
 
 	ret = lm3692x_fault_check(led);
 	if (ret) {
-		dev_err(&led->client->dev, "Cannot read/clear faults\n");
+		dev_err(&led->client->dev, "Cannot read/clear faults: %d\n",
+			ret);
 		goto out;
 	}
 
 	ret = regmap_write(led->regmap, LM3692X_BRT_MSB, brt_val);
 	if (ret) {
-		dev_err(&led->client->dev, "Cannot write MSB\n");
+		dev_err(&led->client->dev, "Cannot write MSB: %d\n", ret);
 		goto out;
 	}
 
 	ret = regmap_write(led->regmap, LM3692X_BRT_LSB, led_brightness_lsb);
 	if (ret) {
-		dev_err(&led->client->dev, "Cannot write LSB\n");
+		dev_err(&led->client->dev, "Cannot write LSB: %d\n", ret);
 		goto out;
 	}
 out:
@@ -203,7 +204,7 @@ static int lm3692x_init(struct lm3692x_led *led)
 		ret = regulator_enable(led->regulator);
 		if (ret) {
 			dev_err(&led->client->dev,
-				"Failed to enable regulator\n");
+				"Failed to enable regulator: %d\n", ret);
 			return ret;
 		}
 	}
@@ -213,7 +214,8 @@ static int lm3692x_init(struct lm3692x_led *led)
 
 	ret = lm3692x_fault_check(led);
 	if (ret) {
-		dev_err(&led->client->dev, "Cannot read/clear faults\n");
+		dev_err(&led->client->dev, "Cannot read/clear faults: %d\n",
+			ret);
 		goto out;
 	}
 
@@ -409,7 +411,8 @@ static int lm3692x_remove(struct i2c_client *client)
 
 	ret = regmap_update_bits(led->regmap, LM3692X_EN, LM3692X_DEVICE_EN, 0);
 	if (ret) {
-		dev_err(&led->client->dev, "Failed to disable regulator\n");
+		dev_err(&led->client->dev, "Failed to disable regulator: %d\n",
+			ret);
 		return ret;
 	}
 
@@ -420,7 +423,7 @@ static int lm3692x_remove(struct i2c_client *client)
 		ret = regulator_disable(led->regulator);
 		if (ret)
 			dev_err(&led->client->dev,
-				"Failed to disable regulator\n");
+				"Failed to disable regulator: %d\n", ret);
 	}
 
 	mutex_destroy(&led->lock);
Signature · 1 line
2.23.0.rc1
#2 lore raw

PATCH v2 2/5 leds: lm3692x: Don't overwrite return value in error path

In reply to Guido Günther

The driver currently reports successful initialization on every failure as long as it's able to power off the regulator. Don't check the return value of regulator_disable to avoid that.

---
 drivers/leds/leds-lm3692x.c | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
drivers/leds/leds-lm3692x.c +4 -3
index 487228c2bed2..31115655f97b 100644
@@ -198,7 +198,7 @@ static int lm3692x_brightness_set(struct led_classdev *led_cdev,
 static int lm3692x_init(struct lm3692x_led *led)
 {
 	int enable_state;
-	int ret;
+	int ret, ret2;
 
 	if (led->regulator) {
 		ret = regulator_enable(led->regulator);
@@ -313,14 +313,15 @@ static int lm3692x_init(struct lm3692x_led *led)
 		gpiod_direction_output(led->enable_gpio, 0);
 
 	if (led->regulator) {
-		ret = regulator_disable(led->regulator);
-		if (ret)
+		ret2 = regulator_disable(led->regulator);
+		if (ret2)
 			dev_err(&led->client->dev,
 				"Failed to disable regulator\n");
 	}
 
 	return ret;
 }
+
 static int lm3692x_probe_dt(struct lm3692x_led *led)
 {
 	struct fwnode_handle *child = NULL;
Signature · 1 line
2.23.0.rc1
#3 lore raw

Re: [PATCH v2 2/5] leds: lm3692x: Don't overwrite return value in error path

Guido

Quoted 23 lines · Guido Günther

The driver currently reports successful initialization on every failure as long as it's able to power off the regulator. Don't check the return value of regulator_disable to avoid that.

---
  drivers/leds/leds-lm3692x.c | 7 ++++---
  1 file changed, 4 insertions(+), 3 deletions(-)
drivers/leds/leds-lm3692x.c +1 -1
index 487228c2bed2..31115655f97b 100644
@@ -198,7 +198,7 @@ static int lm3692x_brightness_set(struct led_classdev *led_cdev,
  static int lm3692x_init(struct lm3692x_led *led)
  {
  	int enable_state;
-	int ret;
+	int ret, ret2;
 
  	if (led->regulator) {
  		ret = regulator_enable(led->regulator);

drivers/leds/leds-lm3692x.c static int lm3692x_init(struct lm3692x_led *led) · line 319

Quoted 9 lines
drivers/leds/leds-lm3692x.c +2 -2
@@ -313,14 +313,15 @@ static int lm3692x_init(struct lm3692x_led *led)
  		gpiod_direction_output(led->enable_gpio, 0);
 
  	if (led->regulator) {
-		ret = regulator_disable(led->regulator);
-		if (ret)
+		ret2 = regulator_disable(led->regulator);
+		if (ret2)
  			dev_err(&led->client->dev,
  				"Failed to disable regulator\n");

s/ret2/reg_ret

Like you did in patch 1 log the error code as well.

If regulator_disabled failed you might want to send that error code but either error returned is fine.

Dan

Quoted 8 lines
drivers/leds/leds-lm3692x.c +1 -0
  	}
 
  	return ret;
  }
+
  static int lm3692x_probe_dt(struct lm3692x_led *led)
  {
  	struct fwnode_handle *child = NULL;
#4 lore raw

Re: [PATCH v2 2/5] leds: lm3692x: Don't overwrite return value in error path

Hi Dan,

Quoted 36 lines · Dan Murphy

Guido

Quoted 22 lines · Guido Günther

The driver currently reports successful initialization on every failure as long as it's able to power off the regulator. Don't check the return value of regulator_disable to avoid that.

---
  drivers/leds/leds-lm3692x.c | 7 ++++---
  1 file changed, 4 insertions(+), 3 deletions(-)
drivers/leds/leds-lm3692x.c +1 -1
index 487228c2bed2..31115655f97b 100644
@@ -198,7 +198,7 @@ static int lm3692x_brightness_set(struct led_classdev *led_cdev,
  static int lm3692x_init(struct lm3692x_led *led)
  {
  	int enable_state;
-	int ret;
+	int ret, ret2;
  	if (led->regulator) {
  		ret = regulator_enable(led->regulator);

drivers/leds/leds-lm3692x.c static int lm3692x_init(struct lm3692x_led *led) · line 318

Quoted 8 lines
drivers/leds/leds-lm3692x.c +2 -2
@@ -313,14 +313,15 @@ static int lm3692x_init(struct lm3692x_led *led)
  		gpiod_direction_output(led->enable_gpio, 0);
  	if (led->regulator) {
-		ret = regulator_disable(led->regulator);
-		if (ret)
+		ret2 = regulator_disable(led->regulator);
+		if (ret2)
  			dev_err(&led->client->dev,
  				"Failed to disable regulator\n");

s/ret2/reg_ret

Quoted 4 lines

Like you did in patch 1 log the error code as well.

If regulator_disabled failed you might want to send that error code but either error returned is fine.

Changed in v3 - i opted to return the original error code since this is likely what upper layers care about and only printk the regulator failure one.
Thanks for the review,
-- Guido

Quoted 12 lines

Dan

Quoted 7 lines
drivers/leds/leds-lm3692x.c +1 -0
  	}
  	return ret;
  }
+
  static int lm3692x_probe_dt(struct lm3692x_led *led)
  {
  	struct fwnode_handle *child = NULL;
Acked-by on v2 2/5
#5 lore raw

Re: [PATCH v2 2/5] leds: lm3692x: Don't overwrite return value in error path

In reply to Guido Günther
Quoted 5 lines · Guido Günther

The driver currently reports successful initialization on every failure as long as it's able to power off the regulator. Don't check the return value of regulator_disable to avoid that.

Pavel

Signature · 2 lines
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
#6 lore raw

PATCH v2 3/5 leds: lm3692x: Handle failure to probe the regulator

In reply to Guido Günther

Instead use devm_regulator_get_optional since the regulator is optional and check for errors.

---
 drivers/leds/leds-lm3692x.c | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)
drivers/leds/leds-lm3692x.c +11 -2
index 31115655f97b..6f6a17ec7c9f 100644
@@ -337,9 +337,18 @@ static int lm3692x_probe_dt(struct lm3692x_led *led)
 		return ret;
 	}
 
-	led->regulator = devm_regulator_get(&led->client->dev, "vled");
-	if (IS_ERR(led->regulator))
+	led->regulator = devm_regulator_get_optional(&led->client->dev, "vled");
+	if (IS_ERR(led->regulator)) {
+		ret = PTR_ERR(led->regulator);
+		if (ret != -ENODEV) {
+			if (ret != -EPROBE_DEFER)
+				dev_err(&led->client->dev,
+					"Failed to get vled regulator: %d\n",
+					ret);
+			return ret;
+		}
 		led->regulator = NULL;
+	}
 
 	child = device_get_next_child_node(&led->client->dev, child);
 	if (!child) {
Signature · 1 line
2.23.0.rc1
#7 lore raw

PATCH v2 4/5 leds: lm3692x: Use flags from LM3692X_BOOST_CTRL

In reply to Guido Günther

The current setup of LM3692X_BOOST_CTRL uses flags from LM3692X_BRT_CTRL. Use flags from LM3692X_BOOST_CTRL but leave the resulting register value unchanged.

---
 drivers/leds/leds-lm3692x.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
drivers/leds/leds-lm3692x.c +3 -3
index 6f6a17ec7c9f..d8a60c7c8077 100644
@@ -250,9 +250,9 @@ static int lm3692x_init(struct lm3692x_led *led)
 		goto out;
 
 	ret = regmap_write(led->regmap, LM3692X_BOOST_CTRL,
-			LM3692X_BRHT_MODE_RAMP_MULTI |
-			LM3692X_BL_ADJ_POL |
-			LM3692X_RAMP_RATE_250us);
+			LM3692X_BOOST_SW_1MHZ |
+			LM3692X_BOOST_SW_NO_SHIFT |
+			LM3692X_OCP_PROT_1_5A);
 	if (ret)
 		goto out;
 
Signature · 1 line
2.23.0.rc1
#8 lore raw

PATCH v2 5/5 leds: lm3692x: Use flags from LM3692X_BRT_CTRL

In reply to Guido Günther

Use LM3692X_RAMP_EN instead of LM3692X_PWM_HYSTER_4LSB since the later is a flag for the PWM register. The actual register value remains unchanged.

---
 drivers/leds/leds-lm3692x.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/leds/leds-lm3692x.c +1 -1
index d8a60c7c8077..a404b66b31e5 100644
@@ -269,7 +269,7 @@ static int lm3692x_init(struct lm3692x_led *led)
 		goto out;
 
 	ret = regmap_write(led->regmap, LM3692X_BRT_CTRL,
-			LM3692X_BL_ADJ_POL | LM3692X_PWM_HYSTER_4LSB);
+			LM3692X_BL_ADJ_POL | LM3692X_RAMP_EN);
 	if (ret)
 		goto out;
 
Signature · 1 line
2.23.0.rc1