1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * PM domains for CPUs via genpd - managed by cpuidle-psci.
4  *
5  * Copyright (C) 2019 Linaro Ltd.
6  * Author: Ulf Hansson <ulf.hansson@linaro.org>
7  *
8  */
9 
10 #define pr_fmt(fmt) "CPUidle PSCI: " fmt
11 
12 #include <linux/cpu.h>
13 #include <linux/device.h>
14 #include <linux/kernel.h>
15 #include <linux/platform_device.h>
16 #include <linux/pm_domain.h>
17 #include <linux/pm_runtime.h>
18 #include <linux/psci.h>
19 #include <linux/slab.h>
20 #include <linux/string.h>
21 
22 #include "cpuidle-psci.h"
23 
24 struct psci_pd_provider {
25 	struct list_head link;
26 	struct device_node *node;
27 };
28 
29 static LIST_HEAD(psci_pd_providers);
30 static bool psci_pd_allow_domain_state;
31 
32 static int psci_pd_power_off(struct generic_pm_domain *pd)
33 {
34 	struct genpd_power_state *state = &pd->states[pd->state_idx];
35 	u32 *pd_state;
36 
37 	if (!state->data)
38 		return 0;
39 
40 	if (!psci_pd_allow_domain_state)
41 		return -EBUSY;
42 
43 	/* OSI mode is enabled, set the corresponding domain state. */
44 	pd_state = state->data;
45 	psci_set_domain_state(*pd_state);
46 
47 	return 0;
48 }
49 
50 static int psci_pd_init(struct device_node *np, bool use_osi)
51 {
52 	struct generic_pm_domain *pd;
53 	struct psci_pd_provider *pd_provider;
54 	struct dev_power_governor *pd_gov;
55 	int ret = -ENOMEM;
56 
57 	pd = dt_idle_pd_alloc(np, psci_dt_parse_state_node);
58 	if (!pd)
59 		goto out;
60 
61 	pd_provider = kzalloc(sizeof(*pd_provider), GFP_KERNEL);
62 	if (!pd_provider)
63 		goto free_pd;
64 
65 	pd->flags |= GENPD_FLAG_IRQ_SAFE | GENPD_FLAG_CPU_DOMAIN;
66 
67 	/*
68 	 * Allow power off when OSI has been successfully enabled.
69 	 * PREEMPT_RT is not yet ready to enter domain idle states.
70 	 */
71 	if (use_osi && !IS_ENABLED(CONFIG_PREEMPT_RT))
72 		pd->power_off = psci_pd_power_off;
73 	else
74 		pd->flags |= GENPD_FLAG_ALWAYS_ON;
75 
76 	/* Use governor for CPU PM domains if it has some states to manage. */
77 	pd_gov = pd->states ? &pm_domain_cpu_gov : NULL;
78 
79 	ret = pm_genpd_init(pd, pd_gov, false);
80 	if (ret)
81 		goto free_pd_prov;
82 
83 	ret = of_genpd_add_provider_simple(np, pd);
84 	if (ret)
85 		goto remove_pd;
86 
87 	pd_provider->node = of_node_get(np);
88 	list_add(&pd_provider->link, &psci_pd_providers);
89 
90 	pr_debug("init PM domain %s\n", pd->name);
91 	return 0;
92 
93 remove_pd:
94 	pm_genpd_remove(pd);
95 free_pd_prov:
96 	kfree(pd_provider);
97 free_pd:
98 	dt_idle_pd_free(pd);
99 out:
100 	pr_err("failed to init PM domain ret=%d %pOF\n", ret, np);
101 	return ret;
102 }
103 
104 static void psci_pd_remove(void)
105 {
106 	struct psci_pd_provider *pd_provider, *it;
107 	struct generic_pm_domain *genpd;
108 
109 	list_for_each_entry_safe_reverse(pd_provider, it,
110 					 &psci_pd_providers, link) {
111 		of_genpd_del_provider(pd_provider->node);
112 
113 		genpd = of_genpd_remove_last(pd_provider->node);
114 		if (!IS_ERR(genpd))
115 			kfree(genpd);
116 
117 		of_node_put(pd_provider->node);
118 		list_del(&pd_provider->link);
119 		kfree(pd_provider);
120 	}
121 }
122 
123 static bool psci_pd_try_set_osi_mode(void)
124 {
125 	int ret;
126 
127 	if (!psci_has_osi_support())
128 		return false;
129 
130 	ret = psci_set_osi_mode(true);
131 	if (ret)
132 		return false;
133 
134 	return true;
135 }
136 
137 static void psci_cpuidle_domain_sync_state(struct device *dev)
138 {
139 	/*
140 	 * All devices have now been attached/probed to the PM domain topology,
141 	 * hence it's fine to allow domain states to be picked.
142 	 */
143 	psci_pd_allow_domain_state = true;
144 }
145 
146 static const struct of_device_id psci_of_match[] = {
147 	{ .compatible = "arm,psci-1.0" },
148 	{}
149 };
150 
151 static int psci_cpuidle_domain_probe(struct platform_device *pdev)
152 {
153 	struct device_node *np = pdev->dev.of_node;
154 	struct device_node *node;
155 	bool use_osi;
156 	int ret = 0, pd_count = 0;
157 
158 	if (!np)
159 		return -ENODEV;
160 
161 	/* If OSI mode is supported, let's try to enable it. */
162 	use_osi = psci_pd_try_set_osi_mode();
163 
164 	/*
165 	 * Parse child nodes for the "#power-domain-cells" property and
166 	 * initialize a genpd/genpd-of-provider pair when it's found.
167 	 */
168 	for_each_child_of_node(np, node) {
169 		if (!of_property_present(node, "#power-domain-cells"))
170 			continue;
171 
172 		ret = psci_pd_init(node, use_osi);
173 		if (ret)
174 			goto put_node;
175 
176 		pd_count++;
177 	}
178 
179 	/* Bail out if not using the hierarchical CPU topology. */
180 	if (!pd_count)
181 		goto no_pd;
182 
183 	/* Link genpd masters/subdomains to model the CPU topology. */
184 	ret = dt_idle_pd_init_topology(np);
185 	if (ret)
186 		goto remove_pd;
187 
188 	pr_info("Initialized CPU PM domain topology using %s mode\n",
189 		use_osi ? "OSI" : "PC");
190 	return 0;
191 
192 put_node:
193 	of_node_put(node);
194 remove_pd:
195 	psci_pd_remove();
196 	pr_err("failed to create CPU PM domains ret=%d\n", ret);
197 no_pd:
198 	if (use_osi)
199 		psci_set_osi_mode(false);
200 	return ret;
201 }
202 
203 static struct platform_driver psci_cpuidle_domain_driver = {
204 	.probe  = psci_cpuidle_domain_probe,
205 	.driver = {
206 		.name = "psci-cpuidle-domain",
207 		.of_match_table = psci_of_match,
208 		.sync_state = psci_cpuidle_domain_sync_state,
209 	},
210 };
211 
212 static int __init psci_idle_init_domains(void)
213 {
214 	return platform_driver_register(&psci_cpuidle_domain_driver);
215 }
216 subsys_initcall(psci_idle_init_domains);
217