Skip to contentSkip to conversation

net: ath9k: use devm for request_irq

PATCH In review Rosen Penev 5 participants 14 messages Jul 31, 2024 – Aug 8, 2024 Qualcomm Atheros ATH9K wireless driver

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 net: ath9k: use devm for request_irq

Avoids having to manually call free_irq. Simplifies code slightly.

---
 drivers/net/wireless/ath/ath9k/ahb.c | 7 ++-----
 drivers/net/wireless/ath/ath9k/pci.c | 9 +++------
 2 files changed, 5 insertions(+), 11 deletions(-)
drivers/net/wireless/ath/ath9k/ahb.c +2 -5
index 1a6697b6e3b4..29f67ded8fe2 100644
@@ -118,7 +118,7 @@ static int ath_ahb_probe(struct platform_device *pdev)
 	sc->mem = mem;
 	sc->irq = irq;
 
-	ret = request_irq(irq, ath_isr, IRQF_SHARED, "ath9k", sc);
+	ret = devm_request_irq(&pdev->dev, irq, ath_isr, IRQF_SHARED, "ath9k", sc);
 	if (ret) {
 		dev_err(&pdev->dev, "request_irq failed\n");
 		goto err_free_hw;
@@ -127,7 +127,7 @@ static int ath_ahb_probe(struct platform_device *pdev)
 	ret = ath9k_init_device(id->driver_data, sc, &ath_ahb_bus_ops);
 	if (ret) {
 		dev_err(&pdev->dev, "failed to initialize device\n");
-		goto err_irq;
+		goto err_free_hw;
 	}
 
 	ah = sc->sc_ah;
@@ -137,8 +137,6 @@ static int ath_ahb_probe(struct platform_device *pdev)
 
 	return 0;
 
- err_irq:
-	free_irq(irq, sc);
  err_free_hw:
 	ieee80211_free_hw(hw);
 	return ret;
@@ -152,7 +150,6 @@ static void ath_ahb_remove(struct platform_device *pdev)
 		struct ath_softc *sc = hw->priv;
 
 		ath9k_deinit_device(sc);
-		free_irq(sc->irq, sc);
 		ieee80211_free_hw(sc->hw);
 	}
 }
drivers/net/wireless/ath/ath9k/pci.c +3 -6
index 1ff53520f0a3..ccf73886199a 100644
@@ -965,9 +965,9 @@ static int ath_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
 	}
 
 	if (!msi_enabled)
-		ret = request_irq(pdev->irq, ath_isr, IRQF_SHARED, "ath9k", sc);
+		ret = devm_request_irq(&pdev->dev, pdev->irq, ath_isr, IRQF_SHARED, "ath9k", sc);
 	else
-		ret = request_irq(pdev->irq, ath_isr, 0, "ath9k", sc);
+		ret = devm_request_irq(&pdev->dev, pdev->irq, ath_isr, 0, "ath9k", sc);
 
 	if (ret) {
 		dev_err(&pdev->dev, "request_irq failed\n");
@@ -979,7 +979,7 @@ static int ath_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
 	ret = ath9k_init_device(id->device, sc, &ath_pci_bus_ops);
 	if (ret) {
 		dev_err(&pdev->dev, "Failed to initialize device\n");
-		goto err_init;
+		goto err_irq;
 	}
 
 	sc->sc_ah->msi_enabled = msi_enabled;
@@ -991,8 +991,6 @@ static int ath_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
 
 	return 0;
 
-err_init:
-	free_irq(sc->irq, sc);
 err_irq:
 	ieee80211_free_hw(hw);
 	return ret;
@@ -1006,7 +1004,6 @@ static void ath_pci_remove(struct pci_dev *pdev)
 	if (!is_ath9k_unloaded)
 		sc->sc_ah->ah_flags |= AH_UNPLUGGED;
 	ath9k_deinit_device(sc);
-	free_irq(sc->irq, sc);
 	ieee80211_free_hw(sc->hw);
 }
 
