blob: 8cbfcf88fae3ed6eaabe1a7af8dd1d1c7fd33d27 [file] [log] [blame]
Linus Walleij91b87a42012-06-11 17:29:54 +02001/*
2 * Driver for the ICST307 VCO clock found in the ARM Reference designs.
3 * We wrap the custom interface from <asm/hardware/icst.h> into the generic
4 * clock framework.
5 *
Linus Walleij401301c2012-11-20 22:39:31 +01006 * Copyright (C) 2012 Linus Walleij
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 *
Linus Walleij91b87a42012-06-11 17:29:54 +020012 * TODO: when all ARM reference designs are migrated to generic clocks, the
13 * ICST clock code from the ARM tree should probably be merged into this
14 * file.
15 */
16#include <linux/clk.h>
17#include <linux/clkdev.h>
18#include <linux/err.h>
19#include <linux/clk-provider.h>
Linus Walleij7a9ad672012-11-20 23:01:04 +010020#include <linux/io.h>
Linus Walleij91b87a42012-06-11 17:29:54 +020021
22#include "clk-icst.h"
23
24/**
25 * struct clk_icst - ICST VCO clock wrapper
26 * @hw: corresponding clock hardware entry
Linus Walleij7a9ad672012-11-20 23:01:04 +010027 * @vcoreg: VCO register address
28 * @lockreg: VCO lock register address
Linus Walleij91b87a42012-06-11 17:29:54 +020029 * @params: parameters for this ICST instance
30 * @rate: current rate
Linus Walleij91b87a42012-06-11 17:29:54 +020031 */
32struct clk_icst {
33 struct clk_hw hw;
Linus Walleij7a9ad672012-11-20 23:01:04 +010034 void __iomem *vcoreg;
35 void __iomem *lockreg;
Linus Walleij91b87a42012-06-11 17:29:54 +020036 const struct icst_params *params;
37 unsigned long rate;
Linus Walleij91b87a42012-06-11 17:29:54 +020038};
39
40#define to_icst(_hw) container_of(_hw, struct clk_icst, hw)
41
Linus Walleij7a9ad672012-11-20 23:01:04 +010042/**
43 * vco_get() - get ICST VCO settings from a certain register
44 * @vcoreg: register containing the VCO settings
45 */
46static struct icst_vco vco_get(void __iomem *vcoreg)
47{
48 u32 val;
49 struct icst_vco vco;
50
51 val = readl(vcoreg);
52 vco.v = val & 0x1ff;
53 vco.r = (val >> 9) & 0x7f;
54 vco.s = (val >> 16) & 03;
55 return vco;
56}
57
58/**
59 * vco_set() - commit changes to an ICST VCO
60 * @locreg: register to poke to unlock the VCO for writing
61 * @vcoreg: register containing the VCO settings
62 * @vco: ICST VCO parameters to commit
63 */
64static void vco_set(void __iomem *lockreg,
65 void __iomem *vcoreg,
66 struct icst_vco vco)
67{
68 u32 val;
69
70 val = readl(vcoreg) & ~0x7ffff;
71 val |= vco.v | (vco.r << 9) | (vco.s << 16);
72
73 /* This magic unlocks the VCO so it can be controlled */
74 writel(0xa05f, lockreg);
75 writel(val, vcoreg);
76 /* This locks the VCO again */
77 writel(0, lockreg);
78}
79
80
Linus Walleij91b87a42012-06-11 17:29:54 +020081static unsigned long icst_recalc_rate(struct clk_hw *hw,
82 unsigned long parent_rate)
83{
84 struct clk_icst *icst = to_icst(hw);
85 struct icst_vco vco;
86
Linus Walleij7a9ad672012-11-20 23:01:04 +010087 vco = vco_get(icst->vcoreg);
Linus Walleij91b87a42012-06-11 17:29:54 +020088 icst->rate = icst_hz(icst->params, vco);
89 return icst->rate;
90}
91
92static long icst_round_rate(struct clk_hw *hw, unsigned long rate,
93 unsigned long *prate)
94{
95 struct clk_icst *icst = to_icst(hw);
96 struct icst_vco vco;
97
98 vco = icst_hz_to_vco(icst->params, rate);
99 return icst_hz(icst->params, vco);
100}
101
102static int icst_set_rate(struct clk_hw *hw, unsigned long rate,
103 unsigned long parent_rate)
104{
105 struct clk_icst *icst = to_icst(hw);
106 struct icst_vco vco;
107
108 vco = icst_hz_to_vco(icst->params, rate);
109 icst->rate = icst_hz(icst->params, vco);
Jonathan Austin2f9f64b2013-07-23 16:42:18 +0100110 vco_set(icst->lockreg, icst->vcoreg, vco);
Linus Walleij91b87a42012-06-11 17:29:54 +0200111 return 0;
112}
113
114static const struct clk_ops icst_ops = {
115 .recalc_rate = icst_recalc_rate,
116 .round_rate = icst_round_rate,
117 .set_rate = icst_set_rate,
118};
119
Linus Walleij7a9ad672012-11-20 23:01:04 +0100120struct clk *icst_clk_register(struct device *dev,
121 const struct clk_icst_desc *desc,
Linus Walleijae6e6942013-11-22 11:30:05 +0100122 const char *name,
Linus Walleij7a9ad672012-11-20 23:01:04 +0100123 void __iomem *base)
Linus Walleij91b87a42012-06-11 17:29:54 +0200124{
125 struct clk *clk;
126 struct clk_icst *icst;
127 struct clk_init_data init;
128
129 icst = kzalloc(sizeof(struct clk_icst), GFP_KERNEL);
130 if (!icst) {
131 pr_err("could not allocate ICST clock!\n");
132 return ERR_PTR(-ENOMEM);
133 }
Linus Walleijae6e6942013-11-22 11:30:05 +0100134 init.name = name;
Linus Walleij91b87a42012-06-11 17:29:54 +0200135 init.ops = &icst_ops;
136 init.flags = CLK_IS_ROOT;
137 init.parent_names = NULL;
138 init.num_parents = 0;
139 icst->hw.init = &init;
140 icst->params = desc->params;
Linus Walleij7a9ad672012-11-20 23:01:04 +0100141 icst->vcoreg = base + desc->vco_offset;
142 icst->lockreg = base + desc->lock_offset;
Linus Walleij91b87a42012-06-11 17:29:54 +0200143
144 clk = clk_register(dev, &icst->hw);
145 if (IS_ERR(clk))
146 kfree(icst);
147
148 return clk;
149}