Linux 4.16.11
[linux/fpc-iii.git] / drivers / clk / at91 / clk-generated.c
blob33481368740e7dc038fe1e32065e2659d8cec730
1 /*
2 * Copyright (C) 2015 Atmel Corporation,
3 * Nicolas Ferre <nicolas.ferre@atmel.com>
5 * Based on clk-programmable & clk-peripheral drivers by Boris BREZILLON.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
14 #include <linux/clk-provider.h>
15 #include <linux/clkdev.h>
16 #include <linux/clk/at91_pmc.h>
17 #include <linux/of.h>
18 #include <linux/mfd/syscon.h>
19 #include <linux/regmap.h>
21 #include "pmc.h"
23 #define PERIPHERAL_MAX 64
24 #define PERIPHERAL_ID_MIN 2
26 #define GENERATED_SOURCE_MAX 6
27 #define GENERATED_MAX_DIV 255
29 #define GCK_ID_SSC0 43
30 #define GCK_ID_SSC1 44
31 #define GCK_ID_I2S0 54
32 #define GCK_ID_I2S1 55
33 #define GCK_ID_CLASSD 59
34 #define GCK_INDEX_DT_AUDIO_PLL 5
36 struct clk_generated {
37 struct clk_hw hw;
38 struct regmap *regmap;
39 struct clk_range range;
40 spinlock_t *lock;
41 u32 id;
42 u32 gckdiv;
43 u8 parent_id;
44 bool audio_pll_allowed;
47 #define to_clk_generated(hw) \
48 container_of(hw, struct clk_generated, hw)
50 static int clk_generated_enable(struct clk_hw *hw)
52 struct clk_generated *gck = to_clk_generated(hw);
53 unsigned long flags;
55 pr_debug("GCLK: %s, gckdiv = %d, parent id = %d\n",
56 __func__, gck->gckdiv, gck->parent_id);
58 spin_lock_irqsave(gck->lock, flags);
59 regmap_write(gck->regmap, AT91_PMC_PCR,
60 (gck->id & AT91_PMC_PCR_PID_MASK));
61 regmap_update_bits(gck->regmap, AT91_PMC_PCR,
62 AT91_PMC_PCR_GCKDIV_MASK | AT91_PMC_PCR_GCKCSS_MASK |
63 AT91_PMC_PCR_CMD | AT91_PMC_PCR_GCKEN,
64 AT91_PMC_PCR_GCKCSS(gck->parent_id) |
65 AT91_PMC_PCR_CMD |
66 AT91_PMC_PCR_GCKDIV(gck->gckdiv) |
67 AT91_PMC_PCR_GCKEN);
68 spin_unlock_irqrestore(gck->lock, flags);
69 return 0;
72 static void clk_generated_disable(struct clk_hw *hw)
74 struct clk_generated *gck = to_clk_generated(hw);
75 unsigned long flags;
77 spin_lock_irqsave(gck->lock, flags);
78 regmap_write(gck->regmap, AT91_PMC_PCR,
79 (gck->id & AT91_PMC_PCR_PID_MASK));
80 regmap_update_bits(gck->regmap, AT91_PMC_PCR,
81 AT91_PMC_PCR_CMD | AT91_PMC_PCR_GCKEN,
82 AT91_PMC_PCR_CMD);
83 spin_unlock_irqrestore(gck->lock, flags);
86 static int clk_generated_is_enabled(struct clk_hw *hw)
88 struct clk_generated *gck = to_clk_generated(hw);
89 unsigned long flags;
90 unsigned int status;
92 spin_lock_irqsave(gck->lock, flags);
93 regmap_write(gck->regmap, AT91_PMC_PCR,
94 (gck->id & AT91_PMC_PCR_PID_MASK));
95 regmap_read(gck->regmap, AT91_PMC_PCR, &status);
96 spin_unlock_irqrestore(gck->lock, flags);
98 return status & AT91_PMC_PCR_GCKEN ? 1 : 0;
101 static unsigned long
102 clk_generated_recalc_rate(struct clk_hw *hw,
103 unsigned long parent_rate)
105 struct clk_generated *gck = to_clk_generated(hw);
107 return DIV_ROUND_CLOSEST(parent_rate, gck->gckdiv + 1);
110 static void clk_generated_best_diff(struct clk_rate_request *req,
111 struct clk_hw *parent,
112 unsigned long parent_rate, u32 div,
113 int *best_diff, long *best_rate)
115 unsigned long tmp_rate;
116 int tmp_diff;
118 if (!div)
119 tmp_rate = parent_rate;
120 else
121 tmp_rate = parent_rate / div;
122 tmp_diff = abs(req->rate - tmp_rate);
124 if (*best_diff < 0 || *best_diff > tmp_diff) {
125 *best_rate = tmp_rate;
126 *best_diff = tmp_diff;
127 req->best_parent_rate = parent_rate;
128 req->best_parent_hw = parent;
132 static int clk_generated_determine_rate(struct clk_hw *hw,
133 struct clk_rate_request *req)
135 struct clk_generated *gck = to_clk_generated(hw);
136 struct clk_hw *parent = NULL;
137 struct clk_rate_request req_parent = *req;
138 long best_rate = -EINVAL;
139 unsigned long min_rate, parent_rate;
140 int best_diff = -1;
141 int i;
142 u32 div;
144 for (i = 0; i < clk_hw_get_num_parents(hw) - 1; i++) {
145 parent = clk_hw_get_parent_by_index(hw, i);
146 if (!parent)
147 continue;
149 parent_rate = clk_hw_get_rate(parent);
150 min_rate = DIV_ROUND_CLOSEST(parent_rate, GENERATED_MAX_DIV + 1);
151 if (!parent_rate ||
152 (gck->range.max && min_rate > gck->range.max))
153 continue;
155 div = DIV_ROUND_CLOSEST(parent_rate, req->rate);
157 clk_generated_best_diff(req, parent, parent_rate, div,
158 &best_diff, &best_rate);
160 if (!best_diff)
161 break;
165 * The audio_pll rate can be modified, unlike the five others clocks
166 * that should never be altered.
167 * The audio_pll can technically be used by multiple consumers. However,
168 * with the rate locking, the first consumer to enable to clock will be
169 * the one definitely setting the rate of the clock.
170 * Since audio IPs are most likely to request the same rate, we enforce
171 * that the only clks able to modify gck rate are those of audio IPs.
174 if (!gck->audio_pll_allowed)
175 goto end;
177 parent = clk_hw_get_parent_by_index(hw, GCK_INDEX_DT_AUDIO_PLL);
178 if (!parent)
179 goto end;
181 for (div = 1; div < GENERATED_MAX_DIV + 2; div++) {
182 req_parent.rate = req->rate * div;
183 __clk_determine_rate(parent, &req_parent);
184 clk_generated_best_diff(req, parent, req_parent.rate, div,
185 &best_diff, &best_rate);
187 if (!best_diff)
188 break;
191 end:
192 pr_debug("GCLK: %s, best_rate = %ld, parent clk: %s @ %ld\n",
193 __func__, best_rate,
194 __clk_get_name((req->best_parent_hw)->clk),
195 req->best_parent_rate);
197 if (best_rate < 0)
198 return best_rate;
200 req->rate = best_rate;
201 return 0;
204 /* No modification of hardware as we have the flag CLK_SET_PARENT_GATE set */
205 static int clk_generated_set_parent(struct clk_hw *hw, u8 index)
207 struct clk_generated *gck = to_clk_generated(hw);
209 if (index >= clk_hw_get_num_parents(hw))
210 return -EINVAL;
212 gck->parent_id = index;
213 return 0;
216 static u8 clk_generated_get_parent(struct clk_hw *hw)
218 struct clk_generated *gck = to_clk_generated(hw);
220 return gck->parent_id;
223 /* No modification of hardware as we have the flag CLK_SET_RATE_GATE set */
224 static int clk_generated_set_rate(struct clk_hw *hw,
225 unsigned long rate,
226 unsigned long parent_rate)
228 struct clk_generated *gck = to_clk_generated(hw);
229 u32 div;
231 if (!rate)
232 return -EINVAL;
234 if (gck->range.max && rate > gck->range.max)
235 return -EINVAL;
237 div = DIV_ROUND_CLOSEST(parent_rate, rate);
238 if (div > GENERATED_MAX_DIV + 1 || !div)
239 return -EINVAL;
241 gck->gckdiv = div - 1;
242 return 0;
245 static const struct clk_ops generated_ops = {
246 .enable = clk_generated_enable,
247 .disable = clk_generated_disable,
248 .is_enabled = clk_generated_is_enabled,
249 .recalc_rate = clk_generated_recalc_rate,
250 .determine_rate = clk_generated_determine_rate,
251 .get_parent = clk_generated_get_parent,
252 .set_parent = clk_generated_set_parent,
253 .set_rate = clk_generated_set_rate,
257 * clk_generated_startup - Initialize a given clock to its default parent and
258 * divisor parameter.
260 * @gck: Generated clock to set the startup parameters for.
262 * Take parameters from the hardware and update local clock configuration
263 * accordingly.
265 static void clk_generated_startup(struct clk_generated *gck)
267 u32 tmp;
268 unsigned long flags;
270 spin_lock_irqsave(gck->lock, flags);
271 regmap_write(gck->regmap, AT91_PMC_PCR,
272 (gck->id & AT91_PMC_PCR_PID_MASK));
273 regmap_read(gck->regmap, AT91_PMC_PCR, &tmp);
274 spin_unlock_irqrestore(gck->lock, flags);
276 gck->parent_id = (tmp & AT91_PMC_PCR_GCKCSS_MASK)
277 >> AT91_PMC_PCR_GCKCSS_OFFSET;
278 gck->gckdiv = (tmp & AT91_PMC_PCR_GCKDIV_MASK)
279 >> AT91_PMC_PCR_GCKDIV_OFFSET;
282 static struct clk_hw * __init
283 at91_clk_register_generated(struct regmap *regmap, spinlock_t *lock,
284 const char *name, const char **parent_names,
285 u8 num_parents, u8 id,
286 const struct clk_range *range)
288 struct clk_generated *gck;
289 struct clk_init_data init;
290 struct clk_hw *hw;
291 int ret;
293 gck = kzalloc(sizeof(*gck), GFP_KERNEL);
294 if (!gck)
295 return ERR_PTR(-ENOMEM);
297 init.name = name;
298 init.ops = &generated_ops;
299 init.parent_names = parent_names;
300 init.num_parents = num_parents;
301 init.flags = CLK_SET_RATE_GATE | CLK_SET_PARENT_GATE |
302 CLK_SET_RATE_PARENT;
304 gck->id = id;
305 gck->hw.init = &init;
306 gck->regmap = regmap;
307 gck->lock = lock;
308 gck->range = *range;
310 clk_generated_startup(gck);
311 hw = &gck->hw;
312 ret = clk_hw_register(NULL, &gck->hw);
313 if (ret) {
314 kfree(gck);
315 hw = ERR_PTR(ret);
316 } else {
317 pmc_register_id(id);
320 return hw;
323 static void __init of_sama5d2_clk_generated_setup(struct device_node *np)
325 int num;
326 u32 id;
327 const char *name;
328 struct clk_hw *hw;
329 unsigned int num_parents;
330 const char *parent_names[GENERATED_SOURCE_MAX];
331 struct device_node *gcknp;
332 struct clk_range range = CLK_RANGE(0, 0);
333 struct regmap *regmap;
334 struct clk_generated *gck;
336 num_parents = of_clk_get_parent_count(np);
337 if (num_parents == 0 || num_parents > GENERATED_SOURCE_MAX)
338 return;
340 of_clk_parent_fill(np, parent_names, num_parents);
342 num = of_get_child_count(np);
343 if (!num || num > PERIPHERAL_MAX)
344 return;
346 regmap = syscon_node_to_regmap(of_get_parent(np));
347 if (IS_ERR(regmap))
348 return;
350 for_each_child_of_node(np, gcknp) {
351 if (of_property_read_u32(gcknp, "reg", &id))
352 continue;
354 if (id < PERIPHERAL_ID_MIN || id >= PERIPHERAL_MAX)
355 continue;
357 if (of_property_read_string(np, "clock-output-names", &name))
358 name = gcknp->name;
360 of_at91_get_clk_range(gcknp, "atmel,clk-output-range",
361 &range);
363 hw = at91_clk_register_generated(regmap, &pmc_pcr_lock, name,
364 parent_names, num_parents,
365 id, &range);
367 gck = to_clk_generated(hw);
369 if (of_device_is_compatible(np,
370 "atmel,sama5d2-clk-generated")) {
371 if (gck->id == GCK_ID_SSC0 || gck->id == GCK_ID_SSC1 ||
372 gck->id == GCK_ID_I2S0 || gck->id == GCK_ID_I2S1 ||
373 gck->id == GCK_ID_CLASSD)
374 gck->audio_pll_allowed = true;
375 else
376 gck->audio_pll_allowed = false;
377 } else {
378 gck->audio_pll_allowed = false;
381 if (IS_ERR(hw))
382 continue;
384 of_clk_add_hw_provider(gcknp, of_clk_hw_simple_get, hw);
387 CLK_OF_DECLARE(of_sama5d2_clk_generated_setup, "atmel,sama5d2-clk-generated",
388 of_sama5d2_clk_generated_setup);