diff mbox series

[v2] PCI: dw-rockchip: Add error messages in .probe()s error paths

Message ID 20240227141256.413055-2-ukleinek@debian.org (mailing list archive)
State New, archived
Headers show
Series [v2] PCI: dw-rockchip: Add error messages in .probe()s error paths | expand

Commit Message

Uwe Kleine-König Feb. 27, 2024, 2:12 p.m. UTC 
Drivers that silently fail to probe provide a bad user experience and
make it unnecessarily hard to debug such a failure. Fix it by using
dev_err_probe() instead of a plain return.

Reviewed-by: Heiko Stuebner <heiko@sntech.de>
Signed-off-by: Uwe Kleine-König <ukleinek@debian.org>
---
Hello,

changes since (implicit) v1, sent with Message-Id:
20240227111837.395422-2-ukleinek@debian.org:

 - use dev instead of rockchip->pci.dev as noticed by Serge Semin.
 - added Reviewed-by: tag for Heiko. I assume he agrees to above
   improvement and adding the tag despite the change is fine.

Best regards
Uwe

 drivers/pci/controller/dwc/pcie-dw-rockchip.c | 21 ++++++++++++-------
 1 file changed, 13 insertions(+), 8 deletions(-)


base-commit: 6613476e225e090cc9aad49be7fa504e290dd33d

Comments

Jesper Nilsson Feb. 28, 2024, 9:52 a.m. UTC | #1 
On Tue, Feb 27, 2024 at 03:12:54PM +0100, Uwe Kleine-König wrote:
> Drivers that silently fail to probe provide a bad user experience and
> make it unnecessarily hard to debug such a failure. Fix it by using
> dev_err_probe() instead of a plain return.
> 
> Reviewed-by: Heiko Stuebner <heiko@sntech.de>
> Signed-off-by: Uwe Kleine-König <ukleinek@debian.org>

Reviewed-by: Jesper Nilsson <jesper.nilsson@axis.com>

/^JN - Jesper Nilsson
Manivannan Sadhasivam March 10, 2024, 1:10 p.m. UTC | #2 
On Tue, Feb 27, 2024 at 03:12:54PM +0100, Uwe Kleine-König wrote:
> Drivers that silently fail to probe provide a bad user experience and
> make it unnecessarily hard to debug such a failure. Fix it by using
> dev_err_probe() instead of a plain return.
> 
> Reviewed-by: Heiko Stuebner <heiko@sntech.de>
> Signed-off-by: Uwe Kleine-König <ukleinek@debian.org>

Reviewed-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>

- Mani

