phy: freescale: phy-fsl-imx8qm-lvds-phy: Fix missing pm_runtime_disable() on probe error path
Subsystems (2)
PATCH v2 1/1 phy: freescale: phy-fsl-imx8qm-lvds-phy: Fix missing pm_runtime_disable() on probe error path
If mixel_lvds_phy_reset() fails in probe after pm_runtime_enable(), the function returns directly without calling pm_runtime_disable(), leaving runtime PM permanently enabled for the device.
Fix this by using devm_pm_runtime_enable() so that cleanup is automatic on any probe failure or driver unbind. This also allows removing the manual err label and the .remove callback.
---
Changes in v2:
- Change the patch's subject prefix requested by Liu Ying.
- Add Liu Ying's Acked-by.
- Link to v1: https://patch.msgid.link/[email protected]
To: Vinod Koul <[email protected]>
To: Neil Armstrong <[email protected]>
To: Frank Li <[email protected]>
To: Sascha Hauer <[email protected]>
To: Pengutronix Kernel Team <[email protected]>
To: Fabio Estevam <[email protected]>
To: Liu Ying <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
--- drivers/phy/freescale/phy-fsl-imx8qm-lvds-phy.c | 24 +++++++----------------- 1 file changed, 7 insertions(+), 17 deletions(-)
drivers/phy/freescale/phy-fsl-imx8qm-lvds-phy.c +7 -17
@@ -345,7 +345,9 @@ static int mixel_lvds_phy_probe(struct platform_device *pdev)dev_set_drvdata (dev, priv); -pm_runtime_enable (dev); + ret =devm_pm_runtime_enable (dev); +if (ret) +return ret; ret =mixel_lvds_phy_reset (dev);if (ret) {
@@ -355,17 +357,15 @@ static int mixel_lvds_phy_probe(struct platform_device *pdev)for (i =0 ; i <PHY_NUM ; i++) { lvds_phy =devm_kzalloc (dev,sizeof (*lvds_phy),GFP_KERNEL ); -if (!lvds_phy) { - ret = -ENOMEM ; - goto err; - } +if (!lvds_phy) +return -ENOMEM ; phy =devm_phy_create (dev,NULL , &mixel_lvds_phy_ops);if (IS_ERR (phy)) { ret =PTR_ERR (phy);dev_err (dev,"failed to create PHY for channel%d: %d\n" , i, ret); - goto err; +return ret; } lvds_phy->phy = phy;
@@ -379,19 +379,10 @@ static int mixel_lvds_phy_probe(struct platform_device *pdev)if (IS_ERR (phy_provider)) { ret =PTR_ERR (phy_provider);dev_err (dev,"failed to register PHY provider: %d\n" , ret); - goto err; +return ret; }return 0 ; -err: -pm_runtime_disable (dev); - -return ret; -} - -static void mixel_lvds_phy_remove (struct platform_device *pdev) -{ -pm_runtime_disable (&pdev->dev); }static int __maybe_unused mixel_lvds_phy_runtime_suspend (struct device *dev)
@@ -432,7 +423,6 @@ MODULE_DEVICE_TABLE(of, mixel_lvds_phy_of_match);static struct platform_driver mixel_lvds_phy_driver = { .probe = mixel_lvds_phy_probe, - .remove = mixel_lvds_phy_remove, .driver = { .pm = &mixel_lvds_phy_pm_ops, .name ="mixel-lvds-phy" ,
---
base-commit: a225caacc36546a09586e3ece36c0313146e7da9
change-id: 20260604-lvds-d67cb619df17
Best regards,
Signature · 1 line
Felix Gu <[email protected]>
[email protected]
AI reviewThank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
Pre-existing issues:
- [High] Pending asynchronous suspend scheduled by pm_runtime_put() can be cancelled by pm_runtime_disable() during probe failure, leaving the hardware permanently in an active power state. --
commit 8ed1a4a5b60301f95aa6700ff6d900f3ad7141f0
Author: Felix Gu <[email protected]>
phy: freescale: phy-fsl-imx8qm-lvds-phy: Fix missing pm_runtime_disable() on probe error path
This commit replaces manual pm_runtime_disable() calls with devm_pm_runtime_enable() to automatically clean up runtime PM during probe failures or unbinds.
Quoted 4 lines
drivers/phy/freescale/phy-fsl-imx8qm-lvds-phy.c +0
-0
[ ... ]
Quoted 8 lines
drivers/phy/freescale/phy-fsl-imx8qm-lvds-phy.c +0
-4@@ -355,17 +357,15 @@ static int mixel_lvds_phy_probe(struct platform_device *pdev)for (i =0 ; i <PHY_NUM ; i++) { lvds_phy =devm_kzalloc (dev,sizeof (*lvds_phy),GFP_KERNEL ); -if (!lvds_phy) { - ret = -ENOMEM ; - goto err; - }
drivers/phy/freescale/phy-fsl-imx8qm-lvds-phy.c static int mixel_lvds_phy_probe(struct platform_device *pdev) · line 368
Quoted 10 lines
drivers/phy/freescale/phy-fsl-imx8qm-lvds-phy.c +3
-1+if (!lvds_phy) +return -ENOMEM ; phy =devm_phy_create (dev,NULL , &mixel_lvds_phy_ops);if (IS_ERR (phy)) { ret =PTR_ERR (phy);dev_err (dev,"failed to create PHY for channel%d: %d\n" , i, ret); - goto err; +return ret;
[Severity: High]
This is a pre-existing issue, but will these error paths leave the hardware powered on indefinitely if initialization fails?
Just prior to this loop, mixel_lvds_phy_probe() calls mixel_lvds_phy_reset(), which finishes by queuing an asynchronous suspend:
drivers/phy/freescale/phy-fsl-imx8qm-lvds-phy.c:mixel_lvds_phy_reset() {
...
regmap_write(priv->regmap, PHY_CTRL, CTRL_RESET_VAL);
pm_runtime_put(dev);
return 0;
}If a subsequent initialization step fails and returns an error, the devres cleanup will immediately execute pm_runtime_disable() (which was also the case previously with the goto err label).
Because pm_runtime_disable() calls __pm_runtime_barrier(), it cancels any pending asynchronous idle or suspend work. This means the runtime suspend callback might never execute, leaving the PHY hardware fully powered up.
Should mixel_lvds_phy_reset() use pm_runtime_put_sync() instead to guarantee the device is properly suspended before a potential error disables runtime PM?
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1
Quoted 4 lines · Felix Gu
If
mixel_lvds_phy_reset()fails in probe afterpm_runtime_enable(), the function returns directly without callingpm_runtime_disable(), leaving runtime PM permanently enabled for the device.
Quoted 8 lines
Fix this by using
devm_pm_runtime_enable()so that cleanup is automatic on any probe failure or driver unbind. This also allows removing the manual err label and the .remove callback.Fixes 06ff622d61d2 ("phy: freescale: Add i.MX8qm Mixel LVDS PHY support")Acked-by Liu Ying <[email protected]>Signed-off-by Felix Gu <[email protected]>---
Quoted 94 lines
Changes in v2:
- Change the patch's subject prefix requested by Liu Ying.
- Add Liu Ying's Acked-by.
- Link to v1: https://patch.msgid.link/[email protected]To: Vinod Koul <[email protected]>
To: Neil Armstrong <[email protected]>
To: Frank Li <[email protected]>
To: Sascha Hauer <[email protected]>
To: Pengutronix Kernel Team <[email protected]>
To: Fabio Estevam <[email protected]>
To: Liu Ying <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]--- drivers/phy/freescale/phy-fsl-imx8qm-lvds-phy.c | 24 +++++++----------------- 1 file changed, 7 insertions(+), 17 deletions(-)drivers/phy/freescale/phy-fsl-imx8qm-lvds-phy.c +7
-18@@ -345,7 +345,9 @@ static int mixel_lvds_phy_probe(struct platform_device *pdev)dev_set_drvdata (dev, priv); -pm_runtime_enable (dev); + ret =devm_pm_runtime_enable (dev); +if (ret) +return ret; ret =mixel_lvds_phy_reset (dev);if (ret) {@@ -355,17 +357,15 @@ static int mixel_lvds_phy_probe(struct platform_device *pdev)for (i =0 ; i <PHY_NUM ; i++) { lvds_phy =devm_kzalloc (dev,sizeof (*lvds_phy),GFP_KERNEL ); -if (!lvds_phy) { - ret = -ENOMEM ; - goto err; - } +if (!lvds_phy) +return -ENOMEM ; phy =devm_phy_create (dev,NULL , &mixel_lvds_phy_ops);if (IS_ERR (phy)) { ret =PTR_ERR (phy);dev_err (dev,"failed to create PHY for channel%d: %d\n" , i, ret); - goto err; +return ret; } lvds_phy->phy = phy;@@ -379,19 +379,10 @@ static int mixel_lvds_phy_probe(struct platform_device *pdev)if (IS_ERR (phy_provider)) { ret =PTR_ERR (phy_provider);dev_err (dev,"failed to register PHY provider: %d\n" , ret); - goto err; +return ret; }return 0 ; -err: -pm_runtime_disable (dev); - -return ret; -} - -static void mixel_lvds_phy_remove (struct platform_device *pdev) -{ -pm_runtime_disable (&pdev->dev); }static int __maybe_unused mixel_lvds_phy_runtime_suspend (struct device *dev)@@ -432,7 +423,6 @@ MODULE_DEVICE_TABLE(of, mixel_lvds_phy_of_match);static struct platform_driver mixel_lvds_phy_driver = { .probe = mixel_lvds_phy_probe, - .remove = mixel_lvds_phy_remove, .driver = { .pm = &mixel_lvds_phy_pm_ops, .name ="mixel-lvds-phy" , ---base-commit:
a225caacc36546a09586e3ece36c0313146e7da9
change-id: 20260604-lvds-d67cb619df17Best regards,
--
Felix Gu <[email protected]>
Quoted 9 lines · Felix Gu
If
mixel_lvds_phy_reset()fails in probe afterpm_runtime_enable(), the function returns directly without callingpm_runtime_disable(), leaving runtime PM permanently enabled for the device.Fix this by using
devm_pm_runtime_enable()so that cleanup is automatic on any probe failure or driver unbind. This also allows removing the manual err label and the .remove callback.[...]
Applied, thanks!
[1/1] phy: freescale: phy-fsl-imx8qm-lvds-phy: Fix missing pm_runtime_disable() on probe error path
commit: 799e7cf2f0b50b34660b5ffce0f7d8dec376a0d5
Best regards,
Signature · 1 line
~Vinod