Skip to contentSkip to conversation

pci: controller: pci-ftpci100: Release the clock resources

PATCH Applied Junyan Ye 4 participants 5 messages May 8, 2023 – May 29, 2023

Subsystems (2)
lore
Share & tools
lore

Junyan Ye

author
#0 lore raw

PATCH v3 1/1 pci: controller: pci-ftpci100: Release the clock resources

Smatch reported:
1. drivers/pci/controller/pci-ftpci100.c:526 faraday_pci_probe() warn:
'clk' from clk_prepare_enable() not released on lines: 442,451,462,478,512,517.
2. drivers/pci/controller/pci-ftpci100.c:526 faraday_pci_probe() warn:
'p->bus_clk' from clk_prepare_enable() not released on lines: 451,462,478,512,517.

The clock resource is obtained by devm_clk_get(), and then clk_prepare_enable() makes the clock resource ready for use. After that, clk_disable_unprepare() should be called to release the clock resource when it is no longer needed. However, while doing some error handling in faraday_pci_probe(), clk_disable_unprepare() is not called to release clk and p->bus_clk before returning. These return lines are exactly 442, 451, 462, 478, 512, 517.

Fix this warning by replacing devm_clk_get() with devm_clk_get_enabled(), which is equivalent to devm_clk_get() + clk_prepare_enable(). And with devm_clk_get_enabled(), the clock will automatically be disabled, unprepared and freed when the device is unbound from the bus.

Fixes b3c433efb8a3 ("PCI: faraday: Fix wrong pointer passed to PTR_ERR()")
Fixes 2eeb02b28579 ("PCI: faraday: Add clock handling")
Fixes 783a862563f7 ("PCI: faraday: Use pci_parse_request_of_pci_ranges()")
Fixes d3c68e0a7e34 ("PCI: faraday: Add Faraday Technology FTPCI100 PCI Host Bridge driver")
Fixes f1e8bd21e39e ("PCI: faraday: Convert IRQ masking to raw PCI config accessors")

---
v2 -> v3: Rebase to v6.4-rc1 and modify commit message.
v1 -> v2: Switch from clk_disable_unprepare() to devm_clk_get_enabled() to release the clock. This issue is found by static analyzer.

 drivers/pci/controller/pci-ftpci100.c | 14 ++------------
 1 file changed, 2 insertions(+), 12 deletions(-)
drivers/pci/controller/pci-ftpci100.c +2 -12
index ecd3009df586..6e7981d2ed5e 100644
@@ -429,22 +429,12 @@ static int faraday_pci_probe(struct platform_device *pdev)
 	p->dev = dev;
 
 	/* Retrieve and enable optional clocks */
-	clk = devm_clk_get(dev, "PCLK");
+	clk = devm_clk_get_enabled(dev, "PCLK");
 	if (IS_ERR(clk))
 		return PTR_ERR(clk);
-	ret = clk_prepare_enable(clk);
-	if (ret) {
-		dev_err(dev, "could not prepare PCLK\n");
-		return ret;
-	}
-	p->bus_clk = devm_clk_get(dev, "PCICLK");
+	p->bus_clk = devm_clk_get_enabled(dev, "PCICLK");
 	if (IS_ERR(p->bus_clk))
 		return PTR_ERR(p->bus_clk);
-	ret = clk_prepare_enable(p->bus_clk);
-	if (ret) {
-		dev_err(dev, "could not prepare PCICLK\n");
-		return ret;
-	}
 
 	p->base = devm_platform_ioremap_resource(pdev, 0);
 	if (IS_ERR(p->base))
Signature · 1 line
2.25.1
Reviewed-by on v3 1/1
#1 lore raw
Quoted 26 lines · Junyan Ye

Smatch reported:
1. drivers/pci/controller/pci-ftpci100.c:526 faraday_pci_probe() warn:
'clk' from clk_prepare_enable() not released on lines: 442,451,462,478,512,517.
2. drivers/pci/controller/pci-ftpci100.c:526 faraday_pci_probe() warn:
'p->bus_clk' from clk_prepare_enable() not released on lines: 451,462,478,512,517.

The clock resource is obtained by devm_clk_get(), and then clk_prepare_enable() makes the clock resource ready for use. After that, clk_disable_unprepare() should be called to release the clock resource when it is no longer needed. However, while doing some error handling in faraday_pci_probe(), clk_disable_unprepare() is not called to release clk and p->bus_clk before returning. These return lines are exactly 442, 451, 462, 478, 512, 517.

Fix this warning by replacing devm_clk_get() with devm_clk_get_enabled(), which is equivalent to devm_clk_get() + clk_prepare_enable(). And with devm_clk_get_enabled(), the clock will automatically be disabled, unprepared and freed when the device is unbound from the bus.

Fixes b3c433efb8a3 ("PCI: faraday: Fix wrong pointer passed to PTR_ERR()")
Fixes 2eeb02b28579 ("PCI: faraday: Add clock handling")
Fixes 783a862563f7 ("PCI: faraday: Use pci_parse_request_of_pci_ranges()")
Fixes d3c68e0a7e34 ("PCI: faraday: Add Faraday Technology FTPCI100 PCI Host Bridge driver")
Fixes f1e8bd21e39e ("PCI: faraday: Convert IRQ masking to raw PCI config accessors")
Quoted 2 lines

---
v2 -> v3: Rebase to v6.4-rc1 and modify commit message.

It's a fine fix since it saves lots of code.

I would merge it as a non-urgent fix.

Yours,
Linus Walleij

#2 lore raw
In reply to Junyan Ye

