net: can: Convert to DEFINE_SIMPLE_DEV_PM_OPS()
PATCH 1/1 net: can: Convert to DEFINE_SIMPLE_DEV_PM_OPS()
Convert the deprecated SIMPLE_DEV_PM_OPS to DEFINE_SIMPLE_DEV_PM_OPS and pm_sleep_ptr().
This lets us drop the __maybe_unused annotations from the suspend and resume callbacks, also reduces kernel size in case CONFIG_PM or CONFIG_PM_SLEEP is disabled.
--- drivers/net/can/bxcan.c | 8 ++++---- drivers/net/can/ctucanfd/ctucanfd.h | 4 ++-- drivers/net/can/ctucanfd/ctucanfd_pci.c | 4 ++-- drivers/net/can/ctucanfd/ctucanfd_platform.c | 4 ++-- drivers/net/can/m_can/m_can_pci.c | 8 ++++---- drivers/net/can/spi/hi311x.c | 8 ++++---- drivers/net/can/spi/mcp251x.c | 8 ++++---- 7 files changed, 22 insertions(+), 22 deletions(-)
drivers/net/can/bxcan.c +4 -4
@@ -1042,7 +1042,7 @@ static void bxcan_remove(struct platform_device *pdev)free_candev (ndev); } -static int __maybe_unused bxcan_suspend (struct device *dev) +static int bxcan_suspend (struct device *dev) {struct net_device *ndev =dev_get_drvdata (dev);struct bxcan_priv *priv =netdev_priv (ndev);
@@ -1059,7 +1059,7 @@ static int __maybe_unused bxcan_suspend(struct device *dev)return 0 ; } -static int __maybe_unused bxcan_resume (struct device *dev) +static int bxcan_resume (struct device *dev) {struct net_device *ndev =dev_get_drvdata (dev);struct bxcan_priv *priv =netdev_priv (ndev);
@@ -1076,7 +1076,7 @@ static int __maybe_unused bxcan_resume(struct device *dev)return 0 ; } -static SIMPLE_DEV_PM_OPS(bxcan_pm_ops, bxcan_suspend, bxcan_resume); +static DEFINE_SIMPLE_DEV_PM_OPS(bxcan_pm_ops, bxcan_suspend, bxcan_resume);static const struct of_device_id bxcan_of_match[] = { {.compatible ="st,stm32f4-bxcan" },
@@ -1087,7 +1087,7 @@ MODULE_DEVICE_TABLE(of, bxcan_of_match);static struct platform_driver bxcan_driver = { .driver = { .name =KBUILD_MODNAME , - .pm = &bxcan_pm_ops, + .pm =pm_sleep_ptr (&bxcan_pm_ops), .of_match_table = bxcan_of_match, }, .probe = bxcan_probe,
drivers/net/can/ctucanfd/ctucanfd.h +2 -2
@@ -76,7 +76,7 @@ int ctucan_probe_common(struct device *dev, void __iomem *addr,void (*set_drvdata_fnc)(struct device *dev, struct net_device *ndev)); -int ctucan_suspend (struct device *dev)__maybe_unused ; -int ctucan_resume (struct device *dev)__maybe_unused ; +int ctucan_suspend (struct device *dev); +int ctucan_resume (struct device *dev);#endif /*__CTUCANFD__*/
drivers/net/can/ctucanfd/ctucanfd_pci.c +2 -2
@@ -259,7 +259,7 @@ static void ctucan_pci_remove(struct pci_dev *pdev)kfree (bdata); } -static SIMPLE_DEV_PM_OPS(ctucan_pci_pm_ops, ctucan_suspend, ctucan_resume); +static DEFINE_SIMPLE_DEV_PM_OPS(ctucan_pci_pm_ops, ctucan_suspend, ctucan_resume);static const struct pci_device_id ctucan_pci_tbl[] = { {PCI_DEVICE_DATA(TEDIA, CTUCAN_VER21,
@@ -273,7 +273,7 @@ static struct pci_driver ctucan_pci_driver = { .id_table = ctucan_pci_tbl, .probe = ctucan_pci_probe, .remove = ctucan_pci_remove, - .driver.pm = &ctucan_pci_pm_ops, + .driver.pm = pm_sleep_ptr(&ctucan_pci_pm_ops), };module_pci_driver (ctucan_pci_driver);
drivers/net/can/ctucanfd/ctucanfd_platform.c +2 -2
@@ -99,7 +99,7 @@ static void ctucan_platform_remove(struct platform_device *pdev)free_candev (ndev); } -static SIMPLE_DEV_PM_OPS(ctucan_platform_pm_ops, ctucan_suspend, ctucan_resume); +static DEFINE_SIMPLE_DEV_PM_OPS(ctucan_platform_pm_ops, ctucan_suspend, ctucan_resume);/* Match table for OF platform binding */ static const struct of_device_id ctucan_of_match[] = {
@@ -114,7 +114,7 @@ static struct platform_driver ctucanfd_driver = { .remove = ctucan_platform_remove, .driver = { .name = DRV_NAME, - .pm = &ctucan_platform_pm_ops, + .pm = pm_sleep_ptr(&ctucan_platform_pm_ops), .of_match_table = ctucan_of_match, }, };
drivers/net/can/m_can/m_can_pci.c +4 -4
@@ -169,17 +169,17 @@ static void m_can_pci_remove(struct pci_dev *pci)pci_free_irq_vectors (pci); } -static __maybe_unused int m_can_pci_suspend (struct device *dev) +static int m_can_pci_suspend (struct device *dev) {return m_can_class_suspend (dev); } -static __maybe_unused int m_can_pci_resume (struct device *dev) +static int m_can_pci_resume (struct device *dev) {return m_can_class_resume (dev); } -static SIMPLE_DEV_PM_OPS(m_can_pci_pm_ops, +static DEFINE_SIMPLE_DEV_PM_OPS(m_can_pci_pm_ops, m_can_pci_suspend, m_can_pci_resume);static const struct pci_device_id m_can_pci_id_table[] = {
@@ -195,7 +195,7 @@ static struct pci_driver m_can_pci_driver = { .remove = m_can_pci_remove, .id_table = m_can_pci_id_table, .driver = { - .pm = &m_can_pci_pm_ops, + .pm = pm_sleep_ptr(&m_can_pci_pm_ops), }, };
drivers/net/can/spi/hi311x.c +4 -4
@@ -972,7 +972,7 @@ static void hi3110_can_remove(struct spi_device *spi)free_candev (net); } -static int __maybe_unused hi3110_can_suspend (struct device *dev) +static int hi3110_can_suspend (struct device *dev) {struct spi_device *spi =to_spi_device (dev);struct hi3110_priv *priv =spi_get_drvdata (spi);
@@ -1002,7 +1002,7 @@ static int __maybe_unused hi3110_can_suspend(struct device *dev)return 0 ; } -static int __maybe_unused hi3110_can_resume (struct device *dev) +static int hi3110_can_resume (struct device *dev) {struct spi_device *spi =to_spi_device (dev);struct hi3110_priv *priv =spi_get_drvdata (spi);
@@ -1022,13 +1022,13 @@ static int __maybe_unused hi3110_can_resume(struct device *dev)return 0 ; } -static SIMPLE_DEV_PM_OPS(hi3110_can_pm_ops, hi3110_can_suspend, hi3110_can_resume); +static DEFINE_SIMPLE_DEV_PM_OPS(hi3110_can_pm_ops, hi3110_can_suspend, hi3110_can_resume);static struct spi_driver hi3110_can_driver = { .driver = { .name =DEVICE_NAME , .of_match_table = hi3110_of_match, - .pm = &hi3110_can_pm_ops, + .pm =pm_sleep_ptr (&hi3110_can_pm_ops), }, .id_table = hi3110_id_table, .probe = hi3110_can_probe,
drivers/net/can/spi/mcp251x.c +4 -4
@@ -1490,7 +1490,7 @@ static void mcp251x_can_remove(struct spi_device *spi)free_candev (net); } -static int __maybe_unused mcp251x_can_suspend (struct device *dev) +static int mcp251x_can_suspend (struct device *dev) {struct spi_device *spi =to_spi_device (dev);struct mcp251x_priv *priv =spi_get_drvdata (spi);
@@ -1517,7 +1517,7 @@ static int __maybe_unused mcp251x_can_suspend(struct device *dev)return 0 ; } -static int __maybe_unused mcp251x_can_resume (struct device *dev) +static int mcp251x_can_resume (struct device *dev) {struct spi_device *spi =to_spi_device (dev);struct mcp251x_priv *priv =spi_get_drvdata (spi);
@@ -1551,14 +1551,14 @@ static int __maybe_unused mcp251x_can_resume(struct device *dev)return 0 ; } -static SIMPLE_DEV_PM_OPS(mcp251x_can_pm_ops, mcp251x_can_suspend, +static DEFINE_SIMPLE_DEV_PM_OPS(mcp251x_can_pm_ops, mcp251x_can_suspend, mcp251x_can_resume);static struct spi_driver mcp251x_can_driver = { .driver = { .name =DEVICE_NAME , .of_match_table = mcp251x_of_match, - .pm = &mcp251x_can_pm_ops, + .pm =pm_sleep_ptr (&mcp251x_can_pm_ops), }, .id_table = mcp251x_id_table, .probe = mcp251x_can_probe,
Signature · 1 line
2.53.0
[email protected]
AI reviewThank you for your contribution! Sashiko AI review found 5 potential issue(s) to consider:
Thank you for your contribution! Sashiko AI review found 5 potential issue(s) to consider:
Pre-existing issues:
- [High] Missing synchronous cancellation of the polling hrtimer during device teardown leads to a use-after-free.
- [High] Workqueue is flushed after the device's power has been disabled, causing pending works to access unpowered hardware.
- [High] Missing IRQ synchronization in bxcan_suspend causes a system crash when a shared interrupt fires.
- [High] Missing NAPI synchronization in m_can_class_suspend allows concurrent access to unclocked registers.
- [High] Missing NAPI and IRQ synchronization in ctucan_suspend leads to use-after-suspend register access. --
--- Patch [1]: [PATCH] net: can: Convert to DEFINE_SIMPLE_DEV_PM_OPS() --- commit a15538c2b4418f8d2120cca5fc551587851481fe
Author: Triet Hoang <[email protected]>
net: can: Convert to DEFINE_SIMPLE_DEV_PM_OPS()
Convert the deprecated SIMPLE_DEV_PM_OPS to DEFINE_SIMPLE_DEV_PM_OPS and pm_sleep_ptr().
This lets us drop the __maybe_unused annotations from the suspend and resume callbacks, also reduces kernel size in case CONFIG_PM or CONFIG_PM_SLEEP is disabled.
Quoted 4 lines
drivers/net/can/bxcan.c +0
-0
[ ... ]
drivers/net/can/bxcan.c static void bxcan_remove(struct platform_device *pdev) · line 1048
Quoted 5 lines
drivers/net/can/bxcan.c +1
-1-static int __maybe_unused bxcan_suspend (struct device *dev) +static int bxcan_suspend (struct device *dev) {struct net_device *ndev =dev_get_drvdata (dev);struct bxcan_priv *priv =netdev_priv (ndev);
[Severity: High]
This is a pre-existing issue, but does this suspend logic correctly handle shared interrupts?
In bxcan_suspend(), the device clock is turned off:
bxcan_suspend() {
...
bxcan_enter_sleep_mode(priv);
priv->can.state = CAN_STATE_SLEEPING;
clk_disable_unprepare(priv->clk);
return 0;
}If another device sharing the same IRQ line triggers an interrupt while the clock is disabled, the kernel will execute bxcan_rx_isr() and unconditionally attempt to read regs->rf0r. Would reading from this unclocked peripheral register cause a fatal bus fault?
[ ... ]
Quoted 4 lines
drivers/net/can/ctucanfd/ctucanfd_pci.c +0
-0
[ ... ]
drivers/net/can/ctucanfd/ctucanfd_pci.c static void ctucan_pci_remove(struct pci_dev *pdev) · line 262
Quoted 2 lines
drivers/net/can/ctucanfd/ctucanfd_pci.c +1
-1-static SIMPLE_DEV_PM_OPS(ctucan_pci_pm_ops, ctucan_suspend, ctucan_resume); +static DEFINE_SIMPLE_DEV_PM_OPS(ctucan_pci_pm_ops, ctucan_suspend, ctucan_resume);
[Severity: High]
This isn't a bug introduced by this patch, but does ctucan_suspend() properly disable hardware interrupts and NAPI?
It transitions the device state to CAN_STATE_SLEEPING, but leaves interrupts and NAPI active before returning.
When the parent PCI bus transitions the device to a low-power state and MMIO access is disabled, could a shared interrupt or scheduled NAPI handler read from the powered-down MMIO space?
Reading from powered-down MMIO typically returns 0xFFFFFFFF, which might cause the ISR to assume all interrupts are active, scheduling NAPI again and potentially entering an infinite polling loop.
[ ... ]
drivers/net/can/m_can/m_can_pci.c static void m_can_pci_remove(struct pci_dev *pci) · line 170
Quoted 7 lines
drivers/net/can/m_can/m_can_pci.c +0
-0@@ -169,17 +169,17 @@ static void m_can_pci_remove(struct pci_dev *pci)pci_free_irq_vectors (pci); }
[Severity: High]
This is a pre-existing issue, but could this lead to a use-after-free during device teardown?
In m_can_pci_remove(), we call m_can_class_free_dev(), which frees the memory backing the device:
m_can_pci_remove() {
...
m_can_class_unregister(mcan_class);
m_can_class_free_dev(mcan_class->net);
pci_free_irq_vectors(pci);
}However, earlier in the unregister path (m_can_close() calling m_can_disable_all_interrupts()), it uses hrtimer_try_to_cancel().
Because hrtimer_try_to_cancel() does not wait for the timer callback to finish if it's currently executing on another CPU, if the timer is still running, could the callback subsequently access the freed cdev->can.state?
drivers/net/can/m_can/m_can_pci.c static void m_can_pci_remove(struct pci_dev *pci) · line 175
Quoted 5 lines
drivers/net/can/m_can/m_can_pci.c +1
-1-static __maybe_unused int m_can_pci_suspend (struct device *dev) +static int m_can_pci_suspend (struct device *dev) {return m_can_class_suspend (dev); }
[Severity: High]
This isn't a bug introduced by this patch, but can this suspend flow lead to a system crash due to a NAPI race?
m_can_class_suspend() disables device clocks via m_can_clk_stop() without explicitly disabling NAPI:
m_can_class_suspend() {
...
} else {
m_can_stop(ndev);
}
m_can_clk_stop(cdev);
cdev->can.state = CAN_STATE_SLEEPING;
}
...
}If an interrupt fires just before or during suspend, napi_schedule() can queue the NAPI poll function (m_can_poll). Could this asynchronous softirq execute after the clocks are turned off and read the M_CAN_IR register from the unclocked peripheral, triggering a bus fault?
[ ... ]
drivers/net/can/spi/hi311x.c static void hi3110_can_remove(struct spi_device *spi) · line 973
Quoted 7 lines
drivers/net/can/spi/hi311x.c +0
-0@@ -972,7 +972,7 @@ static void hi3110_can_remove(struct spi_device *spi)free_candev (net); }
[Severity: High]
This is a pre-existing issue, but does this workqueue teardown order cause pending works to access unpowered hardware?
In hi3110_can_remove() (and similarly in mcp251x_can_remove()), the device power regulators are disabled before calling destroy_workqueue(priv->wq):
hi3110_can_remove() {
...
hi3110_power_enable(priv->power, 0);
destroy_workqueue(priv->wq);
priv->wq = NULL;
...
}Since destroy_workqueue() synchronously flushes any pending work items, could a pending restart_work execute and attempt to communicate with the SPI device while its power regulators are already turned off?
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1
Marc Kleine-Budde
maintainerQuoted 3 lines · Triet Hoang
drivers/net/can/ctucanfd/ctucanfd.h | 4 ++-- drivers/net/can/ctucanfd/ctucanfd_pci.c | 4 ++-- drivers/net/can/ctucanfd/ctucanfd_platform.c | 4 ++--
Clashiko has found an issue with the ctucanfd driver. Can you re-spin the ctucanfd changes only?
regards,
Marc
https://netdev-ai.bots.linux.dev/sashiko/#/patchset/[email protected]
--- Patch [4]: [PATCH net-next 04/12] can: convert to DEFINE_SIMPLE_DEV_PM_OPS() --- commit 2eebc61f80e1b0678405e6e773cda6ae37343aba
Author: Triet Hoang <[email protected]>
can: convert to DEFINE_SIMPLE_DEV_PM_OPS()
This converts seven CAN drivers from SIMPLE_DEV_PM_OPS() to DEFINE_SIMPLE_DEV_PM_OPS() and wraps the .pm pointers in pm_sleep_ptr(). It also drops the __maybe_unused annotations from the suspend and resume callbacks.
drivers/net/can/ctucanfd/ctucanfd.h int ctucan_probe_common(struct device *dev, void __iomem *addr, · line 80
Quoted 12 lines
drivers/net/can/ctucanfd/ctucanfd.h +2
-2@@ -76,7 +76,7 @@ int ctucan_probe_common(struct device *dev, void __iomem *addr,void (*set_drvdata_fnc)(struct device *dev, struct net_device *ndev)); -int ctucan_suspend (struct device *dev)__maybe_unused ; -int ctucan_resume (struct device *dev)__maybe_unused ; +int ctucan_suspend (struct device *dev); +int ctucan_resume (struct device *dev);
Discovered by: opus-5-5 · Missed by: sashiko-gemini
This isn't a bug, but does the size reduction in the commit message hold for the ctucanfd drivers?
"also reduces kernel size in case CONFIG_PM or CONFIG_PM_SLEEP is disabled."
ctucan_suspend() and ctucan_resume() are global functions in ctucanfd_base.c. They are exported with no CONFIG_PM_SLEEP guard:
drivers/net/can/ctucanfd/ctucanfd_base.c:
int ctucan_suspend(struct device *dev)
{
...
}EXPORT_SYMBOL(ctucan_suspend);
int ctucan_resume(struct device *dev)
{
...
}EXPORT_SYMBOL(ctucan_resume);
With CONFIG_PM_SLEEP=n, pm_sleep_ptr() only lets the compiler drop the static ctucan_pci_pm_ops and ctucan_platform_pm_ops structs. The callback bodies and their export entries are still built and linked.
The __maybe_unused removal in this header also has no effect. -Wunused-function does not warn about non-static functions, so the attribute was not suppressing anything here.
To get the saving for ctucanfd, could the base module export the PM ops instead, for example with EXPORT_SIMPLE_DEV_PM_OPS() or EXPORT_GPL_SIMPLE_DEV_PM_OPS() in ctucanfd_base.c, and have the glue drivers use pm_sleep_ptr() on that? Alternatively, the commit message could say that the claim does not apply to ctucanfd.
No later patch in the series touches drivers/net/can/ctucanfd/, so this is still the case at the end of the series.
Quoted 10 lines
drivers/net/can/ctucanfd/ctucanfd_pci.c +1
-1@@ -259,7 +259,7 @@ static void ctucan_pci_remove(struct pci_dev *pdev)kfree (bdata); } -static SIMPLE_DEV_PM_OPS(ctucan_pci_pm_ops, ctucan_suspend, ctucan_resume); +static DEFINE_SIMPLE_DEV_PM_OPS(ctucan_pci_pm_ops, ctucan_suspend, ctucan_resume);
[ ... ]
Quoted 10 lines
drivers/net/can/ctucanfd/ctucanfd_platform.c +1
-1@@ -99,7 +99,7 @@ static void ctucan_platform_remove(struct platform_device *pdev)free_candev (ndev); } -static SIMPLE_DEV_PM_OPS(ctucan_platform_pm_ops, ctucan_suspend, ctucan_resume); +static DEFINE_SIMPLE_DEV_PM_OPS(ctucan_platform_pm_ops, ctucan_suspend, ctucan_resume);
[ ... ]
Signature · 4 lines
Pengutronix e.K. | Marc Kleine-Budde | Embedded Linux | https://www.pengutronix.de | Vertretung Nürnberg | Phone: +49-5121-206917-129 | Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-9 |