1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright 2015-2017 Pengutronix, Lucas Stach <kernel@pengutronix.de>
4 * Copyright 2011-2013 Freescale Semiconductor, Inc.
8 #include <linux/delay.h>
11 #include <linux/platform_device.h>
12 #include <linux/pm_domain.h>
13 #include <linux/property.h>
14 #include <linux/regmap.h>
15 #include <linux/regulator/consumer.h>
17 #define GPC_CNTR 0x000
19 #define GPC_PGC_CTRL_OFFS 0x0
20 #define GPC_PGC_PUPSCR_OFFS 0x4
21 #define GPC_PGC_PDNSCR_OFFS 0x8
22 #define GPC_PGC_SW2ISO_SHIFT 0x8
23 #define GPC_PGC_SW_SHIFT 0x0
25 #define GPC_PGC_PCI_PDN 0x200
26 #define GPC_PGC_PCI_SR 0x20c
28 #define GPC_PGC_GPU_PDN 0x260
29 #define GPC_PGC_GPU_PUPSCR 0x264
30 #define GPC_PGC_GPU_PDNSCR 0x268
31 #define GPC_PGC_GPU_SR 0x26c
33 #define GPC_PGC_DISP_PDN 0x240
34 #define GPC_PGC_DISP_SR 0x24c
36 #define GPU_VPU_PUP_REQ BIT(1)
37 #define GPU_VPU_PDN_REQ BIT(0)
41 #define PGC_DOMAIN_FLAG_NO_PD BIT(0)
43 struct imx_pm_domain {
44 struct generic_pm_domain base;
45 struct regmap *regmap;
46 struct regulator *supply;
47 struct clk *clk[GPC_CLK_MAX];
49 unsigned int reg_offs;
50 signed char cntr_pdn_bit;
51 unsigned int ipg_rate_mhz;
54 static inline struct imx_pm_domain *
55 to_imx_pm_domain(struct generic_pm_domain *genpd)
57 return container_of(genpd, struct imx_pm_domain, base);
60 static int imx6_pm_domain_power_off(struct generic_pm_domain *genpd)
62 struct imx_pm_domain *pd = to_imx_pm_domain(genpd);
66 /* Read ISO and ISO2SW power down delays */
67 regmap_read(pd->regmap, pd->reg_offs + GPC_PGC_PDNSCR_OFFS, &val);
69 iso2sw = (val >> 8) & 0x3f;
71 /* Gate off domain when powered down */
72 regmap_update_bits(pd->regmap, pd->reg_offs + GPC_PGC_CTRL_OFFS,
75 /* Request GPC to power down domain */
76 val = BIT(pd->cntr_pdn_bit);
77 regmap_update_bits(pd->regmap, GPC_CNTR, val, val);
79 /* Wait ISO + ISO2SW IPG clock cycles */
80 udelay(DIV_ROUND_UP(iso + iso2sw, pd->ipg_rate_mhz));
83 regulator_disable(pd->supply);
88 static int imx6_pm_domain_power_on(struct generic_pm_domain *genpd)
90 struct imx_pm_domain *pd = to_imx_pm_domain(genpd);
95 ret = regulator_enable(pd->supply);
97 pr_err("%s: failed to enable regulator: %d\n",
103 /* Enable reset clocks for all devices in the domain */
104 for (i = 0; i < pd->num_clks; i++)
105 clk_prepare_enable(pd->clk[i]);
107 /* Gate off domain when powered down */
108 regmap_update_bits(pd->regmap, pd->reg_offs + GPC_PGC_CTRL_OFFS,
111 /* Request GPC to power up domain */
112 req = BIT(pd->cntr_pdn_bit + 1);
113 regmap_update_bits(pd->regmap, GPC_CNTR, req, req);
115 /* Wait for the PGC to handle the request */
116 ret = regmap_read_poll_timeout(pd->regmap, GPC_CNTR, val, !(val & req),
119 pr_err("powerup request on domain %s timed out\n", genpd->name);
121 /* Wait for reset to propagate through peripherals */
124 /* Disable reset clocks for all devices in the domain */
125 for (i = 0; i < pd->num_clks; i++)
126 clk_disable_unprepare(pd->clk[i]);
131 static int imx_pgc_get_clocks(struct device *dev, struct imx_pm_domain *domain)
136 struct clk *clk = of_clk_get(dev->of_node, i);
139 if (i >= GPC_CLK_MAX) {
140 dev_err(dev, "more than %d clocks\n", GPC_CLK_MAX);
144 domain->clk[i] = clk;
146 domain->num_clks = i;
152 clk_put(domain->clk[i]);
157 static void imx_pgc_put_clocks(struct imx_pm_domain *domain)
161 for (i = domain->num_clks - 1; i >= 0; i--)
162 clk_put(domain->clk[i]);
165 static int imx_pgc_parse_dt(struct device *dev, struct imx_pm_domain *domain)
167 /* try to get the domain supply regulator */
168 domain->supply = devm_regulator_get_optional(dev, "power");
169 if (IS_ERR(domain->supply)) {
170 if (PTR_ERR(domain->supply) == -ENODEV)
171 domain->supply = NULL;
173 return PTR_ERR(domain->supply);
176 /* try to get all clocks needed for reset propagation */
177 return imx_pgc_get_clocks(dev, domain);
180 static int imx_pgc_power_domain_probe(struct platform_device *pdev)
182 struct imx_pm_domain *domain = pdev->dev.platform_data;
183 struct device *dev = &pdev->dev;
186 /* if this PD is associated with a DT node try to parse it */
188 ret = imx_pgc_parse_dt(dev, domain);
193 /* initially power on the domain */
194 if (domain->base.power_on)
195 domain->base.power_on(&domain->base);
197 if (IS_ENABLED(CONFIG_PM_GENERIC_DOMAINS)) {
198 pm_genpd_init(&domain->base, NULL, false);
199 ret = of_genpd_add_provider_simple(dev->of_node, &domain->base);
204 device_link_add(dev, dev->parent, DL_FLAG_AUTOREMOVE_CONSUMER);
209 pm_genpd_remove(&domain->base);
210 imx_pgc_put_clocks(domain);
215 static void imx_pgc_power_domain_remove(struct platform_device *pdev)
217 struct imx_pm_domain *domain = pdev->dev.platform_data;
219 if (IS_ENABLED(CONFIG_PM_GENERIC_DOMAINS)) {
220 of_genpd_del_provider(pdev->dev.of_node);
221 pm_genpd_remove(&domain->base);
222 imx_pgc_put_clocks(domain);
226 static const struct platform_device_id imx_pgc_power_domain_id[] = {
227 { "imx-pgc-power-domain"},
231 static struct platform_driver imx_pgc_power_domain_driver = {
233 .name = "imx-pgc-pd",
235 .probe = imx_pgc_power_domain_probe,
236 .remove_new = imx_pgc_power_domain_remove,
237 .id_table = imx_pgc_power_domain_id,
239 builtin_platform_driver(imx_pgc_power_domain_driver)
241 #define GPC_PGC_DOMAIN_ARM 0
242 #define GPC_PGC_DOMAIN_PU 1
243 #define GPC_PGC_DOMAIN_DISPLAY 2
244 #define GPC_PGC_DOMAIN_PCI 3
246 static struct genpd_power_state imx6_pm_domain_pu_state = {
247 .power_off_latency_ns = 25000,
248 .power_on_latency_ns = 2000000,
251 static struct imx_pm_domain imx_gpc_domains[] = {
252 [GPC_PGC_DOMAIN_ARM] = {
255 .flags = GENPD_FLAG_ALWAYS_ON,
258 [GPC_PGC_DOMAIN_PU] = {
261 .power_off = imx6_pm_domain_power_off,
262 .power_on = imx6_pm_domain_power_on,
263 .states = &imx6_pm_domain_pu_state,
269 [GPC_PGC_DOMAIN_DISPLAY] = {
272 .power_off = imx6_pm_domain_power_off,
273 .power_on = imx6_pm_domain_power_on,
278 [GPC_PGC_DOMAIN_PCI] = {
281 .power_off = imx6_pm_domain_power_off,
282 .power_on = imx6_pm_domain_power_on,
289 struct imx_gpc_dt_data {
291 bool err009619_present;
292 bool err006287_present;
295 static const struct imx_gpc_dt_data imx6q_dt_data = {
297 .err009619_present = false,
298 .err006287_present = false,
301 static const struct imx_gpc_dt_data imx6qp_dt_data = {
303 .err009619_present = true,
304 .err006287_present = false,
307 static const struct imx_gpc_dt_data imx6sl_dt_data = {
309 .err009619_present = false,
310 .err006287_present = true,
313 static const struct imx_gpc_dt_data imx6sx_dt_data = {
315 .err009619_present = false,
316 .err006287_present = false,
319 static const struct of_device_id imx_gpc_dt_ids[] = {
320 { .compatible = "fsl,imx6q-gpc", .data = &imx6q_dt_data },
321 { .compatible = "fsl,imx6qp-gpc", .data = &imx6qp_dt_data },
322 { .compatible = "fsl,imx6sl-gpc", .data = &imx6sl_dt_data },
323 { .compatible = "fsl,imx6sx-gpc", .data = &imx6sx_dt_data },
327 static const struct regmap_range yes_ranges[] = {
328 regmap_reg_range(GPC_CNTR, GPC_CNTR),
329 regmap_reg_range(GPC_PGC_PCI_PDN, GPC_PGC_PCI_SR),
330 regmap_reg_range(GPC_PGC_GPU_PDN, GPC_PGC_GPU_SR),
331 regmap_reg_range(GPC_PGC_DISP_PDN, GPC_PGC_DISP_SR),
334 static const struct regmap_access_table access_table = {
335 .yes_ranges = yes_ranges,
336 .n_yes_ranges = ARRAY_SIZE(yes_ranges),
339 static const struct regmap_config imx_gpc_regmap_config = {
343 .rd_table = &access_table,
344 .wr_table = &access_table,
345 .max_register = 0x2ac,
349 static struct generic_pm_domain *imx_gpc_onecell_domains[] = {
350 &imx_gpc_domains[GPC_PGC_DOMAIN_ARM].base,
351 &imx_gpc_domains[GPC_PGC_DOMAIN_PU].base,
354 static struct genpd_onecell_data imx_gpc_onecell_data = {
355 .domains = imx_gpc_onecell_domains,
359 static int imx_gpc_old_dt_init(struct device *dev, struct regmap *regmap,
360 unsigned int num_domains)
362 struct imx_pm_domain *domain;
365 for (i = 0; i < num_domains; i++) {
366 domain = &imx_gpc_domains[i];
367 domain->regmap = regmap;
368 domain->ipg_rate_mhz = 66;
371 domain->supply = devm_regulator_get(dev, "pu");
372 if (IS_ERR(domain->supply))
373 return PTR_ERR(domain->supply);
375 ret = imx_pgc_get_clocks(dev, domain);
379 domain->base.power_on(&domain->base);
383 for (i = 0; i < num_domains; i++)
384 pm_genpd_init(&imx_gpc_domains[i].base, NULL, false);
386 if (IS_ENABLED(CONFIG_PM_GENERIC_DOMAINS)) {
387 ret = of_genpd_add_provider_onecell(dev->of_node,
388 &imx_gpc_onecell_data);
396 for (i = 0; i < num_domains; i++)
397 pm_genpd_remove(&imx_gpc_domains[i].base);
398 imx_pgc_put_clocks(&imx_gpc_domains[GPC_PGC_DOMAIN_PU]);
403 static int imx_gpc_probe(struct platform_device *pdev)
405 const struct imx_gpc_dt_data *of_id_data = device_get_match_data(&pdev->dev);
406 struct device_node *pgc_node;
407 struct regmap *regmap;
411 pgc_node = of_get_child_by_name(pdev->dev.of_node, "pgc");
413 /* bail out if DT too old and doesn't provide the necessary info */
414 if (!of_property_read_bool(pdev->dev.of_node, "#power-domain-cells") &&
418 base = devm_platform_ioremap_resource(pdev, 0);
420 return PTR_ERR(base);
422 regmap = devm_regmap_init_mmio_clk(&pdev->dev, NULL, base,
423 &imx_gpc_regmap_config);
424 if (IS_ERR(regmap)) {
425 ret = PTR_ERR(regmap);
426 dev_err(&pdev->dev, "failed to init regmap: %d\n",
432 * Disable PU power down by runtime PM if ERR009619 is present.
434 * The PRE clock will be paused for several cycles when turning on the
435 * PU domain LDO from power down state. If PRE is in use at that time,
436 * the IPU/PRG cannot get the correct display data from the PRE.
438 * This is not a concern when the whole system enters suspend state, so
439 * it's safe to power down PU in this case.
441 if (of_id_data->err009619_present)
442 imx_gpc_domains[GPC_PGC_DOMAIN_PU].base.flags |=
443 GENPD_FLAG_RPM_ALWAYS_ON;
445 /* Keep DISP always on if ERR006287 is present */
446 if (of_id_data->err006287_present)
447 imx_gpc_domains[GPC_PGC_DOMAIN_DISPLAY].base.flags |=
448 GENPD_FLAG_ALWAYS_ON;
451 ret = imx_gpc_old_dt_init(&pdev->dev, regmap,
452 of_id_data->num_domains);
456 struct imx_pm_domain *domain;
457 struct platform_device *pd_pdev;
458 struct device_node *np;
460 unsigned int ipg_rate_mhz;
463 ipg_clk = devm_clk_get(&pdev->dev, "ipg");
465 return PTR_ERR(ipg_clk);
466 ipg_rate_mhz = clk_get_rate(ipg_clk) / 1000000;
468 for_each_child_of_node(pgc_node, np) {
469 ret = of_property_read_u32(np, "reg", &domain_index);
474 if (domain_index >= of_id_data->num_domains)
477 pd_pdev = platform_device_alloc("imx-pgc-power-domain",
484 ret = platform_device_add_data(pd_pdev,
485 &imx_gpc_domains[domain_index],
486 sizeof(imx_gpc_domains[domain_index]));
488 platform_device_put(pd_pdev);
492 domain = pd_pdev->dev.platform_data;
493 domain->regmap = regmap;
494 domain->ipg_rate_mhz = ipg_rate_mhz;
496 pd_pdev->dev.parent = &pdev->dev;
497 pd_pdev->dev.of_node = np;
498 pd_pdev->dev.fwnode = of_fwnode_handle(np);
500 ret = platform_device_add(pd_pdev);
502 platform_device_put(pd_pdev);
512 static void imx_gpc_remove(struct platform_device *pdev)
514 struct device_node *pgc_node;
517 pgc_node = of_get_child_by_name(pdev->dev.of_node, "pgc");
519 /* bail out if DT too old and doesn't provide the necessary info */
520 if (!of_property_read_bool(pdev->dev.of_node, "#power-domain-cells") &&
525 * If the old DT binding is used the toplevel driver needs to
526 * de-register the power domains
529 of_genpd_del_provider(pdev->dev.of_node);
531 ret = pm_genpd_remove(&imx_gpc_domains[GPC_PGC_DOMAIN_PU].base);
533 dev_err(&pdev->dev, "Failed to remove PU power domain (%pe)\n",
537 imx_pgc_put_clocks(&imx_gpc_domains[GPC_PGC_DOMAIN_PU]);
539 ret = pm_genpd_remove(&imx_gpc_domains[GPC_PGC_DOMAIN_ARM].base);
541 dev_err(&pdev->dev, "Failed to remove ARM power domain (%pe)\n",
548 static struct platform_driver imx_gpc_driver = {
551 .of_match_table = imx_gpc_dt_ids,
553 .probe = imx_gpc_probe,
554 .remove_new = imx_gpc_remove,
556 builtin_platform_driver(imx_gpc_driver)