Skip to contentSkip to conversation

ata: sata_dwc_460ex: use devm for old DMA resource lifetime management

PATCH In review Rosen Penev 2 participants 3 messages Jun 30 libata

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 ata: sata_dwc_460ex: use devm for old DMA resource lifetime management

Convert sata_dwc_dma_exit_old() to a devm action callback and register it via devm_add_action_or_reset() after dw_dma_probe() succeeds. This lets the devm framework handle DMA controller teardown automatically on probe failure and driver removal.

As a result the probe function can use plain return-on-error for all failure paths — the dma_initialized flag, the goto labels, and the explicit sata_dwc_dma_exit_old() call in sata_dwc_remove() are all eliminated.

Assisted-by opencode:big-pickle
---
 drivers/ata/sata_dwc_460ex.c | 35 ++++++++++++++++-------------------
 1 file changed, 16 insertions(+), 19 deletions(-)
drivers/ata/sata_dwc_460ex.c +16 -19
index 35aa7f9acdf7..a1e319deb0b4 100644
@@ -221,10 +221,18 @@ static int sata_dwc_dma_get_channel_old(struct sata_dwc_device_port *hsdevp)
 	return 0;
 }
 
+static void sata_dwc_dma_exit_old(void *data)
+{
+	struct sata_dwc_device *hsdev = data;
+
+	dw_dma_remove(hsdev->dma);
+}
+
 static int sata_dwc_dma_init_old(struct platform_device *pdev,
 				 struct sata_dwc_device *hsdev)
 {
 	struct device *dev = &pdev->dev;
+	int err;
 
 	hsdev->dma = devm_kzalloc(dev, sizeof(*hsdev->dma), GFP_KERNEL);
 	if (!hsdev->dma)
@@ -244,15 +252,11 @@ static int sata_dwc_dma_init_old(struct platform_device *pdev,
 		return PTR_ERR(hsdev->dma->regs);
 
 	/* Initialize AHB DMAC */
-	return dw_dma_probe(hsdev->dma);
-}
-
-static void sata_dwc_dma_exit_old(struct sata_dwc_device *hsdev)
-{
-	if (!hsdev->dma)
-		return;
+	err = dw_dma_probe(hsdev->dma);
+	if (err)
+		return err;
 
-	dw_dma_remove(hsdev->dma);
+	return devm_add_action_or_reset(dev, sata_dwc_dma_exit_old, hsdev);
 }
 
 #endif
@@ -1187,7 +1191,7 @@ static int sata_dwc_probe(struct platform_device *ofdev)
 
 	err = phy_init(hsdev->phy);
 	if (err)
-		goto error_out;
+		return err;
 
 	/*
 	 * Now, register with libATA core, this will also initiate the
@@ -1195,12 +1199,10 @@ static int sata_dwc_probe(struct platform_device *ofdev)
 	 * error_handler() to execute a dummy Softreset EH session
 	 */
 	err = ata_host_activate(host, irq, sata_dwc_isr, 0, &sata_dwc_sht);
-	if (err)
-		dev_err(dev, "failed to activate host");
+	if (!err)
+		return err;
 
-	return 0;
-
-error_out:
+	dev_err(dev, "failed to activate host");
 	phy_exit(hsdev->phy);
 	return err;
 }
@@ -1215,11 +1217,6 @@ static void sata_dwc_remove(struct platform_device *ofdev)
 
 	phy_exit(hsdev->phy);
 
-#ifdef CONFIG_SATA_DWC_OLD_DMA
-	/* Free SATA DMA resources */
-	sata_dwc_dma_exit_old(hsdev);
-#endif
-
 	dev_dbg(dev, "done\n");
 }
 
Signature · 1 line
2.54.0
maintainer
#1 lore raw
Quoted 69 lines · Rosen Penev

Convert sata_dwc_dma_exit_old() to a devm action callback and register it via devm_add_action_or_reset() after dw_dma_probe() succeeds. This lets the devm framework handle DMA controller teardown automatically on probe failure and driver removal.

