2 * Rockchip Generic power domain support.
4 * Copyright (c) 2015 ROCKCHIP, Co. Ltd.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
12 #include <linux/err.h>
13 #include <linux/pm_clock.h>
14 #include <linux/pm_domain.h>
15 #include <linux/of_address.h>
16 #include <linux/of_platform.h>
17 #include <linux/clk.h>
18 #include <linux/regmap.h>
19 #include <linux/mfd/syscon.h>
20 #include <dt-bindings/power/rk3288-power.h>
21 #include <dt-bindings/power/rk3366-power.h>
22 #include <dt-bindings/power/rk3368-power.h>
23 #include <dt-bindings/power/rk3399-power.h>
25 struct rockchip_domain_info {
33 struct rockchip_pmu_info {
40 u32 core_pwrcnt_offset;
41 u32 gpu_pwrcnt_offset;
43 unsigned int core_power_transition_time;
44 unsigned int gpu_power_transition_time;
47 const struct rockchip_domain_info *domain_info;
50 #define MAX_QOS_REGS_NUM 5
51 #define QOS_PRIORITY 0x08
53 #define QOS_BANDWIDTH 0x10
54 #define QOS_SATURATION 0x14
55 #define QOS_EXTCONTROL 0x18
57 struct rockchip_pm_domain {
58 struct generic_pm_domain genpd;
59 const struct rockchip_domain_info *info;
60 struct rockchip_pmu *pmu;
62 struct regmap **qos_regmap;
63 u32 *qos_save_regs[MAX_QOS_REGS_NUM];
70 struct regmap *regmap;
71 const struct rockchip_pmu_info *info;
72 struct mutex mutex; /* mutex lock for pmu */
73 struct genpd_onecell_data genpd_data;
74 struct generic_pm_domain *domains[];
77 #define to_rockchip_pd(gpd) container_of(gpd, struct rockchip_pm_domain, genpd)
79 #define DOMAIN(pwr, status, req, idle, ack) \
81 .pwr_mask = (pwr >= 0) ? BIT(pwr) : 0, \
82 .status_mask = (status >= 0) ? BIT(status) : 0, \
83 .req_mask = (req >= 0) ? BIT(req) : 0, \
84 .idle_mask = (idle >= 0) ? BIT(idle) : 0, \
85 .ack_mask = (ack >= 0) ? BIT(ack) : 0, \
88 #define DOMAIN_RK3288(pwr, status, req) \
89 DOMAIN(pwr, status, req, req, (req) + 16)
91 #define DOMAIN_RK3368(pwr, status, req) \
92 DOMAIN(pwr, status, req, (req) + 16, req)
94 #define DOMAIN_RK3399(pwr, status, req) \
95 DOMAIN(pwr, status, req, req, req)
97 static bool rockchip_pmu_domain_is_idle(struct rockchip_pm_domain *pd)
99 struct rockchip_pmu *pmu = pd->pmu;
100 const struct rockchip_domain_info *pd_info = pd->info;
103 regmap_read(pmu->regmap, pmu->info->idle_offset, &val);
104 return (val & pd_info->idle_mask) == pd_info->idle_mask;
107 static int rockchip_pmu_set_idle_request(struct rockchip_pm_domain *pd,
110 const struct rockchip_domain_info *pd_info = pd->info;
111 struct rockchip_pmu *pmu = pd->pmu;
114 if (pd_info->req_mask == 0)
117 regmap_update_bits(pmu->regmap, pmu->info->req_offset,
118 pd_info->req_mask, idle ? -1U : 0);
123 regmap_read(pmu->regmap, pmu->info->ack_offset, &val);
124 } while ((val & pd_info->ack_mask) != (idle ? pd_info->ack_mask : 0));
126 while (rockchip_pmu_domain_is_idle(pd) != idle)
132 static int rockchip_pmu_save_qos(struct rockchip_pm_domain *pd)
136 for (i = 0; i < pd->num_qos; i++) {
137 regmap_read(pd->qos_regmap[i],
139 &pd->qos_save_regs[0][i]);
140 regmap_read(pd->qos_regmap[i],
142 &pd->qos_save_regs[1][i]);
143 regmap_read(pd->qos_regmap[i],
145 &pd->qos_save_regs[2][i]);
146 regmap_read(pd->qos_regmap[i],
148 &pd->qos_save_regs[3][i]);
149 regmap_read(pd->qos_regmap[i],
151 &pd->qos_save_regs[4][i]);
156 static int rockchip_pmu_restore_qos(struct rockchip_pm_domain *pd)
160 for (i = 0; i < pd->num_qos; i++) {
161 regmap_write(pd->qos_regmap[i],
163 pd->qos_save_regs[0][i]);
164 regmap_write(pd->qos_regmap[i],
166 pd->qos_save_regs[1][i]);
167 regmap_write(pd->qos_regmap[i],
169 pd->qos_save_regs[2][i]);
170 regmap_write(pd->qos_regmap[i],
172 pd->qos_save_regs[3][i]);
173 regmap_write(pd->qos_regmap[i],
175 pd->qos_save_regs[4][i]);
181 static bool rockchip_pmu_domain_is_on(struct rockchip_pm_domain *pd)
183 struct rockchip_pmu *pmu = pd->pmu;
186 /* check idle status for idle-only domains */
187 if (pd->info->status_mask == 0)
188 return !rockchip_pmu_domain_is_idle(pd);
190 regmap_read(pmu->regmap, pmu->info->status_offset, &val);
192 /* 1'b0: power on, 1'b1: power off */
193 return !(val & pd->info->status_mask);
196 static void rockchip_do_pmu_set_power_domain(struct rockchip_pm_domain *pd,
199 struct rockchip_pmu *pmu = pd->pmu;
201 if (pd->info->pwr_mask == 0)
204 regmap_update_bits(pmu->regmap, pmu->info->pwr_offset,
205 pd->info->pwr_mask, on ? 0 : -1U);
209 while (rockchip_pmu_domain_is_on(pd) != on)
213 static int rockchip_pd_power(struct rockchip_pm_domain *pd, bool power_on)
217 mutex_lock(&pd->pmu->mutex);
219 if (rockchip_pmu_domain_is_on(pd) != power_on) {
220 for (i = 0; i < pd->num_clks; i++)
221 clk_enable(pd->clks[i]);
224 rockchip_pmu_save_qos(pd);
226 /* if powering down, idle request to NIU first */
227 rockchip_pmu_set_idle_request(pd, true);
230 rockchip_do_pmu_set_power_domain(pd, power_on);
233 /* if powering up, leave idle mode */
234 rockchip_pmu_set_idle_request(pd, false);
236 rockchip_pmu_restore_qos(pd);
239 for (i = pd->num_clks - 1; i >= 0; i--)
240 clk_disable(pd->clks[i]);
243 mutex_unlock(&pd->pmu->mutex);
247 static int rockchip_pd_power_on(struct generic_pm_domain *domain)
249 struct rockchip_pm_domain *pd = to_rockchip_pd(domain);
251 return rockchip_pd_power(pd, true);
254 static int rockchip_pd_power_off(struct generic_pm_domain *domain)
256 struct rockchip_pm_domain *pd = to_rockchip_pd(domain);
258 return rockchip_pd_power(pd, false);
261 static int rockchip_pd_attach_dev(struct generic_pm_domain *genpd,
268 dev_dbg(dev, "attaching to power domain '%s'\n", genpd->name);
270 error = pm_clk_create(dev);
272 dev_err(dev, "pm_clk_create failed %d\n", error);
277 while ((clk = of_clk_get(dev->of_node, i++)) && !IS_ERR(clk)) {
278 dev_dbg(dev, "adding clock '%pC' to list of PM clocks\n", clk);
279 error = pm_clk_add_clk(dev, clk);
281 dev_err(dev, "pm_clk_add_clk failed %d\n", error);
291 static void rockchip_pd_detach_dev(struct generic_pm_domain *genpd,
294 dev_dbg(dev, "detaching from power domain '%s'\n", genpd->name);
299 static int rockchip_pm_add_one_domain(struct rockchip_pmu *pmu,
300 struct device_node *node)
302 const struct rockchip_domain_info *pd_info;
303 struct rockchip_pm_domain *pd;
304 struct device_node *qos_node;
311 error = of_property_read_u32(node, "reg", &id);
314 "%s: failed to retrieve domain id (reg): %d\n",
319 if (id >= pmu->info->num_domains) {
320 dev_err(pmu->dev, "%s: invalid domain id %d\n",
325 pd_info = &pmu->info->domain_info[id];
327 dev_err(pmu->dev, "%s: undefined domain id %d\n",
332 clk_cnt = of_count_phandle_with_args(node, "clocks", "#clock-cells");
333 pd = devm_kzalloc(pmu->dev,
334 sizeof(*pd) + clk_cnt * sizeof(pd->clks[0]),
342 for (i = 0; i < clk_cnt; i++) {
343 clk = of_clk_get(node, i);
345 error = PTR_ERR(clk);
347 "%s: failed to get clk at index %d: %d\n",
348 node->name, i, error);
352 error = clk_prepare(clk);
355 "%s: failed to prepare clk %pC (index %d): %d\n",
356 node->name, clk, i, error);
361 pd->clks[pd->num_clks++] = clk;
363 dev_dbg(pmu->dev, "added clock '%pC' to domain '%s'\n",
367 pd->num_qos = of_count_phandle_with_args(node, "pm_qos",
370 if (pd->num_qos > 0) {
371 pd->qos_regmap = devm_kcalloc(pmu->dev, pd->num_qos,
372 sizeof(*pd->qos_regmap),
374 if (!pd->qos_regmap) {
379 for (j = 0; j < MAX_QOS_REGS_NUM; j++) {
380 pd->qos_save_regs[j] = devm_kcalloc(pmu->dev,
384 if (!pd->qos_save_regs[j]) {
390 for (j = 0; j < pd->num_qos; j++) {
391 qos_node = of_parse_phandle(node, "pm_qos", j);
396 pd->qos_regmap[j] = syscon_node_to_regmap(qos_node);
397 if (IS_ERR(pd->qos_regmap[j])) {
399 of_node_put(qos_node);
402 of_node_put(qos_node);
406 error = rockchip_pd_power(pd, true);
409 "failed to power on domain '%s': %d\n",
414 pd->genpd.name = node->name;
415 pd->genpd.power_off = rockchip_pd_power_off;
416 pd->genpd.power_on = rockchip_pd_power_on;
417 pd->genpd.attach_dev = rockchip_pd_attach_dev;
418 pd->genpd.detach_dev = rockchip_pd_detach_dev;
419 pd->genpd.flags = GENPD_FLAG_PM_CLK;
420 pm_genpd_init(&pd->genpd, NULL, false);
422 pmu->genpd_data.domains[id] = &pd->genpd;
427 clk_unprepare(pd->clks[i]);
428 clk_put(pd->clks[i]);
433 static void rockchip_pm_remove_one_domain(struct rockchip_pm_domain *pd)
437 for (i = 0; i < pd->num_clks; i++) {
438 clk_unprepare(pd->clks[i]);
439 clk_put(pd->clks[i]);
442 /* protect the zeroing of pm->num_clks */
443 mutex_lock(&pd->pmu->mutex);
445 mutex_unlock(&pd->pmu->mutex);
447 /* devm will free our memory */
450 static void rockchip_pm_domain_cleanup(struct rockchip_pmu *pmu)
452 struct generic_pm_domain *genpd;
453 struct rockchip_pm_domain *pd;
456 for (i = 0; i < pmu->genpd_data.num_domains; i++) {
457 genpd = pmu->genpd_data.domains[i];
459 pd = to_rockchip_pd(genpd);
460 rockchip_pm_remove_one_domain(pd);
464 /* devm will free our memory */
467 static void rockchip_configure_pd_cnt(struct rockchip_pmu *pmu,
468 u32 domain_reg_offset,
471 /* First configure domain power down transition count ... */
472 regmap_write(pmu->regmap, domain_reg_offset, count);
473 /* ... and then power up count. */
474 regmap_write(pmu->regmap, domain_reg_offset + 4, count);
477 static int rockchip_pm_add_subdomain(struct rockchip_pmu *pmu,
478 struct device_node *parent)
480 struct device_node *np;
481 struct generic_pm_domain *child_domain, *parent_domain;
484 for_each_child_of_node(parent, np) {
487 error = of_property_read_u32(parent, "reg", &idx);
490 "%s: failed to retrieve domain id (reg): %d\n",
491 parent->name, error);
494 parent_domain = pmu->genpd_data.domains[idx];
496 error = rockchip_pm_add_one_domain(pmu, np);
498 dev_err(pmu->dev, "failed to handle node %s: %d\n",
503 error = of_property_read_u32(np, "reg", &idx);
506 "%s: failed to retrieve domain id (reg): %d\n",
510 child_domain = pmu->genpd_data.domains[idx];
512 error = pm_genpd_add_subdomain(parent_domain, child_domain);
514 dev_err(pmu->dev, "%s failed to add subdomain %s: %d\n",
515 parent_domain->name, child_domain->name, error);
518 dev_dbg(pmu->dev, "%s add subdomain: %s\n",
519 parent_domain->name, child_domain->name);
522 rockchip_pm_add_subdomain(pmu, np);
532 static int rockchip_pm_domain_probe(struct platform_device *pdev)
534 struct device *dev = &pdev->dev;
535 struct device_node *np = dev->of_node;
536 struct device_node *node;
537 struct device *parent;
538 struct rockchip_pmu *pmu;
539 const struct of_device_id *match;
540 const struct rockchip_pmu_info *pmu_info;
544 dev_err(dev, "device tree node not found\n");
548 match = of_match_device(dev->driver->of_match_table, dev);
549 if (!match || !match->data) {
550 dev_err(dev, "missing pmu data\n");
554 pmu_info = match->data;
556 pmu = devm_kzalloc(dev,
558 pmu_info->num_domains * sizeof(pmu->domains[0]),
563 pmu->dev = &pdev->dev;
564 mutex_init(&pmu->mutex);
566 pmu->info = pmu_info;
568 pmu->genpd_data.domains = pmu->domains;
569 pmu->genpd_data.num_domains = pmu_info->num_domains;
571 parent = dev->parent;
573 dev_err(dev, "no parent for syscon devices\n");
577 pmu->regmap = syscon_node_to_regmap(parent->of_node);
578 if (IS_ERR(pmu->regmap)) {
579 dev_err(dev, "no regmap available\n");
580 return PTR_ERR(pmu->regmap);
584 * Configure power up and down transition delays for CORE
587 rockchip_configure_pd_cnt(pmu, pmu_info->core_pwrcnt_offset,
588 pmu_info->core_power_transition_time);
589 rockchip_configure_pd_cnt(pmu, pmu_info->gpu_pwrcnt_offset,
590 pmu_info->gpu_power_transition_time);
594 for_each_available_child_of_node(np, node) {
595 error = rockchip_pm_add_one_domain(pmu, node);
597 dev_err(dev, "failed to handle node %s: %d\n",
603 error = rockchip_pm_add_subdomain(pmu, node);
605 dev_err(dev, "failed to handle subdomain node %s: %d\n",
613 dev_dbg(dev, "no power domains defined\n");
617 of_genpd_add_provider_onecell(np, &pmu->genpd_data);
622 rockchip_pm_domain_cleanup(pmu);
626 static const struct rockchip_domain_info rk3288_pm_domains[] = {
627 [RK3288_PD_VIO] = DOMAIN_RK3288(7, 7, 4),
628 [RK3288_PD_HEVC] = DOMAIN_RK3288(14, 10, 9),
629 [RK3288_PD_VIDEO] = DOMAIN_RK3288(8, 8, 3),
630 [RK3288_PD_GPU] = DOMAIN_RK3288(9, 9, 2),
633 static const struct rockchip_domain_info rk3366_pm_domains[] = {
634 [RK3366_PD_PERI] = DOMAIN_RK3368(10, 10, 6),
635 [RK3366_PD_VIO] = DOMAIN_RK3368(14, 14, 8),
636 [RK3366_PD_VIDEO] = DOMAIN_RK3368(13, 13, 7),
637 [RK3366_PD_RKVDEC] = DOMAIN_RK3368(11, 11, 7),
638 [RK3366_PD_WIFIBT] = DOMAIN_RK3368(8, 8, 9),
639 [RK3366_PD_VPU] = DOMAIN_RK3368(12, 12, 7),
640 [RK3366_PD_GPU] = DOMAIN_RK3368(15, 15, 2),
643 static const struct rockchip_domain_info rk3368_pm_domains[] = {
644 [RK3368_PD_PERI] = DOMAIN_RK3368(13, 12, 6),
645 [RK3368_PD_VIO] = DOMAIN_RK3368(15, 14, 8),
646 [RK3368_PD_VIDEO] = DOMAIN_RK3368(14, 13, 7),
647 [RK3368_PD_GPU_0] = DOMAIN_RK3368(16, 15, 2),
648 [RK3368_PD_GPU_1] = DOMAIN_RK3368(17, 16, 2),
651 static const struct rockchip_domain_info rk3399_pm_domains[] = {
652 [RK3399_PD_TCPD0] = DOMAIN_RK3399(8, 8, -1),
653 [RK3399_PD_TCPD1] = DOMAIN_RK3399(9, 9, -1),
654 [RK3399_PD_CCI] = DOMAIN_RK3399(10, 10, -1),
655 [RK3399_PD_CCI0] = DOMAIN_RK3399(-1, -1, 15),
656 [RK3399_PD_CCI1] = DOMAIN_RK3399(-1, -1, 16),
657 [RK3399_PD_PERILP] = DOMAIN_RK3399(11, 11, 1),
658 [RK3399_PD_PERIHP] = DOMAIN_RK3399(12, 12, 2),
659 [RK3399_PD_CENTER] = DOMAIN_RK3399(13, 13, 14),
660 [RK3399_PD_VIO] = DOMAIN_RK3399(14, 14, 17),
661 [RK3399_PD_GPU] = DOMAIN_RK3399(15, 15, 0),
662 [RK3399_PD_VCODEC] = DOMAIN_RK3399(16, 16, 3),
663 [RK3399_PD_VDU] = DOMAIN_RK3399(17, 17, 4),
664 [RK3399_PD_RGA] = DOMAIN_RK3399(18, 18, 5),
665 [RK3399_PD_IEP] = DOMAIN_RK3399(19, 19, 6),
666 [RK3399_PD_VO] = DOMAIN_RK3399(20, 20, -1),
667 [RK3399_PD_VOPB] = DOMAIN_RK3399(-1, -1, 7),
668 [RK3399_PD_VOPL] = DOMAIN_RK3399(-1, -1, 8),
669 [RK3399_PD_ISP0] = DOMAIN_RK3399(22, 22, 9),
670 [RK3399_PD_ISP1] = DOMAIN_RK3399(23, 23, 10),
671 [RK3399_PD_HDCP] = DOMAIN_RK3399(24, 24, 11),
672 [RK3399_PD_GMAC] = DOMAIN_RK3399(25, 25, 23),
673 [RK3399_PD_EMMC] = DOMAIN_RK3399(26, 26, 24),
674 [RK3399_PD_USB3] = DOMAIN_RK3399(27, 27, 12),
675 [RK3399_PD_EDP] = DOMAIN_RK3399(28, 28, 22),
676 [RK3399_PD_GIC] = DOMAIN_RK3399(29, 29, 27),
677 [RK3399_PD_SD] = DOMAIN_RK3399(30, 30, 28),
678 [RK3399_PD_SDIOAUDIO] = DOMAIN_RK3399(31, 31, 29),
681 static const struct rockchip_pmu_info rk3288_pmu = {
683 .status_offset = 0x0c,
688 .core_pwrcnt_offset = 0x34,
689 .gpu_pwrcnt_offset = 0x3c,
691 .core_power_transition_time = 24, /* 1us */
692 .gpu_power_transition_time = 24, /* 1us */
694 .num_domains = ARRAY_SIZE(rk3288_pm_domains),
695 .domain_info = rk3288_pm_domains,
698 static const struct rockchip_pmu_info rk3366_pmu = {
700 .status_offset = 0x10,
705 .core_pwrcnt_offset = 0x48,
706 .gpu_pwrcnt_offset = 0x50,
708 .core_power_transition_time = 24,
709 .gpu_power_transition_time = 24,
711 .num_domains = ARRAY_SIZE(rk3366_pm_domains),
712 .domain_info = rk3366_pm_domains,
715 static const struct rockchip_pmu_info rk3368_pmu = {
717 .status_offset = 0x10,
722 .core_pwrcnt_offset = 0x48,
723 .gpu_pwrcnt_offset = 0x50,
725 .core_power_transition_time = 24,
726 .gpu_power_transition_time = 24,
728 .num_domains = ARRAY_SIZE(rk3368_pm_domains),
729 .domain_info = rk3368_pm_domains,
732 static const struct rockchip_pmu_info rk3399_pmu = {
734 .status_offset = 0x18,
739 .core_pwrcnt_offset = 0xac,
740 .gpu_pwrcnt_offset = 0xac,
742 .core_power_transition_time = 6, /* 0.25us */
743 .gpu_power_transition_time = 6, /* 0.25us */
745 .num_domains = ARRAY_SIZE(rk3399_pm_domains),
746 .domain_info = rk3399_pm_domains,
749 static const struct of_device_id rockchip_pm_domain_dt_match[] = {
751 .compatible = "rockchip,rk3288-power-controller",
752 .data = (void *)&rk3288_pmu,
755 .compatible = "rockchip,rk3366-power-controller",
756 .data = (void *)&rk3366_pmu,
759 .compatible = "rockchip,rk3368-power-controller",
760 .data = (void *)&rk3368_pmu,
763 .compatible = "rockchip,rk3399-power-controller",
764 .data = (void *)&rk3399_pmu,
769 static struct platform_driver rockchip_pm_domain_driver = {
770 .probe = rockchip_pm_domain_probe,
772 .name = "rockchip-pm-domain",
773 .of_match_table = rockchip_pm_domain_dt_match,
775 * We can't forcibly eject devices form power domain,
776 * so we can't really remove power domains once they
779 .suppress_bind_attrs = true,
783 static int __init rockchip_pm_domain_drv_register(void)
785 return platform_driver_register(&rockchip_pm_domain_driver);
787 postcore_initcall(rockchip_pm_domain_drv_register);