Signature · 1 line
2.45.2
#1 lore raw
Quoted 3 lines · Rosen Penev

Avoids having to manually call free_irq. Simplifies code slightly.

The title prefix should be "wifi:". I can fix that, no need to resend because of this.

Signature · 3 lines
https://patchwork.kernel.org/project/linux-wireless/list/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches
#3 lore raw
In reply to Rosen Penev
Quoted 5 lines · Rosen Penev

Avoids having to manually call free_irq(). Simplifies code slightly.

Patch applied to ath-next branch of ath.git, thanks.

92da4ce847bc wifi: ath9k: use devm for request_irq()

Signature · 3 lines
https://patchwork.kernel.org/project/linux-wireless/patch/[email protected]/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches
#4 lore raw
In reply to Rosen Penev
Quoted 13 lines · Rosen Penev

Avoids having to manually call free_irq. Simplifies code slightly.

---
  drivers/net/wireless/ath/ath9k/ahb.c | 7 ++-----
  drivers/net/wireless/ath/ath9k/pci.c | 9 +++------
  2 files changed, 5 insertions(+), 11 deletions(-)
drivers/net/wireless/ath/ath9k/ahb.c +0 -0
index 1a6697b6e3b4..29f67ded8fe2 100644

drivers/net/wireless/ath/ath9k/ahb.c static int ath_ahb_probe(struct platform_device *pdev) · line 121

Quoted 5 lines
drivers/net/wireless/ath/ath9k/ahb.c +1 -1
@@ -118,7 +118,7 @@ static int ath_ahb_probe(struct platform_device *pdev)
  	sc->mem = mem;
  	sc->irq = irq;
 
-	ret = request_irq(irq, ath_isr, IRQF_SHARED, "ath9k", sc);
+	ret = devm_request_irq(&pdev->dev, irq, ath_isr, IRQF_SHARED, "ath9k", sc);

Sorry for the late response, but I think this patch is wrong any may need to be reverted. If there is an error during probe, and the IRQ fires for some reason, there could be an use-after-free bug when the IRQ handler accesses the data in sc. The explicit freq_irq calls were preventing that from happening.

- Felix

#5 lore raw
Quoted 18 lines · Felix Fietkau
Quoted 16 lines · Rosen Penev

Avoids having to manually call free_irq. Simplifies code slightly.

---
  drivers/net/wireless/ath/ath9k/ahb.c | 7 ++-----
  drivers/net/wireless/ath/ath9k/pci.c | 9 +++------
  2 files changed, 5 insertions(+), 11 deletions(-)
drivers/net/wireless/ath/ath9k/ahb.c +0 -0
index 1a6697b6e3b4..29f67ded8fe2 100644
@@ -118,7 +118,7 @@ static int ath_ahb_probe(struct platform_device *pdev)
      sc->mem = mem;
      sc->irq = irq;
 
Quoted 7 lines

drivers/net/wireless/ath/ath9k/ahb.c static int ath_ahb_probe(struct platform_device *pdev) · line 121

Quoted 2 lines
drivers/net/wireless/ath/ath9k/ahb.c +1 -1
-     ret = request_irq(irq, ath_isr, IRQF_SHARED, "ath9k", sc);
+     ret = devm_request_irq(&pdev->dev, irq, ath_isr, IRQF_SHARED, "ath9k", sc);

Sorry for the late response, but I think this patch is wrong any may need to be reverted. If there is an error during probe, and the IRQ fires for some reason, there could be an use-after-free bug when the IRQ handler accesses the data in sc.
The explicit freq_irq calls were preventing that from happening.

How about keeping the devm variant and replacing free_irq with devm_free_irq in probe?

Quoted 3 lines

- Felix

#6 lore raw
Quoted 26 lines · Rosen Penev
Quoted 18 lines · Felix Fietkau
Quoted 16 lines · Rosen Penev