As a result the probe function can use plain return-on-error for all failure paths — the dma_initialized flag, the goto labels, and the explicit sata_dwc_dma_exit_old() call in sata_dwc_remove() are all eliminated.

Assisted-by opencode:big-pickle
---
 drivers/ata/sata_dwc_460ex.c | 35 ++++++++++++++++-------------------
 1 file changed, 16 insertions(+), 19 deletions(-)
drivers/ata/sata_dwc_460ex.c +13 -9
index 35aa7f9acdf7..a1e319deb0b4 100644
@@ -221,10 +221,18 @@ static int sata_dwc_dma_get_channel_old(struct sata_dwc_device_port *hsdevp)
 	return 0;
 }
 
+static void sata_dwc_dma_exit_old(void *data)
+{
+	struct sata_dwc_device *hsdev = data;
+
+	dw_dma_remove(hsdev->dma);
+}
+
 static int sata_dwc_dma_init_old(struct platform_device *pdev,
 				 struct sata_dwc_device *hsdev)
 {
 	struct device *dev = &pdev->dev;
+	int err;
 
 	hsdev->dma = devm_kzalloc(dev, sizeof(*hsdev->dma), GFP_KERNEL);
 	if (!hsdev->dma)
@@ -244,15 +252,11 @@ static int sata_dwc_dma_init_old(struct platform_device *pdev,
 		return PTR_ERR(hsdev->dma->regs);
 
 	/* Initialize AHB DMAC */
-	return dw_dma_probe(hsdev->dma);
-}
-
-static void sata_dwc_dma_exit_old(struct sata_dwc_device *hsdev)
-{
-	if (!hsdev->dma)
-		return;
+	err = dw_dma_probe(hsdev->dma);
+	if (err)
+		return err;
 
-	dw_dma_remove(hsdev->dma);
+	return devm_add_action_or_reset(dev, sata_dwc_dma_exit_old, hsdev);
 }
 
 #endif
@@ -1187,7 +1191,7 @@ static int sata_dwc_probe(struct platform_device *ofdev)
 
 	err = phy_init(hsdev->phy);
 	if (err)
-		goto error_out;
+		return err;
 
 	/*
 	 * Now, register with libATA core, this will also initiate the

drivers/ata/sata_dwc_460ex.c static int sata_dwc_probe(struct platform_device *ofdev) · line 1203

Quoted 7 lines
drivers/ata/sata_dwc_460ex.c +2 -2
@@ -1195,12 +1199,10 @@ static int sata_dwc_probe(struct platform_device *ofdev)
 	 * error_handler() to execute a dummy Softreset EH session
 	 */
 	err = ata_host_activate(host, irq, sata_dwc_isr, 0, &sata_dwc_sht);
-	if (err)
-		dev_err(dev, "failed to activate host");
+	if (!err)
+		return err;

What about the generic error check pattern:

	err = ata_host_activate(host, irq, sata_dwc_isr, 0, &sata_dwc_sht);
	if (err) {
		dev_err(dev, "failed to activate host");
		phy_exit(hsdev->phy);
		return err;
	}

	return 0;

Which I find personally much nicer to read.

Quoted 20 lines
drivers/ata/sata_dwc_460ex.c +1 -8
-	return 0;
-
-error_out:
+	dev_err(dev, "failed to activate host");
 	phy_exit(hsdev->phy);
 	return err;
 }
@@ -1215,11 +1217,6 @@ static void sata_dwc_remove(struct platform_device *ofdev)
 
 	phy_exit(hsdev->phy);
 
-#ifdef CONFIG_SATA_DWC_OLD_DMA
-	/* Free SATA DMA resources */
-	sata_dwc_dma_exit_old(hsdev);
-#endif
-
 	dev_dbg(dev, "done\n");
 }
 
Signature · 2 lines
Damien Le Moal
Western Digital Research
#2 lore raw
Quoted 90 lines · Damien Le Moal
Quoted 69 lines · Rosen Penev

Convert sata_dwc_dma_exit_old() to a devm action callback and register it via devm_add_action_or_reset() after dw_dma_probe() succeeds. This lets the devm framework handle DMA controller teardown automatically on probe failure and driver removal.

