[mirror_ubuntu-jammy-kernel.git] / drivers / soc / ti / ti_sci_pm_domains.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * TI SCI Generic Power Domain Driver
 *
 * Copyright (C) 2015-2017 Texas Instruments Incorporated - http://www.ti.com/
 *	J Keerthy <j-keerthy@ti.com>
 *	Dave Gerlach <d-gerlach@ti.com>
 */

#include <linux/err.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/platform_device.h>
#include <linux/pm_domain.h>
#include <linux/slab.h>
#include <linux/soc/ti/ti_sci_protocol.h>
#include <dt-bindings/soc/ti,sci_pm_domain.h>

/**
 * struct ti_sci_genpd_provider: holds common TI SCI genpd provider data
 * @ti_sci: handle to TI SCI protocol driver that provides ops to
 *	    communicate with system control processor.
 * @dev: pointer to dev for the driver for devm allocs
 * @pd_list: list of all the power domains on the device
 * @data: onecell data for genpd core
 */
struct ti_sci_genpd_provider {
	const struct ti_sci_handle *ti_sci;
	struct device *dev;
	struct list_head pd_list;
	struct genpd_onecell_data data;
};

/**
 * struct ti_sci_pm_domain: TI specific data needed for power domain
 * @idx: index of the device that identifies it with the system
 *	 control processor.
 * @exclusive: Permissions for exclusive request or shared request of the
 *	       device.
 * @pd: generic_pm_domain for use with the genpd framework
 * @node: link for the genpd list
 * @parent: link to the parent TI SCI genpd provider
 */
struct ti_sci_pm_domain {
	int idx;
	u8 exclusive;
	struct generic_pm_domain pd;
	struct list_head node;
	struct ti_sci_genpd_provider *parent;
};

#define genpd_to_ti_sci_pd(gpd) container_of(gpd, struct ti_sci_pm_domain, pd)

/*
 * ti_sci_pd_power_off(): genpd power down hook
 * @domain: pointer to the powerdomain to power off
 */
static int ti_sci_pd_power_off(struct generic_pm_domain *domain)
{
	struct ti_sci_pm_domain *pd = genpd_to_ti_sci_pd(domain);
	const struct ti_sci_handle *ti_sci = pd->parent->ti_sci;

	return ti_sci->ops.dev_ops.put_device(ti_sci, pd->idx);
}

/*
 * ti_sci_pd_power_on(): genpd power up hook
 * @domain: pointer to the powerdomain to power on
 */
static int ti_sci_pd_power_on(struct generic_pm_domain *domain)
{
	struct ti_sci_pm_domain *pd = genpd_to_ti_sci_pd(domain);
	const struct ti_sci_handle *ti_sci = pd->parent->ti_sci;

	if (pd->exclusive)
		return ti_sci->ops.dev_ops.get_device_exclusive(ti_sci,
								pd->idx);
	else
		return ti_sci->ops.dev_ops.get_device(ti_sci, pd->idx);
}

/*
 * ti_sci_pd_xlate(): translation service for TI SCI genpds
 * @genpdspec: DT identification data for the genpd
 * @data: genpd core data for all the powerdomains on the device
 */
static struct generic_pm_domain *ti_sci_pd_xlate(
					struct of_phandle_args *genpdspec,
					void *data)
{
	struct genpd_onecell_data *genpd_data = data;
	unsigned int idx = genpdspec->args[0];

	if (genpdspec->args_count != 1 && genpdspec->args_count != 2)
		return ERR_PTR(-EINVAL);

	if (idx >= genpd_data->num_domains) {
		pr_err("%s: invalid domain index %u\n", __func__, idx);
		return ERR_PTR(-EINVAL);
	}

	if (!genpd_data->domains[idx])
		return ERR_PTR(-ENOENT);

	genpd_to_ti_sci_pd(genpd_data->domains[idx])->exclusive =
		genpdspec->args[1];

	return genpd_data->domains[idx];
}

static const struct of_device_id ti_sci_pm_domain_matches[] = {
	{ .compatible = "ti,sci-pm-domain", },
	{ },
};
MODULE_DEVICE_TABLE(of, ti_sci_pm_domain_matches);