Avoids having to manually call free_irq. Simplifies code slightly.

---
  drivers/net/wireless/ath/ath9k/ahb.c | 7 ++-----
  drivers/net/wireless/ath/ath9k/pci.c | 9 +++------
  2 files changed, 5 insertions(+), 11 deletions(-)
drivers/net/wireless/ath/ath9k/ahb.c +0 -0
index 1a6697b6e3b4..29f67ded8fe2 100644
@@ -118,7 +118,7 @@ static int ath_ahb_probe(struct platform_device *pdev)
      sc->mem = mem;
      sc->irq = irq;
 
Quoted 7 lines

drivers/net/wireless/ath/ath9k/ahb.c static int ath_ahb_probe(struct platform_device *pdev) · line 121

Quoted 2 lines
drivers/net/wireless/ath/ath9k/ahb.c +1 -1
-     ret = request_irq(irq, ath_isr, IRQF_SHARED, "ath9k", sc);
+     ret = devm_request_irq(&pdev->dev, irq, ath_isr, IRQF_SHARED, "ath9k", sc);

Sorry for the late response, but I think this patch is wrong any may need to be reverted. If there is an error during probe, and the IRQ fires for some reason, there could be an use-after-free bug when the IRQ handler accesses the data in sc.
The explicit freq_irq calls were preventing that from happening.

Quoted 2 lines

How about keeping the devm variant and replacing free_irq with devm_free_irq in probe?

If you do that, then using the devm variant is completely pointless. I think a full revert is the best option.

- Felix

#7 lore raw
Quoted 28 lines · Felix Fietkau
Quoted 26 lines · Rosen Penev
Quoted 25 lines · Felix Fietkau
Quoted 13 lines · Rosen Penev

Avoids having to manually call free_irq. Simplifies code slightly.

---
  drivers/net/wireless/ath/ath9k/ahb.c | 7 ++-----
  drivers/net/wireless/ath/ath9k/pci.c | 9 +++------
  2 files changed, 5 insertions(+), 11 deletions(-)
drivers/net/wireless/ath/ath9k/ahb.c +0 -0
index 1a6697b6e3b4..29f67ded8fe2 100644

drivers/net/wireless/ath/ath9k/ahb.c static int ath_ahb_probe(struct platform_device *pdev) · line 121

Quoted 5 lines
drivers/net/wireless/ath/ath9k/ahb.c +1 -1
@@ -118,7 +118,7 @@ static int ath_ahb_probe(struct platform_device *pdev)
      sc->mem = mem;
      sc->irq = irq;
 
-     ret = request_irq(irq, ath_isr, IRQF_SHARED, "ath9k", sc);
+     ret = devm_request_irq(&pdev->dev, irq, ath_isr, IRQF_SHARED, "ath9k", sc);

Sorry for the late response, but I think this patch is wrong any may need to be reverted. If there is an error during probe, and the IRQ fires for some reason, there could be an use-after-free bug when the IRQ handler accesses the data in sc.
The explicit freq_irq calls were preventing that from happening.

Quoted 5 lines
Quoted 2 lines

How about keeping the devm variant and replacing free_irq with devm_free_irq in probe?

If you do that, then using the devm variant is completely pointless. I think a full revert is the best option.

OTOH it still allows removing free_irq from _remove, but I see your point.

Quoted 2 lines

- Felix

#8 lore raw
Quoted 29 lines · Rosen Penev
Quoted 28 lines · Felix Fietkau
Quoted 26 lines · Rosen Penev
Quoted 25 lines · Felix Fietkau
Quoted 13 lines · Rosen Penev

Avoids having to manually call free_irq. Simplifies code slightly.

---
  drivers/net/wireless/ath/ath9k/ahb.c | 7 ++-----
  drivers/net/wireless/ath/ath9k/pci.c | 9 +++------
  2 files changed, 5 insertions(+), 11 deletions(-)
