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 static int rockchip_pmu_save_qos(struct rockchip_pm_domain *pd)
165 for (i = 0; i < pd->num_qos; i++) {
166 regmap_read(pd->qos_regmap[i],
168 &pd->qos_save_regs[0][i]);
169 regmap_read(pd->qos_regmap[i],
171 &pd->qos_save_regs[1][i]);
172 regmap_read(pd->qos_regmap[i],
174 &pd->qos_save_regs[2][i]);
175 regmap_read(pd->qos_regmap[i],
177 &pd->qos_save_regs[3][i]);
178 regmap_read(pd->qos_regmap[i],
180 &pd->qos_save_regs[4][i]);
185 static int rockchip_pmu_restore_qos(struct rockchip_pm_domain *pd)
189 for (i = 0; i < pd->num_qos; i++) {
190 regmap_write(pd->qos_regmap[i],
192 pd->qos_save_regs[0][i]);
193 regmap_write(pd->qos_regmap[i],
195 pd->qos_save_regs[1][i]);
196 regmap_write(pd->qos_regmap[i],
198 pd->qos_save_regs[2][i]);
199 regmap_write(pd->qos_regmap[i],
201 pd->qos_save_regs[3][i]);
202 regmap_write(pd->qos_regmap[i],
204 pd->qos_save_regs[4][i]);
210 static bool rockchip_pmu_domain_is_on(struct rockchip_pm_domain *pd)
212 struct rockchip_pmu *pmu = pd->pmu;
215 /* check idle status for idle-only domains */
216 if (pd->info->status_mask == 0)
217 return !rockchip_pmu_domain_is_idle(pd);
219 regmap_read(pmu->regmap, pmu->info->status_offset, &val);
221 /* 1'b0: power on, 1'b1: power off */
222 return !(val & pd->info->status_mask);
225 static void rockchip_do_pmu_set_power_domain(struct rockchip_pm_domain *pd,
228 struct rockchip_pmu *pmu = pd->pmu;
229 struct generic_pm_domain *genpd = &pd->genpd;
232 if (pd->info->pwr_mask == 0)
235 regmap_update_bits(pmu->regmap, pmu->info->pwr_offset,
236 pd->info->pwr_mask, on ? 0 : -1U);
240 if (readx_poll_timeout_atomic(rockchip_pmu_domain_is_on, pd, is_on,
241 is_on == on, 0, 10000)) {
243 "failed to set domain '%s', val=%d\n",
249 static int rockchip_pd_power(struct rockchip_pm_domain *pd, bool power_on)
253 mutex_lock(&pd->pmu->mutex);
255 if (rockchip_pmu_domain_is_on(pd) != power_on) {
256 for (i = 0; i < pd->num_clks; i++)
257 clk_enable(pd->clks[i]);
260 rockchip_pmu_save_qos(pd);
262 /* if powering down, idle request to NIU first */
263 rockchip_pmu_set_idle_request(pd, true);
266 rockchip_do_pmu_set_power_domain(pd, power_on);
269 /* if powering up, leave idle mode */
270 rockchip_pmu_set_idle_request(pd, false);
272 rockchip_pmu_restore_qos(pd);
275 for (i = pd->num_clks - 1; i >= 0; i--)
276 clk_disable(pd->clks[i]);
279 mutex_unlock(&pd->pmu->mutex);
283 static int rockchip_pd_power_on(struct generic_pm_domain *domain)
285 struct rockchip_pm_domain *pd = to_rockchip_pd(domain);
287 return rockchip_pd_power(pd, true);
290 static int rockchip_pd_power_off(struct generic_pm_domain *domain)
292 struct rockchip_pm_domain *pd = to_rockchip_pd(domain);
294 return rockchip_pd_power(pd, false);
297 static int rockchip_pd_attach_dev(struct generic_pm_domain *genpd,
304 dev_dbg(dev, "attaching to power domain '%s'\n", genpd->name);
306 error = pm_clk_create(dev);
308 dev_err(dev, "pm_clk_create failed %d\n", error);
313 while ((clk = of_clk_get(dev->of_node, i++)) && !IS_ERR(clk)) {
314 dev_dbg(dev, "adding clock '%pC' to list of PM clocks\n", clk);
315 error = pm_clk_add_clk(dev, clk);
317 dev_err(dev, "pm_clk_add_clk failed %d\n", error);
327 static void rockchip_pd_detach_dev(struct generic_pm_domain *genpd,
330 dev_dbg(dev, "detaching from power domain '%s'\n", genpd->name);
335 static bool rockchip_active_wakeup(struct device *dev)
337 struct generic_pm_domain *genpd;
338 struct rockchip_pm_domain *pd;
340 genpd = pd_to_genpd(dev->pm_domain);
341 pd = container_of(genpd, struct rockchip_pm_domain, genpd);
343 return pd->info->active_wakeup;
346 static int rockchip_pm_add_one_domain(struct rockchip_pmu *pmu,
347 struct device_node *node)
349 const struct rockchip_domain_info *pd_info;
350 struct rockchip_pm_domain *pd;
351 struct device_node *qos_node;
358 error = of_property_read_u32(node, "reg", &id);
361 "%s: failed to retrieve domain id (reg): %d\n",
366 if (id >= pmu->info->num_domains) {
367 dev_err(pmu->dev, "%s: invalid domain id %d\n",
372 pd_info = &pmu->info->domain_info[id];
374 dev_err(pmu->dev, "%s: undefined domain id %d\n",
379 clk_cnt = of_count_phandle_with_args(node, "clocks", "#clock-cells");
380 pd = devm_kzalloc(pmu->dev,
381 sizeof(*pd) + clk_cnt * sizeof(pd->clks[0]),
389 for (i = 0; i < clk_cnt; i++) {
390 clk = of_clk_get(node, i);
392 error = PTR_ERR(clk);
394 "%s: failed to get clk at index %d: %d\n",
395 node->name, i, error);
399 error = clk_prepare(clk);
402 "%s: failed to prepare clk %pC (index %d): %d\n",
403 node->name, clk, i, error);
408 pd->clks[pd->num_clks++] = clk;
410 dev_dbg(pmu->dev, "added clock '%pC' to domain '%s'\n",
414 pd->num_qos = of_count_phandle_with_args(node, "pm_qos",
417 if (pd->num_qos > 0) {
418 pd->qos_regmap = devm_kcalloc(pmu->dev, pd->num_qos,
419 sizeof(*pd->qos_regmap),
421 if (!pd->qos_regmap) {
426 for (j = 0; j < MAX_QOS_REGS_NUM; j++) {
427 pd->qos_save_regs[j] = devm_kcalloc(pmu->dev,
431 if (!pd->qos_save_regs[j]) {
437 for (j = 0; j < pd->num_qos; j++) {
438 qos_node = of_parse_phandle(node, "pm_qos", j);
443 pd->qos_regmap[j] = syscon_node_to_regmap(qos_node);
444 if (IS_ERR(pd->qos_regmap[j])) {
446 of_node_put(qos_node);
449 of_node_put(qos_node);
453 error = rockchip_pd_power(pd, true);
456 "failed to power on domain '%s': %d\n",
461 pd->genpd.name = node->name;
462 pd->genpd.power_off = rockchip_pd_power_off;
463 pd->genpd.power_on = rockchip_pd_power_on;
464 pd->genpd.attach_dev = rockchip_pd_attach_dev;
465 pd->genpd.detach_dev = rockchip_pd_detach_dev;
466 pd->genpd.dev_ops.active_wakeup = rockchip_active_wakeup;
467 pd->genpd.flags = GENPD_FLAG_PM_CLK;
468 pm_genpd_init(&pd->genpd, NULL, false);
470 pmu->genpd_data.domains[id] = &pd->genpd;
475 clk_unprepare(pd->clks[i]);
476 clk_put(pd->clks[i]);
481 static void rockchip_pm_remove_one_domain(struct rockchip_pm_domain *pd)
485 for (i = 0; i < pd->num_clks; i++) {
486 clk_unprepare(pd->clks[i]);
487 clk_put(pd->clks[i]);
490 /* protect the zeroing of pm->num_clks */
491 mutex_lock(&pd->pmu->mutex);
493 mutex_unlock(&pd->pmu->mutex);
495 /* devm will free our memory */
498 static void rockchip_pm_domain_cleanup(struct rockchip_pmu *pmu)
500 struct generic_pm_domain *genpd;
501 struct rockchip_pm_domain *pd;
504 for (i = 0; i < pmu->genpd_data.num_domains; i++) {
505 genpd = pmu->genpd_data.domains[i];
507 pd = to_rockchip_pd(genpd);
508 rockchip_pm_remove_one_domain(pd);
512 /* devm will free our memory */
515 static void rockchip_configure_pd_cnt(struct rockchip_pmu *pmu,
516 u32 domain_reg_offset,
519 /* First configure domain power down transition count ... */
520 regmap_write(pmu->regmap, domain_reg_offset, count);
521 /* ... and then power up count. */
522 regmap_write(pmu->regmap, domain_reg_offset + 4, count);
525 static int rockchip_pm_add_subdomain(struct rockchip_pmu *pmu,
526 struct device_node *parent)
528 struct device_node *np;
529 struct generic_pm_domain *child_domain, *parent_domain;
532 for_each_child_of_node(parent, np) {
535 error = of_property_read_u32(parent, "reg", &idx);
538 "%s: failed to retrieve domain id (reg): %d\n",
539 parent->name, error);
542 parent_domain = pmu->genpd_data.domains[idx];
544 error = rockchip_pm_add_one_domain(pmu, np);
546 dev_err(pmu->dev, "failed to handle node %s: %d\n",
551 error = of_property_read_u32(np, "reg", &idx);
554 "%s: failed to retrieve domain id (reg): %d\n",
558 child_domain = pmu->genpd_data.domains[idx];
560 error = pm_genpd_add_subdomain(parent_domain, child_domain);
562 dev_err(pmu->dev, "%s failed to add subdomain %s: %d\n",
563 parent_domain->name, child_domain->name, error);
566 dev_dbg(pmu->dev, "%s add subdomain: %s\n",
567 parent_domain->name, child_domain->name);
570 rockchip_pm_add_subdomain(pmu, np);
580 static int rockchip_pm_domain_probe(struct platform_device *pdev)
582 struct device *dev = &pdev->dev;
583 struct device_node *np = dev->of_node;
584 struct device_node *node;
585 struct device *parent;
586 struct rockchip_pmu *pmu;
587 const struct of_device_id *match;
588 const struct rockchip_pmu_info *pmu_info;
592 dev_err(dev, "device tree node not found\n");
596 match = of_match_device(dev->driver->of_match_table, dev);
597 if (!match || !match->data) {
598 dev_err(dev, "missing pmu data\n");
602 pmu_info = match->data;
604 pmu = devm_kzalloc(dev,
606 pmu_info->num_domains * sizeof(pmu->domains[0]),
611 pmu->dev = &pdev->dev;
612 mutex_init(&pmu->mutex);
614 pmu->info = pmu_info;
616 pmu->genpd_data.domains = pmu->domains;
617 pmu->genpd_data.num_domains = pmu_info->num_domains;
619 parent = dev->parent;
621 dev_err(dev, "no parent for syscon devices\n");
625 pmu->regmap = syscon_node_to_regmap(parent->of_node);
626 if (IS_ERR(pmu->regmap)) {
627 dev_err(dev, "no regmap available\n");
628 return PTR_ERR(pmu->regmap);
632 * Configure power up and down transition delays for CORE
635 rockchip_configure_pd_cnt(pmu, pmu_info->core_pwrcnt_offset,
636 pmu_info->core_power_transition_time);
637 rockchip_configure_pd_cnt(pmu, pmu_info->gpu_pwrcnt_offset,
638 pmu_info->gpu_power_transition_time);
642 for_each_available_child_of_node(np, node) {
643 error = rockchip_pm_add_one_domain(pmu, node);
645 dev_err(dev, "failed to handle node %s: %d\n",
651 error = rockchip_pm_add_subdomain(pmu, node);
653 dev_err(dev, "failed to handle subdomain node %s: %d\n",
661 dev_dbg(dev, "no power domains defined\n");
665 of_genpd_add_provider_onecell(np, &pmu->genpd_data);
670 rockchip_pm_domain_cleanup(pmu);
674 static const struct rockchip_domain_info rk3288_pm_domains[] = {
675 [RK3288_PD_VIO] = DOMAIN_RK3288(7, 7, 4, false),
676 [RK3288_PD_HEVC] = DOMAIN_RK3288(14, 10, 9, false),
677 [RK3288_PD_VIDEO] = DOMAIN_RK3288(8, 8, 3, false),
678 [RK3288_PD_GPU] = DOMAIN_RK3288(9, 9, 2, false),
681 static const struct rockchip_domain_info rk3366_pm_domains[] = {
682 [RK3366_PD_PERI] = DOMAIN_RK3368(10, 10, 6, true),
683 [RK3366_PD_VIO] = DOMAIN_RK3368(14, 14, 8, false),
684 [RK3366_PD_VIDEO] = DOMAIN_RK3368(13, 13, 7, false),
685 [RK3366_PD_RKVDEC] = DOMAIN_RK3368(11, 11, 7, false),
686 [RK3366_PD_WIFIBT] = DOMAIN_RK3368(8, 8, 9, false),
687 [RK3366_PD_VPU] = DOMAIN_RK3368(12, 12, 7, false),
688 [RK3366_PD_GPU] = DOMAIN_RK3368(15, 15, 2, false),
691 static const struct rockchip_domain_info rk3368_pm_domains[] = {
692 [RK3368_PD_PERI] = DOMAIN_RK3368(13, 12, 6, true),
693 [RK3368_PD_VIO] = DOMAIN_RK3368(15, 14, 8, false),
694 [RK3368_PD_VIDEO] = DOMAIN_RK3368(14, 13, 7, false),
695 [RK3368_PD_GPU_0] = DOMAIN_RK3368(16, 15, 2, false),
696 [RK3368_PD_GPU_1] = DOMAIN_RK3368(17, 16, 2, false),
699 static const struct rockchip_domain_info rk3399_pm_domains[] = {
700 [RK3399_PD_TCPD0] = DOMAIN_RK3399(8, 8, -1, false),
701 [RK3399_PD_TCPD1] = DOMAIN_RK3399(9, 9, -1, false),
702 [RK3399_PD_CCI] = DOMAIN_RK3399(10, 10, -1, true),
703 [RK3399_PD_CCI0] = DOMAIN_RK3399(-1, -1, 15, true),
704 [RK3399_PD_CCI1] = DOMAIN_RK3399(-1, -1, 16, true),
705 [RK3399_PD_PERILP] = DOMAIN_RK3399(11, 11, 1, true),
706 [RK3399_PD_PERIHP] = DOMAIN_RK3399(12, 12, 2, true),
707 [RK3399_PD_CENTER] = DOMAIN_RK3399(13, 13, 14, true),
708 [RK3399_PD_VIO] = DOMAIN_RK3399(14, 14, 17, false),
709 [RK3399_PD_GPU] = DOMAIN_RK3399(15, 15, 0, false),
710 [RK3399_PD_VCODEC] = DOMAIN_RK3399(16, 16, 3, false),
711 [RK3399_PD_VDU] = DOMAIN_RK3399(17, 17, 4, false),
712 [RK3399_PD_RGA] = DOMAIN_RK3399(18, 18, 5, false),
713 [RK3399_PD_IEP] = DOMAIN_RK3399(19, 19, 6, false),
714 [RK3399_PD_VO] = DOMAIN_RK3399(20, 20, -1, false),
715 [RK3399_PD_VOPB] = DOMAIN_RK3399(-1, -1, 7, false),
716 [RK3399_PD_VOPL] = DOMAIN_RK3399(-1, -1, 8, false),
717 [RK3399_PD_ISP0] = DOMAIN_RK3399(22, 22, 9, false),
718 [RK3399_PD_ISP1] = DOMAIN_RK3399(23, 23, 10, false),
719 [RK3399_PD_HDCP] = DOMAIN_RK3399(24, 24, 11, false),
720 [RK3399_PD_GMAC] = DOMAIN_RK3399(25, 25, 23, true),
721 [RK3399_PD_EMMC] = DOMAIN_RK3399(26, 26, 24, true),
722 [RK3399_PD_USB3] = DOMAIN_RK3399(27, 27, 12, true),
723 [RK3399_PD_EDP] = DOMAIN_RK3399(28, 28, 22, false),
724 [RK3399_PD_GIC] = DOMAIN_RK3399(29, 29, 27, true),
725 [RK3399_PD_SD] = DOMAIN_RK3399(30, 30, 28, true),
726 [RK3399_PD_SDIOAUDIO] = DOMAIN_RK3399(31, 31, 29, true),
729 static const struct rockchip_pmu_info rk3288_pmu = {
731 .status_offset = 0x0c,
736 .core_pwrcnt_offset = 0x34,
737 .gpu_pwrcnt_offset = 0x3c,
739 .core_power_transition_time = 24, /* 1us */
740 .gpu_power_transition_time = 24, /* 1us */
742 .num_domains = ARRAY_SIZE(rk3288_pm_domains),
743 .domain_info = rk3288_pm_domains,
746 static const struct rockchip_pmu_info rk3366_pmu = {
748 .status_offset = 0x10,
753 .core_pwrcnt_offset = 0x48,
754 .gpu_pwrcnt_offset = 0x50,
756 .core_power_transition_time = 24,
757 .gpu_power_transition_time = 24,
759 .num_domains = ARRAY_SIZE(rk3366_pm_domains),
760 .domain_info = rk3366_pm_domains,
763 static const struct rockchip_pmu_info rk3368_pmu = {
765 .status_offset = 0x10,
770 .core_pwrcnt_offset = 0x48,
771 .gpu_pwrcnt_offset = 0x50,
773 .core_power_transition_time = 24,
774 .gpu_power_transition_time = 24,
776 .num_domains = ARRAY_SIZE(rk3368_pm_domains),
777 .domain_info = rk3368_pm_domains,
780 static const struct rockchip_pmu_info rk3399_pmu = {
782 .status_offset = 0x18,
787 .core_pwrcnt_offset = 0xac,
788 .gpu_pwrcnt_offset = 0xac,
790 .core_power_transition_time = 6, /* 0.25us */
791 .gpu_power_transition_time = 6, /* 0.25us */
793 .num_domains = ARRAY_SIZE(rk3399_pm_domains),
794 .domain_info = rk3399_pm_domains,
797 static const struct of_device_id rockchip_pm_domain_dt_match[] = {
799 .compatible = "rockchip,rk3288-power-controller",
800 .data = (void *)&rk3288_pmu,
803 .compatible = "rockchip,rk3366-power-controller",
804 .data = (void *)&rk3366_pmu,
807 .compatible = "rockchip,rk3368-power-controller",
808 .data = (void *)&rk3368_pmu,
811 .compatible = "rockchip,rk3399-power-controller",
812 .data = (void *)&rk3399_pmu,
817 static struct platform_driver rockchip_pm_domain_driver = {
818 .probe = rockchip_pm_domain_probe,
820 .name = "rockchip-pm-domain",
821 .of_match_table = rockchip_pm_domain_dt_match,
823 * We can't forcibly eject devices form power domain,
824 * so we can't really remove power domains once they
827 .suppress_bind_attrs = true,
831 static int __init rockchip_pm_domain_drv_register(void)
833 return platform_driver_register(&rockchip_pm_domain_driver);
835 postcore_initcall(rockchip_pm_domain_drv_register);