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/iopoll.h>
13 #include <linux/err.h>
14 #include <linux/pm_clock.h>
15 #include <linux/pm_domain.h>
16 #include <linux/of_address.h>
17 #include <linux/of_platform.h>
18 #include <linux/clk.h>
19 #include <linux/regmap.h>
20 #include <linux/mfd/syscon.h>
21 #include <dt-bindings/power/rk3288-power.h>
22 #include <dt-bindings/power/rk3366-power.h>
23 #include <dt-bindings/power/rk3368-power.h>
24 #include <dt-bindings/power/rk3399-power.h>
26 struct rockchip_domain_info {
35 struct rockchip_pmu_info {
42 u32 core_pwrcnt_offset;
43 u32 gpu_pwrcnt_offset;
45 unsigned int core_power_transition_time;
46 unsigned int gpu_power_transition_time;
49 const struct rockchip_domain_info *domain_info;
52 #define MAX_QOS_REGS_NUM 5
53 #define QOS_PRIORITY 0x08
55 #define QOS_BANDWIDTH 0x10
56 #define QOS_SATURATION 0x14
57 #define QOS_EXTCONTROL 0x18
59 struct rockchip_pm_domain {
60 struct generic_pm_domain genpd;
61 const struct rockchip_domain_info *info;
62 struct rockchip_pmu *pmu;
64 struct regmap **qos_regmap;
65 u32 *qos_save_regs[MAX_QOS_REGS_NUM];
72 struct regmap *regmap;
73 const struct rockchip_pmu_info *info;
74 struct mutex mutex; /* mutex lock for pmu */
75 struct genpd_onecell_data genpd_data;
76 struct generic_pm_domain *domains[];
79 #define to_rockchip_pd(gpd) container_of(gpd, struct rockchip_pm_domain, genpd)
81 #define DOMAIN(pwr, status, req, idle, ack, wakeup) \
83 .pwr_mask = (pwr >= 0) ? BIT(pwr) : 0, \
84 .status_mask = (status >= 0) ? BIT(status) : 0, \
85 .req_mask = (req >= 0) ? BIT(req) : 0, \
86 .idle_mask = (idle >= 0) ? BIT(idle) : 0, \
87 .ack_mask = (ack >= 0) ? BIT(ack) : 0, \
88 .active_wakeup = wakeup, \
91 #define DOMAIN_RK3288(pwr, status, req, wakeup) \
92 DOMAIN(pwr, status, req, req, (req) + 16, wakeup)
94 #define DOMAIN_RK3368(pwr, status, req, wakeup) \
95 DOMAIN(pwr, status, req, (req) + 16, req, wakeup)
97 #define DOMAIN_RK3399(pwr, status, req, wakeup) \
98 DOMAIN(pwr, status, req, req, req, wakeup)
100 static bool rockchip_pmu_domain_is_idle(struct rockchip_pm_domain *pd)
102 struct rockchip_pmu *pmu = pd->pmu;
103 const struct rockchip_domain_info *pd_info = pd->info;
106 regmap_read(pmu->regmap, pmu->info->idle_offset, &val);
107 return (val & pd_info->idle_mask) == pd_info->idle_mask;
110 static unsigned int rockchip_pmu_read_ack(struct rockchip_pmu *pmu)
114 regmap_read(pmu->regmap, pmu->info->ack_offset, &val);
118 static int rockchip_pmu_set_idle_request(struct rockchip_pm_domain *pd,
121 const struct rockchip_domain_info *pd_info = pd->info;
122 struct generic_pm_domain *genpd = &pd->genpd;
123 struct rockchip_pmu *pmu = pd->pmu;
124 unsigned int target_ack;
129 if (pd_info->req_mask == 0)
132 regmap_update_bits(pmu->regmap, pmu->info->req_offset,
133 pd_info->req_mask, idle ? -1U : 0);
137 /* Wait util idle_ack = 1 */
138 target_ack = idle ? pd_info->ack_mask : 0;
139 ret = readx_poll_timeout_atomic(rockchip_pmu_read_ack, pmu, val,
140 (val & pd_info->ack_mask) == target_ack,
144 "failed to get ack on domain '%s', val=0x%x\n",
149 ret = readx_poll_timeout_atomic(rockchip_pmu_domain_is_idle, pd,
150 is_idle, is_idle == idle, 0, 10000);
153 "failed to set idle on domain '%s', val=%d\n",
154 genpd->name, is_idle);
161 int rockchip_pmu_idle_request(struct device *dev, bool idle)
163 struct generic_pm_domain *genpd;
164 struct rockchip_pm_domain *pd;
167 if (IS_ERR_OR_NULL(dev))
170 if (IS_ERR_OR_NULL(dev->pm_domain))
173 genpd = pd_to_genpd(dev->pm_domain);
174 pd = to_rockchip_pd(genpd);
176 mutex_lock(&pd->pmu->mutex);
177 ret = rockchip_pmu_set_idle_request(pd, idle);
178 mutex_unlock(&pd->pmu->mutex);
182 EXPORT_SYMBOL(rockchip_pmu_idle_request);
184 static int rockchip_pmu_save_qos(struct rockchip_pm_domain *pd)
188 for (i = 0; i < pd->num_qos; i++) {
189 regmap_read(pd->qos_regmap[i],
191 &pd->qos_save_regs[0][i]);
192 regmap_read(pd->qos_regmap[i],
194 &pd->qos_save_regs[1][i]);
195 regmap_read(pd->qos_regmap[i],
197 &pd->qos_save_regs[2][i]);
198 regmap_read(pd->qos_regmap[i],
200 &pd->qos_save_regs[3][i]);
201 regmap_read(pd->qos_regmap[i],
203 &pd->qos_save_regs[4][i]);
208 static int rockchip_pmu_restore_qos(struct rockchip_pm_domain *pd)
212 for (i = 0; i < pd->num_qos; i++) {
213 regmap_write(pd->qos_regmap[i],
215 pd->qos_save_regs[0][i]);
216 regmap_write(pd->qos_regmap[i],
218 pd->qos_save_regs[1][i]);
219 regmap_write(pd->qos_regmap[i],
221 pd->qos_save_regs[2][i]);
222 regmap_write(pd->qos_regmap[i],
224 pd->qos_save_regs[3][i]);
225 regmap_write(pd->qos_regmap[i],
227 pd->qos_save_regs[4][i]);
233 static bool rockchip_pmu_domain_is_on(struct rockchip_pm_domain *pd)
235 struct rockchip_pmu *pmu = pd->pmu;
238 /* check idle status for idle-only domains */
239 if (pd->info->status_mask == 0)
240 return !rockchip_pmu_domain_is_idle(pd);
242 regmap_read(pmu->regmap, pmu->info->status_offset, &val);
244 /* 1'b0: power on, 1'b1: power off */
245 return !(val & pd->info->status_mask);
248 static void rockchip_do_pmu_set_power_domain(struct rockchip_pm_domain *pd,
251 struct rockchip_pmu *pmu = pd->pmu;
252 struct generic_pm_domain *genpd = &pd->genpd;
255 if (pd->info->pwr_mask == 0)
258 regmap_update_bits(pmu->regmap, pmu->info->pwr_offset,
259 pd->info->pwr_mask, on ? 0 : -1U);
263 if (readx_poll_timeout_atomic(rockchip_pmu_domain_is_on, pd, is_on,
264 is_on == on, 0, 10000)) {
266 "failed to set domain '%s', val=%d\n",
272 static int rockchip_pd_power(struct rockchip_pm_domain *pd, bool power_on)
276 mutex_lock(&pd->pmu->mutex);
278 if (rockchip_pmu_domain_is_on(pd) != power_on) {
279 for (i = 0; i < pd->num_clks; i++)
280 clk_enable(pd->clks[i]);
283 rockchip_pmu_save_qos(pd);
285 /* if powering down, idle request to NIU first */
286 rockchip_pmu_set_idle_request(pd, true);
289 rockchip_do_pmu_set_power_domain(pd, power_on);
292 /* if powering up, leave idle mode */
293 rockchip_pmu_set_idle_request(pd, false);
295 rockchip_pmu_restore_qos(pd);
298 for (i = pd->num_clks - 1; i >= 0; i--)
299 clk_disable(pd->clks[i]);
302 mutex_unlock(&pd->pmu->mutex);
306 static int rockchip_pd_power_on(struct generic_pm_domain *domain)
308 struct rockchip_pm_domain *pd = to_rockchip_pd(domain);
310 return rockchip_pd_power(pd, true);
313 static int rockchip_pd_power_off(struct generic_pm_domain *domain)
315 struct rockchip_pm_domain *pd = to_rockchip_pd(domain);
317 return rockchip_pd_power(pd, false);
320 static int rockchip_pd_attach_dev(struct generic_pm_domain *genpd,
327 dev_dbg(dev, "attaching to power domain '%s'\n", genpd->name);
329 error = pm_clk_create(dev);
331 dev_err(dev, "pm_clk_create failed %d\n", error);
336 while ((clk = of_clk_get(dev->of_node, i++)) && !IS_ERR(clk)) {
337 dev_dbg(dev, "adding clock '%pC' to list of PM clocks\n", clk);
338 error = pm_clk_add_clk(dev, clk);
340 dev_err(dev, "pm_clk_add_clk failed %d\n", error);
350 static void rockchip_pd_detach_dev(struct generic_pm_domain *genpd,
353 dev_dbg(dev, "detaching from power domain '%s'\n", genpd->name);
358 static bool rockchip_active_wakeup(struct device *dev)
360 struct generic_pm_domain *genpd;
361 struct rockchip_pm_domain *pd;
363 genpd = pd_to_genpd(dev->pm_domain);
364 pd = container_of(genpd, struct rockchip_pm_domain, genpd);
366 return pd->info->active_wakeup;
369 static int rockchip_pm_add_one_domain(struct rockchip_pmu *pmu,
370 struct device_node *node)
372 const struct rockchip_domain_info *pd_info;
373 struct rockchip_pm_domain *pd;
374 struct device_node *qos_node;
381 error = of_property_read_u32(node, "reg", &id);
384 "%s: failed to retrieve domain id (reg): %d\n",
389 if (id >= pmu->info->num_domains) {
390 dev_err(pmu->dev, "%s: invalid domain id %d\n",
395 pd_info = &pmu->info->domain_info[id];
397 dev_err(pmu->dev, "%s: undefined domain id %d\n",
402 clk_cnt = of_count_phandle_with_args(node, "clocks", "#clock-cells");
403 pd = devm_kzalloc(pmu->dev,
404 sizeof(*pd) + clk_cnt * sizeof(pd->clks[0]),
412 for (i = 0; i < clk_cnt; i++) {
413 clk = of_clk_get(node, i);
415 error = PTR_ERR(clk);
417 "%s: failed to get clk at index %d: %d\n",
418 node->name, i, error);
422 error = clk_prepare(clk);
425 "%s: failed to prepare clk %pC (index %d): %d\n",
426 node->name, clk, i, error);
431 pd->clks[pd->num_clks++] = clk;
433 dev_dbg(pmu->dev, "added clock '%pC' to domain '%s'\n",
437 pd->num_qos = of_count_phandle_with_args(node, "pm_qos",
440 if (pd->num_qos > 0) {
441 pd->qos_regmap = devm_kcalloc(pmu->dev, pd->num_qos,
442 sizeof(*pd->qos_regmap),
444 if (!pd->qos_regmap) {
449 for (j = 0; j < MAX_QOS_REGS_NUM; j++) {
450 pd->qos_save_regs[j] = devm_kcalloc(pmu->dev,
454 if (!pd->qos_save_regs[j]) {
460 for (j = 0; j < pd->num_qos; j++) {
461 qos_node = of_parse_phandle(node, "pm_qos", j);
466 pd->qos_regmap[j] = syscon_node_to_regmap(qos_node);
467 if (IS_ERR(pd->qos_regmap[j])) {
469 of_node_put(qos_node);
472 of_node_put(qos_node);
476 error = rockchip_pd_power(pd, true);
479 "failed to power on domain '%s': %d\n",
484 pd->genpd.name = node->name;
485 pd->genpd.power_off = rockchip_pd_power_off;
486 pd->genpd.power_on = rockchip_pd_power_on;
487 pd->genpd.attach_dev = rockchip_pd_attach_dev;
488 pd->genpd.detach_dev = rockchip_pd_detach_dev;
489 pd->genpd.dev_ops.active_wakeup = rockchip_active_wakeup;
490 pd->genpd.flags = GENPD_FLAG_PM_CLK;
491 pm_genpd_init(&pd->genpd, NULL, false);
493 pmu->genpd_data.domains[id] = &pd->genpd;
498 clk_unprepare(pd->clks[i]);
499 clk_put(pd->clks[i]);
504 static void rockchip_pm_remove_one_domain(struct rockchip_pm_domain *pd)
508 for (i = 0; i < pd->num_clks; i++) {
509 clk_unprepare(pd->clks[i]);
510 clk_put(pd->clks[i]);
513 /* protect the zeroing of pm->num_clks */
514 mutex_lock(&pd->pmu->mutex);
516 mutex_unlock(&pd->pmu->mutex);
518 /* devm will free our memory */
521 static void rockchip_pm_domain_cleanup(struct rockchip_pmu *pmu)
523 struct generic_pm_domain *genpd;
524 struct rockchip_pm_domain *pd;
527 for (i = 0; i < pmu->genpd_data.num_domains; i++) {
528 genpd = pmu->genpd_data.domains[i];
530 pd = to_rockchip_pd(genpd);
531 rockchip_pm_remove_one_domain(pd);
535 /* devm will free our memory */
538 static void rockchip_configure_pd_cnt(struct rockchip_pmu *pmu,
539 u32 domain_reg_offset,
542 /* First configure domain power down transition count ... */
543 regmap_write(pmu->regmap, domain_reg_offset, count);
544 /* ... and then power up count. */
545 regmap_write(pmu->regmap, domain_reg_offset + 4, count);
548 static int rockchip_pm_add_subdomain(struct rockchip_pmu *pmu,
549 struct device_node *parent)
551 struct device_node *np;
552 struct generic_pm_domain *child_domain, *parent_domain;
555 for_each_child_of_node(parent, np) {
558 error = of_property_read_u32(parent, "reg", &idx);
561 "%s: failed to retrieve domain id (reg): %d\n",
562 parent->name, error);
565 parent_domain = pmu->genpd_data.domains[idx];
567 error = rockchip_pm_add_one_domain(pmu, np);
569 dev_err(pmu->dev, "failed to handle node %s: %d\n",
574 error = of_property_read_u32(np, "reg", &idx);
577 "%s: failed to retrieve domain id (reg): %d\n",
581 child_domain = pmu->genpd_data.domains[idx];
583 error = pm_genpd_add_subdomain(parent_domain, child_domain);
585 dev_err(pmu->dev, "%s failed to add subdomain %s: %d\n",
586 parent_domain->name, child_domain->name, error);
589 dev_dbg(pmu->dev, "%s add subdomain: %s\n",
590 parent_domain->name, child_domain->name);
593 rockchip_pm_add_subdomain(pmu, np);
603 static int rockchip_pm_domain_probe(struct platform_device *pdev)
605 struct device *dev = &pdev->dev;
606 struct device_node *np = dev->of_node;
607 struct device_node *node;
608 struct device *parent;
609 struct rockchip_pmu *pmu;
610 const struct of_device_id *match;
611 const struct rockchip_pmu_info *pmu_info;
615 dev_err(dev, "device tree node not found\n");
619 match = of_match_device(dev->driver->of_match_table, dev);
620 if (!match || !match->data) {
621 dev_err(dev, "missing pmu data\n");
625 pmu_info = match->data;
627 pmu = devm_kzalloc(dev,
629 pmu_info->num_domains * sizeof(pmu->domains[0]),
634 pmu->dev = &pdev->dev;
635 mutex_init(&pmu->mutex);
637 pmu->info = pmu_info;
639 pmu->genpd_data.domains = pmu->domains;
640 pmu->genpd_data.num_domains = pmu_info->num_domains;
642 parent = dev->parent;
644 dev_err(dev, "no parent for syscon devices\n");
648 pmu->regmap = syscon_node_to_regmap(parent->of_node);
649 if (IS_ERR(pmu->regmap)) {
650 dev_err(dev, "no regmap available\n");
651 return PTR_ERR(pmu->regmap);
655 * Configure power up and down transition delays for CORE
658 rockchip_configure_pd_cnt(pmu, pmu_info->core_pwrcnt_offset,
659 pmu_info->core_power_transition_time);
660 rockchip_configure_pd_cnt(pmu, pmu_info->gpu_pwrcnt_offset,
661 pmu_info->gpu_power_transition_time);
665 for_each_available_child_of_node(np, node) {
666 error = rockchip_pm_add_one_domain(pmu, node);
668 dev_err(dev, "failed to handle node %s: %d\n",
674 error = rockchip_pm_add_subdomain(pmu, node);
676 dev_err(dev, "failed to handle subdomain node %s: %d\n",
684 dev_dbg(dev, "no power domains defined\n");
688 of_genpd_add_provider_onecell(np, &pmu->genpd_data);
693 rockchip_pm_domain_cleanup(pmu);
697 static const struct rockchip_domain_info rk3288_pm_domains[] = {
698 [RK3288_PD_VIO] = DOMAIN_RK3288(7, 7, 4, false),
699 [RK3288_PD_HEVC] = DOMAIN_RK3288(14, 10, 9, false),
700 [RK3288_PD_VIDEO] = DOMAIN_RK3288(8, 8, 3, false),
701 [RK3288_PD_GPU] = DOMAIN_RK3288(9, 9, 2, false),
704 static const struct rockchip_domain_info rk3366_pm_domains[] = {
705 [RK3366_PD_PERI] = DOMAIN_RK3368(10, 10, 6, true),
706 [RK3366_PD_VIO] = DOMAIN_RK3368(14, 14, 8, false),
707 [RK3366_PD_VIDEO] = DOMAIN_RK3368(13, 13, 7, false),
708 [RK3366_PD_RKVDEC] = DOMAIN_RK3368(11, 11, 7, false),
709 [RK3366_PD_WIFIBT] = DOMAIN_RK3368(8, 8, 9, false),
710 [RK3366_PD_VPU] = DOMAIN_RK3368(12, 12, 7, false),
711 [RK3366_PD_GPU] = DOMAIN_RK3368(15, 15, 2, false),
714 static const struct rockchip_domain_info rk3368_pm_domains[] = {
715 [RK3368_PD_PERI] = DOMAIN_RK3368(13, 12, 6, true),
716 [RK3368_PD_VIO] = DOMAIN_RK3368(15, 14, 8, false),
717 [RK3368_PD_VIDEO] = DOMAIN_RK3368(14, 13, 7, false),
718 [RK3368_PD_GPU_0] = DOMAIN_RK3368(16, 15, 2, false),
719 [RK3368_PD_GPU_1] = DOMAIN_RK3368(17, 16, 2, false),
722 static const struct rockchip_domain_info rk3399_pm_domains[] = {
723 [RK3399_PD_TCPD0] = DOMAIN_RK3399(8, 8, -1, false),
724 [RK3399_PD_TCPD1] = DOMAIN_RK3399(9, 9, -1, false),
725 [RK3399_PD_CCI] = DOMAIN_RK3399(10, 10, -1, true),
726 [RK3399_PD_CCI0] = DOMAIN_RK3399(-1, -1, 15, true),
727 [RK3399_PD_CCI1] = DOMAIN_RK3399(-1, -1, 16, true),
728 [RK3399_PD_PERILP] = DOMAIN_RK3399(11, 11, 1, true),
729 [RK3399_PD_PERIHP] = DOMAIN_RK3399(12, 12, 2, true),
730 [RK3399_PD_CENTER] = DOMAIN_RK3399(13, 13, 14, true),
731 [RK3399_PD_VIO] = DOMAIN_RK3399(14, 14, 17, false),
732 [RK3399_PD_GPU] = DOMAIN_RK3399(15, 15, 0, false),
733 [RK3399_PD_VCODEC] = DOMAIN_RK3399(16, 16, 3, false),
734 [RK3399_PD_VDU] = DOMAIN_RK3399(17, 17, 4, false),
735 [RK3399_PD_RGA] = DOMAIN_RK3399(18, 18, 5, false),
736 [RK3399_PD_IEP] = DOMAIN_RK3399(19, 19, 6, false),
737 [RK3399_PD_VO] = DOMAIN_RK3399(20, 20, -1, false),
738 [RK3399_PD_VOPB] = DOMAIN_RK3399(-1, -1, 7, false),
739 [RK3399_PD_VOPL] = DOMAIN_RK3399(-1, -1, 8, false),
740 [RK3399_PD_ISP0] = DOMAIN_RK3399(22, 22, 9, false),
741 [RK3399_PD_ISP1] = DOMAIN_RK3399(23, 23, 10, false),
742 [RK3399_PD_HDCP] = DOMAIN_RK3399(24, 24, 11, false),
743 [RK3399_PD_GMAC] = DOMAIN_RK3399(25, 25, 23, true),
744 [RK3399_PD_EMMC] = DOMAIN_RK3399(26, 26, 24, true),
745 [RK3399_PD_USB3] = DOMAIN_RK3399(27, 27, 12, true),
746 [RK3399_PD_EDP] = DOMAIN_RK3399(28, 28, 22, false),
747 [RK3399_PD_GIC] = DOMAIN_RK3399(29, 29, 27, true),
748 [RK3399_PD_SD] = DOMAIN_RK3399(30, 30, 28, true),
749 [RK3399_PD_SDIOAUDIO] = DOMAIN_RK3399(31, 31, 29, true),
752 static const struct rockchip_pmu_info rk3288_pmu = {
754 .status_offset = 0x0c,
759 .core_pwrcnt_offset = 0x34,
760 .gpu_pwrcnt_offset = 0x3c,
762 .core_power_transition_time = 24, /* 1us */
763 .gpu_power_transition_time = 24, /* 1us */
765 .num_domains = ARRAY_SIZE(rk3288_pm_domains),
766 .domain_info = rk3288_pm_domains,
769 static const struct rockchip_pmu_info rk3366_pmu = {
771 .status_offset = 0x10,
776 .core_pwrcnt_offset = 0x48,
777 .gpu_pwrcnt_offset = 0x50,
779 .core_power_transition_time = 24,
780 .gpu_power_transition_time = 24,
782 .num_domains = ARRAY_SIZE(rk3366_pm_domains),
783 .domain_info = rk3366_pm_domains,
786 static const struct rockchip_pmu_info rk3368_pmu = {
788 .status_offset = 0x10,
793 .core_pwrcnt_offset = 0x48,
794 .gpu_pwrcnt_offset = 0x50,
796 .core_power_transition_time = 24,
797 .gpu_power_transition_time = 24,
799 .num_domains = ARRAY_SIZE(rk3368_pm_domains),
800 .domain_info = rk3368_pm_domains,
803 static const struct rockchip_pmu_info rk3399_pmu = {
805 .status_offset = 0x18,
810 .core_pwrcnt_offset = 0xac,
811 .gpu_pwrcnt_offset = 0xac,
813 .core_power_transition_time = 6, /* 0.25us */
814 .gpu_power_transition_time = 6, /* 0.25us */
816 .num_domains = ARRAY_SIZE(rk3399_pm_domains),
817 .domain_info = rk3399_pm_domains,
820 static const struct of_device_id rockchip_pm_domain_dt_match[] = {
822 .compatible = "rockchip,rk3288-power-controller",
823 .data = (void *)&rk3288_pmu,
826 .compatible = "rockchip,rk3366-power-controller",
827 .data = (void *)&rk3366_pmu,
830 .compatible = "rockchip,rk3368-power-controller",
831 .data = (void *)&rk3368_pmu,
834 .compatible = "rockchip,rk3399-power-controller",
835 .data = (void *)&rk3399_pmu,
840 static struct platform_driver rockchip_pm_domain_driver = {
841 .probe = rockchip_pm_domain_probe,
843 .name = "rockchip-pm-domain",
844 .of_match_table = rockchip_pm_domain_dt_match,
846 * We can't forcibly eject devices form power domain,
847 * so we can't really remove power domains once they
850 .suppress_bind_attrs = true,
854 static int __init rockchip_pm_domain_drv_register(void)
856 return platform_driver_register(&rockchip_pm_domain_driver);
858 postcore_initcall(rockchip_pm_domain_drv_register);