clk.c 64.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
/*
 * Copyright (C) 2010-2011 Canonical Ltd <jeremy.kerr@canonical.com>
 * Copyright (C) 2011-2012 Linaro Ltd <mturquette@linaro.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * Standard functionality for the common clock API.  See Documentation/clk.txt
 */

#include <linux/clk-private.h>
13
#include <linux/clk/clk-conf.h>
14 15 16 17 18 19
#include <linux/module.h>
#include <linux/mutex.h>
#include <linux/spinlock.h>
#include <linux/err.h>
#include <linux/list.h>
#include <linux/slab.h>
G
Grant Likely 已提交
20
#include <linux/of.h>
21
#include <linux/device.h>
22
#include <linux/init.h>
23
#include <linux/sched.h>
24

25 26
#include "clk.h"

27 28 29
static DEFINE_SPINLOCK(enable_lock);
static DEFINE_MUTEX(prepare_lock);

30 31 32 33 34 35
static struct task_struct *prepare_owner;
static struct task_struct *enable_owner;

static int prepare_refcnt;
static int enable_refcnt;

36 37 38 39
static HLIST_HEAD(clk_root_list);
static HLIST_HEAD(clk_orphan_list);
static LIST_HEAD(clk_notifier_list);

40 41 42
/***           locking             ***/
static void clk_prepare_lock(void)
{
43 44 45 46 47 48 49 50 51 52 53
	if (!mutex_trylock(&prepare_lock)) {
		if (prepare_owner == current) {
			prepare_refcnt++;
			return;
		}
		mutex_lock(&prepare_lock);
	}
	WARN_ON_ONCE(prepare_owner != NULL);
	WARN_ON_ONCE(prepare_refcnt != 0);
	prepare_owner = current;
	prepare_refcnt = 1;
54 55 56 57
}

static void clk_prepare_unlock(void)
{
58 59 60 61 62 63
	WARN_ON_ONCE(prepare_owner != current);
	WARN_ON_ONCE(prepare_refcnt == 0);

	if (--prepare_refcnt)
		return;
	prepare_owner = NULL;
64 65 66 67 68 69
	mutex_unlock(&prepare_lock);
}

static unsigned long clk_enable_lock(void)
{
	unsigned long flags;
70 71 72 73 74 75 76 77 78 79 80 81

	if (!spin_trylock_irqsave(&enable_lock, flags)) {
		if (enable_owner == current) {
			enable_refcnt++;
			return flags;
		}
		spin_lock_irqsave(&enable_lock, flags);
	}
	WARN_ON_ONCE(enable_owner != NULL);
	WARN_ON_ONCE(enable_refcnt != 0);
	enable_owner = current;
	enable_refcnt = 1;
82 83 84 85 86
	return flags;
}

static void clk_enable_unlock(unsigned long flags)
{
87 88 89 90 91 92
	WARN_ON_ONCE(enable_owner != current);
	WARN_ON_ONCE(enable_refcnt == 0);

	if (--enable_refcnt)
		return;
	enable_owner = NULL;
93 94 95
	spin_unlock_irqrestore(&enable_lock, flags);
}

96 97
/***        debugfs support        ***/

98
#ifdef CONFIG_DEBUG_FS
99 100 101 102
#include <linux/debugfs.h>

static struct dentry *rootdir;
static int inited = 0;
103 104
static DEFINE_MUTEX(clk_debug_lock);
static HLIST_HEAD(clk_debug_list);
105

S
Sachin Kamat 已提交
106 107 108 109 110 111 112 113 114 115 116
static struct hlist_head *all_lists[] = {
	&clk_root_list,
	&clk_orphan_list,
	NULL,
};

static struct hlist_head *orphan_list[] = {
	&clk_orphan_list,
	NULL,
};

117 118 119 120 121
static void clk_summary_show_one(struct seq_file *s, struct clk *c, int level)
{
	if (!c)
		return;

122
	seq_printf(s, "%*s%-*s %11d %12d %11lu %10lu %-3d\n",
123 124
		   level * 3 + 1, "",
		   30 - level * 3, c->name,
125
		   c->enable_count, c->prepare_count, clk_get_rate(c),
126
		   clk_get_accuracy(c), clk_get_phase(c));
127 128 129 130 131 132 133 134 135 136 137 138
}

static void clk_summary_show_subtree(struct seq_file *s, struct clk *c,
				     int level)
{
	struct clk *child;

	if (!c)
		return;

	clk_summary_show_one(s, c, level);

139
	hlist_for_each_entry(child, &c->children, child_node)
140 141 142 143 144 145
		clk_summary_show_subtree(s, child, level + 1);
}

static int clk_summary_show(struct seq_file *s, void *data)
{
	struct clk *c;
146
	struct hlist_head **lists = (struct hlist_head **)s->private;
147

148 149
	seq_puts(s, "   clock                         enable_cnt  prepare_cnt        rate   accuracy   phase\n");
	seq_puts(s, "----------------------------------------------------------------------------------------\n");
150

151
	clk_prepare_lock();
152

153 154 155
	for (; *lists; lists++)
		hlist_for_each_entry(c, *lists, child_node)
			clk_summary_show_subtree(s, c, 0);
156

157
	clk_prepare_unlock();
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174

	return 0;
}


static int clk_summary_open(struct inode *inode, struct file *file)
{
	return single_open(file, clk_summary_show, inode->i_private);
}

static const struct file_operations clk_summary_fops = {
	.open		= clk_summary_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
	.release	= single_release,
};

175 176 177 178 179 180 181 182
static void clk_dump_one(struct seq_file *s, struct clk *c, int level)
{
	if (!c)
		return;

	seq_printf(s, "\"%s\": { ", c->name);
	seq_printf(s, "\"enable_count\": %d,", c->enable_count);
	seq_printf(s, "\"prepare_count\": %d,", c->prepare_count);
183
	seq_printf(s, "\"rate\": %lu", clk_get_rate(c));
184
	seq_printf(s, "\"accuracy\": %lu", clk_get_accuracy(c));
185
	seq_printf(s, "\"phase\": %d", clk_get_phase(c));
186 187 188 189 190 191 192 193 194 195 196
}

static void clk_dump_subtree(struct seq_file *s, struct clk *c, int level)
{
	struct clk *child;

	if (!c)
		return;

	clk_dump_one(s, c, level);

197
	hlist_for_each_entry(child, &c->children, child_node) {
198 199 200 201 202 203 204 205 206 207 208
		seq_printf(s, ",");
		clk_dump_subtree(s, child, level + 1);
	}

	seq_printf(s, "}");
}

static int clk_dump(struct seq_file *s, void *data)
{
	struct clk *c;
	bool first_node = true;
209
	struct hlist_head **lists = (struct hlist_head **)s->private;
210 211 212

	seq_printf(s, "{");

213
	clk_prepare_lock();
214

215 216 217 218 219 220 221
	for (; *lists; lists++) {
		hlist_for_each_entry(c, *lists, child_node) {
			if (!first_node)
				seq_puts(s, ",");
			first_node = false;
			clk_dump_subtree(s, c, 0);
		}
222 223
	}

224
	clk_prepare_unlock();
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242

	seq_printf(s, "}");
	return 0;
}


static int clk_dump_open(struct inode *inode, struct file *file)
{
	return single_open(file, clk_dump, inode->i_private);
}

static const struct file_operations clk_dump_fops = {
	.open		= clk_dump_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
	.release	= single_release,
};

243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
/* caller must hold prepare_lock */
static int clk_debug_create_one(struct clk *clk, struct dentry *pdentry)
{
	struct dentry *d;
	int ret = -ENOMEM;

	if (!clk || !pdentry) {
		ret = -EINVAL;
		goto out;
	}

	d = debugfs_create_dir(clk->name, pdentry);
	if (!d)
		goto out;

	clk->dentry = d;

	d = debugfs_create_u32("clk_rate", S_IRUGO, clk->dentry,
			(u32 *)&clk->rate);
	if (!d)
		goto err_out;

265 266 267 268 269
	d = debugfs_create_u32("clk_accuracy", S_IRUGO, clk->dentry,
			(u32 *)&clk->accuracy);
	if (!d)
		goto err_out;

270 271 272 273 274
	d = debugfs_create_u32("clk_phase", S_IRUGO, clk->dentry,
			(u32 *)&clk->phase);
	if (!d)
		goto err_out;

275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
	d = debugfs_create_x32("clk_flags", S_IRUGO, clk->dentry,
			(u32 *)&clk->flags);
	if (!d)
		goto err_out;

	d = debugfs_create_u32("clk_prepare_count", S_IRUGO, clk->dentry,
			(u32 *)&clk->prepare_count);
	if (!d)
		goto err_out;

	d = debugfs_create_u32("clk_enable_count", S_IRUGO, clk->dentry,
			(u32 *)&clk->enable_count);
	if (!d)
		goto err_out;

	d = debugfs_create_u32("clk_notifier_count", S_IRUGO, clk->dentry,
			(u32 *)&clk->notifier_count);
	if (!d)
		goto err_out;

295 296 297
	if (clk->ops->debug_init) {
		ret = clk->ops->debug_init(clk->hw, clk->dentry);
		if (ret)
298
			goto err_out;
299
	}
300

301 302 303 304
	ret = 0;
	goto out;

err_out:
305 306
	debugfs_remove_recursive(clk->dentry);
	clk->dentry = NULL;
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
out:
	return ret;
}

/**
 * clk_debug_register - add a clk node to the debugfs clk tree
 * @clk: the clk being added to the debugfs clk tree
 *
 * Dynamically adds a clk to the debugfs clk tree if debugfs has been
 * initialized.  Otherwise it bails out early since the debugfs clk tree
 * will be created lazily by clk_debug_init as part of a late_initcall.
 */
static int clk_debug_register(struct clk *clk)
{
	int ret = 0;

323 324 325
	mutex_lock(&clk_debug_lock);
	hlist_add_head(&clk->debug_node, &clk_debug_list);

326
	if (!inited)
327
		goto unlock;
328

329 330 331
	ret = clk_debug_create_one(clk, rootdir);
unlock:
	mutex_unlock(&clk_debug_lock);
332 333 334 335

	return ret;
}

S
Sylwester Nawrocki 已提交
336 337 338 339 340 341 342 343 344 345
 /**
 * clk_debug_unregister - remove a clk node from the debugfs clk tree
 * @clk: the clk being removed from the debugfs clk tree
 *
 * Dynamically removes a clk and all it's children clk nodes from the
 * debugfs clk tree if clk->dentry points to debugfs created by
 * clk_debug_register in __clk_init.
 */
static void clk_debug_unregister(struct clk *clk)
{
346 347 348 349 350
	mutex_lock(&clk_debug_lock);
	if (!clk->dentry)
		goto out;

	hlist_del_init(&clk->debug_node);
S
Sylwester Nawrocki 已提交
351
	debugfs_remove_recursive(clk->dentry);
352 353 354
	clk->dentry = NULL;
out:
	mutex_unlock(&clk_debug_lock);
S
Sylwester Nawrocki 已提交
355 356
}

