mbox series

[0/7] memory: simplify with devm() and guard()

Message ID 20240823-b4-cleanup-h-guard-v1-0-01668915bd55@linaro.org
Headers show
Series memory: simplify with devm() and guard() | expand

Message

Krzysztof Kozlowski Aug. 23, 2024, 10:15 a.m. UTC
Few cleanups/simplifications, of which second patch "memory: emif:
simplify locking with guard()" might have actual impact (RFT).

Best regards,
Krzysztof

---
Krzysztof Kozlowski (7):
      memory: emif: drop unused 'irq_state' member
      memory: emif: simplify locking with guard()
      memory: omap-gpmc: simplify locking with guard()
      memory: pl172: simplify with dev_err_probe()
      memory: pl172: simplify with devm_clk_get_enabled()
      memory: pl353-smc: simplify with dev_err_probe()
      memory: pl353-smc: simplify with devm_clk_get_enabled()

 drivers/memory/emif.c      | 18 ++++++++---------
 drivers/memory/omap-gpmc.c | 24 ++++++++++------------
 drivers/memory/pl172.c     | 30 ++++++++--------------------
 drivers/memory/pl353-smc.c | 50 +++++++++-------------------------------------
 4 files changed, 36 insertions(+), 86 deletions(-)
---
base-commit: 0aa21a46c484770ef30207ed77a9fd3f5a6a32cf
change-id: 20240823-b4-cleanup-h-guard-c30a42f76f23

Best regards,

Comments

Miquel Raynal Aug. 23, 2024, 11:23 a.m. UTC | #1
Hi Krzysztof,

krzysztof.kozlowski@linaro.org wrote on Fri, 23 Aug 2024 12:16:02 +0200:

> Use devm_clk_get_enabled() to drop clock prepare/unprepare parts and
> make code simpler.
> 
> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

Reviewed-by: Miquel Raynal <miquel.raynal@bootlin.com>

Thanks,
Miquèl
Jonathan Cameron Aug. 23, 2024, 11:42 a.m. UTC | #2
On Fri, 23 Aug 2024 12:15:58 +0200
Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:

> Simplify error handling (less gotos) over locks with guard().
> 
> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Simple one. LGTM
Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Jonathan Cameron Aug. 23, 2024, 11:51 a.m. UTC | #3
On Fri, 23 Aug 2024 12:16:00 +0200
Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:

> Use devm_clk_get_enabled() to drop clock prepare/unprepare parts and
> make code simpler.  Change to dev_err_probe() in handling clk_get_rate()
> error to make it even simpler.
> 
> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Follow up suggestion inline + I'd use dev_err_probe() one more
time.

Anyhow fine either way
Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

> ---
>  drivers/memory/pl172.c | 23 +++++------------------
>  1 file changed, 5 insertions(+), 18 deletions(-)
> 
> diff --git a/drivers/memory/pl172.c b/drivers/memory/pl172.c
> index 390012401f64..db5fbee34077 100644
> --- a/drivers/memory/pl172.c
> +++ b/drivers/memory/pl172.c
> @@ -216,28 +216,20 @@ static int pl172_probe(struct amba_device *adev, const struct amba_id *id)
>  	if (!pl172)
>  		return -ENOMEM;
>  
> -	pl172->clk = devm_clk_get(dev, "mpmcclk");
> +	pl172->clk = devm_clk_get_enabled(dev, "mpmcclk");
>  	if (IS_ERR(pl172->clk))
>  		return dev_err_probe(dev, PTR_ERR(pl172->clk),
>  				     "no mpmcclk provided clock\n");
>  
> -	ret = clk_prepare_enable(pl172->clk);
> -	if (ret) {
> -		dev_err(dev, "unable to mpmcclk enable clock\n");
> -		return ret;
> -	}
> -
>  	pl172->rate = clk_get_rate(pl172->clk) / MSEC_PER_SEC;
> -	if (!pl172->rate) {
> -		dev_err(dev, "unable to get mpmcclk clock rate\n");
> -		ret = -EINVAL;
> -		goto err_clk_enable;
> -	}
> +	if (!pl172->rate)
> +		return dev_err_probe(dev, -EINVAL,
> +				     "unable to get mpmcclk clock rate\n");
>  
>  	ret = amba_request_regions(adev, NULL);
Seeing as you are here an obvious follow up...

