clk: qcom: Introduce parent_map tables
[deliverable/linux.git] / drivers / clk / qcom / clk-rcg.c
1 /*
2 * Copyright (c) 2013, The Linux Foundation. All rights reserved.
3 *
4 * This software is licensed under the terms of the GNU General Public
5 * License version 2, as published by the Free Software Foundation, and
6 * may be copied, distributed, and modified under those terms.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 */
13
14 #include <linux/kernel.h>
15 #include <linux/bitops.h>
16 #include <linux/err.h>
17 #include <linux/export.h>
18 #include <linux/clk-provider.h>
19 #include <linux/regmap.h>
20
21 #include <asm/div64.h>
22
23 #include "clk-rcg.h"
24 #include "common.h"
25
26 static u32 ns_to_src(struct src_sel *s, u32 ns)
27 {
28 ns >>= s->src_sel_shift;
29 ns &= SRC_SEL_MASK;
30 return ns;
31 }
32
33 static u32 src_to_ns(struct src_sel *s, u8 src, u32 ns)
34 {
35 u32 mask;
36
37 mask = SRC_SEL_MASK;
38 mask <<= s->src_sel_shift;
39 ns &= ~mask;
40
41 ns |= src << s->src_sel_shift;
42 return ns;
43 }
44
45 static u8 clk_rcg_get_parent(struct clk_hw *hw)
46 {
47 struct clk_rcg *rcg = to_clk_rcg(hw);
48 int num_parents = __clk_get_num_parents(hw->clk);
49 u32 ns;
50 int i, ret;
51
52 ret = regmap_read(rcg->clkr.regmap, rcg->ns_reg, &ns);
53 if (ret)
54 goto err;
55 ns = ns_to_src(&rcg->s, ns);
56 for (i = 0; i < num_parents; i++)
57 if (ns == rcg->s.parent_map[i].cfg)
58 return i;
59
60 err:
61 pr_debug("%s: Clock %s has invalid parent, using default.\n",
62 __func__, __clk_get_name(hw->clk));
63 return 0;
64 }
65
66 static int reg_to_bank(struct clk_dyn_rcg *rcg, u32 bank)
67 {
68 bank &= BIT(rcg->mux_sel_bit);
69 return !!bank;
70 }
71
72 static u8 clk_dyn_rcg_get_parent(struct clk_hw *hw)
73 {
74 struct clk_dyn_rcg *rcg = to_clk_dyn_rcg(hw);
75 int num_parents = __clk_get_num_parents(hw->clk);
76 u32 ns, reg;
77 int bank;
78 int i, ret;
79 struct src_sel *s;
80
81 ret = regmap_read(rcg->clkr.regmap, rcg->bank_reg, &reg);
82 if (ret)
83 goto err;
84 bank = reg_to_bank(rcg, reg);
85 s = &rcg->s[bank];
86
87 ret = regmap_read(rcg->clkr.regmap, rcg->ns_reg[bank], &ns);
88 if (ret)
89 goto err;
90 ns = ns_to_src(s, ns);
91
92 for (i = 0; i < num_parents; i++)
93 if (ns == s->parent_map[i].cfg)
94 return i;
95
96 err:
97 pr_debug("%s: Clock %s has invalid parent, using default.\n",
98 __func__, __clk_get_name(hw->clk));
99 return 0;
100 }
101
102 static int clk_rcg_set_parent(struct clk_hw *hw, u8 index)
103 {
104 struct clk_rcg *rcg = to_clk_rcg(hw);
105 u32 ns;
106
107 regmap_read(rcg->clkr.regmap, rcg->ns_reg, &ns);
108 ns = src_to_ns(&rcg->s, rcg->s.parent_map[index].cfg, ns);
109 regmap_write(rcg->clkr.regmap, rcg->ns_reg, ns);
110
111 return 0;
112 }
113
114 static u32 md_to_m(struct mn *mn, u32 md)
115 {
116 md >>= mn->m_val_shift;
117 md &= BIT(mn->width) - 1;
118 return md;
119 }
120
121 static u32 ns_to_pre_div(struct pre_div *p, u32 ns)
122 {
123 ns >>= p->pre_div_shift;
124 ns &= BIT(p->pre_div_width) - 1;
125 return ns;
126 }
127
128 static u32 pre_div_to_ns(struct pre_div *p, u8 pre_div, u32 ns)
129 {
130 u32 mask;
131
132 mask = BIT(p->pre_div_width) - 1;
133 mask <<= p->pre_div_shift;
134 ns &= ~mask;
135
136 ns |= pre_div << p->pre_div_shift;
137 return ns;
138 }
139
140 static u32 mn_to_md(struct mn *mn, u32 m, u32 n, u32 md)
141 {
142 u32 mask, mask_w;
143
144 mask_w = BIT(mn->width) - 1;
145 mask = (mask_w << mn->m_val_shift) | mask_w;
146 md &= ~mask;
147
148 if (n) {
149 m <<= mn->m_val_shift;
150 md |= m;
151 md |= ~n & mask_w;
152 }
153
154 return md;
155 }
156
157 static u32 ns_m_to_n(struct mn *mn, u32 ns, u32 m)
158 {
159 ns = ~ns >> mn->n_val_shift;
160 ns &= BIT(mn->width) - 1;
161 return ns + m;
162 }
163
164 static u32 reg_to_mnctr_mode(struct mn *mn, u32 val)
165 {
166 val >>= mn->mnctr_mode_shift;
167 val &= MNCTR_MODE_MASK;
168 return val;
169 }
170
171 static u32 mn_to_ns(struct mn *mn, u32 m, u32 n, u32 ns)
172 {
173 u32 mask;
174
175 mask = BIT(mn->width) - 1;
176 mask <<= mn->n_val_shift;
177 ns &= ~mask;
178
179 if (n) {
180 n = n - m;
181 n = ~n;
182 n &= BIT(mn->width) - 1;
183 n <<= mn->n_val_shift;
184 ns |= n;
185 }
186
187 return ns;
188 }
189
190 static u32 mn_to_reg(struct mn *mn, u32 m, u32 n, u32 val)
191 {
192 u32 mask;
193
194 mask = MNCTR_MODE_MASK << mn->mnctr_mode_shift;
195 mask |= BIT(mn->mnctr_en_bit);
196 val &= ~mask;
197
198 if (n) {
199 val |= BIT(mn->mnctr_en_bit);
200 val |= MNCTR_MODE_DUAL << mn->mnctr_mode_shift;
201 }
202
203 return val;
204 }
205
206 static int configure_bank(struct clk_dyn_rcg *rcg, const struct freq_tbl *f)
207 {
208 u32 ns, md, reg;
209 int bank, new_bank, ret, index;
210 struct mn *mn;
211 struct pre_div *p;
212 struct src_sel *s;
213 bool enabled;
214 u32 md_reg, ns_reg;
215 bool banked_mn = !!rcg->mn[1].width;
216 bool banked_p = !!rcg->p[1].pre_div_width;
217 struct clk_hw *hw = &rcg->clkr.hw;
218
219 enabled = __clk_is_enabled(hw->clk);
220
221 ret = regmap_read(rcg->clkr.regmap, rcg->bank_reg, &reg);
222 if (ret)
223 return ret;
224 bank = reg_to_bank(rcg, reg);
225 new_bank = enabled ? !bank : bank;
226
227 ns_reg = rcg->ns_reg[new_bank];
228 ret = regmap_read(rcg->clkr.regmap, ns_reg, &ns);
229 if (ret)
230 return ret;
231
232 if (banked_mn) {
233 mn = &rcg->mn[new_bank];
234 md_reg = rcg->md_reg[new_bank];
235
236 ns |= BIT(mn->mnctr_reset_bit);
237 ret = regmap_write(rcg->clkr.regmap, ns_reg, ns);
238 if (ret)
239 return ret;
240
241 ret = regmap_read(rcg->clkr.regmap, md_reg, &md);
242 if (ret)
243 return ret;
244 md = mn_to_md(mn, f->m, f->n, md);
245 ret = regmap_write(rcg->clkr.regmap, md_reg, md);
246 if (ret)
247 return ret;
248 ns = mn_to_ns(mn, f->m, f->n, ns);
249 ret = regmap_write(rcg->clkr.regmap, ns_reg, ns);
250 if (ret)
251 return ret;
252
253 /* Two NS registers means mode control is in NS register */
254 if (rcg->ns_reg[0] != rcg->ns_reg[1]) {
255 ns = mn_to_reg(mn, f->m, f->n, ns);
256 ret = regmap_write(rcg->clkr.regmap, ns_reg, ns);
257 if (ret)
258 return ret;
259 } else {
260 reg = mn_to_reg(mn, f->m, f->n, reg);
261 ret = regmap_write(rcg->clkr.regmap, rcg->bank_reg,
262 reg);
263 if (ret)
264 return ret;
265 }
266
267 ns &= ~BIT(mn->mnctr_reset_bit);
268 ret = regmap_write(rcg->clkr.regmap, ns_reg, ns);
269 if (ret)
270 return ret;
271 }
272
273 if (banked_p) {
274 p = &rcg->p[new_bank];
275 ns = pre_div_to_ns(p, f->pre_div - 1, ns);
276 }
277
278 s = &rcg->s[new_bank];
279 index = qcom_find_src_index(hw, s->parent_map, f->src);
280 if (index < 0)
281 return index;
282 ns = src_to_ns(s, s->parent_map[index].cfg, ns);
283 ret = regmap_write(rcg->clkr.regmap, ns_reg, ns);
284 if (ret)
285 return ret;
286
287 if (enabled) {
288 ret = regmap_read(rcg->clkr.regmap, rcg->bank_reg, &reg);
289 if (ret)
290 return ret;
291 reg ^= BIT(rcg->mux_sel_bit);
292 ret = regmap_write(rcg->clkr.regmap, rcg->bank_reg, reg);
293 if (ret)
294 return ret;
295 }
296 return 0;
297 }
298
299 static int clk_dyn_rcg_set_parent(struct clk_hw *hw, u8 index)
300 {
301 struct clk_dyn_rcg *rcg = to_clk_dyn_rcg(hw);
302 u32 ns, md, reg;
303 int bank;
304 struct freq_tbl f = { 0 };
305 bool banked_mn = !!rcg->mn[1].width;
306 bool banked_p = !!rcg->p[1].pre_div_width;
307
308 regmap_read(rcg->clkr.regmap, rcg->bank_reg, &reg);
309 bank = reg_to_bank(rcg, reg);
310
311 regmap_read(rcg->clkr.regmap, rcg->ns_reg[bank], &ns);
312
313 if (banked_mn) {
314 regmap_read(rcg->clkr.regmap, rcg->md_reg[bank], &md);
315 f.m = md_to_m(&rcg->mn[bank], md);
316 f.n = ns_m_to_n(&rcg->mn[bank], ns, f.m);
317 }
318
319 if (banked_p)
320 f.pre_div = ns_to_pre_div(&rcg->p[bank], ns) + 1;
321
322 f.src = index;
323 return configure_bank(rcg, &f);
324 }
325
326 /*
327 * Calculate m/n:d rate
328 *
329 * parent_rate m
330 * rate = ----------- x ---
331 * pre_div n
332 */
333 static unsigned long
334 calc_rate(unsigned long rate, u32 m, u32 n, u32 mode, u32 pre_div)
335 {
336 if (pre_div)
337 rate /= pre_div + 1;
338
339 if (mode) {
340 u64 tmp = rate;
341 tmp *= m;
342 do_div(tmp, n);
343 rate = tmp;
344 }
345
346 return rate;
347 }
348
349 static unsigned long
350 clk_rcg_recalc_rate(struct clk_hw *hw, unsigned long parent_rate)
351 {
352 struct clk_rcg *rcg = to_clk_rcg(hw);
353 u32 pre_div, m = 0, n = 0, ns, md, mode = 0;
354 struct mn *mn = &rcg->mn;
355
356 regmap_read(rcg->clkr.regmap, rcg->ns_reg, &ns);
357 pre_div = ns_to_pre_div(&rcg->p, ns);
358
359 if (rcg->mn.width) {
360 regmap_read(rcg->clkr.regmap, rcg->md_reg, &md);
361 m = md_to_m(mn, md);
362 n = ns_m_to_n(mn, ns, m);
363 /* MN counter mode is in hw.enable_reg sometimes */
364 if (rcg->clkr.enable_reg != rcg->ns_reg)
365 regmap_read(rcg->clkr.regmap, rcg->clkr.enable_reg, &mode);
366 else
367 mode = ns;
368 mode = reg_to_mnctr_mode(mn, mode);
369 }
370
371 return calc_rate(parent_rate, m, n, mode, pre_div);
372 }
373
374 static unsigned long
375 clk_dyn_rcg_recalc_rate(struct clk_hw *hw, unsigned long parent_rate)
376 {
377 struct clk_dyn_rcg *rcg = to_clk_dyn_rcg(hw);
378 u32 m, n, pre_div, ns, md, mode, reg;
379 int bank;
380 struct mn *mn;
381 bool banked_p = !!rcg->p[1].pre_div_width;
382 bool banked_mn = !!rcg->mn[1].width;
383
384 regmap_read(rcg->clkr.regmap, rcg->bank_reg, &reg);
385 bank = reg_to_bank(rcg, reg);
386
387 regmap_read(rcg->clkr.regmap, rcg->ns_reg[bank], &ns);
388 m = n = pre_div = mode = 0;
389
390 if (banked_mn) {
391 mn = &rcg->mn[bank];
392 regmap_read(rcg->clkr.regmap, rcg->md_reg[bank], &md);
393 m = md_to_m(mn, md);
394 n = ns_m_to_n(mn, ns, m);
395 /* Two NS registers means mode control is in NS register */
396 if (rcg->ns_reg[0] != rcg->ns_reg[1])
397 reg = ns;
398 mode = reg_to_mnctr_mode(mn, reg);
399 }
400
401 if (banked_p)
402 pre_div = ns_to_pre_div(&rcg->p[bank], ns);
403
404 return calc_rate(parent_rate, m, n, mode, pre_div);
405 }
406
407 static long _freq_tbl_determine_rate(struct clk_hw *hw,
408 const struct freq_tbl *f, unsigned long rate,
409 unsigned long min_rate, unsigned long max_rate,
410 unsigned long *p_rate, struct clk_hw **p_hw)
411 {
412 unsigned long clk_flags;
413 struct clk *p;
414
415 f = qcom_find_freq(f, rate);
416 if (!f)
417 return -EINVAL;
418
419 clk_flags = __clk_get_flags(hw->clk);
420 p = clk_get_parent_by_index(hw->clk, f->src);
421 if (clk_flags & CLK_SET_RATE_PARENT) {
422 rate = rate * f->pre_div;
423 if (f->n) {
424 u64 tmp = rate;
425 tmp = tmp * f->n;
426 do_div(tmp, f->m);
427 rate = tmp;
428 }
429 } else {
430 rate = __clk_get_rate(p);
431 }
432 *p_hw = __clk_get_hw(p);
433 *p_rate = rate;
434
435 return f->freq;
436 }
437
438 static long clk_rcg_determine_rate(struct clk_hw *hw, unsigned long rate,
439 unsigned long min_rate, unsigned long max_rate,
440 unsigned long *p_rate, struct clk_hw **p)
441 {
442 struct clk_rcg *rcg = to_clk_rcg(hw);
443
444 return _freq_tbl_determine_rate(hw, rcg->freq_tbl, rate, min_rate,
445 max_rate, p_rate, p);
446 }
447
448 static long clk_dyn_rcg_determine_rate(struct clk_hw *hw, unsigned long rate,
449 unsigned long min_rate, unsigned long max_rate,
450 unsigned long *p_rate, struct clk_hw **p)
451 {
452 struct clk_dyn_rcg *rcg = to_clk_dyn_rcg(hw);
453
454 return _freq_tbl_determine_rate(hw, rcg->freq_tbl, rate, min_rate,
455 max_rate, p_rate, p);
456 }
457
458 static long clk_rcg_bypass_determine_rate(struct clk_hw *hw, unsigned long rate,
459 unsigned long min_rate, unsigned long max_rate,
460 unsigned long *p_rate, struct clk_hw **p_hw)
461 {
462 struct clk_rcg *rcg = to_clk_rcg(hw);
463 const struct freq_tbl *f = rcg->freq_tbl;
464 struct clk *p;
465
466 p = clk_get_parent_by_index(hw->clk, f->src);
467 *p_hw = __clk_get_hw(p);
468 *p_rate = __clk_round_rate(p, rate);
469
470 return *p_rate;
471 }
472
473 static int __clk_rcg_set_rate(struct clk_rcg *rcg, const struct freq_tbl *f)
474 {
475 u32 ns, md, ctl;
476 struct mn *mn = &rcg->mn;
477 u32 mask = 0;
478 unsigned int reset_reg;
479
480 if (rcg->mn.reset_in_cc)
481 reset_reg = rcg->clkr.enable_reg;
482 else
483 reset_reg = rcg->ns_reg;
484
485 if (rcg->mn.width) {
486 mask = BIT(mn->mnctr_reset_bit);
487 regmap_update_bits(rcg->clkr.regmap, reset_reg, mask, mask);
488
489 regmap_read(rcg->clkr.regmap, rcg->md_reg, &md);
490 md = mn_to_md(mn, f->m, f->n, md);
491 regmap_write(rcg->clkr.regmap, rcg->md_reg, md);
492
493 regmap_read(rcg->clkr.regmap, rcg->ns_reg, &ns);
494 /* MN counter mode is in hw.enable_reg sometimes */
495 if (rcg->clkr.enable_reg != rcg->ns_reg) {
496 regmap_read(rcg->clkr.regmap, rcg->clkr.enable_reg, &ctl);
497 ctl = mn_to_reg(mn, f->m, f->n, ctl);
498 regmap_write(rcg->clkr.regmap, rcg->clkr.enable_reg, ctl);
499 } else {
500 ns = mn_to_reg(mn, f->m, f->n, ns);
501 }
502 ns = mn_to_ns(mn, f->m, f->n, ns);
503 } else {
504 regmap_read(rcg->clkr.regmap, rcg->ns_reg, &ns);
505 }
506
507 ns = pre_div_to_ns(&rcg->p, f->pre_div - 1, ns);
508 regmap_write(rcg->clkr.regmap, rcg->ns_reg, ns);
509
510 regmap_update_bits(rcg->clkr.regmap, reset_reg, mask, 0);
511
512 return 0;
513 }
514
515 static int clk_rcg_set_rate(struct clk_hw *hw, unsigned long rate,
516 unsigned long parent_rate)
517 {
518 struct clk_rcg *rcg = to_clk_rcg(hw);
519 const struct freq_tbl *f;
520
521 f = qcom_find_freq(rcg->freq_tbl, rate);
522 if (!f)
523 return -EINVAL;
524
525 return __clk_rcg_set_rate(rcg, f);
526 }
527
528 static int clk_rcg_bypass_set_rate(struct clk_hw *hw, unsigned long rate,
529 unsigned long parent_rate)
530 {
531 struct clk_rcg *rcg = to_clk_rcg(hw);
532
533 return __clk_rcg_set_rate(rcg, rcg->freq_tbl);
534 }
535
536 /*
537 * This type of clock has a glitch-free mux that switches between the output of
538 * the M/N counter and an always on clock source (XO). When clk_set_rate() is
539 * called we need to make sure that we don't switch to the M/N counter if it
540 * isn't clocking because the mux will get stuck and the clock will stop
541 * outputting a clock. This can happen if the framework isn't aware that this
542 * clock is on and so clk_set_rate() doesn't turn on the new parent. To fix
543 * this we switch the mux in the enable/disable ops and reprogram the M/N
544 * counter in the set_rate op. We also make sure to switch away from the M/N
545 * counter in set_rate if software thinks the clock is off.
546 */
547 static int clk_rcg_lcc_set_rate(struct clk_hw *hw, unsigned long rate,
548 unsigned long parent_rate)
549 {
550 struct clk_rcg *rcg = to_clk_rcg(hw);
551 const struct freq_tbl *f;
552 int ret;
553 u32 gfm = BIT(10);
554
555 f = qcom_find_freq(rcg->freq_tbl, rate);
556 if (!f)
557 return -EINVAL;
558
559 /* Switch to XO to avoid glitches */
560 regmap_update_bits(rcg->clkr.regmap, rcg->ns_reg, gfm, 0);
561 ret = __clk_rcg_set_rate(rcg, f);
562 /* Switch back to M/N if it's clocking */
563 if (__clk_is_enabled(hw->clk))
564 regmap_update_bits(rcg->clkr.regmap, rcg->ns_reg, gfm, gfm);
565
566 return ret;
567 }
568
569 static int clk_rcg_lcc_enable(struct clk_hw *hw)
570 {
571 struct clk_rcg *rcg = to_clk_rcg(hw);
572 u32 gfm = BIT(10);
573
574 /* Use M/N */
575 return regmap_update_bits(rcg->clkr.regmap, rcg->ns_reg, gfm, gfm);
576 }
577
578 static void clk_rcg_lcc_disable(struct clk_hw *hw)
579 {
580 struct clk_rcg *rcg = to_clk_rcg(hw);
581 u32 gfm = BIT(10);
582
583 /* Use XO */
584 regmap_update_bits(rcg->clkr.regmap, rcg->ns_reg, gfm, 0);
585 }
586
587 static int __clk_dyn_rcg_set_rate(struct clk_hw *hw, unsigned long rate)
588 {
589 struct clk_dyn_rcg *rcg = to_clk_dyn_rcg(hw);
590 const struct freq_tbl *f;
591
592 f = qcom_find_freq(rcg->freq_tbl, rate);
593 if (!f)
594 return -EINVAL;
595
596 return configure_bank(rcg, f);
597 }
598
599 static int clk_dyn_rcg_set_rate(struct clk_hw *hw, unsigned long rate,
600 unsigned long parent_rate)
601 {
602 return __clk_dyn_rcg_set_rate(hw, rate);
603 }
604
605 static int clk_dyn_rcg_set_rate_and_parent(struct clk_hw *hw,
606 unsigned long rate, unsigned long parent_rate, u8 index)
607 {
608 return __clk_dyn_rcg_set_rate(hw, rate);
609 }
610
611 const struct clk_ops clk_rcg_ops = {
612 .enable = clk_enable_regmap,
613 .disable = clk_disable_regmap,
614 .get_parent = clk_rcg_get_parent,
615 .set_parent = clk_rcg_set_parent,
616 .recalc_rate = clk_rcg_recalc_rate,
617 .determine_rate = clk_rcg_determine_rate,
618 .set_rate = clk_rcg_set_rate,
619 };
620 EXPORT_SYMBOL_GPL(clk_rcg_ops);
621
622 const struct clk_ops clk_rcg_bypass_ops = {
623 .enable = clk_enable_regmap,
624 .disable = clk_disable_regmap,
625 .get_parent = clk_rcg_get_parent,
626 .set_parent = clk_rcg_set_parent,
627 .recalc_rate = clk_rcg_recalc_rate,
628 .determine_rate = clk_rcg_bypass_determine_rate,
629 .set_rate = clk_rcg_bypass_set_rate,
630 };
631 EXPORT_SYMBOL_GPL(clk_rcg_bypass_ops);
632
633 const struct clk_ops clk_rcg_lcc_ops = {
634 .enable = clk_rcg_lcc_enable,
635 .disable = clk_rcg_lcc_disable,
636 .get_parent = clk_rcg_get_parent,
637 .set_parent = clk_rcg_set_parent,
638 .recalc_rate = clk_rcg_recalc_rate,
639 .determine_rate = clk_rcg_determine_rate,
640 .set_rate = clk_rcg_lcc_set_rate,
641 };
642 EXPORT_SYMBOL_GPL(clk_rcg_lcc_ops);
643
644 const struct clk_ops clk_dyn_rcg_ops = {
645 .enable = clk_enable_regmap,
646 .is_enabled = clk_is_enabled_regmap,
647 .disable = clk_disable_regmap,
648 .get_parent = clk_dyn_rcg_get_parent,
649 .set_parent = clk_dyn_rcg_set_parent,
650 .recalc_rate = clk_dyn_rcg_recalc_rate,
651 .determine_rate = clk_dyn_rcg_determine_rate,
652 .set_rate = clk_dyn_rcg_set_rate,
653 .set_rate_and_parent = clk_dyn_rcg_set_rate_and_parent,
654 };
655 EXPORT_SYMBOL_GPL(clk_dyn_rcg_ops);
This page took 0.047824 seconds and 5 git commands to generate.