357 358 359 360 361 362 363 364 365 366 367 368
struct dentry *clk_debugfs_add_file(struct clk *clk, char *name, umode_t mode,
				void *data, const struct file_operations *fops)
{
	struct dentry *d = NULL;

	if (clk->dentry)
		d = debugfs_create_file(name, mode, clk->dentry, data, fops);

	return d;
}
EXPORT_SYMBOL_GPL(clk_debugfs_add_file);

369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
/**
 * clk_debug_init - lazily create the debugfs clk tree visualization
 *
 * clks are often initialized very early during boot before memory can
 * be dynamically allocated and well before debugfs is setup.
 * clk_debug_init walks the clk tree hierarchy while holding
 * prepare_lock and creates the topology as part of a late_initcall,
 * thus insuring that clks initialized very early will still be
 * represented in the debugfs clk tree.  This function should only be
 * called once at boot-time, and all other clks added dynamically will
 * be done so with clk_debug_register.
 */
static int __init clk_debug_init(void)
{
	struct clk *clk;
384
	struct dentry *d;
385 386 387 388 389 390

	rootdir = debugfs_create_dir("clk", NULL);

	if (!rootdir)
		return -ENOMEM;

391
	d = debugfs_create_file("clk_summary", S_IRUGO, rootdir, &all_lists,
392 393 394 395
				&clk_summary_fops);
	if (!d)
		return -ENOMEM;

396
	d = debugfs_create_file("clk_dump", S_IRUGO, rootdir, &all_lists,
397 398 399 400
				&clk_dump_fops);
	if (!d)
		return -ENOMEM;

401 402 403 404
	d = debugfs_create_file("clk_orphan_summary", S_IRUGO, rootdir,
				&orphan_list, &clk_summary_fops);
	if (!d)
		return -ENOMEM;
405

406 407 408
	d = debugfs_create_file("clk_orphan_dump", S_IRUGO, rootdir,
				&orphan_list, &clk_dump_fops);
	if (!d)
409 410
		return -ENOMEM;

411 412 413
	mutex_lock(&clk_debug_lock);
	hlist_for_each_entry(clk, &clk_debug_list, debug_node)
		clk_debug_create_one(clk, rootdir);
414 415

	inited = 1;
416
	mutex_unlock(&clk_debug_lock);
417 418 419 420 421 422

	return 0;
}
late_initcall(clk_debug_init);
#else
static inline int clk_debug_register(struct clk *clk) { return 0; }
423 424 425
static inline void clk_debug_reparent(struct clk *clk, struct clk *new_parent)
{
}
S
Sylwester Nawrocki 已提交
426 427 428
static inline void clk_debug_unregister(struct clk *clk)
{
}
429
#endif
430

431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
/* caller must hold prepare_lock */
static void clk_unprepare_unused_subtree(struct clk *clk)
{
	struct clk *child;

	if (!clk)
		return;

	hlist_for_each_entry(child, &clk->children, child_node)
		clk_unprepare_unused_subtree(child);

	if (clk->prepare_count)
		return;

	if (clk->flags & CLK_IGNORE_UNUSED)
		return;

448 449 450 451
	if (__clk_is_prepared(clk)) {
		if (clk->ops->unprepare_unused)
			clk->ops->unprepare_unused(clk->hw);
		else if (clk->ops->unprepare)
452
			clk->ops->unprepare(clk->hw);
453
	}
454 455
}

456 457 458 459 460 461 462 463 464
/* caller must hold prepare_lock */
static void clk_disable_unused_subtree(struct clk *clk)
{
	struct clk *child;
	unsigned long flags;

	if (!clk)
		goto out;

465
	hlist_for_each_entry(child, &clk->children, child_node)
466 467
		clk_disable_unused_subtree(child);

468
	flags = clk_enable_lock();
469 470 471 472 473 474 475

	if (clk->enable_count)
		goto unlock_out;

	if (clk->flags & CLK_IGNORE_UNUSED)
		goto unlock_out;

476 477 478 479 480 481 482 483 484 485 486
	/*
	 * some gate clocks have special needs during the disable-unused
	 * sequence.  call .disable_unused if available, otherwise fall
	 * back to .disable
	 */
	if (__clk_is_enabled(clk)) {
		if (clk->ops->disable_unused)
			clk->ops->disable_unused(clk->hw);
		else if (clk->ops->disable)
			clk->ops->disable(clk->hw);
	}
487 488

unlock_out:
489
	clk_enable_unlock(flags);
490 491 492 493 494

out:
	return;
}

495 496 497 498 499 500 501 502
static bool clk_ignore_unused;
static int __init clk_ignore_unused_setup(char *__unused)
{
	clk_ignore_unused = true;
	return 1;
}
__setup("clk_ignore_unused", clk_ignore_unused_setup);

503 504 505 506
static int clk_disable_unused(void)
{
	struct clk *clk;

507 508 509 510 511
	if (clk_ignore_unused) {
		pr_warn("clk: Not disabling unused clocks\n");
		return 0;
	}

512
	clk_prepare_lock();
513

514
	hlist_for_each_entry(clk, &clk_root_list, child_node)
515 516
		clk_disable_unused_subtree(clk);

517
	hlist_for_each_entry(clk, &clk_orphan_list, child_node)
518 519
		clk_disable_unused_subtree(clk);

520 521 522 523 524 525
	hlist_for_each_entry(clk, &clk_root_list, child_node)
		clk_unprepare_unused_subtree(clk);

	hlist_for_each_entry(clk, &clk_orphan_list, child_node)
		clk_unprepare_unused_subtree(clk);

526
	clk_prepare_unlock();
527 528 529

	return 0;
}
530
late_initcall_sync(clk_disable_unused);
531 532 533

/***    helper functions   ***/

534
const char *__clk_get_name(struct clk *clk)
535 536 537
{
	return !clk ? NULL : clk->name;
}
538
EXPORT_SYMBOL_GPL(__clk_get_name);
539

540
struct clk_hw *__clk_get_hw(struct clk *clk)
541 542 543
{
	return !clk ? NULL : clk->hw;
}
544
EXPORT_SYMBOL_GPL(__clk_get_hw);
545

546
u8 __clk_get_num_parents(struct clk *clk)
547
{
548
	return !clk ? 0 : clk->num_parents;
549
}
550
EXPORT_SYMBOL_GPL(__clk_get_num_parents);
551

552
struct clk *__clk_get_parent(struct clk *clk)
553 554 555
{
	return !clk ? NULL : clk->parent;
}
556
EXPORT_SYMBOL_GPL(__clk_get_parent);
557

J
James Hogan 已提交
558 559 560 561 562 563 564 565 566 567 568 569
struct clk *clk_get_parent_by_index(struct clk *clk, u8 index)
{
	if (!clk || index >= clk->num_parents)
		return NULL;
	else if (!clk->parents)
		return __clk_lookup(clk->parent_names[index]);
	else if (!clk->parents[index])
		return clk->parents[index] =
			__clk_lookup(clk->parent_names[index]);
	else
		return clk->parents[index];
}
570
EXPORT_SYMBOL_GPL(clk_get_parent_by_index);
J
James Hogan 已提交
571

572
unsigned int __clk_get_enable_count(struct clk *clk)
573
{
574
	return !clk ? 0 : clk->enable_count;
575 576 577 578 579 580 581
}

unsigned long __clk_get_rate(struct clk *clk)
{
	unsigned long ret;

	if (!clk) {
582
		ret = 0;
583 584 585 586 587 588 589 590 591
		goto out;
	}

	ret = clk->rate;

	if (clk->flags & CLK_IS_ROOT)
		goto out;

	if (!clk->parent)
592
		ret = 0;
593 594 595 596

out:
	return ret;
}
597
EXPORT_SYMBOL_GPL(__clk_get_rate);
598

599 600 601 602 603 604 605 606
unsigned long __clk_get_accuracy(struct clk *clk)
{
	if (!clk)
		return 0;

	return clk->accuracy;
}

607
unsigned long __clk_get_flags(struct clk *clk)
608
{
609
	return !clk ? 0 : clk->flags;
610
}
611
EXPORT_SYMBOL_GPL(__clk_get_flags);
612

613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
bool __clk_is_prepared(struct clk *clk)
{
	int ret;

	if (!clk)
		return false;

	/*
	 * .is_prepared is optional for clocks that can prepare
	 * fall back to software usage counter if it is missing
	 */
	if (!clk->ops->is_prepared) {
		ret = clk->prepare_count ? 1 : 0;
		goto out;
	}

	ret = clk->ops->is_prepared(clk->hw);
out:
	return !!ret;
}

634
bool __clk_is_enabled(struct clk *clk)
635 636 637 638
{
	int ret;

	if (!clk)
639
		return false;
640 641 642 643 644 645 646 647 648 649 650 651

	/*
	 * .is_enabled is only mandatory for clocks that gate
	 * fall back to software usage counter if .is_enabled is missing
	 */
	if (!clk->ops->is_enabled) {
		ret = clk->enable_count ? 1 : 0;
		goto out;
	}

	ret = clk->ops->is_enabled(clk->hw);
out:
652
	return !!ret;
653
}
654
EXPORT_SYMBOL_GPL(__clk_is_enabled);
655 656 657 658 659 660 661 662 663

static struct clk *__clk_lookup_subtree(const char *name, struct clk *clk)
{
	struct clk *child;
	struct clk *ret;

	if (!strcmp(clk->name, name))
		return clk;

664
	hlist_for_each_entry(child, &clk->children, child_node) {
665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
		ret = __clk_lookup_subtree(name, child);
		if (ret)
			return ret;
	}

	return NULL;
}

struct clk *__clk_lookup(const char *name)
{
	struct clk *root_clk;
	struct clk *ret;

	if (!name)
		return NULL;

	/* search the 'proper' clk tree first */
682
	hlist_for_each_entry(root_clk, &clk_root_list, child_node) {
683 684 685 686 687 688
		ret = __clk_lookup_subtree(name, root_clk);
		if (ret)
			return ret;
	}

	/* if not found, then search the orphan tree */
689
	hlist_for_each_entry(root_clk, &clk_orphan_list, child_node) {
690 691 692 693 694 695 696 697
		ret = __clk_lookup_subtree(name, root_clk);
		if (ret)
			return ret;
	}

	return NULL;
}

698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745
/*
 * Helper for finding best parent to provide a given frequency. This can be used
 * directly as a determine_rate callback (e.g. for a mux), or from a more
 * complex clock that may combine a mux with other operations.
 */
long __clk_mux_determine_rate(struct clk_hw *hw, unsigned long rate,
			      unsigned long *best_parent_rate,
			      struct clk **best_parent_p)
{
	struct clk *clk = hw->clk, *parent, *best_parent = NULL;
	int i, num_parents;
	unsigned long parent_rate, best = 0;

	/* if NO_REPARENT flag set, pass through to current parent */
	if (clk->flags & CLK_SET_RATE_NO_REPARENT) {
		parent = clk->parent;
		if (clk->flags & CLK_SET_RATE_PARENT)
			best = __clk_round_rate(parent, rate);
		else if (parent)
			best = __clk_get_rate(parent);
		else
			best = __clk_get_rate(clk);
		goto out;
	}

