2 * Copyright (c) 2013 Heiko Stuebner <heiko@sntech.de>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
8 * Common Clock Framework support for s3c24xx external clock output.
11 #include <linux/clkdev.h>
12 #include <linux/slab.h>
13 #include <linux/clk.h>
14 #include <linux/clk-provider.h>
15 #include <linux/platform_device.h>
16 #include <linux/module.h>
19 /* legacy access to misccr, until dt conversion is finished */
20 #include <mach/hardware.h>
21 #include <mach/regs-gpio.h>
31 #define DCLK_MAX_CLKS (MUX_CLKOUT1 + 1)
40 struct s3c24xx_dclk_drv_data {
41 const char **clkout0_parent_names;
42 int clkout0_num_parents;
43 const char **clkout1_parent_names;
44 int clkout1_num_parents;
45 const char **mux_parent_names;
50 * Clock for output-parent selection in misccr
53 struct s3c24xx_clkout {
59 #define to_s3c24xx_clkout(_hw) container_of(_hw, struct s3c24xx_clkout, hw)
61 static u8 s3c24xx_clkout_get_parent(struct clk_hw *hw)
63 struct s3c24xx_clkout *clkout = to_s3c24xx_clkout(hw);
64 int num_parents = clk_hw_get_num_parents(hw);
67 val = readl_relaxed(S3C24XX_MISCCR) >> clkout->shift;
68 val >>= clkout->shift;
71 if (val >= num_parents)
77 static int s3c24xx_clkout_set_parent(struct clk_hw *hw, u8 index)
79 struct s3c24xx_clkout *clkout = to_s3c24xx_clkout(hw);
81 s3c2410_modify_misccr((clkout->mask << clkout->shift),
82 (index << clkout->shift));
87 static const struct clk_ops s3c24xx_clkout_ops = {
88 .get_parent = s3c24xx_clkout_get_parent,
89 .set_parent = s3c24xx_clkout_set_parent,
90 .determine_rate = __clk_mux_determine_rate,
93 static struct clk *s3c24xx_register_clkout(struct device *dev, const char *name,
94 const char **parent_names, u8 num_parents,
97 struct s3c24xx_clkout *clkout;
99 struct clk_init_data init;
101 /* allocate the clkout */
102 clkout = kzalloc(sizeof(*clkout), GFP_KERNEL);
104 return ERR_PTR(-ENOMEM);
107 init.ops = &s3c24xx_clkout_ops;
108 init.flags = CLK_IS_BASIC;
109 init.parent_names = parent_names;
110 init.num_parents = num_parents;
112 clkout->shift = shift;
114 clkout->hw.init = &init;
116 clk = clk_register(dev, &clkout->hw);
122 * dclk and clkout init
125 struct s3c24xx_dclk {
128 struct clk_onecell_data clk_data;
129 struct notifier_block dclk0_div_change_nb;
130 struct notifier_block dclk1_div_change_nb;
131 spinlock_t dclk_lock;
132 unsigned long reg_save;
135 #define to_s3c24xx_dclk0(x) \
136 container_of(x, struct s3c24xx_dclk, dclk0_div_change_nb)
138 #define to_s3c24xx_dclk1(x) \
139 container_of(x, struct s3c24xx_dclk, dclk1_div_change_nb)
141 static const char *dclk_s3c2410_p[] = { "pclk", "uclk" };
142 static const char *clkout0_s3c2410_p[] = { "mpll", "upll", "fclk", "hclk", "pclk",
144 static const char *clkout1_s3c2410_p[] = { "mpll", "upll", "fclk", "hclk", "pclk",
147 static const char *clkout0_s3c2412_p[] = { "mpll", "upll", "rtc_clkout",
148 "hclk", "pclk", "gate_dclk0" };
149 static const char *clkout1_s3c2412_p[] = { "xti", "upll", "fclk", "hclk", "pclk",
152 static const char *clkout0_s3c2440_p[] = { "xti", "upll", "fclk", "hclk", "pclk",
154 static const char *clkout1_s3c2440_p[] = { "mpll", "upll", "rtc_clkout",
155 "hclk", "pclk", "gate_dclk1" };
157 static const char *dclk_s3c2443_p[] = { "pclk", "epll" };
158 static const char *clkout0_s3c2443_p[] = { "xti", "epll", "armclk", "hclk", "pclk",
160 static const char *clkout1_s3c2443_p[] = { "dummy", "epll", "rtc_clkout",
161 "hclk", "pclk", "gate_dclk1" };
163 #define DCLKCON_DCLK_DIV_MASK 0xf
164 #define DCLKCON_DCLK0_DIV_SHIFT 4
165 #define DCLKCON_DCLK0_CMP_SHIFT 8
166 #define DCLKCON_DCLK1_DIV_SHIFT 20
167 #define DCLKCON_DCLK1_CMP_SHIFT 24
169 static void s3c24xx_dclk_update_cmp(struct s3c24xx_dclk *s3c24xx_dclk,
170 int div_shift, int cmp_shift)
172 unsigned long flags = 0;
173 u32 dclk_con, div, cmp;
175 spin_lock_irqsave(&s3c24xx_dclk->dclk_lock, flags);
177 dclk_con = readl_relaxed(s3c24xx_dclk->base);
179 div = ((dclk_con >> div_shift) & DCLKCON_DCLK_DIV_MASK) + 1;
180 cmp = ((div + 1) / 2) - 1;
182 dclk_con &= ~(DCLKCON_DCLK_DIV_MASK << cmp_shift);
183 dclk_con |= (cmp << cmp_shift);
185 writel_relaxed(dclk_con, s3c24xx_dclk->base);
187 spin_unlock_irqrestore(&s3c24xx_dclk->dclk_lock, flags);
190 static int s3c24xx_dclk0_div_notify(struct notifier_block *nb,
191 unsigned long event, void *data)
193 struct s3c24xx_dclk *s3c24xx_dclk = to_s3c24xx_dclk0(nb);
195 if (event == POST_RATE_CHANGE) {
196 s3c24xx_dclk_update_cmp(s3c24xx_dclk,
197 DCLKCON_DCLK0_DIV_SHIFT, DCLKCON_DCLK0_CMP_SHIFT);
203 static int s3c24xx_dclk1_div_notify(struct notifier_block *nb,
204 unsigned long event, void *data)
206 struct s3c24xx_dclk *s3c24xx_dclk = to_s3c24xx_dclk1(nb);
208 if (event == POST_RATE_CHANGE) {
209 s3c24xx_dclk_update_cmp(s3c24xx_dclk,
210 DCLKCON_DCLK1_DIV_SHIFT, DCLKCON_DCLK1_CMP_SHIFT);
216 #ifdef CONFIG_PM_SLEEP
217 static int s3c24xx_dclk_suspend(struct device *dev)
219 struct platform_device *pdev = to_platform_device(dev);
220 struct s3c24xx_dclk *s3c24xx_dclk = platform_get_drvdata(pdev);
222 s3c24xx_dclk->reg_save = readl_relaxed(s3c24xx_dclk->base);
226 static int s3c24xx_dclk_resume(struct device *dev)
228 struct platform_device *pdev = to_platform_device(dev);
229 struct s3c24xx_dclk *s3c24xx_dclk = platform_get_drvdata(pdev);
231 writel_relaxed(s3c24xx_dclk->reg_save, s3c24xx_dclk->base);
236 static SIMPLE_DEV_PM_OPS(s3c24xx_dclk_pm_ops,
237 s3c24xx_dclk_suspend, s3c24xx_dclk_resume);
239 static int s3c24xx_dclk_probe(struct platform_device *pdev)
241 struct s3c24xx_dclk *s3c24xx_dclk;
242 struct resource *mem;
243 struct clk **clk_table;
244 struct s3c24xx_dclk_drv_data *dclk_variant;
247 s3c24xx_dclk = devm_kzalloc(&pdev->dev, sizeof(*s3c24xx_dclk),
252 s3c24xx_dclk->dev = &pdev->dev;
253 platform_set_drvdata(pdev, s3c24xx_dclk);
254 spin_lock_init(&s3c24xx_dclk->dclk_lock);
256 clk_table = devm_kzalloc(&pdev->dev,
257 sizeof(struct clk *) * DCLK_MAX_CLKS,
262 s3c24xx_dclk->clk_data.clks = clk_table;
263 s3c24xx_dclk->clk_data.clk_num = DCLK_MAX_CLKS;
265 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
266 s3c24xx_dclk->base = devm_ioremap_resource(&pdev->dev, mem);
267 if (IS_ERR(s3c24xx_dclk->base))
268 return PTR_ERR(s3c24xx_dclk->base);
270 dclk_variant = (struct s3c24xx_dclk_drv_data *)
271 platform_get_device_id(pdev)->driver_data;
274 clk_table[MUX_DCLK0] = clk_register_mux(&pdev->dev, "mux_dclk0",
275 dclk_variant->mux_parent_names,
276 dclk_variant->mux_num_parents, 0,
277 s3c24xx_dclk->base, 1, 1, 0,
278 &s3c24xx_dclk->dclk_lock);
279 clk_table[MUX_DCLK1] = clk_register_mux(&pdev->dev, "mux_dclk1",
280 dclk_variant->mux_parent_names,
281 dclk_variant->mux_num_parents, 0,
282 s3c24xx_dclk->base, 17, 1, 0,
283 &s3c24xx_dclk->dclk_lock);
285 clk_table[DIV_DCLK0] = clk_register_divider(&pdev->dev, "div_dclk0",
286 "mux_dclk0", 0, s3c24xx_dclk->base,
287 4, 4, 0, &s3c24xx_dclk->dclk_lock);
288 clk_table[DIV_DCLK1] = clk_register_divider(&pdev->dev, "div_dclk1",
289 "mux_dclk1", 0, s3c24xx_dclk->base,
290 20, 4, 0, &s3c24xx_dclk->dclk_lock);
292 clk_table[GATE_DCLK0] = clk_register_gate(&pdev->dev, "gate_dclk0",
293 "div_dclk0", CLK_SET_RATE_PARENT,
294 s3c24xx_dclk->base, 0, 0,
295 &s3c24xx_dclk->dclk_lock);
296 clk_table[GATE_DCLK1] = clk_register_gate(&pdev->dev, "gate_dclk1",
297 "div_dclk1", CLK_SET_RATE_PARENT,
298 s3c24xx_dclk->base, 16, 0,
299 &s3c24xx_dclk->dclk_lock);
301 clk_table[MUX_CLKOUT0] = s3c24xx_register_clkout(&pdev->dev,
302 "clkout0", dclk_variant->clkout0_parent_names,
303 dclk_variant->clkout0_num_parents, 4, 7);
304 clk_table[MUX_CLKOUT1] = s3c24xx_register_clkout(&pdev->dev,
305 "clkout1", dclk_variant->clkout1_parent_names,
306 dclk_variant->clkout1_num_parents, 8, 7);
308 for (i = 0; i < DCLK_MAX_CLKS; i++)
309 if (IS_ERR(clk_table[i])) {
310 dev_err(&pdev->dev, "clock %d failed to register\n", i);
311 ret = PTR_ERR(clk_table[i]);
312 goto err_clk_register;
315 ret = clk_register_clkdev(clk_table[MUX_DCLK0], "dclk0", NULL);
317 ret = clk_register_clkdev(clk_table[MUX_DCLK1], "dclk1", NULL);
319 ret = clk_register_clkdev(clk_table[MUX_CLKOUT0],
322 ret = clk_register_clkdev(clk_table[MUX_CLKOUT1],
325 dev_err(&pdev->dev, "failed to register aliases, %d\n", ret);
326 goto err_clk_register;
329 s3c24xx_dclk->dclk0_div_change_nb.notifier_call =
330 s3c24xx_dclk0_div_notify;
332 s3c24xx_dclk->dclk1_div_change_nb.notifier_call =
333 s3c24xx_dclk1_div_notify;
335 ret = clk_notifier_register(clk_table[DIV_DCLK0],
336 &s3c24xx_dclk->dclk0_div_change_nb);
338 goto err_clk_register;
340 ret = clk_notifier_register(clk_table[DIV_DCLK1],
341 &s3c24xx_dclk->dclk1_div_change_nb);
343 goto err_dclk_notify;
348 clk_notifier_unregister(clk_table[DIV_DCLK0],
349 &s3c24xx_dclk->dclk0_div_change_nb);
351 for (i = 0; i < DCLK_MAX_CLKS; i++)
352 if (clk_table[i] && !IS_ERR(clk_table[i]))
353 clk_unregister(clk_table[i]);
358 static int s3c24xx_dclk_remove(struct platform_device *pdev)
360 struct s3c24xx_dclk *s3c24xx_dclk = platform_get_drvdata(pdev);
361 struct clk **clk_table = s3c24xx_dclk->clk_data.clks;
364 clk_notifier_unregister(clk_table[DIV_DCLK1],
365 &s3c24xx_dclk->dclk1_div_change_nb);
366 clk_notifier_unregister(clk_table[DIV_DCLK0],
367 &s3c24xx_dclk->dclk0_div_change_nb);
369 for (i = 0; i < DCLK_MAX_CLKS; i++)
370 clk_unregister(clk_table[i]);
375 static struct s3c24xx_dclk_drv_data dclk_variants[] = {
377 .clkout0_parent_names = clkout0_s3c2410_p,
378 .clkout0_num_parents = ARRAY_SIZE(clkout0_s3c2410_p),
379 .clkout1_parent_names = clkout1_s3c2410_p,
380 .clkout1_num_parents = ARRAY_SIZE(clkout1_s3c2410_p),
381 .mux_parent_names = dclk_s3c2410_p,
382 .mux_num_parents = ARRAY_SIZE(dclk_s3c2410_p),
385 .clkout0_parent_names = clkout0_s3c2412_p,
386 .clkout0_num_parents = ARRAY_SIZE(clkout0_s3c2412_p),
387 .clkout1_parent_names = clkout1_s3c2412_p,
388 .clkout1_num_parents = ARRAY_SIZE(clkout1_s3c2412_p),
389 .mux_parent_names = dclk_s3c2410_p,
390 .mux_num_parents = ARRAY_SIZE(dclk_s3c2410_p),
393 .clkout0_parent_names = clkout0_s3c2440_p,
394 .clkout0_num_parents = ARRAY_SIZE(clkout0_s3c2440_p),
395 .clkout1_parent_names = clkout1_s3c2440_p,
396 .clkout1_num_parents = ARRAY_SIZE(clkout1_s3c2440_p),
397 .mux_parent_names = dclk_s3c2410_p,
398 .mux_num_parents = ARRAY_SIZE(dclk_s3c2410_p),
401 .clkout0_parent_names = clkout0_s3c2443_p,
402 .clkout0_num_parents = ARRAY_SIZE(clkout0_s3c2443_p),
403 .clkout1_parent_names = clkout1_s3c2443_p,
404 .clkout1_num_parents = ARRAY_SIZE(clkout1_s3c2443_p),
405 .mux_parent_names = dclk_s3c2443_p,
406 .mux_num_parents = ARRAY_SIZE(dclk_s3c2443_p),
410 static const struct platform_device_id s3c24xx_dclk_driver_ids[] = {
412 .name = "s3c2410-dclk",
413 .driver_data = (kernel_ulong_t)&dclk_variants[S3C2410],
415 .name = "s3c2412-dclk",
416 .driver_data = (kernel_ulong_t)&dclk_variants[S3C2412],
418 .name = "s3c2440-dclk",
419 .driver_data = (kernel_ulong_t)&dclk_variants[S3C2440],
421 .name = "s3c2443-dclk",
422 .driver_data = (kernel_ulong_t)&dclk_variants[S3C2443],
427 MODULE_DEVICE_TABLE(platform, s3c24xx_dclk_driver_ids);
429 static struct platform_driver s3c24xx_dclk_driver = {
431 .name = "s3c24xx-dclk",
432 .pm = &s3c24xx_dclk_pm_ops,
433 .suppress_bind_attrs = true,
435 .probe = s3c24xx_dclk_probe,
436 .remove = s3c24xx_dclk_remove,
437 .id_table = s3c24xx_dclk_driver_ids,
439 module_platform_driver(s3c24xx_dclk_driver);
441 MODULE_LICENSE("GPL v2");
442 MODULE_AUTHOR("Heiko Stuebner <heiko@sntech.de>");
443 MODULE_DESCRIPTION("Driver for the S3C24XX external clock outputs");