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