[PATCH V8 3/6] soc: imx: add i.MX93 SRC power domain driver

[Peng Fan]

On 9/4/2022 5:52 PM, Shawn Guo wrote:
> On Tue, Aug 23, 2022 at 01:52:12PM +0800, Peng Fan (OSS) wrote:
>> From: Peng Fan <peng.fan at nxp.com>
>>
>> Support controlling power domain managed by System Reset
>> Controller(SRC). Current supported power domain is mediamix power
>> domain.
>>
>> Signed-off-by: Peng Fan <peng.fan at nxp.com>
>> ---
>>   drivers/soc/imx/Kconfig     |   8 ++
>>   drivers/soc/imx/Makefile    |   1 +
>>   drivers/soc/imx/imx93-pd.c  | 164 ++++++++++++++++++++++++++++++++++++
>>   drivers/soc/imx/imx93-src.c |  33 ++++++++
>>   4 files changed, 206 insertions(+)
>>   create mode 100644 drivers/soc/imx/imx93-pd.c
>>   create mode 100644 drivers/soc/imx/imx93-src.c
>>
>> diff --git a/drivers/soc/imx/Kconfig b/drivers/soc/imx/Kconfig
>> index a840494e849a..4b906791d6c7 100644
>> --- a/drivers/soc/imx/Kconfig
>> +++ b/drivers/soc/imx/Kconfig
>> @@ -20,4 +20,12 @@ config SOC_IMX8M
>>   	  support, it will provide the SoC info like SoC family,
>>   	  ID and revision etc.
>>   
>> +config SOC_IMX9
>> +	tristate "i.MX9 SoC family support"
>> +	depends on ARCH_MXC || COMPILE_TEST
>> +	default ARCH_MXC && ARM64
>> +	select SOC_BUS
>> +	help
>> +	  If you say yes here, you get support for the NXP i.MX9 family
>> +
>>   endmenu
>> diff --git a/drivers/soc/imx/Makefile b/drivers/soc/imx/Makefile
>> index 63cd29f6d4d2..a0baa2a01adb 100644
>> --- a/drivers/soc/imx/Makefile
>> +++ b/drivers/soc/imx/Makefile
>> @@ -7,3 +7,4 @@ obj-$(CONFIG_IMX_GPCV2_PM_DOMAINS) += gpcv2.o
>>   obj-$(CONFIG_SOC_IMX8M) += soc-imx8m.o
>>   obj-$(CONFIG_SOC_IMX8M) += imx8m-blk-ctrl.o
>>   obj-$(CONFIG_SOC_IMX8M) += imx8mp-blk-ctrl.o
>> +obj-$(CONFIG_SOC_IMX9) += imx93-src.o imx93-pd.o
>> diff --git a/drivers/soc/imx/imx93-pd.c b/drivers/soc/imx/imx93-pd.c
>> new file mode 100644
>> index 000000000000..042a89cb53da
>> --- /dev/null
>> +++ b/drivers/soc/imx/imx93-pd.c
>> @@ -0,0 +1,164 @@
>> +// SPDX-License-Identifier: GPL-2.0
>> +/*
>> + * Copyright 2022 NXP
>> + */
>> +
>> +#include <linux/clk.h>
>> +#include <linux/of_device.h>
>> +#include <linux/delay.h>
>> +#include <linux/iopoll.h>
>> +#include <linux/module.h>
>> +#include <linux/platform_device.h>
>> +#include <linux/pm_domain.h>
> 
> Can we sort these headers alphabetically?

Fix in V9.