Le 08/05/2023 à 06:36, Junyan Ye a écrit :

Quoted 39 lines

Smatch reported:
1. drivers/pci/controller/pci-ftpci100.c:526 faraday_pci_probe() warn:
'clk' from clk_prepare_enable() not released on lines: 442,451,462,478,512,517.
2. drivers/pci/controller/pci-ftpci100.c:526 faraday_pci_probe() warn:
'p->bus_clk' from clk_prepare_enable() not released on lines: 451,462,478,512,517.

The clock resource is obtained by devm_clk_get(), and then clk_prepare_enable() makes the clock resource ready for use. After that, clk_disable_unprepare() should be called to release the clock resource when it is no longer needed. However, while doing some error handling in faraday_pci_probe(), clk_disable_unprepare() is not called to release clk and p->bus_clk before returning. These return lines are exactly 442, 451, 462, 478, 512, 517.

Fix this warning by replacing devm_clk_get() with devm_clk_get_enabled(), which is equivalent to devm_clk_get() + clk_prepare_enable(). And with devm_clk_get_enabled(), the clock will automatically be disabled, unprepared and freed when the device is unbound from the bus.

Fixes b3c433efb8a3 ("PCI: faraday: Fix wrong pointer passed to PTR_ERR()")
Fixes 2eeb02b28579 ("PCI: faraday: Add clock handling")
Fixes 783a862563f7 ("PCI: faraday: Use pci_parse_request_of_pci_ranges()")
Fixes d3c68e0a7e34 ("PCI: faraday: Add Faraday Technology FTPCI100 PCI Host Bridge driver")
Fixes f1e8bd21e39e ("PCI: faraday: Convert IRQ masking to raw PCI config accessors")

---
v2 -> v3: Rebase to v6.4-rc1 and modify commit message.
v1 -> v2: Switch from clk_disable_unprepare() to devm_clk_get_enabled() to release the clock. This issue is found by static analyzer.

  drivers/pci/controller/pci-ftpci100.c | 14 ++------------
  1 file changed, 2 insertions(+), 12 deletions(-)
drivers/pci/controller/pci-ftpci100.c +0 -0
index ecd3009df586..6e7981d2ed5e 100644

drivers/pci/controller/pci-ftpci100.c static int faraday_pci_probe(struct platform_device *pdev) · line 431

Quoted 3 lines
drivers/pci/controller/pci-ftpci100.c +0 -0
@@ -429,22 +429,12 @@ static int faraday_pci_probe(struct platform_device *pdev)
  	p->dev = dev;
 
  	/* Retrieve and enable optional clocks */

Hi,

completely unrelated to your patch, but this comments state "optional". The code below seems to make both clocks mandatory.

Moreover, a few lines later, we have:

    if (!IS_ERR(p->bus_clk)) {

which seems to say that bus_clk is optional.

This was introduced by 2eeb02b28579.

Just a guess, but either the comment should be updated, or the code modified.

Just my 2c,

CJ

Quoted 21 lines
drivers/pci/controller/pci-ftpci100.c +2 -12
-	clk = devm_clk_get(dev, "PCLK");
+	clk = devm_clk_get_enabled(dev, "PCLK");
  	if (IS_ERR(clk))
  		return PTR_ERR(clk);
-	ret = clk_prepare_enable(clk);
-	if (ret) {
-		dev_err(dev, "could not prepare PCLK\n");
-		return ret;
-	}
-	p->bus_clk = devm_clk_get(dev, "PCICLK");
+	p->bus_clk = devm_clk_get_enabled(dev, "PCICLK");
  	if (IS_ERR(p->bus_clk))
  		return PTR_ERR(p->bus_clk);
-	ret = clk_prepare_enable(p->bus_clk);
-	if (ret) {
-		dev_err(dev, "could not prepare PCICLK\n");
-		return ret;
-	}
 
  	p->base = devm_platform_ioremap_resource(pdev, 0);
  	if (IS_ERR(p->base))
#3 lore raw
Quoted 11 lines · Christophe JAILLET

completely unrelated to your patch, but this comments state "optional". The code below seems to make both clocks mandatory.

Moreover, a few lines later, we have:

     if (!IS_ERR(p->bus_clk)) {

which seems to say that bus_clk is optional.

This was introduced by 2eeb02b28579.

Just a guess, but either the comment should be updated, or the code modified.

It's fine to make the clocks mandatory, because all Gemini systems provide these clocks.

But that is good to mention in the commit message as well.

Yours,
Linus Walleij

maintainer Applied
#4 lore raw
In reply to Junyan Ye
Quoted 14 lines · Junyan Ye

Smatch reported:
1. drivers/pci/controller/pci-ftpci100.c:526 faraday_pci_probe() warn:
'clk' from clk_prepare_enable() not released on lines: 442,451,462,478,512,517.
2. drivers/pci/controller/pci-ftpci100.c:526 faraday_pci_probe() warn:
'p->bus_clk' from clk_prepare_enable() not released on lines: 451,462,478,512,517.

The clock resource is obtained by devm_clk_get(), and then clk_prepare_enable() makes the clock resource ready for use. After that, clk_disable_unprepare() should be called to release the clock resource when it is no longer needed. However, while doing some error handling in faraday_pci_probe(), clk_disable_unprepare() is not called to release clk and p->bus_clk before returning. These return lines are exactly 442, 451, 462, 478, 512, 517.

Quoted 1 line

[...]

Applied to pci/ftpci100, thanks!

[1/1] pci: controller: pci-ftpci100: Release the clock resources

      https://git.kernel.org/pci/pci/c/c60738de85f4

Thanks,
Lorenzo