Use a devm_add_action_or_reset() and a local cleanup callback
or spin up a devm_amba_request_regions() and apply that here
and probably in other similar locations (a quick look suggested
this would be generally useful).

Then can drop remove entirely which is always nice to see + return
directly in the remaining error path.

>  	if (ret) {
>  		dev_err(dev, "unable to request AMBA regions\n");
> -		goto err_clk_enable;
> +		return ret;
I'd make this a return dev_err_probe() as well.

>  	}
>  
>  	pl172->base = devm_ioremap(dev, adev->res.start,
> @@ -267,16 +259,11 @@ static int pl172_probe(struct amba_device *adev, const struct amba_id *id)
>  
>  err_no_ioremap:
>  	amba_release_regions(adev);
> -err_clk_enable:
> -	clk_disable_unprepare(pl172->clk);
>  	return ret;
>  }
>  
>  static void pl172_remove(struct amba_device *adev)
>  {
> -	struct pl172_data *pl172 = amba_get_drvdata(adev);
> -
> -	clk_disable_unprepare(pl172->clk);
>  	amba_release_regions(adev);
>  }
>  
>
Jonathan Cameron Aug. 23, 2024, 11:56 a.m. UTC | #4
On Fri, 23 Aug 2024 12:16:02 +0200
Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:

> Use devm_clk_get_enabled() to drop clock prepare/unprepare parts and
> make code simpler.
> 
> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
LGTM.
Follow up suggestion inline.

Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

> ---
>  drivers/memory/pl353-smc.c | 36 +++---------------------------------
>  1 file changed, 3 insertions(+), 33 deletions(-)
> 
> diff --git a/drivers/memory/pl353-smc.c b/drivers/memory/pl353-smc.c
> index c75b99e49970..994c7a792e34 100644
> --- a/drivers/memory/pl353-smc.c
> +++ b/drivers/memory/pl353-smc.c
> @@ -75,34 +75,21 @@ static int pl353_smc_probe(struct amba_device *adev, const struct amba_id *id)
>  	const struct of_device_id *match = NULL;
>  	struct pl353_smc_data *pl353_smc;
>  	struct device_node *child;
> -	int err;
>  
>  	pl353_smc = devm_kzalloc(&adev->dev, sizeof(*pl353_smc), GFP_KERNEL);
>  	if (!pl353_smc)
>  		return -ENOMEM;
>  
> -	pl353_smc->aclk = devm_clk_get(&adev->dev, "apb_pclk");
> +	pl353_smc->aclk = devm_clk_get_enabled(&adev->dev, "apb_pclk");
>  	if (IS_ERR(pl353_smc->aclk))
>  		return dev_err_probe(&adev->dev, PTR_ERR(pl353_smc->aclk),
>  				     "aclk clock not found.\n");
>  
> -	pl353_smc->memclk = devm_clk_get(&adev->dev, "memclk");
> +	pl353_smc->memclk = devm_clk_get_enabled(&adev->dev, "memclk");
>  	if (IS_ERR(pl353_smc->memclk))
>  		return dev_err_probe(&adev->dev, PTR_ERR(pl353_smc->memclk),
>  				     "memclk clock not found.\n");
>  
> -	err = clk_prepare_enable(pl353_smc->aclk);
> -	if (err) {
> -		dev_err(&adev->dev, "Unable to enable AXI clock.\n");
> -		return err;
> -	}
> -
> -	err = clk_prepare_enable(pl353_smc->memclk);
> -	if (err) {
> -		dev_err(&adev->dev, "Unable to enable memory clock.\n");
> -		goto disable_axi_clk;
> -	}
> -
>  	amba_set_drvdata(adev, pl353_smc);
>  
>  	/* Find compatible children. Only a single child is supported */
> @@ -115,30 +102,14 @@ static int pl353_smc_probe(struct amba_device *adev, const struct amba_id *id)
>  		break;
>  	}
>  	if (!match) {
With change below this becomes unconditional as we'll have already
returned in the loop for the good path.

Might as well use dev_err_probe() here as well to save a few lines.

> -		err = -ENODEV;
>  		dev_err(&adev->dev, "no matching children\n");
> -		goto disable_mem_clk;
> +		return -ENODEV;
>  	}
>  
>  	of_platform_device_create(child, NULL, &adev->dev);
>  	of_node_put(child);