drivers/net/wireless/ath/ath9k/ahb.c +0 -0
index 1a6697b6e3b4..29f67ded8fe2 100644

drivers/net/wireless/ath/ath9k/ahb.c static int ath_ahb_probe(struct platform_device *pdev) · line 121

Quoted 5 lines
drivers/net/wireless/ath/ath9k/ahb.c +1 -1
@@ -118,7 +118,7 @@ static int ath_ahb_probe(struct platform_device *pdev)
      sc->mem = mem;
      sc->irq = irq;
 
-     ret = request_irq(irq, ath_isr, IRQF_SHARED, "ath9k", sc);
+     ret = devm_request_irq(&pdev->dev, irq, ath_isr, IRQF_SHARED, "ath9k", sc);

Sorry for the late response, but I think this patch is wrong any may need to be reverted. If there is an error during probe, and the IRQ fires for some reason, there could be an use-after-free bug when the IRQ handler accesses the data in sc.
The explicit freq_irq calls were preventing that from happening.

Quoted 6 lines
Quoted 5 lines
Quoted 2 lines

How about keeping the devm variant and replacing free_irq with devm_free_irq in probe?

If you do that, then using the devm variant is completely pointless. I think a full revert is the best option.

OTOH it still allows removing free_irq from _remove, but I see your point.

No, because you'd have the same use-after-free bug there as well.

- Felix

#9 lore raw
Quoted 30 lines · Felix Fietkau
Quoted 29 lines · Rosen Penev
Quoted 28 lines · Felix Fietkau
Quoted 26 lines · Rosen Penev
Quoted 25 lines · Felix Fietkau
Quoted 13 lines · Rosen Penev

Avoids having to manually call free_irq. Simplifies code slightly.

---
  drivers/net/wireless/ath/ath9k/ahb.c | 7 ++-----
  drivers/net/wireless/ath/ath9k/pci.c | 9 +++------
  2 files changed, 5 insertions(+), 11 deletions(-)
drivers/net/wireless/ath/ath9k/ahb.c +0 -0
index 1a6697b6e3b4..29f67ded8fe2 100644

drivers/net/wireless/ath/ath9k/ahb.c static int ath_ahb_probe(struct platform_device *pdev) · line 121

Quoted 5 lines
drivers/net/wireless/ath/ath9k/ahb.c +1 -1
@@ -118,7 +118,7 @@ static int ath_ahb_probe(struct platform_device *pdev)
      sc->mem = mem;
      sc->irq = irq;
 
-     ret = request_irq(irq, ath_isr, IRQF_SHARED, "ath9k", sc);
+     ret = devm_request_irq(&pdev->dev, irq, ath_isr, IRQF_SHARED, "ath9k", sc);

Sorry for the late response, but I think this patch is wrong any may need to be reverted. If there is an error during probe, and the IRQ fires for some reason, there could be an use-after-free bug when the IRQ handler accesses the data in sc.
The explicit freq_irq calls were preventing that from happening.

Quoted 8 lines
Quoted 6 lines
Quoted 5 lines
Quoted 2 lines

How about keeping the devm variant and replacing free_irq with devm_free_irq in probe?

If you do that, then using the devm variant is completely pointless. I think a full revert is the best option.

OTOH it still allows removing free_irq from _remove, but I see your point.

No, because you'd have the same use-after-free bug there as well.

Alright, let's revert. Kalle, can you just do the revert, or should I send a patch for it?

-Toke

#10 lore raw
Quoted 35 lines · Toke Høiland-Jørgensen
Quoted 33 lines · Felix Fietkau
Quoted 32 lines · Rosen Penev
Quoted 31 lines · Felix Fietkau
Quoted 28 lines · Rosen Penev
Quoted 18 lines · Felix Fietkau
Quoted 16 lines · Rosen Penev

Avoids having to manually call free_irq. Simplifies code slightly.

