Skip to contentSkip to conversation

clk: devres: fix cleanup in devm_clk_get_optional_enabled_with_rate()

PATCH In review Onur Özkan 2 participants 4 messages Aug 9 – Sep 3 Common clk

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 clk: devres: fix cleanup in devm_clk_get_optional_enabled_with_rate()

devm_clk_get_optional_enabled_with_rate() registers its cleanup action before setting the clock rate. If setting the rate fails, it attempts to disable and unprepare a clock that was never enabled. This issue was spotted while reviewing "rust: clk: add devres-managed clks" [1].

Register the cleanup action only after successfully preparing and enabling the clock.

[1]: https://lore.kernel.org/rust-for-linux/[email protected]

Fixes 9934a1bd45b2 ("clk: provide devm_clk_get_optional_enabled_with_rate()")

---

Changes since v1:
- Explicit cleanup to avoid smatch warning.

 drivers/clk/clk-devres.c | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)
drivers/clk/clk-devres.c +12 -2
index 994d5bc5168b..66c35201104c 100644
@@ -99,6 +99,11 @@ struct clk *devm_clk_get_optional_enabled(struct device *dev, const char *id)
 }
 EXPORT_SYMBOL_GPL(devm_clk_get_optional_enabled);
 
+static void devm_clk_disable_unprepare(void *data)
+{
+	clk_disable_unprepare(data);
+}
+
 struct clk *devm_clk_get_optional_enabled_with_rate(struct device *dev,
 						    const char *id,
 						    unsigned long rate)
@@ -106,8 +111,7 @@ struct clk *devm_clk_get_optional_enabled_with_rate(struct device *dev,
 	struct clk *clk;
 	int ret;
 
-	clk = __devm_clk_get(dev, id, clk_get_optional, NULL,
-			     clk_disable_unprepare);
+	clk = devm_clk_get_optional(dev, id);
 	if (IS_ERR(clk))
 		return ERR_CAST(clk);
 
@@ -119,6 +123,12 @@ struct clk *devm_clk_get_optional_enabled_with_rate(struct device *dev,
 	if (ret)
 		goto out_put_clk;
 
+	ret = devm_add_action(dev, devm_clk_disable_unprepare, clk);
+	if (ret) {
+		clk_disable_unprepare(clk);
+		goto out_put_clk;
+	}
+
 	return clk;
 
 out_put_clk:
Signature · 1 line
2.51.2
#1 lore raw

Hi Onur,

Quoted 5 lines · Onur Özkan

devm_clk_get_optional_enabled_with_rate() registers its cleanup action before setting the clock rate. If setting the rate fails, it attempts to disable and unprepare a clock that was never enabled. This issue was spotted while reviewing "rust: clk: add devres-managed clks" [1].

Quoted 8 lines

Register the cleanup action only after successfully preparing and enabling the clock.

[1]: https://lore.kernel.org/rust-for-linux/[email protected]

Fixes 9934a1bd45b2 ("clk: provide devm_clk_get_optional_enabled_with_rate()")

This series no longer applies against the latest clk-next branch. Can you rebase this, and submit a new version? I'll be able to pick it up quickly.

Thanks,

Brian

#2 lore raw
Quoted 17 lines · On Wed, 02 Sep 2026 17:58:13 -0400 Brian Masney <[email protected]> wrote:

Hi Onur,

Quoted 5 lines · Onur Özkan

devm_clk_get_optional_enabled_with_rate() registers its cleanup action before setting the clock rate. If setting the rate fails, it attempts to disable and unprepare a clock that was never enabled. This issue was spotted while reviewing "rust: clk: add devres-managed clks" [1].

Quoted 8 lines

Register the cleanup action only after successfully preparing and enabling the clock.

[1]: https://lore.kernel.org/rust-for-linux/[email protected]

Fixes 9934a1bd45b2 ("clk: provide devm_clk_get_optional_enabled_with_rate()")
Quoted 7 lines

This series no longer applies against the latest clk-next branch. Can you rebase this, and submit a new version? I'll be able to pick it up quickly.

Thanks,

Brian

Hi Brian,

It seems that the fix has already been applied, but v1 was picked instead of v2. I sent v2 the next day after receiving warnings from the kernel bot [1], at which point v1 had not yet been applied anywhere.

[1]: https://lore.kernel.org/all/[email protected]

So this patch itself is no longer necessary since the fix is already there. If you still want to get rid of the warnings I can send another patch for it.

- Onur

#3 lore raw

Hi Onur,

Quoted 8 lines · Onur Özkan

It seems that the fix has already been applied, but v1 was picked instead of v2. I sent v2 the next day after receiving warnings from the kernel bot [1], at which point v1 had not yet been applied anywhere.

[1]: https://lore.kernel.org/all/[email protected]

So this patch itself is no longer necessary since the fix is already there. If you still want to get rid of the warnings I can send another patch for it.

Please submit a separate patch to get rid of the warnings.

Thanks,
Brian