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 {
34 struct rockchip_pmu_info {
41 u32 core_pwrcnt_offset;
42 u32 gpu_pwrcnt_offset;
44 unsigned int core_power_transition_time;
45 unsigned int gpu_power_transition_time;
48 const struct rockchip_domain_info *domain_info;
51 #define MAX_QOS_REGS_NUM 5
52 #define QOS_PRIORITY 0x08
54 #define QOS_BANDWIDTH 0x10
55 #define QOS_SATURATION 0x14
56 #define QOS_EXTCONTROL 0x18
58 struct rockchip_pm_domain {
59 struct generic_pm_domain genpd;
60 const struct rockchip_domain_info *info;
61 struct rockchip_pmu *pmu;
63 struct regmap **qos_regmap;
64 u32 *qos_save_regs[MAX_QOS_REGS_NUM];
71 struct regmap *regmap;
72 const struct rockchip_pmu_info *info;
73 struct mutex mutex; /* mutex lock for pmu */
74 struct genpd_onecell_data genpd_data;
75 struct generic_pm_domain *domains[];
78 #define to_rockchip_pd(gpd) container_of(gpd, struct rockchip_pm_domain, genpd)
80 #define DOMAIN(pwr, status, req, idle, ack, wakeup) \
82 .pwr_mask = (pwr >= 0) ? BIT(pwr) : 0, \
83 .status_mask = (status >= 0) ? BIT(status) : 0, \
84 .req_mask = (req >= 0) ? BIT(req) : 0, \
85 .idle_mask = (idle >= 0) ? BIT(idle) : 0, \
86 .ack_mask = (ack >= 0) ? BIT(ack) : 0, \
87 .active_wakeup = wakeup, \
90 #define DOMAIN_RK3288(pwr, status, req, wakeup) \
91 DOMAIN(pwr, status, req, req, (req) + 16, wakeup)
93 #define DOMAIN_RK3368(pwr, status, req, wakeup) \
94 DOMAIN(pwr, status, req, (req) + 16, req, wakeup)
96 #define DOMAIN_RK3399(pwr, status, req, wakeup) \
97 DOMAIN(pwr, status, req, req, req, wakeup)
99 static bool rockchip_pmu_domain_is_idle(struct rockchip_pm_domain *pd)
101 struct rockchip_pmu *pmu = pd->pmu;
102 const struct rockchip_domain_info *pd_info = pd->info;
105 regmap_read(pmu->regmap, pmu->info->idle_offset, &val);
106 return (val & pd_info->idle_mask) == pd_info->idle_mask;
109 static int rockchip_pmu_set_idle_request(struct rockchip_pm_domain *pd,
112 const struct rockchip_domain_info *pd_info = pd->info;
113 struct rockchip_pmu *pmu = pd->pmu;
116 if (pd_info->req_mask == 0)
119 regmap_update_bits(pmu->regmap, pmu->info->req_offset,
120 pd_info->req_mask, idle ? -1U : 0);
125 regmap_read(pmu->regmap, pmu->info->ack_offset, &val);
126 } while ((val & pd_info->ack_mask) != (idle ? pd_info->ack_mask : 0));
128 while (rockchip_pmu_domain_is_idle(pd) != idle)
134 static int rockchip_pmu_save_qos(struct rockchip_pm_domain *pd)
138 for (i = 0; i < pd->num_qos; i++) {
139 regmap_read(pd->qos_regmap[i],
141 &pd->qos_save_regs[0][i]);
142 regmap_read(pd->qos_regmap[i],
144 &pd->qos_save_regs[1][i]);
145 regmap_read(pd->qos_regmap[i],
147 &pd->qos_save_regs[2][i]);
148 regmap_read(pd->qos_regmap[i],
150 &pd->qos_save_regs[3][i]);
151 regmap_read(pd->qos_regmap[i],
153 &pd->qos_save_regs[4][i]);
158 static int rockchip_pmu_restore_qos(struct rockchip_pm_domain *pd)
162 for (i = 0; i < pd->num_qos; i++) {
163 regmap_write(pd->qos_regmap[i],
165 pd->qos_save_regs[0][i]);
166 regmap_write(pd->qos_regmap[i],
168 pd->qos_save_regs[1][i]);
169 regmap_write(pd->qos_regmap[i],
171 pd->qos_save_regs[2][i]);
172 regmap_write(pd->qos_regmap[i],
174 pd->qos_save_regs[3][i]);
175 regmap_write(pd->qos_regmap[i],
177 pd->qos_save_regs[4][i]);
183 static bool rockchip_pmu_domain_is_on(struct rockchip_pm_domain *pd)
185 struct rockchip_pmu *pmu = pd->pmu;
188 /* check idle status for idle-only domains */
189 if (pd->info->status_mask == 0)
190 return !rockchip_pmu_domain_is_idle(pd);
192 regmap_read(pmu->regmap, pmu->info->status_offset, &val);
194 /* 1'b0: power on, 1'b1: power off */
195 return !(val & pd->info->status_mask);
198 static void rockchip_do_pmu_set_power_domain(struct rockchip_pm_domain *pd,
201 struct rockchip_pmu *pmu = pd->pmu;
203 if (pd->info->pwr_mask == 0)
206 regmap_update_bits(pmu->regmap, pmu->info->pwr_offset,
207 pd->info->pwr_mask, on ? 0 : -1U);
211 while (rockchip_pmu_domain_is_on(pd) != on)
215 static int rockchip_pd_power(struct rockchip_pm_domain *pd, bool power_on)
219 mutex_lock(&pd->pmu->mutex);
221 if (rockchip_pmu_domain_is_on(pd) != power_on) {
222 for (i = 0; i < pd->num_clks; i++)
223 clk_enable(pd->clks[i]);
226 rockchip_pmu_save_qos(pd);
228 /* if powering down, idle request to NIU first */
229 rockchip_pmu_set_idle_request(pd, true);
232 rockchip_do_pmu_set_power_domain(pd, power_on);
235 /* if powering up, leave idle mode */
236 rockchip_pmu_set_idle_request(pd, false);
238 rockchip_pmu_restore_qos(pd);
241 for (i = pd->num_clks - 1; i >= 0; i--)
242 clk_disable(pd->clks[i]);
245 mutex_unlock(&pd->pmu->mutex);
249 static int rockchip_pd_power_on(struct generic_pm_domain *domain)
251 struct rockchip_pm_domain *pd = to_rockchip_pd(domain);
253 return rockchip_pd_power(pd, true);
256 static int rockchip_pd_power_off(struct generic_pm_domain *domain)
258 struct rockchip_pm_domain *pd = to_rockchip_pd(domain);
260 return rockchip_pd_power(pd, false);
263 static int rockchip_pd_attach_dev(struct generic_pm_domain *genpd,
270 dev_dbg(dev, "attaching to power domain '%s'\n", genpd->name);
272 error = pm_clk_create(dev);
274 dev_err(dev, "pm_clk_create failed %d\n", error);
279 while ((clk = of_clk_get(dev->of_node, i++)) && !IS_ERR(clk)) {
280 dev_dbg(dev, "adding clock '%pC' to list of PM clocks\n", clk);
281 error = pm_clk_add_clk(dev, clk);
283 dev_err(dev, "pm_clk_add_clk failed %d\n", error);
293 static void rockchip_pd_detach_dev(struct generic_pm_domain *genpd,
296 dev_dbg(dev, "detaching from power domain '%s'\n", genpd->name);
301 static bool rockchip_active_wakeup(struct device *dev)
303 struct generic_pm_domain *genpd;
304 struct rockchip_pm_domain *pd;
306 genpd = pd_to_genpd(dev->pm_domain);
307 pd = container_of(genpd, struct rockchip_pm_domain, genpd);
309 return pd->info->active_wakeup;
312 static int rockchip_pm_add_one_domain(struct rockchip_pmu *pmu,
313 struct device_node *node)
315 const struct rockchip_domain_info *pd_info;
316 struct rockchip_pm_domain *pd;
317 struct device_node *qos_node;
324 error = of_property_read_u32(node, "reg", &id);
327 "%s: failed to retrieve domain id (reg): %d\n",
332 if (id >= pmu->info->num_domains) {
333 dev_err(pmu->dev, "%s: invalid domain id %d\n",
338 pd_info = &pmu->info->domain_info[id];
340 dev_err(pmu->dev, "%s: undefined domain id %d\n",
345 clk_cnt = of_count_phandle_with_args(node, "clocks", "#clock-cells");
346 pd = devm_kzalloc(pmu->dev,
347 sizeof(*pd) + clk_cnt * sizeof(pd->clks[0]),
355 for (i = 0; i < clk_cnt; i++) {
356 clk = of_clk_get(node, i);
358 error = PTR_ERR(clk);
360 "%s: failed to get clk at index %d: %d\n",
361 node->name, i, error);
365 error = clk_prepare(clk);
368 "%s: failed to prepare clk %pC (index %d): %d\n",
369 node->name, clk, i, error);
374 pd->clks[pd->num_clks++] = clk;
376 dev_dbg(pmu->dev, "added clock '%pC' to domain '%s'\n",
380 pd->num_qos = of_count_phandle_with_args(node, "pm_qos",
383 if (pd->num_qos > 0) {
384 pd->qos_regmap = devm_kcalloc(pmu->dev, pd->num_qos,
385 sizeof(*pd->qos_regmap),
387 if (!pd->qos_regmap) {
392 for (j = 0; j < MAX_QOS_REGS_NUM; j++) {
393 pd->qos_save_regs[j] = devm_kcalloc(pmu->dev,
397 if (!pd->qos_save_regs[j]) {
403 for (j = 0; j < pd->num_qos; j++) {
404 qos_node = of_parse_phandle(node, "pm_qos", j);
409 pd->qos_regmap[j] = syscon_node_to_regmap(qos_node);
410 if (IS_ERR(pd->qos_regmap[j])) {
412 of_node_put(qos_node);
415 of_node_put(qos_node);
419 error = rockchip_pd_power(pd, true);
422 "failed to power on domain '%s': %d\n",
427 pd->genpd.name = node->name;
428 pd->genpd.power_off = rockchip_pd_power_off;
429 pd->genpd.power_on = rockchip_pd_power_on;
430 pd->genpd.attach_dev = rockchip_pd_attach_dev;
431 pd->genpd.detach_dev = rockchip_pd_detach_dev;
432 pd->genpd.dev_ops.active_wakeup = rockchip_active_wakeup;
433 pd->genpd.flags = GENPD_FLAG_PM_CLK;
434 pm_genpd_init(&pd->genpd, NULL, false);
436 pmu->genpd_data.domains[id] = &pd->genpd;
441 clk_unprepare(pd->clks[i]);
442 clk_put(pd->clks[i]);
447 static void rockchip_pm_remove_one_domain(struct rockchip_pm_domain *pd)
451 for (i = 0; i < pd->num_clks; i++) {
452 clk_unprepare(pd->clks[i]);
453 clk_put(pd->clks[i]);
456 /* protect the zeroing of pm->num_clks */
457 mutex_lock(&pd->pmu->mutex);
459 mutex_unlock(&pd->pmu->mutex);
461 /* devm will free our memory */
464 static void rockchip_pm_domain_cleanup(struct rockchip_pmu *pmu)
466 struct generic_pm_domain *genpd;
467 struct rockchip_pm_domain *pd;
470 for (i = 0; i < pmu->genpd_data.num_domains; i++) {
471 genpd = pmu->genpd_data.domains[i];
473 pd = to_rockchip_pd(genpd);
474 rockchip_pm_remove_one_domain(pd);
478 /* devm will free our memory */
481 static void rockchip_configure_pd_cnt(struct rockchip_pmu *pmu,
482 u32 domain_reg_offset,
485 /* First configure domain power down transition count ... */
486 regmap_write(pmu->regmap, domain_reg_offset, count);
487 /* ... and then power up count. */
488 regmap_write(pmu->regmap, domain_reg_offset + 4, count);
491 static int rockchip_pm_add_subdomain(struct rockchip_pmu *pmu,
492 struct device_node *parent)
494 struct device_node *np;
495 struct generic_pm_domain *child_domain, *parent_domain;
498 for_each_child_of_node(parent, np) {
501 error = of_property_read_u32(parent, "reg", &idx);
504 "%s: failed to retrieve domain id (reg): %d\n",
505 parent->name, error);
508 parent_domain = pmu->genpd_data.domains[idx];
510 error = rockchip_pm_add_one_domain(pmu, np);
512 dev_err(pmu->dev, "failed to handle node %s: %d\n",
517 error = of_property_read_u32(np, "reg", &idx);
520 "%s: failed to retrieve domain id (reg): %d\n",
524 child_domain = pmu->genpd_data.domains[idx];
526 error = pm_genpd_add_subdomain(parent_domain, child_domain);
528 dev_err(pmu->dev, "%s failed to add subdomain %s: %d\n",
529 parent_domain->name, child_domain->name, error);
532 dev_dbg(pmu->dev, "%s add subdomain: %s\n",
533 parent_domain->name, child_domain->name);
536 rockchip_pm_add_subdomain(pmu, np);
546 static int rockchip_pm_domain_probe(struct platform_device *pdev)
548 struct device *dev = &pdev->dev;
549 struct device_node *np = dev->of_node;
550 struct device_node *node;
551 struct device *parent;
552 struct rockchip_pmu *pmu;
553 const struct of_device_id *match;
554 const struct rockchip_pmu_info *pmu_info;
558 dev_err(dev, "device tree node not found\n");
562 match = of_match_device(dev->driver->of_match_table, dev);
563 if (!match || !match->data) {
564 dev_err(dev, "missing pmu data\n");
568 pmu_info = match->data;
570 pmu = devm_kzalloc(dev,
572 pmu_info->num_domains * sizeof(pmu->domains[0]),
577 pmu->dev = &pdev->dev;
578 mutex_init(&pmu->mutex);
580 pmu->info = pmu_info;
582 pmu->genpd_data.domains = pmu->domains;
583 pmu->genpd_data.num_domains = pmu_info->num_domains;
585 parent = dev->parent;
587 dev_err(dev, "no parent for syscon devices\n");
591 pmu->regmap = syscon_node_to_regmap(parent->of_node);
592 if (IS_ERR(pmu->regmap)) {
593 dev_err(dev, "no regmap available\n");
594 return PTR_ERR(pmu->regmap);
598 * Configure power up and down transition delays for CORE
601 rockchip_configure_pd_cnt(pmu, pmu_info->core_pwrcnt_offset,
602 pmu_info->core_power_transition_time);
603 rockchip_configure_pd_cnt(pmu, pmu_info->gpu_pwrcnt_offset,
604 pmu_info->gpu_power_transition_time);
608 for_each_available_child_of_node(np, node) {
609 error = rockchip_pm_add_one_domain(pmu, node);
611 dev_err(dev, "failed to handle node %s: %d\n",
617 error = rockchip_pm_add_subdomain(pmu, node);
619 dev_err(dev, "failed to handle subdomain node %s: %d\n",
627 dev_dbg(dev, "no power domains defined\n");
631 of_genpd_add_provider_onecell(np, &pmu->genpd_data);
636 rockchip_pm_domain_cleanup(pmu);
640 static const struct rockchip_domain_info rk3288_pm_domains[] = {
641 [RK3288_PD_VIO] = DOMAIN_RK3288(7, 7, 4, false),
642 [RK3288_PD_HEVC] = DOMAIN_RK3288(14, 10, 9, false),
643 [RK3288_PD_VIDEO] = DOMAIN_RK3288(8, 8, 3, false),
644 [RK3288_PD_GPU] = DOMAIN_RK3288(9, 9, 2, false),
647 static const struct rockchip_domain_info rk3366_pm_domains[] = {
648 [RK3366_PD_PERI] = DOMAIN_RK3368(10, 10, 6, true),
649 [RK3366_PD_VIO] = DOMAIN_RK3368(14, 14, 8, false),
650 [RK3366_PD_VIDEO] = DOMAIN_RK3368(13, 13, 7, false),
651 [RK3366_PD_RKVDEC] = DOMAIN_RK3368(11, 11, 7, false),
652 [RK3366_PD_WIFIBT] = DOMAIN_RK3368(8, 8, 9, false),
653 [RK3366_PD_VPU] = DOMAIN_RK3368(12, 12, 7, false),
654 [RK3366_PD_GPU] = DOMAIN_RK3368(15, 15, 2, false),
657 static const struct rockchip_domain_info rk3368_pm_domains[] = {
658 [RK3368_PD_PERI] = DOMAIN_RK3368(13, 12, 6, true),
659 [RK3368_PD_VIO] = DOMAIN_RK3368(15, 14, 8, false),
660 [RK3368_PD_VIDEO] = DOMAIN_RK3368(14, 13, 7, false),
661 [RK3368_PD_GPU_0] = DOMAIN_RK3368(16, 15, 2, false),
662 [RK3368_PD_GPU_1] = DOMAIN_RK3368(17, 16, 2, false),
665 static const struct rockchip_domain_info rk3399_pm_domains[] = {
666 [RK3399_PD_TCPD0] = DOMAIN_RK3399(8, 8, -1, false),
667 [RK3399_PD_TCPD1] = DOMAIN_RK3399(9, 9, -1, false),
668 [RK3399_PD_CCI] = DOMAIN_RK3399(10, 10, -1, true),
669 [RK3399_PD_CCI0] = DOMAIN_RK3399(-1, -1, 15, true),
670 [RK3399_PD_CCI1] = DOMAIN_RK3399(-1, -1, 16, true),
671 [RK3399_PD_PERILP] = DOMAIN_RK3399(11, 11, 1, true),
672 [RK3399_PD_PERIHP] = DOMAIN_RK3399(12, 12, 2, true),
673 [RK3399_PD_CENTER] = DOMAIN_RK3399(13, 13, 14, true),
674 [RK3399_PD_VIO] = DOMAIN_RK3399(14, 14, 17, false),
675 [RK3399_PD_GPU] = DOMAIN_RK3399(15, 15, 0, false),
676 [RK3399_PD_VCODEC] = DOMAIN_RK3399(16, 16, 3, false),
677 [RK3399_PD_VDU] = DOMAIN_RK3399(17, 17, 4, false),
678 [RK3399_PD_RGA] = DOMAIN_RK3399(18, 18, 5, false),
679 [RK3399_PD_IEP] = DOMAIN_RK3399(19, 19, 6, false),
680 [RK3399_PD_VO] = DOMAIN_RK3399(20, 20, -1, false),
681 [RK3399_PD_VOPB] = DOMAIN_RK3399(-1, -1, 7, false),
682 [RK3399_PD_VOPL] = DOMAIN_RK3399(-1, -1, 8, false),
683 [RK3399_PD_ISP0] = DOMAIN_RK3399(22, 22, 9, false),
684 [RK3399_PD_ISP1] = DOMAIN_RK3399(23, 23, 10, false),
685 [RK3399_PD_HDCP] = DOMAIN_RK3399(24, 24, 11, false),
686 [RK3399_PD_GMAC] = DOMAIN_RK3399(25, 25, 23, true),
687 [RK3399_PD_EMMC] = DOMAIN_RK3399(26, 26, 24, true),
688 [RK3399_PD_USB3] = DOMAIN_RK3399(27, 27, 12, true),
689 [RK3399_PD_EDP] = DOMAIN_RK3399(28, 28, 22, false),
690 [RK3399_PD_GIC] = DOMAIN_RK3399(29, 29, 27, true),
691 [RK3399_PD_SD] = DOMAIN_RK3399(30, 30, 28, true),
692 [RK3399_PD_SDIOAUDIO] = DOMAIN_RK3399(31, 31, 29, true),
695 static const struct rockchip_pmu_info rk3288_pmu = {
697 .status_offset = 0x0c,
702 .core_pwrcnt_offset = 0x34,
703 .gpu_pwrcnt_offset = 0x3c,
705 .core_power_transition_time = 24, /* 1us */
706 .gpu_power_transition_time = 24, /* 1us */
708 .num_domains = ARRAY_SIZE(rk3288_pm_domains),
709 .domain_info = rk3288_pm_domains,
712 static const struct rockchip_pmu_info rk3366_pmu = {
714 .status_offset = 0x10,
719 .core_pwrcnt_offset = 0x48,
720 .gpu_pwrcnt_offset = 0x50,
722 .core_power_transition_time = 24,
723 .gpu_power_transition_time = 24,
725 .num_domains = ARRAY_SIZE(rk3366_pm_domains),
726 .domain_info = rk3366_pm_domains,
729 static const struct rockchip_pmu_info rk3368_pmu = {
731 .status_offset = 0x10,
736 .core_pwrcnt_offset = 0x48,
737 .gpu_pwrcnt_offset = 0x50,
739 .core_power_transition_time = 24,
740 .gpu_power_transition_time = 24,
742 .num_domains = ARRAY_SIZE(rk3368_pm_domains),
743 .domain_info = rk3368_pm_domains,
746 static const struct rockchip_pmu_info rk3399_pmu = {
748 .status_offset = 0x18,
753 .core_pwrcnt_offset = 0xac,
754 .gpu_pwrcnt_offset = 0xac,
756 .core_power_transition_time = 6, /* 0.25us */
757 .gpu_power_transition_time = 6, /* 0.25us */
759 .num_domains = ARRAY_SIZE(rk3399_pm_domains),
760 .domain_info = rk3399_pm_domains,
763 static const struct of_device_id rockchip_pm_domain_dt_match[] = {
765 .compatible = "rockchip,rk3288-power-controller",
766 .data = (void *)&rk3288_pmu,
769 .compatible = "rockchip,rk3366-power-controller",
770 .data = (void *)&rk3366_pmu,
773 .compatible = "rockchip,rk3368-power-controller",
774 .data = (void *)&rk3368_pmu,
777 .compatible = "rockchip,rk3399-power-controller",
778 .data = (void *)&rk3399_pmu,
783 static struct platform_driver rockchip_pm_domain_driver = {
784 .probe = rockchip_pm_domain_probe,
786 .name = "rockchip-pm-domain",
787 .of_match_table = rockchip_pm_domain_dt_match,
789 * We can't forcibly eject devices form power domain,
790 * so we can't really remove power domains once they
793 .suppress_bind_attrs = true,
797 static int __init rockchip_pm_domain_drv_register(void)
799 return platform_driver_register(&rockchip_pm_domain_driver);
801 postcore_initcall(rockchip_pm_domain_drv_register);