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