[2/2] bus: ts-nbus: Improve error reporting

Message ID 20702efe8ab96add9773e97ceed1a6cf91a065ee.1702160838.git.u.kleine-koenig@pengutronix.de
State New
Headers
Series bus: ts-nbus: Two improvements |

Commit Message

Uwe Kleine-König Dec. 9, 2023, 10:35 p.m. UTC
  Using dev_err_probe() brings several improvements:

 - emits the symbolic error code
 - properly handles EPROBE_DEFER
 - combines error message generation and return value handling

While at it add error messages to two error paths that were silent
before.

Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
---
 drivers/bus/ts-nbus.c | 65 ++++++++++++++++++-------------------------
 1 file changed, 27 insertions(+), 38 deletions(-)
  

Comments

Christophe JAILLET Dec. 10, 2023, 6:55 a.m. UTC | #1
Le 09/12/2023 à 23:35, Uwe Kleine-König a écrit :
> Using dev_err_probe() brings several improvements:
> 
>   - emits the symbolic error code
>   - properly handles EPROBE_DEFER
>   - combines error message generation and return value handling
> 
> While at it add error messages to two error paths that were silent
> before.
> 
> Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
> ---
>   drivers/bus/ts-nbus.c | 65 ++++++++++++++++++-------------------------
>   1 file changed, 27 insertions(+), 38 deletions(-)
> 
> diff --git a/drivers/bus/ts-nbus.c b/drivers/bus/ts-nbus.c

...

> @@ -289,25 +283,19 @@ static int ts_nbus_probe(struct platform_device *pdev)
>   		return ret;
>   
>   	pwm = devm_pwm_get(dev, NULL);
> -	if (IS_ERR(pwm)) {
> -		ret = PTR_ERR(pwm);
> -		if (ret != -EPROBE_DEFER)
> -			dev_err(dev, "unable to request PWM\n");
> -		return ret;
> -	}
> +	if (IS_ERR(pwm))
> +		return dev_err_probe(dev, ret, "unable to request PWM\n");

s/ret/PTR_ERR(pwm)/

CJ
  
Uwe Kleine-König Dec. 10, 2023, 2:13 p.m. UTC | #2
Hello,