static int ti_sci_pm_domain_probe(struct platform_device *pdev)
{
	struct device *dev = &pdev->dev;
	struct ti_sci_genpd_provider *pd_provider;
	struct ti_sci_pm_domain *pd;
	struct device_node *np = NULL;
	struct of_phandle_args args;
	int ret;
	u32 max_id = 0;
	int index;

	pd_provider = devm_kzalloc(dev, sizeof(*pd_provider), GFP_KERNEL);
	if (!pd_provider)
		return -ENOMEM;

	pd_provider->ti_sci = devm_ti_sci_get_handle(dev);
	if (IS_ERR(pd_provider->ti_sci))
		return PTR_ERR(pd_provider->ti_sci);

	pd_provider->dev = dev;

	INIT_LIST_HEAD(&pd_provider->pd_list);

	/* Find highest device ID used for power domains */
	while (1) {
		np = of_find_node_with_property(np, "power-domains");
		if (!np)
			break;

		index = 0;

		while (1) {
			ret = of_parse_phandle_with_args(np, "power-domains",
							 "#power-domain-cells",
							 index, &args);
			if (ret)
				break;

			if (args.args_count >= 1 && args.np == dev->of_node) {
				if (args.args[0] > max_id)
					max_id = args.args[0];

				pd = devm_kzalloc(dev, sizeof(*pd), GFP_KERNEL);
				if (!pd)
					return -ENOMEM;

				pd->pd.name = devm_kasprintf(dev, GFP_KERNEL,
							     "pd:%d",
							     args.args[0]);
				if (!pd->pd.name)
					return -ENOMEM;

				pd->pd.power_off = ti_sci_pd_power_off;
				pd->pd.power_on = ti_sci_pd_power_on;
				pd->idx = args.args[0];
				pd->parent = pd_provider;

				pm_genpd_init(&pd->pd, NULL, true);

				list_add(&pd->node, &pd_provider->pd_list);
			}
			index++;
		}
	}

	pd_provider->data.domains =
		devm_kcalloc(dev, max_id + 1,
			     sizeof(*pd_provider->data.domains),
			     GFP_KERNEL);

	pd_provider->data.num_domains = max_id + 1;
	pd_provider->data.xlate = ti_sci_pd_xlate;

	list_for_each_entry(pd, &pd_provider->pd_list, node)
		pd_provider->data.domains[pd->idx] = &pd->pd;

	return of_genpd_add_provider_onecell(dev->of_node, &pd_provider->data);
}

static struct platform_driver ti_sci_pm_domains_driver = {
	.probe = ti_sci_pm_domain_probe,
	.driver = {
		.name = "ti_sci_pm_domains",
		.of_match_table = ti_sci_pm_domain_matches,
	},
};
module_platform_driver(ti_sci_pm_domains_driver);
MODULE_LICENSE("GPL v2");
MODULE_DESCRIPTION("TI System Control Interface (SCI) Power Domain driver");
MODULE_AUTHOR("Dave Gerlach");
Commit	Line	Data
1802d0be	1	// SPDX-License-Identifier: GPL-2.0-only
52835d59 DG	2	/*
	3	* TI SCI Generic Power Domain Driver
	4	*
7574f67e	5	* Copyright (C) 2015-2017 Texas Instruments Incorporated - http://www.ti.com/
52835d59 DG	6	* J Keerthy <j-keerthy@ti.com>
52835d59 DG	7	* Dave Gerlach <d-gerlach@ti.com>
52835d59 DG	8	*/
	9
	10	#include <linux/err.h>
	11	#include <linux/module.h>
52835d59 DG	12	#include <linux/of.h>
	13	#include <linux/platform_device.h>
	14	#include <linux/pm_domain.h>
	15	#include <linux/slab.h>
	16	#include <linux/soc/ti/ti_sci_protocol.h>
