diff mbox series

[v4] pinctrl: stm32: Add check for clk_enable()

Message ID 20241213010948.2623382-1-zmw12306@gmail.com (mailing list archive)
State New
Headers show
Series [v4] pinctrl: stm32: Add check for clk_enable() | expand

Commit Message

Mingwei Zheng Dec. 13, 2024, 1:09 a.m. UTC
Convert the driver to clk_bulk*() API.
Add check for the return value of clk_bulk_enable() to catch
the potential error.

Fixes: 05d8af449d93 ("pinctrl: stm32: Keep pinctrl block clock enabled when LEVEL IRQ requested")
Signed-off-by: Mingwei Zheng <zmw12306@gmail.com>
Signed-off-by: Jiasheng Jiang <jiashengjiangcool@gmail.com>
---
Changelog:

v3 -> v4:
1. Add initialization for  pctl->clks.
2. Adjust alignment.

v2 -> v3:

1. Convert clk_disable_unprepare to clk_bulk_disable
and clk_bulk_unprepare.

v1 -> v2:

1. Move int ret declaration into if block.
---
 drivers/pinctrl/stm32/pinctrl-stm32.c | 37 +++++++++++++++------------
 1 file changed, 21 insertions(+), 16 deletions(-)

Comments

Clément Le Goffic Dec. 13, 2024, 11:16 a.m. UTC | #1
On 12/13/24 02:09, Mingwei Zheng wrote:
> Convert the driver to clk_bulk*() API.
> Add check for the return value of clk_bulk_enable() to catch
> the potential error.
> 
> Fixes: 05d8af449d93 ("pinctrl: stm32: Keep pinctrl block clock enabled when LEVEL IRQ requested")
> Signed-off-by: Mingwei Zheng <zmw12306@gmail.com>
> Signed-off-by: Jiasheng Jiang <jiashengjiangcool@gmail.com>
> ---
> Changelog:
> 
> v3 -> v4:
> 1. Add initialization for  pctl->clks.
> 2. Adjust alignment.
> 
> v2 -> v3:
> 
> 1. Convert clk_disable_unprepare to clk_bulk_disable
> and clk_bulk_unprepare.
> 
> v1 -> v2:
> 
> 1. Move int ret declaration into if block.
> ---
>   drivers/pinctrl/stm32/pinctrl-stm32.c | 37 +++++++++++++++------------
>   1 file changed, 21 insertions(+), 16 deletions(-)
> 
> diff --git a/drivers/pinctrl/stm32/pinctrl-stm32.c b/drivers/pinctrl/stm32/pinctrl-stm32.c
> index 5b7fa77c1184..427749d4f6a5 100644
> --- a/drivers/pinctrl/stm32/pinctrl-stm32.c
> +++ b/drivers/pinctrl/stm32/pinctrl-stm32.c
> @@ -86,7 +86,6 @@ struct stm32_pinctrl_group {
>   
>   struct stm32_gpio_bank {
>   	void __iomem *base;
> -	struct clk *clk;
>   	struct reset_control *rstc;
>   	spinlock_t lock;
>   	struct gpio_chip gpio_chip;
> @@ -108,6 +107,7 @@ struct stm32_pinctrl {
>   	unsigned ngroups;
>   	const char **grp_names;
>   	struct stm32_gpio_bank *banks;
> +	struct clk_bulk_data *clks;
>   	unsigned nbanks;
>   	const struct stm32_pinctrl_match_data *match_data;
>   	struct irq_domain	*domain;
> @@ -1308,7 +1308,7 @@ static int stm32_gpiolib_register_bank(struct stm32_pinctrl *pctl, struct fwnode
>   	if (IS_ERR(bank->base))
>   		return PTR_ERR(bank->base);
>   
> -	err = clk_prepare_enable(bank->clk);
> +	err = clk_prepare_enable(pctl->clks[pctl->nbanks].clk);
>   	if (err) {
>   		dev_err(dev, "failed to prepare_enable clk (%d)\n", err);
>   		return err;
> @@ -1397,7 +1397,7 @@ static int stm32_gpiolib_register_bank(struct stm32_pinctrl *pctl, struct fwnode
>   	return 0;
>   
>   err_clk:
> -	clk_disable_unprepare(bank->clk);
> +	clk_disable_unprepare(pctl->clks[pctl->nbanks].clk);
>   	return err;
>   }
>   
> @@ -1617,10 +1617,18 @@ int stm32_pctl_probe(struct platform_device *pdev)
>   		return -EINVAL;
>   	}
>   	pctl->banks = devm_kcalloc(dev, banks, sizeof(*pctl->banks),
> -			GFP_KERNEL);
> +				   GFP_KERNEL);
>   	if (!pctl->banks)
>   		return -ENOMEM;
>   
> +	pctl->clks = devm_kcalloc(dev, banks, sizeof(*pctl->clks),
> +				  GFP_KERNEL);
> +	if (!pctl->clks)
> +		return -ENOMEM;
> +
> +	for (i = 0; i < banks; ++i)
> +		pctl->clks[i].id = "";
> +
>   	i = 0;
>   	for_each_gpiochip_node(dev, child) {
>   		struct stm32_gpio_bank *bank = &pctl->banks[i];
> @@ -1631,11 +1639,10 @@ int stm32_pctl_probe(struct platform_device *pdev)
>   			fwnode_handle_put(child);
>   			return -EPROBE_DEFER;
>   		}
> -
> -		bank->clk = of_clk_get_by_name(np, NULL);
> -		if (IS_ERR(bank->clk)) {
> +		pctl->clks[i].clk = of_clk_get_by_name(np, NULL);
> +		if (IS_ERR(pctl->clks[i].clk)) {
>   			fwnode_handle_put(child);
> -			return dev_err_probe(dev, PTR_ERR(bank->clk),
> +			return dev_err_probe(dev, PTR_ERR(pctl->clks[i].clk),
>   					     "failed to get clk\n");
>   		}
>   		i++;
> @@ -1646,8 +1653,7 @@ int stm32_pctl_probe(struct platform_device *pdev)
>   		if (ret) {
>   			fwnode_handle_put(child);
>   
> -			for (i = 0; i < pctl->nbanks; i++)
> -				clk_disable_unprepare(pctl->banks[i].clk);
> +			clk_bulk_disable_unprepare(pctl->nbanks, pctl->clks);
>   
>   			return ret;
>   		}
> @@ -1726,10 +1732,8 @@ static int __maybe_unused stm32_pinctrl_restore_gpio_regs(
>   int __maybe_unused stm32_pinctrl_suspend(struct device *dev)
>   {
>   	struct stm32_pinctrl *pctl = dev_get_drvdata(dev);
> -	int i;
>   
> -	for (i = 0; i < pctl->nbanks; i++)
> -		clk_disable(pctl->banks[i].clk);
> +	clk_bulk_disable(pctl->nbanks, pctl->clks);
>   
>   	return 0;
>   }
> @@ -1738,10 +1742,11 @@ int __maybe_unused stm32_pinctrl_resume(struct device *dev)
>   {
>   	struct stm32_pinctrl *pctl = dev_get_drvdata(dev);
>   	struct stm32_pinctrl_group *g = pctl->groups;
> -	int i;
> +	int i, ret;
>   
> -	for (i = 0; i < pctl->nbanks; i++)
> -		clk_enable(pctl->banks[i].clk);
> +	ret = clk_bulk_enable(pctl->nbanks, pctl->clks);
> +	if (ret)
> +		return ret;
>   
>   	for (i = 0; i < pctl->ngroups; i++, g++)
>   		stm32_pinctrl_restore_gpio_regs(pctl, g->pin);


Tested-by: Clément Le Goffic <clement.legoffic@foss.st.com>
Antonio Borneo Dec. 13, 2024, 11:24 a.m. UTC | #2
On Thu, 2024-12-12 at 20:09 -0500, Mingwei Zheng wrote:
> Convert the driver to clk_bulk*() API.
> Add check for the return value of clk_bulk_enable() to catch
> the potential error.
> 
> Fixes: 05d8af449d93 ("pinctrl: stm32: Keep pinctrl block clock enabled when LEVEL IRQ requested")
> Signed-off-by: Mingwei Zheng <zmw12306@gmail.com>
> Signed-off-by: Jiasheng Jiang <jiashengjiangcool@gmail.com>
> ---

Rewiewed-by: Antonio Borneo <antonio.borneo@foss.st.com>

Thanks!
Marek Vasut Dec. 13, 2024, 11:45 a.m. UTC | #3
On 12/13/24 2:09 AM, Mingwei Zheng wrote:

[...]

> @@ -1397,7 +1397,7 @@ static int stm32_gpiolib_register_bank(struct stm32_pinctrl *pctl, struct fwnode
>   	return 0;
>   
>   err_clk:
> -	clk_disable_unprepare(bank->clk);
> +	clk_disable_unprepare(pctl->clks[pctl->nbanks].clk);


Should this be

-clk_disable_unprepare(pctl->clks[pctl->nbanks].clk);
+clk_disable_unprepare(pctl->clks[bank->bank_nr].clk);
                                   ^^^^^^^^^^^^^

?

>   	return err;
>   }
>   
> @@ -1617,10 +1617,18 @@ int stm32_pctl_probe(struct platform_device *pdev)
>   		return -EINVAL;
>   	}
>   	pctl->banks = devm_kcalloc(dev, banks, sizeof(*pctl->banks),
> -			GFP_KERNEL);
> +				   GFP_KERNEL);
>   	if (!pctl->banks)
>   		return -ENOMEM;
>   
> +	pctl->clks = devm_kcalloc(dev, banks, sizeof(*pctl->clks),
> +				  GFP_KERNEL);
> +	if (!pctl->clks)
> +		return -ENOMEM;
> +
> +	for (i = 0; i < banks; ++i)

i++
Antonio Borneo Dec. 13, 2024, 1:43 p.m. UTC | #4
On Fri, 2024-12-13 at 12:45 +0100, Marek Vasut wrote:
> On 12/13/24 2:09 AM, Mingwei Zheng wrote:
> 
> [...]
> 
> > @@ -1397,7 +1397,7 @@ static int stm32_gpiolib_register_bank(struct stm32_pinctrl *pctl, struct fwnode
> >         return 0;
> >   
> >   err_clk:
> > -       clk_disable_unprepare(bank->clk);
> > +       clk_disable_unprepare(pctl->clks[pctl->nbanks].clk);
> 
> 
> Should this be
> 
> -clk_disable_unprepare(pctl->clks[pctl->nbanks].clk);
> +clk_disable_unprepare(pctl->clks[bank->bank_nr].clk);
>                                    ^^^^^^^^^^^^^
> 

No Marek,
pctl->nbanks is the progressive index of the bank's subnode, that is also the index for pctl->clks[].
Instead bank->bank_nr can be computed from gpio-ranges, and there is no guarantee it would match the index for pctl->clks[].

Actually this is quite confusing; I think it would be much cleaner dropping the clock handling from stm32_gpiolib_register_bank() and moving it to its caller.
In stm32_pctl_probe() we can just call clk_bulk_prepare_enable() and, in case of error, clk_bulk_disable_unprepare()

Antonio

> ?
> 
> >         return err;
> >   }
> >   
> > @@ -1617,10 +1617,18 @@ int stm32_pctl_probe(struct platform_device *pdev)
> >                 return -EINVAL;
> >         }
> >         pctl->banks = devm_kcalloc(dev, banks, sizeof(*pctl->banks),
> > -                       GFP_KERNEL);
> > +                                  GFP_KERNEL);
> >         if (!pctl->banks)
> >                 return -ENOMEM;
> >   
> > +       pctl->clks = devm_kcalloc(dev, banks, sizeof(*pctl->clks),
> > +                                 GFP_KERNEL);
> > +       if (!pctl->clks)
> > +               return -ENOMEM;
> > +
> > +       for (i = 0; i < banks; ++i)
> 
> i++
diff mbox series

Patch

diff --git a/drivers/pinctrl/stm32/pinctrl-stm32.c b/drivers/pinctrl/stm32/pinctrl-stm32.c
index 5b7fa77c1184..427749d4f6a5 100644
--- a/drivers/pinctrl/stm32/pinctrl-stm32.c
+++ b/drivers/pinctrl/stm32/pinctrl-stm32.c
@@ -86,7 +86,6 @@  struct stm32_pinctrl_group {
 
 struct stm32_gpio_bank {
 	void __iomem *base;
-	struct clk *clk;
 	struct reset_control *rstc;
 	spinlock_t lock;
 	struct gpio_chip gpio_chip;
@@ -108,6 +107,7 @@  struct stm32_pinctrl {
 	unsigned ngroups;
 	const char **grp_names;
 	struct stm32_gpio_bank *banks;
+	struct clk_bulk_data *clks;
 	unsigned nbanks;
 	const struct stm32_pinctrl_match_data *match_data;
 	struct irq_domain	*domain;
@@ -1308,7 +1308,7 @@  static int stm32_gpiolib_register_bank(struct stm32_pinctrl *pctl, struct fwnode
 	if (IS_ERR(bank->base))
 		return PTR_ERR(bank->base);
 
-	err = clk_prepare_enable(bank->clk);
+	err = clk_prepare_enable(pctl->clks[pctl->nbanks].clk);
 	if (err) {
 		dev_err(dev, "failed to prepare_enable clk (%d)\n", err);
 		return err;
@@ -1397,7 +1397,7 @@  static int stm32_gpiolib_register_bank(struct stm32_pinctrl *pctl, struct fwnode
 	return 0;
 
 err_clk:
-	clk_disable_unprepare(bank->clk);
+	clk_disable_unprepare(pctl->clks[pctl->nbanks].clk);
 	return err;
 }
 
@@ -1617,10 +1617,18 @@  int stm32_pctl_probe(struct platform_device *pdev)
 		return -EINVAL;
 	}
 	pctl->banks = devm_kcalloc(dev, banks, sizeof(*pctl->banks),
-			GFP_KERNEL);
+				   GFP_KERNEL);
 	if (!pctl->banks)
 		return -ENOMEM;
 
+	pctl->clks = devm_kcalloc(dev, banks, sizeof(*pctl->clks),
+				  GFP_KERNEL);
+	if (!pctl->clks)
+		return -ENOMEM;
+
+	for (i = 0; i < banks; ++i)
+		pctl->clks[i].id = "";
+
 	i = 0;
 	for_each_gpiochip_node(dev, child) {
 		struct stm32_gpio_bank *bank = &pctl->banks[i];
@@ -1631,11 +1639,10 @@  int stm32_pctl_probe(struct platform_device *pdev)
 			fwnode_handle_put(child);
 			return -EPROBE_DEFER;
 		}
-
-		bank->clk = of_clk_get_by_name(np, NULL);
-		if (IS_ERR(bank->clk)) {
+		pctl->clks[i].clk = of_clk_get_by_name(np, NULL);
+		if (IS_ERR(pctl->clks[i].clk)) {
 			fwnode_handle_put(child);
-			return dev_err_probe(dev, PTR_ERR(bank->clk),
+			return dev_err_probe(dev, PTR_ERR(pctl->clks[i].clk),
 					     "failed to get clk\n");
 		}
 		i++;
@@ -1646,8 +1653,7 @@  int stm32_pctl_probe(struct platform_device *pdev)
 		if (ret) {
 			fwnode_handle_put(child);
 
-			for (i = 0; i < pctl->nbanks; i++)
-				clk_disable_unprepare(pctl->banks[i].clk);
+			clk_bulk_disable_unprepare(pctl->nbanks, pctl->clks);
 
 			return ret;
 		}
@@ -1726,10 +1732,8 @@  static int __maybe_unused stm32_pinctrl_restore_gpio_regs(
 int __maybe_unused stm32_pinctrl_suspend(struct device *dev)
 {
 	struct stm32_pinctrl *pctl = dev_get_drvdata(dev);
-	int i;
 
-	for (i = 0; i < pctl->nbanks; i++)
-		clk_disable(pctl->banks[i].clk);
+	clk_bulk_disable(pctl->nbanks, pctl->clks);
 
 	return 0;
 }
@@ -1738,10 +1742,11 @@  int __maybe_unused stm32_pinctrl_resume(struct device *dev)
 {
 	struct stm32_pinctrl *pctl = dev_get_drvdata(dev);
 	struct stm32_pinctrl_group *g = pctl->groups;
-	int i;
+	int i, ret;
 
-	for (i = 0; i < pctl->nbanks; i++)
-		clk_enable(pctl->banks[i].clk);
+	ret = clk_bulk_enable(pctl->nbanks, pctl->clks);
+	if (ret)
+		return ret;
 
 	for (i = 0; i < pctl->ngroups; i++, g++)
 		stm32_pinctrl_restore_gpio_regs(pctl, g->pin);