dmaengine: Convert to DEFINE_SIMPLE_DEV_PM_OPS()
PATCH 1/1 dmaengine: 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, and reduces kernel size in case CONFIG_PM or CONFIG_PM_SLEEP is disabled.
--- drivers/dma/k3dma.c | 6 ++---- drivers/dma/pch_dma.c | 8 ++++---- 2 files changed, 6 insertions(+), 8 deletions(-)
drivers/dma/k3dma.c +2 -4
@@ -982,7 +982,6 @@ static void k3_dma_remove(struct platform_device *op)clk_disable_unprepare (d->clk); } -#ifdef CONFIG_PM_SLEEP static int k3_dma_suspend_dev (struct device *dev) {struct k3_dma_dev *d =dev_get_drvdata (dev);
@@ -1012,14 +1011,13 @@ static int k3_dma_resume_dev(struct device *dev)k3_dma_enable_dma (d, true);return 0 ; } -#endif -static SIMPLE_DEV_PM_OPS(k3_dma_pmops, k3_dma_suspend_dev, k3_dma_resume_dev); +static DEFINE_SIMPLE_DEV_PM_OPS(k3_dma_pmops, k3_dma_suspend_dev, k3_dma_resume_dev);static struct platform_driver k3_pdma_driver = { .driver = { .name =DRIVER_NAME , - .pm = &k3_dma_pmops, + .pm =pm_sleep_ptr (&k3_dma_pmops), .of_match_table = k3_pdma_dt_ids, }, .probe = k3_dma_probe,
drivers/dma/pch_dma.c +4 -4
@@ -776,7 +776,7 @@ static void __maybe_unused pch_dma_restore_regs(struct pch_dma *pd) } } -static int __maybe_unused pch_dma_suspend (struct device *dev) +static int pch_dma_suspend (struct device *dev) {struct pch_dma *pd =dev_get_drvdata (dev);
@@ -786,7 +786,7 @@ static int __maybe_unused pch_dma_suspend(struct device *dev)return 0 ; } -static int __maybe_unused pch_dma_resume (struct device *dev) +static int pch_dma_resume (struct device *dev) {struct pch_dma *pd =dev_get_drvdata (dev);
@@ -972,14 +972,14 @@ static const struct pci_device_id pch_dma_id_table[] = { };MODULE_DEVICE_TABLE (pci, pch_dma_id_table); -static SIMPLE_DEV_PM_OPS(pch_dma_pm_ops, pch_dma_suspend, pch_dma_resume); +static DEFINE_SIMPLE_DEV_PM_OPS(pch_dma_pm_ops, pch_dma_suspend, pch_dma_resume);static struct pci_driver pch_dma_driver = { .name =DRV_NAME , .id_table = pch_dma_id_table, .probe = pch_dma_probe, .remove = pch_dma_remove, - .driver.pm = &pch_dma_pm_ops, + .driver.pm =pm_sleep_ptr (&pch_dma_pm_ops), };module_pci_driver (pch_dma_driver);
Signature · 1 line
2.53.0
[email protected]
AI reviewThank you for your contribution! Sashiko AI review found 3 potential issue(s) to consider:
Thank you for your contribution! Sashiko AI review found 3 potential issue(s) to consider:
Pre-existing issues:
- [High] Missing tasklet teardown on probe error path leads to Use-After-Free.
- [High] Tasklet scheduled before initialization causes NULL pointer dereference, and missing teardown causes Use-After-Free.
- [High] Clock disabled immediately after relaxed writes can lead to lost writes or bus stalls.
--
--- Patch [1]: [PATCH] dmaengine: Convert to DEFINE_SIMPLE_DEV_PM_OPS() --- commit 362f0670618631761830584ae4ebaa28847cc39c
Author: Triet Hoang <[email protected]>
dmaengine: Convert to DEFINE_SIMPLE_DEV_PM_OPS()
This commit converts the deprecated SIMPLE_DEV_PM_OPS to DEFINE_SIMPLE_DEV_PM_OPS and pm_sleep_ptr(). It drops the __maybe_unused annotations from the suspend and resume callbacks, reducing kernel size when PM configurations are disabled.
Quoted 4 lines
drivers/dma/k3dma.c +0
-0
[ ... ]
drivers/dma/k3dma.c static void k3_dma_remove(struct platform_device *op) · line 987
Quoted 4 lines
drivers/dma/k3dma.c +0
-1-#ifdef CONFIG_PM_SLEEP static int k3_dma_suspend_dev (struct device *dev) {struct k3_dma_dev *d =dev_get_drvdata (dev);
[Severity: High]
This is a pre-existing issue, but I noticed a potential problem with how the clock is disabled in k3_dma_suspend_dev().
The suspend function calls k3_dma_enable_dma(d, false), which uses writel_relaxed() to mask interrupts. Since writel_relaxed() performs posted writes, they are not guaranteed to reach the peripheral immediately.
Right after this, the clock is disabled via clk_disable_unprepare(d->clk).
Can disabling the clock while a bus write is still in-flight cause the write to be lost (leaving interrupts unmasked) or trigger a system-wide bus stall? Should there be a dummy readback to flush the bus before the clock is disabled?
[ ... ]
drivers/dma/k3dma.c static int k3_dma_resume_dev(struct device *dev) · line 1023
Quoted 8 lines
static struct
platform_driverk3_pdma_driver= {drivers/dma/k3dma.c +1
-1.driver = { .name = DRIVER_NAME, - .pm = &k3_dma_pmops, + .pm = pm_sleep_ptr(&k3_dma_pmops), .of_match_table = k3_pdma_dt_ids, }, .probe = k3_dma_probe,
[Severity: High]
This is a pre-existing issue, but I noticed a potential initialization and teardown issue in k3_dma_probe().
The probe function requests an IRQ and unmasks interrupts via k3_dma_enable_dma(d, true) before the tasklet is initialized:
k3_dma_enable_dma(d, true);
ret = dma_async_device_register(&d->slave);
if (ret)
goto dma_async_register_fail;
...
tasklet_setup(&d->task, k3_dma_tasklet);If an interrupt fires immediately, k3_dma_int_handler() could call tasklet_schedule(&d->task). Since d->task is zero-allocated and hasn't been initialized by tasklet_setup() yet, wouldn't this cause a NULL pointer dereference?
Additionally, if the probe fails later (for example, in dma_async_device_register()), the error path relies on devres to free memory but omits tasklet_kill(). Does this leave pending virtual channel tasklets pointing to freed memory, causing a use-after-free?
Quoted 4 lines
drivers/dma/pch_dma.c +0
-0
[ ... ]
drivers/dma/pch_dma.c static const struct pci_device_id pch_dma_id_table[] = { · line 980
Quoted 4 lines
static struct
pci_driverpch_dma_driver= {drivers/dma/pch_dma.c +0
-0.name = DRV_NAME, .id_table = pch_dma_id_table, .probe = pch_dma_probe,
[Severity: High]
This is a pre-existing issue, but looking at pch_dma_probe(), there appears to be a missing tasklet teardown on the error path.
The probe function requests an IRQ with IRQF_SHARED. If a shared interrupt fires, pd_irq() executes, reads the device status, and might schedule pd_chan->tasklet if the hardware status bits are non-zero.
If the probe subsequently fails (e.g., in dma_async_device_register()), the error path calls free_irq() and frees the memory, but omits calling tasklet_kill(&pd_chan->tasklet):
err_free_pool:
dma_pool_destroy(pd->pool);
err_free_irq:
free_irq(pdev->irq, pd);err_iounmap:
Could the tasklet remain queued and execute after pd is freed, resulting in a use-after-free?
Quoted 4 lines
drivers/dma/pch_dma.c +1
-1.remove = pch_dma_remove, - .driver.pm = &pch_dma_pm_ops, + .driver.pm = pm_sleep_ptr(&pch_dma_pm_ops), };
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1
Quoted 4 lines · Triet Hoang
Convert the deprecated
SIMPLE_DEV_PM_OPS
toDEFINE_SIMPLE_DEV_PM_OPSandpm_sleep_ptr().
Quoted 8 lines
This lets us drop the
__maybe_unusedannotations from the suspend and resume callbacks, and reduces kernel size in caseCONFIG_PMorCONFIG_PM_SLEEPis disabled.Signed-off-by Triet Hoang <[email protected]>--- drivers/dma/k3dma.c | 6 ++---- drivers/dma/pch_dma.c | 8 ++++----
Does other dmaengine also convert? if not, can you convert all?
Frank
Quoted 73 lines
2 files changed, 6 insertions(+), 8 deletions(-)drivers/dma/k3dma.c +2
-4@@ -982,7 +982,6 @@ static void k3_dma_remove(struct platform_device *op)clk_disable_unprepare (d->clk); } -#ifdef CONFIG_PM_SLEEP static int k3_dma_suspend_dev (struct device *dev) {struct k3_dma_dev *d =dev_get_drvdata (dev);@@ -1012,14 +1011,13 @@ static int k3_dma_resume_dev(struct device *dev)k3_dma_enable_dma (d, true);return 0 ; } -#endif -static SIMPLE_DEV_PM_OPS(k3_dma_pmops, k3_dma_suspend_dev, k3_dma_resume_dev); +static DEFINE_SIMPLE_DEV_PM_OPS(k3_dma_pmops, k3_dma_suspend_dev, k3_dma_resume_dev);static struct platform_driver k3_pdma_driver = { .driver = { .name =DRIVER_NAME , - .pm = &k3_dma_pmops, + .pm =pm_sleep_ptr (&k3_dma_pmops), .of_match_table = k3_pdma_dt_ids, }, .probe = k3_dma_probe,drivers/dma/pch_dma.c +4
-5@@ -776,7 +776,7 @@ static void __maybe_unused pch_dma_restore_regs(struct pch_dma *pd) } } -static int __maybe_unused pch_dma_suspend (struct device *dev) +static int pch_dma_suspend (struct device *dev) {struct pch_dma *pd =dev_get_drvdata (dev);@@ -786,7 +786,7 @@ static int __maybe_unused pch_dma_suspend(struct device *dev)return 0 ; } -static int __maybe_unused pch_dma_resume (struct device *dev) +static int pch_dma_resume (struct device *dev) {struct pch_dma *pd =dev_get_drvdata (dev);@@ -972,14 +972,14 @@ static const struct pci_device_id pch_dma_id_table[] = { };MODULE_DEVICE_TABLE (pci, pch_dma_id_table); -static SIMPLE_DEV_PM_OPS(pch_dma_pm_ops, pch_dma_suspend, pch_dma_resume); +static DEFINE_SIMPLE_DEV_PM_OPS(pch_dma_pm_ops, pch_dma_suspend, pch_dma_resume);static struct pci_driver pch_dma_driver = { .name =DRV_NAME , .id_table = pch_dma_id_table, .probe = pch_dma_probe, .remove = pch_dma_remove, - .driver.pm = &pch_dma_pm_ops, + .driver.pm =pm_sleep_ptr (&pch_dma_pm_ops), };module_pci_driver (pch_dma_driver); --2.53.0
Quoted 1 line
Does other dmaengine also convert? if not, can you convert all?
Hi Frank,
Thanks for replying. I have checked and see that other dmaengine also convert.
BR,
Triet