	/* find the parent that can provide the fastest rate <= rate */
	num_parents = clk->num_parents;
	for (i = 0; i < num_parents; i++) {
		parent = clk_get_parent_by_index(clk, i);
		if (!parent)
			continue;
		if (clk->flags & CLK_SET_RATE_PARENT)
			parent_rate = __clk_round_rate(parent, rate);
		else
			parent_rate = __clk_get_rate(parent);
		if (parent_rate <= rate && parent_rate > best) {
			best_parent = parent;
			best = parent_rate;
		}
	}

out:
	if (best_parent)
		*best_parent_p = best_parent;
	*best_parent_rate = best;

	return best;
}
746
EXPORT_SYMBOL_GPL(__clk_mux_determine_rate);
747

748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
/***        clk api        ***/

void __clk_unprepare(struct clk *clk)
{
	if (!clk)
		return;

	if (WARN_ON(clk->prepare_count == 0))
		return;

	if (--clk->prepare_count > 0)
		return;

	WARN_ON(clk->enable_count > 0);

	if (clk->ops->unprepare)
		clk->ops->unprepare(clk->hw);

	__clk_unprepare(clk->parent);
}

/**
 * clk_unprepare - undo preparation of a clock source
P
Peter Meerwald 已提交
771
 * @clk: the clk being unprepared
772 773 774 775 776 777 778 779 780 781
 *
 * clk_unprepare may sleep, which differentiates it from clk_disable.  In a
 * simple case, clk_unprepare can be used instead of clk_disable to gate a clk
 * if the operation may sleep.  One example is a clk which is accessed over
 * I2c.  In the complex case a clk gate operation may require a fast and a slow
 * part.  It is this reason that clk_unprepare and clk_disable are not mutually
 * exclusive.  In fact clk_disable must be called before clk_unprepare.
 */
void clk_unprepare(struct clk *clk)
{
782 783 784
	if (IS_ERR_OR_NULL(clk))
		return;

785
	clk_prepare_lock();
786
	__clk_unprepare(clk);
787
	clk_prepare_unlock();
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832
}
EXPORT_SYMBOL_GPL(clk_unprepare);

int __clk_prepare(struct clk *clk)
{
	int ret = 0;

	if (!clk)
		return 0;

	if (clk->prepare_count == 0) {
		ret = __clk_prepare(clk->parent);
		if (ret)
			return ret;

		if (clk->ops->prepare) {
			ret = clk->ops->prepare(clk->hw);
			if (ret) {
				__clk_unprepare(clk->parent);
				return ret;
			}
		}
	}

	clk->prepare_count++;

	return 0;
}

/**
 * clk_prepare - prepare a clock source
 * @clk: the clk being prepared
 *
 * clk_prepare may sleep, which differentiates it from clk_enable.  In a simple
 * case, clk_prepare can be used instead of clk_enable to ungate a clk if the
 * operation may sleep.  One example is a clk which is accessed over I2c.  In
 * the complex case a clk ungate operation may require a fast and a slow part.
 * It is this reason that clk_prepare and clk_enable are not mutually
 * exclusive.  In fact clk_prepare must be called before clk_enable.
 * Returns 0 on success, -EERROR otherwise.
 */
int clk_prepare(struct clk *clk)
{
	int ret;

833
	clk_prepare_lock();
834
	ret = __clk_prepare(clk);
835
	clk_prepare_unlock();
836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873

	return ret;
}
EXPORT_SYMBOL_GPL(clk_prepare);

static void __clk_disable(struct clk *clk)
{
	if (!clk)
		return;

	if (WARN_ON(clk->enable_count == 0))
		return;

	if (--clk->enable_count > 0)
		return;

	if (clk->ops->disable)
		clk->ops->disable(clk->hw);

	__clk_disable(clk->parent);
}

/**
 * clk_disable - gate a clock
 * @clk: the clk being gated
 *
 * clk_disable must not sleep, which differentiates it from clk_unprepare.  In
 * a simple case, clk_disable can be used instead of clk_unprepare to gate a
 * clk if the operation is fast and will never sleep.  One example is a
 * SoC-internal clk which is controlled via simple register writes.  In the
 * complex case a clk gate operation may require a fast and a slow part.  It is
 * this reason that clk_unprepare and clk_disable are not mutually exclusive.
 * In fact clk_disable must be called before clk_unprepare.
 */
void clk_disable(struct clk *clk)
{
	unsigned long flags;

874 875 876
	if (IS_ERR_OR_NULL(clk))
		return;

877
	flags = clk_enable_lock();
878
	__clk_disable(clk);
879
	clk_enable_unlock(flags);
880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929
}
EXPORT_SYMBOL_GPL(clk_disable);

static int __clk_enable(struct clk *clk)
{
	int ret = 0;

	if (!clk)
		return 0;

	if (WARN_ON(clk->prepare_count == 0))
		return -ESHUTDOWN;

	if (clk->enable_count == 0) {
		ret = __clk_enable(clk->parent);

		if (ret)
			return ret;

		if (clk->ops->enable) {
			ret = clk->ops->enable(clk->hw);
			if (ret) {
				__clk_disable(clk->parent);
				return ret;
			}
		}
	}

	clk->enable_count++;
	return 0;
}

/**
 * clk_enable - ungate a clock
 * @clk: the clk being ungated
 *
 * clk_enable must not sleep, which differentiates it from clk_prepare.  In a
 * simple case, clk_enable can be used instead of clk_prepare to ungate a clk
 * if the operation will never sleep.  One example is a SoC-internal clk which
 * is controlled via simple register writes.  In the complex case a clk ungate
 * operation may require a fast and a slow part.  It is this reason that
 * clk_enable and clk_prepare are not mutually exclusive.  In fact clk_prepare
 * must be called before clk_enable.  Returns 0 on success, -EERROR
 * otherwise.
 */
int clk_enable(struct clk *clk)
{
	unsigned long flags;
	int ret;

930
	flags = clk_enable_lock();
931
	ret = __clk_enable(clk);
932
	clk_enable_unlock(flags);
933 934 935 936 937 938 939 940

	return ret;
}
EXPORT_SYMBOL_GPL(clk_enable);

/**
 * __clk_round_rate - round the given rate for a clk
 * @clk: round the rate of this clock
P
Peter Meerwald 已提交
941
 * @rate: the rate which is to be rounded
942 943 944 945 946
 *
 * Caller must hold prepare_lock.  Useful for clk_ops such as .set_rate
 */
unsigned long __clk_round_rate(struct clk *clk, unsigned long rate)
{
947
	unsigned long parent_rate = 0;
948
	struct clk *parent;
949 950

	if (!clk)
951
		return 0;
952

953 954 955 956 957 958 959 960 961 962 963 964 965
	parent = clk->parent;
	if (parent)
		parent_rate = parent->rate;

	if (clk->ops->determine_rate)
		return clk->ops->determine_rate(clk->hw, rate, &parent_rate,
						&parent);
	else if (clk->ops->round_rate)
		return clk->ops->round_rate(clk->hw, rate, &parent_rate);
	else if (clk->flags & CLK_SET_RATE_PARENT)
		return __clk_round_rate(clk->parent, rate);
	else
		return clk->rate;
966
}
967
EXPORT_SYMBOL_GPL(__clk_round_rate);
968 969 970 971 972 973 974 975 976 977 978 979 980 981

/**
 * clk_round_rate - round the given rate for a clk
 * @clk: the clk for which we are rounding a rate
 * @rate: the rate which is to be rounded
 *
 * Takes in a rate as input and rounds it to a rate that the clk can actually
 * use which is then returned.  If clk doesn't support round_rate operation
 * then the parent rate is returned.
 */
long clk_round_rate(struct clk *clk, unsigned long rate)
{
	unsigned long ret;

982
	clk_prepare_lock();
983
	ret = __clk_round_rate(clk, rate);
984
	clk_prepare_unlock();
985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025

	return ret;
}
EXPORT_SYMBOL_GPL(clk_round_rate);

/**
 * __clk_notify - call clk notifier chain
 * @clk: struct clk * that is changing rate
 * @msg: clk notifier type (see include/linux/clk.h)
 * @old_rate: old clk rate
 * @new_rate: new clk rate
 *
 * Triggers a notifier call chain on the clk rate-change notification
 * for 'clk'.  Passes a pointer to the struct clk and the previous
 * and current rates to the notifier callback.  Intended to be called by
 * internal clock code only.  Returns NOTIFY_DONE from the last driver
 * called if all went well, or NOTIFY_STOP or NOTIFY_BAD immediately if
 * a driver returns that.
 */
static int __clk_notify(struct clk *clk, unsigned long msg,
		unsigned long old_rate, unsigned long new_rate)
{
	struct clk_notifier *cn;
	struct clk_notifier_data cnd;
	int ret = NOTIFY_DONE;

	cnd.clk = clk;
	cnd.old_rate = old_rate;
	cnd.new_rate = new_rate;

	list_for_each_entry(cn, &clk_notifier_list, node) {
		if (cn->clk == clk) {
			ret = srcu_notifier_call_chain(&cn->notifier_head, msg,
					&cnd);
			break;
		}
	}

	return ret;
}

1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
/**
 * __clk_recalc_accuracies
 * @clk: first clk in the subtree
 *
 * Walks the subtree of clks starting with clk and recalculates accuracies as
 * it goes.  Note that if a clk does not implement the .recalc_accuracy
 * callback then it is assumed that the clock will take on the accuracy of it's
 * parent.
 *
 * Caller must hold prepare_lock.
 */
static void __clk_recalc_accuracies(struct clk *clk)
{
	unsigned long parent_accuracy = 0;
	struct clk *child;

	if (clk->parent)
		parent_accuracy = clk->parent->accuracy;

	if (clk->ops->recalc_accuracy)
		clk->accuracy = clk->ops->recalc_accuracy(clk->hw,
							  parent_accuracy);
	else
		clk->accuracy = parent_accuracy;

	hlist_for_each_entry(child, &clk->children, child_node)
		__clk_recalc_accuracies(child);
}

/**
 * clk_get_accuracy - return the accuracy of clk
 * @clk: the clk whose accuracy is being returned
 *
 * Simply returns the cached accuracy of the clk, unless
 * CLK_GET_ACCURACY_NOCACHE flag is set, which means a recalc_rate will be
 * issued.
 * If clk is NULL then returns 0.
 */
long clk_get_accuracy(struct clk *clk)
{
	unsigned long accuracy;

	clk_prepare_lock();
	if (clk && (clk->flags & CLK_GET_ACCURACY_NOCACHE))
		__clk_recalc_accuracies(clk);

	accuracy = __clk_get_accuracy(clk);
	clk_prepare_unlock();

	return accuracy;
}
EXPORT_SYMBOL_GPL(clk_get_accuracy);

1079 1080 1081 1082 1083 1084 1085
static unsigned long clk_recalc(struct clk *clk, unsigned long parent_rate)
{
	if (clk->ops->recalc_rate)
		return clk->ops->recalc_rate(clk->hw, parent_rate);
	return parent_rate;
}