de8a618f	17	#include <dt-bindings/soc/ti,sci_pm_domain.h>
52835d59 DG	18
52835d59 DG	19	/**
efa5c01c TK	20	* struct ti_sci_genpd_provider: holds common TI SCI genpd provider data
	21	* @ti_sci: handle to TI SCI protocol driver that provides ops to
	22	* communicate with system control processor.
	23	* @dev: pointer to dev for the driver for devm allocs
	24	* @pd_list: list of all the power domains on the device
	25	* @data: onecell data for genpd core
52835d59	26	*/
efa5c01c TK	27	struct ti_sci_genpd_provider {
	28	const struct ti_sci_handle *ti_sci;
	29	struct device *dev;
	30	struct list_head pd_list;
	31	struct genpd_onecell_data data;
52835d59 DG	32	};
	33
	34	/**
	35	* struct ti_sci_pm_domain: TI specific data needed for power domain
efa5c01c TK	36	* @idx: index of the device that identifies it with the system
	37	* control processor.
	38	* @exclusive: Permissions for exclusive request or shared request of the
	39	* device.
52835d59	40	* @pd: generic_pm_domain for use with the genpd framework
efa5c01c TK	41	* @node: link for the genpd list
efa5c01c TK	42	* @parent: link to the parent TI SCI genpd provider
52835d59 DG	43	*/
52835d59 DG	44	struct ti_sci_pm_domain {
efa5c01c TK	45	int idx;
efa5c01c TK	46	u8 exclusive;
52835d59	47	struct generic_pm_domain pd;
efa5c01c TK	48	struct list_head node;
efa5c01c TK	49	struct ti_sci_genpd_provider *parent;
52835d59 DG	50	};
	51
	52	#define genpd_to_ti_sci_pd(gpd) container_of(gpd, struct ti_sci_pm_domain, pd)
	53
efa5c01c TK	54	/*
	55	* ti_sci_pd_power_off(): genpd power down hook
	56	* @domain: pointer to the powerdomain to power off
52835d59	57	*/
efa5c01c	58	static int ti_sci_pd_power_off(struct generic_pm_domain *domain)
52835d59	59	{
efa5c01c TK	60	struct ti_sci_pm_domain *pd = genpd_to_ti_sci_pd(domain);
efa5c01c TK	61	const struct ti_sci_handle *ti_sci = pd->parent->ti_sci;
52835d59	62
efa5c01c	63	return ti_sci->ops.dev_ops.put_device(ti_sci, pd->idx);
52835d59 DG	64	}
52835d59 DG	65
efa5c01c TK	66	/*
	67	* ti_sci_pd_power_on(): genpd power up hook
	68	* @domain: pointer to the powerdomain to power on
52835d59	69	*/
efa5c01c	70	static int ti_sci_pd_power_on(struct generic_pm_domain *domain)
52835d59	71	{
efa5c01c TK	72	struct ti_sci_pm_domain *pd = genpd_to_ti_sci_pd(domain);
efa5c01c TK	73	const struct ti_sci_handle *ti_sci = pd->parent->ti_sci;
52835d59	74
efa5c01c TK	75	if (pd->exclusive)
	76	return ti_sci->ops.dev_ops.get_device_exclusive(ti_sci,
	77	pd->idx);
de8a618f	78	else
efa5c01c	79	return ti_sci->ops.dev_ops.get_device(ti_sci, pd->idx);
52835d59 DG	80	}
52835d59 DG	81
efa5c01c TK	82	/*
	83	* ti_sci_pd_xlate(): translation service for TI SCI genpds
	84	* @genpdspec: DT identification data for the genpd
	85	* @data: genpd core data for all the powerdomains on the device
52835d59	86	*/
efa5c01c TK	87	static struct generic_pm_domain *ti_sci_pd_xlate(
	88	struct of_phandle_args *genpdspec,
	89	void *data)
