Re: [PATCH v3 8/9] reset: amlogic: split the device core and platform probe

From: Philipp Zabel
Date: Mon Sep 02 2024 - 06:39:08 EST


On Do, 2024-08-08 at 12:27 +0200, Jerome Brunet wrote:
> To prepare the addition of the auxiliary device support, split
> out the device core function from the probe of the platform device.
>
> The device core function will be common to both the platform and auxiliary
> driver.
>
> Signed-off-by: Jerome Brunet <jbrunet@xxxxxxxxxxxx>
> ---
> drivers/reset/amlogic/Kconfig | 10 +-
> drivers/reset/amlogic/Makefile | 3 +-
> .../{reset-meson.c => reset-meson-core.c} | 101 +++---------------
> drivers/reset/amlogic/reset-meson-pltf.c | 92 ++++++++++++++++
> drivers/reset/amlogic/reset-meson.h | 24 +++++
> 5 files changed, 143 insertions(+), 87 deletions(-)
> rename drivers/reset/amlogic/{reset-meson.c => reset-meson-core.c} (51%)
> create mode 100644 drivers/reset/amlogic/reset-meson-pltf.c
> create mode 100644 drivers/reset/amlogic/reset-meson.h
>
> diff --git a/drivers/reset/amlogic/Kconfig b/drivers/reset/amlogic/Kconfig
> index 7ed9cf50f038..04c7be0f3165 100644
> --- a/drivers/reset/amlogic/Kconfig
> +++ b/drivers/reset/amlogic/Kconfig
> @@ -1,9 +1,15 @@
> +config RESET_MESON_CORE
> + tristate
> + select REGMAP
> +
> config RESET_MESON
> - tristate "Meson Reset Driver"
> + tristate "Meson Reset Platform Driver"

I think this change is unnecessary.

> depends on ARCH_MESON || COMPILE_TEST
> default ARCH_MESON
> + select REGMAP_MMIO
> + select RESET_MESON_CORE
> help
> - This enables the reset driver for Amlogic Meson SoCs.
> + This enables the reset platform driver for Amlogic SoCs.

and this as well.

