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 "mt8192-pm-domains.h"
24 #define MTK_POLL_DELAY_US 10
25 #define MTK_POLL_TIMEOUT USEC_PER_SEC
27 #define PWR_RST_B_BIT BIT(0)
28 #define PWR_ISO_BIT BIT(1)
29 #define PWR_ON_BIT BIT(2)
30 #define PWR_ON_2ND_BIT BIT(3)
31 #define PWR_CLK_DIS_BIT BIT(4)
32 #define PWR_SRAM_CLKISO_BIT BIT(5)
33 #define PWR_SRAM_ISOINT_B_BIT BIT(6)
35 struct scpsys_domain {
36 struct generic_pm_domain genpd;
37 const struct scpsys_domain_data *data;
38 struct scpsys *scpsys;
40 struct clk_bulk_data *clks;
42 struct clk_bulk_data *subsys_clks;
43 struct regmap *infracfg;
45 struct regulator *supply;
51 const struct scpsys_soc_data *soc_data;
52 struct genpd_onecell_data pd_data;
53 struct generic_pm_domain *domains[];
56 #define to_scpsys_domain(gpd) container_of(gpd, struct scpsys_domain, genpd)
58 static bool scpsys_domain_is_on(struct scpsys_domain *pd)
60 struct scpsys *scpsys = pd->scpsys;
63 regmap_read(scpsys->base, scpsys->soc_data->pwr_sta_offs, &status);
64 status &= pd->data->sta_mask;
66 regmap_read(scpsys->base, scpsys->soc_data->pwr_sta2nd_offs, &status2);
67 status2 &= pd->data->sta_mask;
69 /* A domain is on when both status bits are set. */
70 return status && status2;
73 static int scpsys_sram_enable(struct scpsys_domain *pd)
75 u32 pdn_ack = pd->data->sram_pdn_ack_bits;
76 struct scpsys *scpsys = pd->scpsys;
80 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, pd->data->sram_pdn_bits);
82 /* Either wait until SRAM_PDN_ACK all 1 or 0 */
83 ret = regmap_read_poll_timeout(scpsys->base, pd->data->ctl_offs, tmp,
84 (tmp & pdn_ack) == 0, MTK_POLL_DELAY_US, MTK_POLL_TIMEOUT);
88 if (MTK_SCPD_CAPS(pd, MTK_SCPD_SRAM_ISO)) {
89 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_SRAM_ISOINT_B_BIT);
91 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_SRAM_CLKISO_BIT);
97 static int scpsys_sram_disable(struct scpsys_domain *pd)
99 u32 pdn_ack = pd->data->sram_pdn_ack_bits;
100 struct scpsys *scpsys = pd->scpsys;
103 if (MTK_SCPD_CAPS(pd, MTK_SCPD_SRAM_ISO)) {
104 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_SRAM_CLKISO_BIT);
106 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_SRAM_ISOINT_B_BIT);
109 regmap_set_bits(scpsys->base, pd->data->ctl_offs, pd->data->sram_pdn_bits);
111 /* Either wait until SRAM_PDN_ACK all 1 or 0 */
112 return regmap_read_poll_timeout(scpsys->base, pd->data->ctl_offs, tmp,
113 (tmp & pdn_ack) == pdn_ack, MTK_POLL_DELAY_US,
117 static int _scpsys_bus_protect_enable(const struct scpsys_bus_prot_data *bpd, struct regmap *regmap)
121 for (i = 0; i < SPM_MAX_BUS_PROT_DATA; i++) {
122 u32 val, mask = bpd[i].bus_prot_mask;
127 if (bpd[i].bus_prot_reg_update)
128 regmap_set_bits(regmap, bpd[i].bus_prot_set, mask);
130 regmap_write(regmap, bpd[i].bus_prot_set, mask);
132 ret = regmap_read_poll_timeout(regmap, bpd[i].bus_prot_sta,
133 val, (val & mask) == mask,
134 MTK_POLL_DELAY_US, MTK_POLL_TIMEOUT);
142 static int scpsys_bus_protect_enable(struct scpsys_domain *pd)
146 ret = _scpsys_bus_protect_enable(pd->data->bp_infracfg, pd->infracfg);
150 return _scpsys_bus_protect_enable(pd->data->bp_smi, pd->smi);
153 static int _scpsys_bus_protect_disable(const struct scpsys_bus_prot_data *bpd,
154 struct regmap *regmap)
158 for (i = SPM_MAX_BUS_PROT_DATA - 1; i >= 0; i--) {
159 u32 val, mask = bpd[i].bus_prot_mask;
164 if (bpd[i].bus_prot_reg_update)
165 regmap_clear_bits(regmap, bpd[i].bus_prot_clr, mask);
167 regmap_write(regmap, bpd[i].bus_prot_clr, mask);
169 if (bpd[i].ignore_clr_ack)
172 ret = regmap_read_poll_timeout(regmap, bpd[i].bus_prot_sta,
174 MTK_POLL_DELAY_US, MTK_POLL_TIMEOUT);
182 static int scpsys_bus_protect_disable(struct scpsys_domain *pd)
186 ret = _scpsys_bus_protect_disable(pd->data->bp_smi, pd->smi);
190 return _scpsys_bus_protect_disable(pd->data->bp_infracfg, pd->infracfg);
193 static int scpsys_regulator_enable(struct regulator *supply)
195 return supply ? regulator_enable(supply) : 0;
198 static int scpsys_regulator_disable(struct regulator *supply)
200 return supply ? regulator_disable(supply) : 0;
203 static int scpsys_power_on(struct generic_pm_domain *genpd)
205 struct scpsys_domain *pd = container_of(genpd, struct scpsys_domain, genpd);
206 struct scpsys *scpsys = pd->scpsys;
210 ret = scpsys_regulator_enable(pd->supply);
214 ret = clk_bulk_prepare_enable(pd->num_clks, pd->clks);
218 /* subsys power on */
219 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_ON_BIT);
220 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_ON_2ND_BIT);
222 /* wait until PWR_ACK = 1 */
223 ret = readx_poll_timeout(scpsys_domain_is_on, pd, tmp, tmp, MTK_POLL_DELAY_US,
228 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_CLK_DIS_BIT);
229 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_ISO_BIT);
230 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_RST_B_BIT);
232 ret = clk_bulk_prepare_enable(pd->num_subsys_clks, pd->subsys_clks);
236 ret = scpsys_sram_enable(pd);
238 goto err_disable_subsys_clks;
240 ret = scpsys_bus_protect_disable(pd);
242 goto err_disable_sram;
247 scpsys_sram_disable(pd);
248 err_disable_subsys_clks:
249 clk_bulk_disable_unprepare(pd->num_subsys_clks, pd->subsys_clks);
251 clk_bulk_disable_unprepare(pd->num_clks, pd->clks);
253 scpsys_regulator_disable(pd->supply);
257 static int scpsys_power_off(struct generic_pm_domain *genpd)
259 struct scpsys_domain *pd = container_of(genpd, struct scpsys_domain, genpd);
260 struct scpsys *scpsys = pd->scpsys;
264 ret = scpsys_bus_protect_enable(pd);
268 ret = scpsys_sram_disable(pd);
272 clk_bulk_disable_unprepare(pd->num_subsys_clks, pd->subsys_clks);
274 /* subsys power off */
275 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_RST_B_BIT);
276 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_ISO_BIT);
277 regmap_set_bits(scpsys->base, pd->data->ctl_offs, PWR_CLK_DIS_BIT);
278 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_ON_2ND_BIT);
279 regmap_clear_bits(scpsys->base, pd->data->ctl_offs, PWR_ON_BIT);
281 /* wait until PWR_ACK = 0 */
282 ret = readx_poll_timeout(scpsys_domain_is_on, pd, tmp, !tmp, MTK_POLL_DELAY_US,
287 clk_bulk_disable_unprepare(pd->num_clks, pd->clks);
289 scpsys_regulator_disable(pd->supply);
295 generic_pm_domain *scpsys_add_one_domain(struct scpsys *scpsys, struct device_node *node)
297 const struct scpsys_domain_data *domain_data;
298 struct scpsys_domain *pd;
299 struct device_node *root_node = scpsys->dev->of_node;
300 struct device_node *smi_node;
301 struct property *prop;
302 const char *clk_name;
303 int i, ret, num_clks;
308 ret = of_property_read_u32(node, "reg", &id);
310 dev_err(scpsys->dev, "%pOF: failed to retrieve domain id from reg: %d\n",
312 return ERR_PTR(-EINVAL);
315 if (id >= scpsys->soc_data->num_domains) {
316 dev_err(scpsys->dev, "%pOF: invalid domain id %d\n", node, id);
317 return ERR_PTR(-EINVAL);
320 domain_data = &scpsys->soc_data->domains_data[id];
321 if (domain_data->sta_mask == 0) {
322 dev_err(scpsys->dev, "%pOF: undefined domain id %d\n", node, id);
323 return ERR_PTR(-EINVAL);
326 pd = devm_kzalloc(scpsys->dev, sizeof(*pd), GFP_KERNEL);
328 return ERR_PTR(-ENOMEM);
330 pd->data = domain_data;
333 if (MTK_SCPD_CAPS(pd, MTK_SCPD_DOMAIN_SUPPLY)) {
335 * Find regulator in current power domain node.
336 * devm_regulator_get() finds regulator in a node and its child
337 * node, so set of_node to current power domain node then change
338 * back to original node after regulator is found for current
341 scpsys->dev->of_node = node;
342 pd->supply = devm_regulator_get(scpsys->dev, "domain");
343 scpsys->dev->of_node = root_node;
344 if (IS_ERR(pd->supply)) {
345 dev_err_probe(scpsys->dev, PTR_ERR(pd->supply),
346 "%pOF: failed to get power supply.\n",
348 return ERR_CAST(pd->supply);
352 pd->infracfg = syscon_regmap_lookup_by_phandle_optional(node, "mediatek,infracfg");
353 if (IS_ERR(pd->infracfg))
354 return ERR_CAST(pd->infracfg);
356 smi_node = of_parse_phandle(node, "mediatek,smi", 0);
358 pd->smi = device_node_to_regmap(smi_node);
359 of_node_put(smi_node);
361 return ERR_CAST(pd->smi);
364 num_clks = of_clk_get_parent_count(node);
366 /* Calculate number of subsys_clks */
367 of_property_for_each_string(node, "clock-names", prop, clk_name) {
370 subsys = strchr(clk_name, '-');
372 pd->num_subsys_clks++;
377 pd->clks = devm_kcalloc(scpsys->dev, pd->num_clks, sizeof(*pd->clks), GFP_KERNEL);
379 return ERR_PTR(-ENOMEM);
381 pd->subsys_clks = devm_kcalloc(scpsys->dev, pd->num_subsys_clks,
382 sizeof(*pd->subsys_clks), GFP_KERNEL);
383 if (!pd->subsys_clks)
384 return ERR_PTR(-ENOMEM);
388 for (i = 0; i < pd->num_clks; i++) {
389 clk = of_clk_get(node, i);
392 dev_err_probe(scpsys->dev, ret,
393 "%pOF: failed to get clk at index %d: %d\n", node, i, ret);
397 pd->clks[clk_ind++].clk = clk;
400 for (i = 0; i < pd->num_subsys_clks; i++) {
401 clk = of_clk_get(node, i + clk_ind);
404 dev_err_probe(scpsys->dev, ret,
405 "%pOF: failed to get clk at index %d: %d\n", node,
407 goto err_put_subsys_clocks;
410 pd->subsys_clks[i].clk = clk;
414 * Initially turn on all domains to make the domains usable
415 * with !CONFIG_PM and to get the hardware in sync with the
416 * software. The unused domains will be switched off during
419 if (MTK_SCPD_CAPS(pd, MTK_SCPD_KEEP_DEFAULT_OFF)) {
420 if (scpsys_domain_is_on(pd))
421 dev_warn(scpsys->dev,
422 "%pOF: A default off power domain has been ON\n", node);
424 ret = scpsys_power_on(&pd->genpd);
426 dev_err(scpsys->dev, "%pOF: failed to power on domain: %d\n", node, ret);
427 goto err_put_subsys_clocks;
431 if (scpsys->domains[id]) {
434 "power domain with id %d already exists, check your device-tree\n", id);
435 goto err_put_subsys_clocks;
439 pd->genpd.name = node->name;
441 pd->genpd.name = pd->data->name;
443 pd->genpd.power_off = scpsys_power_off;
444 pd->genpd.power_on = scpsys_power_on;
446 if (MTK_SCPD_CAPS(pd, MTK_SCPD_KEEP_DEFAULT_OFF))
447 pm_genpd_init(&pd->genpd, NULL, true);
449 pm_genpd_init(&pd->genpd, NULL, false);
451 scpsys->domains[id] = &pd->genpd;
453 return scpsys->pd_data.domains[id];
455 err_put_subsys_clocks:
456 clk_bulk_put(pd->num_subsys_clks, pd->subsys_clks);
458 clk_bulk_put(pd->num_clks, pd->clks);
462 static int scpsys_add_subdomain(struct scpsys *scpsys, struct device_node *parent)
464 struct generic_pm_domain *child_pd, *parent_pd;
465 struct device_node *child;
468 for_each_child_of_node(parent, child) {
471 ret = of_property_read_u32(parent, "reg", &id);
473 dev_err(scpsys->dev, "%pOF: failed to get parent domain id\n", child);
477 if (!scpsys->pd_data.domains[id]) {
479 dev_err(scpsys->dev, "power domain with id %d does not exist\n", id);
483 parent_pd = scpsys->pd_data.domains[id];
485 child_pd = scpsys_add_one_domain(scpsys, child);
486 if (IS_ERR(child_pd)) {
487 ret = PTR_ERR(child_pd);
488 dev_err_probe(scpsys->dev, ret, "%pOF: failed to get child domain id\n",
493 ret = pm_genpd_add_subdomain(parent_pd, child_pd);
495 dev_err(scpsys->dev, "failed to add %s subdomain to parent %s\n",
496 child_pd->name, parent_pd->name);
499 dev_dbg(scpsys->dev, "%s add subdomain: %s\n", parent_pd->name,
503 /* recursive call to add all subdomains */
504 ret = scpsys_add_subdomain(scpsys, child);
516 static void scpsys_remove_one_domain(struct scpsys_domain *pd)
520 if (scpsys_domain_is_on(pd))
521 scpsys_power_off(&pd->genpd);
524 * We're in the error cleanup already, so we only complain,
525 * but won't emit another error on top of the original one.
527 ret = pm_genpd_remove(&pd->genpd);
529 dev_err(pd->scpsys->dev,
530 "failed to remove domain '%s' : %d - state may be inconsistent\n",
531 pd->genpd.name, ret);
533 clk_bulk_put(pd->num_clks, pd->clks);
534 clk_bulk_put(pd->num_subsys_clks, pd->subsys_clks);
537 static void scpsys_domain_cleanup(struct scpsys *scpsys)
539 struct generic_pm_domain *genpd;
540 struct scpsys_domain *pd;
543 for (i = scpsys->pd_data.num_domains - 1; i >= 0; i--) {
544 genpd = scpsys->pd_data.domains[i];
546 pd = to_scpsys_domain(genpd);
547 scpsys_remove_one_domain(pd);
552 static const struct of_device_id scpsys_of_match[] = {
554 .compatible = "mediatek,mt8167-power-controller",
555 .data = &mt8167_scpsys_data,
558 .compatible = "mediatek,mt8173-power-controller",
559 .data = &mt8173_scpsys_data,
562 .compatible = "mediatek,mt8183-power-controller",
563 .data = &mt8183_scpsys_data,
566 .compatible = "mediatek,mt8192-power-controller",
567 .data = &mt8192_scpsys_data,
572 static int scpsys_probe(struct platform_device *pdev)
574 struct device *dev = &pdev->dev;
575 struct device_node *np = dev->of_node;
576 const struct scpsys_soc_data *soc;
577 struct device_node *node;
578 struct device *parent;
579 struct scpsys *scpsys;
582 soc = of_device_get_match_data(&pdev->dev);
584 dev_err(&pdev->dev, "no power controller data\n");
588 scpsys = devm_kzalloc(dev, struct_size(scpsys, domains, soc->num_domains), GFP_KERNEL);
593 scpsys->soc_data = soc;
595 scpsys->pd_data.domains = scpsys->domains;
596 scpsys->pd_data.num_domains = soc->num_domains;
598 parent = dev->parent;
600 dev_err(dev, "no parent for syscon devices\n");
604 scpsys->base = syscon_node_to_regmap(parent->of_node);
605 if (IS_ERR(scpsys->base)) {
606 dev_err(dev, "no regmap available\n");
607 return PTR_ERR(scpsys->base);
611 for_each_available_child_of_node(np, node) {
612 struct generic_pm_domain *domain;
614 domain = scpsys_add_one_domain(scpsys, node);
615 if (IS_ERR(domain)) {
616 ret = PTR_ERR(domain);
618 goto err_cleanup_domains;
621 ret = scpsys_add_subdomain(scpsys, node);
624 goto err_cleanup_domains;
629 dev_dbg(dev, "no power domains present\n");
633 ret = of_genpd_add_provider_onecell(np, &scpsys->pd_data);
635 dev_err(dev, "failed to add provider: %d\n", ret);
636 goto err_cleanup_domains;
642 scpsys_domain_cleanup(scpsys);
646 static struct platform_driver scpsys_pm_domain_driver = {
647 .probe = scpsys_probe,
649 .name = "mtk-power-controller",
650 .suppress_bind_attrs = true,
651 .of_match_table = scpsys_of_match,
654 builtin_platform_driver(scpsys_pm_domain_driver);