[dropped Sebastien from Cc, the address doesn't work]

On Sun, Dec 10, 2023 at 07:55:02AM +0100, Christophe JAILLET wrote:
> Le 09/12/2023 à 23:35, Uwe Kleine-König a écrit :
> > Using dev_err_probe() brings several improvements:
> > 
> >   - emits the symbolic error code
> >   - properly handles EPROBE_DEFER
> >   - combines error message generation and return value handling
> > 
> > While at it add error messages to two error paths that were silent
> > before.
> > 
> > Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
> > ---
> >   drivers/bus/ts-nbus.c | 65 ++++++++++++++++++-------------------------
> >   1 file changed, 27 insertions(+), 38 deletions(-)
> > 
> > diff --git a/drivers/bus/ts-nbus.c b/drivers/bus/ts-nbus.c
> 
> ...
> 
> > @@ -289,25 +283,19 @@ static int ts_nbus_probe(struct platform_device *pdev)
> >   		return ret;
> >   	pwm = devm_pwm_get(dev, NULL);
> > -	if (IS_ERR(pwm)) {
> > -		ret = PTR_ERR(pwm);
> > -		if (ret != -EPROBE_DEFER)
> > -			dev_err(dev, "unable to request PWM\n");
> > -		return ret;
> > -	}
> > +	if (IS_ERR(pwm))
> > +		return dev_err_probe(dev, ret, "unable to request PWM\n");
> 
> s/ret/PTR_ERR(pwm)/

Indeed. Thanks for spotting that. Will send a v2 after waiting a bit
more for feedback.

Best regards
Uwe
  

Patch

diff --git a/drivers/bus/ts-nbus.c b/drivers/bus/ts-nbus.c
index 19c5d1f4e4d7..89c6ce1403e3 100644
--- a/drivers/bus/ts-nbus.c
+++ b/drivers/bus/ts-nbus.c
@@ -39,45 +39,39 @@  struct ts_nbus {
 /*
  * request all gpios required by the bus.
  */
-static int ts_nbus_init_pdata(struct platform_device *pdev, struct ts_nbus
-		*ts_nbus)
+static int ts_nbus_init_pdata(struct platform_device *pdev,
+			      struct ts_nbus *ts_nbus)
 {
 	ts_nbus->data = devm_gpiod_get_array(&pdev->dev, "ts,data",
 			GPIOD_OUT_HIGH);
-	if (IS_ERR(ts_nbus->data)) {
-		dev_err(&pdev->dev, "failed to retrieve ts,data-gpio from dts\n");
-		return PTR_ERR(ts_nbus->data);
-	}
+	if (IS_ERR(ts_nbus->data))
+		return dev_err_probe(&pdev->dev, PTR_ERR(ts_nbus->data),
+				     "failed to retrieve ts,data-gpio from dts\n");
 
 	ts_nbus->csn = devm_gpiod_get(&pdev->dev, "ts,csn", GPIOD_OUT_HIGH);
-	if (IS_ERR(ts_nbus->csn)) {
-		dev_err(&pdev->dev, "failed to retrieve ts,csn-gpio from dts\n");
-		return PTR_ERR(ts_nbus->csn);
-	}
+	if (IS_ERR(ts_nbus->csn))
+		return dev_err_probe(&pdev->dev, PTR_ERR(ts_nbus->csn),
+			      "failed to retrieve ts,csn-gpio from dts\n");
 
 	ts_nbus->txrx = devm_gpiod_get(&pdev->dev, "ts,txrx", GPIOD_OUT_HIGH);
-	if (IS_ERR(ts_nbus->txrx)) {
-		dev_err(&pdev->dev, "failed to retrieve ts,txrx-gpio from dts\n");
-		return PTR_ERR(ts_nbus->txrx);
-	}
+	if (IS_ERR(ts_nbus->txrx))
+		return dev_err_probe(&pdev->dev, PTR_ERR(ts_nbus->txrx),
+				     "failed to retrieve ts,txrx-gpio from dts\n");
 
 	ts_nbus->strobe = devm_gpiod_get(&pdev->dev, "ts,strobe", GPIOD_OUT_HIGH);
-	if (IS_ERR(ts_nbus->strobe)) {
-		dev_err(&pdev->dev, "failed to retrieve ts,strobe-gpio from dts\n");
-		return PTR_ERR(ts_nbus->strobe);
-	}
+	if (IS_ERR(ts_nbus->strobe))
+		return dev_err_probe(&pdev->dev, PTR_ERR(ts_nbus->strobe),
+				     "failed to retrieve ts,strobe-gpio from dts\n");
 
 	ts_nbus->ale = devm_gpiod_get(&pdev->dev, "ts,ale", GPIOD_OUT_HIGH);
-	if (IS_ERR(ts_nbus->ale)) {
-		dev_err(&pdev->dev, "failed to retrieve ts,ale-gpio from dts\n");
-		return PTR_ERR(ts_nbus->ale);
-	}
+	if (IS_ERR(ts_nbus->ale))
+		return dev_err_probe(&pdev->dev, PTR_ERR(ts_nbus->ale),
+				     "failed to retrieve ts,ale-gpio from dts\n");
 
 	ts_nbus->rdy = devm_gpiod_get(&pdev->dev, "ts,rdy", GPIOD_IN);
-	if (IS_ERR(ts_nbus->rdy)) {
-		dev_err(&pdev->dev, "failed to retrieve ts,rdy-gpio from dts\n");
-		return PTR_ERR(ts_nbus->rdy);
-	}
+	if (IS_ERR(ts_nbus->rdy))
+		return dev_err_probe(&pdev->dev, PTR_ERR(ts_nbus->rdy),
+				     "failed to retrieve ts,rdy-gpio from dts\n");
 
 	return 0;
 }
@@ -289,25 +283,19 @@  static int ts_nbus_probe(struct platform_device *pdev)
 		return ret;
 
 	pwm = devm_pwm_get(dev, NULL);
-	if (IS_ERR(pwm)) {
-		ret = PTR_ERR(pwm);
-		if (ret != -EPROBE_DEFER)
-			dev_err(dev, "unable to request PWM\n");
-		return ret;
-	}
+	if (IS_ERR(pwm))
+		return dev_err_probe(dev, ret, "unable to request PWM\n");
 
 	pwm_init_state(pwm, &state);
-	if (!state.period) {
-		dev_err(&pdev->dev, "invalid PWM period\n");
-		return -EINVAL;
-	}
+	if (!state.period)
+		return dev_err_probe(dev, -EINVAL, "invalid PWM period\n");
 
 	state.duty_cycle = state.period;
 	state.enabled = true;
 
 	ret = pwm_apply_state(pwm, &state);
 	if (ret < 0)
-		return ret;
+		return dev_err_probe(dev, ret, "failed to configure PWM\n");
 
 	/*
 	 * we can now start the FPGA and populate the peripherals.
@@ -321,7 +309,8 @@  static int ts_nbus_probe(struct platform_device *pdev)
 
 	ret = of_platform_populate(dev->of_node, NULL, NULL, dev);
 	if (ret < 0)
-		return ret;
+		return dev_err_probe(dev, ret,
+				     "failed to populate platform devices on bus\n");
 
 	dev_info(dev, "initialized\n");