2 * OMAP2/3/4 clockdomain framework functions
4 * Copyright (C) 2008-2011 Texas Instruments, Inc.
5 * Copyright (C) 2008-2011 Nokia Corporation
7 * Written by Paul Walmsley and Jouni Högander
8 * Added OMAP4 specific support by Abhijit Pagare <abhijitpagare@ti.com>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
16 #include <linux/kernel.h>
17 #include <linux/device.h>
18 #include <linux/list.h>
19 #include <linux/errno.h>
20 #include <linux/delay.h>
21 #include <linux/clk.h>
22 #include <linux/limits.h>
23 #include <linux/err.h>
27 #include <linux/bitops.h>
29 #include <plat/clock.h>
30 #include "clockdomain.h"
32 /* clkdm_list contains all registered struct clockdomains */
33 static LIST_HEAD(clkdm_list);
35 /* array of clockdomain deps to be added/removed when clkdm in hwsup mode */
36 static struct clkdm_autodep *autodeps;
38 static struct clkdm_ops *arch_clkdm;
40 /* Private functions */
42 static struct clockdomain *_clkdm_lookup(const char *name)
44 struct clockdomain *clkdm, *temp_clkdm;
51 list_for_each_entry(temp_clkdm, &clkdm_list, node) {
52 if (!strcmp(name, temp_clkdm->name)) {
62 * _clkdm_register - register a clockdomain
63 * @clkdm: struct clockdomain * to register
65 * Adds a clockdomain to the internal clockdomain list.
66 * Returns -EINVAL if given a null pointer, -EEXIST if a clockdomain is
67 * already registered by the provided name, or 0 upon success.
69 static int _clkdm_register(struct clockdomain *clkdm)
71 struct powerdomain *pwrdm;
73 if (!clkdm || !clkdm->name)
76 pwrdm = pwrdm_lookup(clkdm->pwrdm.name);
78 pr_err("clockdomain: %s: powerdomain %s does not exist\n",
79 clkdm->name, clkdm->pwrdm.name);
82 clkdm->pwrdm.ptr = pwrdm;
84 /* Verify that the clockdomain is not already registered */
85 if (_clkdm_lookup(clkdm->name))
88 list_add(&clkdm->node, &clkdm_list);
90 pwrdm_add_clkdm(pwrdm, clkdm);
92 spin_lock_init(&clkdm->lock);
94 pr_debug("clockdomain: registered %s\n", clkdm->name);
99 /* _clkdm_deps_lookup - look up the specified clockdomain in a clkdm list */
100 static struct clkdm_dep *_clkdm_deps_lookup(struct clockdomain *clkdm,
101 struct clkdm_dep *deps)
103 struct clkdm_dep *cd;
106 return ERR_PTR(-EINVAL);
108 for (cd = deps; cd->clkdm_name; cd++) {
109 if (!cd->clkdm && cd->clkdm_name)
110 cd->clkdm = _clkdm_lookup(cd->clkdm_name);
112 if (cd->clkdm == clkdm)
117 return ERR_PTR(-ENOENT);
123 * _autodep_lookup - resolve autodep clkdm names to clkdm pointers; store
124 * @autodep: struct clkdm_autodep * to resolve
126 * Resolve autodep clockdomain names to clockdomain pointers via
127 * clkdm_lookup() and store the pointers in the autodep structure. An
128 * "autodep" is a clockdomain sleep/wakeup dependency that is
129 * automatically added and removed whenever clocks in the associated
130 * clockdomain are enabled or disabled (respectively) when the
131 * clockdomain is in hardware-supervised mode. Meant to be called
132 * once at clockdomain layer initialization, since these should remain
133 * fixed for a particular architecture. No return value.
135 * XXX autodeps are deprecated and should be removed at the earliest
138 static void _autodep_lookup(struct clkdm_autodep *autodep)
140 struct clockdomain *clkdm;
145 clkdm = clkdm_lookup(autodep->clkdm.name);
147 pr_err("clockdomain: autodeps: clockdomain %s does not exist\n",
148 autodep->clkdm.name);
149 clkdm = ERR_PTR(-ENOENT);
151 autodep->clkdm.ptr = clkdm;
155 * _clkdm_add_autodeps - add auto sleepdeps/wkdeps to clkdm upon clock enable
156 * @clkdm: struct clockdomain *
158 * Add the "autodep" sleep & wakeup dependencies to clockdomain 'clkdm'
159 * in hardware-supervised mode. Meant to be called from clock framework
160 * when a clock inside clockdomain 'clkdm' is enabled. No return value.
162 * XXX autodeps are deprecated and should be removed at the earliest
165 void _clkdm_add_autodeps(struct clockdomain *clkdm)
167 struct clkdm_autodep *autodep;
169 if (!autodeps || clkdm->flags & CLKDM_NO_AUTODEPS)
172 for (autodep = autodeps; autodep->clkdm.ptr; autodep++) {
173 if (IS_ERR(autodep->clkdm.ptr))
176 pr_debug("clockdomain: adding %s sleepdep/wkdep for "
177 "clkdm %s\n", autodep->clkdm.ptr->name,
180 clkdm_add_sleepdep(clkdm, autodep->clkdm.ptr);
181 clkdm_add_wkdep(clkdm, autodep->clkdm.ptr);
186 * _clkdm_add_autodeps - remove auto sleepdeps/wkdeps from clkdm
187 * @clkdm: struct clockdomain *
189 * Remove the "autodep" sleep & wakeup dependencies from clockdomain 'clkdm'
190 * in hardware-supervised mode. Meant to be called from clock framework
191 * when a clock inside clockdomain 'clkdm' is disabled. No return value.
193 * XXX autodeps are deprecated and should be removed at the earliest
196 void _clkdm_del_autodeps(struct clockdomain *clkdm)
198 struct clkdm_autodep *autodep;
200 if (!autodeps || clkdm->flags & CLKDM_NO_AUTODEPS)
203 for (autodep = autodeps; autodep->clkdm.ptr; autodep++) {
204 if (IS_ERR(autodep->clkdm.ptr))
207 pr_debug("clockdomain: removing %s sleepdep/wkdep for "
208 "clkdm %s\n", autodep->clkdm.ptr->name,
211 clkdm_del_sleepdep(clkdm, autodep->clkdm.ptr);
212 clkdm_del_wkdep(clkdm, autodep->clkdm.ptr);
217 * _resolve_clkdm_deps() - resolve clkdm_names in @clkdm_deps to clkdms
218 * @clkdm: clockdomain that we are resolving dependencies for
219 * @clkdm_deps: ptr to array of struct clkdm_deps to resolve
221 * Iterates through @clkdm_deps, looking up the struct clockdomain named by
222 * clkdm_name and storing the clockdomain pointer in the struct clkdm_dep.
225 static void _resolve_clkdm_deps(struct clockdomain *clkdm,
226 struct clkdm_dep *clkdm_deps)
228 struct clkdm_dep *cd;
230 for (cd = clkdm_deps; cd && cd->clkdm_name; cd++) {
233 cd->clkdm = _clkdm_lookup(cd->clkdm_name);
235 WARN(!cd->clkdm, "clockdomain: %s: could not find clkdm %s while resolving dependencies - should never happen",
236 clkdm->name, cd->clkdm_name);
240 /* Public functions */
243 * clkdm_register_platform_funcs - register clockdomain implementation fns
244 * @co: func pointers for arch specific implementations
246 * Register the list of function pointers used to implement the
247 * clockdomain functions on different OMAP SoCs. Should be called
248 * before any other clkdm_register*() function. Returns -EINVAL if
249 * @co is null, -EEXIST if platform functions have already been
250 * registered, or 0 upon success.
252 int clkdm_register_platform_funcs(struct clkdm_ops *co)
266 * clkdm_register_clkdms - register SoC clockdomains
267 * @cs: pointer to an array of struct clockdomain to register
269 * Register the clockdomains available on a particular OMAP SoC. Must
270 * be called after clkdm_register_platform_funcs(). May be called
271 * multiple times. Returns -EACCES if called before
272 * clkdm_register_platform_funcs(); -EINVAL if the argument @cs is
273 * null; or 0 upon success.
275 int clkdm_register_clkdms(struct clockdomain **cs)
277 struct clockdomain **c = NULL;
285 for (c = cs; *c; c++)
292 * clkdm_register_autodeps - register autodeps (if required)
293 * @ia: pointer to a static array of struct clkdm_autodep to register
295 * Register clockdomain "automatic dependencies." These are
296 * clockdomain wakeup and sleep dependencies that are automatically
297 * added whenever the first clock inside a clockdomain is enabled, and
298 * removed whenever the last clock inside a clockdomain is disabled.
299 * These are currently only used on OMAP3 devices, and are deprecated,
300 * since they waste energy. However, until the OMAP2/3 IP block
301 * enable/disable sequence can be converted to match the OMAP4
302 * sequence, they are needed.
304 * Must be called only after all of the SoC clockdomains are
305 * registered, since the function will resolve autodep clockdomain
306 * names into clockdomain pointers.
308 * The struct clkdm_autodep @ia array must be static, as this function
309 * does not copy the array elements.
311 * Returns -EACCES if called before any clockdomains have been
312 * registered, -EINVAL if called with a null @ia argument, -EEXIST if
313 * autodeps have already been registered, or 0 upon success.
315 int clkdm_register_autodeps(struct clkdm_autodep *ia)
317 struct clkdm_autodep *a = NULL;
319 if (list_empty(&clkdm_list))
329 for (a = autodeps; a->clkdm.ptr; a++)
336 * clkdm_complete_init - set up the clockdomain layer
338 * Put all clockdomains into software-supervised mode; PM code should
339 * later enable hardware-supervised mode as appropriate. Must be
340 * called after clkdm_register_clkdms(). Returns -EACCES if called
341 * before clkdm_register_clkdms(), or 0 upon success.
343 int clkdm_complete_init(void)
345 struct clockdomain *clkdm;
347 if (list_empty(&clkdm_list))
350 list_for_each_entry(clkdm, &clkdm_list, node) {
351 if (clkdm->flags & CLKDM_CAN_FORCE_WAKEUP)
353 else if (clkdm->flags & CLKDM_CAN_DISABLE_AUTO)
354 clkdm_deny_idle(clkdm);
356 _resolve_clkdm_deps(clkdm, clkdm->wkdep_srcs);
357 clkdm_clear_all_wkdeps(clkdm);
359 _resolve_clkdm_deps(clkdm, clkdm->sleepdep_srcs);
360 clkdm_clear_all_sleepdeps(clkdm);
367 * clkdm_lookup - look up a clockdomain by name, return a pointer
368 * @name: name of clockdomain
370 * Find a registered clockdomain by its name @name. Returns a pointer
371 * to the struct clockdomain if found, or NULL otherwise.
373 struct clockdomain *clkdm_lookup(const char *name)
375 struct clockdomain *clkdm, *temp_clkdm;
382 list_for_each_entry(temp_clkdm, &clkdm_list, node) {
383 if (!strcmp(name, temp_clkdm->name)) {
393 * clkdm_for_each - call function on each registered clockdomain
394 * @fn: callback function *
396 * Call the supplied function @fn for each registered clockdomain.
397 * The callback function @fn can return anything but 0 to bail
398 * out early from the iterator. The callback function is called with
399 * the clkdm_mutex held, so no clockdomain structure manipulation
400 * functions should be called from the callback, although hardware
401 * clockdomain control functions are fine. Returns the last return
402 * value of the callback function, which should be 0 for success or
403 * anything else to indicate failure; or -EINVAL if the function pointer
406 int clkdm_for_each(int (*fn)(struct clockdomain *clkdm, void *user),
409 struct clockdomain *clkdm;
415 list_for_each_entry(clkdm, &clkdm_list, node) {
416 ret = (*fn)(clkdm, user);
426 * clkdm_get_pwrdm - return a ptr to the pwrdm that this clkdm resides in
427 * @clkdm: struct clockdomain *
429 * Return a pointer to the struct powerdomain that the specified clockdomain
430 * @clkdm exists in, or returns NULL if @clkdm is NULL.
432 struct powerdomain *clkdm_get_pwrdm(struct clockdomain *clkdm)
437 return clkdm->pwrdm.ptr;
441 /* Hardware clockdomain control */
444 * clkdm_add_wkdep - add a wakeup dependency from clkdm2 to clkdm1
445 * @clkdm1: wake this struct clockdomain * up (dependent)
446 * @clkdm2: when this struct clockdomain * wakes up (source)
448 * When the clockdomain represented by @clkdm2 wakes up, wake up
449 * @clkdm1. Implemented in hardware on the OMAP, this feature is
450 * designed to reduce wakeup latency of the dependent clockdomain @clkdm1.
451 * Returns -EINVAL if presented with invalid clockdomain pointers,
452 * -ENOENT if @clkdm2 cannot wake up clkdm1 in hardware, or 0 upon
455 int clkdm_add_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2)
457 struct clkdm_dep *cd;
460 if (!clkdm1 || !clkdm2)
463 cd = _clkdm_deps_lookup(clkdm2, clkdm1->wkdep_srcs);
467 if (!arch_clkdm || !arch_clkdm->clkdm_add_wkdep)
471 pr_debug("clockdomain: hardware cannot set/clear wake up of "
472 "%s when %s wakes up\n", clkdm1->name, clkdm2->name);
476 if (atomic_inc_return(&cd->wkdep_usecount) == 1) {
477 pr_debug("clockdomain: hardware will wake up %s when %s wakes "
478 "up\n", clkdm1->name, clkdm2->name);
480 ret = arch_clkdm->clkdm_add_wkdep(clkdm1, clkdm2);
487 * clkdm_del_wkdep - remove a wakeup dependency from clkdm2 to clkdm1
488 * @clkdm1: wake this struct clockdomain * up (dependent)
489 * @clkdm2: when this struct clockdomain * wakes up (source)
491 * Remove a wakeup dependency causing @clkdm1 to wake up when @clkdm2
492 * wakes up. Returns -EINVAL if presented with invalid clockdomain
493 * pointers, -ENOENT if @clkdm2 cannot wake up clkdm1 in hardware, or
496 int clkdm_del_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2)
498 struct clkdm_dep *cd;
501 if (!clkdm1 || !clkdm2)
504 cd = _clkdm_deps_lookup(clkdm2, clkdm1->wkdep_srcs);
508 if (!arch_clkdm || !arch_clkdm->clkdm_del_wkdep)
512 pr_debug("clockdomain: hardware cannot set/clear wake up of "
513 "%s when %s wakes up\n", clkdm1->name, clkdm2->name);
517 if (atomic_dec_return(&cd->wkdep_usecount) == 0) {
518 pr_debug("clockdomain: hardware will no longer wake up %s "
519 "after %s wakes up\n", clkdm1->name, clkdm2->name);
521 ret = arch_clkdm->clkdm_del_wkdep(clkdm1, clkdm2);
528 * clkdm_read_wkdep - read wakeup dependency state from clkdm2 to clkdm1
529 * @clkdm1: wake this struct clockdomain * up (dependent)
530 * @clkdm2: when this struct clockdomain * wakes up (source)
532 * Return 1 if a hardware wakeup dependency exists wherein @clkdm1 will be
533 * awoken when @clkdm2 wakes up; 0 if dependency is not set; -EINVAL
534 * if either clockdomain pointer is invalid; or -ENOENT if the hardware
537 * REVISIT: Currently this function only represents software-controllable
538 * wakeup dependencies. Wakeup dependencies fixed in hardware are not
541 int clkdm_read_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2)
543 struct clkdm_dep *cd;
546 if (!clkdm1 || !clkdm2)
549 cd = _clkdm_deps_lookup(clkdm2, clkdm1->wkdep_srcs);
553 if (!arch_clkdm || !arch_clkdm->clkdm_read_wkdep)
557 pr_debug("clockdomain: hardware cannot set/clear wake up of "
558 "%s when %s wakes up\n", clkdm1->name, clkdm2->name);
562 /* XXX It's faster to return the atomic wkdep_usecount */
563 return arch_clkdm->clkdm_read_wkdep(clkdm1, clkdm2);
567 * clkdm_clear_all_wkdeps - remove all wakeup dependencies from target clkdm
568 * @clkdm: struct clockdomain * to remove all wakeup dependencies from
570 * Remove all inter-clockdomain wakeup dependencies that could cause
571 * @clkdm to wake. Intended to be used during boot to initialize the
572 * PRCM to a known state, after all clockdomains are put into swsup idle
573 * and woken up. Returns -EINVAL if @clkdm pointer is invalid, or
576 int clkdm_clear_all_wkdeps(struct clockdomain *clkdm)
581 if (!arch_clkdm || !arch_clkdm->clkdm_clear_all_wkdeps)
584 return arch_clkdm->clkdm_clear_all_wkdeps(clkdm);
588 * clkdm_add_sleepdep - add a sleep dependency from clkdm2 to clkdm1
589 * @clkdm1: prevent this struct clockdomain * from sleeping (dependent)
590 * @clkdm2: when this struct clockdomain * is active (source)
592 * Prevent @clkdm1 from automatically going inactive (and then to
593 * retention or off) if @clkdm2 is active. Returns -EINVAL if
594 * presented with invalid clockdomain pointers or called on a machine
595 * that does not support software-configurable hardware sleep
596 * dependencies, -ENOENT if the specified dependency cannot be set in
597 * hardware, or 0 upon success.
599 int clkdm_add_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2)
601 struct clkdm_dep *cd;
604 if (!clkdm1 || !clkdm2)
607 cd = _clkdm_deps_lookup(clkdm2, clkdm1->sleepdep_srcs);
611 if (!arch_clkdm || !arch_clkdm->clkdm_add_sleepdep)
615 pr_debug("clockdomain: hardware cannot set/clear sleep "
616 "dependency affecting %s from %s\n", clkdm1->name,
621 if (atomic_inc_return(&cd->sleepdep_usecount) == 1) {
622 pr_debug("clockdomain: will prevent %s from sleeping if %s "
623 "is active\n", clkdm1->name, clkdm2->name);
625 ret = arch_clkdm->clkdm_add_sleepdep(clkdm1, clkdm2);
632 * clkdm_del_sleepdep - remove a sleep dependency from clkdm2 to clkdm1
633 * @clkdm1: prevent this struct clockdomain * from sleeping (dependent)
634 * @clkdm2: when this struct clockdomain * is active (source)
636 * Allow @clkdm1 to automatically go inactive (and then to retention or
637 * off), independent of the activity state of @clkdm2. Returns -EINVAL
638 * if presented with invalid clockdomain pointers or called on a machine
639 * that does not support software-configurable hardware sleep dependencies,
640 * -ENOENT if the specified dependency cannot be cleared in hardware, or
643 int clkdm_del_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2)
645 struct clkdm_dep *cd;
648 if (!clkdm1 || !clkdm2)
651 cd = _clkdm_deps_lookup(clkdm2, clkdm1->sleepdep_srcs);
655 if (!arch_clkdm || !arch_clkdm->clkdm_del_sleepdep)
659 pr_debug("clockdomain: hardware cannot set/clear sleep "
660 "dependency affecting %s from %s\n", clkdm1->name,
665 if (atomic_dec_return(&cd->sleepdep_usecount) == 0) {
666 pr_debug("clockdomain: will no longer prevent %s from "
667 "sleeping if %s is active\n", clkdm1->name,
670 ret = arch_clkdm->clkdm_del_sleepdep(clkdm1, clkdm2);
677 * clkdm_read_sleepdep - read sleep dependency state from clkdm2 to clkdm1
678 * @clkdm1: prevent this struct clockdomain * from sleeping (dependent)
679 * @clkdm2: when this struct clockdomain * is active (source)
681 * Return 1 if a hardware sleep dependency exists wherein @clkdm1 will
682 * not be allowed to automatically go inactive if @clkdm2 is active;
683 * 0 if @clkdm1's automatic power state inactivity transition is independent
684 * of @clkdm2's; -EINVAL if either clockdomain pointer is invalid or called
685 * on a machine that does not support software-configurable hardware sleep
686 * dependencies; or -ENOENT if the hardware is incapable.
688 * REVISIT: Currently this function only represents software-controllable
689 * sleep dependencies. Sleep dependencies fixed in hardware are not
692 int clkdm_read_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2)
694 struct clkdm_dep *cd;
697 if (!clkdm1 || !clkdm2)
700 cd = _clkdm_deps_lookup(clkdm2, clkdm1->sleepdep_srcs);
704 if (!arch_clkdm || !arch_clkdm->clkdm_read_sleepdep)
708 pr_debug("clockdomain: hardware cannot set/clear sleep "
709 "dependency affecting %s from %s\n", clkdm1->name,
714 /* XXX It's faster to return the atomic sleepdep_usecount */
715 return arch_clkdm->clkdm_read_sleepdep(clkdm1, clkdm2);
719 * clkdm_clear_all_sleepdeps - remove all sleep dependencies from target clkdm
720 * @clkdm: struct clockdomain * to remove all sleep dependencies from
722 * Remove all inter-clockdomain sleep dependencies that could prevent
723 * @clkdm from idling. Intended to be used during boot to initialize the
724 * PRCM to a known state, after all clockdomains are put into swsup idle
725 * and woken up. Returns -EINVAL if @clkdm pointer is invalid, or
728 int clkdm_clear_all_sleepdeps(struct clockdomain *clkdm)
733 if (!arch_clkdm || !arch_clkdm->clkdm_clear_all_sleepdeps)
736 return arch_clkdm->clkdm_clear_all_sleepdeps(clkdm);
740 * clkdm_sleep - force clockdomain sleep transition
741 * @clkdm: struct clockdomain *
743 * Instruct the CM to force a sleep transition on the specified
744 * clockdomain @clkdm. Returns -EINVAL if @clkdm is NULL or if
745 * clockdomain does not support software-initiated sleep; 0 upon
748 int clkdm_sleep(struct clockdomain *clkdm)
756 if (!(clkdm->flags & CLKDM_CAN_FORCE_SLEEP)) {
757 pr_debug("clockdomain: %s does not support forcing "
758 "sleep via software\n", clkdm->name);
762 if (!arch_clkdm || !arch_clkdm->clkdm_sleep)
765 pr_debug("clockdomain: forcing sleep on %s\n", clkdm->name);
767 spin_lock_irqsave(&clkdm->lock, flags);
768 clkdm->_flags &= ~_CLKDM_FLAG_HWSUP_ENABLED;
769 ret = arch_clkdm->clkdm_sleep(clkdm);
770 spin_unlock_irqrestore(&clkdm->lock, flags);
775 * clkdm_wakeup - force clockdomain wakeup transition
776 * @clkdm: struct clockdomain *
778 * Instruct the CM to force a wakeup transition on the specified
779 * clockdomain @clkdm. Returns -EINVAL if @clkdm is NULL or if the
780 * clockdomain does not support software-controlled wakeup; 0 upon
783 int clkdm_wakeup(struct clockdomain *clkdm)
791 if (!(clkdm->flags & CLKDM_CAN_FORCE_WAKEUP)) {
792 pr_debug("clockdomain: %s does not support forcing "
793 "wakeup via software\n", clkdm->name);
797 if (!arch_clkdm || !arch_clkdm->clkdm_wakeup)
800 pr_debug("clockdomain: forcing wakeup on %s\n", clkdm->name);
802 spin_lock_irqsave(&clkdm->lock, flags);
803 clkdm->_flags &= ~_CLKDM_FLAG_HWSUP_ENABLED;
804 ret = arch_clkdm->clkdm_wakeup(clkdm);
805 ret |= pwrdm_state_switch(clkdm->pwrdm.ptr);
806 spin_unlock_irqrestore(&clkdm->lock, flags);
811 * clkdm_allow_idle - enable hwsup idle transitions for clkdm
812 * @clkdm: struct clockdomain *
814 * Allow the hardware to automatically switch the clockdomain @clkdm into
815 * active or idle states, as needed by downstream clocks. If the
816 * clockdomain has any downstream clocks enabled in the clock
817 * framework, wkdep/sleepdep autodependencies are added; this is so
818 * device drivers can read and write to the device. No return value.
820 void clkdm_allow_idle(struct clockdomain *clkdm)
827 if (!(clkdm->flags & CLKDM_CAN_ENABLE_AUTO)) {
828 pr_debug("clock: automatic idle transitions cannot be enabled "
829 "on clockdomain %s\n", clkdm->name);
833 if (!arch_clkdm || !arch_clkdm->clkdm_allow_idle)
836 pr_debug("clockdomain: enabling automatic idle transitions for %s\n",
839 spin_lock_irqsave(&clkdm->lock, flags);
840 clkdm->_flags |= _CLKDM_FLAG_HWSUP_ENABLED;
841 arch_clkdm->clkdm_allow_idle(clkdm);
842 pwrdm_clkdm_state_switch(clkdm);
843 spin_unlock_irqrestore(&clkdm->lock, flags);
847 * clkdm_deny_idle - disable hwsup idle transitions for clkdm
848 * @clkdm: struct clockdomain *
850 * Prevent the hardware from automatically switching the clockdomain
851 * @clkdm into inactive or idle states. If the clockdomain has
852 * downstream clocks enabled in the clock framework, wkdep/sleepdep
853 * autodependencies are removed. No return value.
855 void clkdm_deny_idle(struct clockdomain *clkdm)
862 if (!(clkdm->flags & CLKDM_CAN_DISABLE_AUTO)) {
863 pr_debug("clockdomain: automatic idle transitions cannot be "
864 "disabled on %s\n", clkdm->name);
868 if (!arch_clkdm || !arch_clkdm->clkdm_deny_idle)
871 pr_debug("clockdomain: disabling automatic idle transitions for %s\n",
874 spin_lock_irqsave(&clkdm->lock, flags);
875 clkdm->_flags &= ~_CLKDM_FLAG_HWSUP_ENABLED;
876 arch_clkdm->clkdm_deny_idle(clkdm);
877 pwrdm_state_switch(clkdm->pwrdm.ptr);
878 spin_unlock_irqrestore(&clkdm->lock, flags);
882 * clkdm_in_hwsup - is clockdomain @clkdm have hardware-supervised idle enabled?
883 * @clkdm: struct clockdomain *
885 * Returns true if clockdomain @clkdm currently has
886 * hardware-supervised idle enabled, or false if it does not or if
887 * @clkdm is NULL. It is only valid to call this function after
888 * clkdm_init() has been called. This function does not actually read
889 * bits from the hardware; it instead tests an in-memory flag that is
890 * changed whenever the clockdomain code changes the auto-idle mode.
892 bool clkdm_in_hwsup(struct clockdomain *clkdm)
900 spin_lock_irqsave(&clkdm->lock, flags);
901 ret = (clkdm->_flags & _CLKDM_FLAG_HWSUP_ENABLED) ? true : false;
902 spin_unlock_irqrestore(&clkdm->lock, flags);
907 /* Clockdomain-to-clock/hwmod framework interface code */
909 static int _clkdm_clk_hwmod_enable(struct clockdomain *clkdm)
913 if (!clkdm || !arch_clkdm || !arch_clkdm->clkdm_clk_enable)
917 * For arch's with no autodeps, clkcm_clk_enable
918 * should be called for every clock instance or hwmod that is
919 * enabled, so the clkdm can be force woken up.
921 if ((atomic_inc_return(&clkdm->usecount) > 1) && autodeps)
924 spin_lock_irqsave(&clkdm->lock, flags);
925 arch_clkdm->clkdm_clk_enable(clkdm);
926 pwrdm_wait_transition(clkdm->pwrdm.ptr);
927 pwrdm_clkdm_state_switch(clkdm);
928 spin_unlock_irqrestore(&clkdm->lock, flags);
930 pr_debug("clockdomain: clkdm %s: enabled\n", clkdm->name);
935 static int _clkdm_clk_hwmod_disable(struct clockdomain *clkdm)
939 if (!clkdm || !arch_clkdm || !arch_clkdm->clkdm_clk_disable)
942 if (atomic_read(&clkdm->usecount) == 0) {
943 WARN_ON(1); /* underflow */
947 if (atomic_dec_return(&clkdm->usecount) > 0)
950 spin_lock_irqsave(&clkdm->lock, flags);
951 arch_clkdm->clkdm_clk_disable(clkdm);
952 pwrdm_clkdm_state_switch(clkdm);
953 spin_unlock_irqrestore(&clkdm->lock, flags);
955 pr_debug("clockdomain: clkdm %s: disabled\n", clkdm->name);
961 * clkdm_clk_enable - add an enabled downstream clock to this clkdm
962 * @clkdm: struct clockdomain *
963 * @clk: struct clk * of the enabled downstream clock
965 * Increment the usecount of the clockdomain @clkdm and ensure that it
966 * is awake before @clk is enabled. Intended to be called by
967 * clk_enable() code. If the clockdomain is in software-supervised
968 * idle mode, force the clockdomain to wake. If the clockdomain is in
969 * hardware-supervised idle mode, add clkdm-pwrdm autodependencies, to
970 * ensure that devices in the clockdomain can be read from/written to
971 * by on-chip processors. Returns -EINVAL if passed null pointers;
972 * returns 0 upon success or if the clockdomain is in hwsup idle mode.
974 int clkdm_clk_enable(struct clockdomain *clkdm, struct clk *clk)
977 * XXX Rewrite this code to maintain a list of enabled
978 * downstream clocks for debugging purposes?
984 return _clkdm_clk_hwmod_enable(clkdm);
988 * clkdm_clk_disable - remove an enabled downstream clock from this clkdm
989 * @clkdm: struct clockdomain *
990 * @clk: struct clk * of the disabled downstream clock
992 * Decrement the usecount of this clockdomain @clkdm when @clk is
993 * disabled. Intended to be called by clk_disable() code. If the
994 * clockdomain usecount goes to 0, put the clockdomain to sleep
995 * (software-supervised mode) or remove the clkdm autodependencies
996 * (hardware-supervised mode). Returns -EINVAL if passed null
997 * pointers; -ERANGE if the @clkdm usecount underflows; or returns 0
998 * upon success or if the clockdomain is in hwsup idle mode.
1000 int clkdm_clk_disable(struct clockdomain *clkdm, struct clk *clk)
1003 * XXX Rewrite this code to maintain a list of enabled
1004 * downstream clocks for debugging purposes?
1010 return _clkdm_clk_hwmod_disable(clkdm);
1014 * clkdm_hwmod_enable - add an enabled downstream hwmod to this clkdm
1015 * @clkdm: struct clockdomain *
1016 * @oh: struct omap_hwmod * of the enabled downstream hwmod
1018 * Increment the usecount of the clockdomain @clkdm and ensure that it
1019 * is awake before @oh is enabled. Intended to be called by
1020 * module_enable() code.
1021 * If the clockdomain is in software-supervised idle mode, force the
1022 * clockdomain to wake. If the clockdomain is in hardware-supervised idle
1023 * mode, add clkdm-pwrdm autodependencies, to ensure that devices in the
1024 * clockdomain can be read from/written to by on-chip processors.
1025 * Returns -EINVAL if passed null pointers;
1026 * returns 0 upon success or if the clockdomain is in hwsup idle mode.
1028 int clkdm_hwmod_enable(struct clockdomain *clkdm, struct omap_hwmod *oh)
1030 /* The clkdm attribute does not exist yet prior OMAP4 */
1031 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1035 * XXX Rewrite this code to maintain a list of enabled
1036 * downstream hwmods for debugging purposes?
1042 return _clkdm_clk_hwmod_enable(clkdm);
1046 * clkdm_hwmod_disable - remove an enabled downstream hwmod from this clkdm
1047 * @clkdm: struct clockdomain *
1048 * @oh: struct omap_hwmod * of the disabled downstream hwmod
1050 * Decrement the usecount of this clockdomain @clkdm when @oh is
1051 * disabled. Intended to be called by module_disable() code.
1052 * If the clockdomain usecount goes to 0, put the clockdomain to sleep
1053 * (software-supervised mode) or remove the clkdm autodependencies
1054 * (hardware-supervised mode).
1055 * Returns -EINVAL if passed null pointers; -ERANGE if the @clkdm usecount
1056 * underflows; or returns 0 upon success or if the clockdomain is in hwsup
1059 int clkdm_hwmod_disable(struct clockdomain *clkdm, struct omap_hwmod *oh)
1061 /* The clkdm attribute does not exist yet prior OMAP4 */
1062 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1066 * XXX Rewrite this code to maintain a list of enabled
1067 * downstream hwmods for debugging purposes?
1073 return _clkdm_clk_hwmod_disable(clkdm);