>
> config RESET_MESON_AUDIO_ARB
> tristate "Meson Audio Memory Arbiter Reset Driver"
> diff --git a/drivers/reset/amlogic/Makefile b/drivers/reset/amlogic/Makefile
> index 55509fc78513..0f8f9121b566 100644
> --- a/drivers/reset/amlogic/Makefile
> +++ b/drivers/reset/amlogic/Makefile
> @@ -1,2 +1,3 @@
> -obj-$(CONFIG_RESET_MESON) += reset-meson.o
> +obj-$(CONFIG_RESET_MESON) += reset-meson-pltf.o
> +obj-$(CONFIG_RESET_MESON_CORE) += reset-meson-core.o
> obj-$(CONFIG_RESET_MESON_AUDIO_ARB) += reset-meson-audio-arb.o
> diff --git a/drivers/reset/amlogic/reset-meson.c b/drivers/reset/amlogic/reset-meson-core.c
> similarity index 51%
> rename from drivers/reset/amlogic/reset-meson.c
> rename to drivers/reset/amlogic/reset-meson-core.c
> index b16d9c32adb1..ea4fc562f7e6 100644
> --- a/drivers/reset/amlogic/reset-meson.c
> +++ b/drivers/reset/amlogic/reset-meson-core.c
> @@ -1,27 +1,17 @@
> // SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause
> /*
> - * Amlogic Meson Reset Controller driver
> + * Amlogic Meson Reset core functions
> *
> - * Copyright (c) 2016 BayLibre, SAS.
> - * Author: Neil Armstrong <narmstrong@xxxxxxxxxxxx>
> + * Copyright (c) 2024 BayLibre, SAS.
> + * Author: Jerome Brunet <jbrunet@xxxxxxxxxxxx>
> */
> -#include <linux/err.h>
> -#include <linux/init.h>
> -#include <linux/io.h>
> -#include <linux/of.h>
> +
> +#include <linux/device.h>
> #include <linux/module.h>
> -#include <linux/platform_device.h>
> #include <linux/regmap.h>
> #include <linux/reset-controller.h>
> -#include <linux/slab.h>
> -#include <linux/types.h>
> -
> -struct meson_reset_param {
> - unsigned int reset_num;
> - unsigned int reset_offset;
> - unsigned int level_offset;
> - bool level_low_reset;
> -};
> +
> +#include "reset-meson.h"
>
> struct meson_reset {
> const struct meson_reset_param *param;
> @@ -102,84 +92,27 @@ static const struct reset_control_ops meson_reset_ops = {
> .status = meson_reset_status,
> };
>
> -static const struct meson_reset_param meson8b_param = {
> - .reset_num = 256,
> - .reset_offset = 0x0,
> - .level_offset = 0x7c,
> - .level_low_reset = true,
> -};
> -
> -static const struct meson_reset_param meson_a1_param = {
> - .reset_num = 96,
> - .reset_offset = 0x0,
> - .level_offset = 0x40,
> - .level_low_reset = true,
> -};
> -
> -static const struct meson_reset_param meson_s4_param = {
> - .reset_num = 192,
> - .reset_offset = 0x0,
> - .level_offset = 0x40,
> - .level_low_reset = true,
> -};
> -
> -static const struct of_device_id meson_reset_dt_ids[] = {
> - { .compatible = "amlogic,meson8b-reset", .data = &meson8b_param},
> - { .compatible = "amlogic,meson-gxbb-reset", .data = &meson8b_param},
> - { .compatible = "amlogic,meson-axg-reset", .data = &meson8b_param},
> - { .compatible = "amlogic,meson-a1-reset", .data = &meson_a1_param},
> - { .compatible = "amlogic,meson-s4-reset", .data = &meson_s4_param},
> - { .compatible = "amlogic,c3-reset", .data = &meson_s4_param},
> - { /* sentinel */ },
> -};
> -MODULE_DEVICE_TABLE(of, meson_reset_dt_ids);
> -
> -static const struct regmap_config regmap_config = {
> - .reg_bits = 32,
> - .val_bits = 32,
> - .reg_stride = 4,
> -};
> -
> -static int meson_reset_probe(struct platform_device *pdev)
> +int meson_reset_probe(struct device *dev, struct regmap *map,
> + const struct meson_reset_param *param)

I'd rename this to something other than *_probe, as this is not a
complete probe function to be used as a .probe callback anymore.
meson_reset_probe_common() or meson_reset_controller_register(), maybe?

> {
> - struct device *dev = &pdev->dev;
> struct meson_reset *data;
> - void __iomem *base;
>
> data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
> if (!data)
> return -ENOMEM;
>
> - base = devm_platform_ioremap_resource(pdev, 0);
> - if (IS_ERR(base))
> - return PTR_ERR(base);
> -
> - data->param = device_get_match_data(dev);
> - if (!data->param)
> - return -ENODEV;
> -
> - data->map = devm_regmap_init_mmio(dev, base, &regmap_config);
> - if (IS_ERR(data->map))
> - return dev_err_probe(dev, PTR_ERR(data->map),
> - "can't init regmap mmio region\n");
> -
> - data->rcdev.owner = THIS_MODULE;
> - data->rcdev.nr_resets = data->param->reset_num;
> + data->param = param;
> + data->map = map;
> + data->rcdev.owner = dev->driver->owner;
> + data->rcdev.nr_resets = param->reset_num;
> data->rcdev.ops = &meson_reset_ops;
> data->rcdev.of_node = dev->of_node;
>
> return devm_reset_controller_register(dev, &data->rcdev);
> }
> +EXPORT_SYMBOL_NS_GPL(meson_reset_probe, MESON_RESET);
>
> -static struct platform_driver meson_reset_driver = {
> - .probe = meson_reset_probe,
> - .driver = {
> - .name = "meson_reset",
> - .of_match_table = meson_reset_dt_ids,
> - },
> -};
> -module_platform_driver(meson_reset_driver);
> -
> -MODULE_DESCRIPTION("Amlogic Meson Reset Controller driver");
> +MODULE_DESCRIPTION("Amlogic Meson Reset Core function");
> MODULE_AUTHOR("Neil Armstrong <narmstrong@xxxxxxxxxxxx>");
> -MODULE_LICENSE("Dual BSD/GPL");
> +MODULE_AUTHOR("Jerome Brunet <jbrunet@xxxxxxxxxxxx>");
> +MODULE_IMPORT_NS(MESON_RESET);
> diff --git a/drivers/reset/amlogic/reset-meson-pltf.c b/drivers/reset/amlogic/reset-meson-pltf.c
> new file mode 100644
> index 000000000000..97e933b4aa34
> --- /dev/null
> +++ b/drivers/reset/amlogic/reset-meson-pltf.c

I'd keep the reset-meson.c name for this file.

> @@ -0,0 +1,92 @@
> +// SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause
> +/*
> + * Amlogic Meson Reset platform driver

I thought "Amlogic Meson Reset Controller driver" was pretty
descriptive. Let's keep that.

> + *
> + * Copyright (c) 2016 BayLibre, SAS.
> + * Author: Neil Armstrong <narmstrong@xxxxxxxxxxxx>
> + */
> +#include <linux/err.h>
> +#include <linux/io.h>
> +#include <linux/of.h>
> +#include <linux/module.h>
> +#include <linux/platform_device.h>
> +#include <linux/regmap.h>
> +#include <linux/reset-controller.h>
> +
> +#include "reset-meson.h"
> +
> +static const struct meson_reset_param meson8b_param = {
> + .reset_num = 256,
> + .reset_offset = 0x0,
> + .level_offset = 0x7c,
> + .level_low_reset = true,
> +};
> +
> +static const struct meson_reset_param meson_a1_param = {
> + .reset_num = 96,
> + .reset_offset = 0x0,
> + .level_offset = 0x40,
> + .level_low_reset = true,
> +};
> +
> +static const struct meson_reset_param meson_s4_param = {
> + .reset_num = 192,
> + .reset_offset = 0x0,
> + .level_offset = 0x40,
> + .level_low_reset = true,
> +};
> +
> +static const struct of_device_id meson_reset_dt_ids[] = {
> + { .compatible = "amlogic,meson8b-reset", .data = &meson8b_param},
> + { .compatible = "amlogic,meson-gxbb-reset", .data = &meson8b_param},
> + { .compatible = "amlogic,meson-axg-reset", .data = &meson8b_param},
> + { .compatible = "amlogic,meson-a1-reset", .data = &meson_a1_param},
> + { .compatible = "amlogic,meson-s4-reset", .data = &meson_s4_param},
> + { .compatible = "amlogic,c3-reset", .data = &meson_s4_param},
> + { /* sentinel */ },
> +};
> +MODULE_DEVICE_TABLE(of, meson_reset_dt_ids);
> +
> +static const struct regmap_config regmap_config = {
> + .reg_bits = 32,
> + .val_bits = 32,
> + .reg_stride = 4,
> +};
> +
> +static int meson_reset_pltf_probe(struct platform_device *pdev)

s/pltf_//

> +{
> + const struct meson_reset_param *param;
> + struct device *dev = &pdev->dev;
> + struct regmap *map;
> + void __iomem *base;
> +
> + base = devm_platform_ioremap_resource(pdev, 0);
> + if (IS_ERR(base))
> + return PTR_ERR(base);
> +
> + param = device_get_match_data(dev);
> + if (!param)
> + return -ENODEV;
> +
> + map = devm_regmap_init_mmio(dev, base, &regmap_config);
> + if (IS_ERR(map))
> + return dev_err_probe(dev, PTR_ERR(map),
> + "can't init regmap mmio region\n");
> +
> + return meson_reset_probe(dev, map, param);
> +}
> +
> +static struct platform_driver meson_reset_pltf_driver = {

s/pltf_//

> + .probe = meson_reset_pltf_probe,

s/pltf_//

> + .driver = {
> + .name = "meson_reset",
> + .of_match_table = meson_reset_dt_ids,
> + },
> +};
> +module_platform_driver(meson_reset_pltf_driver);

s/pltf_//

> +
> +MODULE_DESCRIPTION("Amlogic Meson Reset Platform Controller driver");

s/Platform //

> +MODULE_AUTHOR("Neil Armstrong <narmstrong@xxxxxxxxxxxx>");
> +MODULE_AUTHOR("Jerome Brunet <jbrunet@xxxxxxxxxxxx>");
> +MODULE_LICENSE("Dual BSD/GPL");
> +MODULE_IMPORT_NS(MESON_RESET);
> diff --git a/drivers/reset/amlogic/reset-meson.h b/drivers/reset/amlogic/reset-meson.h
> new file mode 100644
> index 000000000000..c2e8a5cf2e46
> --- /dev/null
> +++ b/drivers/reset/amlogic/reset-meson.h
> @@ -0,0 +1,24 @@
> +/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
> +/*
> + * Copyright (c) 2024 BayLibre, SAS.
> + * Author: Jerome Brunet <jbrunet@xxxxxxxxxxxx>
> + */
> +
> +#ifndef __MESON_RESET_CORE_H
> +#define __MESON_RESET_CORE_H
> +
> +#include <linux/module.h>
> +#include <linux/regmap.h>
> +#include <linux/reset-controller.h>
> +
> +struct meson_reset_param {
> + unsigned int reset_num;
> + unsigned int reset_offset;
> + unsigned int level_offset;
> + bool level_low_reset;
> +};
> +
> +int meson_reset_probe(struct device *dev, struct regmap *map,
> + const struct meson_reset_param *param);
> +
> +#endif /* __MESON_RESET_CORE_H */

regards
Philipp