> 
>> +
>> +#define MIX_SLICE_SW_CTRL_OFF		0x20
>> +#define SLICE_SW_CTRL_PSW_CTRL_OFF_MASK	BIT(4)
>> +#define SLICE_SW_CTRL_PDN_SOFT_MASK	BIT(31)
>> +
>> +#define MIX_FUNC_STAT_OFF		0xB4
>> +
>> +#define FUNC_STAT_PSW_STAT_MASK		BIT(0)
>> +#define FUNC_STAT_RST_STAT_MASK		BIT(2)
>> +#define FUNC_STAT_ISO_STAT_MASK		BIT(4)
>> +
>> +struct imx93_power_domain {
>> +	struct generic_pm_domain genpd;
>> +	struct device *dev;
>> +	void __iomem *addr;
>> +	struct clk_bulk_data *clks;
>> +	int num_clks;
>> +	bool init_off;
>> +};
>> +
>> +#define to_imx93_pd(_genpd) container_of(_genpd, struct imx93_power_domain, genpd)
>> +
>> +static int imx93_pd_on(struct generic_pm_domain *genpd)
>> +{
>> +	struct imx93_power_domain *domain = to_imx93_pd(genpd);
>> +	void __iomem *addr = domain->addr;
>> +	u32 val;
>> +	int ret;
>> +
>> +	ret = clk_bulk_prepare_enable(domain->num_clks, domain->clks);
>> +	if (ret) {
>> +		dev_err(domain->dev, "failed to enable clocks for domain: %s\n", genpd->name);
>> +		return ret;
>> +	}
>> +
>> +	val = readl(addr + MIX_SLICE_SW_CTRL_OFF);
>> +	val &= ~SLICE_SW_CTRL_PDN_SOFT_MASK;
>> +	writel(val, addr + MIX_SLICE_SW_CTRL_OFF);
>> +
>> +	ret = readl_poll_timeout(addr + MIX_FUNC_STAT_OFF, val,
>> +				 !(val & FUNC_STAT_ISO_STAT_MASK), 1, 10000);
>> +	if (ret) {
>> +		dev_err(domain->dev, "pd_on timeout: name: %s, stat: %x\n", genpd->name, val);
>> +		return ret;
>> +	}
>> +
>> +	return 0;
>> +}
>> +
>> +static int imx93_pd_off(struct generic_pm_domain *genpd)
>> +{
>> +	struct imx93_power_domain *domain = to_imx93_pd(genpd);
>> +	void __iomem *addr = domain->addr;
>> +	int ret;
>> +	u32 val;
>> +
>> +	/* Power off MIX */
>> +	val = readl(addr + MIX_SLICE_SW_CTRL_OFF);
>> +	val |= SLICE_SW_CTRL_PDN_SOFT_MASK;
>> +	writel(val, addr + MIX_SLICE_SW_CTRL_OFF);
>> +
>> +	ret = readl_poll_timeout(addr + MIX_FUNC_STAT_OFF, val,
>> +				 val & FUNC_STAT_PSW_STAT_MASK, 1, 1000);
>> +	if (ret) {
>> +		dev_err(domain->dev, "pd_off timeout: name: %s, stat: %x\n", genpd->name, val);
>> +		return ret;
>> +	}
>> +
>> +	clk_bulk_disable_unprepare(domain->num_clks, domain->clks);
>> +
>> +	return 0;
>> +};
>> +
>> +static int imx93_pd_remove(struct platform_device *pdev)
>> +{
>> +	struct imx93_power_domain *domain = platform_get_drvdata(pdev);
>> +	struct device *dev = &pdev->dev;
>> +	struct device_node *np = dev->of_node;
>> +
>> +	if (!domain->init_off)
>> +		clk_bulk_disable_unprepare(domain->num_clks, domain->clks);
>> +
>> +	of_genpd_del_provider(np);
>> +	pm_genpd_remove(&domain->genpd);
>> +
>> +	return 0;
>> +}
>> +
>> +static int imx93_pd_probe(struct platform_device *pdev)
>> +{
>> +	struct device *dev = &pdev->dev;
>> +	struct device_node *np = dev->of_node;
>> +	struct imx93_power_domain *domain;
>> +	int ret;
>> +
>> +	domain = devm_kzalloc(dev, sizeof(*domain), GFP_KERNEL);
>> +	if (!domain)
>> +		return -ENOMEM;
>> +
>> +	domain->addr = devm_platform_ioremap_resource(pdev, 0);
>> +	if (IS_ERR(domain->addr))
>> +		return PTR_ERR(domain->addr);
>> +
>> +	domain->num_clks = devm_clk_bulk_get_all(dev, &domain->clks);
>> +	if (domain->num_clks < 0)
>> +		return dev_err_probe(dev, domain->num_clks, "Failed to get domain's clocks\n");
>> +
>> +	domain->genpd.name = dev_name(dev);
>> +	domain->genpd.power_off = imx93_pd_off;
>> +	domain->genpd.power_on = imx93_pd_on;
>> +	domain->dev = dev;
>> +
>> +	domain->init_off = readl(domain->addr + MIX_FUNC_STAT_OFF) & FUNC_STAT_ISO_STAT_MASK;
>> +	/* Just to sync the status of hardware */
>> +	if (!domain->init_off) {
>> +		ret = clk_bulk_prepare_enable(domain->num_clks, domain->clks);
>> +		if (ret) {
>> +			dev_err(domain->dev, "failed to enable clocks for domain: %s\n",
>> +				domain->genpd.name);
>> +			return ret;
>> +		}
>> +	}
>> +
>> +	ret = pm_genpd_init(&domain->genpd, NULL, domain->init_off);
>> +	if (ret)
>> +		return ret;
>> +
>> +	platform_set_drvdata(pdev, domain);
>> +
>> +	return of_genpd_add_provider_simple(np, &domain->genpd);
>> +}
>> +
>> +static const struct of_device_id imx93_dt_ids[] = {
> 
> Can we make the variable name a bit driver specific? 'imx93_dt_ids' is
> used in both this power domain and SRC driver below.

Yes, fix in v9.

> 
>> +	{ .compatible = "fsl,imx93-src-slice" },
>> +	{ }
>> +};
>> +MODULE_DEVICE_TABLE(of, imx93_dt_ids);
>> +
>> +static struct platform_driver imx93_power_domain_driver = {
>> +	.driver = {
>> +		.name	= "imx93_power_domain",
>> +		.owner	= THIS_MODULE,
>> +		.of_match_table = imx93_dt_ids,
>> +	},
>> +	.probe = imx93_pd_probe,
>> +	.remove = imx93_pd_remove,
>> +};
>> +module_platform_driver(imx93_power_domain_driver);
>> +
>> +MODULE_AUTHOR("Peng Fan <peng.fan at nxp.com>");
>> +MODULE_DESCRIPTION("NXP i.MX93 power domain driver");
>> +MODULE_LICENSE("GPL");
> 
> Considering 'SPDX-License-Identifier: GPL-2.0' above, should we use
> "GPL v2" here?