1086 1087 1088 1089 1090 1091 1092
/**
 * __clk_recalc_rates
 * @clk: first clk in the subtree
 * @msg: notification type (see include/linux/clk.h)
 *
 * Walks the subtree of clks starting with clk and recalculates rates as it
 * goes.  Note that if a clk does not implement the .recalc_rate callback then
P
Peter Meerwald 已提交
1093
 * it is assumed that the clock will take on the rate of its parent.
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
 *
 * clk_recalc_rates also propagates the POST_RATE_CHANGE notification,
 * if necessary.
 *
 * Caller must hold prepare_lock.
 */
static void __clk_recalc_rates(struct clk *clk, unsigned long msg)
{
	unsigned long old_rate;
	unsigned long parent_rate = 0;
	struct clk *child;

	old_rate = clk->rate;

	if (clk->parent)
		parent_rate = clk->parent->rate;

1111
	clk->rate = clk_recalc(clk, parent_rate);
1112 1113 1114 1115 1116 1117 1118 1119

	/*
	 * ignore NOTIFY_STOP and NOTIFY_BAD return values for POST_RATE_CHANGE
	 * & ABORT_RATE_CHANGE notifiers
	 */
	if (clk->notifier_count && msg)
		__clk_notify(clk, msg, old_rate, clk->rate);

1120
	hlist_for_each_entry(child, &clk->children, child_node)
1121 1122 1123
		__clk_recalc_rates(child, msg);
}

1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135
/**
 * clk_get_rate - return the rate of clk
 * @clk: the clk whose rate is being returned
 *
 * Simply returns the cached rate of the clk, unless CLK_GET_RATE_NOCACHE flag
 * is set, which means a recalc_rate will be issued.
 * If clk is NULL then returns 0.
 */
unsigned long clk_get_rate(struct clk *clk)
{
	unsigned long rate;

1136
	clk_prepare_lock();
1137 1138 1139 1140 1141

	if (clk && (clk->flags & CLK_GET_RATE_NOCACHE))
		__clk_recalc_rates(clk, 0);

	rate = __clk_get_rate(clk);
1142
	clk_prepare_unlock();
1143 1144 1145 1146 1147

	return rate;
}
EXPORT_SYMBOL_GPL(clk_get_rate);

1148
static int clk_fetch_parent_index(struct clk *clk, struct clk *parent)
1149
{
1150
	int i;
1151

1152
	if (!clk->parents) {
1153 1154
		clk->parents = kcalloc(clk->num_parents,
					sizeof(struct clk *), GFP_KERNEL);
1155 1156 1157
		if (!clk->parents)
			return -ENOMEM;
	}
1158 1159 1160 1161 1162 1163 1164

	/*
	 * find index of new parent clock using cached parent ptrs,
	 * or if not yet cached, use string name comparison and cache
	 * them now to avoid future calls to __clk_lookup.
	 */
	for (i = 0; i < clk->num_parents; i++) {
1165
		if (clk->parents[i] == parent)
1166
			return i;
1167 1168 1169 1170 1171 1172

		if (clk->parents[i])
			continue;

		if (!strcmp(clk->parent_names[i], parent->name)) {
			clk->parents[i] = __clk_lookup(parent->name);
1173
			return i;
1174 1175 1176
		}
	}

1177
	return -EINVAL;
1178 1179 1180 1181 1182 1183
}

static void clk_reparent(struct clk *clk, struct clk *new_parent)
{
	hlist_del(&clk->child_node);

1184 1185 1186 1187 1188
	if (new_parent) {
		/* avoid duplicate POST_RATE_CHANGE notifications */
		if (new_parent->new_child == clk)
			new_parent->new_child = NULL;

1189
		hlist_add_head(&clk->child_node, &new_parent->children);
1190
	} else {
1191
		hlist_add_head(&clk->child_node, &clk_orphan_list);
1192
	}
1193 1194 1195 1196

	clk->parent = new_parent;
}

S
Stephen Boyd 已提交
1197
static struct clk *__clk_set_parent_before(struct clk *clk, struct clk *parent)
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229
{
	unsigned long flags;
	struct clk *old_parent = clk->parent;

	/*
	 * Migrate prepare state between parents and prevent race with
	 * clk_enable().
	 *
	 * If the clock is not prepared, then a race with
	 * clk_enable/disable() is impossible since we already have the
	 * prepare lock (future calls to clk_enable() need to be preceded by
	 * a clk_prepare()).
	 *
	 * If the clock is prepared, migrate the prepared state to the new
	 * parent and also protect against a race with clk_enable() by
	 * forcing the clock and the new parent on.  This ensures that all
	 * future calls to clk_enable() are practically NOPs with respect to
	 * hardware and software states.
	 *
	 * See also: Comment for clk_set_parent() below.
	 */
	if (clk->prepare_count) {
		__clk_prepare(parent);
		clk_enable(parent);
		clk_enable(clk);
	}

	/* update the clk tree topology */
	flags = clk_enable_lock();
	clk_reparent(clk, parent);
	clk_enable_unlock(flags);

S
Stephen Boyd 已提交
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
	return old_parent;
}

static void __clk_set_parent_after(struct clk *clk, struct clk *parent,
		struct clk *old_parent)
{
	/*
	 * Finish the migration of prepare state and undo the changes done
	 * for preventing a race with clk_enable().
	 */
	if (clk->prepare_count) {
		clk_disable(clk);
		clk_disable(old_parent);
		__clk_unprepare(old_parent);
	}
}

static int __clk_set_parent(struct clk *clk, struct clk *parent, u8 p_index)
{
	unsigned long flags;
	int ret = 0;
	struct clk *old_parent;

	old_parent = __clk_set_parent_before(clk, parent);

1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271
	/* change clock input source */
	if (parent && clk->ops->set_parent)
		ret = clk->ops->set_parent(clk->hw, p_index);

	if (ret) {
		flags = clk_enable_lock();
		clk_reparent(clk, old_parent);
		clk_enable_unlock(flags);

		if (clk->prepare_count) {
			clk_disable(clk);
			clk_disable(parent);
			__clk_unprepare(parent);
		}
		return ret;
	}

S
Stephen Boyd 已提交
1272
	__clk_set_parent_after(clk, parent, old_parent);
1273 1274 1275 1276

	return 0;
}

1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288
/**
 * __clk_speculate_rates
 * @clk: first clk in the subtree
 * @parent_rate: the "future" rate of clk's parent
 *
 * Walks the subtree of clks starting with clk, speculating rates as it
 * goes and firing off PRE_RATE_CHANGE notifications as necessary.
 *
 * Unlike clk_recalc_rates, clk_speculate_rates exists only for sending
 * pre-rate change notifications and returns early if no clks in the
 * subtree have subscribed to the notifications.  Note that if a clk does not
 * implement the .recalc_rate callback then it is assumed that the clock will
P
Peter Meerwald 已提交
1289
 * take on the rate of its parent.
1290 1291 1292 1293 1294 1295 1296 1297 1298
 *
 * Caller must hold prepare_lock.
 */
static int __clk_speculate_rates(struct clk *clk, unsigned long parent_rate)
{
	struct clk *child;
	unsigned long new_rate;
	int ret = NOTIFY_DONE;

1299
	new_rate = clk_recalc(clk, parent_rate);
1300

1301
	/* abort rate change if a driver returns NOTIFY_BAD or NOTIFY_STOP */
1302 1303 1304
	if (clk->notifier_count)
		ret = __clk_notify(clk, PRE_RATE_CHANGE, clk->rate, new_rate);

1305 1306 1307
	if (ret & NOTIFY_STOP_MASK) {
		pr_debug("%s: clk notifier callback for clock %s aborted with error %d\n",
				__func__, clk->name, ret);
1308
		goto out;
1309
	}
1310

1311
	hlist_for_each_entry(child, &clk->children, child_node) {
1312
		ret = __clk_speculate_rates(child, new_rate);
1313
		if (ret & NOTIFY_STOP_MASK)
1314 1315 1316 1317 1318 1319 1320
			break;
	}

out:
	return ret;
}

1321 1322
static void clk_calc_subtree(struct clk *clk, unsigned long new_rate,
			     struct clk *new_parent, u8 p_index)
1323 1324 1325 1326
{
	struct clk *child;

	clk->new_rate = new_rate;
1327 1328 1329 1330 1331 1332
	clk->new_parent = new_parent;
	clk->new_parent_index = p_index;
	/* include clk in new parent's PRE_RATE_CHANGE notifications */
	clk->new_child = NULL;
	if (new_parent && new_parent != clk->parent)
		new_parent->new_child = clk;
1333

1334
	hlist_for_each_entry(child, &clk->children, child_node) {
1335
		child->new_rate = clk_recalc(child, new_rate);
1336
		clk_calc_subtree(child, child->new_rate, NULL, 0);
1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
	}
}

/*
 * calculate the new rates returning the topmost clock that has to be
 * changed.
 */
static struct clk *clk_calc_new_rates(struct clk *clk, unsigned long rate)
{
	struct clk *top = clk;
1347
	struct clk *old_parent, *parent;
1348
	unsigned long best_parent_rate = 0;
1349
	unsigned long new_rate;
1350
	int p_index = 0;
1351

1352 1353 1354 1355
	/* sanity */
	if (IS_ERR_OR_NULL(clk))
		return NULL;

1356
	/* save parent rate, if it exists */
1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376
	parent = old_parent = clk->parent;
	if (parent)
		best_parent_rate = parent->rate;

	/* find the closest rate and parent clk/rate */
	if (clk->ops->determine_rate) {
		new_rate = clk->ops->determine_rate(clk->hw, rate,
						    &best_parent_rate,
						    &parent);
	} else if (clk->ops->round_rate) {
		new_rate = clk->ops->round_rate(clk->hw, rate,
						&best_parent_rate);
	} else if (!parent || !(clk->flags & CLK_SET_RATE_PARENT)) {
		/* pass-through clock without adjustable parent */
		clk->new_rate = clk->rate;
		return NULL;
	} else {
		/* pass-through clock with adjustable parent */
		top = clk_calc_new_rates(parent, rate);
		new_rate = parent->new_rate;
1377
		goto out;
1378 1379
	}

1380 1381 1382 1383 1384
	/* some clocks must be gated to change parent */
	if (parent != old_parent &&
	    (clk->flags & CLK_SET_PARENT_GATE) && clk->prepare_count) {
		pr_debug("%s: %s not gated but wants to reparent\n",
			 __func__, clk->name);
1385 1386 1387
		return NULL;
	}

1388 1389 1390
	/* try finding the new parent index */
	if (parent) {
		p_index = clk_fetch_parent_index(clk, parent);
1391
		if (p_index < 0) {
1392 1393 1394 1395
			pr_debug("%s: clk %s can not be parent of clk %s\n",
				 __func__, parent->name, clk->name);
			return NULL;
		}
1396 1397
	}

1398 1399 1400
	if ((clk->flags & CLK_SET_RATE_PARENT) && parent &&
	    best_parent_rate != parent->rate)
		top = clk_calc_new_rates(parent, best_parent_rate);
1401 1402

out:
1403
	clk_calc_subtree(clk, new_rate, parent, p_index);
1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414

