Skip to contentSkip to conversation

leds: lm3692x: Probing and flag fixes

PATCH Superseded Guido Günther 3 participants 13 messages Sep 18, 2019 – Sep 19, 2019 LED

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

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.

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, 25 insertions(+), 20 deletions(-)
Signature · 1 line
2.23.0.rc1
#1 lore raw

PATCH 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
Reviewed-by on v1 1/5
#2 lore raw

Re: [PATCH 1/5] leds: lm3692x: Print error value on dev_err

Guido

Quoted 3 lines · Guido Günther

This gives a way better idea what is going on.

Quoted 70 lines
---
  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);
#3 lore raw

PATCH 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 | 9 +++------
 1 file changed, 3 insertions(+), 6 deletions(-)
drivers/leds/leds-lm3692x.c +3 -6
index 487228c2bed2..f394669ad8f2 100644
@@ -312,15 +312,12 @@ static int lm3692x_init(struct lm3692x_led *led)
 	if (led->enable_gpio)
 		gpiod_direction_output(led->enable_gpio, 0);
 
-	if (led->regulator) {
-		ret = regulator_disable(led->regulator);
-		if (ret)
-			dev_err(&led->client->dev,
-				"Failed to disable regulator\n");
-	}
+	if (led->regulator)
+		regulator_disable(led->regulator);
 
 	return ret;
 }
+
 static int lm3692x_probe_dt(struct lm3692x_led *led)
 {
 	struct fwnode_handle *child = NULL;
Signature · 1 line
2.23.0.rc1
#4 lore raw

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

Guido

Quoted 15 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 | 9 +++------
  1 file changed, 3 insertions(+), 6 deletions(-)
drivers/leds/leds-lm3692x.c +0 -0
index 487228c2bed2..f394669ad8f2 100644
@@ -312,15 +312,12 @@ static int lm3692x_init(struct lm3692x_led *led)
  	if (led->enable_gpio)

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

Quoted 10 lines
drivers/leds/leds-lm3692x.c +2 -6
  		gpiod_direction_output(led->enable_gpio, 0);
 
-	if (led->regulator) {
-		ret = regulator_disable(led->regulator);
-		if (ret)
-			dev_err(&led->client->dev,
-				"Failed to disable regulator\n");
-	}
+	if (led->regulator)
+		regulator_disable(led->regulator);

The change is ok and makes sense but I believe that if the regulator was not properly disabled there needs to be some error message t0o.

If the code got here then there is either a fault or an I/O issue not a regulator issue.

The regulator failing to disable should be logged.

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;
#5 lore raw

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

In reply to Guido Günther
Quoted 17 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 | 9 +++------
 1 file changed, 3 insertions(+), 6 deletions(-)
drivers/leds/leds-lm3692x.c +0 -0
index 487228c2bed2..f394669ad8f2 100644
@@ -312,15 +312,12 @@ static int lm3692x_init(struct lm3692x_led *led)
 	if (led->enable_gpio)
 		gpiod_direction_output(led->enable_gpio, 0);
 

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

Quoted 10 lines
drivers/leds/leds-lm3692x.c +2 -6
-	if (led->regulator) {
-		ret = regulator_disable(led->regulator);
-		if (ret)
-			dev_err(&led->client->dev,
-				"Failed to disable regulator\n");
-	}
+	if (led->regulator)
+		regulator_disable(led->regulator);
 
 	return ret;

Overwriting return value is bad, but we should still print some kind of error message.

Best regards,
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 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 | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)
drivers/leds/leds-lm3692x.c +8 -3
index f394669ad8f2..9972c932d51e 100644
@@ -333,9 +333,14 @@ 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 = NULL;
+	led->regulator = devm_regulator_get_optional(&led->client->dev, "vled");
+	if (IS_ERR(led->regulator)) {
+		ret = PTR_ERR(led->regulator);
+		if (ret != -EPROBE_DEFER)
+			dev_err(&led->client->dev,
+				"Failed to get vled regulator: %d\n", ret);
+		return ret;
+	}
 
 	child = device_get_next_child_node(&led->client->dev, child);
 	if (!child) {
Signature · 1 line
2.23.0.rc1
#7 lore raw

Re: [PATCH 3/5] leds: lm3692x: Handle failure to probe the regulator

Guido

Quoted 15 lines · Guido Günther

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

---
  drivers/leds/leds-lm3692x.c | 11 ++++++++---
  1 file changed, 8 insertions(+), 3 deletions(-)
drivers/leds/leds-lm3692x.c +0 -0
index f394669ad8f2..9972c932d51e 100644
@@ -333,9 +333,14 @@ static int lm3692x_probe_dt(struct lm3692x_led *led)
  		return ret;
  	}

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

Quoted 10 lines
drivers/leds/leds-lm3692x.c +6 -3
 
-	led->regulator = devm_regulator_get(&led->client->dev, "vled");
-	if (IS_ERR(led->regulator))
-		led->regulator = NULL;
+	led->regulator = devm_regulator_get_optional(&led->client->dev, "vled");
+	if (IS_ERR(led->regulator)) {
+		ret = PTR_ERR(led->regulator);
+		if (ret != -EPROBE_DEFER)
+			dev_err(&led->client->dev,
+				"Failed to get vled regulator: %d\n", ret);

nitpick. Add a new line for readability

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

Quoted 2 lines
drivers/leds/leds-lm3692x.c +2 -0
+		return ret;
+	}

If the regulator is not set then led->regulator should be set to NULL.

Dan

Quoted 3 lines
drivers/leds/leds-lm3692x.c +0 -0
  	child = device_get_next_child_node(&led->client->dev, child);
  	if (!child) {
#8 lore raw

PATCH 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 9972c932d51e..d673f706385e 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
Reviewed-by on v1 4/5
#9 lore raw

Re: [PATCH 4/5] leds: lm3692x: Use flags from LM3692X_BOOST_CTRL

Guido

Quoted 5 lines · 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.

Quoted 21 lines
---
  drivers/leds/leds-lm3692x.c | 6 +++---
  1 file changed, 3 insertions(+), 3 deletions(-)
drivers/leds/leds-lm3692x.c +3 -3
index 9972c932d51e..d673f706385e 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;
 
#10 lore raw

PATCH 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 d673f706385e..ecac586ca89c 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
Reviewed-by on v1 5/5
#11 lore raw

Re: [PATCH 5/5] leds: lm3692x: Use flags from LM3692X_BRT_CTRL

Guido

Quoted 5 lines · 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.

Quoted 17 lines
---
  drivers/leds/leds-lm3692x.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
drivers/leds/leds-lm3692x.c +1 -1
index d673f706385e..ecac586ca89c 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;
 
#12 lore raw
In reply to Guido Günther
Quoted 3 lines · Guido Günther

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.

1,3,4,5: Acked-by: Pavel Machek <[email protected]>

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