---
  drivers/net/wireless/ath/ath9k/ahb.c | 7 ++-----
  drivers/net/wireless/ath/ath9k/pci.c | 9 +++------
  2 files changed, 5 insertions(+), 11 deletions(-)
drivers/net/wireless/ath/ath9k/ahb.c +0 -0
index 1a6697b6e3b4..29f67ded8fe2 100644
@@ -118,7 +118,7 @@ static int ath_ahb_probe(struct platform_device *pdev)
      sc->mem = mem;
      sc->irq = irq;
 
Quoted 7 lines

drivers/net/wireless/ath/ath9k/ahb.c static int ath_ahb_probe(struct platform_device *pdev) · line 121

Quoted 2 lines
drivers/net/wireless/ath/ath9k/ahb.c +1 -1
-     ret = request_irq(irq, ath_isr, IRQF_SHARED, "ath9k", sc);
+     ret = devm_request_irq(&pdev->dev, irq, ath_isr, IRQF_SHARED, "ath9k", sc);

Sorry for the late response, but I think this patch is wrong any may need to be reverted. If there is an error during probe, and the IRQ fires for some reason, there could be an use-after-free bug when the IRQ handler accesses the data in sc.
The explicit freq_irq calls were preventing that from happening.

How about keeping the devm variant and replacing free_irq with devm_free_irq in probe?

Quoted 8 lines
Quoted 5 lines
Quoted 3 lines
Quoted 2 lines

If you do that, then using the devm variant is completely pointless. I think a full revert is the best option.

OTOH it still allows removing free_irq from _remove, but I see your point.

No, because you'd have the same use-after-free bug there as well.

Alright, let's revert. Kalle, can you just do the revert, or should I send a patch for it?

Thanks, the best is to send a patch.

But honestly more and more I'm starting to think that we should just reject all these "drive-by cleanups". We have better things to do than fixing unnecessary their bugs. Thoughts?

Signature · 3 lines
https://patchwork.kernel.org/project/linux-wireless/list/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches
#11 lore raw
Quoted 39 lines · Kalle Valo
Quoted 37 lines · Toke Høiland-Jørgensen
Quoted 35 lines · Felix Fietkau
Quoted 34 lines · Rosen Penev
Quoted 33 lines · Felix Fietkau
Quoted 26 lines · Rosen Penev
Quoted 18 lines · Felix Fietkau
Quoted 16 lines · Rosen Penev

Avoids having to manually call free_irq. Simplifies code slightly.

---
  drivers/net/wireless/ath/ath9k/ahb.c | 7 ++-----
  drivers/net/wireless/ath/ath9k/pci.c | 9 +++------
  2 files changed, 5 insertions(+), 11 deletions(-)
drivers/net/wireless/ath/ath9k/ahb.c +0 -0
index 1a6697b6e3b4..29f67ded8fe2 100644
@@ -118,7 +118,7 @@ static int ath_ahb_probe(struct platform_device *pdev)
      sc->mem = mem;
      sc->irq = irq;
 
Quoted 7 lines

drivers/net/wireless/ath/ath9k/ahb.c static int ath_ahb_probe(struct platform_device *pdev) · line 121

Quoted 2 lines
drivers/net/wireless/ath/ath9k/ahb.c +1 -1
-     ret = request_irq(irq, ath_isr, IRQF_SHARED, "ath9k", sc);
+     ret = devm_request_irq(&pdev->dev, irq, ath_isr, IRQF_SHARED, "ath9k", sc);

Sorry for the late response, but I think this patch is wrong any may need to be reverted. If there is an error during probe, and the IRQ fires for some reason, there could be an use-after-free bug when the IRQ handler accesses the data in sc.
The explicit freq_irq calls were preventing that from happening.

Quoted 2 lines

How about keeping the devm variant and replacing free_irq with devm_free_irq in probe?

If you do that, then using the devm variant is completely pointless. I think a full revert is the best option.

