[PATCH 1/2] i2c: synquacer: Fix an error handling path in synquacer_i2c_probe()

[PATCH 1/2] i2c: synquacer: Fix an error handling path in synquacer_i2c_probe()

[Christophe JAILLET]

If an error occurs after the clk_prepare_enable() call, it should be undone
by a corresponding clk_disable_unprepare() call, as already done in the
remove() function.

As devm_clk_get() is used, we can switch to devm_clk_get_enabled() to
handle it automatically and fix the probe.

Update the remove() function accordingly and remove the now useless
clk_disable_unprepare() call.

Fixes: 0d676a6c4390 ("i2c: add support for Socionext SynQuacer I2C controller")
Signed-off-by: Christophe JAILLET <christophe.jaillet@wanadoo.fr>
---
 drivers/i2c/busses/i2c-synquacer.c | 20 +++++++-------------
 1 file changed, 7 insertions(+), 13 deletions(-)

diff --git a/drivers/i2c/busses/i2c-synquacer.c b/drivers/i2c/busses/i2c-synquacer.c
index bbea521b05dd..a73f5bb9a164 100644
--- a/drivers/i2c/busses/i2c-synquacer.c
+++ b/drivers/i2c/busses/i2c-synquacer.c
@@ -550,17 +550,13 @@ static int synquacer_i2c_probe(struct platform_device *pdev)
 	device_property_read_u32(&pdev->dev, "socionext,pclk-rate",
 				 &i2c->pclkrate);
 
-	i2c->pclk = devm_clk_get(&pdev->dev, "pclk");
-	if (PTR_ERR(i2c->pclk) == -EPROBE_DEFER)
-		return -EPROBE_DEFER;
-	if (!IS_ERR_OR_NULL(i2c->pclk)) {
-		dev_dbg(&pdev->dev, "clock source %p\n", i2c->pclk);
-
-		ret = clk_prepare_enable(i2c->pclk);
-		if (ret)
-			return dev_err_probe(&pdev->dev, ret, "failed to enable clock\n");
-		i2c->pclkrate = clk_get_rate(i2c->pclk);
-	}
+	i2c->pclk = devm_clk_get_enabled(&pdev->dev, "pclk");
+	if (IS_ERR(i2c->pclk))
+		return dev_err_probe(&pdev->dev, PTR_ERR(i2c->pclk),
+				     "failed to get and enable clock\n");
+
+	dev_dbg(&pdev->dev, "clock source %p\n", i2c->pclk);
+	i2c->pclkrate = clk_get_rate(i2c->pclk);
 
 	if (i2c->pclkrate < SYNQUACER_I2C_MIN_CLK_RATE ||
 	    i2c->pclkrate > SYNQUACER_I2C_MAX_CLK_RATE)
@@ -615,8 +611,6 @@ static void synquacer_i2c_remove(struct platform_device *pdev)
 	struct synquacer_i2c *i2c = platform_get_drvdata(pdev);
 
 	i2c_del_adapter(&i2c->adapter);