An additional cleanup looks sensible here.

Push this last bit into the loop and use 

for_each_available_child_of_node_scoped()

Assuming you don't already have a patch doing that :)

>  
>  	return 0;
> -
> -disable_mem_clk:
> -	clk_disable_unprepare(pl353_smc->memclk);
> -disable_axi_clk:
> -	clk_disable_unprepare(pl353_smc->aclk);
> -
> -	return err;
> -}
> -
> -static void pl353_smc_remove(struct amba_device *adev)
> -{
> -	struct pl353_smc_data *pl353_smc = amba_get_drvdata(adev);
> -
> -	clk_disable_unprepare(pl353_smc->memclk);
> -	clk_disable_unprepare(pl353_smc->aclk);
>  }
>  
>  static const struct amba_id pl353_ids[] = {
> @@ -157,7 +128,6 @@ static struct amba_driver pl353_smc_driver = {
>  	},
>  	.id_table = pl353_ids,
>  	.probe = pl353_smc_probe,
> -	.remove = pl353_smc_remove,
>  };
>  
>  module_amba_driver(pl353_smc_driver);
>
Vladimir Zapolskiy Aug. 23, 2024, 12:22 p.m. UTC | #5
On 8/23/24 13:16, Krzysztof Kozlowski wrote:
> Use devm_clk_get_enabled() to drop clock prepare/unprepare parts and
> make code simpler.  Change to dev_err_probe() in handling clk_get_rate()
> error to make it even simpler.
> 
> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

Reviewed-by: Vladimir Zapolskiy <vz@mleia.com>

--
Best wishes,
Vladimir
Krzysztof Kozlowski Aug. 25, 2024, 8:13 a.m. UTC | #6
On 23/08/2024 13:56, Jonathan Cameron wrote:
> With change below this becomes unconditional as we'll have already
> returned in the loop for the good path.
> 
> Might as well use dev_err_probe() here as well to save a few lines.
> 
>> -		err = -ENODEV;
>>  		dev_err(&adev->dev, "no matching children\n");
>> -		goto disable_mem_clk;
>> +		return -ENODEV;
>>  	}
>>  
>>  	of_platform_device_create(child, NULL, &adev->dev);
>>  	of_node_put(child);
> 
> An additional cleanup looks sensible here.
> 
> Push this last bit into the loop and use 
> 
> for_each_available_child_of_node_scoped()
> 
> Assuming you don't already have a patch doing that :)

Yes, this could be simplified, thanks for the hint.

Best regards,
Krzysztof
Krzysztof Kozlowski Aug. 25, 2024, 12:22 p.m. UTC | #7
On Fri, 23 Aug 2024 12:15:55 +0200, Krzysztof Kozlowski wrote:
> Few cleanups/simplifications, of which second patch "memory: emif:
> simplify locking with guard()" might have actual impact (RFT).
> 
> Best regards,
> Krzysztof
> 

Applied, thanks!

[1/7] memory: emif: drop unused 'irq_state' member
      https://git.kernel.org/krzk/linux-mem-ctrl/c/99602b4d30359f971247f8438afac57cbd1832f0
[2/7] memory: emif: simplify locking with guard()
      https://git.kernel.org/krzk/linux-mem-ctrl/c/f1619986d7e996eb6e53c7fe8ab32e66b17e1cf1
[3/7] memory: omap-gpmc: simplify locking with guard()
      https://git.kernel.org/krzk/linux-mem-ctrl/c/c93ad423edd8a42a6666241595043f9193469f9e
[4/7] memory: pl172: simplify with dev_err_probe()
      https://git.kernel.org/krzk/linux-mem-ctrl/c/8f3cb397cbc1e3b18081738af87171f960bd112e
[5/7] memory: pl172: simplify with devm_clk_get_enabled()
      https://git.kernel.org/krzk/linux-mem-ctrl/c/610395de8496c34919f827dd194bf41af20c2bca
[6/7] memory: pl353-smc: simplify with dev_err_probe()
      https://git.kernel.org/krzk/linux-mem-ctrl/c/49ee2e842a40dec16ed4933bf2cd993c709f12a3
[7/7] memory: pl353-smc: simplify with devm_clk_get_enabled()
      https://git.kernel.org/krzk/linux-mem-ctrl/c/ce536578e5652ec4da10ec69436d2ae2548bd619

Best regards,