Quoted 8 lines
Quoted 6 lines
Quoted 3 lines
Quoted 1 line

OTOH it still allows removing free_irq from _remove, but I see your point.

No, because you'd have the same use-after-free bug there as well.

Alright, let's revert. Kalle, can you just do the revert, or should I send a patch for it?

Thanks, the best is to send a patch.

Alright, will do.

Quoted 3 lines

But honestly more and more I'm starting to think that we should just reject all these "drive-by cleanups". We have better things to do than fixing unnecessary their bugs. Thoughts?

Hmm, yeah, maybe. I do kinda like the fact that people send patches to improve small things, though. We all started out as new to the kernel, and I appreciate the fact that people try to improve our "commons" in this way even if it's small things.

I do try to be critical of things that can break stuff before ack'ing these fixes, but I'll admit that it seems like I don't have that great of a track record for judging "correct" in this context (cf this one, and that debugfs regression). So I guess you're right that I should at least raise the bar somewhat; will try to recalibrate and say no more :)

-Toke

#12 lore raw
Quoted 8 lines · Toke Høiland-Jørgensen
Quoted 3 lines

But honestly more and more I'm starting to think that we should just reject all these "drive-by cleanups". We have better things to do than fixing unnecessary their bugs. Thoughts?

Hmm, yeah, maybe. I do kinda like the fact that people send patches to improve small things, though. We all started out as new to the kernel, and I appreciate the fact that people try to improve our "commons" in this way even if it's small things.

Yeah, you have a point. It's just that the extra work from cleanups feels so unnecessary compared to the practical benefits. And most of the time we don't hear from these people ever again, that's why I call them "drive-by cleanup".

Quoted 5 lines

I do try to be critical of things that can break stuff before ack'ing these fixes, but I'll admit that it seems like I don't have that great of a track record for judging "correct" in this context (cf this one, and that debugfs regression). So I guess you're right that I should at least raise the bar somewhat; will try to recalibrate and say no more :)

You are doing a great job :) Nobody can catch all bugs in review, I would say there is a small percentage (5%?) of all cleanup patches that cause issues. Though it would be cool to see some real statistics.

Signature · 3 lines
https://patchwork.kernel.org/project/linux-wireless/list/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches
#13 lore raw
Quoted 11 lines · Kalle Valo
Quoted 8 lines · Toke Høiland-Jørgensen
Quoted 3 lines

But honestly more and more I'm starting to think that we should just reject all these "drive-by cleanups". We have better things to do than fixing unnecessary their bugs. Thoughts?

Hmm, yeah, maybe. I do kinda like the fact that people send patches to improve small things, though. We all started out as new to the kernel, and I appreciate the fact that people try to improve our "commons" in this way even if it's small things.

Quoted 4 lines

Yeah, you have a point. It's just that the extra work from cleanups feels so unnecessary compared to the practical benefits. And most of the time we don't hear from these people ever again, that's why I call them "drive-by cleanup".

Sure, I share the frustration, and not everyone turns into regular contributors. But I like to think that even those who don't get something else out of it at least. And on our side I guess there's a balance to be struck between being welcoming and not expending too much effort on it :)

Quoted 9 lines
Quoted 5 lines

I do try to be critical of things that can break stuff before ack'ing these fixes, but I'll admit that it seems like I don't have that great of a track record for judging "correct" in this context (cf this one, and that debugfs regression). So I guess you're right that I should at least raise the bar somewhat; will try to recalibrate and say no more :)

You are doing a great job :) Nobody can catch all bugs in review, I would say there is a small percentage (5%?) of all cleanup patches that cause issues. Though it would be cool to see some real statistics.

Thanks! Yeah, would love to see some statistics, but I suppose it's not trivial to identity "cleanup patches" in the first place in a way that can be automated. Maybe something to poke at sometime one has time to spare (ha!) or needs a break from the regular drudgery :)

-Toke