blob: 32dbcbc3ee6dbcb9b03cef615ca21e3cfa15eb1e [file] [log] [blame]
Paul Walmsleyd459bfe2008-08-19 11:08:43 +03001/*
Abhijit Pagare8a3ddc72010-01-26 20:12:54 -07002 * OMAP2/3/4 clockdomain framework functions
Paul Walmsleyd459bfe2008-08-19 11:08:43 +03003 *
Paul Walmsley32a363c2011-07-10 05:56:54 -06004 * Copyright (C) 2008-2011 Texas Instruments, Inc.
5 * Copyright (C) 2008-2011 Nokia Corporation
Paul Walmsleyd459bfe2008-08-19 11:08:43 +03006 *
7 * Written by Paul Walmsley and Jouni Högander
Abhijit Pagare8a3ddc72010-01-26 20:12:54 -07008 * Added OMAP4 specific support by Abhijit Pagare <abhijitpagare@ti.com>
Paul Walmsleyd459bfe2008-08-19 11:08:43 +03009 *
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.
13 */
Paul Walmsley33903eb2009-12-08 16:33:10 -070014#undef DEBUG
Paul Walmsleyd459bfe2008-08-19 11:08:43 +030015
Paul Walmsleyd459bfe2008-08-19 11:08:43 +030016#include <linux/kernel.h>
17#include <linux/device.h>
18#include <linux/list.h>
19#include <linux/errno.h>
Paul Gortmakerd44b28c2011-07-31 10:52:44 -040020#include <linux/string.h>
Paul Walmsleyd459bfe2008-08-19 11:08:43 +030021#include <linux/delay.h>
22#include <linux/clk.h>
23#include <linux/limits.h>
Paul Walmsley5b74c672009-02-03 02:10:03 -070024#include <linux/err.h>
Paul Walmsleyd459bfe2008-08-19 11:08:43 +030025
26#include <linux/io.h>
27
28#include <linux/bitops.h>
29
Paul Walmsleya135eaa2012-09-27 10:33:34 -060030#include "clock.h"
Paul Walmsley1540f2142010-12-21 21:05:15 -070031#include "clockdomain.h"
Paul Walmsleyd459bfe2008-08-19 11:08:43 +030032
33/* clkdm_list contains all registered struct clockdomains */
34static LIST_HEAD(clkdm_list);
35
Paul Walmsley55ed9692010-01-26 20:12:59 -070036/* array of clockdomain deps to be added/removed when clkdm in hwsup mode */
37static struct clkdm_autodep *autodeps;
Paul Walmsleyd459bfe2008-08-19 11:08:43 +030038
Rajendra Nayak32d40342011-02-25 16:06:47 -070039static struct clkdm_ops *arch_clkdm;
Paul Walmsleyd459bfe2008-08-19 11:08:43 +030040
41/* Private functions */
42
Paul Walmsley55ed9692010-01-26 20:12:59 -070043static struct clockdomain *_clkdm_lookup(const char *name)
44{
45 struct clockdomain *clkdm, *temp_clkdm;
46
47 if (!name)
48 return NULL;
49
50 clkdm = NULL;
51
52 list_for_each_entry(temp_clkdm, &clkdm_list, node) {
53 if (!strcmp(name, temp_clkdm->name)) {
54 clkdm = temp_clkdm;
55 break;
56 }
57 }
58
59 return clkdm;
60}
61
Paul Walmsleye909d62a82010-01-26 20:13:00 -070062/**
63 * _clkdm_register - register a clockdomain
64 * @clkdm: struct clockdomain * to register
65 *
66 * Adds a clockdomain to the internal clockdomain list.
67 * Returns -EINVAL if given a null pointer, -EEXIST if a clockdomain is
68 * already registered by the provided name, or 0 upon success.
69 */
70static int _clkdm_register(struct clockdomain *clkdm)
71{
72 struct powerdomain *pwrdm;
73
74 if (!clkdm || !clkdm->name)
75 return -EINVAL;
76
Paul Walmsleye909d62a82010-01-26 20:13:00 -070077 pwrdm = pwrdm_lookup(clkdm->pwrdm.name);
78 if (!pwrdm) {
79 pr_err("clockdomain: %s: powerdomain %s does not exist\n",
80 clkdm->name, clkdm->pwrdm.name);
81 return -EINVAL;
82 }
83 clkdm->pwrdm.ptr = pwrdm;
84
85 /* Verify that the clockdomain is not already registered */
86 if (_clkdm_lookup(clkdm->name))
87 return -EEXIST;
88
89 list_add(&clkdm->node, &clkdm_list);
90
91 pwrdm_add_clkdm(pwrdm, clkdm);
92
Rajendra Nayak555e74e2011-07-10 05:56:55 -060093 spin_lock_init(&clkdm->lock);
94
Paul Walmsleye909d62a82010-01-26 20:13:00 -070095 pr_debug("clockdomain: registered %s\n", clkdm->name);
96
97 return 0;
98}
99
Paul Walmsley55ed9692010-01-26 20:12:59 -0700100/* _clkdm_deps_lookup - look up the specified clockdomain in a clkdm list */
101static struct clkdm_dep *_clkdm_deps_lookup(struct clockdomain *clkdm,
102 struct clkdm_dep *deps)
103{
104 struct clkdm_dep *cd;
105
Paul Walmsleya5ffef62011-09-14 16:01:21 -0600106 if (!clkdm || !deps)
Paul Walmsley55ed9692010-01-26 20:12:59 -0700107 return ERR_PTR(-EINVAL);
108
109 for (cd = deps; cd->clkdm_name; cd++) {
Paul Walmsley55ed9692010-01-26 20:12:59 -0700110 if (!cd->clkdm && cd->clkdm_name)
111 cd->clkdm = _clkdm_lookup(cd->clkdm_name);
112
113 if (cd->clkdm == clkdm)
114 break;
Paul Walmsley55ed9692010-01-26 20:12:59 -0700115 }
116
117 if (!cd->clkdm_name)
118 return ERR_PTR(-ENOENT);
119
120 return cd;
121}
122
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300123/*
Paul Walmsley55ed9692010-01-26 20:12:59 -0700124 * _autodep_lookup - resolve autodep clkdm names to clkdm pointers; store
125 * @autodep: struct clkdm_autodep * to resolve
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300126 *
Paul Walmsley55ed9692010-01-26 20:12:59 -0700127 * Resolve autodep clockdomain names to clockdomain pointers via
128 * clkdm_lookup() and store the pointers in the autodep structure. An
129 * "autodep" is a clockdomain sleep/wakeup dependency that is
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300130 * automatically added and removed whenever clocks in the associated
131 * clockdomain are enabled or disabled (respectively) when the
132 * clockdomain is in hardware-supervised mode. Meant to be called
133 * once at clockdomain layer initialization, since these should remain
134 * fixed for a particular architecture. No return value.
Paul Walmsleyb170fbe2010-12-21 21:05:15 -0700135 *
136 * XXX autodeps are deprecated and should be removed at the earliest
137 * opportunity
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300138 */
Paul Walmsley55ed9692010-01-26 20:12:59 -0700139static void _autodep_lookup(struct clkdm_autodep *autodep)
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300140{
Paul Walmsley55ed9692010-01-26 20:12:59 -0700141 struct clockdomain *clkdm;
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300142
143 if (!autodep)
144 return;
145
Paul Walmsley55ed9692010-01-26 20:12:59 -0700146 clkdm = clkdm_lookup(autodep->clkdm.name);
147 if (!clkdm) {
148 pr_err("clockdomain: autodeps: clockdomain %s does not exist\n",
149 autodep->clkdm.name);
150 clkdm = ERR_PTR(-ENOENT);
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300151 }
Paul Walmsley55ed9692010-01-26 20:12:59 -0700152 autodep->clkdm.ptr = clkdm;
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300153}
154
155/*
156 * _clkdm_add_autodeps - add auto sleepdeps/wkdeps to clkdm upon clock enable
157 * @clkdm: struct clockdomain *
158 *
159 * Add the "autodep" sleep & wakeup dependencies to clockdomain 'clkdm'
160 * in hardware-supervised mode. Meant to be called from clock framework
161 * when a clock inside clockdomain 'clkdm' is enabled. No return value.
Paul Walmsleyb170fbe2010-12-21 21:05:15 -0700162 *
163 * XXX autodeps are deprecated and should be removed at the earliest
164 * opportunity
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300165 */
Rajendra Nayak5cd19372011-02-25 16:06:48 -0700166void _clkdm_add_autodeps(struct clockdomain *clkdm)
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300167{
Paul Walmsley55ed9692010-01-26 20:12:59 -0700168 struct clkdm_autodep *autodep;
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300169
Paul Walmsley570b54c2011-03-10 03:50:09 -0700170 if (!autodeps || clkdm->flags & CLKDM_NO_AUTODEPS)
Paul Walmsleyad956162010-02-22 22:09:35 -0700171 return;
172
Paul Walmsley55ed9692010-01-26 20:12:59 -0700173 for (autodep = autodeps; autodep->clkdm.ptr; autodep++) {
174 if (IS_ERR(autodep->clkdm.ptr))
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300175 continue;
176
Paul Walmsley7852ec02012-07-26 00:54:26 -0600177 pr_debug("clockdomain: %s: adding %s sleepdep/wkdep\n",
178 clkdm->name, autodep->clkdm.ptr->name);
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300179
Paul Walmsley55ed9692010-01-26 20:12:59 -0700180 clkdm_add_sleepdep(clkdm, autodep->clkdm.ptr);
181 clkdm_add_wkdep(clkdm, autodep->clkdm.ptr);
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300182 }
183}
184
185/*
186 * _clkdm_add_autodeps - remove auto sleepdeps/wkdeps from clkdm
187 * @clkdm: struct clockdomain *
188 *
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.
Paul Walmsleyb170fbe2010-12-21 21:05:15 -0700192 *
193 * XXX autodeps are deprecated and should be removed at the earliest
194 * opportunity
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300195 */
Rajendra Nayak5cd19372011-02-25 16:06:48 -0700196void _clkdm_del_autodeps(struct clockdomain *clkdm)
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300197{
Paul Walmsley55ed9692010-01-26 20:12:59 -0700198 struct clkdm_autodep *autodep;
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300199
Paul Walmsley570b54c2011-03-10 03:50:09 -0700200 if (!autodeps || clkdm->flags & CLKDM_NO_AUTODEPS)
Paul Walmsleyad956162010-02-22 22:09:35 -0700201 return;
202
Paul Walmsley55ed9692010-01-26 20:12:59 -0700203 for (autodep = autodeps; autodep->clkdm.ptr; autodep++) {
204 if (IS_ERR(autodep->clkdm.ptr))
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300205 continue;
206
Paul Walmsley7852ec02012-07-26 00:54:26 -0600207 pr_debug("clockdomain: %s: removing %s sleepdep/wkdep\n",
208 clkdm->name, autodep->clkdm.ptr->name);
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300209
Paul Walmsley55ed9692010-01-26 20:12:59 -0700210 clkdm_del_sleepdep(clkdm, autodep->clkdm.ptr);
211 clkdm_del_wkdep(clkdm, autodep->clkdm.ptr);
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300212 }
213}
214
Paul Walmsleyb170fbe2010-12-21 21:05:15 -0700215/**
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700216 * _resolve_clkdm_deps() - resolve clkdm_names in @clkdm_deps to clkdms
217 * @clkdm: clockdomain that we are resolving dependencies for
218 * @clkdm_deps: ptr to array of struct clkdm_deps to resolve
Kalle Jokiniemia0219fb2009-10-14 16:40:37 -0600219 *
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700220 * Iterates through @clkdm_deps, looking up the struct clockdomain named by
221 * clkdm_name and storing the clockdomain pointer in the struct clkdm_dep.
Paul Walmsleyb170fbe2010-12-21 21:05:15 -0700222 * No return value.
Paul Walmsleyb170fbe2010-12-21 21:05:15 -0700223 */
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700224static void _resolve_clkdm_deps(struct clockdomain *clkdm,
225 struct clkdm_dep *clkdm_deps)
Kalle Jokiniemia0219fb2009-10-14 16:40:37 -0600226{
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700227 struct clkdm_dep *cd;
228
229 for (cd = clkdm_deps; cd && cd->clkdm_name; cd++) {
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700230 if (cd->clkdm)
231 continue;
232 cd->clkdm = _clkdm_lookup(cd->clkdm_name);
233
234 WARN(!cd->clkdm, "clockdomain: %s: could not find clkdm %s while resolving dependencies - should never happen",
235 clkdm->name, cd->clkdm_name);
236 }
Kalle Jokiniemia0219fb2009-10-14 16:40:37 -0600237}
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300238
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300239/* Public functions */
240
241/**
Paul Walmsley08cb9702011-09-14 16:01:20 -0600242 * clkdm_register_platform_funcs - register clockdomain implementation fns
243 * @co: func pointers for arch specific implementations
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300244 *
Paul Walmsley08cb9702011-09-14 16:01:20 -0600245 * Register the list of function pointers used to implement the
246 * clockdomain functions on different OMAP SoCs. Should be called
247 * before any other clkdm_register*() function. Returns -EINVAL if
248 * @co is null, -EEXIST if platform functions have already been
249 * registered, or 0 upon success.
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300250 */
Paul Walmsley08cb9702011-09-14 16:01:20 -0600251int clkdm_register_platform_funcs(struct clkdm_ops *co)
252{
253 if (!co)
254 return -EINVAL;
255
256 if (arch_clkdm)
257 return -EEXIST;
258
259 arch_clkdm = co;
260
261 return 0;
262};
263
264/**
265 * clkdm_register_clkdms - register SoC clockdomains
266 * @cs: pointer to an array of struct clockdomain to register
267 *
268 * Register the clockdomains available on a particular OMAP SoC. Must
269 * be called after clkdm_register_platform_funcs(). May be called
270 * multiple times. Returns -EACCES if called before
271 * clkdm_register_platform_funcs(); -EINVAL if the argument @cs is
272 * null; or 0 upon success.
273 */
274int clkdm_register_clkdms(struct clockdomain **cs)
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300275{
276 struct clockdomain **c = NULL;
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300277
Paul Walmsley08cb9702011-09-14 16:01:20 -0600278 if (!arch_clkdm)
279 return -EACCES;
Rajendra Nayak32d40342011-02-25 16:06:47 -0700280
Paul Walmsley08cb9702011-09-14 16:01:20 -0600281 if (!cs)
282 return -EINVAL;
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300283
Paul Walmsley08cb9702011-09-14 16:01:20 -0600284 for (c = cs; *c; c++)
285 _clkdm_register(*c);
286
287 return 0;
288}
289
290/**
291 * clkdm_register_autodeps - register autodeps (if required)
292 * @ia: pointer to a static array of struct clkdm_autodep to register
293 *
294 * Register clockdomain "automatic dependencies." These are
295 * clockdomain wakeup and sleep dependencies that are automatically
296 * added whenever the first clock inside a clockdomain is enabled, and
297 * removed whenever the last clock inside a clockdomain is disabled.
298 * These are currently only used on OMAP3 devices, and are deprecated,
299 * since they waste energy. However, until the OMAP2/3 IP block
300 * enable/disable sequence can be converted to match the OMAP4
301 * sequence, they are needed.
302 *
303 * Must be called only after all of the SoC clockdomains are
304 * registered, since the function will resolve autodep clockdomain
305 * names into clockdomain pointers.
306 *
307 * The struct clkdm_autodep @ia array must be static, as this function
308 * does not copy the array elements.
309 *
310 * Returns -EACCES if called before any clockdomains have been
311 * registered, -EINVAL if called with a null @ia argument, -EEXIST if
312 * autodeps have already been registered, or 0 upon success.
313 */
314int clkdm_register_autodeps(struct clkdm_autodep *ia)
315{
316 struct clkdm_autodep *a = NULL;
317
318 if (list_empty(&clkdm_list))
319 return -EACCES;
320
321 if (!ia)
322 return -EINVAL;
323
Paul Walmsley55ed9692010-01-26 20:12:59 -0700324 if (autodeps)
Paul Walmsley08cb9702011-09-14 16:01:20 -0600325 return -EEXIST;
Paul Walmsley369d5612010-01-26 20:13:01 -0700326
Paul Walmsley08cb9702011-09-14 16:01:20 -0600327 autodeps = ia;
328 for (a = autodeps; a->clkdm.ptr; a++)
329 _autodep_lookup(a);
330
331 return 0;
332}
333
334/**
335 * clkdm_complete_init - set up the clockdomain layer
336 *
337 * Put all clockdomains into software-supervised mode; PM code should
338 * later enable hardware-supervised mode as appropriate. Must be
339 * called after clkdm_register_clkdms(). Returns -EACCES if called
340 * before clkdm_register_clkdms(), or 0 upon success.
341 */
342int clkdm_complete_init(void)
343{
344 struct clockdomain *clkdm;
345
346 if (list_empty(&clkdm_list))
347 return -EACCES;
348
Paul Walmsley369d5612010-01-26 20:13:01 -0700349 list_for_each_entry(clkdm, &clkdm_list, node) {
Paul Walmsley6f7f63c2010-09-14 15:56:53 -0600350 if (clkdm->flags & CLKDM_CAN_FORCE_WAKEUP)
Rajendra Nayak68b921a2011-02-25 16:06:47 -0700351 clkdm_wakeup(clkdm);
Paul Walmsley6f7f63c2010-09-14 15:56:53 -0600352 else if (clkdm->flags & CLKDM_CAN_DISABLE_AUTO)
Rajendra Nayak5cd19372011-02-25 16:06:48 -0700353 clkdm_deny_idle(clkdm);
Paul Walmsley6f7f63c2010-09-14 15:56:53 -0600354
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700355 _resolve_clkdm_deps(clkdm, clkdm->wkdep_srcs);
Paul Walmsley6f7f63c2010-09-14 15:56:53 -0600356 clkdm_clear_all_wkdeps(clkdm);
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700357
358 _resolve_clkdm_deps(clkdm, clkdm->sleepdep_srcs);
Paul Walmsley6f7f63c2010-09-14 15:56:53 -0600359 clkdm_clear_all_sleepdeps(clkdm);
Paul Walmsley369d5612010-01-26 20:13:01 -0700360 }
Paul Walmsley08cb9702011-09-14 16:01:20 -0600361
362 return 0;
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300363}
364
365/**
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300366 * clkdm_lookup - look up a clockdomain by name, return a pointer
367 * @name: name of clockdomain
368 *
Paul Walmsleyf0271d62010-01-26 20:13:02 -0700369 * Find a registered clockdomain by its name @name. Returns a pointer
370 * to the struct clockdomain if found, or NULL otherwise.
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300371 */
372struct clockdomain *clkdm_lookup(const char *name)
373{
374 struct clockdomain *clkdm, *temp_clkdm;
375
376 if (!name)
377 return NULL;
378
379 clkdm = NULL;
380
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300381 list_for_each_entry(temp_clkdm, &clkdm_list, node) {
382 if (!strcmp(name, temp_clkdm->name)) {
383 clkdm = temp_clkdm;
384 break;
385 }
386 }
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300387
388 return clkdm;
389}
390
391/**
392 * clkdm_for_each - call function on each registered clockdomain
393 * @fn: callback function *
394 *
Paul Walmsleyf0271d62010-01-26 20:13:02 -0700395 * Call the supplied function @fn for each registered clockdomain.
396 * The callback function @fn can return anything but 0 to bail
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300397 * out early from the iterator. The callback function is called with
398 * the clkdm_mutex held, so no clockdomain structure manipulation
399 * functions should be called from the callback, although hardware
400 * clockdomain control functions are fine. Returns the last return
401 * value of the callback function, which should be 0 for success or
402 * anything else to indicate failure; or -EINVAL if the function pointer
403 * is null.
404 */
Peter 'p2' De Schrijvera23456e2008-10-15 18:13:47 +0300405int clkdm_for_each(int (*fn)(struct clockdomain *clkdm, void *user),
406 void *user)
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300407{
408 struct clockdomain *clkdm;
409 int ret = 0;
410
411 if (!fn)
412 return -EINVAL;
413
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300414 list_for_each_entry(clkdm, &clkdm_list, node) {
Peter 'p2' De Schrijvera23456e2008-10-15 18:13:47 +0300415 ret = (*fn)(clkdm, user);
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300416 if (ret)
417 break;
418 }
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300419
420 return ret;
421}
422
423
Paul Walmsleye89087c2008-05-20 18:41:35 -0600424/**
425 * clkdm_get_pwrdm - return a ptr to the pwrdm that this clkdm resides in
426 * @clkdm: struct clockdomain *
427 *
428 * Return a pointer to the struct powerdomain that the specified clockdomain
Paul Walmsleyf0271d62010-01-26 20:13:02 -0700429 * @clkdm exists in, or returns NULL if @clkdm is NULL.
Paul Walmsleye89087c2008-05-20 18:41:35 -0600430 */
431struct powerdomain *clkdm_get_pwrdm(struct clockdomain *clkdm)
432{
433 if (!clkdm)
434 return NULL;
435
Paul Walmsley5b74c672009-02-03 02:10:03 -0700436 return clkdm->pwrdm.ptr;
Paul Walmsleye89087c2008-05-20 18:41:35 -0600437}
438
439
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300440/* Hardware clockdomain control */
441
442/**
Paul Walmsley55ed9692010-01-26 20:12:59 -0700443 * clkdm_add_wkdep - add a wakeup dependency from clkdm2 to clkdm1
444 * @clkdm1: wake this struct clockdomain * up (dependent)
445 * @clkdm2: when this struct clockdomain * wakes up (source)
446 *
447 * When the clockdomain represented by @clkdm2 wakes up, wake up
448 * @clkdm1. Implemented in hardware on the OMAP, this feature is
449 * designed to reduce wakeup latency of the dependent clockdomain @clkdm1.
450 * Returns -EINVAL if presented with invalid clockdomain pointers,
451 * -ENOENT if @clkdm2 cannot wake up clkdm1 in hardware, or 0 upon
452 * success.
453 */
454int clkdm_add_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2)
455{
456 struct clkdm_dep *cd;
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700457 int ret = 0;
Paul Walmsley56bc78d2011-01-17 13:28:17 -0700458
Paul Walmsley55ed9692010-01-26 20:12:59 -0700459 if (!clkdm1 || !clkdm2)
460 return -EINVAL;
461
462 cd = _clkdm_deps_lookup(clkdm2, clkdm1->wkdep_srcs);
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700463 if (IS_ERR(cd))
464 ret = PTR_ERR(cd);
465
466 if (!arch_clkdm || !arch_clkdm->clkdm_add_wkdep)
467 ret = -EINVAL;
468
469 if (ret) {
Paul Walmsley7852ec02012-07-26 00:54:26 -0600470 pr_debug("clockdomain: hardware cannot set/clear wake up of %s when %s wakes up\n",
471 clkdm1->name, clkdm2->name);
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700472 return ret;
Paul Walmsley55ed9692010-01-26 20:12:59 -0700473 }
474
Paul Walmsley369d5612010-01-26 20:13:01 -0700475 if (atomic_inc_return(&cd->wkdep_usecount) == 1) {
Paul Walmsley7852ec02012-07-26 00:54:26 -0600476 pr_debug("clockdomain: hardware will wake up %s when %s wakes up\n",
477 clkdm1->name, clkdm2->name);
Paul Walmsley55ed9692010-01-26 20:12:59 -0700478
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700479 ret = arch_clkdm->clkdm_add_wkdep(clkdm1, clkdm2);
Paul Walmsley369d5612010-01-26 20:13:01 -0700480 }
Paul Walmsley55ed9692010-01-26 20:12:59 -0700481
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700482 return ret;
Paul Walmsley55ed9692010-01-26 20:12:59 -0700483}
484
485/**
486 * clkdm_del_wkdep - remove a wakeup dependency from clkdm2 to clkdm1
487 * @clkdm1: wake this struct clockdomain * up (dependent)
488 * @clkdm2: when this struct clockdomain * wakes up (source)
489 *
490 * Remove a wakeup dependency causing @clkdm1 to wake up when @clkdm2
491 * wakes up. Returns -EINVAL if presented with invalid clockdomain
492 * pointers, -ENOENT if @clkdm2 cannot wake up clkdm1 in hardware, or
493 * 0 upon success.
494 */
495int clkdm_del_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2)
496{
497 struct clkdm_dep *cd;
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700498 int ret = 0;
Paul Walmsley56bc78d2011-01-17 13:28:17 -0700499
Paul Walmsley55ed9692010-01-26 20:12:59 -0700500 if (!clkdm1 || !clkdm2)
501 return -EINVAL;
502
503 cd = _clkdm_deps_lookup(clkdm2, clkdm1->wkdep_srcs);
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700504 if (IS_ERR(cd))
505 ret = PTR_ERR(cd);
506
507 if (!arch_clkdm || !arch_clkdm->clkdm_del_wkdep)
508 ret = -EINVAL;
509
510 if (ret) {
Paul Walmsley7852ec02012-07-26 00:54:26 -0600511 pr_debug("clockdomain: hardware cannot set/clear wake up of %s when %s wakes up\n",
512 clkdm1->name, clkdm2->name);
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700513 return ret;
Paul Walmsley55ed9692010-01-26 20:12:59 -0700514 }
515
Paul Walmsley369d5612010-01-26 20:13:01 -0700516 if (atomic_dec_return(&cd->wkdep_usecount) == 0) {
Paul Walmsley7852ec02012-07-26 00:54:26 -0600517 pr_debug("clockdomain: hardware will no longer wake up %s after %s wakes up\n",
518 clkdm1->name, clkdm2->name);
Paul Walmsley55ed9692010-01-26 20:12:59 -0700519
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700520 ret = arch_clkdm->clkdm_del_wkdep(clkdm1, clkdm2);
Paul Walmsley369d5612010-01-26 20:13:01 -0700521 }
Paul Walmsley55ed9692010-01-26 20:12:59 -0700522
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700523 return ret;
Paul Walmsley55ed9692010-01-26 20:12:59 -0700524}
525
526/**
527 * clkdm_read_wkdep - read wakeup dependency state from clkdm2 to clkdm1
528 * @clkdm1: wake this struct clockdomain * up (dependent)
529 * @clkdm2: when this struct clockdomain * wakes up (source)
530 *
531 * Return 1 if a hardware wakeup dependency exists wherein @clkdm1 will be
532 * awoken when @clkdm2 wakes up; 0 if dependency is not set; -EINVAL
533 * if either clockdomain pointer is invalid; or -ENOENT if the hardware
534 * is incapable.
535 *
536 * REVISIT: Currently this function only represents software-controllable
537 * wakeup dependencies. Wakeup dependencies fixed in hardware are not
538 * yet handled here.
539 */
540int clkdm_read_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2)
541{
542 struct clkdm_dep *cd;
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700543 int ret = 0;
Paul Walmsley55ed9692010-01-26 20:12:59 -0700544
545 if (!clkdm1 || !clkdm2)
546 return -EINVAL;
547
548 cd = _clkdm_deps_lookup(clkdm2, clkdm1->wkdep_srcs);
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700549 if (IS_ERR(cd))
550 ret = PTR_ERR(cd);
551
552 if (!arch_clkdm || !arch_clkdm->clkdm_read_wkdep)
553 ret = -EINVAL;
554
555 if (ret) {
Paul Walmsley7852ec02012-07-26 00:54:26 -0600556 pr_debug("clockdomain: hardware cannot set/clear wake up of %s when %s wakes up\n",
557 clkdm1->name, clkdm2->name);
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700558 return ret;
Paul Walmsley55ed9692010-01-26 20:12:59 -0700559 }
560
Paul Walmsley369d5612010-01-26 20:13:01 -0700561 /* XXX It's faster to return the atomic wkdep_usecount */
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700562 return arch_clkdm->clkdm_read_wkdep(clkdm1, clkdm2);
Paul Walmsley55ed9692010-01-26 20:12:59 -0700563}
564
565/**
Paul Walmsley369d5612010-01-26 20:13:01 -0700566 * clkdm_clear_all_wkdeps - remove all wakeup dependencies from target clkdm
567 * @clkdm: struct clockdomain * to remove all wakeup dependencies from
568 *
569 * Remove all inter-clockdomain wakeup dependencies that could cause
570 * @clkdm to wake. Intended to be used during boot to initialize the
571 * PRCM to a known state, after all clockdomains are put into swsup idle
572 * and woken up. Returns -EINVAL if @clkdm pointer is invalid, or
573 * 0 upon success.
574 */
575int clkdm_clear_all_wkdeps(struct clockdomain *clkdm)
576{
Paul Walmsley369d5612010-01-26 20:13:01 -0700577 if (!clkdm)
578 return -EINVAL;
579
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700580 if (!arch_clkdm || !arch_clkdm->clkdm_clear_all_wkdeps)
581 return -EINVAL;
Paul Walmsley369d5612010-01-26 20:13:01 -0700582
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700583 return arch_clkdm->clkdm_clear_all_wkdeps(clkdm);
Paul Walmsley369d5612010-01-26 20:13:01 -0700584}
585
586/**
Paul Walmsley55ed9692010-01-26 20:12:59 -0700587 * clkdm_add_sleepdep - add a sleep dependency from clkdm2 to clkdm1
588 * @clkdm1: prevent this struct clockdomain * from sleeping (dependent)
589 * @clkdm2: when this struct clockdomain * is active (source)
590 *
591 * Prevent @clkdm1 from automatically going inactive (and then to
592 * retention or off) if @clkdm2 is active. Returns -EINVAL if
593 * presented with invalid clockdomain pointers or called on a machine
594 * that does not support software-configurable hardware sleep
595 * dependencies, -ENOENT if the specified dependency cannot be set in
596 * hardware, or 0 upon success.
597 */
598int clkdm_add_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2)
599{
600 struct clkdm_dep *cd;
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700601 int ret = 0;
Paul Walmsley55ed9692010-01-26 20:12:59 -0700602
603 if (!clkdm1 || !clkdm2)
604 return -EINVAL;
605
606 cd = _clkdm_deps_lookup(clkdm2, clkdm1->sleepdep_srcs);
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700607 if (IS_ERR(cd))
608 ret = PTR_ERR(cd);
609
610 if (!arch_clkdm || !arch_clkdm->clkdm_add_sleepdep)
611 ret = -EINVAL;
612
613 if (ret) {
Paul Walmsley7852ec02012-07-26 00:54:26 -0600614 pr_debug("clockdomain: hardware cannot set/clear sleep dependency affecting %s from %s\n",
615 clkdm1->name, clkdm2->name);
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700616 return ret;
Paul Walmsley55ed9692010-01-26 20:12:59 -0700617 }
618
Paul Walmsley369d5612010-01-26 20:13:01 -0700619 if (atomic_inc_return(&cd->sleepdep_usecount) == 1) {
Paul Walmsley7852ec02012-07-26 00:54:26 -0600620 pr_debug("clockdomain: will prevent %s from sleeping if %s is active\n",
621 clkdm1->name, clkdm2->name);
Paul Walmsley55ed9692010-01-26 20:12:59 -0700622
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700623 ret = arch_clkdm->clkdm_add_sleepdep(clkdm1, clkdm2);
Paul Walmsley369d5612010-01-26 20:13:01 -0700624 }
Paul Walmsley55ed9692010-01-26 20:12:59 -0700625
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700626 return ret;
Paul Walmsley55ed9692010-01-26 20:12:59 -0700627}
628
629/**
630 * clkdm_del_sleepdep - remove a sleep dependency from clkdm2 to clkdm1
631 * @clkdm1: prevent this struct clockdomain * from sleeping (dependent)
632 * @clkdm2: when this struct clockdomain * is active (source)
633 *
634 * Allow @clkdm1 to automatically go inactive (and then to retention or
635 * off), independent of the activity state of @clkdm2. Returns -EINVAL
636 * if presented with invalid clockdomain pointers or called on a machine
637 * that does not support software-configurable hardware sleep dependencies,
638 * -ENOENT if the specified dependency cannot be cleared in hardware, or
639 * 0 upon success.
640 */
641int clkdm_del_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2)
642{
643 struct clkdm_dep *cd;
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700644 int ret = 0;
Paul Walmsley55ed9692010-01-26 20:12:59 -0700645
646 if (!clkdm1 || !clkdm2)
647 return -EINVAL;
648
649 cd = _clkdm_deps_lookup(clkdm2, clkdm1->sleepdep_srcs);
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700650 if (IS_ERR(cd))
651 ret = PTR_ERR(cd);
652
653 if (!arch_clkdm || !arch_clkdm->clkdm_del_sleepdep)
654 ret = -EINVAL;
655
656 if (ret) {
Paul Walmsley7852ec02012-07-26 00:54:26 -0600657 pr_debug("clockdomain: hardware cannot set/clear sleep dependency affecting %s from %s\n",
658 clkdm1->name, clkdm2->name);
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700659 return ret;
Paul Walmsley55ed9692010-01-26 20:12:59 -0700660 }
661
Paul Walmsley369d5612010-01-26 20:13:01 -0700662 if (atomic_dec_return(&cd->sleepdep_usecount) == 0) {
Paul Walmsley7852ec02012-07-26 00:54:26 -0600663 pr_debug("clockdomain: will no longer prevent %s from sleeping if %s is active\n",
664 clkdm1->name, clkdm2->name);
Paul Walmsley55ed9692010-01-26 20:12:59 -0700665
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700666 ret = arch_clkdm->clkdm_del_sleepdep(clkdm1, clkdm2);
Paul Walmsley369d5612010-01-26 20:13:01 -0700667 }
Paul Walmsley55ed9692010-01-26 20:12:59 -0700668
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700669 return ret;
Paul Walmsley55ed9692010-01-26 20:12:59 -0700670}
671
672/**
673 * clkdm_read_sleepdep - read sleep dependency state from clkdm2 to clkdm1
674 * @clkdm1: prevent this struct clockdomain * from sleeping (dependent)
675 * @clkdm2: when this struct clockdomain * is active (source)
676 *
677 * Return 1 if a hardware sleep dependency exists wherein @clkdm1 will
678 * not be allowed to automatically go inactive if @clkdm2 is active;
679 * 0 if @clkdm1's automatic power state inactivity transition is independent
680 * of @clkdm2's; -EINVAL if either clockdomain pointer is invalid or called
681 * on a machine that does not support software-configurable hardware sleep
682 * dependencies; or -ENOENT if the hardware is incapable.
683 *
684 * REVISIT: Currently this function only represents software-controllable
685 * sleep dependencies. Sleep dependencies fixed in hardware are not
686 * yet handled here.
687 */
688int clkdm_read_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2)
689{
690 struct clkdm_dep *cd;
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700691 int ret = 0;
Paul Walmsley55ed9692010-01-26 20:12:59 -0700692
693 if (!clkdm1 || !clkdm2)
694 return -EINVAL;
695
696 cd = _clkdm_deps_lookup(clkdm2, clkdm1->sleepdep_srcs);
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700697 if (IS_ERR(cd))
698 ret = PTR_ERR(cd);
699
700 if (!arch_clkdm || !arch_clkdm->clkdm_read_sleepdep)
701 ret = -EINVAL;
702
703 if (ret) {
Paul Walmsley7852ec02012-07-26 00:54:26 -0600704 pr_debug("clockdomain: hardware cannot set/clear sleep dependency affecting %s from %s\n",
705 clkdm1->name, clkdm2->name);
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700706 return ret;
Paul Walmsley55ed9692010-01-26 20:12:59 -0700707 }
708
Paul Walmsley369d5612010-01-26 20:13:01 -0700709 /* XXX It's faster to return the atomic sleepdep_usecount */
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700710 return arch_clkdm->clkdm_read_sleepdep(clkdm1, clkdm2);
Paul Walmsley55ed9692010-01-26 20:12:59 -0700711}
712
Paul Walmsley369d5612010-01-26 20:13:01 -0700713/**
714 * clkdm_clear_all_sleepdeps - remove all sleep dependencies from target clkdm
715 * @clkdm: struct clockdomain * to remove all sleep dependencies from
716 *
717 * Remove all inter-clockdomain sleep dependencies that could prevent
718 * @clkdm from idling. Intended to be used during boot to initialize the
719 * PRCM to a known state, after all clockdomains are put into swsup idle
720 * and woken up. Returns -EINVAL if @clkdm pointer is invalid, or
721 * 0 upon success.
722 */
723int clkdm_clear_all_sleepdeps(struct clockdomain *clkdm)
724{
Paul Walmsley369d5612010-01-26 20:13:01 -0700725 if (!clkdm)
726 return -EINVAL;
727
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700728 if (!arch_clkdm || !arch_clkdm->clkdm_clear_all_sleepdeps)
729 return -EINVAL;
Paul Walmsley369d5612010-01-26 20:13:01 -0700730
Rajendra Nayak4aef7a22011-02-25 16:06:47 -0700731 return arch_clkdm->clkdm_clear_all_sleepdeps(clkdm);
Paul Walmsley369d5612010-01-26 20:13:01 -0700732}
Paul Walmsley55ed9692010-01-26 20:12:59 -0700733
734/**
Rajendra Nayak68b921a2011-02-25 16:06:47 -0700735 * clkdm_sleep - force clockdomain sleep transition
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300736 * @clkdm: struct clockdomain *
737 *
738 * Instruct the CM to force a sleep transition on the specified
Paul Walmsleyf0271d62010-01-26 20:13:02 -0700739 * clockdomain @clkdm. Returns -EINVAL if @clkdm is NULL or if
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300740 * clockdomain does not support software-initiated sleep; 0 upon
741 * success.
742 */
Rajendra Nayak68b921a2011-02-25 16:06:47 -0700743int clkdm_sleep(struct clockdomain *clkdm)
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300744{
Rajendra Nayak555e74e2011-07-10 05:56:55 -0600745 int ret;
746 unsigned long flags;
747
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300748 if (!clkdm)
749 return -EINVAL;
750
751 if (!(clkdm->flags & CLKDM_CAN_FORCE_SLEEP)) {
Paul Walmsley7852ec02012-07-26 00:54:26 -0600752 pr_debug("clockdomain: %s does not support forcing sleep via software\n",
753 clkdm->name);
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300754 return -EINVAL;
755 }
756
Rajendra Nayak68b921a2011-02-25 16:06:47 -0700757 if (!arch_clkdm || !arch_clkdm->clkdm_sleep)
758 return -EINVAL;
759
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300760 pr_debug("clockdomain: forcing sleep on %s\n", clkdm->name);
761
Rajendra Nayak555e74e2011-07-10 05:56:55 -0600762 spin_lock_irqsave(&clkdm->lock, flags);
Paul Walmsley32a363c2011-07-10 05:56:54 -0600763 clkdm->_flags &= ~_CLKDM_FLAG_HWSUP_ENABLED;
Rajendra Nayak555e74e2011-07-10 05:56:55 -0600764 ret = arch_clkdm->clkdm_sleep(clkdm);
765 spin_unlock_irqrestore(&clkdm->lock, flags);
766 return ret;
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300767}
768
769/**
Rajendra Nayak68b921a2011-02-25 16:06:47 -0700770 * clkdm_wakeup - force clockdomain wakeup transition
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300771 * @clkdm: struct clockdomain *
772 *
773 * Instruct the CM to force a wakeup transition on the specified
Paul Walmsleyf0271d62010-01-26 20:13:02 -0700774 * clockdomain @clkdm. Returns -EINVAL if @clkdm is NULL or if the
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300775 * clockdomain does not support software-controlled wakeup; 0 upon
776 * success.
777 */
Rajendra Nayak68b921a2011-02-25 16:06:47 -0700778int clkdm_wakeup(struct clockdomain *clkdm)
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300779{
Rajendra Nayak555e74e2011-07-10 05:56:55 -0600780 int ret;
781 unsigned long flags;
782
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300783 if (!clkdm)
784 return -EINVAL;
785
786 if (!(clkdm->flags & CLKDM_CAN_FORCE_WAKEUP)) {
Paul Walmsley7852ec02012-07-26 00:54:26 -0600787 pr_debug("clockdomain: %s does not support forcing wakeup via software\n",
788 clkdm->name);
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300789 return -EINVAL;
790 }
791
Rajendra Nayak68b921a2011-02-25 16:06:47 -0700792 if (!arch_clkdm || !arch_clkdm->clkdm_wakeup)
793 return -EINVAL;
794
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300795 pr_debug("clockdomain: forcing wakeup on %s\n", clkdm->name);
796
Rajendra Nayak555e74e2011-07-10 05:56:55 -0600797 spin_lock_irqsave(&clkdm->lock, flags);
Paul Walmsley32a363c2011-07-10 05:56:54 -0600798 clkdm->_flags &= ~_CLKDM_FLAG_HWSUP_ENABLED;
Rajendra Nayak555e74e2011-07-10 05:56:55 -0600799 ret = arch_clkdm->clkdm_wakeup(clkdm);
Santosh Shilimkarb1cbdb02011-08-19 16:59:39 -0600800 ret |= pwrdm_state_switch(clkdm->pwrdm.ptr);
Rajendra Nayak555e74e2011-07-10 05:56:55 -0600801 spin_unlock_irqrestore(&clkdm->lock, flags);
802 return ret;
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300803}
804
805/**
Rajendra Nayak5cd19372011-02-25 16:06:48 -0700806 * clkdm_allow_idle - enable hwsup idle transitions for clkdm
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300807 * @clkdm: struct clockdomain *
808 *
Paul Walmsleyf0271d62010-01-26 20:13:02 -0700809 * Allow the hardware to automatically switch the clockdomain @clkdm into
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300810 * active or idle states, as needed by downstream clocks. If the
811 * clockdomain has any downstream clocks enabled in the clock
812 * framework, wkdep/sleepdep autodependencies are added; this is so
813 * device drivers can read and write to the device. No return value.
814 */
Rajendra Nayak5cd19372011-02-25 16:06:48 -0700815void clkdm_allow_idle(struct clockdomain *clkdm)
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300816{
Rajendra Nayak555e74e2011-07-10 05:56:55 -0600817 unsigned long flags;
818
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300819 if (!clkdm)
820 return;
821
822 if (!(clkdm->flags & CLKDM_CAN_ENABLE_AUTO)) {
Paul Walmsley7852ec02012-07-26 00:54:26 -0600823 pr_debug("clock: %s: automatic idle transitions cannot be enabled\n",
824 clkdm->name);
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300825 return;
826 }
827
Rajendra Nayak5cd19372011-02-25 16:06:48 -0700828 if (!arch_clkdm || !arch_clkdm->clkdm_allow_idle)
829 return;
830
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300831 pr_debug("clockdomain: enabling automatic idle transitions for %s\n",
832 clkdm->name);
833
Rajendra Nayak555e74e2011-07-10 05:56:55 -0600834 spin_lock_irqsave(&clkdm->lock, flags);
Paul Walmsley32a363c2011-07-10 05:56:54 -0600835 clkdm->_flags |= _CLKDM_FLAG_HWSUP_ENABLED;
Rajendra Nayak5cd19372011-02-25 16:06:48 -0700836 arch_clkdm->clkdm_allow_idle(clkdm);
Santosh Shilimkar5a68a732012-05-07 23:55:38 -0600837 pwrdm_state_switch(clkdm->pwrdm.ptr);
Rajendra Nayak555e74e2011-07-10 05:56:55 -0600838 spin_unlock_irqrestore(&clkdm->lock, flags);
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300839}
840
841/**
Rajendra Nayak5cd19372011-02-25 16:06:48 -0700842 * clkdm_deny_idle - disable hwsup idle transitions for clkdm
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300843 * @clkdm: struct clockdomain *
844 *
845 * Prevent the hardware from automatically switching the clockdomain
Paul Walmsleyf0271d62010-01-26 20:13:02 -0700846 * @clkdm into inactive or idle states. If the clockdomain has
847 * downstream clocks enabled in the clock framework, wkdep/sleepdep
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300848 * autodependencies are removed. No return value.
849 */
Rajendra Nayak5cd19372011-02-25 16:06:48 -0700850void clkdm_deny_idle(struct clockdomain *clkdm)
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300851{
Rajendra Nayak555e74e2011-07-10 05:56:55 -0600852 unsigned long flags;
853
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300854 if (!clkdm)
855 return;
856
857 if (!(clkdm->flags & CLKDM_CAN_DISABLE_AUTO)) {
Paul Walmsley7852ec02012-07-26 00:54:26 -0600858 pr_debug("clockdomain: %s: automatic idle transitions cannot be disabled\n",
859 clkdm->name);
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300860 return;
861 }
862
Rajendra Nayak5cd19372011-02-25 16:06:48 -0700863 if (!arch_clkdm || !arch_clkdm->clkdm_deny_idle)
864 return;
865
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300866 pr_debug("clockdomain: disabling automatic idle transitions for %s\n",
867 clkdm->name);
868
Rajendra Nayak555e74e2011-07-10 05:56:55 -0600869 spin_lock_irqsave(&clkdm->lock, flags);
Paul Walmsley32a363c2011-07-10 05:56:54 -0600870 clkdm->_flags &= ~_CLKDM_FLAG_HWSUP_ENABLED;
Rajendra Nayak5cd19372011-02-25 16:06:48 -0700871 arch_clkdm->clkdm_deny_idle(clkdm);
Santosh Shilimkarb1cbdb02011-08-19 16:59:39 -0600872 pwrdm_state_switch(clkdm->pwrdm.ptr);
Rajendra Nayak555e74e2011-07-10 05:56:55 -0600873 spin_unlock_irqrestore(&clkdm->lock, flags);
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300874}
875
Paul Walmsley32a363c2011-07-10 05:56:54 -0600876/**
877 * clkdm_in_hwsup - is clockdomain @clkdm have hardware-supervised idle enabled?
878 * @clkdm: struct clockdomain *
879 *
880 * Returns true if clockdomain @clkdm currently has
881 * hardware-supervised idle enabled, or false if it does not or if
882 * @clkdm is NULL. It is only valid to call this function after
883 * clkdm_init() has been called. This function does not actually read
884 * bits from the hardware; it instead tests an in-memory flag that is
885 * changed whenever the clockdomain code changes the auto-idle mode.
886 */
887bool clkdm_in_hwsup(struct clockdomain *clkdm)
888{
Rajendra Nayak555e74e2011-07-10 05:56:55 -0600889 bool ret;
890 unsigned long flags;
891
Paul Walmsley32a363c2011-07-10 05:56:54 -0600892 if (!clkdm)
893 return false;
894
Rajendra Nayak555e74e2011-07-10 05:56:55 -0600895 spin_lock_irqsave(&clkdm->lock, flags);
896 ret = (clkdm->_flags & _CLKDM_FLAG_HWSUP_ENABLED) ? true : false;
897 spin_unlock_irqrestore(&clkdm->lock, flags);
898
899 return ret;
Paul Walmsley32a363c2011-07-10 05:56:54 -0600900}
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300901
Paul Walmsleyb71c7212012-09-23 17:28:28 -0600902/**
903 * clkdm_missing_idle_reporting - can @clkdm enter autoidle even if in use?
904 * @clkdm: struct clockdomain *
905 *
906 * Returns true if clockdomain @clkdm has the
907 * CLKDM_MISSING_IDLE_REPORTING flag set, or false if not or @clkdm is
908 * null. More information is available in the documentation for the
909 * CLKDM_MISSING_IDLE_REPORTING macro.
910 */
911bool clkdm_missing_idle_reporting(struct clockdomain *clkdm)
912{
913 if (!clkdm)
914 return false;
915
916 return (clkdm->flags & CLKDM_MISSING_IDLE_REPORTING) ? true : false;
917}
918
Benoit Cousson113a7412011-07-10 05:56:54 -0600919/* Clockdomain-to-clock/hwmod framework interface code */
920
921static int _clkdm_clk_hwmod_enable(struct clockdomain *clkdm)
922{
Rajendra Nayak555e74e2011-07-10 05:56:55 -0600923 unsigned long flags;
924
Benoit Cousson113a7412011-07-10 05:56:54 -0600925 if (!clkdm || !arch_clkdm || !arch_clkdm->clkdm_clk_enable)
926 return -EINVAL;
927
928 /*
929 * For arch's with no autodeps, clkcm_clk_enable
930 * should be called for every clock instance or hwmod that is
931 * enabled, so the clkdm can be force woken up.
932 */
933 if ((atomic_inc_return(&clkdm->usecount) > 1) && autodeps)
934 return 0;
935
Rajendra Nayak555e74e2011-07-10 05:56:55 -0600936 spin_lock_irqsave(&clkdm->lock, flags);
Benoit Cousson113a7412011-07-10 05:56:54 -0600937 arch_clkdm->clkdm_clk_enable(clkdm);
Santosh Shilimkar5a68a732012-05-07 23:55:38 -0600938 pwrdm_state_switch(clkdm->pwrdm.ptr);
Rajendra Nayak555e74e2011-07-10 05:56:55 -0600939 spin_unlock_irqrestore(&clkdm->lock, flags);
Benoit Cousson113a7412011-07-10 05:56:54 -0600940
Paul Walmsley7852ec02012-07-26 00:54:26 -0600941 pr_debug("clockdomain: %s: enabled\n", clkdm->name);
Benoit Cousson113a7412011-07-10 05:56:54 -0600942
943 return 0;
944}
945
946static int _clkdm_clk_hwmod_disable(struct clockdomain *clkdm)
947{
Rajendra Nayak555e74e2011-07-10 05:56:55 -0600948 unsigned long flags;
949
Benoit Cousson113a7412011-07-10 05:56:54 -0600950 if (!clkdm || !arch_clkdm || !arch_clkdm->clkdm_clk_disable)
951 return -EINVAL;
952
953 if (atomic_read(&clkdm->usecount) == 0) {
954 WARN_ON(1); /* underflow */
955 return -ERANGE;
956 }
957
958 if (atomic_dec_return(&clkdm->usecount) > 0)
959 return 0;
960
Rajendra Nayak555e74e2011-07-10 05:56:55 -0600961 spin_lock_irqsave(&clkdm->lock, flags);
Benoit Cousson113a7412011-07-10 05:56:54 -0600962 arch_clkdm->clkdm_clk_disable(clkdm);
Santosh Shilimkar5a68a732012-05-07 23:55:38 -0600963 pwrdm_state_switch(clkdm->pwrdm.ptr);
Rajendra Nayak555e74e2011-07-10 05:56:55 -0600964 spin_unlock_irqrestore(&clkdm->lock, flags);
Benoit Cousson113a7412011-07-10 05:56:54 -0600965
Paul Walmsley7852ec02012-07-26 00:54:26 -0600966 pr_debug("clockdomain: %s: disabled\n", clkdm->name);
Benoit Cousson113a7412011-07-10 05:56:54 -0600967
968 return 0;
969}
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300970
971/**
Rajendra Nayak4da71ae2011-02-25 16:06:48 -0700972 * clkdm_clk_enable - add an enabled downstream clock to this clkdm
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300973 * @clkdm: struct clockdomain *
974 * @clk: struct clk * of the enabled downstream clock
975 *
Paul Walmsleyf0271d62010-01-26 20:13:02 -0700976 * Increment the usecount of the clockdomain @clkdm and ensure that it
977 * is awake before @clk is enabled. Intended to be called by
978 * clk_enable() code. If the clockdomain is in software-supervised
979 * idle mode, force the clockdomain to wake. If the clockdomain is in
980 * hardware-supervised idle mode, add clkdm-pwrdm autodependencies, to
981 * ensure that devices in the clockdomain can be read from/written to
982 * by on-chip processors. Returns -EINVAL if passed null pointers;
983 * returns 0 upon success or if the clockdomain is in hwsup idle mode.
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300984 */
Rajendra Nayak4da71ae2011-02-25 16:06:48 -0700985int clkdm_clk_enable(struct clockdomain *clkdm, struct clk *clk)
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300986{
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300987 /*
988 * XXX Rewrite this code to maintain a list of enabled
989 * downstream clocks for debugging purposes?
990 */
991
Benoit Cousson113a7412011-07-10 05:56:54 -0600992 if (!clk)
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300993 return -EINVAL;
994
Benoit Cousson113a7412011-07-10 05:56:54 -0600995 return _clkdm_clk_hwmod_enable(clkdm);
Paul Walmsleyd459bfe2008-08-19 11:08:43 +0300996}
997
998/**
Rajendra Nayak4da71ae2011-02-25 16:06:48 -0700999 * clkdm_clk_disable - remove an enabled downstream clock from this clkdm
Paul Walmsleyd459bfe2008-08-19 11:08:43 +03001000 * @clkdm: struct clockdomain *
1001 * @clk: struct clk * of the disabled downstream clock
1002 *
Paul Walmsleyf0271d62010-01-26 20:13:02 -07001003 * Decrement the usecount of this clockdomain @clkdm when @clk is
1004 * disabled. Intended to be called by clk_disable() code. If the
1005 * clockdomain usecount goes to 0, put the clockdomain to sleep
1006 * (software-supervised mode) or remove the clkdm autodependencies
1007 * (hardware-supervised mode). Returns -EINVAL if passed null
Benoit Cousson113a7412011-07-10 05:56:54 -06001008 * pointers; -ERANGE if the @clkdm usecount underflows; or returns 0
1009 * upon success or if the clockdomain is in hwsup idle mode.
Paul Walmsleyd459bfe2008-08-19 11:08:43 +03001010 */
Rajendra Nayak4da71ae2011-02-25 16:06:48 -07001011int clkdm_clk_disable(struct clockdomain *clkdm, struct clk *clk)
Paul Walmsleyd459bfe2008-08-19 11:08:43 +03001012{
Paul Walmsleyd459bfe2008-08-19 11:08:43 +03001013 /*
1014 * XXX Rewrite this code to maintain a list of enabled
1015 * downstream clocks for debugging purposes?
1016 */
1017
Benoit Cousson113a7412011-07-10 05:56:54 -06001018 if (!clk)
Paul Walmsleyd459bfe2008-08-19 11:08:43 +03001019 return -EINVAL;
1020
Benoit Cousson113a7412011-07-10 05:56:54 -06001021 return _clkdm_clk_hwmod_disable(clkdm);
1022}
Rajendra Nayak4da71ae2011-02-25 16:06:48 -07001023
Benoit Cousson113a7412011-07-10 05:56:54 -06001024/**
1025 * clkdm_hwmod_enable - add an enabled downstream hwmod to this clkdm
1026 * @clkdm: struct clockdomain *
1027 * @oh: struct omap_hwmod * of the enabled downstream hwmod
1028 *
1029 * Increment the usecount of the clockdomain @clkdm and ensure that it
1030 * is awake before @oh is enabled. Intended to be called by
1031 * module_enable() code.
1032 * If the clockdomain is in software-supervised idle mode, force the
1033 * clockdomain to wake. If the clockdomain is in hardware-supervised idle
1034 * mode, add clkdm-pwrdm autodependencies, to ensure that devices in the
1035 * clockdomain can be read from/written to by on-chip processors.
1036 * Returns -EINVAL if passed null pointers;
1037 * returns 0 upon success or if the clockdomain is in hwsup idle mode.
1038 */
1039int clkdm_hwmod_enable(struct clockdomain *clkdm, struct omap_hwmod *oh)
1040{
1041 /* The clkdm attribute does not exist yet prior OMAP4 */
1042 if (cpu_is_omap24xx() || cpu_is_omap34xx())
Paul Walmsleyd459bfe2008-08-19 11:08:43 +03001043 return 0;
1044
Benoit Cousson113a7412011-07-10 05:56:54 -06001045 /*
1046 * XXX Rewrite this code to maintain a list of enabled
1047 * downstream hwmods for debugging purposes?
1048 */
Paul Walmsleyd459bfe2008-08-19 11:08:43 +03001049
Benoit Cousson113a7412011-07-10 05:56:54 -06001050 if (!oh)
1051 return -EINVAL;
Paul Walmsleyd459bfe2008-08-19 11:08:43 +03001052
Benoit Cousson113a7412011-07-10 05:56:54 -06001053 return _clkdm_clk_hwmod_enable(clkdm);
1054}
Peter 'p2' De Schrijverfe617af2008-10-15 17:48:44 +03001055
Benoit Cousson113a7412011-07-10 05:56:54 -06001056/**
1057 * clkdm_hwmod_disable - remove an enabled downstream hwmod from this clkdm
1058 * @clkdm: struct clockdomain *
1059 * @oh: struct omap_hwmod * of the disabled downstream hwmod
1060 *
1061 * Decrement the usecount of this clockdomain @clkdm when @oh is
1062 * disabled. Intended to be called by module_disable() code.
1063 * If the clockdomain usecount goes to 0, put the clockdomain to sleep
1064 * (software-supervised mode) or remove the clkdm autodependencies
1065 * (hardware-supervised mode).
1066 * Returns -EINVAL if passed null pointers; -ERANGE if the @clkdm usecount
1067 * underflows; or returns 0 upon success or if the clockdomain is in hwsup
1068 * idle mode.
1069 */
1070int clkdm_hwmod_disable(struct clockdomain *clkdm, struct omap_hwmod *oh)
1071{
1072 /* The clkdm attribute does not exist yet prior OMAP4 */
1073 if (cpu_is_omap24xx() || cpu_is_omap34xx())
1074 return 0;
1075
1076 /*
1077 * XXX Rewrite this code to maintain a list of enabled
1078 * downstream hwmods for debugging purposes?
1079 */
1080
1081 if (!oh)
1082 return -EINVAL;
1083
1084 return _clkdm_clk_hwmod_disable(clkdm);
Paul Walmsleyd459bfe2008-08-19 11:08:43 +03001085}
1086