Skip to contentSkip to conversation

net: bcmgenet: Use devm_clk_get_optional() to get the clocks

PATCH In review Andy Shevchenko 2 participants 3 messages Apr 20, 2020

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 net: bcmgenet: Use devm_clk_get_optional() to get the clocks

Conversion to devm_clk_get_optional() makes it explicit that clocks are optional. This change allows to handle deferred probe in case clocks are defined, but not yet probed. Due to above changes replace dev_dbg() by dev_err() and bail out in error case.

While here, check potential error when enable main clock.

---
 .../net/ethernet/broadcom/genet/bcmgenet.c    | 25 +++++++++++--------
 1 file changed, 15 insertions(+), 10 deletions(-)
drivers/net/ethernet/broadcom/genet/bcmgenet.c +15 -10
index ef275db018f73..045f7b7f0b5d3 100644
@@ -3487,13 +3487,16 @@ static int bcmgenet_probe(struct platform_device *pdev)
 		priv->dma_max_burst_length = DMA_MAX_BURST_LENGTH;
 	}
 
-	priv->clk = devm_clk_get(&priv->pdev->dev, "enet");
+	priv->clk = devm_clk_get_optional(&priv->pdev->dev, "enet");
 	if (IS_ERR(priv->clk)) {
-		dev_dbg(&priv->pdev->dev, "failed to get enet clock\n");
-		priv->clk = NULL;
+		dev_err(&priv->pdev->dev, "failed to get enet clock\n");
+		err = PTR_ERR(priv->clk);
+		goto err;
 	}
 
-	clk_prepare_enable(priv->clk);
+	err = clk_prepare_enable(priv->clk);
+	if (err)
+		goto err;
 
 	bcmgenet_set_hw_params(priv);
 
@@ -3511,16 +3514,18 @@ static int bcmgenet_probe(struct platform_device *pdev)
 	priv->rx_buf_len = RX_BUF_LENGTH;
 	INIT_WORK(&priv->bcmgenet_irq_work, bcmgenet_irq_task);
 
-	priv->clk_wol = devm_clk_get(&priv->pdev->dev, "enet-wol");
+	priv->clk_wol = devm_clk_get_optional(&priv->pdev->dev, "enet-wol");
 	if (IS_ERR(priv->clk_wol)) {
-		dev_dbg(&priv->pdev->dev, "failed to get enet-wol clock\n");
-		priv->clk_wol = NULL;
+		dev_err(&priv->pdev->dev, "failed to get enet-wol clock\n");
+		err = PTR_ERR(priv->clk_wol);
+		goto err;
 	}
 
-	priv->clk_eee = devm_clk_get(&priv->pdev->dev, "enet-eee");
+	priv->clk_eee = devm_clk_get_optional(&priv->pdev->dev, "enet-eee");
 	if (IS_ERR(priv->clk_eee)) {
-		dev_dbg(&priv->pdev->dev, "failed to get enet-eee clock\n");
-		priv->clk_eee = NULL;
+		dev_err(&priv->pdev->dev, "failed to get enet-eee clock\n");
+		err = PTR_ERR(priv->clk_eee);
+		goto err;
 	}
 
 	/* If this is an internal GPHY, power it on now, before UniMAC is
Signature · 1 line
2.26.1
Acked-by on v1 1/1
#1 lore raw
Quoted 17 lines · Andy Shevchenko

Conversion to devm_clk_get_optional() makes it explicit that clocks are optional. This change allows to handle deferred probe in case clocks are defined, but not yet probed. Due to above changes replace dev_dbg() by dev_err() and bail out in error case.

While here, check potential error when enable main clock.

---
  .../net/ethernet/broadcom/genet/bcmgenet.c    | 25 +++++++++++--------
  1 file changed, 15 insertions(+), 10 deletions(-)
drivers/net/ethernet/broadcom/genet/bcmgenet.c +0 -0
index ef275db018f73..045f7b7f0b5d3 100644

drivers/net/ethernet/broadcom/genet/bcmgenet.c static int bcmgenet_probe(struct platform_device *pdev) · line 3492

Quoted 9 lines
drivers/net/ethernet/broadcom/genet/bcmgenet.c +2 -3
@@ -3487,13 +3487,16 @@ static int bcmgenet_probe(struct platform_device *pdev)
  		priv->dma_max_burst_length = DMA_MAX_BURST_LENGTH;
  	}
 
-	priv->clk = devm_clk_get(&priv->pdev->dev, "enet");
+	priv->clk = devm_clk_get_optional(&priv->pdev->dev, "enet");
  	if (IS_ERR(priv->clk)) {
-		dev_dbg(&priv->pdev->dev, "failed to get enet clock\n");
-		priv->clk = NULL;
+		dev_err(&priv->pdev->dev, "failed to get enet clock\n");

Please maintain the dev_dbg() here and likewise for the rest of your changes. With that:

Signature · 1 line
Florian
#2 lore raw
Quoted 30 lines · Florian Fainelli
Quoted 17 lines · Andy Shevchenko

Conversion to devm_clk_get_optional() makes it explicit that clocks are optional. This change allows to handle deferred probe in case clocks are defined, but not yet probed. Due to above changes replace dev_dbg() by dev_err() and bail out in error case.

While here, check potential error when enable main clock.

---
  .../net/ethernet/broadcom/genet/bcmgenet.c    | 25 +++++++++++--------
  1 file changed, 15 insertions(+), 10 deletions(-)
drivers/net/ethernet/broadcom/genet/bcmgenet.c +0 -0
index ef275db018f73..045f7b7f0b5d3 100644

drivers/net/ethernet/broadcom/genet/bcmgenet.c static int bcmgenet_probe(struct platform_device *pdev) · line 3491

Quoted 8 lines
drivers/net/ethernet/broadcom/genet/bcmgenet.c +2 -3
@@ -3487,13 +3487,16 @@ static int bcmgenet_probe(struct platform_device *pdev)
  		priv->dma_max_burst_length = DMA_MAX_BURST_LENGTH;
  	}
-	priv->clk = devm_clk_get(&priv->pdev->dev, "enet");
+	priv->clk = devm_clk_get_optional(&priv->pdev->dev, "enet");
  	if (IS_ERR(priv->clk)) {
-		dev_dbg(&priv->pdev->dev, "failed to get enet clock\n");
-		priv->clk = NULL;
+		dev_err(&priv->pdev->dev, "failed to get enet clock\n");

Please maintain the dev_dbg() here and likewise for the rest of your changes. With that:

Quoted 1 line

Ah, I see, actually dev_err() will make too much noise in case of deferred probe.

Perhaps

	if (err != -EPROBE_DEFER)
		dev_err(...);

?

Signature · 2 lines
With Best Regards,
Andy Shevchenko