	return top;
}

/*
 * Notify about rate changes in a subtree. Always walk down the whole tree
 * so that in case of an error we can walk down the whole tree again and
 * abort the change.
 */
static struct clk *clk_propagate_rate_change(struct clk *clk, unsigned long event)
{
1415
	struct clk *child, *tmp_clk, *fail_clk = NULL;
1416 1417 1418
	int ret = NOTIFY_DONE;

	if (clk->rate == clk->new_rate)
1419
		return NULL;
1420 1421 1422

	if (clk->notifier_count) {
		ret = __clk_notify(clk, event, clk->rate, clk->new_rate);
1423
		if (ret & NOTIFY_STOP_MASK)
1424 1425 1426
			fail_clk = clk;
	}

1427
	hlist_for_each_entry(child, &clk->children, child_node) {
1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440
		/* Skip children who will be reparented to another clock */
		if (child->new_parent && child->new_parent != clk)
			continue;
		tmp_clk = clk_propagate_rate_change(child, event);
		if (tmp_clk)
			fail_clk = tmp_clk;
	}

	/* handle the new child who might not be in clk->children yet */
	if (clk->new_child) {
		tmp_clk = clk_propagate_rate_change(clk->new_child, event);
		if (tmp_clk)
			fail_clk = tmp_clk;
1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452
	}

	return fail_clk;
}

/*
 * walk down a subtree and set the new rates notifying the rate
 * change on the way
 */
static void clk_change_rate(struct clk *clk)
{
	struct clk *child;
1453
	struct hlist_node *tmp;
1454
	unsigned long old_rate;
1455
	unsigned long best_parent_rate = 0;
S
Stephen Boyd 已提交
1456 1457
	bool skip_set_rate = false;
	struct clk *old_parent;
1458 1459 1460

	old_rate = clk->rate;

S
Stephen Boyd 已提交
1461 1462 1463
	if (clk->new_parent)
		best_parent_rate = clk->new_parent->rate;
	else if (clk->parent)
1464 1465
		best_parent_rate = clk->parent->rate;

S
Stephen Boyd 已提交
1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481
	if (clk->new_parent && clk->new_parent != clk->parent) {
		old_parent = __clk_set_parent_before(clk, clk->new_parent);

		if (clk->ops->set_rate_and_parent) {
			skip_set_rate = true;
			clk->ops->set_rate_and_parent(clk->hw, clk->new_rate,
					best_parent_rate,
					clk->new_parent_index);
		} else if (clk->ops->set_parent) {
			clk->ops->set_parent(clk->hw, clk->new_parent_index);
		}

		__clk_set_parent_after(clk, clk->new_parent, old_parent);
	}

	if (!skip_set_rate && clk->ops->set_rate)
1482
		clk->ops->set_rate(clk->hw, clk->new_rate, best_parent_rate);
1483

1484
	clk->rate = clk_recalc(clk, best_parent_rate);
1485 1486 1487 1488

	if (clk->notifier_count && old_rate != clk->rate)
		__clk_notify(clk, POST_RATE_CHANGE, old_rate, clk->rate);

1489 1490 1491 1492 1493
	/*
	 * Use safe iteration, as change_rate can actually swap parents
	 * for certain clock types.
	 */
	hlist_for_each_entry_safe(child, tmp, &clk->children, child_node) {
1494 1495 1496
		/* Skip children who will be reparented to another clock */
		if (child->new_parent && child->new_parent != clk)
			continue;
1497
		clk_change_rate(child);
1498 1499 1500 1501 1502
	}

	/* handle the new child who might not be in clk->children yet */
	if (clk->new_child)
		clk_change_rate(clk->new_child);
1503 1504 1505 1506 1507 1508 1509
}

/**
 * clk_set_rate - specify a new rate for clk
 * @clk: the clk whose rate is being changed
 * @rate: the new rate for clk
 *
1510
 * In the simplest case clk_set_rate will only adjust the rate of clk.
1511
 *
1512 1513 1514 1515 1516
 * Setting the CLK_SET_RATE_PARENT flag allows the rate change operation to
 * propagate up to clk's parent; whether or not this happens depends on the
 * outcome of clk's .round_rate implementation.  If *parent_rate is unchanged
 * after calling .round_rate then upstream parent propagation is ignored.  If
 * *parent_rate comes back with a new rate for clk's parent then we propagate
P
Peter Meerwald 已提交
1517
 * up to clk's parent and set its rate.  Upward propagation will continue
1518 1519
 * until either a clk does not support the CLK_SET_RATE_PARENT flag or
 * .round_rate stops requesting changes to clk's parent_rate.
1520
 *
1521 1522
 * Rate changes are accomplished via tree traversal that also recalculates the
 * rates for the clocks and fires off POST_RATE_CHANGE notifiers.
1523 1524 1525 1526 1527 1528 1529 1530
 *
 * Returns 0 on success, -EERROR otherwise.
 */
int clk_set_rate(struct clk *clk, unsigned long rate)
{
	struct clk *top, *fail_clk;
	int ret = 0;

1531 1532 1533
	if (!clk)
		return 0;

1534
	/* prevent racing with updates to the clock topology */
1535
	clk_prepare_lock();
1536 1537

	/* bail early if nothing to do */
1538
	if (rate == clk_get_rate(clk))
1539 1540
		goto out;

1541
	if ((clk->flags & CLK_SET_RATE_GATE) && clk->prepare_count) {
1542 1543 1544 1545
		ret = -EBUSY;
		goto out;
	}

1546 1547 1548 1549 1550 1551 1552 1553 1554 1555
	/* calculate new rates and get the topmost changed clock */
	top = clk_calc_new_rates(clk, rate);
	if (!top) {
		ret = -EINVAL;
		goto out;
	}

	/* notify that we are about to change rates */
	fail_clk = clk_propagate_rate_change(top, PRE_RATE_CHANGE);
	if (fail_clk) {
1556
		pr_debug("%s: failed to set %s rate\n", __func__,
1557 1558 1559 1560 1561 1562 1563 1564 1565 1566
				fail_clk->name);
		clk_propagate_rate_change(top, ABORT_RATE_CHANGE);
		ret = -EBUSY;
		goto out;
	}

	/* change the rates */
	clk_change_rate(top);

out:
1567
	clk_prepare_unlock();
1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582

	return ret;
}
EXPORT_SYMBOL_GPL(clk_set_rate);

/**
 * clk_get_parent - return the parent of a clk
 * @clk: the clk whose parent gets returned
 *
 * Simply returns clk->parent.  Returns NULL if clk is NULL.
 */
struct clk *clk_get_parent(struct clk *clk)
{
	struct clk *parent;

1583
	clk_prepare_lock();
1584
	parent = __clk_get_parent(clk);
1585
	clk_prepare_unlock();
1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611

	return parent;
}
EXPORT_SYMBOL_GPL(clk_get_parent);

/*
 * .get_parent is mandatory for clocks with multiple possible parents.  It is
 * optional for single-parent clocks.  Always call .get_parent if it is
 * available and WARN if it is missing for multi-parent clocks.
 *
 * For single-parent clocks without .get_parent, first check to see if the
 * .parents array exists, and if so use it to avoid an expensive tree
 * traversal.  If .parents does not exist then walk the tree with __clk_lookup.
 */
static struct clk *__clk_init_parent(struct clk *clk)
{
	struct clk *ret = NULL;
	u8 index;

	/* handle the trivial cases */

	if (!clk->num_parents)
		goto out;

	if (clk->num_parents == 1) {
		if (IS_ERR_OR_NULL(clk->parent))
1612
			clk->parent = __clk_lookup(clk->parent_names[0]);
1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633
		ret = clk->parent;
		goto out;
	}

	if (!clk->ops->get_parent) {
		WARN(!clk->ops->get_parent,
			"%s: multi-parent clocks must implement .get_parent\n",
			__func__);
		goto out;
	};

	/*
	 * Do our best to cache parent clocks in clk->parents.  This prevents
	 * unnecessary and expensive calls to __clk_lookup.  We don't set
	 * clk->parent here; that is done by the calling function
	 */

	index = clk->ops->get_parent(clk->hw);

	if (!clk->parents)
		clk->parents =
1634
			kcalloc(clk->num_parents, sizeof(struct clk *),
1635 1636
					GFP_KERNEL);

J
James Hogan 已提交
1637
	ret = clk_get_parent_by_index(clk, index);
1638 1639 1640 1641 1642

out:
	return ret;
}

1643 1644 1645
void __clk_reparent(struct clk *clk, struct clk *new_parent)
{
	clk_reparent(clk, new_parent);
1646
	__clk_recalc_accuracies(clk);
1647 1648 1649 1650 1651 1652 1653 1654
	__clk_recalc_rates(clk, POST_RATE_CHANGE);
}

/**
 * clk_set_parent - switch the parent of a mux clk
 * @clk: the mux clk whose input we are switching
 * @parent: the new input to clk
 *
1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665
 * Re-parent clk to use parent as its new input source.  If clk is in
 * prepared state, the clk will get enabled for the duration of this call. If
 * that's not acceptable for a specific clk (Eg: the consumer can't handle
 * that, the reparenting is glitchy in hardware, etc), use the
 * CLK_SET_PARENT_GATE flag to allow reparenting only when clk is unprepared.
 *
 * After successfully changing clk's parent clk_set_parent will update the
 * clk topology, sysfs topology and propagate rate recalculation via
 * __clk_recalc_rates.
 *
 * Returns 0 on success, -EERROR otherwise.
1666 1667 1668 1669
 */
int clk_set_parent(struct clk *clk, struct clk *parent)
{
	int ret = 0;
1670
	int p_index = 0;
1671
	unsigned long p_rate = 0;
1672

1673 1674 1675
	if (!clk)
		return 0;

1676 1677
	/* verify ops for for multi-parent clks */
	if ((clk->num_parents > 1) && (!clk->ops->set_parent))
1678 1679 1680
		return -ENOSYS;

	/* prevent racing with updates to the clock topology */
1681
	clk_prepare_lock();
1682 1683 1684 1685

	if (clk->parent == parent)
		goto out;

1686 1687 1688 1689 1690 1691 1692 1693 1694 1695
	/* check that we are allowed to re-parent if the clock is in use */
	if ((clk->flags & CLK_SET_PARENT_GATE) && clk->prepare_count) {
		ret = -EBUSY;
		goto out;
	}

	/* try finding the new parent index */
	if (parent) {
		p_index = clk_fetch_parent_index(clk, parent);
		p_rate = parent->rate;
1696
		if (p_index < 0) {
1697 1698
			pr_debug("%s: clk %s can not be parent of clk %s\n",
					__func__, parent->name, clk->name);
1699
			ret = p_index;
1700 1701 1702 1703
			goto out;
		}
	}

1704
	/* propagate PRE_RATE_CHANGE notifications */
1705
	ret = __clk_speculate_rates(clk, p_rate);
1706 1707

	/* abort if a driver objects */
1708
	if (ret & NOTIFY_STOP_MASK)
1709 1710
		goto out;

1711 1712
	/* do the re-parent */
	ret = __clk_set_parent(clk, parent, p_index);
1713

1714 1715
	/* propagate rate an accuracy recalculation accordingly */
	if (ret) {
1716
		__clk_recalc_rates(clk, ABORT_RATE_CHANGE);
1717
	} else {
1718
		__clk_recalc_rates(clk, POST_RATE_CHANGE);
1719 1720
		__clk_recalc_accuracies(clk);
	}
1721 1722

out:
1723
	clk_prepare_unlock();
1724 1725 1726 1727 1728

	return ret;
}
EXPORT_SYMBOL_GPL(clk_set_parent);