-	if (!IS_ERR(i2c->pclk))
-		clk_disable_unprepare(i2c->pclk);
 };
 
 static const struct of_device_id synquacer_i2c_dt_ids[] __maybe_unused = {
-- 
2.34.1

[PATCH 2/2] i2c: synquacer: Remove a clk reference from struct synquacer_i2c

[Christophe JAILLET]

'pclk' is only used locally in the probe. Remove it from the
'synquacer_i2c' structure.

Also remove a useless debug message.

Signed-off-by: Christophe JAILLET <christophe.jaillet@wanadoo.fr>
---
 drivers/i2c/busses/i2c-synquacer.c | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/drivers/i2c/busses/i2c-synquacer.c b/drivers/i2c/busses/i2c-synquacer.c
index a73f5bb9a164..e774b9f499b6 100644
--- a/drivers/i2c/busses/i2c-synquacer.c
+++ b/drivers/i2c/busses/i2c-synquacer.c
@@ -138,7 +138,6 @@ struct synquacer_i2c {
 	int			irq;
 	struct device		*dev;
 	void __iomem		*base;
-	struct clk		*pclk;
 	u32			pclkrate;
 	u32			speed_khz;
 	u32			timeout_ms;
@@ -535,6 +534,7 @@ static const struct i2c_adapter synquacer_i2c_ops = {
 static int synquacer_i2c_probe(struct platform_device *pdev)
 {
 	struct synquacer_i2c *i2c;
+	struct clk *pclk;
 	u32 bus_speed;
 	int ret;
 
@@ -550,13 +550,12 @@ static int synquacer_i2c_probe(struct platform_device *pdev)
 	device_property_read_u32(&pdev->dev, "socionext,pclk-rate",
 				 &i2c->pclkrate);
 
-	i2c->pclk = devm_clk_get_enabled(&pdev->dev, "pclk");
-	if (IS_ERR(i2c->pclk))
-		return dev_err_probe(&pdev->dev, PTR_ERR(i2c->pclk),
+	pclk = devm_clk_get_enabled(&pdev->dev, "pclk");
+	if (IS_ERR(pclk))
+		return dev_err_probe(&pdev->dev, PTR_ERR(pclk),
 				     "failed to get and enable clock\n");
 
-	dev_dbg(&pdev->dev, "clock source %p\n", i2c->pclk);
-	i2c->pclkrate = clk_get_rate(i2c->pclk);
+	i2c->pclkrate = clk_get_rate(pclk);
 
 	if (i2c->pclkrate < SYNQUACER_I2C_MIN_CLK_RATE ||
 	    i2c->pclkrate > SYNQUACER_I2C_MAX_CLK_RATE)
-- 
2.34.1

Re: [PATCH 1/2] i2c: synquacer: Fix an error handling path in synquacer_i2c_probe()

[Ard Biesheuvel]

On Sat, 6 Jan 2024 at 13:48, Christophe JAILLET
<christophe.jaillet@wanadoo.fr> wrote:
>
> If an error occurs after the clk_prepare_enable() call, it should be undone
> by a corresponding clk_disable_unprepare() call, as already done in the
> remove() function.
>
> As devm_clk_get() is used, we can switch to devm_clk_get_enabled() to
> handle it automatically and fix the probe.
>
> Update the remove() function accordingly and remove the now useless
> clk_disable_unprepare() call.
>
> Fixes: 0d676a6c4390 ("i2c: add support for Socionext SynQuacer I2C controller")
> Signed-off-by: Christophe JAILLET <christophe.jaillet@wanadoo.fr>

Acked-by: Ard Biesheuvel <ardb@kernel.org>

> ---
>  drivers/i2c/busses/i2c-synquacer.c | 20 +++++++-------------
>  1 file changed, 7 insertions(+), 13 deletions(-)
>
> diff --git a/drivers/i2c/busses/i2c-synquacer.c b/drivers/i2c/busses/i2c-synquacer.c
> index bbea521b05dd..a73f5bb9a164 100644
> --- a/drivers/i2c/busses/i2c-synquacer.c
> +++ b/drivers/i2c/busses/i2c-synquacer.c
> @@ -550,17 +550,13 @@ static int synquacer_i2c_probe(struct platform_device *pdev)
>         device_property_read_u32(&pdev->dev, "socionext,pclk-rate",
>                                  &i2c->pclkrate);
>
> -       i2c->pclk = devm_clk_get(&pdev->dev, "pclk");
> -       if (PTR_ERR(i2c->pclk) == -EPROBE_DEFER)
> -               return -EPROBE_DEFER;
> -       if (!IS_ERR_OR_NULL(i2c->pclk)) {
> -               dev_dbg(&pdev->dev, "clock source %p\n", i2c->pclk);
> -
> -               ret = clk_prepare_enable(i2c->pclk);
> -               if (ret)
> -                       return dev_err_probe(&pdev->dev, ret, "failed to enable clock\n");
> -               i2c->pclkrate = clk_get_rate(i2c->pclk);
> -       }
> +       i2c->pclk = devm_clk_get_enabled(&pdev->dev, "pclk");
> +       if (IS_ERR(i2c->pclk))
> +               return dev_err_probe(&pdev->dev, PTR_ERR(i2c->pclk),
> +                                    "failed to get and enable clock\n");
> +
> +       dev_dbg(&pdev->dev, "clock source %p\n", i2c->pclk);
> +       i2c->pclkrate = clk_get_rate(i2c->pclk);
>
>         if (i2c->pclkrate < SYNQUACER_I2C_MIN_CLK_RATE ||
>             i2c->pclkrate > SYNQUACER_I2C_MAX_CLK_RATE)
> @@ -615,8 +611,6 @@ static void synquacer_i2c_remove(struct platform_device *pdev)
>         struct synquacer_i2c *i2c = platform_get_drvdata(pdev);
>
>         i2c_del_adapter(&i2c->adapter);
> -       if (!IS_ERR(i2c->pclk))
> -               clk_disable_unprepare(i2c->pclk);
>  };
>
>  static const struct of_device_id synquacer_i2c_dt_ids[] __maybe_unused = {
> --
> 2.34.1
>

Re: [PATCH 2/2] i2c: synquacer: Remove a clk reference from struct synquacer_i2c

[Ard Biesheuvel]

On Sat, 6 Jan 2024 at 13:48, Christophe JAILLET
<christophe.jaillet@wanadoo.fr> wrote:
>
> 'pclk' is only used locally in the probe. Remove it from the
> 'synquacer_i2c' structure.
>
> Also remove a useless debug message.
>
> Signed-off-by: Christophe JAILLET <christophe.jaillet@wanadoo.fr>

Acked-by: Ard Biesheuvel <ardb@kernel.org>

> ---
>  drivers/i2c/busses/i2c-synquacer.c | 11 +++++------
>  1 file changed, 5 insertions(+), 6 deletions(-)
>
> diff --git a/drivers/i2c/busses/i2c-synquacer.c b/drivers/i2c/busses/i2c-synquacer.c
> index a73f5bb9a164..e774b9f499b6 100644
> --- a/drivers/i2c/busses/i2c-synquacer.c
> +++ b/drivers/i2c/busses/i2c-synquacer.c
> @@ -138,7 +138,6 @@ struct synquacer_i2c {
>         int                     irq;
>         struct device           *dev;
>         void __iomem            *base;
> -       struct clk              *pclk;
>         u32                     pclkrate;
>         u32                     speed_khz;
>         u32                     timeout_ms;
> @@ -535,6 +534,7 @@ static const struct i2c_adapter synquacer_i2c_ops = {
>  static int synquacer_i2c_probe(struct platform_device *pdev)
>  {
>         struct synquacer_i2c *i2c;
> +       struct clk *pclk;
>         u32 bus_speed;
>         int ret;
>
> @@ -550,13 +550,12 @@ static int synquacer_i2c_probe(struct platform_device *pdev)
>         device_property_read_u32(&pdev->dev, "socionext,pclk-rate",
>                                  &i2c->pclkrate);
>
> -       i2c->pclk = devm_clk_get_enabled(&pdev->dev, "pclk");
> -       if (IS_ERR(i2c->pclk))
> -               return dev_err_probe(&pdev->dev, PTR_ERR(i2c->pclk),
> +       pclk = devm_clk_get_enabled(&pdev->dev, "pclk");
> +       if (IS_ERR(pclk))
> +               return dev_err_probe(&pdev->dev, PTR_ERR(pclk),
>                                      "failed to get and enable clock\n");
>
> -       dev_dbg(&pdev->dev, "clock source %p\n", i2c->pclk);
> -       i2c->pclkrate = clk_get_rate(i2c->pclk);
> +       i2c->pclkrate = clk_get_rate(pclk);
>
>         if (i2c->pclkrate < SYNQUACER_I2C_MIN_CLK_RATE ||
>             i2c->pclkrate > SYNQUACER_I2C_MAX_CLK_RATE)
> --
> 2.34.1
>

Re: [PATCH 1/2] i2c: synquacer: Fix an error handling path in synquacer_i2c_probe()

[Andi Shyti]

Hi Christophe,

On Sat, Jan 06, 2024 at 01:48:24PM +0100, Christophe JAILLET wrote:
> If an error occurs after the clk_prepare_enable() call, it should be undone
> by a corresponding clk_disable_unprepare() call, as already done in the
> remove() function.
> 
> As devm_clk_get() is used, we can switch to devm_clk_get_enabled() to
> handle it automatically and fix the probe.
> 
> Update the remove() function accordingly and remove the now useless
> clk_disable_unprepare() call.
> 
> Fixes: 0d676a6c4390 ("i2c: add support for Socionext SynQuacer I2C controller")
> Signed-off-by: Christophe JAILLET <christophe.jaillet@wanadoo.fr>

Applied to i2c/i2c-host-fixes.

Thanks,
Andi

Re: [PATCH 2/2] i2c: synquacer: Remove a clk reference from struct synquacer_i2c

[Andi Shyti]

Hi Christophe,

On Sat, Jan 06, 2024 at 01:48:25PM +0100, Christophe JAILLET wrote:
> 'pclk' is only used locally in the probe. Remove it from the
> 'synquacer_i2c' structure.
> 
> Also remove a useless debug message.
> 
> Signed-off-by: Christophe JAILLET <christophe.jaillet@wanadoo.fr>

Applied to i2c/i2c-host-next.

Thanks,
Andi

Re: [PATCH 1/2] i2c: synquacer: Fix an error handling path in synquacer_i2c_probe()

[Ard Biesheuvel]

On Mon, 6 May 2024 at 11:03, Andi Shyti <andi.shyti@kernel.org> wrote:
>
> Hi Christophe,
>
> On Sat, Jan 06, 2024 at 01:48:24PM +0100, Christophe JAILLET wrote:
> > If an error occurs after the clk_prepare_enable() call, it should be undone
> > by a corresponding clk_disable_unprepare() call, as already done in the
> > remove() function.
> >
> > As devm_clk_get() is used, we can switch to devm_clk_get_enabled() to
> > handle it automatically and fix the probe.
> >
> > Update the remove() function accordingly and remove the now useless
> > clk_disable_unprepare() call.
> >
> > Fixes: 0d676a6c4390 ("i2c: add support for Socionext SynQuacer I2C controller")
> > Signed-off-by: Christophe JAILLET <christophe.jaillet@wanadoo.fr>
>
> Applied to i2c/i2c-host-fixes.
>

These patches should be reverted: ACPI boot on SynQuacer based systems
now fails with

[    6.206022] synquacer_i2c SCX0003:00: error -ENOENT: failed to get
and enable clock
[    6.235762] synquacer_i2c SCX0003:00: probe with driver
synquacer_i2c failed with error -2

as in this case, there is no clock to enable, and the clock rate is
specified in the PRP0001 device node.

Re: [PATCH 1/2] i2c: synquacer: Fix an error handling path in synquacer_i2c_probe()

[Andy Shevchenko]

On Thu, Sep 12, 2024 at 1:23 PM Ard Biesheuvel <ardb@kernel.org> wrote:
> On Mon, 6 May 2024 at 11:03, Andi Shyti <andi.shyti@kernel.org> wrote:
> > On Sat, Jan 06, 2024 at 01:48:24PM +0100, Christophe JAILLET wrote:
> > > If an error occurs after the clk_prepare_enable() call, it should be undone
> > > by a corresponding clk_disable_unprepare() call, as already done in the
> > > remove() function.
> > >
> > > As devm_clk_get() is used, we can switch to devm_clk_get_enabled() to
> > > handle it automatically and fix the probe.
> > >
> > > Update the remove() function accordingly and remove the now useless
> > > clk_disable_unprepare() call.
> > >
> > > Fixes: 0d676a6c4390 ("i2c: add support for Socionext SynQuacer I2C controller")
> > > Signed-off-by: Christophe JAILLET <christophe.jaillet@wanadoo.fr>
> >
> > Applied to i2c/i2c-host-fixes.
>
> These patches should be reverted: ACPI boot on SynQuacer based systems
> now fails with
>
> [    6.206022] synquacer_i2c SCX0003:00: error -ENOENT: failed to get
> and enable clock
> [    6.235762] synquacer_i2c SCX0003:00: probe with driver
> synquacer_i2c failed with error -2
>
> as in this case, there is no clock to enable, and the clock rate is
> specified in the PRP0001 device node.

Wouldn't simply moving to _optional fix the issue?


-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH 1/2] i2c: synquacer: Fix an error handling path in synquacer_i2c_probe()

[Andy Shevchenko]

On Thu, Sep 12, 2024 at 1:23 PM Ard Biesheuvel <ardb@kernel.org> wrote:
> On Mon, 6 May 2024 at 11:03, Andi Shyti <andi.shyti@kernel.org> wrote:
> > On Sat, Jan 06, 2024 at 01:48:24PM +0100, Christophe JAILLET wrote:
> > > If an error occurs after the clk_prepare_enable() call, it should be undone
> > > by a corresponding clk_disable_unprepare() call, as already done in the
> > > remove() function.
> > >
> > > As devm_clk_get() is used, we can switch to devm_clk_get_enabled() to
> > > handle it automatically and fix the probe.
> > >
> > > Update the remove() function accordingly and remove the now useless
> > > clk_disable_unprepare() call.
> > >
> > > Fixes: 0d676a6c4390 ("i2c: add support for Socionext SynQuacer I2C controller")
> > > Signed-off-by: Christophe JAILLET <christophe.jaillet@wanadoo.fr>
> >
> > Applied to i2c/i2c-host-fixes.
> >
>
> These patches should be reverted: ACPI boot on SynQuacer based systems
> now fails with
>
> [    6.206022] synquacer_i2c SCX0003:00: error -ENOENT: failed to get
> and enable clock
> [    6.235762] synquacer_i2c SCX0003:00: probe with driver
> synquacer_i2c failed with error -2
>
> as in this case, there is no clock to enable, and the clock rate is
> specified in the PRP0001 device node.

I have just sent a fix, please test.

-- 
With Best Regards,
Andy Shevchenko