1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
4 * Author: Tomasz Figa <t.figa@samsung.com>
6 * Clock driver for Exynos clock output
9 #include <linux/slab.h>
10 #include <linux/clk.h>
11 #include <linux/clk-provider.h>
12 #include <linux/module.h>
15 #include <linux/of_address.h>
16 #include <linux/of_device.h>
17 #include <linux/platform_device.h>
20 #define EXYNOS_CLKOUT_NR_CLKS 1
21 #define EXYNOS_CLKOUT_PARENTS 32
23 #define EXYNOS_PMU_DEBUG_REG 0xa00
24 #define EXYNOS_CLKOUT_DISABLE_SHIFT 0
25 #define EXYNOS_CLKOUT_MUX_SHIFT 8
26 #define EXYNOS4_CLKOUT_MUX_MASK 0xf
27 #define EXYNOS5_CLKOUT_MUX_MASK 0x1f
29 struct exynos_clkout {
34 struct device_node *np;
36 struct clk_hw_onecell_data data;
39 struct exynos_clkout_variant {
43 static const struct exynos_clkout_variant exynos_clkout_exynos4 = {
44 .mux_mask = EXYNOS4_CLKOUT_MUX_MASK,
47 static const struct exynos_clkout_variant exynos_clkout_exynos5 = {
48 .mux_mask = EXYNOS5_CLKOUT_MUX_MASK,
51 static const struct of_device_id exynos_clkout_ids[] = {
53 .compatible = "samsung,exynos3250-pmu",
54 .data = &exynos_clkout_exynos4,
56 .compatible = "samsung,exynos4210-pmu",
57 .data = &exynos_clkout_exynos4,
59 .compatible = "samsung,exynos4412-pmu",
60 .data = &exynos_clkout_exynos4,
62 .compatible = "samsung,exynos5250-pmu",
63 .data = &exynos_clkout_exynos5,
65 .compatible = "samsung,exynos5410-pmu",
66 .data = &exynos_clkout_exynos5,
68 .compatible = "samsung,exynos5420-pmu",
69 .data = &exynos_clkout_exynos5,
71 .compatible = "samsung,exynos5433-pmu",
72 .data = &exynos_clkout_exynos5,
75 MODULE_DEVICE_TABLE(of, exynos_clkout_ids);
78 * Device will be instantiated as child of PMU device without its own
79 * device node. Therefore match compatibles against parent.
81 static int exynos_clkout_match_parent_dev(struct device *dev, u32 *mux_mask)
83 const struct exynos_clkout_variant *variant;
84 const struct of_device_id *match;
87 dev_err(dev, "not instantiated from MFD\n");
91 match = of_match_device(exynos_clkout_ids, dev->parent);
93 dev_err(dev, "cannot match parent device\n");
96 variant = match->data;
98 *mux_mask = variant->mux_mask;
103 static int exynos_clkout_probe(struct platform_device *pdev)
105 const char *parent_names[EXYNOS_CLKOUT_PARENTS];
106 struct clk *parents[EXYNOS_CLKOUT_PARENTS];
107 struct exynos_clkout *clkout;
108 int parent_count, ret, i;
111 clkout = devm_kzalloc(&pdev->dev,
112 struct_size(clkout, data.hws, EXYNOS_CLKOUT_NR_CLKS),
117 ret = exynos_clkout_match_parent_dev(&pdev->dev, &mux_mask);
121 clkout->np = pdev->dev.of_node;
124 * pdev->dev.parent was checked by exynos_clkout_match_parent_dev()
127 clkout->np = pdev->dev.parent->of_node;
130 platform_set_drvdata(pdev, clkout);
132 spin_lock_init(&clkout->slock);
135 for (i = 0; i < EXYNOS_CLKOUT_PARENTS; ++i) {
136 char name[] = "clkoutXX";
138 snprintf(name, sizeof(name), "clkout%d", i);
139 parents[i] = of_clk_get_by_name(clkout->np, name);
140 if (IS_ERR(parents[i])) {
141 parent_names[i] = "none";
145 parent_names[i] = __clk_get_name(parents[i]);
146 parent_count = i + 1;
152 clkout->reg = of_iomap(clkout->np, 0);
158 clkout->gate.reg = clkout->reg + EXYNOS_PMU_DEBUG_REG;
159 clkout->gate.bit_idx = EXYNOS_CLKOUT_DISABLE_SHIFT;
160 clkout->gate.flags = CLK_GATE_SET_TO_DISABLE;
161 clkout->gate.lock = &clkout->slock;
163 clkout->mux.reg = clkout->reg + EXYNOS_PMU_DEBUG_REG;
164 clkout->mux.mask = mux_mask;
165 clkout->mux.shift = EXYNOS_CLKOUT_MUX_SHIFT;
166 clkout->mux.lock = &clkout->slock;
168 clkout->data.hws[0] = clk_hw_register_composite(NULL, "clkout",
169 parent_names, parent_count, &clkout->mux.hw,
170 &clk_mux_ops, NULL, NULL, &clkout->gate.hw,
171 &clk_gate_ops, CLK_SET_RATE_PARENT
172 | CLK_SET_RATE_NO_REPARENT);
173 if (IS_ERR(clkout->data.hws[0])) {
174 ret = PTR_ERR(clkout->data.hws[0]);
178 clkout->data.num = EXYNOS_CLKOUT_NR_CLKS;
179 ret = of_clk_add_hw_provider(clkout->np, of_clk_hw_onecell_get, &clkout->data);
186 clk_hw_unregister(clkout->data.hws[0]);
188 iounmap(clkout->reg);
190 for (i = 0; i < EXYNOS_CLKOUT_PARENTS; ++i)
191 if (!IS_ERR(parents[i]))
194 dev_err(&pdev->dev, "failed to register clkout clock\n");
199 static int exynos_clkout_remove(struct platform_device *pdev)
201 struct exynos_clkout *clkout = platform_get_drvdata(pdev);
203 of_clk_del_provider(clkout->np);
204 clk_hw_unregister(clkout->data.hws[0]);
205 iounmap(clkout->reg);
210 static int __maybe_unused exynos_clkout_suspend(struct device *dev)
212 struct exynos_clkout *clkout = dev_get_drvdata(dev);
214 clkout->pmu_debug_save = readl(clkout->reg + EXYNOS_PMU_DEBUG_REG);
219 static int __maybe_unused exynos_clkout_resume(struct device *dev)
221 struct exynos_clkout *clkout = dev_get_drvdata(dev);
223 writel(clkout->pmu_debug_save, clkout->reg + EXYNOS_PMU_DEBUG_REG);
228 static SIMPLE_DEV_PM_OPS(exynos_clkout_pm_ops, exynos_clkout_suspend,
229 exynos_clkout_resume);
231 static struct platform_driver exynos_clkout_driver = {
233 .name = "exynos-clkout",
234 .of_match_table = exynos_clkout_ids,
235 .pm = &exynos_clkout_pm_ops,
237 .probe = exynos_clkout_probe,
238 .remove = exynos_clkout_remove,
240 module_platform_driver(exynos_clkout_driver);
242 MODULE_AUTHOR("Krzysztof Kozlowski <krzk@kernel.org>");
243 MODULE_AUTHOR("Tomasz Figa <tomasz.figa@gmail.com>");
244 MODULE_DESCRIPTION("Samsung Exynos clock output driver");
245 MODULE_LICENSE("GPL");