This patch set did some clean up and add runtime pm support for flexspi driver
Subsystems (3)
Haibo Chen
maintainerv3 cover This patch set did some clean up and add runtime pm support for flexspi driver
PATCH1/3/4 to clean up the code, make the code more readable
PATCH2 add the runtime pm support
PATCH5 use devm_add_action_or_reset() to replace remove() callback, this can avoid
oops when do bind/unbind test
---
Changes in v3:
- change the PATCH2, switch to use RUNTIME_PM_OPS instead of SET_RUNTIME_PM_OPS remove CONFIG_PM/CONFIG_PM_SLEEP, and use pm_ptr for PM ops
- fix a type for PATCH5
- Link to v2: https://lore.kernel.org/r/[email protected]
Changes in v2:
- only change the PATCH2, add #ifdef CONFIG_PM_SLEEP for nxp_fspi_suspend() to avoid build error if CONFIG_PM=n and CONFIG_PM_SLEEP=y, no change for all other patches.
- Link to v1: https://lore.kernel.org/r/[email protected]
---
Haibo Chen (4):
spi: spi-nxp-fspi: remove the goto in probe
spi: spi-nxp-fspi: enable runtime pm for fspi
spi: spi-nxp-fspi: use guard(mutex) to simplify the code
spi: spi-nxp-fspi: remove the unchecked return value for nxp_fspi_clk_disable_unprep
Han Xu (1):
spi: nxp-fspi: use devm instead of remove for driver detach
drivers/spi/spi-nxp-fspi.c | 189 ++++++++++++++++++++++++++------------------- 1 file changed, 108 insertions(+), 81 deletions(-)
---
base-commit: 393d0c54cae31317deaa9043320c5fd9454deabc
change-id: 20250421-flexspipatch-1cf724d4213d
Best regards,
Signature · 1 line
Haibo Chen <[email protected]>
Haibo Chen
maintainerPATCH v3 1/5 spi: spi-nxp-fspi: remove the goto in probe
Remove all the goto in probe to simplify the driver.
--- drivers/spi/spi-nxp-fspi.c | 87 ++++++++++++++-------------------------------- 1 file changed, 27 insertions(+), 60 deletions(-)
drivers/spi/spi-nxp-fspi.c +27 -60
@@ -1161,10 +1161,10 @@ static int nxp_fspi_probe(struct platform_device *pdev)struct device_node *np = dev->of_node;struct resource *res;struct nxp_fspi *f; -int ret; +int ret, irq;u32 reg; - ctlr =spi_alloc_host (&pdev->dev,sizeof (*f)); + ctlr =devm_spi_alloc_host (&pdev->dev,sizeof (*f));if (!ctlr)return -ENOMEM ;
@@ -1174,10 +1174,8 @@ static int nxp_fspi_probe(struct platform_device *pdev) f =spi_controller_get_devdata (ctlr); f->dev = dev; f->devtype_data = (struct nxp_fspi_devtype_data *)device_get_match_data (dev); -if (!f->devtype_data) { - ret = -ENODEV ; - goto err_put_ctrl; - } +if (!f->devtype_data) +return -ENODEV ;platform_set_drvdata (pdev, f);
@@ -1186,11 +1184,8 @@ static int nxp_fspi_probe(struct platform_device *pdev) f->iobase =devm_platform_ioremap_resource (pdev,0 ); else f->iobase = devm_platform_ioremap_resource_byname(pdev, "fspi_base"); - -if (IS_ERR (f->iobase)) { - ret =PTR_ERR (f->iobase); - goto err_put_ctrl; - } +if (IS_ERR (f->iobase)) +return PTR_ERR (f->iobase);/* find the resources - controller memory mapped space */ if (is_acpi_node (dev_fwnode (f->dev)))
@@ -1198,11 +1193,8 @@ static int nxp_fspi_probe(struct platform_device *pdev)else res =platform_get_resource_byname (pdev,IORESOURCE_MEM ,"fspi_mmap" ); - -if (!res) { - ret = -ENODEV ; - goto err_put_ctrl; - } +if (!res) +return -ENODEV ;/* assign memory mapped starting address and mapped size. */ f->memmap_phy = res->start;
@@ -1211,69 +1203,46 @@ static int nxp_fspi_probe(struct platform_device *pdev)/* find the clocks */ if (dev_of_node (&pdev->dev)) { f->clk_en =devm_clk_get (dev,"fspi_en" ); -if (IS_ERR (f->clk_en)) { - ret =PTR_ERR (f->clk_en); - goto err_put_ctrl; - } +if (IS_ERR (f->clk_en)) +return PTR_ERR (f->clk_en); f->clk =devm_clk_get (dev,"fspi" ); -if (IS_ERR (f->clk)) { - ret =PTR_ERR (f->clk); - goto err_put_ctrl; - } - - ret =nxp_fspi_clk_prep_enable (f); -if (ret) { -dev_err (dev,"can not enable the clock\n" ); - goto err_put_ctrl; - } +if (IS_ERR (f->clk)) +return PTR_ERR (f->clk); } +/* find the irq */ + irq =platform_get_irq (pdev,0 ); +if (irq <0 ) +return dev_err_probe (dev, irq,"Failed to get irq source" ); + + ret =nxp_fspi_clk_prep_enable (f); +if (ret) +return dev_err_probe (dev, ret,"Can't enable the clock\n" ); +/* Clear potential interrupts */ reg =fspi_readl (f, f->iobase +FSPI_INTR );if (reg)fspi_writel (f, reg, f->iobase +FSPI_INTR ); -/* find the irq */ - ret =platform_get_irq (pdev,0 ); -if (ret <0 ) - goto err_disable_clk; +nxp_fspi_default_setup (f); - ret =devm_request_irq (dev, ret, + ret =devm_request_irq (dev, irq, nxp_fspi_irq_handler,0 , pdev->name, f);if (ret) { -dev_err (dev,"failed to request irq: %d\n" , ret); - goto err_disable_clk; +nxp_fspi_clk_disable_unprep (f); +return dev_err_probe (dev, ret,"Failed to request irq\n" ); } -mutex_init (&f->lock); +devm_mutex_init (dev, &f->lock); ctlr->bus_num =-1 ; ctlr->num_chipselect =NXP_FSPI_MAX_CHIPSELECT ; ctlr->mem_ops = &nxp_fspi_mem_ops; ctlr->mem_caps = &nxp_fspi_mem_caps; - -nxp_fspi_default_setup (f); - ctlr->dev.of_node = np; - ret =devm_spi_register_controller (&pdev->dev, ctlr); -if (ret) - goto err_destroy_mutex; - -return 0 ; - -err_destroy_mutex: -mutex_destroy (&f->lock); - -err_disable_clk: -nxp_fspi_clk_disable_unprep (f); - -err_put_ctrl: -spi_controller_put (ctlr); - -dev_err (dev,"NXP FSPI probe failed\n" ); -return ret; +return devm_spi_register_controller (&pdev->dev, ctlr); }static void nxp_fspi_remove (struct platform_device *pdev)
@@ -1285,8 +1254,6 @@ static void nxp_fspi_remove(struct platform_device *pdev)nxp_fspi_clk_disable_unprep (f); -mutex_destroy (&f->lock); -if (f->ahb_addr)iounmap (f->ahb_addr); }
Signature · 1 line
2.34.1
Haibo Chen
maintainerPATCH v3 2/5 spi: spi-nxp-fspi: enable runtime pm for fspi
In reply to Haibo ChenEnable the runtime PM in fspi driver.
Also for system PM, On some board like i.MX8ULP-EVK board, after system suspend, IOMUX module will lost power, so all the pinctrl setting will lost when system resume back, need driver to save/restore the pinctrl setting.
--- drivers/spi/spi-nxp-fspi.c | 93 +++++++++++++++++++++++++++++++++++++--------- 1 file changed, 76 insertions(+), 17 deletions(-)
drivers/spi/spi-nxp-fspi.c +76 -17
@@ -48,6 +48,8 @@#include <linux/mutex.h> #include <linux/of.h> #include <linux/platform_device.h> +#include <linux/pinctrl/consumer.h> +#include <linux/pm_runtime.h> #include <linux/pm_qos.h> #include <linux/regmap.h> #include <linux/sizes.h>
@@ -57,6 +59,9 @@#include <linux/spi/spi.h> #include <linux/spi/spi-mem.h> +/* runtime pm timeout */ +#define FSPI_RPM_TIMEOUT 50/* 50ms */ +/* Registers used by the driver */ #define FSPI_MCR0 0x00#define FSPI_MCR0_AHB_TIMEOUT (x) ((x) << 24)
@@ -394,6 +399,8 @@ struct nxp_fspi {struct mutex lock;struct pm_qos_request pm_qos_req;int selected; +#define FSPI_NEED_INIT (1 << 0) +int flags; };static inline int needs_ip_only (struct nxp_fspi *f)
@@ -927,6 +934,13 @@ static int nxp_fspi_exec_op(struct spi_mem *mem, const struct spi_mem_op *op)mutex_lock (&f->lock); + err =pm_runtime_get_sync (f->dev); +if (err <0 ) { +mutex_unlock (&f->lock); +dev_err (f->dev,"Failed to enable clock %d\n" , __LINE__); +return err; + } +/* Wait for controller being ready. */ err =fspi_readl_poll_tout (f, f->iobase +FSPI_STS0 ,FSPI_STS0_ARB_IDLE ,1 ,POLL_TOUT , true);
@@ -955,8 +969,10 @@ static int nxp_fspi_exec_op(struct spi_mem *mem, const struct spi_mem_op *op)/* Invalidate the data in the AHB buffer. */ nxp_fspi_invalid (f); -mutex_unlock (&f->lock); +pm_runtime_mark_last_busy (f->dev); +pm_runtime_put_autosuspend (f->dev); +mutex_unlock (&f->lock);return err; }
@@ -1216,9 +1232,14 @@ static int nxp_fspi_probe(struct platform_device *pdev)if (irq <0 )return dev_err_probe (dev, irq,"Failed to get irq source" ); - ret =nxp_fspi_clk_prep_enable (f); -if (ret) -return dev_err_probe (dev, ret,"Can't enable the clock\n" ); +pm_runtime_enable (dev); +pm_runtime_set_autosuspend_delay (dev,FSPI_RPM_TIMEOUT ); +pm_runtime_use_autosuspend (dev); + +/* enable clock */ + ret =pm_runtime_get_sync (f->dev); +if (ret <0 ) +return dev_err_probe (dev, ret,"Failed to enable clock" );/* Clear potential interrupts */ reg =fspi_readl (f, f->iobase +FSPI_INTR );
@@ -1227,12 +1248,14 @@ static int nxp_fspi_probe(struct platform_device *pdev)nxp_fspi_default_setup (f); + ret =pm_runtime_put_sync (dev); +if (ret <0 ) +return dev_err_probe (dev, ret,"Failed to disable clock" ); + ret =devm_request_irq (dev, irq, nxp_fspi_irq_handler,0 , pdev->name, f); -if (ret) { -nxp_fspi_clk_disable_unprep (f); +if (ret)return dev_err_probe (dev, ret,"Failed to request irq\n" ); - }devm_mutex_init (dev, &f->lock);
@@ -1249,29 +1272,70 @@ static void nxp_fspi_remove(struct platform_device *pdev) {struct nxp_fspi *f =platform_get_drvdata (pdev); +/* enable clock first since there is reigster access */ +pm_runtime_get_sync (f->dev); +/* disable the hardware */ fspi_writel (f,FSPI_MCR0_MDIS , f->iobase +FSPI_MCR0 ); +pm_runtime_disable (f->dev); +pm_runtime_put_noidle (f->dev);nxp_fspi_clk_disable_unprep (f);if (f->ahb_addr)iounmap (f->ahb_addr); } -static int nxp_fspi_suspend (struct device *dev) +static int nxp_fspi_runtime_suspend (struct device *dev) { +struct nxp_fspi *f =dev_get_drvdata (dev); + +nxp_fspi_clk_disable_unprep (f); +return 0 ; } -static int nxp_fspi_resume (struct device *dev) +static int nxp_fspi_runtime_resume (struct device *dev) {struct nxp_fspi *f =dev_get_drvdata (dev); +int ret; -nxp_fspi_default_setup (f); + ret =nxp_fspi_clk_prep_enable (f); +if (ret) +return ret; -return 0 ; +if (f->flags &FSPI_NEED_INIT ) { +nxp_fspi_default_setup (f); + ret =pinctrl_pm_select_default_state (dev); +if (ret) +dev_err (dev,"select flexspi default pinctrl failed!\n" ); + f->flags &= ~FSPI_NEED_INIT ; + } + +return ret; } +static int nxp_fspi_suspend (struct device *dev) +{ +struct nxp_fspi *f =dev_get_drvdata (dev); +int ret; + + ret =pinctrl_pm_select_sleep_state (dev); +if (ret) { +dev_err (dev,"select flexspi sleep pinctrl failed!\n" ); +return ret; + } + + f->flags |=FSPI_NEED_INIT ; + +return pm_runtime_force_suspend (dev); +} + +static const struct dev_pm_ops nxp_fspi_pm_ops = { + RUNTIME_PM_OPS(nxp_fspi_runtime_suspend, nxp_fspi_runtime_resume, NULL) +SYSTEM_SLEEP_PM_OPS (nxp_fspi_suspend, pm_runtime_force_resume) +}; +static const struct of_device_id nxp_fspi_dt_ids[] = { { .compatible ="nxp,lx2160a-fspi" , .data = (void *)&lx2160a_data, }, { .compatible ="nxp,imx8mm-fspi" , .data = (void *)&imx8mm_data, },
@@ -1291,17 +1355,12 @@ static const struct acpi_device_id nxp_fspi_acpi_ids[] = {MODULE_DEVICE_TABLE (acpi, nxp_fspi_acpi_ids);#endif -static const struct dev_pm_ops nxp_fspi_pm_ops = { - .suspend = nxp_fspi_suspend, - .resume = nxp_fspi_resume, -}; -static struct platform_driver nxp_fspi_driver = { .driver = { .name ="nxp-fspi" , .of_match_table = nxp_fspi_dt_ids, .acpi_match_table =ACPI_PTR (nxp_fspi_acpi_ids), - .pm = &nxp_fspi_pm_ops, + .pm =pm_ptr (&nxp_fspi_pm_ops), }, .probe = nxp_fspi_probe, .remove = nxp_fspi_remove,
Signature · 1 line
2.34.1
Re: [PATCH v3 2/5] spi: spi-nxp-fspi: enable runtime pm for fspi
drivers/spi/spi-nxp-fspi.c static void nxp_fspi_remove(struct platform_device *pdev) · line 1275
Quoted 5 lines · Haibo Chen
drivers/spi/spi-nxp-fspi.c +1
-0@@ -1249,29 +1272,70 @@ static void nxp_fspi_remove(struct platform_device *pdev) {struct nxp_fspi *f =platform_get_drvdata (pdev); +/* enable clock first since there is reigster access */
typo reigster -> register
drivers/spi/spi-nxp-fspi.c static void nxp_fspi_remove(struct platform_device *pdev) · line 1279
Quoted 4 lines
drivers/spi/spi-nxp-fspi.c +2
-0+pm_runtime_get_sync (f->dev); +/* disable the hardware */ fspi_writel (f,FSPI_MCR0_MDIS , f->iobase +FSPI_MCR0 );
Thanks,
Alok
Mark Brown
maintainerRe: [PATCH v3 2/5] spi: spi-nxp-fspi: enable runtime pm for fspi
In reply to Haibo ChenQuoted 5 lines · Haibo Chen
Enable the runtime PM in fspi driver.
Also for system PM, On some board like i.MX8ULP-EVK board, after system suspend, IOMUX module will lost power, so all the pinctrl setting will lost when system resume back, need driver to save/restore the pinctrl setting.
I think I would expect the pinctrl driver to deal with restoring the pin status over resume? But perhaps that's not the way that API works?
Bough Chen
maintainerRE: [PATCH v3 2/5] spi: spi-nxp-fspi: enable runtime pm for fspi
Quoted 9 lines
-----Original Message-----
From: Mark Brown <[email protected]>
Sent: 2025年5月2日 4:47
To: Bough Chen <[email protected]>
Cc: Han Xu <[email protected]>; Yogesh Gaur <[email protected]>; [email protected]; [email protected]; [email protected]
Subject: Re: [PATCH v3 2/5] spi: spi-nxp-fspi: enable runtime pm for fspiOn Mon, Apr 28, 2025 at 06:06:44PM +0800, Haibo Chen wrote:
Quoted 8 lines
Quoted 5 lines
Enable the runtime PM in fspi driver.
Also for system PM, On some board like i.MX8ULP-EVK board, after system suspend, IOMUX module will lost power, so all the pinctrl setting will lost when system resume back, need driver to save/restore the pinctrl setting.I think I would expect the pinctrl driver to deal with restoring the pin status over resume? But perhaps that's not the way that API works?
Hi Mark,
I check the pinctrl driver, seems pinctrl only support to save/restore the hog pad, refer to pinctrl_force_sleep/pinctrl_force_default, for other pad which driver owned, need driver to handle, refer to pinctrl_pm_select_sleep_state/pinctrl_pm_select_default_state.
Regards
Haibo Chen
Haibo Chen
maintainerPATCH v3 3/5 spi: spi-nxp-fspi: use guard(mutex) to simplify the code
In reply to Haibo ChenUse guard(mutex) to simplify the code logic.
--- drivers/spi/spi-nxp-fspi.c | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-)
drivers/spi/spi-nxp-fspi.c +1 -3
@@ -932,11 +932,10 @@ static int nxp_fspi_exec_op(struct spi_mem *mem, const struct spi_mem_op *op)struct nxp_fspi *f =spi_controller_get_devdata (mem->spi->controller);int err =0 ; -mutex_lock (&f->lock); +guard (mutex)(&f->lock); err =pm_runtime_get_sync (f->dev);if (err <0 ) { -mutex_unlock (&f->lock);dev_err (f->dev,"Failed to enable clock %d\n" , __LINE__);return err; }
@@ -972,7 +971,6 @@ static int nxp_fspi_exec_op(struct spi_mem *mem, const struct spi_mem_op *op)pm_runtime_mark_last_busy (f->dev);pm_runtime_put_autosuspend (f->dev); -mutex_unlock (&f->lock);return err; }
Signature · 1 line
2.34.1
Haibo Chen
maintainerPATCH v3 4/5 spi: spi-nxp-fspi: remove the unchecked return value for nxp_fspi_clk_disable_unprep
In reply to Haibo ChenFor nxp_fspi_clk_disable_unprep(), no caller check the return value, so remove the unchecked return value.
--- drivers/spi/spi-nxp-fspi.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
drivers/spi/spi-nxp-fspi.c +3 -3
@@ -634,15 +634,15 @@ static int nxp_fspi_clk_prep_enable(struct nxp_fspi *f)return 0 ; } -static int nxp_fspi_clk_disable_unprep (struct nxp_fspi *f) +static void nxp_fspi_clk_disable_unprep (struct nxp_fspi *f) {if (is_acpi_node (dev_fwnode (f->dev))) -return 0 ; +return ;clk_disable_unprepare (f->clk);clk_disable_unprepare (f->clk_en); -return 0 ; +return ; }static void nxp_fspi_dll_calibration (struct nxp_fspi *f)
Signature · 1 line
2.34.1
Haibo Chen
maintainerPATCH v3 5/5 spi: nxp-fspi: use devm instead of remove for driver detach
In reply to Haibo ChenFrom: Han Xu <[email protected]>
fspi driver use devm APIs to manage clk/irq/resources and register the spi controller, but the legacy remove function will be called first during device detach and trigger kernel panic. Drop the remove function and use devm_add_action_or_reset() for driver cleanup to ensure the release sequence.
--- drivers/spi/spi-nxp-fspi.c | 41 ++++++++++++++++++++++------------------- 1 file changed, 22 insertions(+), 19 deletions(-)
drivers/spi/spi-nxp-fspi.c +22 -19
@@ -1168,6 +1168,24 @@ static const struct spi_controller_mem_caps nxp_fspi_mem_caps = { .per_op_freq = true, }; +static void nxp_fspi_cleanup (void *data) +{ +struct nxp_fspi *f = data; + +/* enable clock first since there is register access */ +pm_runtime_get_sync (f->dev); + +/* disable the hardware */ +fspi_writel (f,FSPI_MCR0_MDIS , f->iobase +FSPI_MCR0 ); + +pm_runtime_disable (f->dev); +pm_runtime_put_noidle (f->dev); +nxp_fspi_clk_disable_unprep (f); + +if (f->ahb_addr) +iounmap (f->ahb_addr); +} +static int nxp_fspi_probe (struct platform_device *pdev) {struct spi_controller *ctlr;
@@ -1263,25 +1281,11 @@ static int nxp_fspi_probe(struct platform_device *pdev) ctlr->mem_caps = &nxp_fspi_mem_caps; ctlr->dev.of_node = np; -return devm_spi_register_controller (&pdev->dev, ctlr); -} - -static void nxp_fspi_remove (struct platform_device *pdev) -{ -struct nxp_fspi *f =platform_get_drvdata (pdev); - -/* enable clock first since there is reigster access */ -pm_runtime_get_sync (f->dev); - -/* disable the hardware */ -fspi_writel (f,FSPI_MCR0_MDIS , f->iobase +FSPI_MCR0 ); - -pm_runtime_disable (f->dev); -pm_runtime_put_noidle (f->dev); -nxp_fspi_clk_disable_unprep (f); + ret =devm_add_action_or_reset (dev, nxp_fspi_cleanup, f); +if (ret) +return dev_err_probe (dev, ret,"Failed to register nxp_fspi_cleanup\n" ); -if (f->ahb_addr) -iounmap (f->ahb_addr); +return devm_spi_register_controller (&pdev->dev, ctlr); }static int nxp_fspi_runtime_suspend (struct device *dev)
@@ -1361,7 +1365,6 @@ static struct platform_driver nxp_fspi_driver = { .pm = pm_ptr(&nxp_fspi_pm_ops), }, .probe = nxp_fspi_probe, - .remove = nxp_fspi_remove, };module_platform_driver (nxp_fspi_driver);
Signature · 1 line
2.34.1
Mark Brown
maintainerQuoted 6 lines · Haibo Chen
PATCH1/3/4 to clean up the code, make the code more readable
PATCH2 add the runtime pm support
PATCH5 usedevm_add_action_or_reset()to replaceremove()callback, this can avoid
oops when do bind/unbind test
Applied to
https://git.kernel.org/pub/scm/linux/kernel/git/broonie/spi.git for-next
Thanks!
[1/5] spi: spi-nxp-fspi: remove the goto in probe
commit: 48900813abd2730a35c6e3afd1609bafac5271cc
[2/5] spi: spi-nxp-fspi: enable runtime pm for fspi
commit: 97be4b919a609fc8c4bd1118502b5d26cc2f77c4
[3/5] spi: spi-nxp-fspi: use guard(mutex) to simplify the code
commit: 93be516f819dcb1fdac035566381d8899d4b389c
[4/5] spi: spi-nxp-fspi: remove the unchecked return value for nxp_fspi_clk_disable_unprep
commit: e0558eb74c6e082b60e03981eb7cbf0fc3780ef4
[5/5] spi: nxp-fspi: use devm instead of remove for driver detach
commit: 9f7cd1bcb6363368abc954ff4e727b579813c697All being well this means that it will be integrated into the linux-next tree (usually sometime in the next 24 hours) and sent to Linus during the next merge window (or sooner if it is a bug fix), however if problems are discovered then the patch may be dropped or reverted.
You may get further e-mails resulting from automated or manual testing and review of the tree, please engage with people reporting problems and send followup patches addressing any issues that are reported if needed.
If any updates are required or you are submitting further changes they should be sent as incremental updates against current git, existing patches will not be replaced.
Please add any relevant lists and maintainers to the CCs when replying to this mail.
Thanks,
Mark