52835d59	90	{
efa5c01c TK	91	struct genpd_onecell_data *genpd_data = data;
efa5c01c TK	92	unsigned int idx = genpdspec->args[0];
52835d59	93
3d696f42	94	if (genpdspec->args_count != 1 && genpdspec->args_count != 2)
efa5c01c	95	return ERR_PTR(-EINVAL);
52835d59	96
efa5c01c TK	97	if (idx >= genpd_data->num_domains) {
	98	pr_err("%s: invalid domain index %u\n", __func__, idx);
	99	return ERR_PTR(-EINVAL);
	100	}
52835d59	101
efa5c01c TK	102	if (!genpd_data->domains[idx])
efa5c01c TK	103	return ERR_PTR(-ENOENT);
52835d59	104
efa5c01c TK	105	genpd_to_ti_sci_pd(genpd_data->domains[idx])->exclusive =
efa5c01c TK	106	genpdspec->args[1];
52835d59	107
efa5c01c	108	return genpd_data->domains[idx];
52835d59 DG	109	}
	110
	111	static const struct of_device_id ti_sci_pm_domain_matches[] = {
	112	{ .compatible = "ti,sci-pm-domain", },
	113	{ },
	114	};
	115	MODULE_DEVICE_TABLE(of, ti_sci_pm_domain_matches);
	116
	117	static int ti_sci_pm_domain_probe(struct platform_device *pdev)
	118	{
	119	struct device *dev = &pdev->dev;
efa5c01c TK	120	struct ti_sci_genpd_provider *pd_provider;
	121	struct ti_sci_pm_domain *pd;
	122	struct device_node *np = NULL;
	123	struct of_phandle_args args;
52835d59	124	int ret;
efa5c01c TK	125	u32 max_id = 0;
efa5c01c TK	126	int index;
52835d59	127
efa5c01c TK	128	pd_provider = devm_kzalloc(dev, sizeof(*pd_provider), GFP_KERNEL);
efa5c01c TK	129	if (!pd_provider)
52835d59 DG	130	return -ENOMEM;
52835d59 DG	131
efa5c01c TK	132	pd_provider->ti_sci = devm_ti_sci_get_handle(dev);
	133	if (IS_ERR(pd_provider->ti_sci))
	134	return PTR_ERR(pd_provider->ti_sci);
	135
	136	pd_provider->dev = dev;
	137
	138	INIT_LIST_HEAD(&pd_provider->pd_list);
	139
	140	/* Find highest device ID used for power domains */
	141	while (1) {
	142	np = of_find_node_with_property(np, "power-domains");
	143	if (!np)
	144	break;
	145
	146	index = 0;
	147
	148	while (1) {
	149	ret = of_parse_phandle_with_args(np, "power-domains",
	150	"#power-domain-cells",
	151	index, &args);
	152	if (ret)
	153	break;
	154
	155	if (args.args_count >= 1 && args.np == dev->of_node) {
	156	if (args.args[0] > max_id)
	157	max_id = args.args[0];
	158
	159	pd = devm_kzalloc(dev, sizeof(*pd), GFP_KERNEL);
	160	if (!pd)
	161	return -ENOMEM;
	162
	163	pd->pd.name = devm_kasprintf(dev, GFP_KERNEL,
	164	"pd:%d",
	165	args.args[0]);
	166	if (!pd->pd.name)
	167	return -ENOMEM;
52835d59	168
efa5c01c TK	169	pd->pd.power_off = ti_sci_pd_power_off;
	170	pd->pd.power_on = ti_sci_pd_power_on;
	171	pd->idx = args.args[0];
	172	pd->parent = pd_provider;
52835d59	173
efa5c01c	174	pm_genpd_init(&pd->pd, NULL, true);
4dd6a997	175
efa5c01c TK	176	list_add(&pd->node, &pd_provider->pd_list);
	177	}
	178	index++;
	179	}
	180	}
52835d59	181
efa5c01c TK	182	pd_provider->data.domains =
	183	devm_kcalloc(dev, max_id + 1,
	184	sizeof(*pd_provider->data.domains),
	185	GFP_KERNEL);
52835d59	186
efa5c01c TK	187	pd_provider->data.num_domains = max_id + 1;
efa5c01c TK	188	pd_provider->data.xlate = ti_sci_pd_xlate;
52835d59	189
efa5c01c TK	190	list_for_each_entry(pd, &pd_provider->pd_list, node)
efa5c01c TK	191	pd_provider->data.domains[pd->idx] = &pd->pd;
52835d59	192
efa5c01c	193	return of_genpd_add_provider_onecell(dev->of_node, &pd_provider->data);
52835d59 DG	194	}
	195
	196	static struct platform_driver ti_sci_pm_domains_driver = {
	197	.probe = ti_sci_pm_domain_probe,
	198	.driver = {
	199	.name = "ti_sci_pm_domains",
	200	.of_match_table = ti_sci_pm_domain_matches,
	201	},
	202	};
	203	module_platform_driver(ti_sci_pm_domains_driver);
	204	MODULE_LICENSE("GPL v2");
	205	MODULE_DESCRIPTION("TI System Control Interface (SCI) Power Domain driver");
	206	MODULE_AUTHOR("Dave Gerlach");