x86/topology: Fix function name in documentation
[cris-mirror.git] / drivers / soc / imx / gpc.c
blob53f7275d6cbdb513001582555f898adb35e1cc5b
1 /*
2 * Copyright 2015-2017 Pengutronix, Lucas Stach <kernel@pengutronix.de>
3 * Copyright 2011-2013 Freescale Semiconductor, Inc.
5 * The code contained herein is licensed under the GNU General Public
6 * License. You may obtain a copy of the GNU General Public License
7 * Version 2 or later at the following locations:
9 * http://www.opensource.org/licenses/gpl-license.html
10 * http://www.gnu.org/copyleft/gpl.html
13 #include <linux/clk.h>
14 #include <linux/delay.h>
15 #include <linux/io.h>
16 #include <linux/of_device.h>
17 #include <linux/platform_device.h>
18 #include <linux/pm_domain.h>
19 #include <linux/regmap.h>
20 #include <linux/regulator/consumer.h>
22 #define GPC_CNTR 0x000
24 #define GPC_PGC_CTRL_OFFS 0x0
25 #define GPC_PGC_PUPSCR_OFFS 0x4
26 #define GPC_PGC_PDNSCR_OFFS 0x8
27 #define GPC_PGC_SW2ISO_SHIFT 0x8
28 #define GPC_PGC_SW_SHIFT 0x0
30 #define GPC_PGC_GPU_PDN 0x260
31 #define GPC_PGC_GPU_PUPSCR 0x264
32 #define GPC_PGC_GPU_PDNSCR 0x268
34 #define GPU_VPU_PUP_REQ BIT(1)
35 #define GPU_VPU_PDN_REQ BIT(0)
37 #define GPC_CLK_MAX 6
39 #define PGC_DOMAIN_FLAG_NO_PD BIT(0)
41 struct imx_pm_domain {
42 struct generic_pm_domain base;
43 struct regmap *regmap;
44 struct regulator *supply;
45 struct clk *clk[GPC_CLK_MAX];
46 int num_clks;
47 unsigned int reg_offs;
48 signed char cntr_pdn_bit;
49 unsigned int ipg_rate_mhz;
50 unsigned int flags;
53 static inline struct imx_pm_domain *
54 to_imx_pm_domain(struct generic_pm_domain *genpd)
56 return container_of(genpd, struct imx_pm_domain, base);
59 static int imx6_pm_domain_power_off(struct generic_pm_domain *genpd)
61 struct imx_pm_domain *pd = to_imx_pm_domain(genpd);
62 int iso, iso2sw;
63 u32 val;
65 if (pd->flags & PGC_DOMAIN_FLAG_NO_PD)
66 return -EBUSY;
68 /* Read ISO and ISO2SW power down delays */
69 regmap_read(pd->regmap, pd->reg_offs + GPC_PGC_PUPSCR_OFFS, &val);
70 iso = val & 0x3f;
71 iso2sw = (val >> 8) & 0x3f;
73 /* Gate off domain when powered down */
74 regmap_update_bits(pd->regmap, pd->reg_offs + GPC_PGC_CTRL_OFFS,
75 0x1, 0x1);
77 /* Request GPC to power down domain */
78 val = BIT(pd->cntr_pdn_bit);
79 regmap_update_bits(pd->regmap, GPC_CNTR, val, val);
81 /* Wait ISO + ISO2SW IPG clock cycles */
82 udelay(DIV_ROUND_UP(iso + iso2sw, pd->ipg_rate_mhz));
84 if (pd->supply)
85 regulator_disable(pd->supply);
87 return 0;
90 static int imx6_pm_domain_power_on(struct generic_pm_domain *genpd)
92 struct imx_pm_domain *pd = to_imx_pm_domain(genpd);
93 int i, ret, sw, sw2iso;
94 u32 val;
96 if (pd->supply) {
97 ret = regulator_enable(pd->supply);
98 if (ret) {
99 pr_err("%s: failed to enable regulator: %d\n",
100 __func__, ret);
101 return ret;
105 /* Enable reset clocks for all devices in the domain */
106 for (i = 0; i < pd->num_clks; i++)
107 clk_prepare_enable(pd->clk[i]);
109 /* Gate off domain when powered down */
110 regmap_update_bits(pd->regmap, pd->reg_offs + GPC_PGC_CTRL_OFFS,
111 0x1, 0x1);
113 /* Read ISO and ISO2SW power up delays */
114 regmap_read(pd->regmap, pd->reg_offs + GPC_PGC_PUPSCR_OFFS, &val);
115 sw = val & 0x3f;
116 sw2iso = (val >> 8) & 0x3f;
118 /* Request GPC to power up domain */
119 val = BIT(pd->cntr_pdn_bit + 1);
120 regmap_update_bits(pd->regmap, GPC_CNTR, val, val);
122 /* Wait ISO + ISO2SW IPG clock cycles */
123 udelay(DIV_ROUND_UP(sw + sw2iso, pd->ipg_rate_mhz));
125 /* Disable reset clocks for all devices in the domain */
126 for (i = 0; i < pd->num_clks; i++)
127 clk_disable_unprepare(pd->clk[i]);
129 return 0;
132 static int imx_pgc_get_clocks(struct device *dev, struct imx_pm_domain *domain)
134 int i, ret;
136 for (i = 0; ; i++) {
137 struct clk *clk = of_clk_get(dev->of_node, i);
138 if (IS_ERR(clk))
139 break;
140 if (i >= GPC_CLK_MAX) {
141 dev_err(dev, "more than %d clocks\n", GPC_CLK_MAX);
142 ret = -EINVAL;
143 goto clk_err;
145 domain->clk[i] = clk;
147 domain->num_clks = i;
149 return 0;
151 clk_err:
152 while (i--)
153 clk_put(domain->clk[i]);
155 return ret;
158 static void imx_pgc_put_clocks(struct imx_pm_domain *domain)
160 int i;
162 for (i = domain->num_clks - 1; i >= 0; i--)
163 clk_put(domain->clk[i]);
166 static int imx_pgc_parse_dt(struct device *dev, struct imx_pm_domain *domain)
168 /* try to get the domain supply regulator */
169 domain->supply = devm_regulator_get_optional(dev, "power");
170 if (IS_ERR(domain->supply)) {
171 if (PTR_ERR(domain->supply) == -ENODEV)
172 domain->supply = NULL;
173 else
174 return PTR_ERR(domain->supply);
177 /* try to get all clocks needed for reset propagation */
178 return imx_pgc_get_clocks(dev, domain);
181 static int imx_pgc_power_domain_probe(struct platform_device *pdev)
183 struct imx_pm_domain *domain = pdev->dev.platform_data;
184 struct device *dev = &pdev->dev;
185 int ret;
187 /* if this PD is associated with a DT node try to parse it */
188 if (dev->of_node) {
189 ret = imx_pgc_parse_dt(dev, domain);
190 if (ret)
191 return ret;
194 /* initially power on the domain */
195 if (domain->base.power_on)
196 domain->base.power_on(&domain->base);
198 if (IS_ENABLED(CONFIG_PM_GENERIC_DOMAINS)) {
199 pm_genpd_init(&domain->base, NULL, false);
200 ret = of_genpd_add_provider_simple(dev->of_node, &domain->base);
201 if (ret)
202 goto genpd_err;
205 device_link_add(dev, dev->parent, DL_FLAG_AUTOREMOVE);
207 return 0;
209 genpd_err:
210 pm_genpd_remove(&domain->base);
211 imx_pgc_put_clocks(domain);
213 return ret;
216 static int imx_pgc_power_domain_remove(struct platform_device *pdev)
218 struct imx_pm_domain *domain = pdev->dev.platform_data;
220 if (IS_ENABLED(CONFIG_PM_GENERIC_DOMAINS)) {
221 of_genpd_del_provider(pdev->dev.of_node);
222 pm_genpd_remove(&domain->base);
223 imx_pgc_put_clocks(domain);
226 return 0;
229 static const struct platform_device_id imx_pgc_power_domain_id[] = {
230 { "imx-pgc-power-domain"},
231 { },
234 static struct platform_driver imx_pgc_power_domain_driver = {
235 .driver = {
236 .name = "imx-pgc-pd",
238 .probe = imx_pgc_power_domain_probe,
239 .remove = imx_pgc_power_domain_remove,
240 .id_table = imx_pgc_power_domain_id,
242 builtin_platform_driver(imx_pgc_power_domain_driver)
244 #define GPC_PGC_DOMAIN_ARM 0
245 #define GPC_PGC_DOMAIN_PU 1
246 #define GPC_PGC_DOMAIN_DISPLAY 2
248 static struct genpd_power_state imx6_pm_domain_pu_state = {
249 .power_off_latency_ns = 25000,
250 .power_on_latency_ns = 2000000,
253 static struct imx_pm_domain imx_gpc_domains[] = {
255 .base = {
256 .name = "ARM",
258 }, {
259 .base = {
260 .name = "PU",
261 .power_off = imx6_pm_domain_power_off,
262 .power_on = imx6_pm_domain_power_on,
263 .states = &imx6_pm_domain_pu_state,
264 .state_count = 1,
266 .reg_offs = 0x260,
267 .cntr_pdn_bit = 0,
268 }, {
269 .base = {
270 .name = "DISPLAY",
271 .power_off = imx6_pm_domain_power_off,
272 .power_on = imx6_pm_domain_power_on,
274 .reg_offs = 0x240,
275 .cntr_pdn_bit = 4,
276 }, {
277 .base = {
278 .name = "PCI",
279 .power_off = imx6_pm_domain_power_off,
280 .power_on = imx6_pm_domain_power_on,
282 .reg_offs = 0x200,
283 .cntr_pdn_bit = 6,
287 struct imx_gpc_dt_data {
288 int num_domains;
289 bool err009619_present;
292 static const struct imx_gpc_dt_data imx6q_dt_data = {
293 .num_domains = 2,
294 .err009619_present = false,
297 static const struct imx_gpc_dt_data imx6qp_dt_data = {
298 .num_domains = 2,
299 .err009619_present = true,
302 static const struct imx_gpc_dt_data imx6sl_dt_data = {
303 .num_domains = 3,
304 .err009619_present = false,
307 static const struct imx_gpc_dt_data imx6sx_dt_data = {
308 .num_domains = 4,
309 .err009619_present = false,
312 static const struct of_device_id imx_gpc_dt_ids[] = {
313 { .compatible = "fsl,imx6q-gpc", .data = &imx6q_dt_data },
314 { .compatible = "fsl,imx6qp-gpc", .data = &imx6qp_dt_data },
315 { .compatible = "fsl,imx6sl-gpc", .data = &imx6sl_dt_data },
316 { .compatible = "fsl,imx6sx-gpc", .data = &imx6sx_dt_data },
320 static const struct regmap_config imx_gpc_regmap_config = {
321 .reg_bits = 32,
322 .val_bits = 32,
323 .reg_stride = 4,
324 .max_register = 0x2ac,
327 static struct generic_pm_domain *imx_gpc_onecell_domains[] = {
328 &imx_gpc_domains[0].base,
329 &imx_gpc_domains[1].base,
332 static struct genpd_onecell_data imx_gpc_onecell_data = {
333 .domains = imx_gpc_onecell_domains,
334 .num_domains = 2,
337 static int imx_gpc_old_dt_init(struct device *dev, struct regmap *regmap,
338 unsigned int num_domains)
340 struct imx_pm_domain *domain;
341 int i, ret;
343 for (i = 0; i < num_domains; i++) {
344 domain = &imx_gpc_domains[i];
345 domain->regmap = regmap;
346 domain->ipg_rate_mhz = 66;
348 if (i == 1) {
349 domain->supply = devm_regulator_get(dev, "pu");
350 if (IS_ERR(domain->supply))
351 return PTR_ERR(domain->supply);;
353 ret = imx_pgc_get_clocks(dev, domain);
354 if (ret)
355 goto clk_err;
357 domain->base.power_on(&domain->base);
361 for (i = 0; i < num_domains; i++)
362 pm_genpd_init(&imx_gpc_domains[i].base, NULL, false);
364 if (IS_ENABLED(CONFIG_PM_GENERIC_DOMAINS)) {
365 ret = of_genpd_add_provider_onecell(dev->of_node,
366 &imx_gpc_onecell_data);
367 if (ret)
368 goto genpd_err;
371 return 0;
373 genpd_err:
374 for (i = 0; i < num_domains; i++)
375 pm_genpd_remove(&imx_gpc_domains[i].base);
376 imx_pgc_put_clocks(&imx_gpc_domains[GPC_PGC_DOMAIN_PU]);
377 clk_err:
378 return ret;
381 static int imx_gpc_probe(struct platform_device *pdev)
383 const struct of_device_id *of_id =
384 of_match_device(imx_gpc_dt_ids, &pdev->dev);
385 const struct imx_gpc_dt_data *of_id_data = of_id->data;
386 struct device_node *pgc_node;
387 struct regmap *regmap;
388 struct resource *res;
389 void __iomem *base;
390 int ret;
392 pgc_node = of_get_child_by_name(pdev->dev.of_node, "pgc");
394 /* bail out if DT too old and doesn't provide the necessary info */
395 if (!of_property_read_bool(pdev->dev.of_node, "#power-domain-cells") &&
396 !pgc_node)
397 return 0;
399 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
400 base = devm_ioremap_resource(&pdev->dev, res);
401 if (IS_ERR(base))
402 return PTR_ERR(base);
404 regmap = devm_regmap_init_mmio_clk(&pdev->dev, NULL, base,
405 &imx_gpc_regmap_config);
406 if (IS_ERR(regmap)) {
407 ret = PTR_ERR(regmap);
408 dev_err(&pdev->dev, "failed to init regmap: %d\n",
409 ret);
410 return ret;
413 /* Disable PU power down in normal operation if ERR009619 is present */
414 if (of_id_data->err009619_present)
415 imx_gpc_domains[GPC_PGC_DOMAIN_PU].flags |=
416 PGC_DOMAIN_FLAG_NO_PD;
418 if (!pgc_node) {
419 ret = imx_gpc_old_dt_init(&pdev->dev, regmap,
420 of_id_data->num_domains);
421 if (ret)
422 return ret;
423 } else {
424 struct imx_pm_domain *domain;
425 struct platform_device *pd_pdev;
426 struct device_node *np;
427 struct clk *ipg_clk;
428 unsigned int ipg_rate_mhz;
429 int domain_index;
431 ipg_clk = devm_clk_get(&pdev->dev, "ipg");
432 if (IS_ERR(ipg_clk))
433 return PTR_ERR(ipg_clk);
434 ipg_rate_mhz = clk_get_rate(ipg_clk) / 1000000;
436 for_each_child_of_node(pgc_node, np) {
437 ret = of_property_read_u32(np, "reg", &domain_index);
438 if (ret) {
439 of_node_put(np);
440 return ret;
442 if (domain_index >= of_id_data->num_domains)
443 continue;
445 domain = &imx_gpc_domains[domain_index];
446 domain->regmap = regmap;
447 domain->ipg_rate_mhz = ipg_rate_mhz;
449 pd_pdev = platform_device_alloc("imx-pgc-power-domain",
450 domain_index);
451 if (!pd_pdev) {
452 of_node_put(np);
453 return -ENOMEM;
455 pd_pdev->dev.platform_data = domain;
456 pd_pdev->dev.parent = &pdev->dev;
457 pd_pdev->dev.of_node = np;
459 ret = platform_device_add(pd_pdev);
460 if (ret) {
461 platform_device_put(pd_pdev);
462 of_node_put(np);
463 return ret;
468 return 0;
471 static int imx_gpc_remove(struct platform_device *pdev)
473 int ret;
476 * If the old DT binding is used the toplevel driver needs to
477 * de-register the power domains
479 if (!of_get_child_by_name(pdev->dev.of_node, "pgc")) {
480 of_genpd_del_provider(pdev->dev.of_node);
482 ret = pm_genpd_remove(&imx_gpc_domains[GPC_PGC_DOMAIN_PU].base);
483 if (ret)
484 return ret;
485 imx_pgc_put_clocks(&imx_gpc_domains[GPC_PGC_DOMAIN_PU]);
487 ret = pm_genpd_remove(&imx_gpc_domains[GPC_PGC_DOMAIN_ARM].base);
488 if (ret)
489 return ret;
492 return 0;
495 static struct platform_driver imx_gpc_driver = {
496 .driver = {
497 .name = "imx-gpc",
498 .of_match_table = imx_gpc_dt_ids,
500 .probe = imx_gpc_probe,
501 .remove = imx_gpc_remove,
503 builtin_platform_driver(imx_gpc_driver)