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"
27 #include "mt8365-pm-domains.h"
29 #define MTK_POLL_DELAY_US 10
30 #define MTK_POLL_TIMEOUT USEC_PER_SEC
32 #define PWR_RST_B_BIT BIT(0)
33 #define PWR_ISO_BIT BIT(1)
34 #define PWR_ON_BIT BIT(2)
35 #define PWR_ON_2ND_BIT BIT(3)
36 #define PWR_CLK_DIS_BIT BIT(4)
37 #define PWR_SRAM_CLKISO_BIT BIT(5)
38 #define PWR_SRAM_ISOINT_B_BIT BIT(6)
40 struct scpsys_domain {
41 struct generic_pm_domain genpd;
42 const struct scpsys_domain_data *data;
43 struct scpsys *scpsys;
45 struct clk_bulk_data *clks;
47 struct clk_bulk_data *subsys_clks;
48 struct regmap *infracfg_nao;
49 struct regmap *infracfg;
51 struct regulator *supply;
57 const struct scpsys_soc_data *soc_data;
58 struct genpd_onecell_data pd_data;
59 struct generic_pm_domain *domains[];
62 #define to_scpsys_domain(gpd) container_of(gpd, struct scpsys_domain, genpd)
64 static bool scpsys_domain_is_on(struct scpsys_domain *pd)
66 struct scpsys *scpsys = pd->scpsys;
69 regmap_read(scpsys->base, pd->data->pwr_sta_offs, &status);
70 status &= pd->data->sta_mask;
72 regmap_read(scpsys->base, pd->data->pwr_sta2nd_offs, &status2);
73 status2 &= pd->data->sta_mask;
75 /* A domain is on when both status bits are set. */
76 return status && status2;
79 static int scpsys_sram_enable(struct scpsys_domain *pd)
81 u32 pdn_ack = pd->data->sram_pdn_ack_bits;
82 struct scpsys *scpsys = pd->scpsys;
86 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, pd->data->sram_pdn_bits);
88 /* Either wait until SRAM_PDN_ACK all 1 or 0 */
89 ret = regmap_read_poll_timeout(scpsys->base, pd->data->ctl_offs, tmp,
90 (tmp & pdn_ack) == 0, MTK_POLL_DELAY_US, MTK_POLL_TIMEOUT);
94 if (MTK_SCPD_CAPS(pd, MTK_SCPD_SRAM_ISO)) {
95 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_SRAM_ISOINT_B_BIT);
97 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_SRAM_CLKISO_BIT);
103 static int scpsys_sram_disable(struct scpsys_domain *pd)
105 u32 pdn_ack = pd->data->sram_pdn_ack_bits;
106 struct scpsys *scpsys = pd->scpsys;
109 if (MTK_SCPD_CAPS(pd, MTK_SCPD_SRAM_ISO)) {
110 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_SRAM_CLKISO_BIT);
112 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_SRAM_ISOINT_B_BIT);
115 regmap_set_bits(scpsys->base, pd->data->ctl_offs, pd->data->sram_pdn_bits);
117 /* Either wait until SRAM_PDN_ACK all 1 or 0 */
118 return regmap_read_poll_timeout(scpsys->base, pd->data->ctl_offs, tmp,
119 (tmp & pdn_ack) == pdn_ack, MTK_POLL_DELAY_US,
123 static struct regmap *scpsys_bus_protect_get_regmap(struct scpsys_domain *pd,
124 const struct scpsys_bus_prot_data *bpd)
126 if (bpd->flags & BUS_PROT_COMPONENT_SMI)
132 static struct regmap *scpsys_bus_protect_get_sta_regmap(struct scpsys_domain *pd,
133 const struct scpsys_bus_prot_data *bpd)
135 if (bpd->flags & BUS_PROT_STA_COMPONENT_INFRA_NAO)
136 return pd->infracfg_nao;
138 return scpsys_bus_protect_get_regmap(pd, bpd);
141 static int scpsys_bus_protect_clear(struct scpsys_domain *pd,
142 const struct scpsys_bus_prot_data *bpd)
144 struct regmap *sta_regmap = scpsys_bus_protect_get_sta_regmap(pd, bpd);
145 struct regmap *regmap = scpsys_bus_protect_get_regmap(pd, bpd);
146 u32 sta_mask = bpd->bus_prot_sta_mask;
150 expected_ack = (bpd->flags & BUS_PROT_STA_COMPONENT_INFRA_NAO ? sta_mask : 0);
152 if (bpd->flags & BUS_PROT_REG_UPDATE)
153 regmap_clear_bits(regmap, bpd->bus_prot_clr, bpd->bus_prot_set_clr_mask);
155 regmap_write(regmap, bpd->bus_prot_clr, bpd->bus_prot_set_clr_mask);
157 if (bpd->flags & BUS_PROT_IGNORE_CLR_ACK)
160 return regmap_read_poll_timeout(sta_regmap, bpd->bus_prot_sta,
161 val, (val & sta_mask) == expected_ack,
162 MTK_POLL_DELAY_US, MTK_POLL_TIMEOUT);
165 static int scpsys_bus_protect_set(struct scpsys_domain *pd,
166 const struct scpsys_bus_prot_data *bpd)
168 struct regmap *sta_regmap = scpsys_bus_protect_get_sta_regmap(pd, bpd);
169 struct regmap *regmap = scpsys_bus_protect_get_regmap(pd, bpd);
170 u32 sta_mask = bpd->bus_prot_sta_mask;
173 if (bpd->flags & BUS_PROT_REG_UPDATE)
174 regmap_set_bits(regmap, bpd->bus_prot_set, bpd->bus_prot_set_clr_mask);
176 regmap_write(regmap, bpd->bus_prot_set, bpd->bus_prot_set_clr_mask);
178 return regmap_read_poll_timeout(sta_regmap, bpd->bus_prot_sta,
179 val, (val & sta_mask) == sta_mask,
180 MTK_POLL_DELAY_US, MTK_POLL_TIMEOUT);
183 static int scpsys_bus_protect_enable(struct scpsys_domain *pd)
185 for (int i = 0; i < SPM_MAX_BUS_PROT_DATA; i++) {
186 const struct scpsys_bus_prot_data *bpd = &pd->data->bp_cfg[i];
189 if (!bpd->bus_prot_set_clr_mask)
192 if (bpd->flags & BUS_PROT_INVERTED)
193 ret = scpsys_bus_protect_clear(pd, bpd);
195 ret = scpsys_bus_protect_set(pd, bpd);
203 static int scpsys_bus_protect_disable(struct scpsys_domain *pd)
205 for (int i = SPM_MAX_BUS_PROT_DATA - 1; i >= 0; i--) {
206 const struct scpsys_bus_prot_data *bpd = &pd->data->bp_cfg[i];
209 if (!bpd->bus_prot_set_clr_mask)
212 if (bpd->flags & BUS_PROT_INVERTED)
213 ret = scpsys_bus_protect_set(pd, bpd);
215 ret = scpsys_bus_protect_clear(pd, bpd);
223 static int scpsys_regulator_enable(struct regulator *supply)
225 return supply ? regulator_enable(supply) : 0;
228 static int scpsys_regulator_disable(struct regulator *supply)
230 return supply ? regulator_disable(supply) : 0;
233 static int scpsys_power_on(struct generic_pm_domain *genpd)
235 struct scpsys_domain *pd = container_of(genpd, struct scpsys_domain, genpd);
236 struct scpsys *scpsys = pd->scpsys;
240 ret = scpsys_regulator_enable(pd->supply);
244 ret = clk_bulk_prepare_enable(pd->num_clks, pd->clks);
248 if (pd->data->ext_buck_iso_offs && MTK_SCPD_CAPS(pd, MTK_SCPD_EXT_BUCK_ISO))
249 regmap_clear_bits(scpsys->base, pd->data->ext_buck_iso_offs,
250 pd->data->ext_buck_iso_mask);
252 /* subsys power on */
253 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_ON_BIT);
254 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_ON_2ND_BIT);
256 /* wait until PWR_ACK = 1 */
257 ret = readx_poll_timeout(scpsys_domain_is_on, pd, tmp, tmp, MTK_POLL_DELAY_US,
262 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_CLK_DIS_BIT);
263 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_ISO_BIT);
264 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_RST_B_BIT);
267 * In few Mediatek platforms(e.g. MT6779), the bus protect policy is
268 * stricter, which leads to bus protect release must be prior to bus
271 if (!MTK_SCPD_CAPS(pd, MTK_SCPD_STRICT_BUS_PROTECTION)) {
272 ret = clk_bulk_prepare_enable(pd->num_subsys_clks,
278 ret = scpsys_sram_enable(pd);
280 goto err_disable_subsys_clks;
282 ret = scpsys_bus_protect_disable(pd);
284 goto err_disable_sram;
286 if (MTK_SCPD_CAPS(pd, MTK_SCPD_STRICT_BUS_PROTECTION)) {
287 ret = clk_bulk_prepare_enable(pd->num_subsys_clks,
290 goto err_enable_bus_protect;
295 err_enable_bus_protect:
296 scpsys_bus_protect_enable(pd);
298 scpsys_sram_disable(pd);
299 err_disable_subsys_clks:
300 if (!MTK_SCPD_CAPS(pd, MTK_SCPD_STRICT_BUS_PROTECTION))
301 clk_bulk_disable_unprepare(pd->num_subsys_clks,
304 clk_bulk_disable_unprepare(pd->num_clks, pd->clks);
306 scpsys_regulator_disable(pd->supply);
310 static int scpsys_power_off(struct generic_pm_domain *genpd)
312 struct scpsys_domain *pd = container_of(genpd, struct scpsys_domain, genpd);
313 struct scpsys *scpsys = pd->scpsys;
317 ret = scpsys_bus_protect_enable(pd);
321 ret = scpsys_sram_disable(pd);
325 if (pd->data->ext_buck_iso_offs && MTK_SCPD_CAPS(pd, MTK_SCPD_EXT_BUCK_ISO))
326 regmap_set_bits(scpsys->base, pd->data->ext_buck_iso_offs,
327 pd->data->ext_buck_iso_mask);
329 clk_bulk_disable_unprepare(pd->num_subsys_clks, pd->subsys_clks);
331 /* subsys power off */
332 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_ISO_BIT);
333 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_CLK_DIS_BIT);
334 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_RST_B_BIT);
335 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_ON_2ND_BIT);
336 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_ON_BIT);
338 /* wait until PWR_ACK = 0 */
339 ret = readx_poll_timeout(scpsys_domain_is_on, pd, tmp, !tmp, MTK_POLL_DELAY_US,
344 clk_bulk_disable_unprepare(pd->num_clks, pd->clks);
346 scpsys_regulator_disable(pd->supply);
352 generic_pm_domain *scpsys_add_one_domain(struct scpsys *scpsys, struct device_node *node)
354 const struct scpsys_domain_data *domain_data;
355 struct scpsys_domain *pd;
356 struct device_node *root_node = scpsys->dev->of_node;
357 struct device_node *smi_node;
358 struct property *prop;
359 const char *clk_name;
360 int i, ret, num_clks;
365 ret = of_property_read_u32(node, "reg", &id);
367 dev_err(scpsys->dev, "%pOF: failed to retrieve domain id from reg: %d\n",
369 return ERR_PTR(-EINVAL);
372 if (id >= scpsys->soc_data->num_domains) {
373 dev_err(scpsys->dev, "%pOF: invalid domain id %d\n", node, id);
374 return ERR_PTR(-EINVAL);
377 domain_data = &scpsys->soc_data->domains_data[id];
378 if (domain_data->sta_mask == 0) {
379 dev_err(scpsys->dev, "%pOF: undefined domain id %d\n", node, id);
380 return ERR_PTR(-EINVAL);
383 pd = devm_kzalloc(scpsys->dev, sizeof(*pd), GFP_KERNEL);
385 return ERR_PTR(-ENOMEM);
387 pd->data = domain_data;
390 if (MTK_SCPD_CAPS(pd, MTK_SCPD_DOMAIN_SUPPLY)) {
392 * Find regulator in current power domain node.
393 * devm_regulator_get() finds regulator in a node and its child
394 * node, so set of_node to current power domain node then change
395 * back to original node after regulator is found for current
398 scpsys->dev->of_node = node;
399 pd->supply = devm_regulator_get(scpsys->dev, "domain");
400 scpsys->dev->of_node = root_node;
401 if (IS_ERR(pd->supply)) {
402 dev_err_probe(scpsys->dev, PTR_ERR(pd->supply),
403 "%pOF: failed to get power supply.\n",
405 return ERR_CAST(pd->supply);
409 pd->infracfg = syscon_regmap_lookup_by_phandle_optional(node, "mediatek,infracfg");
410 if (IS_ERR(pd->infracfg))
411 return ERR_CAST(pd->infracfg);
413 smi_node = of_parse_phandle(node, "mediatek,smi", 0);
415 pd->smi = device_node_to_regmap(smi_node);
416 of_node_put(smi_node);
418 return ERR_CAST(pd->smi);
421 if (MTK_SCPD_CAPS(pd, MTK_SCPD_HAS_INFRA_NAO)) {
422 pd->infracfg_nao = syscon_regmap_lookup_by_phandle(node, "mediatek,infracfg-nao");
423 if (IS_ERR(pd->infracfg_nao))
424 return ERR_CAST(pd->infracfg_nao);
426 pd->infracfg_nao = NULL;
429 num_clks = of_clk_get_parent_count(node);
431 /* Calculate number of subsys_clks */
432 of_property_for_each_string(node, "clock-names", prop, clk_name) {
435 subsys = strchr(clk_name, '-');
437 pd->num_subsys_clks++;
442 pd->clks = devm_kcalloc(scpsys->dev, pd->num_clks, sizeof(*pd->clks), GFP_KERNEL);
444 return ERR_PTR(-ENOMEM);
446 pd->subsys_clks = devm_kcalloc(scpsys->dev, pd->num_subsys_clks,
447 sizeof(*pd->subsys_clks), GFP_KERNEL);
448 if (!pd->subsys_clks)
449 return ERR_PTR(-ENOMEM);
453 for (i = 0; i < pd->num_clks; i++) {
454 clk = of_clk_get(node, i);
457 dev_err_probe(scpsys->dev, ret,
458 "%pOF: failed to get clk at index %d\n", node, i);
462 pd->clks[clk_ind++].clk = clk;
465 for (i = 0; i < pd->num_subsys_clks; i++) {
466 clk = of_clk_get(node, i + clk_ind);
469 dev_err_probe(scpsys->dev, ret,
470 "%pOF: failed to get clk at index %d\n", node,
472 goto err_put_subsys_clocks;
475 pd->subsys_clks[i].clk = clk;
479 * Initially turn on all domains to make the domains usable
480 * with !CONFIG_PM and to get the hardware in sync with the
481 * software. The unused domains will be switched off during
484 if (MTK_SCPD_CAPS(pd, MTK_SCPD_KEEP_DEFAULT_OFF)) {
485 if (scpsys_domain_is_on(pd))
486 dev_warn(scpsys->dev,
487 "%pOF: A default off power domain has been ON\n", node);
489 ret = scpsys_power_on(&pd->genpd);
491 dev_err(scpsys->dev, "%pOF: failed to power on domain: %d\n", node, ret);
492 goto err_put_subsys_clocks;
495 if (MTK_SCPD_CAPS(pd, MTK_SCPD_ALWAYS_ON))
496 pd->genpd.flags |= GENPD_FLAG_ALWAYS_ON;
499 if (scpsys->domains[id]) {
502 "power domain with id %d already exists, check your device-tree\n", id);
503 goto err_put_subsys_clocks;
507 pd->genpd.name = node->name;
509 pd->genpd.name = pd->data->name;
511 pd->genpd.power_off = scpsys_power_off;
512 pd->genpd.power_on = scpsys_power_on;
514 if (MTK_SCPD_CAPS(pd, MTK_SCPD_ACTIVE_WAKEUP))
515 pd->genpd.flags |= GENPD_FLAG_ACTIVE_WAKEUP;
517 if (MTK_SCPD_CAPS(pd, MTK_SCPD_KEEP_DEFAULT_OFF))
518 pm_genpd_init(&pd->genpd, NULL, true);
520 pm_genpd_init(&pd->genpd, NULL, false);
522 scpsys->domains[id] = &pd->genpd;
524 return scpsys->pd_data.domains[id];
526 err_put_subsys_clocks:
527 clk_bulk_put(pd->num_subsys_clks, pd->subsys_clks);
529 clk_bulk_put(pd->num_clks, pd->clks);
533 static int scpsys_add_subdomain(struct scpsys *scpsys, struct device_node *parent)
535 struct generic_pm_domain *child_pd, *parent_pd;
536 struct device_node *child;
539 for_each_child_of_node(parent, child) {
542 ret = of_property_read_u32(parent, "reg", &id);
544 dev_err(scpsys->dev, "%pOF: failed to get parent domain id\n", child);
548 if (!scpsys->pd_data.domains[id]) {
550 dev_err(scpsys->dev, "power domain with id %d does not exist\n", id);
554 parent_pd = scpsys->pd_data.domains[id];
556 child_pd = scpsys_add_one_domain(scpsys, child);
557 if (IS_ERR(child_pd)) {
558 ret = PTR_ERR(child_pd);
559 dev_err_probe(scpsys->dev, ret, "%pOF: failed to get child domain id\n",
564 /* recursive call to add all subdomains */
565 ret = scpsys_add_subdomain(scpsys, child);
569 ret = pm_genpd_add_subdomain(parent_pd, child_pd);
571 dev_err(scpsys->dev, "failed to add %s subdomain to parent %s\n",
572 child_pd->name, parent_pd->name);
575 dev_dbg(scpsys->dev, "%s add subdomain: %s\n", parent_pd->name,
587 static void scpsys_remove_one_domain(struct scpsys_domain *pd)
592 * We're in the error cleanup already, so we only complain,
593 * but won't emit another error on top of the original one.
595 ret = pm_genpd_remove(&pd->genpd);
597 dev_err(pd->scpsys->dev,
598 "failed to remove domain '%s' : %d - state may be inconsistent\n",
599 pd->genpd.name, ret);
600 if (scpsys_domain_is_on(pd))
601 scpsys_power_off(&pd->genpd);
603 clk_bulk_put(pd->num_clks, pd->clks);
604 clk_bulk_put(pd->num_subsys_clks, pd->subsys_clks);
607 static void scpsys_domain_cleanup(struct scpsys *scpsys)
609 struct generic_pm_domain *genpd;
610 struct scpsys_domain *pd;
613 for (i = scpsys->pd_data.num_domains - 1; i >= 0; i--) {
614 genpd = scpsys->pd_data.domains[i];
616 pd = to_scpsys_domain(genpd);
617 scpsys_remove_one_domain(pd);
622 static const struct of_device_id scpsys_of_match[] = {
624 .compatible = "mediatek,mt6795-power-controller",
625 .data = &mt6795_scpsys_data,
628 .compatible = "mediatek,mt8167-power-controller",
629 .data = &mt8167_scpsys_data,
632 .compatible = "mediatek,mt8173-power-controller",
633 .data = &mt8173_scpsys_data,
636 .compatible = "mediatek,mt8183-power-controller",
637 .data = &mt8183_scpsys_data,
640 .compatible = "mediatek,mt8186-power-controller",
641 .data = &mt8186_scpsys_data,
644 .compatible = "mediatek,mt8188-power-controller",
645 .data = &mt8188_scpsys_data,
648 .compatible = "mediatek,mt8192-power-controller",
649 .data = &mt8192_scpsys_data,
652 .compatible = "mediatek,mt8195-power-controller",
653 .data = &mt8195_scpsys_data,
656 .compatible = "mediatek,mt8365-power-controller",
657 .data = &mt8365_scpsys_data,
662 static int scpsys_probe(struct platform_device *pdev)
664 struct device *dev = &pdev->dev;
665 struct device_node *np = dev->of_node;
666 const struct scpsys_soc_data *soc;
667 struct device_node *node;
668 struct device *parent;
669 struct scpsys *scpsys;
672 soc = of_device_get_match_data(&pdev->dev);
674 dev_err(&pdev->dev, "no power controller data\n");
678 scpsys = devm_kzalloc(dev, struct_size(scpsys, domains, soc->num_domains), GFP_KERNEL);
683 scpsys->soc_data = soc;
685 scpsys->pd_data.domains = scpsys->domains;
686 scpsys->pd_data.num_domains = soc->num_domains;
688 parent = dev->parent;
690 dev_err(dev, "no parent for syscon devices\n");
694 scpsys->base = syscon_node_to_regmap(parent->of_node);
695 if (IS_ERR(scpsys->base)) {
696 dev_err(dev, "no regmap available\n");
697 return PTR_ERR(scpsys->base);
701 for_each_available_child_of_node(np, node) {
702 struct generic_pm_domain *domain;
704 domain = scpsys_add_one_domain(scpsys, node);
705 if (IS_ERR(domain)) {
706 ret = PTR_ERR(domain);
708 goto err_cleanup_domains;
711 ret = scpsys_add_subdomain(scpsys, node);
714 goto err_cleanup_domains;
719 dev_dbg(dev, "no power domains present\n");
723 ret = of_genpd_add_provider_onecell(np, &scpsys->pd_data);
725 dev_err(dev, "failed to add provider: %d\n", ret);
726 goto err_cleanup_domains;
732 scpsys_domain_cleanup(scpsys);
736 static struct platform_driver scpsys_pm_domain_driver = {
737 .probe = scpsys_probe,
739 .name = "mtk-power-controller",
740 .suppress_bind_attrs = true,
741 .of_match_table = scpsys_of_match,
744 builtin_platform_driver(scpsys_pm_domain_driver);