Commit | Line | Data |
---|---|---|
b2476490 MT |
1 | /* |
2 | * Copyright (C) 2010-2011 Canonical Ltd <jeremy.kerr@canonical.com> | |
3 | * Copyright (C) 2011-2012 Linaro Ltd <mturquette@linaro.org> | |
4 | * | |
5 | * This program is free software; you can redistribute it and/or modify | |
6 | * it under the terms of the GNU General Public License version 2 as | |
7 | * published by the Free Software Foundation. | |
8 | * | |
9 | * Standard functionality for the common clock API. See Documentation/clk.txt | |
10 | */ | |
11 | ||
12 | #include <linux/clk-private.h> | |
86be408b | 13 | #include <linux/clk/clk-conf.h> |
b2476490 MT |
14 | #include <linux/module.h> |
15 | #include <linux/mutex.h> | |
16 | #include <linux/spinlock.h> | |
17 | #include <linux/err.h> | |
18 | #include <linux/list.h> | |
19 | #include <linux/slab.h> | |
766e6a4e | 20 | #include <linux/of.h> |
46c8773a | 21 | #include <linux/device.h> |
f2f6c255 | 22 | #include <linux/init.h> |
533ddeb1 | 23 | #include <linux/sched.h> |
b2476490 | 24 | |
d6782c26 SN |
25 | #include "clk.h" |
26 | ||
b2476490 MT |
27 | static DEFINE_SPINLOCK(enable_lock); |
28 | static DEFINE_MUTEX(prepare_lock); | |
29 | ||
533ddeb1 MT |
30 | static struct task_struct *prepare_owner; |
31 | static struct task_struct *enable_owner; | |
32 | ||
33 | static int prepare_refcnt; | |
34 | static int enable_refcnt; | |
35 | ||
b2476490 MT |
36 | static HLIST_HEAD(clk_root_list); |
37 | static HLIST_HEAD(clk_orphan_list); | |
38 | static LIST_HEAD(clk_notifier_list); | |
39 | ||
eab89f69 MT |
40 | /*** locking ***/ |
41 | static void clk_prepare_lock(void) | |
42 | { | |
533ddeb1 MT |
43 | if (!mutex_trylock(&prepare_lock)) { |
44 | if (prepare_owner == current) { | |
45 | prepare_refcnt++; | |
46 | return; | |
47 | } | |
48 | mutex_lock(&prepare_lock); | |
49 | } | |
50 | WARN_ON_ONCE(prepare_owner != NULL); | |
51 | WARN_ON_ONCE(prepare_refcnt != 0); | |
52 | prepare_owner = current; | |
53 | prepare_refcnt = 1; | |
eab89f69 MT |
54 | } |
55 | ||
56 | static void clk_prepare_unlock(void) | |
57 | { | |
533ddeb1 MT |
58 | WARN_ON_ONCE(prepare_owner != current); |
59 | WARN_ON_ONCE(prepare_refcnt == 0); | |
60 | ||
61 | if (--prepare_refcnt) | |
62 | return; | |
63 | prepare_owner = NULL; | |
eab89f69 MT |
64 | mutex_unlock(&prepare_lock); |
65 | } | |
66 | ||
67 | static unsigned long clk_enable_lock(void) | |
68 | { | |
69 | unsigned long flags; | |
533ddeb1 MT |
70 | |
71 | if (!spin_trylock_irqsave(&enable_lock, flags)) { | |
72 | if (enable_owner == current) { | |
73 | enable_refcnt++; | |
74 | return flags; | |
75 | } | |
76 | spin_lock_irqsave(&enable_lock, flags); | |
77 | } | |
78 | WARN_ON_ONCE(enable_owner != NULL); | |
79 | WARN_ON_ONCE(enable_refcnt != 0); | |
80 | enable_owner = current; | |
81 | enable_refcnt = 1; | |
eab89f69 MT |
82 | return flags; |
83 | } | |
84 | ||
85 | static void clk_enable_unlock(unsigned long flags) | |
86 | { | |
533ddeb1 MT |
87 | WARN_ON_ONCE(enable_owner != current); |
88 | WARN_ON_ONCE(enable_refcnt == 0); | |
89 | ||
90 | if (--enable_refcnt) | |
91 | return; | |
92 | enable_owner = NULL; | |
eab89f69 MT |
93 | spin_unlock_irqrestore(&enable_lock, flags); |
94 | } | |
95 | ||
b2476490 MT |
96 | /*** debugfs support ***/ |
97 | ||
ea72dc2c | 98 | #ifdef CONFIG_DEBUG_FS |
b2476490 MT |
99 | #include <linux/debugfs.h> |
100 | ||
101 | static struct dentry *rootdir; | |
b2476490 MT |
102 | static int inited = 0; |
103 | ||
6b44c854 SK |
104 | static struct hlist_head *all_lists[] = { |
105 | &clk_root_list, | |
106 | &clk_orphan_list, | |
107 | NULL, | |
108 | }; | |
109 | ||
110 | static struct hlist_head *orphan_list[] = { | |
111 | &clk_orphan_list, | |
112 | NULL, | |
113 | }; | |
114 | ||
1af599df PG |
115 | static void clk_summary_show_one(struct seq_file *s, struct clk *c, int level) |
116 | { | |
117 | if (!c) | |
118 | return; | |
119 | ||
e59c5371 | 120 | seq_printf(s, "%*s%-*s %11d %12d %11lu %10lu %-3d\n", |
1af599df PG |
121 | level * 3 + 1, "", |
122 | 30 - level * 3, c->name, | |
5279fc40 | 123 | c->enable_count, c->prepare_count, clk_get_rate(c), |
e59c5371 | 124 | clk_get_accuracy(c), clk_get_phase(c)); |
1af599df PG |
125 | } |
126 | ||
127 | static void clk_summary_show_subtree(struct seq_file *s, struct clk *c, | |
128 | int level) | |
129 | { | |
130 | struct clk *child; | |
1af599df PG |
131 | |
132 | if (!c) | |
133 | return; | |
134 | ||
135 | clk_summary_show_one(s, c, level); | |
136 | ||
b67bfe0d | 137 | hlist_for_each_entry(child, &c->children, child_node) |
1af599df PG |
138 | clk_summary_show_subtree(s, child, level + 1); |
139 | } | |
140 | ||
141 | static int clk_summary_show(struct seq_file *s, void *data) | |
142 | { | |
143 | struct clk *c; | |
27b8d5f7 | 144 | struct hlist_head **lists = (struct hlist_head **)s->private; |
1af599df | 145 | |
e59c5371 MT |
146 | seq_puts(s, " clock enable_cnt prepare_cnt rate accuracy phase\n"); |
147 | seq_puts(s, "----------------------------------------------------------------------------------------\n"); | |
1af599df | 148 | |
eab89f69 | 149 | clk_prepare_lock(); |
1af599df | 150 | |
27b8d5f7 PDS |
151 | for (; *lists; lists++) |
152 | hlist_for_each_entry(c, *lists, child_node) | |
153 | clk_summary_show_subtree(s, c, 0); | |
1af599df | 154 | |
eab89f69 | 155 | clk_prepare_unlock(); |
1af599df PG |
156 | |
157 | return 0; | |
158 | } | |
159 | ||
160 | ||
161 | static int clk_summary_open(struct inode *inode, struct file *file) | |
162 | { | |
163 | return single_open(file, clk_summary_show, inode->i_private); | |
164 | } | |
165 | ||
166 | static const struct file_operations clk_summary_fops = { | |
167 | .open = clk_summary_open, | |
168 | .read = seq_read, | |
169 | .llseek = seq_lseek, | |
170 | .release = single_release, | |
171 | }; | |
172 | ||
bddca894 PG |
173 | static void clk_dump_one(struct seq_file *s, struct clk *c, int level) |
174 | { | |
175 | if (!c) | |
176 | return; | |
177 | ||
178 | seq_printf(s, "\"%s\": { ", c->name); | |
179 | seq_printf(s, "\"enable_count\": %d,", c->enable_count); | |
180 | seq_printf(s, "\"prepare_count\": %d,", c->prepare_count); | |
670decdd | 181 | seq_printf(s, "\"rate\": %lu", clk_get_rate(c)); |
5279fc40 | 182 | seq_printf(s, "\"accuracy\": %lu", clk_get_accuracy(c)); |
e59c5371 | 183 | seq_printf(s, "\"phase\": %d", clk_get_phase(c)); |
bddca894 PG |
184 | } |
185 | ||
186 | static void clk_dump_subtree(struct seq_file *s, struct clk *c, int level) | |
187 | { | |
188 | struct clk *child; | |
bddca894 PG |
189 | |
190 | if (!c) | |
191 | return; | |
192 | ||
193 | clk_dump_one(s, c, level); | |
194 | ||
b67bfe0d | 195 | hlist_for_each_entry(child, &c->children, child_node) { |
bddca894 PG |
196 | seq_printf(s, ","); |
197 | clk_dump_subtree(s, child, level + 1); | |
198 | } | |
199 | ||
200 | seq_printf(s, "}"); | |
201 | } | |
202 | ||
203 | static int clk_dump(struct seq_file *s, void *data) | |
204 | { | |
205 | struct clk *c; | |
bddca894 | 206 | bool first_node = true; |
27b8d5f7 | 207 | struct hlist_head **lists = (struct hlist_head **)s->private; |
bddca894 PG |
208 | |
209 | seq_printf(s, "{"); | |
210 | ||
eab89f69 | 211 | clk_prepare_lock(); |
bddca894 | 212 | |
27b8d5f7 PDS |
213 | for (; *lists; lists++) { |
214 | hlist_for_each_entry(c, *lists, child_node) { | |
215 | if (!first_node) | |
216 | seq_puts(s, ","); | |
217 | first_node = false; | |
218 | clk_dump_subtree(s, c, 0); | |
219 | } | |
bddca894 PG |
220 | } |
221 | ||
eab89f69 | 222 | clk_prepare_unlock(); |
bddca894 PG |
223 | |
224 | seq_printf(s, "}"); | |
225 | return 0; | |
226 | } | |
227 | ||
228 | ||
229 | static int clk_dump_open(struct inode *inode, struct file *file) | |
230 | { | |
231 | return single_open(file, clk_dump, inode->i_private); | |
232 | } | |
233 | ||
234 | static const struct file_operations clk_dump_fops = { | |
235 | .open = clk_dump_open, | |
236 | .read = seq_read, | |
237 | .llseek = seq_lseek, | |
238 | .release = single_release, | |
239 | }; | |
240 | ||
b2476490 MT |
241 | /* caller must hold prepare_lock */ |
242 | static int clk_debug_create_one(struct clk *clk, struct dentry *pdentry) | |
243 | { | |
244 | struct dentry *d; | |
245 | int ret = -ENOMEM; | |
246 | ||
247 | if (!clk || !pdentry) { | |
248 | ret = -EINVAL; | |
249 | goto out; | |
250 | } | |
251 | ||
252 | d = debugfs_create_dir(clk->name, pdentry); | |
253 | if (!d) | |
254 | goto out; | |
255 | ||
256 | clk->dentry = d; | |
257 | ||
258 | d = debugfs_create_u32("clk_rate", S_IRUGO, clk->dentry, | |
259 | (u32 *)&clk->rate); | |
260 | if (!d) | |
261 | goto err_out; | |
262 | ||
5279fc40 BB |
263 | d = debugfs_create_u32("clk_accuracy", S_IRUGO, clk->dentry, |
264 | (u32 *)&clk->accuracy); | |
265 | if (!d) | |
266 | goto err_out; | |
267 | ||
e59c5371 MT |
268 | d = debugfs_create_u32("clk_phase", S_IRUGO, clk->dentry, |
269 | (u32 *)&clk->phase); | |
270 | if (!d) | |
271 | goto err_out; | |
272 | ||
b2476490 MT |
273 | d = debugfs_create_x32("clk_flags", S_IRUGO, clk->dentry, |
274 | (u32 *)&clk->flags); | |
275 | if (!d) | |
276 | goto err_out; | |
277 | ||
278 | d = debugfs_create_u32("clk_prepare_count", S_IRUGO, clk->dentry, | |
279 | (u32 *)&clk->prepare_count); | |
280 | if (!d) | |
281 | goto err_out; | |
282 | ||
283 | d = debugfs_create_u32("clk_enable_count", S_IRUGO, clk->dentry, | |
284 | (u32 *)&clk->enable_count); | |
285 | if (!d) | |
286 | goto err_out; | |
287 | ||
288 | d = debugfs_create_u32("clk_notifier_count", S_IRUGO, clk->dentry, | |
289 | (u32 *)&clk->notifier_count); | |
290 | if (!d) | |
291 | goto err_out; | |
292 | ||
abeab450 CB |
293 | if (clk->ops->debug_init) { |
294 | ret = clk->ops->debug_init(clk->hw, clk->dentry); | |
295 | if (ret) | |
c646cbf1 | 296 | goto err_out; |
abeab450 | 297 | } |
c646cbf1 | 298 | |
b2476490 MT |
299 | ret = 0; |
300 | goto out; | |
301 | ||
302 | err_out: | |
b5f98e65 AE |
303 | debugfs_remove_recursive(clk->dentry); |
304 | clk->dentry = NULL; | |
b2476490 MT |
305 | out: |
306 | return ret; | |
307 | } | |
308 | ||
309 | /* caller must hold prepare_lock */ | |
310 | static int clk_debug_create_subtree(struct clk *clk, struct dentry *pdentry) | |
311 | { | |
312 | struct clk *child; | |
b2476490 MT |
313 | int ret = -EINVAL;; |
314 | ||
315 | if (!clk || !pdentry) | |
316 | goto out; | |
317 | ||
318 | ret = clk_debug_create_one(clk, pdentry); | |
319 | ||
320 | if (ret) | |
321 | goto out; | |
322 | ||
b67bfe0d | 323 | hlist_for_each_entry(child, &clk->children, child_node) |
27b8d5f7 | 324 | clk_debug_create_subtree(child, pdentry); |
b2476490 MT |
325 | |
326 | ret = 0; | |
327 | out: | |
328 | return ret; | |
329 | } | |
330 | ||
331 | /** | |
332 | * clk_debug_register - add a clk node to the debugfs clk tree | |
333 | * @clk: the clk being added to the debugfs clk tree | |
334 | * | |
335 | * Dynamically adds a clk to the debugfs clk tree if debugfs has been | |
336 | * initialized. Otherwise it bails out early since the debugfs clk tree | |
337 | * will be created lazily by clk_debug_init as part of a late_initcall. | |
338 | * | |
339 | * Caller must hold prepare_lock. Only clk_init calls this function (so | |
340 | * far) so this is taken care. | |
341 | */ | |
342 | static int clk_debug_register(struct clk *clk) | |
343 | { | |
b2476490 MT |
344 | int ret = 0; |
345 | ||
346 | if (!inited) | |
347 | goto out; | |
348 | ||
27b8d5f7 | 349 | ret = clk_debug_create_subtree(clk, rootdir); |
b2476490 MT |
350 | |
351 | out: | |
352 | return ret; | |
353 | } | |
354 | ||
fcb0ee6a SN |
355 | /** |
356 | * clk_debug_unregister - remove a clk node from the debugfs clk tree | |
357 | * @clk: the clk being removed from the debugfs clk tree | |
358 | * | |
359 | * Dynamically removes a clk and all it's children clk nodes from the | |
360 | * debugfs clk tree if clk->dentry points to debugfs created by | |
361 | * clk_debug_register in __clk_init. | |
362 | * | |
363 | * Caller must hold prepare_lock. | |
364 | */ | |
365 | static void clk_debug_unregister(struct clk *clk) | |
366 | { | |
367 | debugfs_remove_recursive(clk->dentry); | |
368 | } | |
369 | ||
fb2b3c9f PDS |
370 | struct dentry *clk_debugfs_add_file(struct clk *clk, char *name, umode_t mode, |
371 | void *data, const struct file_operations *fops) | |
372 | { | |
373 | struct dentry *d = NULL; | |
374 | ||
375 | if (clk->dentry) | |
376 | d = debugfs_create_file(name, mode, clk->dentry, data, fops); | |
377 | ||
378 | return d; | |
379 | } | |
380 | EXPORT_SYMBOL_GPL(clk_debugfs_add_file); | |
381 | ||
b2476490 MT |
382 | /** |
383 | * clk_debug_init - lazily create the debugfs clk tree visualization | |
384 | * | |
385 | * clks are often initialized very early during boot before memory can | |
386 | * be dynamically allocated and well before debugfs is setup. | |
387 | * clk_debug_init walks the clk tree hierarchy while holding | |
388 | * prepare_lock and creates the topology as part of a late_initcall, | |
389 | * thus insuring that clks initialized very early will still be | |
390 | * represented in the debugfs clk tree. This function should only be | |
391 | * called once at boot-time, and all other clks added dynamically will | |
392 | * be done so with clk_debug_register. | |
393 | */ | |
394 | static int __init clk_debug_init(void) | |
395 | { | |
396 | struct clk *clk; | |
1af599df | 397 | struct dentry *d; |
b2476490 MT |
398 | |
399 | rootdir = debugfs_create_dir("clk", NULL); | |
400 | ||
401 | if (!rootdir) | |
402 | return -ENOMEM; | |
403 | ||
27b8d5f7 | 404 | d = debugfs_create_file("clk_summary", S_IRUGO, rootdir, &all_lists, |
1af599df PG |
405 | &clk_summary_fops); |
406 | if (!d) | |
407 | return -ENOMEM; | |
408 | ||
27b8d5f7 | 409 | d = debugfs_create_file("clk_dump", S_IRUGO, rootdir, &all_lists, |
bddca894 PG |
410 | &clk_dump_fops); |
411 | if (!d) | |
412 | return -ENOMEM; | |
413 | ||
27b8d5f7 PDS |
414 | d = debugfs_create_file("clk_orphan_summary", S_IRUGO, rootdir, |
415 | &orphan_list, &clk_summary_fops); | |
416 | if (!d) | |
417 | return -ENOMEM; | |
b2476490 | 418 | |
27b8d5f7 PDS |
419 | d = debugfs_create_file("clk_orphan_dump", S_IRUGO, rootdir, |
420 | &orphan_list, &clk_dump_fops); | |
421 | if (!d) | |
b2476490 MT |
422 | return -ENOMEM; |
423 | ||
eab89f69 | 424 | clk_prepare_lock(); |
b2476490 | 425 | |
b67bfe0d | 426 | hlist_for_each_entry(clk, &clk_root_list, child_node) |
b2476490 MT |
427 | clk_debug_create_subtree(clk, rootdir); |
428 | ||
b67bfe0d | 429 | hlist_for_each_entry(clk, &clk_orphan_list, child_node) |
27b8d5f7 | 430 | clk_debug_create_subtree(clk, rootdir); |
b2476490 MT |
431 | |
432 | inited = 1; | |
433 | ||
eab89f69 | 434 | clk_prepare_unlock(); |
b2476490 MT |
435 | |
436 | return 0; | |
437 | } | |
438 | late_initcall(clk_debug_init); | |
439 | #else | |
440 | static inline int clk_debug_register(struct clk *clk) { return 0; } | |
b33d212f UH |
441 | static inline void clk_debug_reparent(struct clk *clk, struct clk *new_parent) |
442 | { | |
443 | } | |
fcb0ee6a SN |
444 | static inline void clk_debug_unregister(struct clk *clk) |
445 | { | |
446 | } | |
70d347e6 | 447 | #endif |
b2476490 | 448 | |
1c155b3d UH |
449 | /* caller must hold prepare_lock */ |
450 | static void clk_unprepare_unused_subtree(struct clk *clk) | |
451 | { | |
452 | struct clk *child; | |
453 | ||
454 | if (!clk) | |
455 | return; | |
456 | ||
457 | hlist_for_each_entry(child, &clk->children, child_node) | |
458 | clk_unprepare_unused_subtree(child); | |
459 | ||
460 | if (clk->prepare_count) | |
461 | return; | |
462 | ||
463 | if (clk->flags & CLK_IGNORE_UNUSED) | |
464 | return; | |
465 | ||
3cc8247f UH |
466 | if (__clk_is_prepared(clk)) { |
467 | if (clk->ops->unprepare_unused) | |
468 | clk->ops->unprepare_unused(clk->hw); | |
469 | else if (clk->ops->unprepare) | |
1c155b3d | 470 | clk->ops->unprepare(clk->hw); |
3cc8247f | 471 | } |
1c155b3d UH |
472 | } |
473 | ||
b2476490 MT |
474 | /* caller must hold prepare_lock */ |
475 | static void clk_disable_unused_subtree(struct clk *clk) | |
476 | { | |
477 | struct clk *child; | |
b2476490 MT |
478 | unsigned long flags; |
479 | ||
480 | if (!clk) | |
481 | goto out; | |
482 | ||
b67bfe0d | 483 | hlist_for_each_entry(child, &clk->children, child_node) |
b2476490 MT |
484 | clk_disable_unused_subtree(child); |
485 | ||
eab89f69 | 486 | flags = clk_enable_lock(); |
b2476490 MT |
487 | |
488 | if (clk->enable_count) | |
489 | goto unlock_out; | |
490 | ||
491 | if (clk->flags & CLK_IGNORE_UNUSED) | |
492 | goto unlock_out; | |
493 | ||
7c045a55 MT |
494 | /* |
495 | * some gate clocks have special needs during the disable-unused | |
496 | * sequence. call .disable_unused if available, otherwise fall | |
497 | * back to .disable | |
498 | */ | |
499 | if (__clk_is_enabled(clk)) { | |
500 | if (clk->ops->disable_unused) | |
501 | clk->ops->disable_unused(clk->hw); | |
502 | else if (clk->ops->disable) | |
503 | clk->ops->disable(clk->hw); | |
504 | } | |
b2476490 MT |
505 | |
506 | unlock_out: | |
eab89f69 | 507 | clk_enable_unlock(flags); |
b2476490 MT |
508 | |
509 | out: | |
510 | return; | |
511 | } | |
512 | ||
1e435256 OJ |
513 | static bool clk_ignore_unused; |
514 | static int __init clk_ignore_unused_setup(char *__unused) | |
515 | { | |
516 | clk_ignore_unused = true; | |
517 | return 1; | |
518 | } | |
519 | __setup("clk_ignore_unused", clk_ignore_unused_setup); | |
520 | ||
b2476490 MT |
521 | static int clk_disable_unused(void) |
522 | { | |
523 | struct clk *clk; | |
b2476490 | 524 | |
1e435256 OJ |
525 | if (clk_ignore_unused) { |
526 | pr_warn("clk: Not disabling unused clocks\n"); | |
527 | return 0; | |
528 | } | |
529 | ||
eab89f69 | 530 | clk_prepare_lock(); |
b2476490 | 531 | |
b67bfe0d | 532 | hlist_for_each_entry(clk, &clk_root_list, child_node) |
b2476490 MT |
533 | clk_disable_unused_subtree(clk); |
534 | ||
b67bfe0d | 535 | hlist_for_each_entry(clk, &clk_orphan_list, child_node) |
b2476490 MT |
536 | clk_disable_unused_subtree(clk); |
537 | ||
1c155b3d UH |
538 | hlist_for_each_entry(clk, &clk_root_list, child_node) |
539 | clk_unprepare_unused_subtree(clk); | |
540 | ||
541 | hlist_for_each_entry(clk, &clk_orphan_list, child_node) | |
542 | clk_unprepare_unused_subtree(clk); | |
543 | ||
eab89f69 | 544 | clk_prepare_unlock(); |
b2476490 MT |
545 | |
546 | return 0; | |
547 | } | |
d41d5805 | 548 | late_initcall_sync(clk_disable_unused); |
b2476490 MT |
549 | |
550 | /*** helper functions ***/ | |
551 | ||
65800b2c | 552 | const char *__clk_get_name(struct clk *clk) |
b2476490 MT |
553 | { |
554 | return !clk ? NULL : clk->name; | |
555 | } | |
4895084c | 556 | EXPORT_SYMBOL_GPL(__clk_get_name); |
b2476490 | 557 | |
65800b2c | 558 | struct clk_hw *__clk_get_hw(struct clk *clk) |
b2476490 MT |
559 | { |
560 | return !clk ? NULL : clk->hw; | |
561 | } | |
0b7f04b8 | 562 | EXPORT_SYMBOL_GPL(__clk_get_hw); |
b2476490 | 563 | |
65800b2c | 564 | u8 __clk_get_num_parents(struct clk *clk) |
b2476490 | 565 | { |
2ac6b1f5 | 566 | return !clk ? 0 : clk->num_parents; |
b2476490 | 567 | } |
0b7f04b8 | 568 | EXPORT_SYMBOL_GPL(__clk_get_num_parents); |
b2476490 | 569 | |
65800b2c | 570 | struct clk *__clk_get_parent(struct clk *clk) |
b2476490 MT |
571 | { |
572 | return !clk ? NULL : clk->parent; | |
573 | } | |
0b7f04b8 | 574 | EXPORT_SYMBOL_GPL(__clk_get_parent); |
b2476490 | 575 | |
7ef3dcc8 JH |
576 | struct clk *clk_get_parent_by_index(struct clk *clk, u8 index) |
577 | { | |
578 | if (!clk || index >= clk->num_parents) | |
579 | return NULL; | |
580 | else if (!clk->parents) | |
581 | return __clk_lookup(clk->parent_names[index]); | |
582 | else if (!clk->parents[index]) | |
583 | return clk->parents[index] = | |
584 | __clk_lookup(clk->parent_names[index]); | |
585 | else | |
586 | return clk->parents[index]; | |
587 | } | |
0b7f04b8 | 588 | EXPORT_SYMBOL_GPL(clk_get_parent_by_index); |
7ef3dcc8 | 589 | |
65800b2c | 590 | unsigned int __clk_get_enable_count(struct clk *clk) |
b2476490 | 591 | { |
2ac6b1f5 | 592 | return !clk ? 0 : clk->enable_count; |
b2476490 MT |
593 | } |
594 | ||
65800b2c | 595 | unsigned int __clk_get_prepare_count(struct clk *clk) |
b2476490 | 596 | { |
2ac6b1f5 | 597 | return !clk ? 0 : clk->prepare_count; |
b2476490 MT |
598 | } |
599 | ||
600 | unsigned long __clk_get_rate(struct clk *clk) | |
601 | { | |
602 | unsigned long ret; | |
603 | ||
604 | if (!clk) { | |
34e44fe8 | 605 | ret = 0; |
b2476490 MT |
606 | goto out; |
607 | } | |
608 | ||
609 | ret = clk->rate; | |
610 | ||
611 | if (clk->flags & CLK_IS_ROOT) | |
612 | goto out; | |
613 | ||
614 | if (!clk->parent) | |
34e44fe8 | 615 | ret = 0; |
b2476490 MT |
616 | |
617 | out: | |
618 | return ret; | |
619 | } | |
0b7f04b8 | 620 | EXPORT_SYMBOL_GPL(__clk_get_rate); |
b2476490 | 621 | |
5279fc40 BB |
622 | unsigned long __clk_get_accuracy(struct clk *clk) |
623 | { | |
624 | if (!clk) | |
625 | return 0; | |
626 | ||
627 | return clk->accuracy; | |
628 | } | |
629 | ||
65800b2c | 630 | unsigned long __clk_get_flags(struct clk *clk) |
b2476490 | 631 | { |
2ac6b1f5 | 632 | return !clk ? 0 : clk->flags; |
b2476490 | 633 | } |
b05c6836 | 634 | EXPORT_SYMBOL_GPL(__clk_get_flags); |
b2476490 | 635 | |
3d6ee287 UH |
636 | bool __clk_is_prepared(struct clk *clk) |
637 | { | |
638 | int ret; | |
639 | ||
640 | if (!clk) | |
641 | return false; | |
642 | ||
643 | /* | |
644 | * .is_prepared is optional for clocks that can prepare | |
645 | * fall back to software usage counter if it is missing | |
646 | */ | |
647 | if (!clk->ops->is_prepared) { | |
648 | ret = clk->prepare_count ? 1 : 0; | |
649 | goto out; | |
650 | } | |
651 | ||
652 | ret = clk->ops->is_prepared(clk->hw); | |
653 | out: | |
654 | return !!ret; | |
655 | } | |
656 | ||
2ac6b1f5 | 657 | bool __clk_is_enabled(struct clk *clk) |
b2476490 MT |
658 | { |
659 | int ret; | |
660 | ||
661 | if (!clk) | |
2ac6b1f5 | 662 | return false; |
b2476490 MT |
663 | |
664 | /* | |
665 | * .is_enabled is only mandatory for clocks that gate | |
666 | * fall back to software usage counter if .is_enabled is missing | |
667 | */ | |
668 | if (!clk->ops->is_enabled) { | |
669 | ret = clk->enable_count ? 1 : 0; | |
670 | goto out; | |
671 | } | |
672 | ||
673 | ret = clk->ops->is_enabled(clk->hw); | |
674 | out: | |
2ac6b1f5 | 675 | return !!ret; |
b2476490 | 676 | } |
0b7f04b8 | 677 | EXPORT_SYMBOL_GPL(__clk_is_enabled); |
b2476490 MT |
678 | |
679 | static struct clk *__clk_lookup_subtree(const char *name, struct clk *clk) | |
680 | { | |
681 | struct clk *child; | |
682 | struct clk *ret; | |
b2476490 MT |
683 | |
684 | if (!strcmp(clk->name, name)) | |
685 | return clk; | |
686 | ||
b67bfe0d | 687 | hlist_for_each_entry(child, &clk->children, child_node) { |
b2476490 MT |
688 | ret = __clk_lookup_subtree(name, child); |
689 | if (ret) | |
690 | return ret; | |
691 | } | |
692 | ||
693 | return NULL; | |
694 | } | |
695 | ||
696 | struct clk *__clk_lookup(const char *name) | |
697 | { | |
698 | struct clk *root_clk; | |
699 | struct clk *ret; | |
b2476490 MT |
700 | |
701 | if (!name) | |
702 | return NULL; | |
703 | ||
704 | /* search the 'proper' clk tree first */ | |
b67bfe0d | 705 | hlist_for_each_entry(root_clk, &clk_root_list, child_node) { |
b2476490 MT |
706 | ret = __clk_lookup_subtree(name, root_clk); |
707 | if (ret) | |
708 | return ret; | |
709 | } | |
710 | ||
711 | /* if not found, then search the orphan tree */ | |
b67bfe0d | 712 | hlist_for_each_entry(root_clk, &clk_orphan_list, child_node) { |
b2476490 MT |
713 | ret = __clk_lookup_subtree(name, root_clk); |
714 | if (ret) | |
715 | return ret; | |
716 | } | |
717 | ||
718 | return NULL; | |
719 | } | |
720 | ||
e366fdd7 JH |
721 | /* |
722 | * Helper for finding best parent to provide a given frequency. This can be used | |
723 | * directly as a determine_rate callback (e.g. for a mux), or from a more | |
724 | * complex clock that may combine a mux with other operations. | |
725 | */ | |
726 | long __clk_mux_determine_rate(struct clk_hw *hw, unsigned long rate, | |
727 | unsigned long *best_parent_rate, | |
728 | struct clk **best_parent_p) | |
729 | { | |
730 | struct clk *clk = hw->clk, *parent, *best_parent = NULL; | |
731 | int i, num_parents; | |
732 | unsigned long parent_rate, best = 0; | |
733 | ||
734 | /* if NO_REPARENT flag set, pass through to current parent */ | |
735 | if (clk->flags & CLK_SET_RATE_NO_REPARENT) { | |
736 | parent = clk->parent; | |
737 | if (clk->flags & CLK_SET_RATE_PARENT) | |
738 | best = __clk_round_rate(parent, rate); | |
739 | else if (parent) | |
740 | best = __clk_get_rate(parent); | |
741 | else | |
742 | best = __clk_get_rate(clk); | |
743 | goto out; | |
744 | } | |
745 | ||
746 | /* find the parent that can provide the fastest rate <= rate */ | |
747 | num_parents = clk->num_parents; | |
748 | for (i = 0; i < num_parents; i++) { | |
749 | parent = clk_get_parent_by_index(clk, i); | |
750 | if (!parent) | |
751 | continue; | |
752 | if (clk->flags & CLK_SET_RATE_PARENT) | |
753 | parent_rate = __clk_round_rate(parent, rate); | |
754 | else | |
755 | parent_rate = __clk_get_rate(parent); | |
756 | if (parent_rate <= rate && parent_rate > best) { | |
757 | best_parent = parent; | |
758 | best = parent_rate; | |
759 | } | |
760 | } | |
761 | ||
762 | out: | |
763 | if (best_parent) | |
764 | *best_parent_p = best_parent; | |
765 | *best_parent_rate = best; | |
766 | ||
767 | return best; | |
768 | } | |
0b7f04b8 | 769 | EXPORT_SYMBOL_GPL(__clk_mux_determine_rate); |
e366fdd7 | 770 | |
b2476490 MT |
771 | /*** clk api ***/ |
772 | ||
773 | void __clk_unprepare(struct clk *clk) | |
774 | { | |
775 | if (!clk) | |
776 | return; | |
777 | ||
778 | if (WARN_ON(clk->prepare_count == 0)) | |
779 | return; | |
780 | ||
781 | if (--clk->prepare_count > 0) | |
782 | return; | |
783 | ||
784 | WARN_ON(clk->enable_count > 0); | |
785 | ||
786 | if (clk->ops->unprepare) | |
787 | clk->ops->unprepare(clk->hw); | |
788 | ||
789 | __clk_unprepare(clk->parent); | |
790 | } | |
791 | ||
792 | /** | |
793 | * clk_unprepare - undo preparation of a clock source | |
24ee1a08 | 794 | * @clk: the clk being unprepared |
b2476490 MT |
795 | * |
796 | * clk_unprepare may sleep, which differentiates it from clk_disable. In a | |
797 | * simple case, clk_unprepare can be used instead of clk_disable to gate a clk | |
798 | * if the operation may sleep. One example is a clk which is accessed over | |
799 | * I2c. In the complex case a clk gate operation may require a fast and a slow | |
800 | * part. It is this reason that clk_unprepare and clk_disable are not mutually | |
801 | * exclusive. In fact clk_disable must be called before clk_unprepare. | |
802 | */ | |
803 | void clk_unprepare(struct clk *clk) | |
804 | { | |
63589e92 SB |
805 | if (IS_ERR_OR_NULL(clk)) |
806 | return; | |
807 | ||
eab89f69 | 808 | clk_prepare_lock(); |
b2476490 | 809 | __clk_unprepare(clk); |
eab89f69 | 810 | clk_prepare_unlock(); |
b2476490 MT |
811 | } |
812 | EXPORT_SYMBOL_GPL(clk_unprepare); | |
813 | ||
814 | int __clk_prepare(struct clk *clk) | |
815 | { | |
816 | int ret = 0; | |
817 | ||
818 | if (!clk) | |
819 | return 0; | |
820 | ||
821 | if (clk->prepare_count == 0) { | |
822 | ret = __clk_prepare(clk->parent); | |
823 | if (ret) | |
824 | return ret; | |
825 | ||
826 | if (clk->ops->prepare) { | |
827 | ret = clk->ops->prepare(clk->hw); | |
828 | if (ret) { | |
829 | __clk_unprepare(clk->parent); | |
830 | return ret; | |
831 | } | |
832 | } | |
833 | } | |
834 | ||
835 | clk->prepare_count++; | |
836 | ||
837 | return 0; | |
838 | } | |
839 | ||
840 | /** | |
841 | * clk_prepare - prepare a clock source | |
842 | * @clk: the clk being prepared | |
843 | * | |
844 | * clk_prepare may sleep, which differentiates it from clk_enable. In a simple | |
845 | * case, clk_prepare can be used instead of clk_enable to ungate a clk if the | |
846 | * operation may sleep. One example is a clk which is accessed over I2c. In | |
847 | * the complex case a clk ungate operation may require a fast and a slow part. | |
848 | * It is this reason that clk_prepare and clk_enable are not mutually | |
849 | * exclusive. In fact clk_prepare must be called before clk_enable. | |
850 | * Returns 0 on success, -EERROR otherwise. | |
851 | */ | |
852 | int clk_prepare(struct clk *clk) | |
853 | { | |
854 | int ret; | |
855 | ||
eab89f69 | 856 | clk_prepare_lock(); |
b2476490 | 857 | ret = __clk_prepare(clk); |
eab89f69 | 858 | clk_prepare_unlock(); |
b2476490 MT |
859 | |
860 | return ret; | |
861 | } | |
862 | EXPORT_SYMBOL_GPL(clk_prepare); | |
863 | ||
864 | static void __clk_disable(struct clk *clk) | |
865 | { | |
866 | if (!clk) | |
867 | return; | |
868 | ||
869 | if (WARN_ON(clk->enable_count == 0)) | |
870 | return; | |
871 | ||
872 | if (--clk->enable_count > 0) | |
873 | return; | |
874 | ||
875 | if (clk->ops->disable) | |
876 | clk->ops->disable(clk->hw); | |
877 | ||
878 | __clk_disable(clk->parent); | |
879 | } | |
880 | ||
881 | /** | |
882 | * clk_disable - gate a clock | |
883 | * @clk: the clk being gated | |
884 | * | |
885 | * clk_disable must not sleep, which differentiates it from clk_unprepare. In | |
886 | * a simple case, clk_disable can be used instead of clk_unprepare to gate a | |
887 | * clk if the operation is fast and will never sleep. One example is a | |
888 | * SoC-internal clk which is controlled via simple register writes. In the | |
889 | * complex case a clk gate operation may require a fast and a slow part. It is | |
890 | * this reason that clk_unprepare and clk_disable are not mutually exclusive. | |
891 | * In fact clk_disable must be called before clk_unprepare. | |
892 | */ | |
893 | void clk_disable(struct clk *clk) | |
894 | { | |
895 | unsigned long flags; | |
896 | ||
63589e92 SB |
897 | if (IS_ERR_OR_NULL(clk)) |
898 | return; | |
899 | ||
eab89f69 | 900 | flags = clk_enable_lock(); |
b2476490 | 901 | __clk_disable(clk); |
eab89f69 | 902 | clk_enable_unlock(flags); |
b2476490 MT |
903 | } |
904 | EXPORT_SYMBOL_GPL(clk_disable); | |
905 | ||
906 | static int __clk_enable(struct clk *clk) | |
907 | { | |
908 | int ret = 0; | |
909 | ||
910 | if (!clk) | |
911 | return 0; | |
912 | ||
913 | if (WARN_ON(clk->prepare_count == 0)) | |
914 | return -ESHUTDOWN; | |
915 | ||
916 | if (clk->enable_count == 0) { | |
917 | ret = __clk_enable(clk->parent); | |
918 | ||
919 | if (ret) | |
920 | return ret; | |
921 | ||
922 | if (clk->ops->enable) { | |
923 | ret = clk->ops->enable(clk->hw); | |
924 | if (ret) { | |
925 | __clk_disable(clk->parent); | |
926 | return ret; | |
927 | } | |
928 | } | |
929 | } | |
930 | ||
931 | clk->enable_count++; | |
932 | return 0; | |
933 | } | |
934 | ||
935 | /** | |
936 | * clk_enable - ungate a clock | |
937 | * @clk: the clk being ungated | |
938 | * | |
939 | * clk_enable must not sleep, which differentiates it from clk_prepare. In a | |
940 | * simple case, clk_enable can be used instead of clk_prepare to ungate a clk | |
941 | * if the operation will never sleep. One example is a SoC-internal clk which | |
942 | * is controlled via simple register writes. In the complex case a clk ungate | |
943 | * operation may require a fast and a slow part. It is this reason that | |
944 | * clk_enable and clk_prepare are not mutually exclusive. In fact clk_prepare | |
945 | * must be called before clk_enable. Returns 0 on success, -EERROR | |
946 | * otherwise. | |
947 | */ | |
948 | int clk_enable(struct clk *clk) | |
949 | { | |
950 | unsigned long flags; | |
951 | int ret; | |
952 | ||
eab89f69 | 953 | flags = clk_enable_lock(); |
b2476490 | 954 | ret = __clk_enable(clk); |
eab89f69 | 955 | clk_enable_unlock(flags); |
b2476490 MT |
956 | |
957 | return ret; | |
958 | } | |
959 | EXPORT_SYMBOL_GPL(clk_enable); | |
960 | ||
b2476490 MT |
961 | /** |
962 | * __clk_round_rate - round the given rate for a clk | |
963 | * @clk: round the rate of this clock | |
24ee1a08 | 964 | * @rate: the rate which is to be rounded |
b2476490 MT |
965 | * |
966 | * Caller must hold prepare_lock. Useful for clk_ops such as .set_rate | |
967 | */ | |
968 | unsigned long __clk_round_rate(struct clk *clk, unsigned long rate) | |
969 | { | |
81536e07 | 970 | unsigned long parent_rate = 0; |
71472c0c | 971 | struct clk *parent; |
b2476490 MT |
972 | |
973 | if (!clk) | |
2ac6b1f5 | 974 | return 0; |
b2476490 | 975 | |
71472c0c JH |
976 | parent = clk->parent; |
977 | if (parent) | |
978 | parent_rate = parent->rate; | |
979 | ||
980 | if (clk->ops->determine_rate) | |
981 | return clk->ops->determine_rate(clk->hw, rate, &parent_rate, | |
982 | &parent); | |
983 | else if (clk->ops->round_rate) | |
984 | return clk->ops->round_rate(clk->hw, rate, &parent_rate); | |
985 | else if (clk->flags & CLK_SET_RATE_PARENT) | |
986 | return __clk_round_rate(clk->parent, rate); | |
987 | else | |
988 | return clk->rate; | |
b2476490 | 989 | } |
1cdf8ee2 | 990 | EXPORT_SYMBOL_GPL(__clk_round_rate); |
b2476490 MT |
991 | |
992 | /** | |
993 | * clk_round_rate - round the given rate for a clk | |
994 | * @clk: the clk for which we are rounding a rate | |
995 | * @rate: the rate which is to be rounded | |
996 | * | |
997 | * Takes in a rate as input and rounds it to a rate that the clk can actually | |
998 | * use which is then returned. If clk doesn't support round_rate operation | |
999 | * then the parent rate is returned. | |
1000 | */ | |
1001 | long clk_round_rate(struct clk *clk, unsigned long rate) | |
1002 | { | |
1003 | unsigned long ret; | |
1004 | ||
eab89f69 | 1005 | clk_prepare_lock(); |
b2476490 | 1006 | ret = __clk_round_rate(clk, rate); |
eab89f69 | 1007 | clk_prepare_unlock(); |
b2476490 MT |
1008 | |
1009 | return ret; | |
1010 | } | |
1011 | EXPORT_SYMBOL_GPL(clk_round_rate); | |
1012 | ||
1013 | /** | |
1014 | * __clk_notify - call clk notifier chain | |
1015 | * @clk: struct clk * that is changing rate | |
1016 | * @msg: clk notifier type (see include/linux/clk.h) | |
1017 | * @old_rate: old clk rate | |
1018 | * @new_rate: new clk rate | |
1019 | * | |
1020 | * Triggers a notifier call chain on the clk rate-change notification | |
1021 | * for 'clk'. Passes a pointer to the struct clk and the previous | |
1022 | * and current rates to the notifier callback. Intended to be called by | |
1023 | * internal clock code only. Returns NOTIFY_DONE from the last driver | |
1024 | * called if all went well, or NOTIFY_STOP or NOTIFY_BAD immediately if | |
1025 | * a driver returns that. | |
1026 | */ | |
1027 | static int __clk_notify(struct clk *clk, unsigned long msg, | |
1028 | unsigned long old_rate, unsigned long new_rate) | |
1029 | { | |
1030 | struct clk_notifier *cn; | |
1031 | struct clk_notifier_data cnd; | |
1032 | int ret = NOTIFY_DONE; | |
1033 | ||
1034 | cnd.clk = clk; | |
1035 | cnd.old_rate = old_rate; | |
1036 | cnd.new_rate = new_rate; | |
1037 | ||
1038 | list_for_each_entry(cn, &clk_notifier_list, node) { | |
1039 | if (cn->clk == clk) { | |
1040 | ret = srcu_notifier_call_chain(&cn->notifier_head, msg, | |
1041 | &cnd); | |
1042 | break; | |
1043 | } | |
1044 | } | |
1045 | ||
1046 | return ret; | |
1047 | } | |
1048 | ||
5279fc40 BB |
1049 | /** |
1050 | * __clk_recalc_accuracies | |
1051 | * @clk: first clk in the subtree | |
1052 | * | |
1053 | * Walks the subtree of clks starting with clk and recalculates accuracies as | |
1054 | * it goes. Note that if a clk does not implement the .recalc_accuracy | |
1055 | * callback then it is assumed that the clock will take on the accuracy of it's | |
1056 | * parent. | |
1057 | * | |
1058 | * Caller must hold prepare_lock. | |
1059 | */ | |
1060 | static void __clk_recalc_accuracies(struct clk *clk) | |
1061 | { | |
1062 | unsigned long parent_accuracy = 0; | |
1063 | struct clk *child; | |
1064 | ||
1065 | if (clk->parent) | |
1066 | parent_accuracy = clk->parent->accuracy; | |
1067 | ||
1068 | if (clk->ops->recalc_accuracy) | |
1069 | clk->accuracy = clk->ops->recalc_accuracy(clk->hw, | |
1070 | parent_accuracy); | |
1071 | else | |
1072 | clk->accuracy = parent_accuracy; | |
1073 | ||
1074 | hlist_for_each_entry(child, &clk->children, child_node) | |
1075 | __clk_recalc_accuracies(child); | |
1076 | } | |
1077 | ||
1078 | /** | |
1079 | * clk_get_accuracy - return the accuracy of clk | |
1080 | * @clk: the clk whose accuracy is being returned | |
1081 | * | |
1082 | * Simply returns the cached accuracy of the clk, unless | |
1083 | * CLK_GET_ACCURACY_NOCACHE flag is set, which means a recalc_rate will be | |
1084 | * issued. | |
1085 | * If clk is NULL then returns 0. | |
1086 | */ | |
1087 | long clk_get_accuracy(struct clk *clk) | |
1088 | { | |
1089 | unsigned long accuracy; | |
1090 | ||
1091 | clk_prepare_lock(); | |
1092 | if (clk && (clk->flags & CLK_GET_ACCURACY_NOCACHE)) | |
1093 | __clk_recalc_accuracies(clk); | |
1094 | ||
1095 | accuracy = __clk_get_accuracy(clk); | |
1096 | clk_prepare_unlock(); | |
1097 | ||
1098 | return accuracy; | |
1099 | } | |
1100 | EXPORT_SYMBOL_GPL(clk_get_accuracy); | |
1101 | ||
8f2c2db1 SB |
1102 | static unsigned long clk_recalc(struct clk *clk, unsigned long parent_rate) |
1103 | { | |
1104 | if (clk->ops->recalc_rate) | |
1105 | return clk->ops->recalc_rate(clk->hw, parent_rate); | |
1106 | return parent_rate; | |
1107 | } | |
1108 | ||
b2476490 MT |
1109 | /** |
1110 | * __clk_recalc_rates | |
1111 | * @clk: first clk in the subtree | |
1112 | * @msg: notification type (see include/linux/clk.h) | |
1113 | * | |
1114 | * Walks the subtree of clks starting with clk and recalculates rates as it | |
1115 | * goes. Note that if a clk does not implement the .recalc_rate callback then | |
24ee1a08 | 1116 | * it is assumed that the clock will take on the rate of its parent. |
b2476490 MT |
1117 | * |
1118 | * clk_recalc_rates also propagates the POST_RATE_CHANGE notification, | |
1119 | * if necessary. | |
1120 | * | |
1121 | * Caller must hold prepare_lock. | |
1122 | */ | |
1123 | static void __clk_recalc_rates(struct clk *clk, unsigned long msg) | |
1124 | { | |
1125 | unsigned long old_rate; | |
1126 | unsigned long parent_rate = 0; | |
b2476490 MT |
1127 | struct clk *child; |
1128 | ||
1129 | old_rate = clk->rate; | |
1130 | ||
1131 | if (clk->parent) | |
1132 | parent_rate = clk->parent->rate; | |
1133 | ||
8f2c2db1 | 1134 | clk->rate = clk_recalc(clk, parent_rate); |
b2476490 MT |
1135 | |
1136 | /* | |
1137 | * ignore NOTIFY_STOP and NOTIFY_BAD return values for POST_RATE_CHANGE | |
1138 | * & ABORT_RATE_CHANGE notifiers | |
1139 | */ | |
1140 | if (clk->notifier_count && msg) | |
1141 | __clk_notify(clk, msg, old_rate, clk->rate); | |
1142 | ||
b67bfe0d | 1143 | hlist_for_each_entry(child, &clk->children, child_node) |
b2476490 MT |
1144 | __clk_recalc_rates(child, msg); |
1145 | } | |
1146 | ||
a093bde2 UH |
1147 | /** |
1148 | * clk_get_rate - return the rate of clk | |
1149 | * @clk: the clk whose rate is being returned | |
1150 | * | |
1151 | * Simply returns the cached rate of the clk, unless CLK_GET_RATE_NOCACHE flag | |
1152 | * is set, which means a recalc_rate will be issued. | |
1153 | * If clk is NULL then returns 0. | |
1154 | */ | |
1155 | unsigned long clk_get_rate(struct clk *clk) | |
1156 | { | |
1157 | unsigned long rate; | |
1158 | ||
eab89f69 | 1159 | clk_prepare_lock(); |
a093bde2 UH |
1160 | |
1161 | if (clk && (clk->flags & CLK_GET_RATE_NOCACHE)) | |
1162 | __clk_recalc_rates(clk, 0); | |
1163 | ||
1164 | rate = __clk_get_rate(clk); | |
eab89f69 | 1165 | clk_prepare_unlock(); |
a093bde2 UH |
1166 | |
1167 | return rate; | |
1168 | } | |
1169 | EXPORT_SYMBOL_GPL(clk_get_rate); | |
1170 | ||
f1c8b2ed | 1171 | static int clk_fetch_parent_index(struct clk *clk, struct clk *parent) |
4935b22c | 1172 | { |
f1c8b2ed | 1173 | int i; |
4935b22c | 1174 | |
f1c8b2ed | 1175 | if (!clk->parents) { |
96a7ed90 TF |
1176 | clk->parents = kcalloc(clk->num_parents, |
1177 | sizeof(struct clk *), GFP_KERNEL); | |
f1c8b2ed TF |
1178 | if (!clk->parents) |
1179 | return -ENOMEM; | |
1180 | } | |
4935b22c JH |
1181 | |
1182 | /* | |
1183 | * find index of new parent clock using cached parent ptrs, | |
1184 | * or if not yet cached, use string name comparison and cache | |
1185 | * them now to avoid future calls to __clk_lookup. | |
1186 | */ | |
1187 | for (i = 0; i < clk->num_parents; i++) { | |
da0f0b2c | 1188 | if (clk->parents[i] == parent) |
f1c8b2ed | 1189 | return i; |
da0f0b2c TF |
1190 | |
1191 | if (clk->parents[i]) | |
1192 | continue; | |
1193 | ||
1194 | if (!strcmp(clk->parent_names[i], parent->name)) { | |
1195 | clk->parents[i] = __clk_lookup(parent->name); | |
f1c8b2ed | 1196 | return i; |
4935b22c JH |
1197 | } |
1198 | } | |
1199 | ||
f1c8b2ed | 1200 | return -EINVAL; |
4935b22c JH |
1201 | } |
1202 | ||
1203 | static void clk_reparent(struct clk *clk, struct clk *new_parent) | |
1204 | { | |
1205 | hlist_del(&clk->child_node); | |
1206 | ||
903efc55 JH |
1207 | if (new_parent) { |
1208 | /* avoid duplicate POST_RATE_CHANGE notifications */ | |
1209 | if (new_parent->new_child == clk) | |
1210 | new_parent->new_child = NULL; | |
1211 | ||
4935b22c | 1212 | hlist_add_head(&clk->child_node, &new_parent->children); |
903efc55 | 1213 | } else { |
4935b22c | 1214 | hlist_add_head(&clk->child_node, &clk_orphan_list); |
903efc55 | 1215 | } |
4935b22c JH |
1216 | |
1217 | clk->parent = new_parent; | |
1218 | } | |
1219 | ||
3fa2252b | 1220 | static struct clk *__clk_set_parent_before(struct clk *clk, struct clk *parent) |
4935b22c JH |
1221 | { |
1222 | unsigned long flags; | |
4935b22c JH |
1223 | struct clk *old_parent = clk->parent; |
1224 | ||
1225 | /* | |
1226 | * Migrate prepare state between parents and prevent race with | |
1227 | * clk_enable(). | |
1228 | * | |
1229 | * If the clock is not prepared, then a race with | |
1230 | * clk_enable/disable() is impossible since we already have the | |
1231 | * prepare lock (future calls to clk_enable() need to be preceded by | |
1232 | * a clk_prepare()). | |
1233 | * | |
1234 | * If the clock is prepared, migrate the prepared state to the new | |
1235 | * parent and also protect against a race with clk_enable() by | |
1236 | * forcing the clock and the new parent on. This ensures that all | |
1237 | * future calls to clk_enable() are practically NOPs with respect to | |
1238 | * hardware and software states. | |
1239 | * | |
1240 | * See also: Comment for clk_set_parent() below. | |
1241 | */ | |
1242 | if (clk->prepare_count) { | |
1243 | __clk_prepare(parent); | |
1244 | clk_enable(parent); | |
1245 | clk_enable(clk); | |
1246 | } | |
1247 | ||
1248 | /* update the clk tree topology */ | |
1249 | flags = clk_enable_lock(); | |
1250 | clk_reparent(clk, parent); | |
1251 | clk_enable_unlock(flags); | |
1252 | ||
3fa2252b SB |
1253 | return old_parent; |
1254 | } | |
1255 | ||
1256 | static void __clk_set_parent_after(struct clk *clk, struct clk *parent, | |
1257 | struct clk *old_parent) | |
1258 | { | |
1259 | /* | |
1260 | * Finish the migration of prepare state and undo the changes done | |
1261 | * for preventing a race with clk_enable(). | |
1262 | */ | |
1263 | if (clk->prepare_count) { | |
1264 | clk_disable(clk); | |
1265 | clk_disable(old_parent); | |
1266 | __clk_unprepare(old_parent); | |
1267 | } | |
3fa2252b SB |
1268 | } |
1269 | ||
1270 | static int __clk_set_parent(struct clk *clk, struct clk *parent, u8 p_index) | |
1271 | { | |
1272 | unsigned long flags; | |
1273 | int ret = 0; | |
1274 | struct clk *old_parent; | |
1275 | ||
1276 | old_parent = __clk_set_parent_before(clk, parent); | |
1277 | ||
4935b22c JH |
1278 | /* change clock input source */ |
1279 | if (parent && clk->ops->set_parent) | |
1280 | ret = clk->ops->set_parent(clk->hw, p_index); | |
1281 | ||
1282 | if (ret) { | |
1283 | flags = clk_enable_lock(); | |
1284 | clk_reparent(clk, old_parent); | |
1285 | clk_enable_unlock(flags); | |
1286 | ||
1287 | if (clk->prepare_count) { | |
1288 | clk_disable(clk); | |
1289 | clk_disable(parent); | |
1290 | __clk_unprepare(parent); | |
1291 | } | |
1292 | return ret; | |
1293 | } | |
1294 | ||
3fa2252b | 1295 | __clk_set_parent_after(clk, parent, old_parent); |
4935b22c | 1296 | |
4935b22c JH |
1297 | return 0; |
1298 | } | |
1299 | ||
b2476490 MT |
1300 | /** |
1301 | * __clk_speculate_rates | |
1302 | * @clk: first clk in the subtree | |
1303 | * @parent_rate: the "future" rate of clk's parent | |
1304 | * | |
1305 | * Walks the subtree of clks starting with clk, speculating rates as it | |
1306 | * goes and firing off PRE_RATE_CHANGE notifications as necessary. | |
1307 | * | |
1308 | * Unlike clk_recalc_rates, clk_speculate_rates exists only for sending | |
1309 | * pre-rate change notifications and returns early if no clks in the | |
1310 | * subtree have subscribed to the notifications. Note that if a clk does not | |
1311 | * implement the .recalc_rate callback then it is assumed that the clock will | |
24ee1a08 | 1312 | * take on the rate of its parent. |
b2476490 MT |
1313 | * |
1314 | * Caller must hold prepare_lock. | |
1315 | */ | |
1316 | static int __clk_speculate_rates(struct clk *clk, unsigned long parent_rate) | |
1317 | { | |
b2476490 MT |
1318 | struct clk *child; |
1319 | unsigned long new_rate; | |
1320 | int ret = NOTIFY_DONE; | |
1321 | ||
8f2c2db1 | 1322 | new_rate = clk_recalc(clk, parent_rate); |
b2476490 | 1323 | |
fb72a059 | 1324 | /* abort rate change if a driver returns NOTIFY_BAD or NOTIFY_STOP */ |
b2476490 MT |
1325 | if (clk->notifier_count) |
1326 | ret = __clk_notify(clk, PRE_RATE_CHANGE, clk->rate, new_rate); | |
1327 | ||
86bcfa2e MT |
1328 | if (ret & NOTIFY_STOP_MASK) { |
1329 | pr_debug("%s: clk notifier callback for clock %s aborted with error %d\n", | |
1330 | __func__, clk->name, ret); | |
b2476490 | 1331 | goto out; |
86bcfa2e | 1332 | } |
b2476490 | 1333 | |
b67bfe0d | 1334 | hlist_for_each_entry(child, &clk->children, child_node) { |
b2476490 | 1335 | ret = __clk_speculate_rates(child, new_rate); |
fb72a059 | 1336 | if (ret & NOTIFY_STOP_MASK) |
b2476490 MT |
1337 | break; |
1338 | } | |
1339 | ||
1340 | out: | |
1341 | return ret; | |
1342 | } | |
1343 | ||
71472c0c JH |
1344 | static void clk_calc_subtree(struct clk *clk, unsigned long new_rate, |
1345 | struct clk *new_parent, u8 p_index) | |
b2476490 MT |
1346 | { |
1347 | struct clk *child; | |
b2476490 MT |
1348 | |
1349 | clk->new_rate = new_rate; | |
71472c0c JH |
1350 | clk->new_parent = new_parent; |
1351 | clk->new_parent_index = p_index; | |
1352 | /* include clk in new parent's PRE_RATE_CHANGE notifications */ | |
1353 | clk->new_child = NULL; | |
1354 | if (new_parent && new_parent != clk->parent) | |
1355 | new_parent->new_child = clk; | |
b2476490 | 1356 | |
b67bfe0d | 1357 | hlist_for_each_entry(child, &clk->children, child_node) { |
8f2c2db1 | 1358 | child->new_rate = clk_recalc(child, new_rate); |
71472c0c | 1359 | clk_calc_subtree(child, child->new_rate, NULL, 0); |
b2476490 MT |
1360 | } |
1361 | } | |
1362 | ||
1363 | /* | |
1364 | * calculate the new rates returning the topmost clock that has to be | |
1365 | * changed. | |
1366 | */ | |
1367 | static struct clk *clk_calc_new_rates(struct clk *clk, unsigned long rate) | |
1368 | { | |
1369 | struct clk *top = clk; | |
71472c0c | 1370 | struct clk *old_parent, *parent; |
81536e07 | 1371 | unsigned long best_parent_rate = 0; |
b2476490 | 1372 | unsigned long new_rate; |
f1c8b2ed | 1373 | int p_index = 0; |
b2476490 | 1374 | |
7452b219 MT |
1375 | /* sanity */ |
1376 | if (IS_ERR_OR_NULL(clk)) | |
1377 | return NULL; | |
1378 | ||
63f5c3b2 | 1379 | /* save parent rate, if it exists */ |
71472c0c JH |
1380 | parent = old_parent = clk->parent; |
1381 | if (parent) | |
1382 | best_parent_rate = parent->rate; | |
1383 | ||
1384 | /* find the closest rate and parent clk/rate */ | |
1385 | if (clk->ops->determine_rate) { | |
1386 | new_rate = clk->ops->determine_rate(clk->hw, rate, | |
1387 | &best_parent_rate, | |
1388 | &parent); | |
1389 | } else if (clk->ops->round_rate) { | |
1390 | new_rate = clk->ops->round_rate(clk->hw, rate, | |
1391 | &best_parent_rate); | |
1392 | } else if (!parent || !(clk->flags & CLK_SET_RATE_PARENT)) { | |
1393 | /* pass-through clock without adjustable parent */ | |
1394 | clk->new_rate = clk->rate; | |
1395 | return NULL; | |
1396 | } else { | |
1397 | /* pass-through clock with adjustable parent */ | |
1398 | top = clk_calc_new_rates(parent, rate); | |
1399 | new_rate = parent->new_rate; | |
63f5c3b2 | 1400 | goto out; |
7452b219 MT |
1401 | } |
1402 | ||
71472c0c JH |
1403 | /* some clocks must be gated to change parent */ |
1404 | if (parent != old_parent && | |
1405 | (clk->flags & CLK_SET_PARENT_GATE) && clk->prepare_count) { | |
1406 | pr_debug("%s: %s not gated but wants to reparent\n", | |
1407 | __func__, clk->name); | |
b2476490 MT |
1408 | return NULL; |
1409 | } | |
1410 | ||
71472c0c JH |
1411 | /* try finding the new parent index */ |
1412 | if (parent) { | |
1413 | p_index = clk_fetch_parent_index(clk, parent); | |
f1c8b2ed | 1414 | if (p_index < 0) { |
71472c0c JH |
1415 | pr_debug("%s: clk %s can not be parent of clk %s\n", |
1416 | __func__, parent->name, clk->name); | |
1417 | return NULL; | |
1418 | } | |
b2476490 MT |
1419 | } |
1420 | ||
71472c0c JH |
1421 | if ((clk->flags & CLK_SET_RATE_PARENT) && parent && |
1422 | best_parent_rate != parent->rate) | |
1423 | top = clk_calc_new_rates(parent, best_parent_rate); | |
b2476490 MT |
1424 | |
1425 | out: | |
71472c0c | 1426 | clk_calc_subtree(clk, new_rate, parent, p_index); |
b2476490 MT |
1427 | |
1428 | return top; | |
1429 | } | |
1430 | ||
1431 | /* | |
1432 | * Notify about rate changes in a subtree. Always walk down the whole tree | |
1433 | * so that in case of an error we can walk down the whole tree again and | |
1434 | * abort the change. | |
1435 | */ | |
1436 | static struct clk *clk_propagate_rate_change(struct clk *clk, unsigned long event) | |
1437 | { | |
71472c0c | 1438 | struct clk *child, *tmp_clk, *fail_clk = NULL; |
b2476490 MT |
1439 | int ret = NOTIFY_DONE; |
1440 | ||
1441 | if (clk->rate == clk->new_rate) | |
5fda6858 | 1442 | return NULL; |
b2476490 MT |
1443 | |
1444 | if (clk->notifier_count) { | |
1445 | ret = __clk_notify(clk, event, clk->rate, clk->new_rate); | |
fb72a059 | 1446 | if (ret & NOTIFY_STOP_MASK) |
b2476490 MT |
1447 | fail_clk = clk; |
1448 | } | |
1449 | ||
b67bfe0d | 1450 | hlist_for_each_entry(child, &clk->children, child_node) { |
71472c0c JH |
1451 | /* Skip children who will be reparented to another clock */ |
1452 | if (child->new_parent && child->new_parent != clk) | |
1453 | continue; | |
1454 | tmp_clk = clk_propagate_rate_change(child, event); | |
1455 | if (tmp_clk) | |
1456 | fail_clk = tmp_clk; | |
1457 | } | |
1458 | ||
1459 | /* handle the new child who might not be in clk->children yet */ | |
1460 | if (clk->new_child) { | |
1461 | tmp_clk = clk_propagate_rate_change(clk->new_child, event); | |
1462 | if (tmp_clk) | |
1463 | fail_clk = tmp_clk; | |
b2476490 MT |
1464 | } |
1465 | ||
1466 | return fail_clk; | |
1467 | } | |
1468 | ||
1469 | /* | |
1470 | * walk down a subtree and set the new rates notifying the rate | |
1471 | * change on the way | |
1472 | */ | |
1473 | static void clk_change_rate(struct clk *clk) | |
1474 | { | |
1475 | struct clk *child; | |
1476 | unsigned long old_rate; | |
bf47b4fd | 1477 | unsigned long best_parent_rate = 0; |
3fa2252b SB |
1478 | bool skip_set_rate = false; |
1479 | struct clk *old_parent; | |
b2476490 MT |
1480 | |
1481 | old_rate = clk->rate; | |
1482 | ||
3fa2252b SB |
1483 | if (clk->new_parent) |
1484 | best_parent_rate = clk->new_parent->rate; | |
1485 | else if (clk->parent) | |
bf47b4fd PM |
1486 | best_parent_rate = clk->parent->rate; |
1487 | ||
3fa2252b SB |
1488 | if (clk->new_parent && clk->new_parent != clk->parent) { |
1489 | old_parent = __clk_set_parent_before(clk, clk->new_parent); | |
1490 | ||
1491 | if (clk->ops->set_rate_and_parent) { | |
1492 | skip_set_rate = true; | |
1493 | clk->ops->set_rate_and_parent(clk->hw, clk->new_rate, | |
1494 | best_parent_rate, | |
1495 | clk->new_parent_index); | |
1496 | } else if (clk->ops->set_parent) { | |
1497 | clk->ops->set_parent(clk->hw, clk->new_parent_index); | |
1498 | } | |
1499 | ||
1500 | __clk_set_parent_after(clk, clk->new_parent, old_parent); | |
1501 | } | |
1502 | ||
1503 | if (!skip_set_rate && clk->ops->set_rate) | |
bf47b4fd | 1504 | clk->ops->set_rate(clk->hw, clk->new_rate, best_parent_rate); |
b2476490 | 1505 | |
8f2c2db1 | 1506 | clk->rate = clk_recalc(clk, best_parent_rate); |
b2476490 MT |
1507 | |
1508 | if (clk->notifier_count && old_rate != clk->rate) | |
1509 | __clk_notify(clk, POST_RATE_CHANGE, old_rate, clk->rate); | |
1510 | ||
71472c0c JH |
1511 | hlist_for_each_entry(child, &clk->children, child_node) { |
1512 | /* Skip children who will be reparented to another clock */ | |
1513 | if (child->new_parent && child->new_parent != clk) | |
1514 | continue; | |
b2476490 | 1515 | clk_change_rate(child); |
71472c0c JH |
1516 | } |
1517 | ||
1518 | /* handle the new child who might not be in clk->children yet */ | |
1519 | if (clk->new_child) | |
1520 | clk_change_rate(clk->new_child); | |
b2476490 MT |
1521 | } |
1522 | ||
1523 | /** | |
1524 | * clk_set_rate - specify a new rate for clk | |
1525 | * @clk: the clk whose rate is being changed | |
1526 | * @rate: the new rate for clk | |
1527 | * | |
5654dc94 | 1528 | * In the simplest case clk_set_rate will only adjust the rate of clk. |
b2476490 | 1529 | * |
5654dc94 MT |
1530 | * Setting the CLK_SET_RATE_PARENT flag allows the rate change operation to |
1531 | * propagate up to clk's parent; whether or not this happens depends on the | |
1532 | * outcome of clk's .round_rate implementation. If *parent_rate is unchanged | |
1533 | * after calling .round_rate then upstream parent propagation is ignored. If | |
1534 | * *parent_rate comes back with a new rate for clk's parent then we propagate | |
24ee1a08 | 1535 | * up to clk's parent and set its rate. Upward propagation will continue |
5654dc94 MT |
1536 | * until either a clk does not support the CLK_SET_RATE_PARENT flag or |
1537 | * .round_rate stops requesting changes to clk's parent_rate. | |
b2476490 | 1538 | * |
5654dc94 MT |
1539 | * Rate changes are accomplished via tree traversal that also recalculates the |
1540 | * rates for the clocks and fires off POST_RATE_CHANGE notifiers. | |
b2476490 MT |
1541 | * |
1542 | * Returns 0 on success, -EERROR otherwise. | |
1543 | */ | |
1544 | int clk_set_rate(struct clk *clk, unsigned long rate) | |
1545 | { | |
1546 | struct clk *top, *fail_clk; | |
1547 | int ret = 0; | |
1548 | ||
89ac8d7a MT |
1549 | if (!clk) |
1550 | return 0; | |
1551 | ||
b2476490 | 1552 | /* prevent racing with updates to the clock topology */ |
eab89f69 | 1553 | clk_prepare_lock(); |
b2476490 MT |
1554 | |
1555 | /* bail early if nothing to do */ | |
34e452a1 | 1556 | if (rate == clk_get_rate(clk)) |
b2476490 MT |
1557 | goto out; |
1558 | ||
7e0fa1b5 | 1559 | if ((clk->flags & CLK_SET_RATE_GATE) && clk->prepare_count) { |
0e1c0301 VK |
1560 | ret = -EBUSY; |
1561 | goto out; | |
1562 | } | |
1563 | ||
b2476490 MT |
1564 | /* calculate new rates and get the topmost changed clock */ |
1565 | top = clk_calc_new_rates(clk, rate); | |
1566 | if (!top) { | |
1567 | ret = -EINVAL; | |
1568 | goto out; | |
1569 | } | |
1570 | ||
1571 | /* notify that we are about to change rates */ | |
1572 | fail_clk = clk_propagate_rate_change(top, PRE_RATE_CHANGE); | |
1573 | if (fail_clk) { | |
f7363861 | 1574 | pr_debug("%s: failed to set %s rate\n", __func__, |
b2476490 MT |
1575 | fail_clk->name); |
1576 | clk_propagate_rate_change(top, ABORT_RATE_CHANGE); | |
1577 | ret = -EBUSY; | |
1578 | goto out; | |
1579 | } | |
1580 | ||
1581 | /* change the rates */ | |
1582 | clk_change_rate(top); | |
1583 | ||
b2476490 | 1584 | out: |
eab89f69 | 1585 | clk_prepare_unlock(); |
b2476490 MT |
1586 | |
1587 | return ret; | |
1588 | } | |
1589 | EXPORT_SYMBOL_GPL(clk_set_rate); | |
1590 | ||
1591 | /** | |
1592 | * clk_get_parent - return the parent of a clk | |
1593 | * @clk: the clk whose parent gets returned | |
1594 | * | |
1595 | * Simply returns clk->parent. Returns NULL if clk is NULL. | |
1596 | */ | |
1597 | struct clk *clk_get_parent(struct clk *clk) | |
1598 | { | |
1599 | struct clk *parent; | |
1600 | ||
eab89f69 | 1601 | clk_prepare_lock(); |
b2476490 | 1602 | parent = __clk_get_parent(clk); |
eab89f69 | 1603 | clk_prepare_unlock(); |
b2476490 MT |
1604 | |
1605 | return parent; | |
1606 | } | |
1607 | EXPORT_SYMBOL_GPL(clk_get_parent); | |
1608 | ||
1609 | /* | |
1610 | * .get_parent is mandatory for clocks with multiple possible parents. It is | |
1611 | * optional for single-parent clocks. Always call .get_parent if it is | |
1612 | * available and WARN if it is missing for multi-parent clocks. | |
1613 | * | |
1614 | * For single-parent clocks without .get_parent, first check to see if the | |
1615 | * .parents array exists, and if so use it to avoid an expensive tree | |
1616 | * traversal. If .parents does not exist then walk the tree with __clk_lookup. | |
1617 | */ | |
1618 | static struct clk *__clk_init_parent(struct clk *clk) | |
1619 | { | |
1620 | struct clk *ret = NULL; | |
1621 | u8 index; | |
1622 | ||
1623 | /* handle the trivial cases */ | |
1624 | ||
1625 | if (!clk->num_parents) | |
1626 | goto out; | |
1627 | ||
1628 | if (clk->num_parents == 1) { | |
1629 | if (IS_ERR_OR_NULL(clk->parent)) | |
1630 | ret = clk->parent = __clk_lookup(clk->parent_names[0]); | |
1631 | ret = clk->parent; | |
1632 | goto out; | |
1633 | } | |
1634 | ||
1635 | if (!clk->ops->get_parent) { | |
1636 | WARN(!clk->ops->get_parent, | |
1637 | "%s: multi-parent clocks must implement .get_parent\n", | |
1638 | __func__); | |
1639 | goto out; | |
1640 | }; | |
1641 | ||
1642 | /* | |
1643 | * Do our best to cache parent clocks in clk->parents. This prevents | |
1644 | * unnecessary and expensive calls to __clk_lookup. We don't set | |
1645 | * clk->parent here; that is done by the calling function | |
1646 | */ | |
1647 | ||
1648 | index = clk->ops->get_parent(clk->hw); | |
1649 | ||
1650 | if (!clk->parents) | |
1651 | clk->parents = | |
96a7ed90 | 1652 | kcalloc(clk->num_parents, sizeof(struct clk *), |
b2476490 MT |
1653 | GFP_KERNEL); |
1654 | ||
7ef3dcc8 | 1655 | ret = clk_get_parent_by_index(clk, index); |
b2476490 MT |
1656 | |
1657 | out: | |
1658 | return ret; | |
1659 | } | |
1660 | ||
b33d212f UH |
1661 | void __clk_reparent(struct clk *clk, struct clk *new_parent) |
1662 | { | |
1663 | clk_reparent(clk, new_parent); | |
5279fc40 | 1664 | __clk_recalc_accuracies(clk); |
b2476490 MT |
1665 | __clk_recalc_rates(clk, POST_RATE_CHANGE); |
1666 | } | |
1667 | ||
b2476490 MT |
1668 | /** |
1669 | * clk_set_parent - switch the parent of a mux clk | |
1670 | * @clk: the mux clk whose input we are switching | |
1671 | * @parent: the new input to clk | |
1672 | * | |
f8aa0bd5 SK |
1673 | * Re-parent clk to use parent as its new input source. If clk is in |
1674 | * prepared state, the clk will get enabled for the duration of this call. If | |
1675 | * that's not acceptable for a specific clk (Eg: the consumer can't handle | |
1676 | * that, the reparenting is glitchy in hardware, etc), use the | |
1677 | * CLK_SET_PARENT_GATE flag to allow reparenting only when clk is unprepared. | |
1678 | * | |
1679 | * After successfully changing clk's parent clk_set_parent will update the | |
1680 | * clk topology, sysfs topology and propagate rate recalculation via | |
1681 | * __clk_recalc_rates. | |
1682 | * | |
1683 | * Returns 0 on success, -EERROR otherwise. | |
b2476490 MT |
1684 | */ |
1685 | int clk_set_parent(struct clk *clk, struct clk *parent) | |
1686 | { | |
1687 | int ret = 0; | |
f1c8b2ed | 1688 | int p_index = 0; |
031dcc9b | 1689 | unsigned long p_rate = 0; |
b2476490 | 1690 | |
89ac8d7a MT |
1691 | if (!clk) |
1692 | return 0; | |
1693 | ||
031dcc9b UH |
1694 | /* verify ops for for multi-parent clks */ |
1695 | if ((clk->num_parents > 1) && (!clk->ops->set_parent)) | |
b2476490 MT |
1696 | return -ENOSYS; |
1697 | ||
1698 | /* prevent racing with updates to the clock topology */ | |
eab89f69 | 1699 | clk_prepare_lock(); |
b2476490 MT |
1700 | |
1701 | if (clk->parent == parent) | |
1702 | goto out; | |
1703 | ||
031dcc9b UH |
1704 | /* check that we are allowed to re-parent if the clock is in use */ |
1705 | if ((clk->flags & CLK_SET_PARENT_GATE) && clk->prepare_count) { | |
1706 | ret = -EBUSY; | |
1707 | goto out; | |
1708 | } | |
1709 | ||
1710 | /* try finding the new parent index */ | |
1711 | if (parent) { | |
1712 | p_index = clk_fetch_parent_index(clk, parent); | |
1713 | p_rate = parent->rate; | |
f1c8b2ed | 1714 | if (p_index < 0) { |
031dcc9b UH |
1715 | pr_debug("%s: clk %s can not be parent of clk %s\n", |
1716 | __func__, parent->name, clk->name); | |
f1c8b2ed | 1717 | ret = p_index; |
031dcc9b UH |
1718 | goto out; |
1719 | } | |
1720 | } | |
1721 | ||
b2476490 | 1722 | /* propagate PRE_RATE_CHANGE notifications */ |
f3aab5d6 | 1723 | ret = __clk_speculate_rates(clk, p_rate); |
b2476490 MT |
1724 | |
1725 | /* abort if a driver objects */ | |
fb72a059 | 1726 | if (ret & NOTIFY_STOP_MASK) |
b2476490 MT |
1727 | goto out; |
1728 | ||
031dcc9b UH |
1729 | /* do the re-parent */ |
1730 | ret = __clk_set_parent(clk, parent, p_index); | |
b2476490 | 1731 | |
5279fc40 BB |
1732 | /* propagate rate an accuracy recalculation accordingly */ |
1733 | if (ret) { | |
b2476490 | 1734 | __clk_recalc_rates(clk, ABORT_RATE_CHANGE); |
5279fc40 | 1735 | } else { |
a68de8e4 | 1736 | __clk_recalc_rates(clk, POST_RATE_CHANGE); |
5279fc40 BB |
1737 | __clk_recalc_accuracies(clk); |
1738 | } | |
b2476490 MT |
1739 | |
1740 | out: | |
eab89f69 | 1741 | clk_prepare_unlock(); |
b2476490 MT |
1742 | |
1743 | return ret; | |
1744 | } | |
1745 | EXPORT_SYMBOL_GPL(clk_set_parent); | |
1746 | ||
e59c5371 MT |
1747 | /** |
1748 | * clk_set_phase - adjust the phase shift of a clock signal | |
1749 | * @clk: clock signal source | |
1750 | * @degrees: number of degrees the signal is shifted | |
1751 | * | |
1752 | * Shifts the phase of a clock signal by the specified | |
1753 | * degrees. Returns 0 on success, -EERROR otherwise. | |
1754 | * | |
1755 | * This function makes no distinction about the input or reference | |
1756 | * signal that we adjust the clock signal phase against. For example | |
1757 | * phase locked-loop clock signal generators we may shift phase with | |
1758 | * respect to feedback clock signal input, but for other cases the | |
1759 | * clock phase may be shifted with respect to some other, unspecified | |
1760 | * signal. | |
1761 | * | |
1762 | * Additionally the concept of phase shift does not propagate through | |
1763 | * the clock tree hierarchy, which sets it apart from clock rates and | |
1764 | * clock accuracy. A parent clock phase attribute does not have an | |
1765 | * impact on the phase attribute of a child clock. | |
1766 | */ | |
1767 | int clk_set_phase(struct clk *clk, int degrees) | |
1768 | { | |
1769 | int ret = 0; | |
1770 | ||
1771 | if (!clk) | |
1772 | goto out; | |
1773 | ||
1774 | /* sanity check degrees */ | |
1775 | degrees %= 360; | |
1776 | if (degrees < 0) | |
1777 | degrees += 360; | |
1778 | ||
1779 | clk_prepare_lock(); | |
1780 | ||
1781 | if (!clk->ops->set_phase) | |
1782 | goto out_unlock; | |
1783 | ||
1784 | ret = clk->ops->set_phase(clk->hw, degrees); | |
1785 | ||
1786 | if (!ret) | |
1787 | clk->phase = degrees; | |
1788 | ||
1789 | out_unlock: | |
1790 | clk_prepare_unlock(); | |
1791 | ||
1792 | out: | |
1793 | return ret; | |
1794 | } | |
1795 | ||
1796 | /** | |
1797 | * clk_get_phase - return the phase shift of a clock signal | |
1798 | * @clk: clock signal source | |
1799 | * | |
1800 | * Returns the phase shift of a clock node in degrees, otherwise returns | |
1801 | * -EERROR. | |
1802 | */ | |
1803 | int clk_get_phase(struct clk *clk) | |
1804 | { | |
1805 | int ret = 0; | |
1806 | ||
1807 | if (!clk) | |
1808 | goto out; | |
1809 | ||
1810 | clk_prepare_lock(); | |
1811 | ret = clk->phase; | |
1812 | clk_prepare_unlock(); | |
1813 | ||
1814 | out: | |
1815 | return ret; | |
1816 | } | |
1817 | ||
b2476490 MT |
1818 | /** |
1819 | * __clk_init - initialize the data structures in a struct clk | |
1820 | * @dev: device initializing this clk, placeholder for now | |
1821 | * @clk: clk being initialized | |
1822 | * | |
1823 | * Initializes the lists in struct clk, queries the hardware for the | |
1824 | * parent and rate and sets them both. | |
b2476490 | 1825 | */ |
d1302a36 | 1826 | int __clk_init(struct device *dev, struct clk *clk) |
b2476490 | 1827 | { |
d1302a36 | 1828 | int i, ret = 0; |
b2476490 | 1829 | struct clk *orphan; |
b67bfe0d | 1830 | struct hlist_node *tmp2; |
b2476490 MT |
1831 | |
1832 | if (!clk) | |
d1302a36 | 1833 | return -EINVAL; |
b2476490 | 1834 | |
eab89f69 | 1835 | clk_prepare_lock(); |
b2476490 MT |
1836 | |
1837 | /* check to see if a clock with this name is already registered */ | |
d1302a36 MT |
1838 | if (__clk_lookup(clk->name)) { |
1839 | pr_debug("%s: clk %s already initialized\n", | |
1840 | __func__, clk->name); | |
1841 | ret = -EEXIST; | |
b2476490 | 1842 | goto out; |
d1302a36 | 1843 | } |
b2476490 | 1844 | |
d4d7e3dd MT |
1845 | /* check that clk_ops are sane. See Documentation/clk.txt */ |
1846 | if (clk->ops->set_rate && | |
71472c0c JH |
1847 | !((clk->ops->round_rate || clk->ops->determine_rate) && |
1848 | clk->ops->recalc_rate)) { | |
1849 | pr_warning("%s: %s must implement .round_rate or .determine_rate in addition to .recalc_rate\n", | |
d4d7e3dd | 1850 | __func__, clk->name); |
d1302a36 | 1851 | ret = -EINVAL; |
d4d7e3dd MT |
1852 | goto out; |
1853 | } | |
1854 | ||
1855 | if (clk->ops->set_parent && !clk->ops->get_parent) { | |
1856 | pr_warning("%s: %s must implement .get_parent & .set_parent\n", | |
1857 | __func__, clk->name); | |
d1302a36 | 1858 | ret = -EINVAL; |
d4d7e3dd MT |
1859 | goto out; |
1860 | } | |
1861 | ||
3fa2252b SB |
1862 | if (clk->ops->set_rate_and_parent && |
1863 | !(clk->ops->set_parent && clk->ops->set_rate)) { | |
1864 | pr_warn("%s: %s must implement .set_parent & .set_rate\n", | |
1865 | __func__, clk->name); | |
1866 | ret = -EINVAL; | |
1867 | goto out; | |
1868 | } | |
1869 | ||
b2476490 MT |
1870 | /* throw a WARN if any entries in parent_names are NULL */ |
1871 | for (i = 0; i < clk->num_parents; i++) | |
1872 | WARN(!clk->parent_names[i], | |
1873 | "%s: invalid NULL in %s's .parent_names\n", | |
1874 | __func__, clk->name); | |
1875 | ||
1876 | /* | |
1877 | * Allocate an array of struct clk *'s to avoid unnecessary string | |
1878 | * look-ups of clk's possible parents. This can fail for clocks passed | |
1879 | * in to clk_init during early boot; thus any access to clk->parents[] | |
1880 | * must always check for a NULL pointer and try to populate it if | |
1881 | * necessary. | |
1882 | * | |
1883 | * If clk->parents is not NULL we skip this entire block. This allows | |
1884 | * for clock drivers to statically initialize clk->parents. | |
1885 | */ | |
9ca1c5a4 | 1886 | if (clk->num_parents > 1 && !clk->parents) { |
96a7ed90 TF |
1887 | clk->parents = kcalloc(clk->num_parents, sizeof(struct clk *), |
1888 | GFP_KERNEL); | |
b2476490 MT |
1889 | /* |
1890 | * __clk_lookup returns NULL for parents that have not been | |
1891 | * clk_init'd; thus any access to clk->parents[] must check | |
1892 | * for a NULL pointer. We can always perform lazy lookups for | |
1893 | * missing parents later on. | |
1894 | */ | |
1895 | if (clk->parents) | |
1896 | for (i = 0; i < clk->num_parents; i++) | |
1897 | clk->parents[i] = | |
1898 | __clk_lookup(clk->parent_names[i]); | |
1899 | } | |
1900 | ||
1901 | clk->parent = __clk_init_parent(clk); | |
1902 | ||
1903 | /* | |
1904 | * Populate clk->parent if parent has already been __clk_init'd. If | |
1905 | * parent has not yet been __clk_init'd then place clk in the orphan | |
1906 | * list. If clk has set the CLK_IS_ROOT flag then place it in the root | |
1907 | * clk list. | |
1908 | * | |
1909 | * Every time a new clk is clk_init'd then we walk the list of orphan | |
1910 | * clocks and re-parent any that are children of the clock currently | |
1911 | * being clk_init'd. | |
1912 | */ | |
1913 | if (clk->parent) | |
1914 | hlist_add_head(&clk->child_node, | |
1915 | &clk->parent->children); | |
1916 | else if (clk->flags & CLK_IS_ROOT) | |
1917 | hlist_add_head(&clk->child_node, &clk_root_list); | |
1918 | else | |
1919 | hlist_add_head(&clk->child_node, &clk_orphan_list); | |
1920 | ||
5279fc40 BB |
1921 | /* |
1922 | * Set clk's accuracy. The preferred method is to use | |
1923 | * .recalc_accuracy. For simple clocks and lazy developers the default | |
1924 | * fallback is to use the parent's accuracy. If a clock doesn't have a | |
1925 | * parent (or is orphaned) then accuracy is set to zero (perfect | |
1926 | * clock). | |
1927 | */ | |
1928 | if (clk->ops->recalc_accuracy) | |
1929 | clk->accuracy = clk->ops->recalc_accuracy(clk->hw, | |
1930 | __clk_get_accuracy(clk->parent)); | |
1931 | else if (clk->parent) | |
1932 | clk->accuracy = clk->parent->accuracy; | |
1933 | else | |
1934 | clk->accuracy = 0; | |
1935 | ||
b2476490 MT |
1936 | /* |
1937 | * Set clk's rate. The preferred method is to use .recalc_rate. For | |
1938 | * simple clocks and lazy developers the default fallback is to use the | |
1939 | * parent's rate. If a clock doesn't have a parent (or is orphaned) | |
1940 | * then rate is set to zero. | |
1941 | */ | |
1942 | if (clk->ops->recalc_rate) | |
1943 | clk->rate = clk->ops->recalc_rate(clk->hw, | |
1944 | __clk_get_rate(clk->parent)); | |
1945 | else if (clk->parent) | |
1946 | clk->rate = clk->parent->rate; | |
1947 | else | |
1948 | clk->rate = 0; | |
1949 | ||
3a5aec24 | 1950 | clk_debug_register(clk); |
b2476490 MT |
1951 | /* |
1952 | * walk the list of orphan clocks and reparent any that are children of | |
1953 | * this clock | |
1954 | */ | |
b67bfe0d | 1955 | hlist_for_each_entry_safe(orphan, tmp2, &clk_orphan_list, child_node) { |
12d29886 | 1956 | if (orphan->num_parents && orphan->ops->get_parent) { |
1f61e5f1 MF |
1957 | i = orphan->ops->get_parent(orphan->hw); |
1958 | if (!strcmp(clk->name, orphan->parent_names[i])) | |
1959 | __clk_reparent(orphan, clk); | |
1960 | continue; | |
1961 | } | |
1962 | ||
b2476490 MT |
1963 | for (i = 0; i < orphan->num_parents; i++) |
1964 | if (!strcmp(clk->name, orphan->parent_names[i])) { | |
1965 | __clk_reparent(orphan, clk); | |
1966 | break; | |
1967 | } | |
1f61e5f1 | 1968 | } |
b2476490 MT |
1969 | |
1970 | /* | |
1971 | * optional platform-specific magic | |
1972 | * | |
1973 | * The .init callback is not used by any of the basic clock types, but | |
1974 | * exists for weird hardware that must perform initialization magic. | |
1975 | * Please consider other ways of solving initialization problems before | |
24ee1a08 | 1976 | * using this callback, as its use is discouraged. |
b2476490 MT |
1977 | */ |
1978 | if (clk->ops->init) | |
1979 | clk->ops->init(clk->hw); | |
1980 | ||
fcb0ee6a | 1981 | kref_init(&clk->ref); |
b2476490 | 1982 | out: |
eab89f69 | 1983 | clk_prepare_unlock(); |
b2476490 | 1984 | |
d1302a36 | 1985 | return ret; |
b2476490 MT |
1986 | } |
1987 | ||
0197b3ea SK |
1988 | /** |
1989 | * __clk_register - register a clock and return a cookie. | |
1990 | * | |
1991 | * Same as clk_register, except that the .clk field inside hw shall point to a | |
1992 | * preallocated (generally statically allocated) struct clk. None of the fields | |
1993 | * of the struct clk need to be initialized. | |
1994 | * | |
1995 | * The data pointed to by .init and .clk field shall NOT be marked as init | |
1996 | * data. | |
1997 | * | |
1998 | * __clk_register is only exposed via clk-private.h and is intended for use with | |
1999 | * very large numbers of clocks that need to be statically initialized. It is | |
2000 | * a layering violation to include clk-private.h from any code which implements | |
2001 | * a clock's .ops; as such any statically initialized clock data MUST be in a | |
24ee1a08 | 2002 | * separate C file from the logic that implements its operations. Returns 0 |
0197b3ea SK |
2003 | * on success, otherwise an error code. |
2004 | */ | |
2005 | struct clk *__clk_register(struct device *dev, struct clk_hw *hw) | |
2006 | { | |
2007 | int ret; | |
2008 | struct clk *clk; | |
2009 | ||
2010 | clk = hw->clk; | |
2011 | clk->name = hw->init->name; | |
2012 | clk->ops = hw->init->ops; | |
2013 | clk->hw = hw; | |
2014 | clk->flags = hw->init->flags; | |
2015 | clk->parent_names = hw->init->parent_names; | |
2016 | clk->num_parents = hw->init->num_parents; | |
ac2df527 SN |
2017 | if (dev && dev->driver) |
2018 | clk->owner = dev->driver->owner; | |
2019 | else | |
2020 | clk->owner = NULL; | |
0197b3ea SK |
2021 | |
2022 | ret = __clk_init(dev, clk); | |
2023 | if (ret) | |
2024 | return ERR_PTR(ret); | |
2025 | ||
2026 | return clk; | |
2027 | } | |
2028 | EXPORT_SYMBOL_GPL(__clk_register); | |
2029 | ||
293ba3b4 SB |
2030 | /** |
2031 | * clk_register - allocate a new clock, register it and return an opaque cookie | |
2032 | * @dev: device that is registering this clock | |
2033 | * @hw: link to hardware-specific clock data | |
2034 | * | |
2035 | * clk_register is the primary interface for populating the clock tree with new | |
2036 | * clock nodes. It returns a pointer to the newly allocated struct clk which | |
2037 | * cannot be dereferenced by driver code but may be used in conjuction with the | |
2038 | * rest of the clock API. In the event of an error clk_register will return an | |
2039 | * error code; drivers must test for an error code after calling clk_register. | |
2040 | */ | |
2041 | struct clk *clk_register(struct device *dev, struct clk_hw *hw) | |
b2476490 | 2042 | { |
d1302a36 | 2043 | int i, ret; |
293ba3b4 SB |
2044 | struct clk *clk; |
2045 | ||
2046 | clk = kzalloc(sizeof(*clk), GFP_KERNEL); | |
2047 | if (!clk) { | |
2048 | pr_err("%s: could not allocate clk\n", __func__); | |
2049 | ret = -ENOMEM; | |
2050 | goto fail_out; | |
2051 | } | |
b2476490 | 2052 | |
0197b3ea SK |
2053 | clk->name = kstrdup(hw->init->name, GFP_KERNEL); |
2054 | if (!clk->name) { | |
2055 | pr_err("%s: could not allocate clk->name\n", __func__); | |
2056 | ret = -ENOMEM; | |
2057 | goto fail_name; | |
2058 | } | |
2059 | clk->ops = hw->init->ops; | |
ac2df527 SN |
2060 | if (dev && dev->driver) |
2061 | clk->owner = dev->driver->owner; | |
b2476490 | 2062 | clk->hw = hw; |
0197b3ea SK |
2063 | clk->flags = hw->init->flags; |
2064 | clk->num_parents = hw->init->num_parents; | |
b2476490 MT |
2065 | hw->clk = clk; |
2066 | ||
d1302a36 | 2067 | /* allocate local copy in case parent_names is __initdata */ |
96a7ed90 TF |
2068 | clk->parent_names = kcalloc(clk->num_parents, sizeof(char *), |
2069 | GFP_KERNEL); | |
d1302a36 MT |
2070 | |
2071 | if (!clk->parent_names) { | |
2072 | pr_err("%s: could not allocate clk->parent_names\n", __func__); | |
2073 | ret = -ENOMEM; | |
2074 | goto fail_parent_names; | |
2075 | } | |
2076 | ||
2077 | ||
2078 | /* copy each string name in case parent_names is __initdata */ | |
0197b3ea SK |
2079 | for (i = 0; i < clk->num_parents; i++) { |
2080 | clk->parent_names[i] = kstrdup(hw->init->parent_names[i], | |
2081 | GFP_KERNEL); | |
d1302a36 MT |
2082 | if (!clk->parent_names[i]) { |
2083 | pr_err("%s: could not copy parent_names\n", __func__); | |
2084 | ret = -ENOMEM; | |
2085 | goto fail_parent_names_copy; | |
2086 | } | |
2087 | } | |
2088 | ||
2089 | ret = __clk_init(dev, clk); | |
2090 | if (!ret) | |
293ba3b4 | 2091 | return clk; |
b2476490 | 2092 | |
d1302a36 MT |
2093 | fail_parent_names_copy: |
2094 | while (--i >= 0) | |
2095 | kfree(clk->parent_names[i]); | |
2096 | kfree(clk->parent_names); | |
2097 | fail_parent_names: | |
0197b3ea SK |
2098 | kfree(clk->name); |
2099 | fail_name: | |
d1302a36 MT |
2100 | kfree(clk); |
2101 | fail_out: | |
2102 | return ERR_PTR(ret); | |
b2476490 MT |
2103 | } |
2104 | EXPORT_SYMBOL_GPL(clk_register); | |
2105 | ||
fcb0ee6a SN |
2106 | /* |
2107 | * Free memory allocated for a clock. | |
2108 | * Caller must hold prepare_lock. | |
2109 | */ | |
2110 | static void __clk_release(struct kref *ref) | |
2111 | { | |
2112 | struct clk *clk = container_of(ref, struct clk, ref); | |
2113 | int i = clk->num_parents; | |
2114 | ||
2115 | kfree(clk->parents); | |
2116 | while (--i >= 0) | |
2117 | kfree(clk->parent_names[i]); | |
2118 | ||
2119 | kfree(clk->parent_names); | |
2120 | kfree(clk->name); | |
2121 | kfree(clk); | |
2122 | } | |
2123 | ||
2124 | /* | |
2125 | * Empty clk_ops for unregistered clocks. These are used temporarily | |
2126 | * after clk_unregister() was called on a clock and until last clock | |
2127 | * consumer calls clk_put() and the struct clk object is freed. | |
2128 | */ | |
2129 | static int clk_nodrv_prepare_enable(struct clk_hw *hw) | |
2130 | { | |
2131 | return -ENXIO; | |
2132 | } | |
2133 | ||
2134 | static void clk_nodrv_disable_unprepare(struct clk_hw *hw) | |
2135 | { | |
2136 | WARN_ON_ONCE(1); | |
2137 | } | |
2138 | ||
2139 | static int clk_nodrv_set_rate(struct clk_hw *hw, unsigned long rate, | |
2140 | unsigned long parent_rate) | |
2141 | { | |
2142 | return -ENXIO; | |
2143 | } | |
2144 | ||
2145 | static int clk_nodrv_set_parent(struct clk_hw *hw, u8 index) | |
2146 | { | |
2147 | return -ENXIO; | |
2148 | } | |
2149 | ||
2150 | static const struct clk_ops clk_nodrv_ops = { | |
2151 | .enable = clk_nodrv_prepare_enable, | |
2152 | .disable = clk_nodrv_disable_unprepare, | |
2153 | .prepare = clk_nodrv_prepare_enable, | |
2154 | .unprepare = clk_nodrv_disable_unprepare, | |
2155 | .set_rate = clk_nodrv_set_rate, | |
2156 | .set_parent = clk_nodrv_set_parent, | |
2157 | }; | |
2158 | ||
1df5c939 MB |
2159 | /** |
2160 | * clk_unregister - unregister a currently registered clock | |
2161 | * @clk: clock to unregister | |
1df5c939 | 2162 | */ |
fcb0ee6a SN |
2163 | void clk_unregister(struct clk *clk) |
2164 | { | |
2165 | unsigned long flags; | |
2166 | ||
2167 | if (!clk || WARN_ON_ONCE(IS_ERR(clk))) | |
2168 | return; | |
2169 | ||
2170 | clk_prepare_lock(); | |
2171 | ||
2172 | if (clk->ops == &clk_nodrv_ops) { | |
2173 | pr_err("%s: unregistered clock: %s\n", __func__, clk->name); | |
2174 | goto out; | |
2175 | } | |
2176 | /* | |
2177 | * Assign empty clock ops for consumers that might still hold | |
2178 | * a reference to this clock. | |
2179 | */ | |
2180 | flags = clk_enable_lock(); | |
2181 | clk->ops = &clk_nodrv_ops; | |
2182 | clk_enable_unlock(flags); | |
2183 | ||
2184 | if (!hlist_empty(&clk->children)) { | |
2185 | struct clk *child; | |
874f224c | 2186 | struct hlist_node *t; |
fcb0ee6a SN |
2187 | |
2188 | /* Reparent all children to the orphan list. */ | |
874f224c | 2189 | hlist_for_each_entry_safe(child, t, &clk->children, child_node) |
fcb0ee6a SN |
2190 | clk_set_parent(child, NULL); |
2191 | } | |
2192 | ||
2193 | clk_debug_unregister(clk); | |
2194 | ||
2195 | hlist_del_init(&clk->child_node); | |
2196 | ||
2197 | if (clk->prepare_count) | |
2198 | pr_warn("%s: unregistering prepared clock: %s\n", | |
2199 | __func__, clk->name); | |
2200 | ||
2201 | kref_put(&clk->ref, __clk_release); | |
2202 | out: | |
2203 | clk_prepare_unlock(); | |
2204 | } | |
1df5c939 MB |
2205 | EXPORT_SYMBOL_GPL(clk_unregister); |
2206 | ||
46c8773a SB |
2207 | static void devm_clk_release(struct device *dev, void *res) |
2208 | { | |
293ba3b4 | 2209 | clk_unregister(*(struct clk **)res); |
46c8773a SB |
2210 | } |
2211 | ||
2212 | /** | |
2213 | * devm_clk_register - resource managed clk_register() | |
2214 | * @dev: device that is registering this clock | |
2215 | * @hw: link to hardware-specific clock data | |
2216 | * | |
2217 | * Managed clk_register(). Clocks returned from this function are | |
2218 | * automatically clk_unregister()ed on driver detach. See clk_register() for | |
2219 | * more information. | |
2220 | */ | |
2221 | struct clk *devm_clk_register(struct device *dev, struct clk_hw *hw) | |
2222 | { | |
2223 | struct clk *clk; | |
293ba3b4 | 2224 | struct clk **clkp; |
46c8773a | 2225 | |
293ba3b4 SB |
2226 | clkp = devres_alloc(devm_clk_release, sizeof(*clkp), GFP_KERNEL); |
2227 | if (!clkp) | |
46c8773a SB |
2228 | return ERR_PTR(-ENOMEM); |
2229 | ||
293ba3b4 SB |
2230 | clk = clk_register(dev, hw); |
2231 | if (!IS_ERR(clk)) { | |
2232 | *clkp = clk; | |
2233 | devres_add(dev, clkp); | |
46c8773a | 2234 | } else { |
293ba3b4 | 2235 | devres_free(clkp); |
46c8773a SB |
2236 | } |
2237 | ||
2238 | return clk; | |
2239 | } | |
2240 | EXPORT_SYMBOL_GPL(devm_clk_register); | |
2241 | ||
2242 | static int devm_clk_match(struct device *dev, void *res, void *data) | |
2243 | { | |
2244 | struct clk *c = res; | |
2245 | if (WARN_ON(!c)) | |
2246 | return 0; | |
2247 | return c == data; | |
2248 | } | |
2249 | ||
2250 | /** | |
2251 | * devm_clk_unregister - resource managed clk_unregister() | |
2252 | * @clk: clock to unregister | |
2253 | * | |
2254 | * Deallocate a clock allocated with devm_clk_register(). Normally | |
2255 | * this function will not need to be called and the resource management | |
2256 | * code will ensure that the resource is freed. | |
2257 | */ | |
2258 | void devm_clk_unregister(struct device *dev, struct clk *clk) | |
2259 | { | |
2260 | WARN_ON(devres_release(dev, devm_clk_release, devm_clk_match, clk)); | |
2261 | } | |
2262 | EXPORT_SYMBOL_GPL(devm_clk_unregister); | |
2263 | ||
ac2df527 SN |
2264 | /* |
2265 | * clkdev helpers | |
2266 | */ | |
2267 | int __clk_get(struct clk *clk) | |
2268 | { | |
00efcb1c SN |
2269 | if (clk) { |
2270 | if (!try_module_get(clk->owner)) | |
2271 | return 0; | |
ac2df527 | 2272 | |
00efcb1c SN |
2273 | kref_get(&clk->ref); |
2274 | } | |
ac2df527 SN |
2275 | return 1; |
2276 | } | |
2277 | ||
2278 | void __clk_put(struct clk *clk) | |
2279 | { | |
00efcb1c | 2280 | if (!clk || WARN_ON_ONCE(IS_ERR(clk))) |
ac2df527 SN |
2281 | return; |
2282 | ||
fcb0ee6a SN |
2283 | clk_prepare_lock(); |
2284 | kref_put(&clk->ref, __clk_release); | |
2285 | clk_prepare_unlock(); | |
2286 | ||
00efcb1c | 2287 | module_put(clk->owner); |
ac2df527 SN |
2288 | } |
2289 | ||
b2476490 MT |
2290 | /*** clk rate change notifiers ***/ |
2291 | ||
2292 | /** | |
2293 | * clk_notifier_register - add a clk rate change notifier | |
2294 | * @clk: struct clk * to watch | |
2295 | * @nb: struct notifier_block * with callback info | |
2296 | * | |
2297 | * Request notification when clk's rate changes. This uses an SRCU | |
2298 | * notifier because we want it to block and notifier unregistrations are | |
2299 | * uncommon. The callbacks associated with the notifier must not | |
2300 | * re-enter into the clk framework by calling any top-level clk APIs; | |
2301 | * this will cause a nested prepare_lock mutex. | |
2302 | * | |
5324fda7 SB |
2303 | * In all notification cases cases (pre, post and abort rate change) the |
2304 | * original clock rate is passed to the callback via struct | |
2305 | * clk_notifier_data.old_rate and the new frequency is passed via struct | |
b2476490 MT |
2306 | * clk_notifier_data.new_rate. |
2307 | * | |
b2476490 MT |
2308 | * clk_notifier_register() must be called from non-atomic context. |
2309 | * Returns -EINVAL if called with null arguments, -ENOMEM upon | |
2310 | * allocation failure; otherwise, passes along the return value of | |
2311 | * srcu_notifier_chain_register(). | |
2312 | */ | |
2313 | int clk_notifier_register(struct clk *clk, struct notifier_block *nb) | |
2314 | { | |
2315 | struct clk_notifier *cn; | |
2316 | int ret = -ENOMEM; | |
2317 | ||
2318 | if (!clk || !nb) | |
2319 | return -EINVAL; | |
2320 | ||
eab89f69 | 2321 | clk_prepare_lock(); |
b2476490 MT |
2322 | |
2323 | /* search the list of notifiers for this clk */ | |
2324 | list_for_each_entry(cn, &clk_notifier_list, node) | |
2325 | if (cn->clk == clk) | |
2326 | break; | |
2327 | ||
2328 | /* if clk wasn't in the notifier list, allocate new clk_notifier */ | |
2329 | if (cn->clk != clk) { | |
2330 | cn = kzalloc(sizeof(struct clk_notifier), GFP_KERNEL); | |
2331 | if (!cn) | |
2332 | goto out; | |
2333 | ||
2334 | cn->clk = clk; | |
2335 | srcu_init_notifier_head(&cn->notifier_head); | |
2336 | ||
2337 | list_add(&cn->node, &clk_notifier_list); | |
2338 | } | |
2339 | ||
2340 | ret = srcu_notifier_chain_register(&cn->notifier_head, nb); | |
2341 | ||
2342 | clk->notifier_count++; | |
2343 | ||
2344 | out: | |
eab89f69 | 2345 | clk_prepare_unlock(); |
b2476490 MT |
2346 | |
2347 | return ret; | |
2348 | } | |
2349 | EXPORT_SYMBOL_GPL(clk_notifier_register); | |
2350 | ||
2351 | /** | |
2352 | * clk_notifier_unregister - remove a clk rate change notifier | |
2353 | * @clk: struct clk * | |
2354 | * @nb: struct notifier_block * with callback info | |
2355 | * | |
2356 | * Request no further notification for changes to 'clk' and frees memory | |
2357 | * allocated in clk_notifier_register. | |
2358 | * | |
2359 | * Returns -EINVAL if called with null arguments; otherwise, passes | |
2360 | * along the return value of srcu_notifier_chain_unregister(). | |
2361 | */ | |
2362 | int clk_notifier_unregister(struct clk *clk, struct notifier_block *nb) | |
2363 | { | |
2364 | struct clk_notifier *cn = NULL; | |
2365 | int ret = -EINVAL; | |
2366 | ||
2367 | if (!clk || !nb) | |
2368 | return -EINVAL; | |
2369 | ||
eab89f69 | 2370 | clk_prepare_lock(); |
b2476490 MT |
2371 | |
2372 | list_for_each_entry(cn, &clk_notifier_list, node) | |
2373 | if (cn->clk == clk) | |
2374 | break; | |
2375 | ||
2376 | if (cn->clk == clk) { | |
2377 | ret = srcu_notifier_chain_unregister(&cn->notifier_head, nb); | |
2378 | ||
2379 | clk->notifier_count--; | |
2380 | ||
2381 | /* XXX the notifier code should handle this better */ | |
2382 | if (!cn->notifier_head.head) { | |
2383 | srcu_cleanup_notifier_head(&cn->notifier_head); | |
72b5322f | 2384 | list_del(&cn->node); |
b2476490 MT |
2385 | kfree(cn); |
2386 | } | |
2387 | ||
2388 | } else { | |
2389 | ret = -ENOENT; | |
2390 | } | |
2391 | ||
eab89f69 | 2392 | clk_prepare_unlock(); |
b2476490 MT |
2393 | |
2394 | return ret; | |
2395 | } | |
2396 | EXPORT_SYMBOL_GPL(clk_notifier_unregister); | |
766e6a4e GL |
2397 | |
2398 | #ifdef CONFIG_OF | |
2399 | /** | |
2400 | * struct of_clk_provider - Clock provider registration structure | |
2401 | * @link: Entry in global list of clock providers | |
2402 | * @node: Pointer to device tree node of clock provider | |
2403 | * @get: Get clock callback. Returns NULL or a struct clk for the | |
2404 | * given clock specifier | |
2405 | * @data: context pointer to be passed into @get callback | |
2406 | */ | |
2407 | struct of_clk_provider { | |
2408 | struct list_head link; | |
2409 | ||
2410 | struct device_node *node; | |
2411 | struct clk *(*get)(struct of_phandle_args *clkspec, void *data); | |
2412 | void *data; | |
2413 | }; | |
2414 | ||
f2f6c255 PG |
2415 | static const struct of_device_id __clk_of_table_sentinel |
2416 | __used __section(__clk_of_table_end); | |
2417 | ||
766e6a4e | 2418 | static LIST_HEAD(of_clk_providers); |
d6782c26 SN |
2419 | static DEFINE_MUTEX(of_clk_mutex); |
2420 | ||
2421 | /* of_clk_provider list locking helpers */ | |
2422 | void of_clk_lock(void) | |
2423 | { | |
2424 | mutex_lock(&of_clk_mutex); | |
2425 | } | |
2426 | ||
2427 | void of_clk_unlock(void) | |
2428 | { | |
2429 | mutex_unlock(&of_clk_mutex); | |
2430 | } | |
766e6a4e GL |
2431 | |
2432 | struct clk *of_clk_src_simple_get(struct of_phandle_args *clkspec, | |
2433 | void *data) | |
2434 | { | |
2435 | return data; | |
2436 | } | |
2437 | EXPORT_SYMBOL_GPL(of_clk_src_simple_get); | |
2438 | ||
494bfec9 SG |
2439 | struct clk *of_clk_src_onecell_get(struct of_phandle_args *clkspec, void *data) |
2440 | { | |
2441 | struct clk_onecell_data *clk_data = data; | |
2442 | unsigned int idx = clkspec->args[0]; | |
2443 | ||
2444 | if (idx >= clk_data->clk_num) { | |
2445 | pr_err("%s: invalid clock index %d\n", __func__, idx); | |
2446 | return ERR_PTR(-EINVAL); | |
2447 | } | |
2448 | ||
2449 | return clk_data->clks[idx]; | |
2450 | } | |
2451 | EXPORT_SYMBOL_GPL(of_clk_src_onecell_get); | |
2452 | ||
766e6a4e GL |
2453 | /** |
2454 | * of_clk_add_provider() - Register a clock provider for a node | |
2455 | * @np: Device node pointer associated with clock provider | |
2456 | * @clk_src_get: callback for decoding clock | |
2457 | * @data: context pointer for @clk_src_get callback. | |
2458 | */ | |
2459 | int of_clk_add_provider(struct device_node *np, | |
2460 | struct clk *(*clk_src_get)(struct of_phandle_args *clkspec, | |
2461 | void *data), | |
2462 | void *data) | |
2463 | { | |
2464 | struct of_clk_provider *cp; | |
86be408b | 2465 | int ret; |
766e6a4e GL |
2466 | |
2467 | cp = kzalloc(sizeof(struct of_clk_provider), GFP_KERNEL); | |
2468 | if (!cp) | |
2469 | return -ENOMEM; | |
2470 | ||
2471 | cp->node = of_node_get(np); | |
2472 | cp->data = data; | |
2473 | cp->get = clk_src_get; | |
2474 | ||
d6782c26 | 2475 | mutex_lock(&of_clk_mutex); |
766e6a4e | 2476 | list_add(&cp->link, &of_clk_providers); |
d6782c26 | 2477 | mutex_unlock(&of_clk_mutex); |
766e6a4e GL |
2478 | pr_debug("Added clock from %s\n", np->full_name); |
2479 | ||
86be408b SN |
2480 | ret = of_clk_set_defaults(np, true); |
2481 | if (ret < 0) | |
2482 | of_clk_del_provider(np); | |
2483 | ||
2484 | return ret; | |
766e6a4e GL |
2485 | } |
2486 | EXPORT_SYMBOL_GPL(of_clk_add_provider); | |
2487 | ||
2488 | /** | |
2489 | * of_clk_del_provider() - Remove a previously registered clock provider | |
2490 | * @np: Device node pointer associated with clock provider | |
2491 | */ | |
2492 | void of_clk_del_provider(struct device_node *np) | |
2493 | { | |
2494 | struct of_clk_provider *cp; | |
2495 | ||
d6782c26 | 2496 | mutex_lock(&of_clk_mutex); |
766e6a4e GL |
2497 | list_for_each_entry(cp, &of_clk_providers, link) { |
2498 | if (cp->node == np) { | |
2499 | list_del(&cp->link); | |
2500 | of_node_put(cp->node); | |
2501 | kfree(cp); | |
2502 | break; | |
2503 | } | |
2504 | } | |
d6782c26 | 2505 | mutex_unlock(&of_clk_mutex); |
766e6a4e GL |
2506 | } |
2507 | EXPORT_SYMBOL_GPL(of_clk_del_provider); | |
2508 | ||
d6782c26 | 2509 | struct clk *__of_clk_get_from_provider(struct of_phandle_args *clkspec) |
766e6a4e GL |
2510 | { |
2511 | struct of_clk_provider *provider; | |
a34cd466 | 2512 | struct clk *clk = ERR_PTR(-EPROBE_DEFER); |
766e6a4e GL |
2513 | |
2514 | /* Check if we have such a provider in our array */ | |
766e6a4e GL |
2515 | list_for_each_entry(provider, &of_clk_providers, link) { |
2516 | if (provider->node == clkspec->np) | |
2517 | clk = provider->get(clkspec, provider->data); | |
2518 | if (!IS_ERR(clk)) | |
2519 | break; | |
2520 | } | |
d6782c26 SN |
2521 | |
2522 | return clk; | |
2523 | } | |
2524 | ||
2525 | struct clk *of_clk_get_from_provider(struct of_phandle_args *clkspec) | |
2526 | { | |
2527 | struct clk *clk; | |
2528 | ||
2529 | mutex_lock(&of_clk_mutex); | |
2530 | clk = __of_clk_get_from_provider(clkspec); | |
2531 | mutex_unlock(&of_clk_mutex); | |
766e6a4e GL |
2532 | |
2533 | return clk; | |
2534 | } | |
2535 | ||
f6102742 MT |
2536 | int of_clk_get_parent_count(struct device_node *np) |
2537 | { | |
2538 | return of_count_phandle_with_args(np, "clocks", "#clock-cells"); | |
2539 | } | |
2540 | EXPORT_SYMBOL_GPL(of_clk_get_parent_count); | |
2541 | ||
766e6a4e GL |
2542 | const char *of_clk_get_parent_name(struct device_node *np, int index) |
2543 | { | |
2544 | struct of_phandle_args clkspec; | |
7a0fc1a3 | 2545 | struct property *prop; |
766e6a4e | 2546 | const char *clk_name; |
7a0fc1a3 BD |
2547 | const __be32 *vp; |
2548 | u32 pv; | |
766e6a4e | 2549 | int rc; |
7a0fc1a3 | 2550 | int count; |
766e6a4e GL |
2551 | |
2552 | if (index < 0) | |
2553 | return NULL; | |
2554 | ||
2555 | rc = of_parse_phandle_with_args(np, "clocks", "#clock-cells", index, | |
2556 | &clkspec); | |
2557 | if (rc) | |
2558 | return NULL; | |
2559 | ||
7a0fc1a3 BD |
2560 | index = clkspec.args_count ? clkspec.args[0] : 0; |
2561 | count = 0; | |
2562 | ||
2563 | /* if there is an indices property, use it to transfer the index | |
2564 | * specified into an array offset for the clock-output-names property. | |
2565 | */ | |
2566 | of_property_for_each_u32(clkspec.np, "clock-indices", prop, vp, pv) { | |
2567 | if (index == pv) { | |
2568 | index = count; | |
2569 | break; | |
2570 | } | |
2571 | count++; | |
2572 | } | |
2573 | ||
766e6a4e | 2574 | if (of_property_read_string_index(clkspec.np, "clock-output-names", |
7a0fc1a3 | 2575 | index, |
766e6a4e GL |
2576 | &clk_name) < 0) |
2577 | clk_name = clkspec.np->name; | |
2578 | ||
2579 | of_node_put(clkspec.np); | |
2580 | return clk_name; | |
2581 | } | |
2582 | EXPORT_SYMBOL_GPL(of_clk_get_parent_name); | |
2583 | ||
1771b10d GC |
2584 | struct clock_provider { |
2585 | of_clk_init_cb_t clk_init_cb; | |
2586 | struct device_node *np; | |
2587 | struct list_head node; | |
2588 | }; | |
2589 | ||
2590 | static LIST_HEAD(clk_provider_list); | |
2591 | ||
2592 | /* | |
2593 | * This function looks for a parent clock. If there is one, then it | |
2594 | * checks that the provider for this parent clock was initialized, in | |
2595 | * this case the parent clock will be ready. | |
2596 | */ | |
2597 | static int parent_ready(struct device_node *np) | |
2598 | { | |
2599 | int i = 0; | |
2600 | ||
2601 | while (true) { | |
2602 | struct clk *clk = of_clk_get(np, i); | |
2603 | ||
2604 | /* this parent is ready we can check the next one */ | |
2605 | if (!IS_ERR(clk)) { | |
2606 | clk_put(clk); | |
2607 | i++; | |
2608 | continue; | |
2609 | } | |
2610 | ||
2611 | /* at least one parent is not ready, we exit now */ | |
2612 | if (PTR_ERR(clk) == -EPROBE_DEFER) | |
2613 | return 0; | |
2614 | ||
2615 | /* | |
2616 | * Here we make assumption that the device tree is | |
2617 | * written correctly. So an error means that there is | |
2618 | * no more parent. As we didn't exit yet, then the | |
2619 | * previous parent are ready. If there is no clock | |
2620 | * parent, no need to wait for them, then we can | |
2621 | * consider their absence as being ready | |
2622 | */ | |
2623 | return 1; | |
2624 | } | |
2625 | } | |
2626 | ||
766e6a4e GL |
2627 | /** |
2628 | * of_clk_init() - Scan and init clock providers from the DT | |
2629 | * @matches: array of compatible values and init functions for providers. | |
2630 | * | |
1771b10d | 2631 | * This function scans the device tree for matching clock providers |
e5ca8fb4 | 2632 | * and calls their initialization functions. It also does it by trying |
1771b10d | 2633 | * to follow the dependencies. |
766e6a4e GL |
2634 | */ |
2635 | void __init of_clk_init(const struct of_device_id *matches) | |
2636 | { | |
7f7ed584 | 2637 | const struct of_device_id *match; |
766e6a4e | 2638 | struct device_node *np; |
1771b10d GC |
2639 | struct clock_provider *clk_provider, *next; |
2640 | bool is_init_done; | |
2641 | bool force = false; | |
766e6a4e | 2642 | |
f2f6c255 | 2643 | if (!matches) |
819b4861 | 2644 | matches = &__clk_of_table; |
f2f6c255 | 2645 | |
1771b10d | 2646 | /* First prepare the list of the clocks providers */ |
7f7ed584 | 2647 | for_each_matching_node_and_match(np, matches, &match) { |
1771b10d GC |
2648 | struct clock_provider *parent = |
2649 | kzalloc(sizeof(struct clock_provider), GFP_KERNEL); | |
2650 | ||
2651 | parent->clk_init_cb = match->data; | |
2652 | parent->np = np; | |
3f6d439f | 2653 | list_add_tail(&parent->node, &clk_provider_list); |
1771b10d GC |
2654 | } |
2655 | ||
2656 | while (!list_empty(&clk_provider_list)) { | |
2657 | is_init_done = false; | |
2658 | list_for_each_entry_safe(clk_provider, next, | |
2659 | &clk_provider_list, node) { | |
2660 | if (force || parent_ready(clk_provider->np)) { | |
86be408b | 2661 | |
1771b10d | 2662 | clk_provider->clk_init_cb(clk_provider->np); |
86be408b SN |
2663 | of_clk_set_defaults(clk_provider->np, true); |
2664 | ||
1771b10d GC |
2665 | list_del(&clk_provider->node); |
2666 | kfree(clk_provider); | |
2667 | is_init_done = true; | |
2668 | } | |
2669 | } | |
2670 | ||
2671 | /* | |
e5ca8fb4 | 2672 | * We didn't manage to initialize any of the |
1771b10d GC |
2673 | * remaining providers during the last loop, so now we |
2674 | * initialize all the remaining ones unconditionally | |
2675 | * in case the clock parent was not mandatory | |
2676 | */ | |
2677 | if (!is_init_done) | |
2678 | force = true; | |
766e6a4e GL |
2679 | } |
2680 | } | |
2681 | #endif |