> ---
> Hello,
> 
> changes since (implicit) v1, sent with Message-Id:
> 20240227111837.395422-2-ukleinek@debian.org:
> 
>  - use dev instead of rockchip->pci.dev as noticed by Serge Semin.
>  - added Reviewed-by: tag for Heiko. I assume he agrees to above
>    improvement and adding the tag despite the change is fine.
> 
> Best regards
> Uwe
> 
>  drivers/pci/controller/dwc/pcie-dw-rockchip.c | 21 ++++++++++++-------
>  1 file changed, 13 insertions(+), 8 deletions(-)
> 
> diff --git a/drivers/pci/controller/dwc/pcie-dw-rockchip.c b/drivers/pci/controller/dwc/pcie-dw-rockchip.c
> index d6842141d384..a13ca83ce260 100644
> --- a/drivers/pci/controller/dwc/pcie-dw-rockchip.c
> +++ b/drivers/pci/controller/dwc/pcie-dw-rockchip.c
> @@ -225,11 +225,15 @@ static int rockchip_pcie_clk_init(struct rockchip_pcie *rockchip)
>  
>  	ret = devm_clk_bulk_get_all(dev, &rockchip->clks);
>  	if (ret < 0)
> -		return ret;
> +		return dev_err_probe(dev, ret, "failed to get clocks\n");
>  
>  	rockchip->clk_cnt = ret;
>  
> -	return clk_bulk_prepare_enable(rockchip->clk_cnt, rockchip->clks);
> +	ret = clk_bulk_prepare_enable(rockchip->clk_cnt, rockchip->clks);
> +	if (ret)
> +		return dev_err_probe(dev, ret, "failed to enable clocks\n");
> +
> +	return 0;
>  }
>  
>  static int rockchip_pcie_resource_get(struct platform_device *pdev,
> @@ -237,12 +241,14 @@ static int rockchip_pcie_resource_get(struct platform_device *pdev,
>  {
>  	rockchip->apb_base = devm_platform_ioremap_resource_byname(pdev, "apb");
>  	if (IS_ERR(rockchip->apb_base))
> -		return PTR_ERR(rockchip->apb_base);
> +		return dev_err_probe(&pdev->dev, PTR_ERR(rockchip->apb_base),
> +				     "failed to map apb registers\n");
>  
>  	rockchip->rst_gpio = devm_gpiod_get_optional(&pdev->dev, "reset",
>  						     GPIOD_OUT_HIGH);
>  	if (IS_ERR(rockchip->rst_gpio))
> -		return PTR_ERR(rockchip->rst_gpio);
> +		return dev_err_probe(&pdev->dev, PTR_ERR(rockchip->rst_gpio),
> +				     "failed to get reset gpio\n");
>  
>  	rockchip->rst = devm_reset_control_array_get_exclusive(&pdev->dev);
>  	if (IS_ERR(rockchip->rst))
> @@ -320,10 +326,9 @@ static int rockchip_pcie_probe(struct platform_device *pdev)
>  		rockchip->vpcie3v3 = NULL;
>  	} else {
>  		ret = regulator_enable(rockchip->vpcie3v3);
> -		if (ret) {
> -			dev_err(dev, "failed to enable vpcie3v3 regulator\n");
> -			return ret;
> -		}
> +		if (ret)
> +			return dev_err_probe(dev, ret,
> +					     "failed to enable vpcie3v3 regulator\n");
>  	}
>  
>  	ret = rockchip_pcie_phy_init(rockchip);
> 
> base-commit: 6613476e225e090cc9aad49be7fa504e290dd33d
> -- 
> 2.43.0
>
Bjorn Helgaas May 15, 2024, 8:57 p.m. UTC | #3 
On Tue, Feb 27, 2024 at 03:12:54PM +0100, Uwe Kleine-König wrote:
> Drivers that silently fail to probe provide a bad user experience and
> make it unnecessarily hard to debug such a failure. Fix it by using
> dev_err_probe() instead of a plain return.
> 
> Reviewed-by: Heiko Stuebner <heiko@sntech.de>
> Signed-off-by: Uwe Kleine-König <ukleinek@debian.org>

Krzysztof applied this to pci/controller/rockchip with Reviewed-by
from Jesper and Mani, but his outgoing mail queue got stuck.  Trying
to squeeze into v6.9.

> ---
> Hello,
> 
> changes since (implicit) v1, sent with Message-Id:
> 20240227111837.395422-2-ukleinek@debian.org:
> 
>  - use dev instead of rockchip->pci.dev as noticed by Serge Semin.
>  - added Reviewed-by: tag for Heiko. I assume he agrees to above
>    improvement and adding the tag despite the change is fine.
> 
> Best regards
> Uwe
> 
>  drivers/pci/controller/dwc/pcie-dw-rockchip.c | 21 ++++++++++++-------
>  1 file changed, 13 insertions(+), 8 deletions(-)
> 
> diff --git a/drivers/pci/controller/dwc/pcie-dw-rockchip.c b/drivers/pci/controller/dwc/pcie-dw-rockchip.c
> index d6842141d384..a13ca83ce260 100644
> --- a/drivers/pci/controller/dwc/pcie-dw-rockchip.c
> +++ b/drivers/pci/controller/dwc/pcie-dw-rockchip.c
> @@ -225,11 +225,15 @@ static int rockchip_pcie_clk_init(struct rockchip_pcie *rockchip)
>  
>  	ret = devm_clk_bulk_get_all(dev, &rockchip->clks);
>  	if (ret < 0)
> -		return ret;
> +		return dev_err_probe(dev, ret, "failed to get clocks\n");
>  
>  	rockchip->clk_cnt = ret;
>  
> -	return clk_bulk_prepare_enable(rockchip->clk_cnt, rockchip->clks);
> +	ret = clk_bulk_prepare_enable(rockchip->clk_cnt, rockchip->clks);
> +	if (ret)
> +		return dev_err_probe(dev, ret, "failed to enable clocks\n");
> +
> +	return 0;
>  }
>  
>  static int rockchip_pcie_resource_get(struct platform_device *pdev,
> @@ -237,12 +241,14 @@ static int rockchip_pcie_resource_get(struct platform_device *pdev,
>  {
>  	rockchip->apb_base = devm_platform_ioremap_resource_byname(pdev, "apb");
>  	if (IS_ERR(rockchip->apb_base))
> -		return PTR_ERR(rockchip->apb_base);
> +		return dev_err_probe(&pdev->dev, PTR_ERR(rockchip->apb_base),
> +				     "failed to map apb registers\n");
>  
>  	rockchip->rst_gpio = devm_gpiod_get_optional(&pdev->dev, "reset",
>  						     GPIOD_OUT_HIGH);
>  	if (IS_ERR(rockchip->rst_gpio))
> -		return PTR_ERR(rockchip->rst_gpio);
> +		return dev_err_probe(&pdev->dev, PTR_ERR(rockchip->rst_gpio),
> +				     "failed to get reset gpio\n");
>  
>  	rockchip->rst = devm_reset_control_array_get_exclusive(&pdev->dev);
>  	if (IS_ERR(rockchip->rst))
> @@ -320,10 +326,9 @@ static int rockchip_pcie_probe(struct platform_device *pdev)
>  		rockchip->vpcie3v3 = NULL;
>  	} else {
>  		ret = regulator_enable(rockchip->vpcie3v3);
> -		if (ret) {
> -			dev_err(dev, "failed to enable vpcie3v3 regulator\n");
> -			return ret;
> -		}
> +		if (ret)
> +			return dev_err_probe(dev, ret,
> +					     "failed to enable vpcie3v3 regulator\n");
>  	}
>  
>  	ret = rockchip_pcie_phy_init(rockchip);
> 
> base-commit: 6613476e225e090cc9aad49be7fa504e290dd33d
> -- 
> 2.43.0
> 
> 
> _______________________________________________
> linux-arm-kernel mailing list
> linux-arm-kernel@lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Bjorn Helgaas May 15, 2024, 9:13 p.m. UTC | #4 
On Wed, May 15, 2024 at 03:57:37PM -0500, Bjorn Helgaas wrote:
> On Tue, Feb 27, 2024 at 03:12:54PM +0100, Uwe Kleine-König wrote:
> > Drivers that silently fail to probe provide a bad user experience and
> > make it unnecessarily hard to debug such a failure. Fix it by using
> > dev_err_probe() instead of a plain return.
> > 
> > Reviewed-by: Heiko Stuebner <heiko@sntech.de>
> > Signed-off-by: Uwe Kleine-König <ukleinek@debian.org>
> 
> Krzysztof applied this to pci/controller/rockchip with Reviewed-by
> from Jesper and Mani, but his outgoing mail queue got stuck.  Trying
> to squeeze into v6.9.

Sorry, v6.10.  v6.9 is already done, obviously.

> > ---
> > Hello,
> > 
> > changes since (implicit) v1, sent with Message-Id:
> > 20240227111837.395422-2-ukleinek@debian.org:
> > 
> >  - use dev instead of rockchip->pci.dev as noticed by Serge Semin.
> >  - added Reviewed-by: tag for Heiko. I assume he agrees to above
> >    improvement and adding the tag despite the change is fine.
> > 
> > Best regards
> > Uwe
> > 
> >  drivers/pci/controller/dwc/pcie-dw-rockchip.c | 21 ++++++++++++-------
> >  1 file changed, 13 insertions(+), 8 deletions(-)
> > 
> > diff --git a/drivers/pci/controller/dwc/pcie-dw-rockchip.c b/drivers/pci/controller/dwc/pcie-dw-rockchip.c
> > index d6842141d384..a13ca83ce260 100644
> > --- a/drivers/pci/controller/dwc/pcie-dw-rockchip.c
> > +++ b/drivers/pci/controller/dwc/pcie-dw-rockchip.c
> > @@ -225,11 +225,15 @@ static int rockchip_pcie_clk_init(struct rockchip_pcie *rockchip)
> >  
> >  	ret = devm_clk_bulk_get_all(dev, &rockchip->clks);
> >  	if (ret < 0)
> > -		return ret;
> > +		return dev_err_probe(dev, ret, "failed to get clocks\n");
> >  
> >  	rockchip->clk_cnt = ret;
> >  
> > -	return clk_bulk_prepare_enable(rockchip->clk_cnt, rockchip->clks);
> > +	ret = clk_bulk_prepare_enable(rockchip->clk_cnt, rockchip->clks);
> > +	if (ret)
> > +		return dev_err_probe(dev, ret, "failed to enable clocks\n");
> > +
> > +	return 0;
> >  }
> >  
> >  static int rockchip_pcie_resource_get(struct platform_device *pdev,
> > @@ -237,12 +241,14 @@ static int rockchip_pcie_resource_get(struct platform_device *pdev,
> >  {
> >  	rockchip->apb_base = devm_platform_ioremap_resource_byname(pdev, "apb");
> >  	if (IS_ERR(rockchip->apb_base))
> > -		return PTR_ERR(rockchip->apb_base);
> > +		return dev_err_probe(&pdev->dev, PTR_ERR(rockchip->apb_base),
> > +				     "failed to map apb registers\n");
> >  
> >  	rockchip->rst_gpio = devm_gpiod_get_optional(&pdev->dev, "reset",
> >  						     GPIOD_OUT_HIGH);
> >  	if (IS_ERR(rockchip->rst_gpio))
> > -		return PTR_ERR(rockchip->rst_gpio);
> > +		return dev_err_probe(&pdev->dev, PTR_ERR(rockchip->rst_gpio),
> > +				     "failed to get reset gpio\n");
> >  
> >  	rockchip->rst = devm_reset_control_array_get_exclusive(&pdev->dev);
> >  	if (IS_ERR(rockchip->rst))
> > @@ -320,10 +326,9 @@ static int rockchip_pcie_probe(struct platform_device *pdev)
> >  		rockchip->vpcie3v3 = NULL;
> >  	} else {
> >  		ret = regulator_enable(rockchip->vpcie3v3);
> > -		if (ret) {
> > -			dev_err(dev, "failed to enable vpcie3v3 regulator\n");
> > -			return ret;
> > -		}
> > +		if (ret)
> > +			return dev_err_probe(dev, ret,
> > +					     "failed to enable vpcie3v3 regulator\n");
> >  	}
> >  
> >  	ret = rockchip_pcie_phy_init(rockchip);
> > 
> > base-commit: 6613476e225e090cc9aad49be7fa504e290dd33d
> > -- 
> > 2.43.0
> > 
> > 
> > _______________________________________________
> > linux-arm-kernel mailing list
> > linux-arm-kernel@lists.infradead.org
> > http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
Krzysztof Wilczyński May 17, 2024, 11:18 a.m. UTC | #5 
> Drivers that silently fail to probe provide a bad user experience and
> make it unnecessarily hard to debug such a failure. Fix it by using
> dev_err_probe() instead of a plain return.

Applied to controller/rockchip, thank you!

[1/1] PCI: dw-rockchip: Add error messages in .probe()s error paths
      https://git.kernel.org/pci/pci/c/8ab425aa02ac

	Krzysztof
diff mbox series

Patch

diff --git a/drivers/pci/controller/dwc/pcie-dw-rockchip.c b/drivers/pci/controller/dwc/pcie-dw-rockchip.c
index d6842141d384..a13ca83ce260 100644
--- a/drivers/pci/controller/dwc/pcie-dw-rockchip.c
+++ b/drivers/pci/controller/dwc/pcie-dw-rockchip.c
@@ -225,11 +225,15 @@  static int rockchip_pcie_clk_init(struct rockchip_pcie *rockchip)
 
 	ret = devm_clk_bulk_get_all(dev, &rockchip->clks);
 	if (ret < 0)
-		return ret;
+		return dev_err_probe(dev, ret, "failed to get clocks\n");
 
 	rockchip->clk_cnt = ret;
 
-	return clk_bulk_prepare_enable(rockchip->clk_cnt, rockchip->clks);
+	ret = clk_bulk_prepare_enable(rockchip->clk_cnt, rockchip->clks);
+	if (ret)
+		return dev_err_probe(dev, ret, "failed to enable clocks\n");
+
+	return 0;
 }
 
 static int rockchip_pcie_resource_get(struct platform_device *pdev,
@@ -237,12 +241,14 @@  static int rockchip_pcie_resource_get(struct platform_device *pdev,
 {
 	rockchip->apb_base = devm_platform_ioremap_resource_byname(pdev, "apb");
 	if (IS_ERR(rockchip->apb_base))
-		return PTR_ERR(rockchip->apb_base);
+		return dev_err_probe(&pdev->dev, PTR_ERR(rockchip->apb_base),
+				     "failed to map apb registers\n");
 
 	rockchip->rst_gpio = devm_gpiod_get_optional(&pdev->dev, "reset",
 						     GPIOD_OUT_HIGH);
 	if (IS_ERR(rockchip->rst_gpio))
-		return PTR_ERR(rockchip->rst_gpio);
+		return dev_err_probe(&pdev->dev, PTR_ERR(rockchip->rst_gpio),
+				     "failed to get reset gpio\n");
 
 	rockchip->rst = devm_reset_control_array_get_exclusive(&pdev->dev);
 	if (IS_ERR(rockchip->rst))
@@ -320,10 +326,9 @@  static int rockchip_pcie_probe(struct platform_device *pdev)
 		rockchip->vpcie3v3 = NULL;
 	} else {
 		ret = regulator_enable(rockchip->vpcie3v3);
-		if (ret) {
-			dev_err(dev, "failed to enable vpcie3v3 regulator\n");
-			return ret;
-		}
+		if (ret)
+			return dev_err_probe(dev, ret,
+					     "failed to enable vpcie3v3 regulator\n");
 	}
 
 	ret = rockchip_pcie_phy_init(rockchip);