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>
12 #include <linux/of_clk.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 "mt6795-pm-domains.h"
20 #include "mt8167-pm-domains.h"
21 #include "mt8173-pm-domains.h"
22 #include "mt8183-pm-domains.h"
23 #include "mt8186-pm-domains.h"
24 #include "mt8188-pm-domains.h"
25 #include "mt8192-pm-domains.h"
26 #include "mt8195-pm-domains.h"
28 #define MTK_POLL_DELAY_US 10
29 #define MTK_POLL_TIMEOUT USEC_PER_SEC
31 #define PWR_RST_B_BIT BIT(0)
32 #define PWR_ISO_BIT BIT(1)
33 #define PWR_ON_BIT BIT(2)
34 #define PWR_ON_2ND_BIT BIT(3)
35 #define PWR_CLK_DIS_BIT BIT(4)
36 #define PWR_SRAM_CLKISO_BIT BIT(5)
37 #define PWR_SRAM_ISOINT_B_BIT BIT(6)
39 struct scpsys_domain {
40 struct generic_pm_domain genpd;
41 const struct scpsys_domain_data *data;
42 struct scpsys *scpsys;
44 struct clk_bulk_data *clks;
46 struct clk_bulk_data *subsys_clks;
47 struct regmap *infracfg;
49 struct regulator *supply;
55 const struct scpsys_soc_data *soc_data;
56 struct genpd_onecell_data pd_data;
57 struct generic_pm_domain *domains[];
60 #define to_scpsys_domain(gpd) container_of(gpd, struct scpsys_domain, genpd)
62 static bool scpsys_domain_is_on(struct scpsys_domain *pd)
64 struct scpsys *scpsys = pd->scpsys;
67 regmap_read(scpsys->base, pd->data->pwr_sta_offs, &status);
68 status &= pd->data->sta_mask;
70 regmap_read(scpsys->base, pd->data->pwr_sta2nd_offs, &status2);
71 status2 &= pd->data->sta_mask;
73 /* A domain is on when both status bits are set. */
74 return status && status2;
77 static int scpsys_sram_enable(struct scpsys_domain *pd)
79 u32 pdn_ack = pd->data->sram_pdn_ack_bits;
80 struct scpsys *scpsys = pd->scpsys;
84 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, pd->data->sram_pdn_bits);
86 /* Either wait until SRAM_PDN_ACK all 1 or 0 */
87 ret = regmap_read_poll_timeout(scpsys->base, pd->data->ctl_offs, tmp,
88 (tmp & pdn_ack) == 0, MTK_POLL_DELAY_US, MTK_POLL_TIMEOUT);
92 if (MTK_SCPD_CAPS(pd, MTK_SCPD_SRAM_ISO)) {
93 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_SRAM_ISOINT_B_BIT);
95 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_SRAM_CLKISO_BIT);
101 static int scpsys_sram_disable(struct scpsys_domain *pd)
103 u32 pdn_ack = pd->data->sram_pdn_ack_bits;
104 struct scpsys *scpsys = pd->scpsys;
107 if (MTK_SCPD_CAPS(pd, MTK_SCPD_SRAM_ISO)) {
108 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_SRAM_CLKISO_BIT);
110 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_SRAM_ISOINT_B_BIT);
113 regmap_set_bits(scpsys->base, pd->data->ctl_offs, pd->data->sram_pdn_bits);
115 /* Either wait until SRAM_PDN_ACK all 1 or 0 */
116 return regmap_read_poll_timeout(scpsys->base, pd->data->ctl_offs, tmp,
117 (tmp & pdn_ack) == pdn_ack, MTK_POLL_DELAY_US,
121 static int _scpsys_bus_protect_enable(const struct scpsys_bus_prot_data *bpd, struct regmap *regmap)
125 for (i = 0; i < SPM_MAX_BUS_PROT_DATA; i++) {
126 u32 val, mask = bpd[i].bus_prot_mask;
131 if (bpd[i].bus_prot_reg_update)
132 regmap_set_bits(regmap, bpd[i].bus_prot_set, mask);
134 regmap_write(regmap, bpd[i].bus_prot_set, mask);
136 ret = regmap_read_poll_timeout(regmap, bpd[i].bus_prot_sta,
137 val, (val & mask) == mask,
138 MTK_POLL_DELAY_US, MTK_POLL_TIMEOUT);
146 static int scpsys_bus_protect_enable(struct scpsys_domain *pd)
150 ret = _scpsys_bus_protect_enable(pd->data->bp_infracfg, pd->infracfg);
154 return _scpsys_bus_protect_enable(pd->data->bp_smi, pd->smi);
157 static int _scpsys_bus_protect_disable(const struct scpsys_bus_prot_data *bpd,
158 struct regmap *regmap)
162 for (i = SPM_MAX_BUS_PROT_DATA - 1; i >= 0; i--) {
163 u32 val, mask = bpd[i].bus_prot_mask;
168 if (bpd[i].bus_prot_reg_update)
169 regmap_clear_bits(regmap, bpd[i].bus_prot_clr, mask);
171 regmap_write(regmap, bpd[i].bus_prot_clr, mask);
173 if (bpd[i].ignore_clr_ack)
176 ret = regmap_read_poll_timeout(regmap, bpd[i].bus_prot_sta,
178 MTK_POLL_DELAY_US, MTK_POLL_TIMEOUT);
186 static int scpsys_bus_protect_disable(struct scpsys_domain *pd)
190 ret = _scpsys_bus_protect_disable(pd->data->bp_smi, pd->smi);
194 return _scpsys_bus_protect_disable(pd->data->bp_infracfg, pd->infracfg);
197 static int scpsys_regulator_enable(struct regulator *supply)
199 return supply ? regulator_enable(supply) : 0;
202 static int scpsys_regulator_disable(struct regulator *supply)
204 return supply ? regulator_disable(supply) : 0;
207 static int scpsys_power_on(struct generic_pm_domain *genpd)
209 struct scpsys_domain *pd = container_of(genpd, struct scpsys_domain, genpd);
210 struct scpsys *scpsys = pd->scpsys;
214 ret = scpsys_regulator_enable(pd->supply);
218 ret = clk_bulk_prepare_enable(pd->num_clks, pd->clks);
222 if (pd->data->ext_buck_iso_offs && MTK_SCPD_CAPS(pd, MTK_SCPD_EXT_BUCK_ISO))
223 regmap_clear_bits(scpsys->base, pd->data->ext_buck_iso_offs,
224 pd->data->ext_buck_iso_mask);
226 /* subsys power on */
227 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_ON_BIT);
228 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_ON_2ND_BIT);
230 /* wait until PWR_ACK = 1 */
231 ret = readx_poll_timeout(scpsys_domain_is_on, pd, tmp, tmp, MTK_POLL_DELAY_US,
236 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_CLK_DIS_BIT);
237 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_ISO_BIT);
238 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_RST_B_BIT);
240 ret = clk_bulk_prepare_enable(pd->num_subsys_clks, pd->subsys_clks);
244 ret = scpsys_sram_enable(pd);
246 goto err_disable_subsys_clks;
248 ret = scpsys_bus_protect_disable(pd);
250 goto err_disable_sram;
255 scpsys_sram_disable(pd);
256 err_disable_subsys_clks:
257 clk_bulk_disable_unprepare(pd->num_subsys_clks, pd->subsys_clks);
259 clk_bulk_disable_unprepare(pd->num_clks, pd->clks);
261 scpsys_regulator_disable(pd->supply);
265 static int scpsys_power_off(struct generic_pm_domain *genpd)
267 struct scpsys_domain *pd = container_of(genpd, struct scpsys_domain, genpd);
268 struct scpsys *scpsys = pd->scpsys;
272 ret = scpsys_bus_protect_enable(pd);
276 ret = scpsys_sram_disable(pd);
280 if (pd->data->ext_buck_iso_offs && MTK_SCPD_CAPS(pd, MTK_SCPD_EXT_BUCK_ISO))
281 regmap_set_bits(scpsys->base, pd->data->ext_buck_iso_offs,
282 pd->data->ext_buck_iso_mask);
284 clk_bulk_disable_unprepare(pd->num_subsys_clks, pd->subsys_clks);
286 /* subsys power off */
287 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_ISO_BIT);
288 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_CLK_DIS_BIT);
289 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_RST_B_BIT);
290 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_ON_2ND_BIT);
291 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_ON_BIT);
293 /* wait until PWR_ACK = 0 */
294 ret = readx_poll_timeout(scpsys_domain_is_on, pd, tmp, !tmp, MTK_POLL_DELAY_US,
299 clk_bulk_disable_unprepare(pd->num_clks, pd->clks);
301 scpsys_regulator_disable(pd->supply);
307 generic_pm_domain *scpsys_add_one_domain(struct scpsys *scpsys, struct device_node *node)
309 const struct scpsys_domain_data *domain_data;
310 struct scpsys_domain *pd;
311 struct device_node *root_node = scpsys->dev->of_node;
312 struct device_node *smi_node;
313 struct property *prop;
314 const char *clk_name;
315 int i, ret, num_clks;
320 ret = of_property_read_u32(node, "reg", &id);
322 dev_err(scpsys->dev, "%pOF: failed to retrieve domain id from reg: %d\n",
324 return ERR_PTR(-EINVAL);
327 if (id >= scpsys->soc_data->num_domains) {
328 dev_err(scpsys->dev, "%pOF: invalid domain id %d\n", node, id);
329 return ERR_PTR(-EINVAL);
332 domain_data = &scpsys->soc_data->domains_data[id];
333 if (domain_data->sta_mask == 0) {
334 dev_err(scpsys->dev, "%pOF: undefined domain id %d\n", node, id);
335 return ERR_PTR(-EINVAL);
338 pd = devm_kzalloc(scpsys->dev, sizeof(*pd), GFP_KERNEL);
340 return ERR_PTR(-ENOMEM);
342 pd->data = domain_data;
345 if (MTK_SCPD_CAPS(pd, MTK_SCPD_DOMAIN_SUPPLY)) {
347 * Find regulator in current power domain node.
348 * devm_regulator_get() finds regulator in a node and its child
349 * node, so set of_node to current power domain node then change
350 * back to original node after regulator is found for current
353 scpsys->dev->of_node = node;
354 pd->supply = devm_regulator_get(scpsys->dev, "domain");
355 scpsys->dev->of_node = root_node;
356 if (IS_ERR(pd->supply)) {
357 dev_err_probe(scpsys->dev, PTR_ERR(pd->supply),
358 "%pOF: failed to get power supply.\n",
360 return ERR_CAST(pd->supply);
364 pd->infracfg = syscon_regmap_lookup_by_phandle_optional(node, "mediatek,infracfg");
365 if (IS_ERR(pd->infracfg))
366 return ERR_CAST(pd->infracfg);
368 smi_node = of_parse_phandle(node, "mediatek,smi", 0);
370 pd->smi = device_node_to_regmap(smi_node);
371 of_node_put(smi_node);
373 return ERR_CAST(pd->smi);
376 num_clks = of_clk_get_parent_count(node);
378 /* Calculate number of subsys_clks */
379 of_property_for_each_string(node, "clock-names", prop, clk_name) {
382 subsys = strchr(clk_name, '-');
384 pd->num_subsys_clks++;
389 pd->clks = devm_kcalloc(scpsys->dev, pd->num_clks, sizeof(*pd->clks), GFP_KERNEL);
391 return ERR_PTR(-ENOMEM);
393 pd->subsys_clks = devm_kcalloc(scpsys->dev, pd->num_subsys_clks,
394 sizeof(*pd->subsys_clks), GFP_KERNEL);
395 if (!pd->subsys_clks)
396 return ERR_PTR(-ENOMEM);
400 for (i = 0; i < pd->num_clks; i++) {
401 clk = of_clk_get(node, i);
404 dev_err_probe(scpsys->dev, ret,
405 "%pOF: failed to get clk at index %d\n", node, i);
409 pd->clks[clk_ind++].clk = clk;
412 for (i = 0; i < pd->num_subsys_clks; i++) {
413 clk = of_clk_get(node, i + clk_ind);
416 dev_err_probe(scpsys->dev, ret,
417 "%pOF: failed to get clk at index %d\n", node,
419 goto err_put_subsys_clocks;
422 pd->subsys_clks[i].clk = clk;
426 * Initially turn on all domains to make the domains usable
427 * with !CONFIG_PM and to get the hardware in sync with the
428 * software. The unused domains will be switched off during
431 if (MTK_SCPD_CAPS(pd, MTK_SCPD_KEEP_DEFAULT_OFF)) {
432 if (scpsys_domain_is_on(pd))
433 dev_warn(scpsys->dev,
434 "%pOF: A default off power domain has been ON\n", node);
436 ret = scpsys_power_on(&pd->genpd);
438 dev_err(scpsys->dev, "%pOF: failed to power on domain: %d\n", node, ret);
439 goto err_put_subsys_clocks;
442 if (MTK_SCPD_CAPS(pd, MTK_SCPD_ALWAYS_ON))
443 pd->genpd.flags |= GENPD_FLAG_ALWAYS_ON;
446 if (scpsys->domains[id]) {
449 "power domain with id %d already exists, check your device-tree\n", id);
450 goto err_put_subsys_clocks;
454 pd->genpd.name = node->name;
456 pd->genpd.name = pd->data->name;
458 pd->genpd.power_off = scpsys_power_off;
459 pd->genpd.power_on = scpsys_power_on;
461 if (MTK_SCPD_CAPS(pd, MTK_SCPD_ACTIVE_WAKEUP))
462 pd->genpd.flags |= GENPD_FLAG_ACTIVE_WAKEUP;
464 if (MTK_SCPD_CAPS(pd, MTK_SCPD_KEEP_DEFAULT_OFF))
465 pm_genpd_init(&pd->genpd, NULL, true);
467 pm_genpd_init(&pd->genpd, NULL, false);
469 scpsys->domains[id] = &pd->genpd;
471 return scpsys->pd_data.domains[id];
473 err_put_subsys_clocks:
474 clk_bulk_put(pd->num_subsys_clks, pd->subsys_clks);
476 clk_bulk_put(pd->num_clks, pd->clks);
480 static int scpsys_add_subdomain(struct scpsys *scpsys, struct device_node *parent)
482 struct generic_pm_domain *child_pd, *parent_pd;
483 struct device_node *child;
486 for_each_child_of_node(parent, child) {
489 ret = of_property_read_u32(parent, "reg", &id);
491 dev_err(scpsys->dev, "%pOF: failed to get parent domain id\n", child);
495 if (!scpsys->pd_data.domains[id]) {
497 dev_err(scpsys->dev, "power domain with id %d does not exist\n", id);
501 parent_pd = scpsys->pd_data.domains[id];
503 child_pd = scpsys_add_one_domain(scpsys, child);
504 if (IS_ERR(child_pd)) {
505 ret = PTR_ERR(child_pd);
506 dev_err_probe(scpsys->dev, ret, "%pOF: failed to get child domain id\n",
511 ret = pm_genpd_add_subdomain(parent_pd, child_pd);
513 dev_err(scpsys->dev, "failed to add %s subdomain to parent %s\n",
514 child_pd->name, parent_pd->name);
517 dev_dbg(scpsys->dev, "%s add subdomain: %s\n", parent_pd->name,
521 /* recursive call to add all subdomains */
522 ret = scpsys_add_subdomain(scpsys, child);
534 static void scpsys_remove_one_domain(struct scpsys_domain *pd)
538 if (scpsys_domain_is_on(pd))
539 scpsys_power_off(&pd->genpd);
542 * We're in the error cleanup already, so we only complain,
543 * but won't emit another error on top of the original one.
545 ret = pm_genpd_remove(&pd->genpd);
547 dev_err(pd->scpsys->dev,
548 "failed to remove domain '%s' : %d - state may be inconsistent\n",
549 pd->genpd.name, ret);
551 clk_bulk_put(pd->num_clks, pd->clks);
552 clk_bulk_put(pd->num_subsys_clks, pd->subsys_clks);
555 static void scpsys_domain_cleanup(struct scpsys *scpsys)
557 struct generic_pm_domain *genpd;
558 struct scpsys_domain *pd;
561 for (i = scpsys->pd_data.num_domains - 1; i >= 0; i--) {
562 genpd = scpsys->pd_data.domains[i];
564 pd = to_scpsys_domain(genpd);
565 scpsys_remove_one_domain(pd);
570 static const struct of_device_id scpsys_of_match[] = {
572 .compatible = "mediatek,mt6795-power-controller",
573 .data = &mt6795_scpsys_data,
576 .compatible = "mediatek,mt8167-power-controller",
577 .data = &mt8167_scpsys_data,
580 .compatible = "mediatek,mt8173-power-controller",
581 .data = &mt8173_scpsys_data,
584 .compatible = "mediatek,mt8183-power-controller",
585 .data = &mt8183_scpsys_data,
588 .compatible = "mediatek,mt8186-power-controller",
589 .data = &mt8186_scpsys_data,
592 .compatible = "mediatek,mt8188-power-controller",
593 .data = &mt8188_scpsys_data,
596 .compatible = "mediatek,mt8192-power-controller",
597 .data = &mt8192_scpsys_data,
600 .compatible = "mediatek,mt8195-power-controller",
601 .data = &mt8195_scpsys_data,
606 static int scpsys_probe(struct platform_device *pdev)
608 struct device *dev = &pdev->dev;
609 struct device_node *np = dev->of_node;
610 const struct scpsys_soc_data *soc;
611 struct device_node *node;
612 struct device *parent;
613 struct scpsys *scpsys;
616 soc = of_device_get_match_data(&pdev->dev);
618 dev_err(&pdev->dev, "no power controller data\n");
622 scpsys = devm_kzalloc(dev, struct_size(scpsys, domains, soc->num_domains), GFP_KERNEL);
627 scpsys->soc_data = soc;
629 scpsys->pd_data.domains = scpsys->domains;
630 scpsys->pd_data.num_domains = soc->num_domains;
632 parent = dev->parent;
634 dev_err(dev, "no parent for syscon devices\n");
638 scpsys->base = syscon_node_to_regmap(parent->of_node);
639 if (IS_ERR(scpsys->base)) {
640 dev_err(dev, "no regmap available\n");
641 return PTR_ERR(scpsys->base);
645 for_each_available_child_of_node(np, node) {
646 struct generic_pm_domain *domain;
648 domain = scpsys_add_one_domain(scpsys, node);
649 if (IS_ERR(domain)) {
650 ret = PTR_ERR(domain);
652 goto err_cleanup_domains;
655 ret = scpsys_add_subdomain(scpsys, node);
658 goto err_cleanup_domains;
663 dev_dbg(dev, "no power domains present\n");
667 ret = of_genpd_add_provider_onecell(np, &scpsys->pd_data);
669 dev_err(dev, "failed to add provider: %d\n", ret);
670 goto err_cleanup_domains;
676 scpsys_domain_cleanup(scpsys);
680 static struct platform_driver scpsys_pm_domain_driver = {
681 .probe = scpsys_probe,
683 .name = "mtk-power-controller",
684 .suppress_bind_attrs = true,
685 .of_match_table = scpsys_of_match,
688 builtin_platform_driver(scpsys_pm_domain_driver);