No. Per ./Documentation/process/license-rules.rst

"GPL v2"    Same as "GPL". It exists for historic reasons.

Thanks,
Peng.

> 
> Shawn
> 
>> diff --git a/drivers/soc/imx/imx93-src.c b/drivers/soc/imx/imx93-src.c
>> new file mode 100644
>> index 000000000000..830cbb9541c1
>> --- /dev/null
>> +++ b/drivers/soc/imx/imx93-src.c
>> @@ -0,0 +1,33 @@
>> +// SPDX-License-Identifier: GPL-2.0
>> +/*
>> + * Copyright 2022 NXP
>> + */
>> +
>> +#include <linux/module.h>
>> +#include <linux/of_platform.h>
>> +#include <linux/platform_device.h>
>> +
>> +static int imx93_src_probe(struct platform_device *pdev)
>> +{
>> +	return devm_of_platform_populate(&pdev->dev);
>> +}
>> +
>> +static const struct of_device_id imx93_dt_ids[] = {
>> +	{ .compatible = "fsl,imx93-src" },
>> +	{ }
>> +};
>> +MODULE_DEVICE_TABLE(of, imx93_dt_ids);
>> +
>> +static struct platform_driver imx93_src_driver = {
>> +	.driver = {
>> +		.name	= "imx93_src",
>> +		.owner	= THIS_MODULE,
>> +		.of_match_table = imx93_dt_ids,
>> +	},
>> +	.probe = imx93_src_probe,
>> +};
>> +module_platform_driver(imx93_src_driver);
>> +
>> +MODULE_AUTHOR("Peng Fan <peng.fan at nxp.com>");
>> +MODULE_DESCRIPTION("NXP i.MX93 src driver");
>> +MODULE_LICENSE("GPL");
>> -- 
>> 2.37.1
>>