rtc: stm32: fix clock leak on pinctrl probe failure
Subsystems (2)
PATCH 1/1 rtc: stm32: fix clock leak on pinctrl probe failure
stm32_rtc_probe() enables rtc_ck/pclk early and unwinds them through the err: label on every later failure -- except a failing devm_pinctrl_register_and_init() or pinctrl_enable(), which both return directly, leaking both clocks. -EPROBE_DEFER is a routine outcome from pinctrl lookups during boot, so each deferred retry leaks another reference.
Route both through the existing err: label, matching every other post-enable failure path in this function.
--- drivers/rtc/rtc-stm32.c | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-)
drivers/rtc/rtc-stm32.c +8 -4
@@ -1175,12 +1175,16 @@ static int stm32_rtc_probe(struct platform_device *pdev)stm32_rtc_clean_outs (rtc); ret =devm_pinctrl_register_and_init (&pdev->dev, &stm32_rtc_pdesc, rtc, &pctl); -if (ret) -return dev_err_probe (&pdev->dev, ret,"pinctrl register failed" ); +if (ret) { +dev_err_probe (&pdev->dev, ret,"pinctrl register failed" ); + goto err; + } ret =pinctrl_enable (pctl); -if (ret) -return dev_err_probe (&pdev->dev, ret,"pinctrl enable failed" ); +if (ret) { +dev_err_probe (&pdev->dev, ret,"pinctrl enable failed" ); + goto err; + }/* * If INITS flag is reset (calendar year field set to 0x00), calendar
Signature · 1 line
2.25.1
[email protected]
AI reviewThank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [High] Routing pinctrl failures to the manual clock cleanup path creates a critical window where…
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [High] Routing pinctrl failures to the manual clock cleanup path creates a critical window where devm-managed resources (IRQ, RTC device) remain active while hardware clocks are disabled, risking a synchronous external abort (bus fault). --
commit 813d70ca28c122c9814bc7903a9c96494f127aea
Author: Cong Nguyen <[email protected]>
rtc: stm32: fix clock leak on pinctrl probe failure
This commit addresses a clock leak during pinctrl probe failure. It updates the error handling paths for devm_pinctrl_register_and_init() and pinctrl_enable() to route through the existing err label, ensuring rtc_ck and pclk are unwound properly.
Quoted 4 lines
drivers/rtc/rtc-stm32.c +0
-0
[ ... ]
drivers/rtc/rtc-stm32.c static int stm32_rtc_probe(struct platform_device *pdev) · line 1180
Quoted 9 lines
drivers/rtc/rtc-stm32.c +3
-2@@ -1175,12 +1175,16 @@ static int stm32_rtc_probe(struct platform_device *pdev)stm32_rtc_clean_outs (rtc); ret =devm_pinctrl_register_and_init (&pdev->dev, &stm32_rtc_pdesc, rtc, &pctl); -if (ret) -return dev_err_probe (&pdev->dev, ret,"pinctrl register failed" ); +if (ret) { +dev_err_probe (&pdev->dev, ret,"pinctrl register failed" ); + goto err;
[Severity: High]
Does this new error path create a window for a synchronous external abort?
When pinctrl initialization fails (for example, returning -EPROBE_DEFER), this now jumps to the err label where rtc_ck and pclk are manually disabled.
However, the RTC device and the alarm IRQ were registered earlier in the probe function using devres-managed functions:
stm32_rtc_probe()
rtc->rtc_dev = devm_rtc_device_register(...);
ret = devm_request_threaded_irq(..., stm32_rtc_alarm_irq, ...);Because devres resources are not released until after the probe function returns, there is a window where the clocks are disabled but the IRQ handler and RTC device remain active.
Could the still-registered IRQ fire during this cleanup window? If that happens, or if userspace accesses the RTC device, driver callbacks like stm32_rtc_alarm_irq() might attempt to access hardware registers without the APB clock enabled, resulting in a bus fault.
Quoted 9 lines
drivers/rtc/rtc-stm32.c +5
-2+ } ret =pinctrl_enable (pctl); -if (ret) -return dev_err_probe (&pdev->dev, ret,"pinctrl enable failed" ); +if (ret) { +dev_err_probe (&pdev->dev, ret,"pinctrl enable failed" ); + goto err; + }
[ ... ]
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1
Quoted 7 lines · Cong Nguyen
stm32_rtc_probe()enables rtc_ck/pclk early and unwinds them through the err: label on every later failure -- except a failingdevm_pinctrl_register_and_init()orpinctrl_enable(), which both return directly, leaking both clocks. -EPROBE_DEFER is a routine outcome from pinctrl lookups during boot, so each deferred retry leaks another reference.
Quoted 5 lines
Route both through the existing err: label, matching every other post-enable failure path in this function.
Fixes 16ad2bc09efb ("rtc: stm32: add pinctrl and pinmux interfaces")Assisted-by Claude:claude-opus-4
Shouldn't it be
accordingly to commit 816d9992d9ed in latestDocumentation/process/coding-assistants.rst ?
Quoted 2 lines
Signed-off-by Cong Nguyen <[email protected]>---
Apart from the comment above,
Thanks!
Antonio