2 * Renesas Clock Pulse Generator / Module Standby and Software Reset
4 * Copyright (C) 2015 Glider bvba
6 * Based on clk-mstp.c, clk-rcar-gen2.c, and clk-rcar-gen3.c
8 * Copyright (C) 2013 Ideas On Board SPRL
9 * Copyright (C) 2015 Renesas Electronics Corp.
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; version 2 of the License.
16 #include <linux/clk.h>
17 #include <linux/clk-provider.h>
18 #include <linux/clk/renesas.h>
19 #include <linux/delay.h>
20 #include <linux/device.h>
21 #include <linux/init.h>
22 #include <linux/mod_devicetable.h>
23 #include <linux/module.h>
24 #include <linux/of_address.h>
25 #include <linux/of_device.h>
26 #include <linux/platform_device.h>
27 #include <linux/pm_clock.h>
28 #include <linux/pm_domain.h>
29 #include <linux/reset-controller.h>
30 #include <linux/slab.h>
32 #include <dt-bindings/clock/renesas-cpg-mssr.h>
34 #include "renesas-cpg-mssr.h"
38 #define WARN_DEBUG(x) WARN_ON(x)
40 #define WARN_DEBUG(x) do { } while (0)
45 * Module Standby and Software Reset register offets.
47 * If the registers exist, these are valid for SH-Mobile, R-Mobile,
48 * R-Car Gen2, R-Car Gen3, and RZ/G1.
49 * These are NOT valid for R-Car Gen1 and RZ/A1!
53 * Module Stop Status Register offsets
56 static const u16 mstpsr[] = {
57 0x030, 0x038, 0x040, 0x048, 0x04C, 0x03C, 0x1C0, 0x1C4,
58 0x9A0, 0x9A4, 0x9A8, 0x9AC,
61 #define MSTPSR(i) mstpsr[i]
65 * System Module Stop Control Register offsets
68 static const u16 smstpcr[] = {
69 0x130, 0x134, 0x138, 0x13C, 0x140, 0x144, 0x148, 0x14C,
70 0x990, 0x994, 0x998, 0x99C,
73 #define SMSTPCR(i) smstpcr[i]
77 * Software Reset Register offsets
80 static const u16 srcr[] = {
81 0x0A0, 0x0A8, 0x0B0, 0x0B8, 0x0BC, 0x0C4, 0x1C8, 0x1CC,
82 0x920, 0x924, 0x928, 0x92C,
85 #define SRCR(i) srcr[i]
88 /* Realtime Module Stop Control Register offsets */
89 #define RMSTPCR(i) (smstpcr[i] - 0x20)
91 /* Modem Module Stop Control Register offsets (r8a73a4) */
92 #define MMSTPCR(i) (smstpcr[i] + 0x20)
94 /* Software Reset Clearing Register offsets */
95 #define SRSTCLR(i) (0x940 + (i) * 4)
99 * Clock Pulse Generator / Module Standby and Software Reset Private Data
101 * @rcdev: Optional reset controller entity
102 * @dev: CPG/MSSR device
103 * @base: CPG/MSSR register block base address
104 * @rmw_lock: protects RMW register accesses
105 * @clks: Array containing all Core and Module Clocks
106 * @num_core_clks: Number of Core Clocks in clks[]
107 * @num_mod_clks: Number of Module Clocks in clks[]
108 * @last_dt_core_clk: ID of the last Core Clock exported to DT
110 struct cpg_mssr_priv {
111 #ifdef CONFIG_RESET_CONTROLLER
112 struct reset_controller_dev rcdev;
119 unsigned int num_core_clks;
120 unsigned int num_mod_clks;
121 unsigned int last_dt_core_clk;
126 * struct mstp_clock - MSTP gating clock
127 * @hw: handle between common and hardware-specific interfaces
128 * @index: MSTP clock number
129 * @priv: CPG/MSSR private data
134 struct cpg_mssr_priv *priv;
137 #define to_mstp_clock(_hw) container_of(_hw, struct mstp_clock, hw)
139 static int cpg_mstp_clock_endisable(struct clk_hw *hw, bool enable)
141 struct mstp_clock *clock = to_mstp_clock(hw);
142 struct cpg_mssr_priv *priv = clock->priv;
143 unsigned int reg = clock->index / 32;
144 unsigned int bit = clock->index % 32;
145 struct device *dev = priv->dev;
146 u32 bitmask = BIT(bit);
151 dev_dbg(dev, "MSTP %u%02u/%pC %s\n", reg, bit, hw->clk,
152 enable ? "ON" : "OFF");
153 spin_lock_irqsave(&priv->rmw_lock, flags);
155 value = readl(priv->base + SMSTPCR(reg));
160 writel(value, priv->base + SMSTPCR(reg));
162 spin_unlock_irqrestore(&priv->rmw_lock, flags);
167 for (i = 1000; i > 0; --i) {
168 if (!(readl(priv->base + MSTPSR(reg)) & bitmask))
174 dev_err(dev, "Failed to enable SMSTP %p[%d]\n",
175 priv->base + SMSTPCR(reg), bit);
182 static int cpg_mstp_clock_enable(struct clk_hw *hw)
184 return cpg_mstp_clock_endisable(hw, true);
187 static void cpg_mstp_clock_disable(struct clk_hw *hw)
189 cpg_mstp_clock_endisable(hw, false);
192 static int cpg_mstp_clock_is_enabled(struct clk_hw *hw)
194 struct mstp_clock *clock = to_mstp_clock(hw);
195 struct cpg_mssr_priv *priv = clock->priv;
198 value = readl(priv->base + MSTPSR(clock->index / 32));
200 return !(value & BIT(clock->index % 32));
203 static const struct clk_ops cpg_mstp_clock_ops = {
204 .enable = cpg_mstp_clock_enable,
205 .disable = cpg_mstp_clock_disable,
206 .is_enabled = cpg_mstp_clock_is_enabled,
210 struct clk *cpg_mssr_clk_src_twocell_get(struct of_phandle_args *clkspec,
213 unsigned int clkidx = clkspec->args[1];
214 struct cpg_mssr_priv *priv = data;
215 struct device *dev = priv->dev;
220 switch (clkspec->args[0]) {
223 if (clkidx > priv->last_dt_core_clk) {
224 dev_err(dev, "Invalid %s clock index %u\n", type,
226 return ERR_PTR(-EINVAL);
228 clk = priv->clks[clkidx];
233 idx = MOD_CLK_PACK(clkidx);
234 if (clkidx % 100 > 31 || idx >= priv->num_mod_clks) {
235 dev_err(dev, "Invalid %s clock index %u\n", type,
237 return ERR_PTR(-EINVAL);
239 clk = priv->clks[priv->num_core_clks + idx];
243 dev_err(dev, "Invalid CPG clock type %u\n", clkspec->args[0]);
244 return ERR_PTR(-EINVAL);
248 dev_err(dev, "Cannot get %s clock %u: %ld", type, clkidx,
251 dev_dbg(dev, "clock (%u, %u) is %pC at %lu Hz\n",
252 clkspec->args[0], clkspec->args[1], clk,
257 static void __init cpg_mssr_register_core_clk(const struct cpg_core_clk *core,
258 const struct cpg_mssr_info *info,
259 struct cpg_mssr_priv *priv)
261 struct clk *clk = ERR_PTR(-ENOTSUPP), *parent;
262 struct device *dev = priv->dev;
263 unsigned int id = core->id, div = core->div;
264 const char *parent_name;
266 WARN_DEBUG(id >= priv->num_core_clks);
267 WARN_DEBUG(PTR_ERR(priv->clks[id]) != -ENOENT);
270 /* Skip NULLified clock */
274 switch (core->type) {
276 clk = of_clk_get_by_name(priv->dev->of_node, core->name);
280 case CLK_TYPE_DIV6P1:
281 case CLK_TYPE_DIV6_RO:
282 WARN_DEBUG(core->parent >= priv->num_core_clks);
283 parent = priv->clks[core->parent];
284 if (IS_ERR(parent)) {
289 parent_name = __clk_get_name(parent);
291 if (core->type == CLK_TYPE_DIV6_RO)
292 /* Multiply with the DIV6 register value */
293 div *= (readl(priv->base + core->offset) & 0x3f) + 1;
295 if (core->type == CLK_TYPE_DIV6P1) {
296 clk = cpg_div6_register(core->name, 1, &parent_name,
297 priv->base + core->offset);
299 clk = clk_register_fixed_factor(NULL, core->name,
306 if (info->cpg_clk_register)
307 clk = info->cpg_clk_register(dev, core, info,
308 priv->clks, priv->base);
310 dev_err(dev, "%s has unsupported core clock type %u\n",
311 core->name, core->type);
315 if (IS_ERR_OR_NULL(clk))
318 dev_dbg(dev, "Core clock %pC at %lu Hz\n", clk, clk_get_rate(clk));
319 priv->clks[id] = clk;
323 dev_err(dev, "Failed to register %s clock %s: %ld\n", "core",
324 core->name, PTR_ERR(clk));
327 static void __init cpg_mssr_register_mod_clk(const struct mssr_mod_clk *mod,
328 const struct cpg_mssr_info *info,
329 struct cpg_mssr_priv *priv)
331 struct mstp_clock *clock = NULL;
332 struct device *dev = priv->dev;
333 unsigned int id = mod->id;
334 struct clk_init_data init;
335 struct clk *parent, *clk;
336 const char *parent_name;
339 WARN_DEBUG(id < priv->num_core_clks);
340 WARN_DEBUG(id >= priv->num_core_clks + priv->num_mod_clks);
341 WARN_DEBUG(mod->parent >= priv->num_core_clks + priv->num_mod_clks);
342 WARN_DEBUG(PTR_ERR(priv->clks[id]) != -ENOENT);
345 /* Skip NULLified clock */
349 parent = priv->clks[mod->parent];
350 if (IS_ERR(parent)) {
355 clock = kzalloc(sizeof(*clock), GFP_KERNEL);
357 clk = ERR_PTR(-ENOMEM);
361 init.name = mod->name;
362 init.ops = &cpg_mstp_clock_ops;
363 init.flags = CLK_IS_BASIC | CLK_SET_RATE_PARENT;
364 for (i = 0; i < info->num_crit_mod_clks; i++)
365 if (id == info->crit_mod_clks[i]) {
366 dev_dbg(dev, "MSTP %s setting CLK_IS_CRITICAL\n",
368 init.flags |= CLK_IS_CRITICAL;
372 parent_name = __clk_get_name(parent);
373 init.parent_names = &parent_name;
374 init.num_parents = 1;
376 clock->index = id - priv->num_core_clks;
378 clock->hw.init = &init;
380 clk = clk_register(NULL, &clock->hw);
384 dev_dbg(dev, "Module clock %pC at %lu Hz\n", clk, clk_get_rate(clk));
385 priv->clks[id] = clk;
389 dev_err(dev, "Failed to register %s clock %s: %ld\n", "module",
390 mod->name, PTR_ERR(clk));
394 struct cpg_mssr_clk_domain {
395 struct generic_pm_domain genpd;
396 struct device_node *np;
397 unsigned int num_core_pm_clks;
398 unsigned int core_pm_clks[0];
401 static struct cpg_mssr_clk_domain *cpg_mssr_clk_domain;
403 static bool cpg_mssr_is_pm_clk(const struct of_phandle_args *clkspec,
404 struct cpg_mssr_clk_domain *pd)
408 if (clkspec->np != pd->np || clkspec->args_count != 2)
411 switch (clkspec->args[0]) {
413 for (i = 0; i < pd->num_core_pm_clks; i++)
414 if (clkspec->args[1] == pd->core_pm_clks[i])
426 int cpg_mssr_attach_dev(struct generic_pm_domain *unused, struct device *dev)
428 struct cpg_mssr_clk_domain *pd = cpg_mssr_clk_domain;
429 struct device_node *np = dev->of_node;
430 struct of_phandle_args clkspec;
436 dev_dbg(dev, "CPG/MSSR clock domain not yet available\n");
437 return -EPROBE_DEFER;
440 while (!of_parse_phandle_with_args(np, "clocks", "#clock-cells", i,
442 if (cpg_mssr_is_pm_clk(&clkspec, pd))
445 of_node_put(clkspec.np);
452 clk = of_clk_get_from_provider(&clkspec);
453 of_node_put(clkspec.np);
458 error = pm_clk_create(dev);
460 dev_err(dev, "pm_clk_create failed %d\n", error);
464 error = pm_clk_add_clk(dev, clk);
466 dev_err(dev, "pm_clk_add_clk %pC failed %d\n", clk, error);
479 void cpg_mssr_detach_dev(struct generic_pm_domain *unused, struct device *dev)
481 if (!pm_clk_no_clocks(dev))
485 static int __init cpg_mssr_add_clk_domain(struct device *dev,
486 const unsigned int *core_pm_clks,
487 unsigned int num_core_pm_clks)
489 struct device_node *np = dev->of_node;
490 struct generic_pm_domain *genpd;
491 struct cpg_mssr_clk_domain *pd;
492 size_t pm_size = num_core_pm_clks * sizeof(core_pm_clks[0]);
494 pd = devm_kzalloc(dev, sizeof(*pd) + pm_size, GFP_KERNEL);
499 pd->num_core_pm_clks = num_core_pm_clks;
500 memcpy(pd->core_pm_clks, core_pm_clks, pm_size);
503 genpd->name = np->name;
504 genpd->flags = GENPD_FLAG_PM_CLK;
505 genpd->attach_dev = cpg_mssr_attach_dev;
506 genpd->detach_dev = cpg_mssr_detach_dev;
507 pm_genpd_init(genpd, &pm_domain_always_on_gov, false);
508 cpg_mssr_clk_domain = pd;
510 of_genpd_add_provider_simple(np, genpd);
514 #ifdef CONFIG_RESET_CONTROLLER
516 #define rcdev_to_priv(x) container_of(x, struct cpg_mssr_priv, rcdev)
518 static int cpg_mssr_reset(struct reset_controller_dev *rcdev,
521 struct cpg_mssr_priv *priv = rcdev_to_priv(rcdev);
522 unsigned int reg = id / 32;
523 unsigned int bit = id % 32;
524 u32 bitmask = BIT(bit);
526 dev_dbg(priv->dev, "reset %u%02u\n", reg, bit);
529 writel(bitmask, priv->base + SRCR(reg));
531 /* Wait for at least one cycle of the RCLK clock (@ ca. 32 kHz) */
534 /* Release module from reset state */
535 writel(bitmask, priv->base + SRSTCLR(reg));
540 static int cpg_mssr_assert(struct reset_controller_dev *rcdev, unsigned long id)
542 struct cpg_mssr_priv *priv = rcdev_to_priv(rcdev);
543 unsigned int reg = id / 32;
544 unsigned int bit = id % 32;
545 u32 bitmask = BIT(bit);
547 dev_dbg(priv->dev, "assert %u%02u\n", reg, bit);
549 writel(bitmask, priv->base + SRCR(reg));
553 static int cpg_mssr_deassert(struct reset_controller_dev *rcdev,
556 struct cpg_mssr_priv *priv = rcdev_to_priv(rcdev);
557 unsigned int reg = id / 32;
558 unsigned int bit = id % 32;
559 u32 bitmask = BIT(bit);
561 dev_dbg(priv->dev, "deassert %u%02u\n", reg, bit);
563 writel(bitmask, priv->base + SRSTCLR(reg));
567 static int cpg_mssr_status(struct reset_controller_dev *rcdev,
570 struct cpg_mssr_priv *priv = rcdev_to_priv(rcdev);
571 unsigned int reg = id / 32;
572 unsigned int bit = id % 32;
573 u32 bitmask = BIT(bit);
575 return !!(readl(priv->base + SRCR(reg)) & bitmask);
578 static const struct reset_control_ops cpg_mssr_reset_ops = {
579 .reset = cpg_mssr_reset,
580 .assert = cpg_mssr_assert,
581 .deassert = cpg_mssr_deassert,
582 .status = cpg_mssr_status,
585 static int cpg_mssr_reset_xlate(struct reset_controller_dev *rcdev,
586 const struct of_phandle_args *reset_spec)
588 struct cpg_mssr_priv *priv = rcdev_to_priv(rcdev);
589 unsigned int unpacked = reset_spec->args[0];
590 unsigned int idx = MOD_CLK_PACK(unpacked);
592 if (unpacked % 100 > 31 || idx >= rcdev->nr_resets) {
593 dev_err(priv->dev, "Invalid reset index %u\n", unpacked);
600 static int cpg_mssr_reset_controller_register(struct cpg_mssr_priv *priv)
602 priv->rcdev.ops = &cpg_mssr_reset_ops;
603 priv->rcdev.of_node = priv->dev->of_node;
604 priv->rcdev.of_reset_n_cells = 1;
605 priv->rcdev.of_xlate = cpg_mssr_reset_xlate;
606 priv->rcdev.nr_resets = priv->num_mod_clks;
607 return devm_reset_controller_register(priv->dev, &priv->rcdev);
610 #else /* !CONFIG_RESET_CONTROLLER */
611 static inline int cpg_mssr_reset_controller_register(struct cpg_mssr_priv *priv)
615 #endif /* !CONFIG_RESET_CONTROLLER */
618 static const struct of_device_id cpg_mssr_match[] = {
619 #ifdef CONFIG_CLK_R8A7743
621 .compatible = "renesas,r8a7743-cpg-mssr",
622 .data = &r8a7743_cpg_mssr_info,
625 #ifdef CONFIG_CLK_R8A7745
627 .compatible = "renesas,r8a7745-cpg-mssr",
628 .data = &r8a7745_cpg_mssr_info,
631 #ifdef CONFIG_CLK_R8A7790
633 .compatible = "renesas,r8a7790-cpg-mssr",
634 .data = &r8a7790_cpg_mssr_info,
637 #ifdef CONFIG_CLK_R8A7791
639 .compatible = "renesas,r8a7791-cpg-mssr",
640 .data = &r8a7791_cpg_mssr_info,
642 /* R-Car M2-N is (almost) identical to R-Car M2-W w.r.t. clocks. */
644 .compatible = "renesas,r8a7793-cpg-mssr",
645 .data = &r8a7791_cpg_mssr_info,
648 #ifdef CONFIG_CLK_R8A7792
650 .compatible = "renesas,r8a7792-cpg-mssr",
651 .data = &r8a7792_cpg_mssr_info,
654 #ifdef CONFIG_CLK_R8A7794
656 .compatible = "renesas,r8a7794-cpg-mssr",
657 .data = &r8a7794_cpg_mssr_info,
660 #ifdef CONFIG_CLK_R8A7795
662 .compatible = "renesas,r8a7795-cpg-mssr",
663 .data = &r8a7795_cpg_mssr_info,
666 #ifdef CONFIG_CLK_R8A7796
668 .compatible = "renesas,r8a7796-cpg-mssr",
669 .data = &r8a7796_cpg_mssr_info,
672 #ifdef CONFIG_CLK_R8A77995
674 .compatible = "renesas,r8a77995-cpg-mssr",
675 .data = &r8a77995_cpg_mssr_info,
681 static void cpg_mssr_del_clk_provider(void *data)
683 of_clk_del_provider(data);
686 static int __init cpg_mssr_probe(struct platform_device *pdev)
688 struct device *dev = &pdev->dev;
689 struct device_node *np = dev->of_node;
690 const struct cpg_mssr_info *info;
691 struct cpg_mssr_priv *priv;
692 unsigned int nclks, i;
693 struct resource *res;
697 info = of_device_get_match_data(dev);
699 error = info->init(dev);
704 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
709 spin_lock_init(&priv->rmw_lock);
711 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
712 priv->base = devm_ioremap_resource(dev, res);
713 if (IS_ERR(priv->base))
714 return PTR_ERR(priv->base);
716 nclks = info->num_total_core_clks + info->num_hw_mod_clks;
717 clks = devm_kmalloc_array(dev, nclks, sizeof(*clks), GFP_KERNEL);
722 priv->num_core_clks = info->num_total_core_clks;
723 priv->num_mod_clks = info->num_hw_mod_clks;
724 priv->last_dt_core_clk = info->last_dt_core_clk;
726 for (i = 0; i < nclks; i++)
727 clks[i] = ERR_PTR(-ENOENT);
729 for (i = 0; i < info->num_core_clks; i++)
730 cpg_mssr_register_core_clk(&info->core_clks[i], info, priv);
732 for (i = 0; i < info->num_mod_clks; i++)
733 cpg_mssr_register_mod_clk(&info->mod_clks[i], info, priv);
735 error = of_clk_add_provider(np, cpg_mssr_clk_src_twocell_get, priv);
739 error = devm_add_action_or_reset(dev,
740 cpg_mssr_del_clk_provider,
745 error = cpg_mssr_add_clk_domain(dev, info->core_pm_clks,
746 info->num_core_pm_clks);
750 error = cpg_mssr_reset_controller_register(priv);
757 static struct platform_driver cpg_mssr_driver = {
759 .name = "renesas-cpg-mssr",
760 .of_match_table = cpg_mssr_match,
764 static int __init cpg_mssr_init(void)
766 return platform_driver_probe(&cpg_mssr_driver, cpg_mssr_probe);
769 subsys_initcall(cpg_mssr_init);
771 void __init cpg_core_nullify_range(struct cpg_core_clk *core_clks,
772 unsigned int num_core_clks,
773 unsigned int first_clk,
774 unsigned int last_clk)
778 for (i = 0; i < num_core_clks; i++)
779 if (core_clks[i].id >= first_clk &&
780 core_clks[i].id <= last_clk)
781 core_clks[i].name = NULL;
784 void __init mssr_mod_nullify(struct mssr_mod_clk *mod_clks,
785 unsigned int num_mod_clks,
786 const unsigned int *clks, unsigned int n)
790 for (i = 0, j = 0; i < num_mod_clks && j < n; i++)
791 if (mod_clks[i].id == clks[j]) {
792 mod_clks[i].name = NULL;
797 void __init mssr_mod_reparent(struct mssr_mod_clk *mod_clks,
798 unsigned int num_mod_clks,
799 const struct mssr_mod_reparent *clks,
804 for (i = 0, j = 0; i < num_mod_clks && j < n; i++)
805 if (mod_clks[i].id == clks[j].clk) {
806 mod_clks[i].parent = clks[j].parent;
811 MODULE_DESCRIPTION("Renesas CPG/MSSR Driver");
812 MODULE_LICENSE("GPL v2");