1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799
/**
 * clk_set_phase - adjust the phase shift of a clock signal
 * @clk: clock signal source
 * @degrees: number of degrees the signal is shifted
 *
 * Shifts the phase of a clock signal by the specified
 * degrees. Returns 0 on success, -EERROR otherwise.
 *
 * This function makes no distinction about the input or reference
 * signal that we adjust the clock signal phase against. For example
 * phase locked-loop clock signal generators we may shift phase with
 * respect to feedback clock signal input, but for other cases the
 * clock phase may be shifted with respect to some other, unspecified
 * signal.
 *
 * Additionally the concept of phase shift does not propagate through
 * the clock tree hierarchy, which sets it apart from clock rates and
 * clock accuracy. A parent clock phase attribute does not have an
 * impact on the phase attribute of a child clock.
 */
int clk_set_phase(struct clk *clk, int degrees)
{
	int ret = 0;

	if (!clk)
		goto out;

	/* sanity check degrees */
	degrees %= 360;
	if (degrees < 0)
		degrees += 360;

	clk_prepare_lock();

	if (!clk->ops->set_phase)
		goto out_unlock;

	ret = clk->ops->set_phase(clk->hw, degrees);

	if (!ret)
		clk->phase = degrees;

out_unlock:
	clk_prepare_unlock();

out:
	return ret;
}

/**
 * clk_get_phase - return the phase shift of a clock signal
 * @clk: clock signal source
 *
 * Returns the phase shift of a clock node in degrees, otherwise returns
 * -EERROR.
 */
int clk_get_phase(struct clk *clk)
{
	int ret = 0;

	if (!clk)
		goto out;

	clk_prepare_lock();
	ret = clk->phase;
	clk_prepare_unlock();

out:
	return ret;
}

1800 1801 1802 1803 1804 1805 1806 1807
/**
 * __clk_init - initialize the data structures in a struct clk
 * @dev:	device initializing this clk, placeholder for now
 * @clk:	clk being initialized
 *
 * Initializes the lists in struct clk, queries the hardware for the
 * parent and rate and sets them both.
 */
1808
int __clk_init(struct device *dev, struct clk *clk)
1809
{
1810
	int i, ret = 0;
1811
	struct clk *orphan;
1812
	struct hlist_node *tmp2;
1813 1814

	if (!clk)
1815
		return -EINVAL;
1816

1817
	clk_prepare_lock();
1818 1819

	/* check to see if a clock with this name is already registered */
1820 1821 1822 1823
	if (__clk_lookup(clk->name)) {
		pr_debug("%s: clk %s already initialized\n",
				__func__, clk->name);
		ret = -EEXIST;
1824
		goto out;
1825
	}
1826

1827 1828
	/* check that clk_ops are sane.  See Documentation/clk.txt */
	if (clk->ops->set_rate &&
1829 1830 1831
	    !((clk->ops->round_rate || clk->ops->determine_rate) &&
	      clk->ops->recalc_rate)) {
		pr_warning("%s: %s must implement .round_rate or .determine_rate in addition to .recalc_rate\n",
1832
				__func__, clk->name);
1833
		ret = -EINVAL;
1834 1835 1836 1837 1838 1839
		goto out;
	}

	if (clk->ops->set_parent && !clk->ops->get_parent) {
		pr_warning("%s: %s must implement .get_parent & .set_parent\n",
				__func__, clk->name);
1840
		ret = -EINVAL;
1841 1842 1843
		goto out;
	}

S
Stephen Boyd 已提交
1844 1845 1846 1847 1848 1849 1850 1851
	if (clk->ops->set_rate_and_parent &&
			!(clk->ops->set_parent && clk->ops->set_rate)) {
		pr_warn("%s: %s must implement .set_parent & .set_rate\n",
				__func__, clk->name);
		ret = -EINVAL;
		goto out;
	}

1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867
	/* throw a WARN if any entries in parent_names are NULL */
	for (i = 0; i < clk->num_parents; i++)
		WARN(!clk->parent_names[i],
				"%s: invalid NULL in %s's .parent_names\n",
				__func__, clk->name);

	/*
	 * Allocate an array of struct clk *'s to avoid unnecessary string
	 * look-ups of clk's possible parents.  This can fail for clocks passed
	 * in to clk_init during early boot; thus any access to clk->parents[]
	 * must always check for a NULL pointer and try to populate it if
	 * necessary.
	 *
	 * If clk->parents is not NULL we skip this entire block.  This allows
	 * for clock drivers to statically initialize clk->parents.
	 */
1868
	if (clk->num_parents > 1 && !clk->parents) {
1869 1870
		clk->parents = kcalloc(clk->num_parents, sizeof(struct clk *),
					GFP_KERNEL);
1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902
		/*
		 * __clk_lookup returns NULL for parents that have not been
		 * clk_init'd; thus any access to clk->parents[] must check
		 * for a NULL pointer.  We can always perform lazy lookups for
		 * missing parents later on.
		 */
		if (clk->parents)
			for (i = 0; i < clk->num_parents; i++)
				clk->parents[i] =
					__clk_lookup(clk->parent_names[i]);
	}

	clk->parent = __clk_init_parent(clk);

	/*
	 * Populate clk->parent if parent has already been __clk_init'd.  If
	 * parent has not yet been __clk_init'd then place clk in the orphan
	 * list.  If clk has set the CLK_IS_ROOT flag then place it in the root
	 * clk list.
	 *
	 * Every time a new clk is clk_init'd then we walk the list of orphan
	 * clocks and re-parent any that are children of the clock currently
	 * being clk_init'd.
	 */
	if (clk->parent)
		hlist_add_head(&clk->child_node,
				&clk->parent->children);
	else if (clk->flags & CLK_IS_ROOT)
		hlist_add_head(&clk->child_node, &clk_root_list);
	else
		hlist_add_head(&clk->child_node, &clk_orphan_list);

1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917
	/*
	 * Set clk's accuracy.  The preferred method is to use
	 * .recalc_accuracy. For simple clocks and lazy developers the default
	 * fallback is to use the parent's accuracy.  If a clock doesn't have a
	 * parent (or is orphaned) then accuracy is set to zero (perfect
	 * clock).
	 */
	if (clk->ops->recalc_accuracy)
		clk->accuracy = clk->ops->recalc_accuracy(clk->hw,
					__clk_get_accuracy(clk->parent));
	else if (clk->parent)
		clk->accuracy = clk->parent->accuracy;
	else
		clk->accuracy = 0;

1918 1919 1920 1921 1922 1923 1924 1925 1926 1927
	/*
	 * Set clk's phase.
	 * Since a phase is by definition relative to its parent, just
	 * query the current clock phase, or just assume it's in phase.
	 */
	if (clk->ops->get_phase)
		clk->phase = clk->ops->get_phase(clk->hw);
	else
		clk->phase = 0;

1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941
	/*
	 * Set clk's rate.  The preferred method is to use .recalc_rate.  For
	 * simple clocks and lazy developers the default fallback is to use the
	 * parent's rate.  If a clock doesn't have a parent (or is orphaned)
	 * then rate is set to zero.
	 */
	if (clk->ops->recalc_rate)
		clk->rate = clk->ops->recalc_rate(clk->hw,
				__clk_get_rate(clk->parent));
	else if (clk->parent)
		clk->rate = clk->parent->rate;
	else
		clk->rate = 0;

1942
	clk_debug_register(clk);
1943 1944 1945 1946
	/*
	 * walk the list of orphan clocks and reparent any that are children of
	 * this clock
	 */
1947
	hlist_for_each_entry_safe(orphan, tmp2, &clk_orphan_list, child_node) {
1948
		if (orphan->num_parents && orphan->ops->get_parent) {
1949 1950 1951 1952 1953 1954
			i = orphan->ops->get_parent(orphan->hw);
			if (!strcmp(clk->name, orphan->parent_names[i]))
				__clk_reparent(orphan, clk);
			continue;
		}

1955 1956 1957 1958 1959
		for (i = 0; i < orphan->num_parents; i++)
			if (!strcmp(clk->name, orphan->parent_names[i])) {
				__clk_reparent(orphan, clk);
				break;
			}
1960
	 }
1961 1962 1963 1964 1965 1966 1967

	/*
	 * optional platform-specific magic
	 *
	 * The .init callback is not used by any of the basic clock types, but
	 * exists for weird hardware that must perform initialization magic.
	 * Please consider other ways of solving initialization problems before
P
Peter Meerwald 已提交
1968
	 * using this callback, as its use is discouraged.
1969 1970 1971 1972
	 */
	if (clk->ops->init)
		clk->ops->init(clk->hw);

S
Sylwester Nawrocki 已提交
1973
	kref_init(&clk->ref);
1974
out:
1975
	clk_prepare_unlock();
1976

1977
	return ret;
1978 1979
}

1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993
/**
 * __clk_register - register a clock and return a cookie.
 *
 * Same as clk_register, except that the .clk field inside hw shall point to a
 * preallocated (generally statically allocated) struct clk. None of the fields
 * of the struct clk need to be initialized.
 *
 * The data pointed to by .init and .clk field shall NOT be marked as init
 * data.
 *
 * __clk_register is only exposed via clk-private.h and is intended for use with
 * very large numbers of clocks that need to be statically initialized.  It is
 * a layering violation to include clk-private.h from any code which implements
 * a clock's .ops; as such any statically initialized clock data MUST be in a
P
Peter Meerwald 已提交
1994
 * separate C file from the logic that implements its operations.  Returns 0
1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008
 * on success, otherwise an error code.
 */
struct clk *__clk_register(struct device *dev, struct clk_hw *hw)
{
	int ret;
	struct clk *clk;

	clk = hw->clk;
	clk->name = hw->init->name;
	clk->ops = hw->init->ops;
	clk->hw = hw;
	clk->flags = hw->init->flags;
	clk->parent_names = hw->init->parent_names;
	clk->num_parents = hw->init->num_parents;
2009 2010 2011 2012
	if (dev && dev->driver)
		clk->owner = dev->driver->owner;
	else
		clk->owner = NULL;
2013 2014 2015 2016 2017 2018 2019 2020 2021

	ret = __clk_init(dev, clk);
	if (ret)
		return ERR_PTR(ret);

	return clk;
}
EXPORT_SYMBOL_GPL(__clk_register);

