1*e2ad626fSUlf Hansson // SPDX-License-Identifier: GPL-2.0
2*e2ad626fSUlf Hansson /*
3*e2ad626fSUlf Hansson * ZynqMP Generic PM domain support
4*e2ad626fSUlf Hansson *
5*e2ad626fSUlf Hansson * Copyright (C) 2015-2019 Xilinx, Inc.
6*e2ad626fSUlf Hansson *
7*e2ad626fSUlf Hansson * Davorin Mista <davorin.mista@aggios.com>
8*e2ad626fSUlf Hansson * Jolly Shah <jollys@xilinx.com>
9*e2ad626fSUlf Hansson * Rajan Vaja <rajan.vaja@xilinx.com>
10*e2ad626fSUlf Hansson */
11*e2ad626fSUlf Hansson
12*e2ad626fSUlf Hansson #include <linux/err.h>
13*e2ad626fSUlf Hansson #include <linux/list.h>
14*e2ad626fSUlf Hansson #include <linux/module.h>
15*e2ad626fSUlf Hansson #include <linux/of_platform.h>
16*e2ad626fSUlf Hansson #include <linux/platform_device.h>
17*e2ad626fSUlf Hansson #include <linux/pm_domain.h>
18*e2ad626fSUlf Hansson #include <linux/slab.h>
19*e2ad626fSUlf Hansson
20*e2ad626fSUlf Hansson #include <linux/firmware/xlnx-zynqmp.h>
21*e2ad626fSUlf Hansson
22*e2ad626fSUlf Hansson #define ZYNQMP_NUM_DOMAINS (100)
23*e2ad626fSUlf Hansson
24*e2ad626fSUlf Hansson static int min_capability;
25*e2ad626fSUlf Hansson
26*e2ad626fSUlf Hansson /**
27*e2ad626fSUlf Hansson * struct zynqmp_pm_domain - Wrapper around struct generic_pm_domain
28*e2ad626fSUlf Hansson * @gpd: Generic power domain
29*e2ad626fSUlf Hansson * @node_id: PM node ID corresponding to device inside PM domain
30*e2ad626fSUlf Hansson * @requested: The PM node mapped to the PM domain has been requested
31*e2ad626fSUlf Hansson */
32*e2ad626fSUlf Hansson struct zynqmp_pm_domain {
33*e2ad626fSUlf Hansson struct generic_pm_domain gpd;
34*e2ad626fSUlf Hansson u32 node_id;
35*e2ad626fSUlf Hansson bool requested;
36*e2ad626fSUlf Hansson };
37*e2ad626fSUlf Hansson
38*e2ad626fSUlf Hansson #define to_zynqmp_pm_domain(pm_domain) \
39*e2ad626fSUlf Hansson container_of(pm_domain, struct zynqmp_pm_domain, gpd)
40*e2ad626fSUlf Hansson
41*e2ad626fSUlf Hansson /**
42*e2ad626fSUlf Hansson * zynqmp_gpd_is_active_wakeup_path() - Check if device is in wakeup source
43*e2ad626fSUlf Hansson * path
44*e2ad626fSUlf Hansson * @dev: Device to check for wakeup source path
45*e2ad626fSUlf Hansson * @not_used: Data member (not required)
46*e2ad626fSUlf Hansson *
47*e2ad626fSUlf Hansson * This function is checks device's child hierarchy and checks if any device is
48*e2ad626fSUlf Hansson * set as wakeup source.
49*e2ad626fSUlf Hansson *
50*e2ad626fSUlf Hansson * Return: 1 if device is in wakeup source path else 0
51*e2ad626fSUlf Hansson */
zynqmp_gpd_is_active_wakeup_path(struct device * dev,void * not_used)52*e2ad626fSUlf Hansson static int zynqmp_gpd_is_active_wakeup_path(struct device *dev, void *not_used)
53*e2ad626fSUlf Hansson {
54*e2ad626fSUlf Hansson int may_wakeup;
55*e2ad626fSUlf Hansson
56*e2ad626fSUlf Hansson may_wakeup = device_may_wakeup(dev);
57*e2ad626fSUlf Hansson if (may_wakeup)
58*e2ad626fSUlf Hansson return may_wakeup;
59*e2ad626fSUlf Hansson
60*e2ad626fSUlf Hansson return device_for_each_child(dev, NULL,
61*e2ad626fSUlf Hansson zynqmp_gpd_is_active_wakeup_path);
62*e2ad626fSUlf Hansson }
63*e2ad626fSUlf Hansson
64*e2ad626fSUlf Hansson /**
65*e2ad626fSUlf Hansson * zynqmp_gpd_power_on() - Power on PM domain
66*e2ad626fSUlf Hansson * @domain: Generic PM domain
67*e2ad626fSUlf Hansson *
68*e2ad626fSUlf Hansson * This function is called before devices inside a PM domain are resumed, to
69*e2ad626fSUlf Hansson * power on PM domain.
70*e2ad626fSUlf Hansson *
71*e2ad626fSUlf Hansson * Return: 0 on success, error code otherwise
72*e2ad626fSUlf Hansson */
zynqmp_gpd_power_on(struct generic_pm_domain * domain)73*e2ad626fSUlf Hansson static int zynqmp_gpd_power_on(struct generic_pm_domain *domain)
74*e2ad626fSUlf Hansson {
75*e2ad626fSUlf Hansson struct zynqmp_pm_domain *pd = to_zynqmp_pm_domain(domain);
76*e2ad626fSUlf Hansson int ret;
77*e2ad626fSUlf Hansson
78*e2ad626fSUlf Hansson ret = zynqmp_pm_set_requirement(pd->node_id,
79*e2ad626fSUlf Hansson ZYNQMP_PM_CAPABILITY_ACCESS,
80*e2ad626fSUlf Hansson ZYNQMP_PM_MAX_QOS,
81*e2ad626fSUlf Hansson ZYNQMP_PM_REQUEST_ACK_BLOCKING);
82*e2ad626fSUlf Hansson if (ret) {
83*e2ad626fSUlf Hansson dev_err(&domain->dev,
84*e2ad626fSUlf Hansson "failed to set requirement to 0x%x for PM node id %d: %d\n",
85*e2ad626fSUlf Hansson ZYNQMP_PM_CAPABILITY_ACCESS, pd->node_id, ret);
86*e2ad626fSUlf Hansson return ret;
87*e2ad626fSUlf Hansson }
88*e2ad626fSUlf Hansson
89*e2ad626fSUlf Hansson dev_dbg(&domain->dev, "set requirement to 0x%x for PM node id %d\n",
90*e2ad626fSUlf Hansson ZYNQMP_PM_CAPABILITY_ACCESS, pd->node_id);
91*e2ad626fSUlf Hansson
92*e2ad626fSUlf Hansson return 0;
93*e2ad626fSUlf Hansson }
94*e2ad626fSUlf Hansson
95*e2ad626fSUlf Hansson /**
96*e2ad626fSUlf Hansson * zynqmp_gpd_power_off() - Power off PM domain
97*e2ad626fSUlf Hansson * @domain: Generic PM domain
98*e2ad626fSUlf Hansson *
99*e2ad626fSUlf Hansson * This function is called after devices inside a PM domain are suspended, to
100*e2ad626fSUlf Hansson * power off PM domain.
101*e2ad626fSUlf Hansson *
102*e2ad626fSUlf Hansson * Return: 0 on success, error code otherwise
103*e2ad626fSUlf Hansson */
zynqmp_gpd_power_off(struct generic_pm_domain * domain)104*e2ad626fSUlf Hansson static int zynqmp_gpd_power_off(struct generic_pm_domain *domain)
105*e2ad626fSUlf Hansson {
106*e2ad626fSUlf Hansson struct zynqmp_pm_domain *pd = to_zynqmp_pm_domain(domain);
107*e2ad626fSUlf Hansson int ret;
108*e2ad626fSUlf Hansson struct pm_domain_data *pdd, *tmp;
109*e2ad626fSUlf Hansson u32 capabilities = min_capability;
110*e2ad626fSUlf Hansson bool may_wakeup;
111*e2ad626fSUlf Hansson
112*e2ad626fSUlf Hansson /* If domain is already released there is nothing to be done */
113*e2ad626fSUlf Hansson if (!pd->requested) {
114*e2ad626fSUlf Hansson dev_dbg(&domain->dev, "PM node id %d is already released\n",
115*e2ad626fSUlf Hansson pd->node_id);
116*e2ad626fSUlf Hansson return 0;
117*e2ad626fSUlf Hansson }
118*e2ad626fSUlf Hansson
119*e2ad626fSUlf Hansson list_for_each_entry_safe(pdd, tmp, &domain->dev_list, list_node) {
120*e2ad626fSUlf Hansson /* If device is in wakeup path, set capability to WAKEUP */
121*e2ad626fSUlf Hansson may_wakeup = zynqmp_gpd_is_active_wakeup_path(pdd->dev, NULL);
122*e2ad626fSUlf Hansson if (may_wakeup) {
123*e2ad626fSUlf Hansson dev_dbg(pdd->dev, "device is in wakeup path in %s\n",
124*e2ad626fSUlf Hansson domain->name);
125*e2ad626fSUlf Hansson capabilities = ZYNQMP_PM_CAPABILITY_WAKEUP;
126*e2ad626fSUlf Hansson break;
127*e2ad626fSUlf Hansson }
128*e2ad626fSUlf Hansson }
129*e2ad626fSUlf Hansson
130*e2ad626fSUlf Hansson ret = zynqmp_pm_set_requirement(pd->node_id, capabilities, 0,
131*e2ad626fSUlf Hansson ZYNQMP_PM_REQUEST_ACK_NO);
132*e2ad626fSUlf Hansson if (ret) {
133*e2ad626fSUlf Hansson dev_err(&domain->dev,
134*e2ad626fSUlf Hansson "failed to set requirement to 0x%x for PM node id %d: %d\n",
135*e2ad626fSUlf Hansson capabilities, pd->node_id, ret);
136*e2ad626fSUlf Hansson return ret;
137*e2ad626fSUlf Hansson }
138*e2ad626fSUlf Hansson
139*e2ad626fSUlf Hansson dev_dbg(&domain->dev, "set requirement to 0x%x for PM node id %d\n",
140*e2ad626fSUlf Hansson capabilities, pd->node_id);
141*e2ad626fSUlf Hansson
142*e2ad626fSUlf Hansson return 0;
143*e2ad626fSUlf Hansson }
144*e2ad626fSUlf Hansson
145*e2ad626fSUlf Hansson /**
146*e2ad626fSUlf Hansson * zynqmp_gpd_attach_dev() - Attach device to the PM domain
147*e2ad626fSUlf Hansson * @domain: Generic PM domain
148*e2ad626fSUlf Hansson * @dev: Device to attach
149*e2ad626fSUlf Hansson *
150*e2ad626fSUlf Hansson * Return: 0 on success, error code otherwise
151*e2ad626fSUlf Hansson */
zynqmp_gpd_attach_dev(struct generic_pm_domain * domain,struct device * dev)152*e2ad626fSUlf Hansson static int zynqmp_gpd_attach_dev(struct generic_pm_domain *domain,
153*e2ad626fSUlf Hansson struct device *dev)
154*e2ad626fSUlf Hansson {
155*e2ad626fSUlf Hansson struct zynqmp_pm_domain *pd = to_zynqmp_pm_domain(domain);
156*e2ad626fSUlf Hansson struct device_link *link;
157*e2ad626fSUlf Hansson int ret;
158*e2ad626fSUlf Hansson
159*e2ad626fSUlf Hansson link = device_link_add(dev, &domain->dev, DL_FLAG_SYNC_STATE_ONLY);
160*e2ad626fSUlf Hansson if (!link)
161*e2ad626fSUlf Hansson dev_dbg(&domain->dev, "failed to create device link for %s\n",
162*e2ad626fSUlf Hansson dev_name(dev));
163*e2ad626fSUlf Hansson
164*e2ad626fSUlf Hansson /* If this is not the first device to attach there is nothing to do */
165*e2ad626fSUlf Hansson if (domain->device_count)
166*e2ad626fSUlf Hansson return 0;
167*e2ad626fSUlf Hansson
168*e2ad626fSUlf Hansson ret = zynqmp_pm_request_node(pd->node_id, 0, 0,
169*e2ad626fSUlf Hansson ZYNQMP_PM_REQUEST_ACK_BLOCKING);
170*e2ad626fSUlf Hansson if (ret) {
171*e2ad626fSUlf Hansson dev_err(&domain->dev, "%s request failed for node %d: %d\n",
172*e2ad626fSUlf Hansson domain->name, pd->node_id, ret);
173*e2ad626fSUlf Hansson return ret;
174*e2ad626fSUlf Hansson }
175*e2ad626fSUlf Hansson
176*e2ad626fSUlf Hansson pd->requested = true;
177*e2ad626fSUlf Hansson
178*e2ad626fSUlf Hansson dev_dbg(&domain->dev, "%s requested PM node id %d\n",
179*e2ad626fSUlf Hansson dev_name(dev), pd->node_id);
180*e2ad626fSUlf Hansson
181*e2ad626fSUlf Hansson return 0;
182*e2ad626fSUlf Hansson }
183*e2ad626fSUlf Hansson
184*e2ad626fSUlf Hansson /**
185*e2ad626fSUlf Hansson * zynqmp_gpd_detach_dev() - Detach device from the PM domain
186*e2ad626fSUlf Hansson * @domain: Generic PM domain
187*e2ad626fSUlf Hansson * @dev: Device to detach
188*e2ad626fSUlf Hansson */
zynqmp_gpd_detach_dev(struct generic_pm_domain * domain,struct device * dev)189*e2ad626fSUlf Hansson static void zynqmp_gpd_detach_dev(struct generic_pm_domain *domain,
190*e2ad626fSUlf Hansson struct device *dev)
191*e2ad626fSUlf Hansson {
192*e2ad626fSUlf Hansson struct zynqmp_pm_domain *pd = to_zynqmp_pm_domain(domain);
193*e2ad626fSUlf Hansson int ret;
194*e2ad626fSUlf Hansson
195*e2ad626fSUlf Hansson /* If this is not the last device to detach there is nothing to do */
196*e2ad626fSUlf Hansson if (domain->device_count)
197*e2ad626fSUlf Hansson return;
198*e2ad626fSUlf Hansson
199*e2ad626fSUlf Hansson ret = zynqmp_pm_release_node(pd->node_id);
200*e2ad626fSUlf Hansson if (ret) {
201*e2ad626fSUlf Hansson dev_err(&domain->dev, "failed to release PM node id %d: %d\n",
202*e2ad626fSUlf Hansson pd->node_id, ret);
203*e2ad626fSUlf Hansson return;
204*e2ad626fSUlf Hansson }
205*e2ad626fSUlf Hansson
206*e2ad626fSUlf Hansson pd->requested = false;
207*e2ad626fSUlf Hansson
208*e2ad626fSUlf Hansson dev_dbg(&domain->dev, "%s released PM node id %d\n",
209*e2ad626fSUlf Hansson dev_name(dev), pd->node_id);
210*e2ad626fSUlf Hansson }
211*e2ad626fSUlf Hansson
zynqmp_gpd_xlate(struct of_phandle_args * genpdspec,void * data)212*e2ad626fSUlf Hansson static struct generic_pm_domain *zynqmp_gpd_xlate
213*e2ad626fSUlf Hansson (struct of_phandle_args *genpdspec, void *data)
214*e2ad626fSUlf Hansson {
215*e2ad626fSUlf Hansson struct genpd_onecell_data *genpd_data = data;
216*e2ad626fSUlf Hansson unsigned int i, idx = genpdspec->args[0];
217*e2ad626fSUlf Hansson struct zynqmp_pm_domain *pd;
218*e2ad626fSUlf Hansson
219*e2ad626fSUlf Hansson pd = to_zynqmp_pm_domain(genpd_data->domains[0]);
220*e2ad626fSUlf Hansson
221*e2ad626fSUlf Hansson if (genpdspec->args_count != 1)
222*e2ad626fSUlf Hansson return ERR_PTR(-EINVAL);
223*e2ad626fSUlf Hansson
224*e2ad626fSUlf Hansson /* Check for existing pm domains */
225*e2ad626fSUlf Hansson for (i = 0; i < ZYNQMP_NUM_DOMAINS; i++) {
226*e2ad626fSUlf Hansson if (pd[i].node_id == idx)
227*e2ad626fSUlf Hansson goto done;
228*e2ad626fSUlf Hansson }
229*e2ad626fSUlf Hansson
230*e2ad626fSUlf Hansson /*
231*e2ad626fSUlf Hansson * Add index in empty node_id of power domain list as no existing
232*e2ad626fSUlf Hansson * power domain found for current index.
233*e2ad626fSUlf Hansson */
234*e2ad626fSUlf Hansson for (i = 0; i < ZYNQMP_NUM_DOMAINS; i++) {
235*e2ad626fSUlf Hansson if (pd[i].node_id == 0) {
236*e2ad626fSUlf Hansson pd[i].node_id = idx;
237*e2ad626fSUlf Hansson break;
238*e2ad626fSUlf Hansson }
239*e2ad626fSUlf Hansson }
240*e2ad626fSUlf Hansson
241*e2ad626fSUlf Hansson done:
242*e2ad626fSUlf Hansson if (!genpd_data->domains[i] || i == ZYNQMP_NUM_DOMAINS)
243*e2ad626fSUlf Hansson return ERR_PTR(-ENOENT);
244*e2ad626fSUlf Hansson
245*e2ad626fSUlf Hansson return genpd_data->domains[i];
246*e2ad626fSUlf Hansson }
247*e2ad626fSUlf Hansson
zynqmp_gpd_probe(struct platform_device * pdev)248*e2ad626fSUlf Hansson static int zynqmp_gpd_probe(struct platform_device *pdev)
249*e2ad626fSUlf Hansson {
250*e2ad626fSUlf Hansson int i;
251*e2ad626fSUlf Hansson struct genpd_onecell_data *zynqmp_pd_data;
252*e2ad626fSUlf Hansson struct generic_pm_domain **domains;
253*e2ad626fSUlf Hansson struct zynqmp_pm_domain *pd;
254*e2ad626fSUlf Hansson struct device *dev = &pdev->dev;
255*e2ad626fSUlf Hansson
256*e2ad626fSUlf Hansson pd = devm_kcalloc(dev, ZYNQMP_NUM_DOMAINS, sizeof(*pd), GFP_KERNEL);
257*e2ad626fSUlf Hansson if (!pd)
258*e2ad626fSUlf Hansson return -ENOMEM;
259*e2ad626fSUlf Hansson
260*e2ad626fSUlf Hansson zynqmp_pd_data = devm_kzalloc(dev, sizeof(*zynqmp_pd_data), GFP_KERNEL);
261*e2ad626fSUlf Hansson if (!zynqmp_pd_data)
262*e2ad626fSUlf Hansson return -ENOMEM;
263*e2ad626fSUlf Hansson
264*e2ad626fSUlf Hansson zynqmp_pd_data->xlate = zynqmp_gpd_xlate;
265*e2ad626fSUlf Hansson
266*e2ad626fSUlf Hansson domains = devm_kcalloc(dev, ZYNQMP_NUM_DOMAINS, sizeof(*domains),
267*e2ad626fSUlf Hansson GFP_KERNEL);
268*e2ad626fSUlf Hansson if (!domains)
269*e2ad626fSUlf Hansson return -ENOMEM;
270*e2ad626fSUlf Hansson
271*e2ad626fSUlf Hansson if (!of_device_is_compatible(dev->parent->of_node,
272*e2ad626fSUlf Hansson "xlnx,zynqmp-firmware"))
273*e2ad626fSUlf Hansson min_capability = ZYNQMP_PM_CAPABILITY_UNUSABLE;
274*e2ad626fSUlf Hansson
275*e2ad626fSUlf Hansson for (i = 0; i < ZYNQMP_NUM_DOMAINS; i++, pd++) {
276*e2ad626fSUlf Hansson pd->node_id = 0;
277*e2ad626fSUlf Hansson pd->gpd.name = kasprintf(GFP_KERNEL, "domain%d", i);
278*e2ad626fSUlf Hansson pd->gpd.power_off = zynqmp_gpd_power_off;
279*e2ad626fSUlf Hansson pd->gpd.power_on = zynqmp_gpd_power_on;
280*e2ad626fSUlf Hansson pd->gpd.attach_dev = zynqmp_gpd_attach_dev;
281*e2ad626fSUlf Hansson pd->gpd.detach_dev = zynqmp_gpd_detach_dev;
282*e2ad626fSUlf Hansson
283*e2ad626fSUlf Hansson domains[i] = &pd->gpd;
284*e2ad626fSUlf Hansson
285*e2ad626fSUlf Hansson /* Mark all PM domains as initially powered off */
286*e2ad626fSUlf Hansson pm_genpd_init(&pd->gpd, NULL, true);
287*e2ad626fSUlf Hansson }
288*e2ad626fSUlf Hansson
289*e2ad626fSUlf Hansson zynqmp_pd_data->domains = domains;
290*e2ad626fSUlf Hansson zynqmp_pd_data->num_domains = ZYNQMP_NUM_DOMAINS;
291*e2ad626fSUlf Hansson of_genpd_add_provider_onecell(dev->parent->of_node, zynqmp_pd_data);
292*e2ad626fSUlf Hansson
293*e2ad626fSUlf Hansson return 0;
294*e2ad626fSUlf Hansson }
295*e2ad626fSUlf Hansson
zynqmp_gpd_remove(struct platform_device * pdev)296*e2ad626fSUlf Hansson static int zynqmp_gpd_remove(struct platform_device *pdev)
297*e2ad626fSUlf Hansson {
298*e2ad626fSUlf Hansson of_genpd_del_provider(pdev->dev.parent->of_node);
299*e2ad626fSUlf Hansson
300*e2ad626fSUlf Hansson return 0;
301*e2ad626fSUlf Hansson }
302*e2ad626fSUlf Hansson
zynqmp_gpd_sync_state(struct device * dev)303*e2ad626fSUlf Hansson static void zynqmp_gpd_sync_state(struct device *dev)
304*e2ad626fSUlf Hansson {
305*e2ad626fSUlf Hansson int ret;
306*e2ad626fSUlf Hansson
307*e2ad626fSUlf Hansson ret = zynqmp_pm_init_finalize();
308*e2ad626fSUlf Hansson if (ret)
309*e2ad626fSUlf Hansson dev_warn(dev, "failed to release power management to firmware\n");
310*e2ad626fSUlf Hansson }
311*e2ad626fSUlf Hansson
312*e2ad626fSUlf Hansson static struct platform_driver zynqmp_power_domain_driver = {
313*e2ad626fSUlf Hansson .driver = {
314*e2ad626fSUlf Hansson .name = "zynqmp_power_controller",
315*e2ad626fSUlf Hansson .sync_state = zynqmp_gpd_sync_state,
316*e2ad626fSUlf Hansson },
317*e2ad626fSUlf Hansson .probe = zynqmp_gpd_probe,
318*e2ad626fSUlf Hansson .remove = zynqmp_gpd_remove,
319*e2ad626fSUlf Hansson };
320*e2ad626fSUlf Hansson module_platform_driver(zynqmp_power_domain_driver);
321*e2ad626fSUlf Hansson
322*e2ad626fSUlf Hansson MODULE_ALIAS("platform:zynqmp_power_controller");
323