1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2020 Collabora Ltd.
6 #include <linux/clk-provider.h>
7 #include <linux/init.h>
9 #include <linux/iopoll.h>
10 #include <linux/mfd/syscon.h>
11 #include <linux/of_clk.h>
12 #include <linux/of_device.h>
13 #include <linux/platform_device.h>
14 #include <linux/pm_domain.h>
15 #include <linux/regmap.h>
16 #include <linux/regulator/consumer.h>
17 #include <linux/soc/mediatek/infracfg.h>
19 #include "mt8167-pm-domains.h"
20 #include "mt8173-pm-domains.h"
21 #include "mt8183-pm-domains.h"
22 #include "mt8186-pm-domains.h"
23 #include "mt8192-pm-domains.h"
24 #include "mt8195-pm-domains.h"
26 #define MTK_POLL_DELAY_US 10
27 #define MTK_POLL_TIMEOUT USEC_PER_SEC
29 #define PWR_RST_B_BIT BIT(0)
30 #define PWR_ISO_BIT BIT(1)
31 #define PWR_ON_BIT BIT(2)
32 #define PWR_ON_2ND_BIT BIT(3)
33 #define PWR_CLK_DIS_BIT BIT(4)
34 #define PWR_SRAM_CLKISO_BIT BIT(5)
35 #define PWR_SRAM_ISOINT_B_BIT BIT(6)
37 struct scpsys_domain {
38 struct generic_pm_domain genpd;
39 const struct scpsys_domain_data *data;
40 struct scpsys *scpsys;
42 struct clk_bulk_data *clks;
44 struct clk_bulk_data *subsys_clks;
45 struct regmap *infracfg;
47 struct regulator *supply;
53 const struct scpsys_soc_data *soc_data;
54 struct genpd_onecell_data pd_data;
55 struct generic_pm_domain *domains[];
58 #define to_scpsys_domain(gpd) container_of(gpd, struct scpsys_domain, genpd)
60 static bool scpsys_domain_is_on(struct scpsys_domain *pd)
62 struct scpsys *scpsys = pd->scpsys;
65 regmap_read(scpsys->base, pd->data->pwr_sta_offs, &status);
66 status &= pd->data->sta_mask;
68 regmap_read(scpsys->base, pd->data->pwr_sta2nd_offs, &status2);
69 status2 &= pd->data->sta_mask;
71 /* A domain is on when both status bits are set. */
72 return status && status2;
75 static int scpsys_sram_enable(struct scpsys_domain *pd)
77 u32 pdn_ack = pd->data->sram_pdn_ack_bits;
78 struct scpsys *scpsys = pd->scpsys;
82 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, pd->data->sram_pdn_bits);
84 /* Either wait until SRAM_PDN_ACK all 1 or 0 */
85 ret = regmap_read_poll_timeout(scpsys->base, pd->data->ctl_offs, tmp,
86 (tmp & pdn_ack) == 0, MTK_POLL_DELAY_US, MTK_POLL_TIMEOUT);
90 if (MTK_SCPD_CAPS(pd, MTK_SCPD_SRAM_ISO)) {
91 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_SRAM_ISOINT_B_BIT);
93 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_SRAM_CLKISO_BIT);
99 static int scpsys_sram_disable(struct scpsys_domain *pd)
101 u32 pdn_ack = pd->data->sram_pdn_ack_bits;
102 struct scpsys *scpsys = pd->scpsys;
105 if (MTK_SCPD_CAPS(pd, MTK_SCPD_SRAM_ISO)) {
106 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_SRAM_CLKISO_BIT);
108 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_SRAM_ISOINT_B_BIT);
111 regmap_set_bits(scpsys->base, pd->data->ctl_offs, pd->data->sram_pdn_bits);
113 /* Either wait until SRAM_PDN_ACK all 1 or 0 */
114 return regmap_read_poll_timeout(scpsys->base, pd->data->ctl_offs, tmp,
115 (tmp & pdn_ack) == pdn_ack, MTK_POLL_DELAY_US,
119 static int _scpsys_bus_protect_enable(const struct scpsys_bus_prot_data *bpd, struct regmap *regmap)
123 for (i = 0; i < SPM_MAX_BUS_PROT_DATA; i++) {
124 u32 val, mask = bpd[i].bus_prot_mask;
129 if (bpd[i].bus_prot_reg_update)
130 regmap_set_bits(regmap, bpd[i].bus_prot_set, mask);
132 regmap_write(regmap, bpd[i].bus_prot_set, mask);
134 ret = regmap_read_poll_timeout(regmap, bpd[i].bus_prot_sta,
135 val, (val & mask) == mask,
136 MTK_POLL_DELAY_US, MTK_POLL_TIMEOUT);
144 static int scpsys_bus_protect_enable(struct scpsys_domain *pd)
148 ret = _scpsys_bus_protect_enable(pd->data->bp_infracfg, pd->infracfg);
152 return _scpsys_bus_protect_enable(pd->data->bp_smi, pd->smi);
155 static int _scpsys_bus_protect_disable(const struct scpsys_bus_prot_data *bpd,
156 struct regmap *regmap)
160 for (i = SPM_MAX_BUS_PROT_DATA - 1; i >= 0; i--) {
161 u32 val, mask = bpd[i].bus_prot_mask;
166 if (bpd[i].bus_prot_reg_update)
167 regmap_clear_bits(regmap, bpd[i].bus_prot_clr, mask);
169 regmap_write(regmap, bpd[i].bus_prot_clr, mask);
171 if (bpd[i].ignore_clr_ack)
174 ret = regmap_read_poll_timeout(regmap, bpd[i].bus_prot_sta,
176 MTK_POLL_DELAY_US, MTK_POLL_TIMEOUT);
184 static int scpsys_bus_protect_disable(struct scpsys_domain *pd)
188 ret = _scpsys_bus_protect_disable(pd->data->bp_smi, pd->smi);
192 return _scpsys_bus_protect_disable(pd->data->bp_infracfg, pd->infracfg);
195 static int scpsys_regulator_enable(struct regulator *supply)
197 return supply ? regulator_enable(supply) : 0;
200 static int scpsys_regulator_disable(struct regulator *supply)
202 return supply ? regulator_disable(supply) : 0;
205 static int scpsys_power_on(struct generic_pm_domain *genpd)
207 struct scpsys_domain *pd = container_of(genpd, struct scpsys_domain, genpd);
208 struct scpsys *scpsys = pd->scpsys;
212 ret = scpsys_regulator_enable(pd->supply);
216 ret = clk_bulk_prepare_enable(pd->num_clks, pd->clks);
220 /* subsys power on */
221 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_ON_BIT);
222 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_ON_2ND_BIT);
224 /* wait until PWR_ACK = 1 */
225 ret = readx_poll_timeout(scpsys_domain_is_on, pd, tmp, tmp, MTK_POLL_DELAY_US,
230 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_CLK_DIS_BIT);
231 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_ISO_BIT);
232 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_RST_B_BIT);
234 ret = clk_bulk_prepare_enable(pd->num_subsys_clks, pd->subsys_clks);
238 ret = scpsys_sram_enable(pd);
240 goto err_disable_subsys_clks;
242 ret = scpsys_bus_protect_disable(pd);
244 goto err_disable_sram;
249 scpsys_sram_disable(pd);
250 err_disable_subsys_clks:
251 clk_bulk_disable_unprepare(pd->num_subsys_clks, pd->subsys_clks);
253 clk_bulk_disable_unprepare(pd->num_clks, pd->clks);
255 scpsys_regulator_disable(pd->supply);
259 static int scpsys_power_off(struct generic_pm_domain *genpd)
261 struct scpsys_domain *pd = container_of(genpd, struct scpsys_domain, genpd);
262 struct scpsys *scpsys = pd->scpsys;
266 ret = scpsys_bus_protect_enable(pd);
270 ret = scpsys_sram_disable(pd);
274 clk_bulk_disable_unprepare(pd->num_subsys_clks, pd->subsys_clks);
276 /* subsys power off */
277 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_RST_B_BIT);
278 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_ISO_BIT);
279 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_CLK_DIS_BIT);
280 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_ON_2ND_BIT);
281 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_ON_BIT);
283 /* wait until PWR_ACK = 0 */
284 ret = readx_poll_timeout(scpsys_domain_is_on, pd, tmp, !tmp, MTK_POLL_DELAY_US,
289 clk_bulk_disable_unprepare(pd->num_clks, pd->clks);
291 scpsys_regulator_disable(pd->supply);
297 generic_pm_domain *scpsys_add_one_domain(struct scpsys *scpsys, struct device_node *node)
299 const struct scpsys_domain_data *domain_data;
300 struct scpsys_domain *pd;
301 struct device_node *root_node = scpsys->dev->of_node;
302 struct device_node *smi_node;
303 struct property *prop;
304 const char *clk_name;
305 int i, ret, num_clks;
310 ret = of_property_read_u32(node, "reg", &id);
312 dev_err(scpsys->dev, "%pOF: failed to retrieve domain id from reg: %d\n",
314 return ERR_PTR(-EINVAL);
317 if (id >= scpsys->soc_data->num_domains) {
318 dev_err(scpsys->dev, "%pOF: invalid domain id %d\n", node, id);
319 return ERR_PTR(-EINVAL);
322 domain_data = &scpsys->soc_data->domains_data[id];
323 if (domain_data->sta_mask == 0) {
324 dev_err(scpsys->dev, "%pOF: undefined domain id %d\n", node, id);
325 return ERR_PTR(-EINVAL);
328 pd = devm_kzalloc(scpsys->dev, sizeof(*pd), GFP_KERNEL);
330 return ERR_PTR(-ENOMEM);
332 pd->data = domain_data;
335 if (MTK_SCPD_CAPS(pd, MTK_SCPD_DOMAIN_SUPPLY)) {
337 * Find regulator in current power domain node.
338 * devm_regulator_get() finds regulator in a node and its child
339 * node, so set of_node to current power domain node then change
340 * back to original node after regulator is found for current
343 scpsys->dev->of_node = node;
344 pd->supply = devm_regulator_get(scpsys->dev, "domain");
345 scpsys->dev->of_node = root_node;
346 if (IS_ERR(pd->supply)) {
347 dev_err_probe(scpsys->dev, PTR_ERR(pd->supply),
348 "%pOF: failed to get power supply.\n",
350 return ERR_CAST(pd->supply);
354 pd->infracfg = syscon_regmap_lookup_by_phandle_optional(node, "mediatek,infracfg");
355 if (IS_ERR(pd->infracfg))
356 return ERR_CAST(pd->infracfg);
358 smi_node = of_parse_phandle(node, "mediatek,smi", 0);
360 pd->smi = device_node_to_regmap(smi_node);
361 of_node_put(smi_node);
363 return ERR_CAST(pd->smi);
366 num_clks = of_clk_get_parent_count(node);
368 /* Calculate number of subsys_clks */
369 of_property_for_each_string(node, "clock-names", prop, clk_name) {
372 subsys = strchr(clk_name, '-');
374 pd->num_subsys_clks++;
379 pd->clks = devm_kcalloc(scpsys->dev, pd->num_clks, sizeof(*pd->clks), GFP_KERNEL);
381 return ERR_PTR(-ENOMEM);
383 pd->subsys_clks = devm_kcalloc(scpsys->dev, pd->num_subsys_clks,
384 sizeof(*pd->subsys_clks), GFP_KERNEL);
385 if (!pd->subsys_clks)
386 return ERR_PTR(-ENOMEM);
390 for (i = 0; i < pd->num_clks; i++) {
391 clk = of_clk_get(node, i);
394 dev_err_probe(scpsys->dev, ret,
395 "%pOF: failed to get clk at index %d: %d\n", node, i, ret);
399 pd->clks[clk_ind++].clk = clk;
402 for (i = 0; i < pd->num_subsys_clks; i++) {
403 clk = of_clk_get(node, i + clk_ind);
406 dev_err_probe(scpsys->dev, ret,
407 "%pOF: failed to get clk at index %d: %d\n", node,
409 goto err_put_subsys_clocks;
412 pd->subsys_clks[i].clk = clk;
416 * Initially turn on all domains to make the domains usable
417 * with !CONFIG_PM and to get the hardware in sync with the
418 * software. The unused domains will be switched off during
421 if (MTK_SCPD_CAPS(pd, MTK_SCPD_KEEP_DEFAULT_OFF)) {
422 if (scpsys_domain_is_on(pd))
423 dev_warn(scpsys->dev,
424 "%pOF: A default off power domain has been ON\n", node);
426 ret = scpsys_power_on(&pd->genpd);
428 dev_err(scpsys->dev, "%pOF: failed to power on domain: %d\n", node, ret);
429 goto err_put_subsys_clocks;
433 if (scpsys->domains[id]) {
436 "power domain with id %d already exists, check your device-tree\n", id);
437 goto err_put_subsys_clocks;
441 pd->genpd.name = node->name;
443 pd->genpd.name = pd->data->name;
445 pd->genpd.power_off = scpsys_power_off;
446 pd->genpd.power_on = scpsys_power_on;
448 if (MTK_SCPD_CAPS(pd, MTK_SCPD_ACTIVE_WAKEUP))
449 pd->genpd.flags |= GENPD_FLAG_ACTIVE_WAKEUP;
451 if (MTK_SCPD_CAPS(pd, MTK_SCPD_KEEP_DEFAULT_OFF))
452 pm_genpd_init(&pd->genpd, NULL, true);
454 pm_genpd_init(&pd->genpd, NULL, false);
456 scpsys->domains[id] = &pd->genpd;
458 return scpsys->pd_data.domains[id];
460 err_put_subsys_clocks:
461 clk_bulk_put(pd->num_subsys_clks, pd->subsys_clks);
463 clk_bulk_put(pd->num_clks, pd->clks);
467 static int scpsys_add_subdomain(struct scpsys *scpsys, struct device_node *parent)
469 struct generic_pm_domain *child_pd, *parent_pd;
470 struct device_node *child;
473 for_each_child_of_node(parent, child) {
476 ret = of_property_read_u32(parent, "reg", &id);
478 dev_err(scpsys->dev, "%pOF: failed to get parent domain id\n", child);
482 if (!scpsys->pd_data.domains[id]) {
484 dev_err(scpsys->dev, "power domain with id %d does not exist\n", id);
488 parent_pd = scpsys->pd_data.domains[id];
490 child_pd = scpsys_add_one_domain(scpsys, child);
491 if (IS_ERR(child_pd)) {
492 ret = PTR_ERR(child_pd);
493 dev_err_probe(scpsys->dev, ret, "%pOF: failed to get child domain id\n",
498 ret = pm_genpd_add_subdomain(parent_pd, child_pd);
500 dev_err(scpsys->dev, "failed to add %s subdomain to parent %s\n",
501 child_pd->name, parent_pd->name);
504 dev_dbg(scpsys->dev, "%s add subdomain: %s\n", parent_pd->name,
508 /* recursive call to add all subdomains */
509 ret = scpsys_add_subdomain(scpsys, child);
521 static void scpsys_remove_one_domain(struct scpsys_domain *pd)
525 if (scpsys_domain_is_on(pd))
526 scpsys_power_off(&pd->genpd);
529 * We're in the error cleanup already, so we only complain,
530 * but won't emit another error on top of the original one.
532 ret = pm_genpd_remove(&pd->genpd);
534 dev_err(pd->scpsys->dev,
535 "failed to remove domain '%s' : %d - state may be inconsistent\n",
536 pd->genpd.name, ret);
538 clk_bulk_put(pd->num_clks, pd->clks);
539 clk_bulk_put(pd->num_subsys_clks, pd->subsys_clks);
542 static void scpsys_domain_cleanup(struct scpsys *scpsys)
544 struct generic_pm_domain *genpd;
545 struct scpsys_domain *pd;
548 for (i = scpsys->pd_data.num_domains - 1; i >= 0; i--) {
549 genpd = scpsys->pd_data.domains[i];
551 pd = to_scpsys_domain(genpd);
552 scpsys_remove_one_domain(pd);
557 static const struct of_device_id scpsys_of_match[] = {
559 .compatible = "mediatek,mt8167-power-controller",
560 .data = &mt8167_scpsys_data,
563 .compatible = "mediatek,mt8173-power-controller",
564 .data = &mt8173_scpsys_data,
567 .compatible = "mediatek,mt8183-power-controller",
568 .data = &mt8183_scpsys_data,
571 .compatible = "mediatek,mt8186-power-controller",
572 .data = &mt8186_scpsys_data,
575 .compatible = "mediatek,mt8192-power-controller",
576 .data = &mt8192_scpsys_data,
579 .compatible = "mediatek,mt8195-power-controller",
580 .data = &mt8195_scpsys_data,
585 static int scpsys_probe(struct platform_device *pdev)
587 struct device *dev = &pdev->dev;
588 struct device_node *np = dev->of_node;
589 const struct scpsys_soc_data *soc;
590 struct device_node *node;
591 struct device *parent;
592 struct scpsys *scpsys;
595 soc = of_device_get_match_data(&pdev->dev);
597 dev_err(&pdev->dev, "no power controller data\n");
601 scpsys = devm_kzalloc(dev, struct_size(scpsys, domains, soc->num_domains), GFP_KERNEL);
606 scpsys->soc_data = soc;
608 scpsys->pd_data.domains = scpsys->domains;
609 scpsys->pd_data.num_domains = soc->num_domains;
611 parent = dev->parent;
613 dev_err(dev, "no parent for syscon devices\n");
617 scpsys->base = syscon_node_to_regmap(parent->of_node);
618 if (IS_ERR(scpsys->base)) {
619 dev_err(dev, "no regmap available\n");
620 return PTR_ERR(scpsys->base);
624 for_each_available_child_of_node(np, node) {
625 struct generic_pm_domain *domain;
627 domain = scpsys_add_one_domain(scpsys, node);
628 if (IS_ERR(domain)) {
629 ret = PTR_ERR(domain);
631 goto err_cleanup_domains;
634 ret = scpsys_add_subdomain(scpsys, node);
637 goto err_cleanup_domains;
642 dev_dbg(dev, "no power domains present\n");
646 ret = of_genpd_add_provider_onecell(np, &scpsys->pd_data);
648 dev_err(dev, "failed to add provider: %d\n", ret);
649 goto err_cleanup_domains;
655 scpsys_domain_cleanup(scpsys);
659 static struct platform_driver scpsys_pm_domain_driver = {
660 .probe = scpsys_probe,
662 .name = "mtk-power-controller",
663 .suppress_bind_attrs = true,
664 .of_match_table = scpsys_of_match,
667 builtin_platform_driver(scpsys_pm_domain_driver);