2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033
/**
 * clk_register - allocate a new clock, register it and return an opaque cookie
 * @dev: device that is registering this clock
 * @hw: link to hardware-specific clock data
 *
 * clk_register is the primary interface for populating the clock tree with new
 * clock nodes.  It returns a pointer to the newly allocated struct clk which
 * cannot be dereferenced by driver code but may be used in conjuction with the
 * rest of the clock API.  In the event of an error clk_register will return an
 * error code; drivers must test for an error code after calling clk_register.
 */
struct clk *clk_register(struct device *dev, struct clk_hw *hw)
2034
{
2035
	int i, ret;
2036 2037 2038 2039 2040 2041 2042 2043
	struct clk *clk;

	clk = kzalloc(sizeof(*clk), GFP_KERNEL);
	if (!clk) {
		pr_err("%s: could not allocate clk\n", __func__);
		ret = -ENOMEM;
		goto fail_out;
	}
2044

2045 2046 2047 2048 2049 2050 2051
	clk->name = kstrdup(hw->init->name, GFP_KERNEL);
	if (!clk->name) {
		pr_err("%s: could not allocate clk->name\n", __func__);
		ret = -ENOMEM;
		goto fail_name;
	}
	clk->ops = hw->init->ops;
2052 2053
	if (dev && dev->driver)
		clk->owner = dev->driver->owner;
2054
	clk->hw = hw;
2055 2056
	clk->flags = hw->init->flags;
	clk->num_parents = hw->init->num_parents;
2057 2058
	hw->clk = clk;

2059
	/* allocate local copy in case parent_names is __initdata */
2060 2061
	clk->parent_names = kcalloc(clk->num_parents, sizeof(char *),
					GFP_KERNEL);
2062 2063 2064 2065 2066 2067 2068 2069 2070

	if (!clk->parent_names) {
		pr_err("%s: could not allocate clk->parent_names\n", __func__);
		ret = -ENOMEM;
		goto fail_parent_names;
	}


	/* copy each string name in case parent_names is __initdata */
2071 2072 2073
	for (i = 0; i < clk->num_parents; i++) {
		clk->parent_names[i] = kstrdup(hw->init->parent_names[i],
						GFP_KERNEL);
2074 2075 2076 2077 2078 2079 2080 2081 2082
		if (!clk->parent_names[i]) {
			pr_err("%s: could not copy parent_names\n", __func__);
			ret = -ENOMEM;
			goto fail_parent_names_copy;
		}
	}

	ret = __clk_init(dev, clk);
	if (!ret)
2083
		return clk;
2084

2085 2086 2087 2088 2089
fail_parent_names_copy:
	while (--i >= 0)
		kfree(clk->parent_names[i]);
	kfree(clk->parent_names);
fail_parent_names:
2090 2091
	kfree(clk->name);
fail_name:
2092 2093 2094
	kfree(clk);
fail_out:
	return ERR_PTR(ret);
2095 2096 2097
}
EXPORT_SYMBOL_GPL(clk_register);

S
Sylwester Nawrocki 已提交
2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150
/*
 * Free memory allocated for a clock.
 * Caller must hold prepare_lock.
 */
static void __clk_release(struct kref *ref)
{
	struct clk *clk = container_of(ref, struct clk, ref);
	int i = clk->num_parents;

	kfree(clk->parents);
	while (--i >= 0)
		kfree(clk->parent_names[i]);

	kfree(clk->parent_names);
	kfree(clk->name);
	kfree(clk);
}

/*
 * Empty clk_ops for unregistered clocks. These are used temporarily
 * after clk_unregister() was called on a clock and until last clock
 * consumer calls clk_put() and the struct clk object is freed.
 */
static int clk_nodrv_prepare_enable(struct clk_hw *hw)
{
	return -ENXIO;
}

static void clk_nodrv_disable_unprepare(struct clk_hw *hw)
{
	WARN_ON_ONCE(1);
}

static int clk_nodrv_set_rate(struct clk_hw *hw, unsigned long rate,
					unsigned long parent_rate)
{
	return -ENXIO;
}

static int clk_nodrv_set_parent(struct clk_hw *hw, u8 index)
{
	return -ENXIO;
}

static const struct clk_ops clk_nodrv_ops = {
	.enable		= clk_nodrv_prepare_enable,
	.disable	= clk_nodrv_disable_unprepare,
	.prepare	= clk_nodrv_prepare_enable,
	.unprepare	= clk_nodrv_disable_unprepare,
	.set_rate	= clk_nodrv_set_rate,
	.set_parent	= clk_nodrv_set_parent,
};

M
Mark Brown 已提交
2151 2152 2153 2154
/**
 * clk_unregister - unregister a currently registered clock
 * @clk: clock to unregister
 */
S
Sylwester Nawrocki 已提交
2155 2156 2157 2158
void clk_unregister(struct clk *clk)
{
	unsigned long flags;

2159 2160 2161 2162
	if (!clk || WARN_ON_ONCE(IS_ERR(clk)))
		return;

	clk_debug_unregister(clk);
S
Sylwester Nawrocki 已提交
2163 2164 2165 2166 2167

	clk_prepare_lock();

	if (clk->ops == &clk_nodrv_ops) {
		pr_err("%s: unregistered clock: %s\n", __func__, clk->name);
2168
		return;
S
Sylwester Nawrocki 已提交
2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179
	}
	/*
	 * Assign empty clock ops for consumers that might still hold
	 * a reference to this clock.
	 */
	flags = clk_enable_lock();
	clk->ops = &clk_nodrv_ops;
	clk_enable_unlock(flags);

	if (!hlist_empty(&clk->children)) {
		struct clk *child;
2180
		struct hlist_node *t;
S
Sylwester Nawrocki 已提交
2181 2182

		/* Reparent all children to the orphan list. */
2183
		hlist_for_each_entry_safe(child, t, &clk->children, child_node)
S
Sylwester Nawrocki 已提交
2184 2185 2186 2187 2188 2189 2190 2191 2192
			clk_set_parent(child, NULL);
	}

	hlist_del_init(&clk->child_node);

	if (clk->prepare_count)
		pr_warn("%s: unregistering prepared clock: %s\n",
					__func__, clk->name);
	kref_put(&clk->ref, __clk_release);
2193

S
Sylwester Nawrocki 已提交
2194 2195
	clk_prepare_unlock();
}
M
Mark Brown 已提交
2196 2197
EXPORT_SYMBOL_GPL(clk_unregister);

2198 2199
static void devm_clk_release(struct device *dev, void *res)
{
2200
	clk_unregister(*(struct clk **)res);
2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214
}

/**
 * devm_clk_register - resource managed clk_register()
 * @dev: device that is registering this clock
 * @hw: link to hardware-specific clock data
 *
 * Managed clk_register(). Clocks returned from this function are
 * automatically clk_unregister()ed on driver detach. See clk_register() for
 * more information.
 */
struct clk *devm_clk_register(struct device *dev, struct clk_hw *hw)
{
	struct clk *clk;
2215
	struct clk **clkp;
2216

2217 2218
	clkp = devres_alloc(devm_clk_release, sizeof(*clkp), GFP_KERNEL);
	if (!clkp)
2219 2220
		return ERR_PTR(-ENOMEM);

2221 2222 2223 2224
	clk = clk_register(dev, hw);
	if (!IS_ERR(clk)) {
		*clkp = clk;
		devres_add(dev, clkp);
2225
	} else {
2226
		devres_free(clkp);
2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254
	}

	return clk;
}
EXPORT_SYMBOL_GPL(devm_clk_register);

static int devm_clk_match(struct device *dev, void *res, void *data)
{
	struct clk *c = res;
	if (WARN_ON(!c))
		return 0;
	return c == data;
}

/**
 * devm_clk_unregister - resource managed clk_unregister()
 * @clk: clock to unregister
 *
 * Deallocate a clock allocated with devm_clk_register(). Normally
 * this function will not need to be called and the resource management
 * code will ensure that the resource is freed.
 */
void devm_clk_unregister(struct device *dev, struct clk *clk)
{
	WARN_ON(devres_release(dev, devm_clk_release, devm_clk_match, clk));
}
EXPORT_SYMBOL_GPL(devm_clk_unregister);

2255 2256 2257 2258 2259
/*
 * clkdev helpers
 */
int __clk_get(struct clk *clk)
{
2260 2261 2262
	if (clk) {
		if (!try_module_get(clk->owner))
			return 0;
2263

2264 2265
		kref_get(&clk->ref);
	}
2266 2267 2268 2269 2270
	return 1;
}

void __clk_put(struct clk *clk)
{
2271
	if (!clk || WARN_ON_ONCE(IS_ERR(clk)))
2272 2273
		return;

S
Sylwester Nawrocki 已提交
2274 2275 2276 2277
	clk_prepare_lock();
	kref_put(&clk->ref, __clk_release);
	clk_prepare_unlock();

2278
	module_put(clk->owner);
2279 2280
}

2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293
/***        clk rate change notifiers        ***/

/**
 * clk_notifier_register - add a clk rate change notifier
 * @clk: struct clk * to watch
 * @nb: struct notifier_block * with callback info
 *
 * Request notification when clk's rate changes.  This uses an SRCU
 * notifier because we want it to block and notifier unregistrations are
 * uncommon.  The callbacks associated with the notifier must not
 * re-enter into the clk framework by calling any top-level clk APIs;
 * this will cause a nested prepare_lock mutex.
 *
2294 2295 2296
 * In all notification cases cases (pre, post and abort rate change) the
 * original clock rate is passed to the callback via struct
 * clk_notifier_data.old_rate and the new frequency is passed via struct
2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311
 * clk_notifier_data.new_rate.
 *
 * clk_notifier_register() must be called from non-atomic context.
 * Returns -EINVAL if called with null arguments, -ENOMEM upon
 * allocation failure; otherwise, passes along the return value of
 * srcu_notifier_chain_register().
 */
int clk_notifier_register(struct clk *clk, struct notifier_block *nb)
{
	struct clk_notifier *cn;
	int ret = -ENOMEM;

	if (!clk || !nb)
		return -EINVAL;

2312
	clk_prepare_lock();
2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335

	/* search the list of notifiers for this clk */
	list_for_each_entry(cn, &clk_notifier_list, node)
		if (cn->clk == clk)
			break;

	/* if clk wasn't in the notifier list, allocate new clk_notifier */
	if (cn->clk != clk) {
		cn = kzalloc(sizeof(struct clk_notifier), GFP_KERNEL);
		if (!cn)
			goto out;

		cn->clk = clk;
		srcu_init_notifier_head(&cn->notifier_head);

		list_add(&cn->node, &clk_notifier_list);
	}

	ret = srcu_notifier_chain_register(&cn->notifier_head, nb);

	clk->notifier_count++;

out:
2336
	clk_prepare_unlock();
2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360

	return ret;
}
EXPORT_SYMBOL_GPL(clk_notifier_register);

/**
 * clk_notifier_unregister - remove a clk rate change notifier
 * @clk: struct clk *
 * @nb: struct notifier_block * with callback info
 *
 * Request no further notification for changes to 'clk' and frees memory
 * allocated in clk_notifier_register.
 *
 * Returns -EINVAL if called with null arguments; otherwise, passes
 * along the return value of srcu_notifier_chain_unregister().
 */
