1 From 75d5d1d584ae73ba0c36d1d7255db6153ca4d3f3 Mon Sep 17 00:00:00 2001
2 From: Claudiu Beznea <claudiu.beznea@microchip.com>
3 Date: Mon, 11 Oct 2021 14:27:16 +0300
4 Subject: [PATCH 244/247] clk: at91: clk-master: add notifier for divider
6 SAMA7G5 supports DVFS by changing cpuck. On SAMA7G5 mck0 shares the same
7 parent with cpuck as seen in the following clock tree:
11 FRAC PLL ---> DIV PLL -+-> DIV ---> mck0
13 mck0 could go b/w 32KHz and 200MHz on SAMA7G5. To avoid mck0 overclocking
14 while changing FRAC PLL or DIV PLL the commit implements a notifier for
15 mck0 which applies a safe divider to register (maximum value of the divider
16 which is 5) on PRE_RATE_CHANGE events (such that changes on PLL to not
17 overclock mck0) and sets the maximum allowed rate on POST_RATE_CHANGE
20 Signed-off-by: Claudiu Beznea <claudiu.beznea@microchip.com>
21 Link: https://lore.kernel.org/r/20211011112719.3951784-13-claudiu.beznea@microchip.com
22 Acked-by: Nicolas Ferre <nicolas.ferre@microchip.com>
23 Signed-off-by: Stephen Boyd <sboyd@kernel.org>
25 drivers/clk/at91/at91rm9200.c | 2 +-
26 drivers/clk/at91/at91sam9260.c | 2 +-
27 drivers/clk/at91/at91sam9g45.c | 2 +-
28 drivers/clk/at91/at91sam9n12.c | 2 +-
29 drivers/clk/at91/at91sam9rl.c | 2 +-
30 drivers/clk/at91/at91sam9x5.c | 2 +-
31 drivers/clk/at91/clk-master.c | 244 +++++++++++++++++++++++----------
32 drivers/clk/at91/dt-compat.c | 2 +-
33 drivers/clk/at91/pmc.h | 2 +-
34 drivers/clk/at91/sama5d2.c | 2 +-
35 drivers/clk/at91/sama5d3.c | 2 +-
36 drivers/clk/at91/sama5d4.c | 2 +-
37 drivers/clk/at91/sama7g5.c | 2 +-
38 13 files changed, 186 insertions(+), 82 deletions(-)
40 --- a/drivers/clk/at91/at91rm9200.c
41 +++ b/drivers/clk/at91/at91rm9200.c
42 @@ -152,7 +152,7 @@ static void __init at91rm9200_pmc_setup(
44 &at91rm9200_master_layout,
45 &rm9200_mck_characteristics,
46 - &rm9200_mck_lock, CLK_SET_RATE_GATE);
47 + &rm9200_mck_lock, CLK_SET_RATE_GATE, 0);
51 --- a/drivers/clk/at91/at91sam9260.c
52 +++ b/drivers/clk/at91/at91sam9260.c
53 @@ -429,7 +429,7 @@ static void __init at91sam926x_pmc_setup
54 &at91rm9200_master_layout,
55 data->mck_characteristics,
56 &at91sam9260_mck_lock,
58 + CLK_SET_RATE_GATE, 0);
62 --- a/drivers/clk/at91/at91sam9g45.c
63 +++ b/drivers/clk/at91/at91sam9g45.c
64 @@ -164,7 +164,7 @@ static void __init at91sam9g45_pmc_setup
65 &at91rm9200_master_layout,
67 &at91sam9g45_mck_lock,
69 + CLK_SET_RATE_GATE, 0);
73 --- a/drivers/clk/at91/at91sam9n12.c
74 +++ b/drivers/clk/at91/at91sam9n12.c
75 @@ -191,7 +191,7 @@ static void __init at91sam9n12_pmc_setup
76 &at91sam9x5_master_layout,
78 &at91sam9n12_mck_lock,
80 + CLK_SET_RATE_GATE, 0);
84 --- a/drivers/clk/at91/at91sam9rl.c
85 +++ b/drivers/clk/at91/at91sam9rl.c
86 @@ -132,7 +132,7 @@ static void __init at91sam9rl_pmc_setup(
88 &at91rm9200_master_layout,
89 &sam9rl_mck_characteristics,
90 - &sam9rl_mck_lock, CLK_SET_RATE_GATE);
91 + &sam9rl_mck_lock, CLK_SET_RATE_GATE, 0);
95 --- a/drivers/clk/at91/at91sam9x5.c
96 +++ b/drivers/clk/at91/at91sam9x5.c
97 @@ -210,7 +210,7 @@ static void __init at91sam9x5_pmc_setup(
99 &at91sam9x5_master_layout,
100 &mck_characteristics, &mck_lock,
101 - CLK_SET_RATE_GATE);
102 + CLK_SET_RATE_GATE, 0);
106 --- a/drivers/clk/at91/clk-master.c
107 +++ b/drivers/clk/at91/clk-master.c
110 #include <linux/clk-provider.h>
111 #include <linux/clkdev.h>
112 +#include <linux/clk.h>
113 #include <linux/clk/at91_pmc.h>
114 #include <linux/of.h>
115 #include <linux/mfd/syscon.h>
116 @@ -36,8 +37,12 @@ struct clk_master {
123 +/* MCK div reference to be used by notifier. */
124 +static struct clk_master *master_div;
126 static inline bool clk_master_ready(struct clk_master *master)
128 unsigned int bit = master->id ? AT91_PMC_MCKXRDY : AT91_PMC_MCKRDY;
129 @@ -153,107 +158,81 @@ static const struct clk_ops master_div_o
130 .restore_context = clk_master_div_restore_context,
133 -static int clk_master_div_set_rate(struct clk_hw *hw, unsigned long rate,
134 - unsigned long parent_rate)
135 +/* This function must be called with lock acquired. */
136 +static int clk_master_div_set(struct clk_master *master,
137 + unsigned long parent_rate, int div)
139 - struct clk_master *master = to_clk_master(hw);
140 const struct clk_master_characteristics *characteristics =
141 master->characteristics;
142 - unsigned long flags;
143 - unsigned int mckr, tmp;
145 + unsigned long rate = parent_rate;
146 + unsigned int max_div = 0, div_index = 0, max_div_index = 0;
147 + unsigned int i, mckr, tmp;
150 - div = DIV_ROUND_CLOSEST(parent_rate, rate);
151 - if (div > ARRAY_SIZE(characteristics->divisors))
154 for (i = 0; i < ARRAY_SIZE(characteristics->divisors); i++) {
155 if (!characteristics->divisors[i])
158 - if (div == characteristics->divisors[i]) {
161 + if (div == characteristics->divisors[i])
164 + if (max_div < characteristics->divisors[i]) {
165 + max_div = characteristics->divisors[i];
170 - if (i == ARRAY_SIZE(characteristics->divisors))
173 + div_index = max_div_index;
175 - spin_lock_irqsave(master->lock, flags);
176 ret = regmap_read(master->regmap, master->layout->offset, &mckr);
181 mckr &= master->layout->mask;
182 tmp = (mckr >> MASTER_DIV_SHIFT) & MASTER_DIV_MASK;
185 + if (tmp == div_index)
188 + rate /= characteristics->divisors[div_index];
189 + if (rate < characteristics->output.min)
190 + pr_warn("master clk div is underclocked");
191 + else if (rate > characteristics->output.max)
192 + pr_warn("master clk div is overclocked");
194 mckr &= ~(MASTER_DIV_MASK << MASTER_DIV_SHIFT);
195 - mckr |= (div << MASTER_DIV_SHIFT);
196 + mckr |= (div_index << MASTER_DIV_SHIFT);
197 ret = regmap_write(master->regmap, master->layout->offset, mckr);
202 while (!clk_master_ready(master))
205 - spin_unlock_irqrestore(master->lock, flags);
207 + master->div = characteristics->divisors[div_index];
212 -static int clk_master_div_determine_rate(struct clk_hw *hw,
213 - struct clk_rate_request *req)
214 +static unsigned long clk_master_div_recalc_rate_chg(struct clk_hw *hw,
215 + unsigned long parent_rate)
217 struct clk_master *master = to_clk_master(hw);
218 - const struct clk_master_characteristics *characteristics =
219 - master->characteristics;
220 - struct clk_hw *parent;
221 - unsigned long parent_rate, tmp_rate, best_rate = 0;
222 - int i, best_diff = INT_MIN, tmp_diff;
224 - parent = clk_hw_get_parent(hw);
228 - parent_rate = clk_hw_get_rate(parent);
232 - for (i = 0; i < ARRAY_SIZE(characteristics->divisors); i++) {
233 - if (!characteristics->divisors[i])
236 - tmp_rate = DIV_ROUND_CLOSEST_ULL(parent_rate,
237 - characteristics->divisors[i]);
238 - tmp_diff = abs(tmp_rate - req->rate);
240 - if (!best_rate || best_diff > tmp_diff) {
241 - best_diff = tmp_diff;
242 - best_rate = tmp_rate;
249 - req->best_parent_rate = best_rate;
250 - req->best_parent_hw = parent;
251 - req->rate = best_rate;
254 + return DIV_ROUND_CLOSEST_ULL(parent_rate, master->div);
257 static void clk_master_div_restore_context_chg(struct clk_hw *hw)
259 struct clk_master *master = to_clk_master(hw);
260 + unsigned long flags;
263 - ret = clk_master_div_set_rate(hw, master->pms.rate,
264 - master->pms.parent_rate);
265 + spin_lock_irqsave(master->lock, flags);
266 + ret = clk_master_div_set(master, master->pms.parent_rate,
267 + DIV_ROUND_CLOSEST(master->pms.parent_rate,
268 + master->pms.rate));
269 + spin_unlock_irqrestore(master->lock, flags);
271 pr_warn("Failed to restore MCK DIV clock\n");
273 @@ -261,13 +240,116 @@ static void clk_master_div_restore_conte
274 static const struct clk_ops master_div_ops_chg = {
275 .prepare = clk_master_prepare,
276 .is_prepared = clk_master_is_prepared,
277 - .recalc_rate = clk_master_div_recalc_rate,
278 - .determine_rate = clk_master_div_determine_rate,
279 - .set_rate = clk_master_div_set_rate,
280 + .recalc_rate = clk_master_div_recalc_rate_chg,
281 .save_context = clk_master_div_save_context,
282 .restore_context = clk_master_div_restore_context_chg,
285 +static int clk_master_div_notifier_fn(struct notifier_block *notifier,
286 + unsigned long code, void *data)
288 + const struct clk_master_characteristics *characteristics =
289 + master_div->characteristics;
290 + struct clk_notifier_data *cnd = data;
291 + unsigned long flags, new_parent_rate, new_rate;
292 + unsigned int mckr, div, new_div = 0;
295 + long best_diff = -1;
297 + spin_lock_irqsave(master_div->lock, flags);
299 + case PRE_RATE_CHANGE:
301 + * We want to avoid any overclocking of MCK DIV domain. To do
302 + * this we set a safe divider (the underclocking is not of
303 + * interest as we can go as low as 32KHz). The relation
304 + * b/w this clock and its parents are as follows:
306 + * FRAC PLL -> DIV PLL -> MCK DIV
308 + * With the proper safe divider we should be good even with FRAC
309 + * PLL at its maximum value.
311 + ret = regmap_read(master_div->regmap, master_div->layout->offset,
314 + ret = NOTIFY_STOP_MASK;
318 + mckr &= master_div->layout->mask;
319 + div = (mckr >> MASTER_DIV_SHIFT) & MASTER_DIV_MASK;
321 + /* Switch to safe divider. */
322 + clk_master_div_set(master_div,
323 + cnd->old_rate * characteristics->divisors[div],
324 + master_div->safe_div);
327 + case POST_RATE_CHANGE:
329 + * At this point we want to restore MCK DIV domain to its maximum
332 + ret = regmap_read(master_div->regmap, master_div->layout->offset,
335 + ret = NOTIFY_STOP_MASK;
339 + mckr &= master_div->layout->mask;
340 + div = (mckr >> MASTER_DIV_SHIFT) & MASTER_DIV_MASK;
341 + new_parent_rate = cnd->new_rate * characteristics->divisors[div];
343 + for (i = 0; i < ARRAY_SIZE(characteristics->divisors); i++) {
344 + if (!characteristics->divisors[i])
347 + new_rate = DIV_ROUND_CLOSEST_ULL(new_parent_rate,
348 + characteristics->divisors[i]);
350 + tmp_diff = characteristics->output.max - new_rate;
354 + if (best_diff < 0 || best_diff > tmp_diff) {
355 + new_div = characteristics->divisors[i];
356 + best_diff = tmp_diff;
364 + ret = NOTIFY_STOP_MASK;
368 + /* Update the div to preserve MCK DIV clock rate. */
369 + clk_master_div_set(master_div, new_parent_rate,
381 + spin_unlock_irqrestore(master_div->lock, flags);
386 +static struct notifier_block clk_master_div_notifier = {
387 + .notifier_call = clk_master_div_notifier_fn,
390 static void clk_sama7g5_master_best_diff(struct clk_rate_request *req,
391 struct clk_hw *parent,
392 unsigned long parent_rate,
393 @@ -496,6 +578,8 @@ at91_clk_register_master_internal(struct
394 struct clk_master *master;
395 struct clk_init_data init;
398 + unsigned long irqflags;
401 if (!name || !num_parents || !parent_names || !lock)
402 @@ -518,6 +602,16 @@ at91_clk_register_master_internal(struct
403 master->chg_pid = chg_pid;
406 + if (ops == &master_div_ops_chg) {
407 + spin_lock_irqsave(master->lock, irqflags);
408 + regmap_read(master->regmap, master->layout->offset, &mckr);
409 + spin_unlock_irqrestore(master->lock, irqflags);
411 + mckr &= layout->mask;
412 + mckr = (mckr >> MASTER_DIV_SHIFT) & MASTER_DIV_MASK;
413 + master->div = characteristics->divisors[mckr];
417 ret = clk_hw_register(NULL, &master->hw);
419 @@ -554,19 +648,29 @@ at91_clk_register_master_div(struct regm
420 const char *name, const char *parent_name,
421 const struct clk_master_layout *layout,
422 const struct clk_master_characteristics *characteristics,
423 - spinlock_t *lock, u32 flags)
424 + spinlock_t *lock, u32 flags, u32 safe_div)
426 const struct clk_ops *ops;
429 if (flags & CLK_SET_RATE_GATE)
430 ops = &master_div_ops;
432 ops = &master_div_ops_chg;
434 - return at91_clk_register_master_internal(regmap, name, 1,
435 - &parent_name, layout,
436 - characteristics, ops,
437 - lock, flags, -EINVAL);
438 + hw = at91_clk_register_master_internal(regmap, name, 1,
439 + &parent_name, layout,
440 + characteristics, ops,
441 + lock, flags, -EINVAL);
443 + if (!IS_ERR(hw) && safe_div) {
444 + master_div = to_clk_master(hw);
445 + master_div->safe_div = safe_div;
446 + clk_notifier_register(hw->clk,
447 + &clk_master_div_notifier);
454 --- a/drivers/clk/at91/dt-compat.c
455 +++ b/drivers/clk/at91/dt-compat.c
456 @@ -399,7 +399,7 @@ of_at91_clk_master_setup(struct device_n
458 hw = at91_clk_register_master_div(regmap, name, "masterck_pres",
459 layout, characteristics,
460 - &mck_lock, CLK_SET_RATE_GATE);
461 + &mck_lock, CLK_SET_RATE_GATE, 0);
463 goto out_free_characteristics;
465 --- a/drivers/clk/at91/pmc.h
466 +++ b/drivers/clk/at91/pmc.h
467 @@ -182,7 +182,7 @@ at91_clk_register_master_div(struct regm
468 const char *parent_names,
469 const struct clk_master_layout *layout,
470 const struct clk_master_characteristics *characteristics,
471 - spinlock_t *lock, u32 flags);
472 + spinlock_t *lock, u32 flags, u32 safe_div);
474 struct clk_hw * __init
475 at91_clk_sama7g5_register_master(struct regmap *regmap,
476 --- a/drivers/clk/at91/sama5d2.c
477 +++ b/drivers/clk/at91/sama5d2.c
478 @@ -249,7 +249,7 @@ static void __init sama5d2_pmc_setup(str
480 &at91sam9x5_master_layout,
481 &mck_characteristics, &mck_lock,
482 - CLK_SET_RATE_GATE);
483 + CLK_SET_RATE_GATE, 0);
487 --- a/drivers/clk/at91/sama5d3.c
488 +++ b/drivers/clk/at91/sama5d3.c
489 @@ -184,7 +184,7 @@ static void __init sama5d3_pmc_setup(str
491 &at91sam9x5_master_layout,
492 &mck_characteristics, &mck_lock,
493 - CLK_SET_RATE_GATE);
494 + CLK_SET_RATE_GATE, 0);
498 --- a/drivers/clk/at91/sama5d4.c
499 +++ b/drivers/clk/at91/sama5d4.c
500 @@ -199,7 +199,7 @@ static void __init sama5d4_pmc_setup(str
502 &at91sam9x5_master_layout,
503 &mck_characteristics, &mck_lock,
504 - CLK_SET_RATE_GATE);
505 + CLK_SET_RATE_GATE, 0);
509 --- a/drivers/clk/at91/sama7g5.c
510 +++ b/drivers/clk/at91/sama7g5.c
511 @@ -1003,7 +1003,7 @@ static void __init sama7g5_pmc_setup(str
513 hw = at91_clk_register_master_div(regmap, "mck0", "cpuck",
514 &mck0_layout, &mck0_characteristics,
515 - &pmc_mck0_lock, 0);
516 + &pmc_mck0_lock, CLK_GET_RATE_NOCACHE, 5);