As a result the probe function can use plain return-on-error for all failure paths — the dma_initialized flag, the goto labels, and the explicit sata_dwc_dma_exit_old() call in sata_dwc_remove() are all eliminated.

Assisted-by opencode:big-pickle
---
 drivers/ata/sata_dwc_460ex.c | 35 ++++++++++++++++-------------------
 1 file changed, 16 insertions(+), 19 deletions(-)
drivers/ata/sata_dwc_460ex.c +13 -9
index 35aa7f9acdf7..a1e319deb0b4 100644
@@ -221,10 +221,18 @@ static int sata_dwc_dma_get_channel_old(struct sata_dwc_device_port *hsdevp)
      return 0;
 }
 
+static void sata_dwc_dma_exit_old(void *data)
+{
+     struct sata_dwc_device *hsdev = data;
+
+     dw_dma_remove(hsdev->dma);
+}
+
 static int sata_dwc_dma_init_old(struct platform_device *pdev,
                               struct sata_dwc_device *hsdev)
 {
      struct device *dev = &pdev->dev;
+     int err;
 
      hsdev->dma = devm_kzalloc(dev, sizeof(*hsdev->dma), GFP_KERNEL);
      if (!hsdev->dma)
@@ -244,15 +252,11 @@ static int sata_dwc_dma_init_old(struct platform_device *pdev,
              return PTR_ERR(hsdev->dma->regs);
 
      /* Initialize AHB DMAC */
-     return dw_dma_probe(hsdev->dma);
-}
-
-static void sata_dwc_dma_exit_old(struct sata_dwc_device *hsdev)
-{
-     if (!hsdev->dma)
-             return;
+     err = dw_dma_probe(hsdev->dma);
+     if (err)
+             return err;
 
-     dw_dma_remove(hsdev->dma);
+     return devm_add_action_or_reset(dev, sata_dwc_dma_exit_old, hsdev);
 }
 
 #endif
@@ -1187,7 +1191,7 @@ static int sata_dwc_probe(struct platform_device *ofdev)
 
      err = phy_init(hsdev->phy);
      if (err)
-             goto error_out;
+             return err;
 
      /*
       * Now, register with libATA core, this will also initiate the

drivers/ata/sata_dwc_460ex.c static int sata_dwc_probe(struct platform_device *ofdev) · line 1203

Quoted 7 lines
drivers/ata/sata_dwc_460ex.c +2 -2
@@ -1195,12 +1199,10 @@ static int sata_dwc_probe(struct platform_device *ofdev)
       * error_handler() to execute a dummy Softreset EH session
       */
      err = ata_host_activate(host, irq, sata_dwc_isr, 0, &sata_dwc_sht);
-     if (err)
-             dev_err(dev, "failed to activate host");
+     if (!err)
+             return err;

What about the generic error check pattern:

        err = ata_host_activate(host, irq, sata_dwc_isr, 0, &sata_dwc_sht);
        if (err) {
                dev_err(dev, "failed to activate host");
                phy_exit(hsdev->phy);
                return err;
        }

        return 0;
Quoted 1 line

Which I find personally much nicer to read.

OK. Will do for v2.

I did it this way to reduce indentation.

Quoted 26 lines
Quoted 11 lines
drivers/ata/sata_dwc_460ex.c +1 -3
-     return 0;
-
-error_out:
+     dev_err(dev, "failed to activate host");
      phy_exit(hsdev->phy);
      return err;
 }
@@ -1215,11 +1217,6 @@ static void sata_dwc_remove(struct platform_device *ofdev)
 

drivers/ata/sata_dwc_460ex.c static void sata_dwc_remove(struct platform_device *ofdev) · line 1222

Quoted 10 lines
drivers/ata/sata_dwc_460ex.c +0 -5
      phy_exit(hsdev->phy);
 
-#ifdef CONFIG_SATA_DWC_OLD_DMA
-     /* Free SATA DMA resources */
-     sata_dwc_dma_exit_old(hsdev);
-#endif
-
      dev_dbg(dev, "done\n");
 }
 

--
Damien Le Moal
Western Digital Research