int clk_notifier_unregister(struct clk *clk, struct notifier_block *nb)
{
	struct clk_notifier *cn = NULL;
	int ret = -EINVAL;

	if (!clk || !nb)
		return -EINVAL;

2361
	clk_prepare_lock();
2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374

	list_for_each_entry(cn, &clk_notifier_list, node)
		if (cn->clk == clk)
			break;

	if (cn->clk == clk) {
		ret = srcu_notifier_chain_unregister(&cn->notifier_head, nb);

		clk->notifier_count--;

		/* XXX the notifier code should handle this better */
		if (!cn->notifier_head.head) {
			srcu_cleanup_notifier_head(&cn->notifier_head);
2375
			list_del(&cn->node);
2376 2377 2378 2379 2380 2381 2382
			kfree(cn);
		}

	} else {
		ret = -ENOENT;
	}

2383
	clk_prepare_unlock();
2384 2385 2386 2387

	return ret;
}
EXPORT_SYMBOL_GPL(clk_notifier_unregister);
G
Grant Likely 已提交
2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405

#ifdef CONFIG_OF
/**
 * struct of_clk_provider - Clock provider registration structure
 * @link: Entry in global list of clock providers
 * @node: Pointer to device tree node of clock provider
 * @get: Get clock callback.  Returns NULL or a struct clk for the
 *       given clock specifier
 * @data: context pointer to be passed into @get callback
 */
struct of_clk_provider {
	struct list_head link;

	struct device_node *node;
	struct clk *(*get)(struct of_phandle_args *clkspec, void *data);
	void *data;
};

2406 2407 2408
static const struct of_device_id __clk_of_table_sentinel
	__used __section(__clk_of_table_end);

G
Grant Likely 已提交
2409
static LIST_HEAD(of_clk_providers);
2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421
static DEFINE_MUTEX(of_clk_mutex);

/* of_clk_provider list locking helpers */
void of_clk_lock(void)
{
	mutex_lock(&of_clk_mutex);
}

void of_clk_unlock(void)
{
	mutex_unlock(&of_clk_mutex);
}
G
Grant Likely 已提交
2422 2423 2424 2425 2426 2427 2428 2429

struct clk *of_clk_src_simple_get(struct of_phandle_args *clkspec,
				     void *data)
{
	return data;
}
EXPORT_SYMBOL_GPL(of_clk_src_simple_get);

2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443
struct clk *of_clk_src_onecell_get(struct of_phandle_args *clkspec, void *data)
{
	struct clk_onecell_data *clk_data = data;
	unsigned int idx = clkspec->args[0];

	if (idx >= clk_data->clk_num) {
		pr_err("%s: invalid clock index %d\n", __func__, idx);
		return ERR_PTR(-EINVAL);
	}

	return clk_data->clks[idx];
}
EXPORT_SYMBOL_GPL(of_clk_src_onecell_get);

G
Grant Likely 已提交
2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455
/**
 * of_clk_add_provider() - Register a clock provider for a node
 * @np: Device node pointer associated with clock provider
 * @clk_src_get: callback for decoding clock
 * @data: context pointer for @clk_src_get callback.
 */
int of_clk_add_provider(struct device_node *np,
			struct clk *(*clk_src_get)(struct of_phandle_args *clkspec,
						   void *data),
			void *data)
{
	struct of_clk_provider *cp;
2456
	int ret;
G
Grant Likely 已提交
2457 2458 2459 2460 2461 2462 2463 2464 2465

	cp = kzalloc(sizeof(struct of_clk_provider), GFP_KERNEL);
	if (!cp)
		return -ENOMEM;

	cp->node = of_node_get(np);
	cp->data = data;
	cp->get = clk_src_get;

2466
	mutex_lock(&of_clk_mutex);
G
Grant Likely 已提交
2467
	list_add(&cp->link, &of_clk_providers);
2468
	mutex_unlock(&of_clk_mutex);
G
Grant Likely 已提交
2469 2470
	pr_debug("Added clock from %s\n", np->full_name);

2471 2472 2473 2474 2475
	ret = of_clk_set_defaults(np, true);
	if (ret < 0)
		of_clk_del_provider(np);

	return ret;
G
Grant Likely 已提交
2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486
}
EXPORT_SYMBOL_GPL(of_clk_add_provider);

/**
 * of_clk_del_provider() - Remove a previously registered clock provider
 * @np: Device node pointer associated with clock provider
 */
void of_clk_del_provider(struct device_node *np)
{
	struct of_clk_provider *cp;

2487
	mutex_lock(&of_clk_mutex);
G
Grant Likely 已提交
2488 2489 2490 2491 2492 2493 2494 2495
	list_for_each_entry(cp, &of_clk_providers, link) {
		if (cp->node == np) {
			list_del(&cp->link);
			of_node_put(cp->node);
			kfree(cp);
			break;
		}
	}
2496
	mutex_unlock(&of_clk_mutex);
G
Grant Likely 已提交
2497 2498 2499
}
EXPORT_SYMBOL_GPL(of_clk_del_provider);

2500
struct clk *__of_clk_get_from_provider(struct of_phandle_args *clkspec)
G
Grant Likely 已提交
2501 2502
{
	struct of_clk_provider *provider;
2503
	struct clk *clk = ERR_PTR(-EPROBE_DEFER);
G
Grant Likely 已提交
2504 2505 2506 2507 2508 2509 2510 2511

	/* Check if we have such a provider in our array */
	list_for_each_entry(provider, &of_clk_providers, link) {
		if (provider->node == clkspec->np)
			clk = provider->get(clkspec, provider->data);
		if (!IS_ERR(clk))
			break;
	}
2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522

	return clk;
}

struct clk *of_clk_get_from_provider(struct of_phandle_args *clkspec)
{
	struct clk *clk;

	mutex_lock(&of_clk_mutex);
	clk = __of_clk_get_from_provider(clkspec);
	mutex_unlock(&of_clk_mutex);
G
Grant Likely 已提交
2523 2524 2525 2526

	return clk;
}

2527 2528 2529 2530 2531 2532
int of_clk_get_parent_count(struct device_node *np)
{
	return of_count_phandle_with_args(np, "clocks", "#clock-cells");
}
EXPORT_SYMBOL_GPL(of_clk_get_parent_count);

G
Grant Likely 已提交
2533 2534 2535
const char *of_clk_get_parent_name(struct device_node *np, int index)
{
	struct of_phandle_args clkspec;
B
Ben Dooks 已提交
2536
	struct property *prop;
G
Grant Likely 已提交
2537
	const char *clk_name;
B
Ben Dooks 已提交
2538 2539
	const __be32 *vp;
	u32 pv;
G
Grant Likely 已提交
2540
	int rc;
B
Ben Dooks 已提交
2541
	int count;
G
Grant Likely 已提交
2542 2543 2544 2545 2546 2547 2548 2549 2550

	if (index < 0)
		return NULL;

	rc = of_parse_phandle_with_args(np, "clocks", "#clock-cells", index,
					&clkspec);
	if (rc)
		return NULL;

B
Ben Dooks 已提交
2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564
	index = clkspec.args_count ? clkspec.args[0] : 0;
	count = 0;

	/* if there is an indices property, use it to transfer the index
	 * specified into an array offset for the clock-output-names property.
	 */
	of_property_for_each_u32(clkspec.np, "clock-indices", prop, vp, pv) {
		if (index == pv) {
			index = count;
			break;
		}
		count++;
	}

G
Grant Likely 已提交
2565
	if (of_property_read_string_index(clkspec.np, "clock-output-names",
B
Ben Dooks 已提交
2566
					  index,
G
Grant Likely 已提交
2567 2568 2569 2570 2571 2572 2573 2574
					  &clk_name) < 0)
		clk_name = clkspec.np->name;

	of_node_put(clkspec.np);
	return clk_name;
}
EXPORT_SYMBOL_GPL(of_clk_get_parent_name);

2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617
struct clock_provider {
	of_clk_init_cb_t clk_init_cb;
	struct device_node *np;
	struct list_head node;
};

static LIST_HEAD(clk_provider_list);

/*
 * This function looks for a parent clock. If there is one, then it
 * checks that the provider for this parent clock was initialized, in
 * this case the parent clock will be ready.
 */
static int parent_ready(struct device_node *np)
{
	int i = 0;

	while (true) {
		struct clk *clk = of_clk_get(np, i);

		/* this parent is ready we can check the next one */
		if (!IS_ERR(clk)) {
			clk_put(clk);
			i++;
			continue;
		}

		/* at least one parent is not ready, we exit now */
		if (PTR_ERR(clk) == -EPROBE_DEFER)
			return 0;

		/*
		 * Here we make assumption that the device tree is
		 * written correctly. So an error means that there is
		 * no more parent. As we didn't exit yet, then the
		 * previous parent are ready. If there is no clock
		 * parent, no need to wait for them, then we can
		 * consider their absence as being ready
		 */
		return 1;
	}
}

G
Grant Likely 已提交
2618 2619 2620 2621
/**
 * of_clk_init() - Scan and init clock providers from the DT
 * @matches: array of compatible values and init functions for providers.
 *
2622
 * This function scans the device tree for matching clock providers
2623
 * and calls their initialization functions. It also does it by trying
2624
 * to follow the dependencies.
G
Grant Likely 已提交
2625 2626 2627
 */
void __init of_clk_init(const struct of_device_id *matches)
{
2628
	const struct of_device_id *match;
G
Grant Likely 已提交
2629
	struct device_node *np;
2630 2631 2632
	struct clock_provider *clk_provider, *next;
	bool is_init_done;
	bool force = false;
G
Grant Likely 已提交
2633

2634
	if (!matches)
2635
		matches = &__clk_of_table;
2636

2637
	/* First prepare the list of the clocks providers */
2638
	for_each_matching_node_and_match(np, matches, &match) {
2639 2640 2641 2642 2643
		struct clock_provider *parent =
			kzalloc(sizeof(struct clock_provider),	GFP_KERNEL);

		parent->clk_init_cb = match->data;
		parent->np = np;
2644
		list_add_tail(&parent->node, &clk_provider_list);
2645 2646 2647 2648 2649 2650 2651
	}

	while (!list_empty(&clk_provider_list)) {
		is_init_done = false;
		list_for_each_entry_safe(clk_provider, next,
					&clk_provider_list, node) {
			if (force || parent_ready(clk_provider->np)) {
2652

2653
				clk_provider->clk_init_cb(clk_provider->np);
2654 2655
				of_clk_set_defaults(clk_provider->np, true);

2656 2657 2658 2659 2660 2661 2662
				list_del(&clk_provider->node);
				kfree(clk_provider);
				is_init_done = true;
			}
		}

		/*
2663
		 * We didn't manage to initialize any of the
2664 2665 2666 2667 2668 2669
		 * remaining providers during the last loop, so now we
		 * initialize all the remaining ones unconditionally
		 * in case the clock parent was not mandatory
		 */
		if (!is_init_done)
			force = true;
G
Grant Likely 已提交
2670 2671 2672
	}
}
#endif