Commit | Line | Data |
---|---|---|
d459bfe0 | 1 | /* |
8a3ddc75 | 2 | * OMAP2/3/4 clockdomain framework functions |
d459bfe0 | 3 | * |
32a363c0 PW |
4 | * Copyright (C) 2008-2011 Texas Instruments, Inc. |
5 | * Copyright (C) 2008-2011 Nokia Corporation | |
d459bfe0 PW |
6 | * |
7 | * Written by Paul Walmsley and Jouni Högander | |
8a3ddc75 | 8 | * Added OMAP4 specific support by Abhijit Pagare <abhijitpagare@ti.com> |
d459bfe0 PW |
9 | * |
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 | */ | |
33903eb5 | 14 | #undef DEBUG |
d459bfe0 | 15 | |
d459bfe0 PW |
16 | #include <linux/kernel.h> |
17 | #include <linux/device.h> | |
18 | #include <linux/list.h> | |
19 | #include <linux/errno.h> | |
d44b28c4 | 20 | #include <linux/string.h> |
d459bfe0 PW |
21 | #include <linux/delay.h> |
22 | #include <linux/clk.h> | |
23 | #include <linux/limits.h> | |
5b74c676 | 24 | #include <linux/err.h> |
d043d87c | 25 | #include <linux/clk-provider.h> |
d459bfe0 PW |
26 | |
27 | #include <linux/io.h> | |
28 | ||
29 | #include <linux/bitops.h> | |
30 | ||
e4c060db | 31 | #include "soc.h" |
a135eaae | 32 | #include "clock.h" |
1540f214 | 33 | #include "clockdomain.h" |
d459bfe0 PW |
34 | |
35 | /* clkdm_list contains all registered struct clockdomains */ | |
36 | static LIST_HEAD(clkdm_list); | |
37 | ||
55ed9694 PW |
38 | /* array of clockdomain deps to be added/removed when clkdm in hwsup mode */ |
39 | static struct clkdm_autodep *autodeps; | |
d459bfe0 | 40 | |
32d4034e | 41 | static struct clkdm_ops *arch_clkdm; |
d459bfe0 PW |
42 | |
43 | /* Private functions */ | |
44 | ||
55ed9694 PW |
45 | static struct clockdomain *_clkdm_lookup(const char *name) |
46 | { | |
47 | struct clockdomain *clkdm, *temp_clkdm; | |
48 | ||
49 | if (!name) | |
50 | return NULL; | |
51 | ||
52 | clkdm = NULL; | |
53 | ||
54 | list_for_each_entry(temp_clkdm, &clkdm_list, node) { | |
55 | if (!strcmp(name, temp_clkdm->name)) { | |
56 | clkdm = temp_clkdm; | |
57 | break; | |
58 | } | |
59 | } | |
60 | ||
61 | return clkdm; | |
62 | } | |
63 | ||
e909d62a PW |
64 | /** |
65 | * _clkdm_register - register a clockdomain | |
66 | * @clkdm: struct clockdomain * to register | |
67 | * | |
68 | * Adds a clockdomain to the internal clockdomain list. | |
69 | * Returns -EINVAL if given a null pointer, -EEXIST if a clockdomain is | |
70 | * already registered by the provided name, or 0 upon success. | |
71 | */ | |
72 | static int _clkdm_register(struct clockdomain *clkdm) | |
73 | { | |
74 | struct powerdomain *pwrdm; | |
75 | ||
76 | if (!clkdm || !clkdm->name) | |
77 | return -EINVAL; | |
78 | ||
e909d62a PW |
79 | pwrdm = pwrdm_lookup(clkdm->pwrdm.name); |
80 | if (!pwrdm) { | |
81 | pr_err("clockdomain: %s: powerdomain %s does not exist\n", | |
82 | clkdm->name, clkdm->pwrdm.name); | |
83 | return -EINVAL; | |
84 | } | |
85 | clkdm->pwrdm.ptr = pwrdm; | |
86 | ||
87 | /* Verify that the clockdomain is not already registered */ | |
88 | if (_clkdm_lookup(clkdm->name)) | |
89 | return -EEXIST; | |
90 | ||
91 | list_add(&clkdm->node, &clkdm_list); | |
92 | ||
93 | pwrdm_add_clkdm(pwrdm, clkdm); | |
94 | ||
95 | pr_debug("clockdomain: registered %s\n", clkdm->name); | |
96 | ||
97 | return 0; | |
98 | } | |
99 | ||
55ed9694 PW |
100 | /* _clkdm_deps_lookup - look up the specified clockdomain in a clkdm list */ |
101 | static struct clkdm_dep *_clkdm_deps_lookup(struct clockdomain *clkdm, | |
102 | struct clkdm_dep *deps) | |
103 | { | |
104 | struct clkdm_dep *cd; | |
105 | ||
a5ffef6a | 106 | if (!clkdm || !deps) |
55ed9694 PW |
107 | return ERR_PTR(-EINVAL); |
108 | ||
109 | for (cd = deps; cd->clkdm_name; cd++) { | |
55ed9694 PW |
110 | if (!cd->clkdm && cd->clkdm_name) |
111 | cd->clkdm = _clkdm_lookup(cd->clkdm_name); | |
112 | ||
113 | if (cd->clkdm == clkdm) | |
114 | break; | |
55ed9694 PW |
115 | } |
116 | ||
117 | if (!cd->clkdm_name) | |
118 | return ERR_PTR(-ENOENT); | |
119 | ||
120 | return cd; | |
121 | } | |
122 | ||
d459bfe0 | 123 | /* |
55ed9694 PW |
124 | * _autodep_lookup - resolve autodep clkdm names to clkdm pointers; store |
125 | * @autodep: struct clkdm_autodep * to resolve | |
d459bfe0 | 126 | * |
55ed9694 PW |
127 | * 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 | |
d459bfe0 PW |
130 | * 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. | |
b170fbe1 PW |
135 | * |
136 | * XXX autodeps are deprecated and should be removed at the earliest | |
137 | * opportunity | |
d459bfe0 | 138 | */ |
55ed9694 | 139 | static void _autodep_lookup(struct clkdm_autodep *autodep) |
d459bfe0 | 140 | { |
55ed9694 | 141 | struct clockdomain *clkdm; |
d459bfe0 PW |
142 | |
143 | if (!autodep) | |
144 | return; | |
145 | ||
55ed9694 PW |
146 | 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); | |
d459bfe0 | 151 | } |
55ed9694 | 152 | autodep->clkdm.ptr = clkdm; |
d459bfe0 PW |
153 | } |
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. | |
b170fbe1 PW |
162 | * |
163 | * XXX autodeps are deprecated and should be removed at the earliest | |
164 | * opportunity | |
d459bfe0 | 165 | */ |
5cd1937b | 166 | void _clkdm_add_autodeps(struct clockdomain *clkdm) |
d459bfe0 | 167 | { |
55ed9694 | 168 | struct clkdm_autodep *autodep; |
d459bfe0 | 169 | |
570b54c7 | 170 | if (!autodeps || clkdm->flags & CLKDM_NO_AUTODEPS) |
ad956160 PW |
171 | return; |
172 | ||
55ed9694 PW |
173 | for (autodep = autodeps; autodep->clkdm.ptr; autodep++) { |
174 | if (IS_ERR(autodep->clkdm.ptr)) | |
d459bfe0 PW |
175 | continue; |
176 | ||
7852ec05 PW |
177 | pr_debug("clockdomain: %s: adding %s sleepdep/wkdep\n", |
178 | clkdm->name, autodep->clkdm.ptr->name); | |
d459bfe0 | 179 | |
55ed9694 PW |
180 | clkdm_add_sleepdep(clkdm, autodep->clkdm.ptr); |
181 | clkdm_add_wkdep(clkdm, autodep->clkdm.ptr); | |
d459bfe0 PW |
182 | } |
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. | |
b170fbe1 PW |
192 | * |
193 | * XXX autodeps are deprecated and should be removed at the earliest | |
194 | * opportunity | |
d459bfe0 | 195 | */ |
5cd1937b | 196 | void _clkdm_del_autodeps(struct clockdomain *clkdm) |
d459bfe0 | 197 | { |
55ed9694 | 198 | struct clkdm_autodep *autodep; |
d459bfe0 | 199 | |
570b54c7 | 200 | if (!autodeps || clkdm->flags & CLKDM_NO_AUTODEPS) |
ad956160 PW |
201 | return; |
202 | ||
55ed9694 PW |
203 | for (autodep = autodeps; autodep->clkdm.ptr; autodep++) { |
204 | if (IS_ERR(autodep->clkdm.ptr)) | |
d459bfe0 PW |
205 | continue; |
206 | ||
7852ec05 PW |
207 | pr_debug("clockdomain: %s: removing %s sleepdep/wkdep\n", |
208 | clkdm->name, autodep->clkdm.ptr->name); | |
d459bfe0 | 209 | |
55ed9694 PW |
210 | clkdm_del_sleepdep(clkdm, autodep->clkdm.ptr); |
211 | clkdm_del_wkdep(clkdm, autodep->clkdm.ptr); | |
d459bfe0 PW |
212 | } |
213 | } | |
214 | ||
b170fbe1 | 215 | /** |
4aef7a2a RN |
216 | * _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 | |
b170fbe1 | 219 | * |
4aef7a2a RN |
220 | * Iterates through @clkdm_deps, looking up the struct clockdomain named by |
221 | * clkdm_name and storing the clockdomain pointer in the struct clkdm_dep. | |
b170fbe1 | 222 | * No return value. |
a0219fbd | 223 | */ |
4aef7a2a RN |
224 | static void _resolve_clkdm_deps(struct clockdomain *clkdm, |
225 | struct clkdm_dep *clkdm_deps) | |
a0219fbd | 226 | { |
4aef7a2a RN |
227 | struct clkdm_dep *cd; |
228 | ||
229 | for (cd = clkdm_deps; cd && cd->clkdm_name; cd++) { | |
4aef7a2a RN |
230 | 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 | } | |
a0219fbd | 237 | } |
d459bfe0 | 238 | |
d459bfe0 PW |
239 | /* Public functions */ |
240 | ||
241 | /** | |
08cb9703 PW |
242 | * clkdm_register_platform_funcs - register clockdomain implementation fns |
243 | * @co: func pointers for arch specific implementations | |
d459bfe0 | 244 | * |
08cb9703 PW |
245 | * 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. | |
d459bfe0 | 250 | */ |
08cb9703 PW |
251 | int 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 | */ | |
274 | int clkdm_register_clkdms(struct clockdomain **cs) | |
d459bfe0 PW |
275 | { |
276 | struct clockdomain **c = NULL; | |
d459bfe0 | 277 | |
08cb9703 PW |
278 | if (!arch_clkdm) |
279 | return -EACCES; | |
280 | ||
281 | if (!cs) | |
282 | return -EINVAL; | |
283 | ||
284 | 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 | */ | |
314 | int clkdm_register_autodeps(struct clkdm_autodep *ia) | |
315 | { | |
316 | struct clkdm_autodep *a = NULL; | |
317 | ||
318 | if (list_empty(&clkdm_list)) | |
319 | return -EACCES; | |
32d4034e | 320 | |
08cb9703 PW |
321 | if (!ia) |
322 | return -EINVAL; | |
d459bfe0 | 323 | |
55ed9694 | 324 | if (autodeps) |
08cb9703 PW |
325 | return -EEXIST; |
326 | ||
327 | 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 | */ | |
342 | int clkdm_complete_init(void) | |
343 | { | |
344 | struct clockdomain *clkdm; | |
345 | ||
346 | if (list_empty(&clkdm_list)) | |
347 | return -EACCES; | |
369d5614 | 348 | |
369d5614 | 349 | list_for_each_entry(clkdm, &clkdm_list, node) { |
6f7f63cc | 350 | if (clkdm->flags & CLKDM_CAN_FORCE_WAKEUP) |
68b921ad | 351 | clkdm_wakeup(clkdm); |
6f7f63cc | 352 | else if (clkdm->flags & CLKDM_CAN_DISABLE_AUTO) |
5cd1937b | 353 | clkdm_deny_idle(clkdm); |
6f7f63cc | 354 | |
4aef7a2a | 355 | _resolve_clkdm_deps(clkdm, clkdm->wkdep_srcs); |
6f7f63cc | 356 | clkdm_clear_all_wkdeps(clkdm); |
4aef7a2a RN |
357 | |
358 | _resolve_clkdm_deps(clkdm, clkdm->sleepdep_srcs); | |
6f7f63cc | 359 | clkdm_clear_all_sleepdeps(clkdm); |
369d5614 | 360 | } |
08cb9703 PW |
361 | |
362 | return 0; | |
d459bfe0 PW |
363 | } |
364 | ||
d459bfe0 PW |
365 | /** |
366 | * clkdm_lookup - look up a clockdomain by name, return a pointer | |
367 | * @name: name of clockdomain | |
368 | * | |
f0271d65 PW |
369 | * Find a registered clockdomain by its name @name. Returns a pointer |
370 | * to the struct clockdomain if found, or NULL otherwise. | |
d459bfe0 PW |
371 | */ |
372 | struct 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 | ||
d459bfe0 PW |
381 | list_for_each_entry(temp_clkdm, &clkdm_list, node) { |
382 | if (!strcmp(name, temp_clkdm->name)) { | |
383 | clkdm = temp_clkdm; | |
384 | break; | |
385 | } | |
386 | } | |
d459bfe0 PW |
387 | |
388 | return clkdm; | |
389 | } | |
390 | ||
391 | /** | |
392 | * clkdm_for_each - call function on each registered clockdomain | |
393 | * @fn: callback function * | |
394 | * | |
f0271d65 PW |
395 | * Call the supplied function @fn for each registered clockdomain. |
396 | * The callback function @fn can return anything but 0 to bail | |
d459bfe0 PW |
397 | * 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 | */ | |
a23456e9 PDS |
405 | int clkdm_for_each(int (*fn)(struct clockdomain *clkdm, void *user), |
406 | void *user) | |
d459bfe0 PW |
407 | { |
408 | struct clockdomain *clkdm; | |
409 | int ret = 0; | |
410 | ||
411 | if (!fn) | |
412 | return -EINVAL; | |
413 | ||
d459bfe0 | 414 | list_for_each_entry(clkdm, &clkdm_list, node) { |
a23456e9 | 415 | ret = (*fn)(clkdm, user); |
d459bfe0 PW |
416 | if (ret) |
417 | break; | |
418 | } | |
d459bfe0 PW |
419 | |
420 | return ret; | |
421 | } | |
422 | ||
423 | ||
e89087c9 PW |
424 | /** |
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 | |
f0271d65 | 429 | * @clkdm exists in, or returns NULL if @clkdm is NULL. |
e89087c9 PW |
430 | */ |
431 | struct powerdomain *clkdm_get_pwrdm(struct clockdomain *clkdm) | |
432 | { | |
433 | if (!clkdm) | |
434 | return NULL; | |
435 | ||
5b74c676 | 436 | return clkdm->pwrdm.ptr; |
e89087c9 PW |
437 | } |
438 | ||
439 | ||
d459bfe0 PW |
440 | /* Hardware clockdomain control */ |
441 | ||
55ed9694 PW |
442 | /** |
443 | * 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 | */ | |
454 | int clkdm_add_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2) | |
455 | { | |
456 | struct clkdm_dep *cd; | |
4aef7a2a | 457 | int ret = 0; |
56bc78d4 | 458 | |
55ed9694 PW |
459 | if (!clkdm1 || !clkdm2) |
460 | return -EINVAL; | |
461 | ||
462 | cd = _clkdm_deps_lookup(clkdm2, clkdm1->wkdep_srcs); | |
4aef7a2a RN |
463 | 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) { | |
7852ec05 PW |
470 | pr_debug("clockdomain: hardware cannot set/clear wake up of %s when %s wakes up\n", |
471 | clkdm1->name, clkdm2->name); | |
4aef7a2a | 472 | return ret; |
55ed9694 PW |
473 | } |
474 | ||
369d5614 | 475 | if (atomic_inc_return(&cd->wkdep_usecount) == 1) { |
7852ec05 PW |
476 | pr_debug("clockdomain: hardware will wake up %s when %s wakes up\n", |
477 | clkdm1->name, clkdm2->name); | |
55ed9694 | 478 | |
4aef7a2a | 479 | ret = arch_clkdm->clkdm_add_wkdep(clkdm1, clkdm2); |
369d5614 | 480 | } |
55ed9694 | 481 | |
4aef7a2a | 482 | return ret; |
55ed9694 PW |
483 | } |
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 | */ | |
495 | int clkdm_del_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2) | |
496 | { | |
497 | struct clkdm_dep *cd; | |
4aef7a2a | 498 | int ret = 0; |
56bc78d4 | 499 | |
55ed9694 PW |
500 | if (!clkdm1 || !clkdm2) |
501 | return -EINVAL; | |
502 | ||
503 | cd = _clkdm_deps_lookup(clkdm2, clkdm1->wkdep_srcs); | |
4aef7a2a RN |
504 | 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) { | |
7852ec05 PW |
511 | pr_debug("clockdomain: hardware cannot set/clear wake up of %s when %s wakes up\n", |
512 | clkdm1->name, clkdm2->name); | |
4aef7a2a | 513 | return ret; |
55ed9694 PW |
514 | } |
515 | ||
369d5614 | 516 | if (atomic_dec_return(&cd->wkdep_usecount) == 0) { |
7852ec05 PW |
517 | pr_debug("clockdomain: hardware will no longer wake up %s after %s wakes up\n", |
518 | clkdm1->name, clkdm2->name); | |
55ed9694 | 519 | |
4aef7a2a | 520 | ret = arch_clkdm->clkdm_del_wkdep(clkdm1, clkdm2); |
369d5614 | 521 | } |
55ed9694 | 522 | |
4aef7a2a | 523 | return ret; |
55ed9694 PW |
524 | } |
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 | */ | |
540 | int clkdm_read_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2) | |
541 | { | |
542 | struct clkdm_dep *cd; | |
4aef7a2a | 543 | int ret = 0; |
55ed9694 PW |
544 | |
545 | if (!clkdm1 || !clkdm2) | |
546 | return -EINVAL; | |
547 | ||
548 | cd = _clkdm_deps_lookup(clkdm2, clkdm1->wkdep_srcs); | |
4aef7a2a RN |
549 | 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) { | |
7852ec05 PW |
556 | pr_debug("clockdomain: hardware cannot set/clear wake up of %s when %s wakes up\n", |
557 | clkdm1->name, clkdm2->name); | |
4aef7a2a | 558 | return ret; |
55ed9694 PW |
559 | } |
560 | ||
369d5614 | 561 | /* XXX It's faster to return the atomic wkdep_usecount */ |
4aef7a2a | 562 | return arch_clkdm->clkdm_read_wkdep(clkdm1, clkdm2); |
55ed9694 PW |
563 | } |
564 | ||
369d5614 PW |
565 | /** |
566 | * 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 | */ | |
575 | int clkdm_clear_all_wkdeps(struct clockdomain *clkdm) | |
576 | { | |
369d5614 PW |
577 | if (!clkdm) |
578 | return -EINVAL; | |
579 | ||
4aef7a2a RN |
580 | if (!arch_clkdm || !arch_clkdm->clkdm_clear_all_wkdeps) |
581 | return -EINVAL; | |
369d5614 | 582 | |
4aef7a2a | 583 | return arch_clkdm->clkdm_clear_all_wkdeps(clkdm); |
369d5614 PW |
584 | } |
585 | ||
55ed9694 PW |
586 | /** |
587 | * 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 | */ | |
598 | int clkdm_add_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2) | |
599 | { | |
600 | struct clkdm_dep *cd; | |
4aef7a2a | 601 | int ret = 0; |
55ed9694 PW |
602 | |
603 | if (!clkdm1 || !clkdm2) | |
604 | return -EINVAL; | |
605 | ||
606 | cd = _clkdm_deps_lookup(clkdm2, clkdm1->sleepdep_srcs); | |
4aef7a2a RN |
607 | 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) { | |
7852ec05 PW |
614 | pr_debug("clockdomain: hardware cannot set/clear sleep dependency affecting %s from %s\n", |
615 | clkdm1->name, clkdm2->name); | |
4aef7a2a | 616 | return ret; |
55ed9694 PW |
617 | } |
618 | ||
369d5614 | 619 | if (atomic_inc_return(&cd->sleepdep_usecount) == 1) { |
7852ec05 PW |
620 | pr_debug("clockdomain: will prevent %s from sleeping if %s is active\n", |
621 | clkdm1->name, clkdm2->name); | |
55ed9694 | 622 | |
4aef7a2a | 623 | ret = arch_clkdm->clkdm_add_sleepdep(clkdm1, clkdm2); |
369d5614 | 624 | } |
55ed9694 | 625 | |
4aef7a2a | 626 | return ret; |
55ed9694 PW |
627 | } |
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 | */ | |
641 | int clkdm_del_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2) | |
642 | { | |
643 | struct clkdm_dep *cd; | |
4aef7a2a | 644 | int ret = 0; |
55ed9694 PW |
645 | |
646 | if (!clkdm1 || !clkdm2) | |
647 | return -EINVAL; | |
648 | ||
649 | cd = _clkdm_deps_lookup(clkdm2, clkdm1->sleepdep_srcs); | |
4aef7a2a RN |
650 | 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) { | |
7852ec05 PW |
657 | pr_debug("clockdomain: hardware cannot set/clear sleep dependency affecting %s from %s\n", |
658 | clkdm1->name, clkdm2->name); | |
4aef7a2a | 659 | return ret; |
55ed9694 PW |
660 | } |
661 | ||
369d5614 | 662 | if (atomic_dec_return(&cd->sleepdep_usecount) == 0) { |
7852ec05 PW |
663 | pr_debug("clockdomain: will no longer prevent %s from sleeping if %s is active\n", |
664 | clkdm1->name, clkdm2->name); | |
55ed9694 | 665 | |
4aef7a2a | 666 | ret = arch_clkdm->clkdm_del_sleepdep(clkdm1, clkdm2); |
369d5614 | 667 | } |
55ed9694 | 668 | |
4aef7a2a | 669 | return ret; |
55ed9694 PW |
670 | } |
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 | */ | |
688 | int clkdm_read_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2) | |
689 | { | |
690 | struct clkdm_dep *cd; | |
4aef7a2a | 691 | int ret = 0; |
55ed9694 PW |
692 | |
693 | if (!clkdm1 || !clkdm2) | |
694 | return -EINVAL; | |
695 | ||
696 | cd = _clkdm_deps_lookup(clkdm2, clkdm1->sleepdep_srcs); | |
4aef7a2a RN |
697 | 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) { | |
7852ec05 PW |
704 | pr_debug("clockdomain: hardware cannot set/clear sleep dependency affecting %s from %s\n", |
705 | clkdm1->name, clkdm2->name); | |
4aef7a2a | 706 | return ret; |
55ed9694 PW |
707 | } |
708 | ||
369d5614 | 709 | /* XXX It's faster to return the atomic sleepdep_usecount */ |
4aef7a2a | 710 | return arch_clkdm->clkdm_read_sleepdep(clkdm1, clkdm2); |
55ed9694 PW |
711 | } |
712 | ||
369d5614 PW |
713 | /** |
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 | */ | |
723 | int clkdm_clear_all_sleepdeps(struct clockdomain *clkdm) | |
724 | { | |
369d5614 PW |
725 | if (!clkdm) |
726 | return -EINVAL; | |
727 | ||
4aef7a2a RN |
728 | if (!arch_clkdm || !arch_clkdm->clkdm_clear_all_sleepdeps) |
729 | return -EINVAL; | |
369d5614 | 730 | |
4aef7a2a | 731 | return arch_clkdm->clkdm_clear_all_sleepdeps(clkdm); |
369d5614 | 732 | } |
55ed9694 | 733 | |
d459bfe0 | 734 | /** |
3a090284 | 735 | * clkdm_sleep_nolock - force clockdomain sleep transition (lockless) |
d459bfe0 PW |
736 | * @clkdm: struct clockdomain * |
737 | * | |
738 | * Instruct the CM to force a sleep transition on the specified | |
3a090284 PW |
739 | * clockdomain @clkdm. Only for use by the powerdomain code. Returns |
740 | * -EINVAL if @clkdm is NULL or if clockdomain does not support | |
741 | * software-initiated sleep; 0 upon success. | |
d459bfe0 | 742 | */ |
3a090284 | 743 | int clkdm_sleep_nolock(struct clockdomain *clkdm) |
d459bfe0 | 744 | { |
555e74ea | 745 | int ret; |
555e74ea | 746 | |
d459bfe0 PW |
747 | if (!clkdm) |
748 | return -EINVAL; | |
749 | ||
750 | if (!(clkdm->flags & CLKDM_CAN_FORCE_SLEEP)) { | |
7852ec05 PW |
751 | pr_debug("clockdomain: %s does not support forcing sleep via software\n", |
752 | clkdm->name); | |
d459bfe0 PW |
753 | return -EINVAL; |
754 | } | |
755 | ||
68b921ad RN |
756 | if (!arch_clkdm || !arch_clkdm->clkdm_sleep) |
757 | return -EINVAL; | |
bd2122ca | 758 | |
68b921ad | 759 | pr_debug("clockdomain: forcing sleep on %s\n", clkdm->name); |
d459bfe0 | 760 | |
32a363c0 | 761 | clkdm->_flags &= ~_CLKDM_FLAG_HWSUP_ENABLED; |
555e74ea | 762 | ret = arch_clkdm->clkdm_sleep(clkdm); |
3a090284 PW |
763 | ret |= pwrdm_state_switch_nolock(clkdm->pwrdm.ptr); |
764 | ||
555e74ea | 765 | return ret; |
d459bfe0 PW |
766 | } |
767 | ||
768 | /** | |
3a090284 | 769 | * clkdm_sleep - force clockdomain sleep transition |
d459bfe0 PW |
770 | * @clkdm: struct clockdomain * |
771 | * | |
3a090284 PW |
772 | * Instruct the CM to force a sleep transition on the specified |
773 | * clockdomain @clkdm. Returns -EINVAL if @clkdm is NULL or if | |
774 | * clockdomain does not support software-initiated sleep; 0 upon | |
d459bfe0 PW |
775 | * success. |
776 | */ | |
3a090284 PW |
777 | int clkdm_sleep(struct clockdomain *clkdm) |
778 | { | |
779 | int ret; | |
780 | ||
781 | pwrdm_lock(clkdm->pwrdm.ptr); | |
782 | ret = clkdm_sleep_nolock(clkdm); | |
783 | pwrdm_unlock(clkdm->pwrdm.ptr); | |
784 | ||
785 | return ret; | |
786 | } | |
787 | ||
788 | /** | |
789 | * clkdm_wakeup_nolock - force clockdomain wakeup transition (lockless) | |
790 | * @clkdm: struct clockdomain * | |
791 | * | |
792 | * Instruct the CM to force a wakeup transition on the specified | |
793 | * clockdomain @clkdm. Only for use by the powerdomain code. Returns | |
794 | * -EINVAL if @clkdm is NULL or if the clockdomain does not support | |
795 | * software-controlled wakeup; 0 upon success. | |
796 | */ | |
797 | int clkdm_wakeup_nolock(struct clockdomain *clkdm) | |
d459bfe0 | 798 | { |
555e74ea | 799 | int ret; |
555e74ea | 800 | |
d459bfe0 PW |
801 | if (!clkdm) |
802 | return -EINVAL; | |
803 | ||
804 | if (!(clkdm->flags & CLKDM_CAN_FORCE_WAKEUP)) { | |
7852ec05 PW |
805 | pr_debug("clockdomain: %s does not support forcing wakeup via software\n", |
806 | clkdm->name); | |
d459bfe0 PW |
807 | return -EINVAL; |
808 | } | |
809 | ||
68b921ad RN |
810 | if (!arch_clkdm || !arch_clkdm->clkdm_wakeup) |
811 | return -EINVAL; | |
bd2122ca | 812 | |
68b921ad | 813 | pr_debug("clockdomain: forcing wakeup on %s\n", clkdm->name); |
d459bfe0 | 814 | |
32a363c0 | 815 | clkdm->_flags &= ~_CLKDM_FLAG_HWSUP_ENABLED; |
555e74ea | 816 | ret = arch_clkdm->clkdm_wakeup(clkdm); |
3a090284 PW |
817 | ret |= pwrdm_state_switch_nolock(clkdm->pwrdm.ptr); |
818 | ||
555e74ea | 819 | return ret; |
d459bfe0 PW |
820 | } |
821 | ||
822 | /** | |
3a090284 | 823 | * clkdm_wakeup - force clockdomain wakeup transition |
d459bfe0 PW |
824 | * @clkdm: struct clockdomain * |
825 | * | |
3a090284 PW |
826 | * Instruct the CM to force a wakeup transition on the specified |
827 | * clockdomain @clkdm. Returns -EINVAL if @clkdm is NULL or if the | |
828 | * clockdomain does not support software-controlled wakeup; 0 upon | |
829 | * success. | |
830 | */ | |
831 | int clkdm_wakeup(struct clockdomain *clkdm) | |
832 | { | |
833 | int ret; | |
834 | ||
835 | pwrdm_lock(clkdm->pwrdm.ptr); | |
836 | ret = clkdm_wakeup_nolock(clkdm); | |
837 | pwrdm_unlock(clkdm->pwrdm.ptr); | |
838 | ||
839 | return ret; | |
840 | } | |
841 | ||
842 | /** | |
843 | * clkdm_allow_idle_nolock - enable hwsup idle transitions for clkdm | |
844 | * @clkdm: struct clockdomain * | |
845 | * | |
846 | * Allow the hardware to automatically switch the clockdomain @clkdm | |
847 | * into active or idle states, as needed by downstream clocks. If the | |
d459bfe0 PW |
848 | * clockdomain has any downstream clocks enabled in the clock |
849 | * framework, wkdep/sleepdep autodependencies are added; this is so | |
3a090284 PW |
850 | * device drivers can read and write to the device. Only for use by |
851 | * the powerdomain code. No return value. | |
d459bfe0 | 852 | */ |
3a090284 | 853 | void clkdm_allow_idle_nolock(struct clockdomain *clkdm) |
d459bfe0 | 854 | { |
d459bfe0 PW |
855 | if (!clkdm) |
856 | return; | |
857 | ||
858 | if (!(clkdm->flags & CLKDM_CAN_ENABLE_AUTO)) { | |
7852ec05 PW |
859 | pr_debug("clock: %s: automatic idle transitions cannot be enabled\n", |
860 | clkdm->name); | |
d459bfe0 PW |
861 | return; |
862 | } | |
863 | ||
5cd1937b RN |
864 | if (!arch_clkdm || !arch_clkdm->clkdm_allow_idle) |
865 | return; | |
866 | ||
d459bfe0 PW |
867 | pr_debug("clockdomain: enabling automatic idle transitions for %s\n", |
868 | clkdm->name); | |
869 | ||
32a363c0 | 870 | clkdm->_flags |= _CLKDM_FLAG_HWSUP_ENABLED; |
5cd1937b | 871 | arch_clkdm->clkdm_allow_idle(clkdm); |
3a090284 PW |
872 | pwrdm_state_switch_nolock(clkdm->pwrdm.ptr); |
873 | } | |
874 | ||
875 | /** | |
876 | * clkdm_allow_idle - enable hwsup idle transitions for clkdm | |
877 | * @clkdm: struct clockdomain * | |
878 | * | |
879 | * Allow the hardware to automatically switch the clockdomain @clkdm into | |
880 | * active or idle states, as needed by downstream clocks. If the | |
881 | * clockdomain has any downstream clocks enabled in the clock | |
882 | * framework, wkdep/sleepdep autodependencies are added; this is so | |
883 | * device drivers can read and write to the device. No return value. | |
884 | */ | |
885 | void clkdm_allow_idle(struct clockdomain *clkdm) | |
886 | { | |
887 | pwrdm_lock(clkdm->pwrdm.ptr); | |
888 | clkdm_allow_idle_nolock(clkdm); | |
889 | pwrdm_unlock(clkdm->pwrdm.ptr); | |
d459bfe0 PW |
890 | } |
891 | ||
892 | /** | |
5cd1937b | 893 | * clkdm_deny_idle - disable hwsup idle transitions for clkdm |
d459bfe0 PW |
894 | * @clkdm: struct clockdomain * |
895 | * | |
896 | * Prevent the hardware from automatically switching the clockdomain | |
f0271d65 PW |
897 | * @clkdm into inactive or idle states. If the clockdomain has |
898 | * downstream clocks enabled in the clock framework, wkdep/sleepdep | |
3a090284 PW |
899 | * autodependencies are removed. Only for use by the powerdomain |
900 | * code. No return value. | |
d459bfe0 | 901 | */ |
3a090284 | 902 | void clkdm_deny_idle_nolock(struct clockdomain *clkdm) |
d459bfe0 | 903 | { |
d459bfe0 PW |
904 | if (!clkdm) |
905 | return; | |
906 | ||
907 | if (!(clkdm->flags & CLKDM_CAN_DISABLE_AUTO)) { | |
7852ec05 PW |
908 | pr_debug("clockdomain: %s: automatic idle transitions cannot be disabled\n", |
909 | clkdm->name); | |
d459bfe0 PW |
910 | return; |
911 | } | |
912 | ||
5cd1937b RN |
913 | if (!arch_clkdm || !arch_clkdm->clkdm_deny_idle) |
914 | return; | |
915 | ||
d459bfe0 PW |
916 | pr_debug("clockdomain: disabling automatic idle transitions for %s\n", |
917 | clkdm->name); | |
918 | ||
32a363c0 | 919 | clkdm->_flags &= ~_CLKDM_FLAG_HWSUP_ENABLED; |
5cd1937b | 920 | arch_clkdm->clkdm_deny_idle(clkdm); |
3a090284 PW |
921 | pwrdm_state_switch_nolock(clkdm->pwrdm.ptr); |
922 | } | |
923 | ||
924 | /** | |
925 | * clkdm_deny_idle - disable hwsup idle transitions for clkdm | |
926 | * @clkdm: struct clockdomain * | |
927 | * | |
928 | * Prevent the hardware from automatically switching the clockdomain | |
929 | * @clkdm into inactive or idle states. If the clockdomain has | |
930 | * downstream clocks enabled in the clock framework, wkdep/sleepdep | |
931 | * autodependencies are removed. No return value. | |
932 | */ | |
933 | void clkdm_deny_idle(struct clockdomain *clkdm) | |
934 | { | |
935 | pwrdm_lock(clkdm->pwrdm.ptr); | |
936 | clkdm_deny_idle_nolock(clkdm); | |
937 | pwrdm_unlock(clkdm->pwrdm.ptr); | |
d459bfe0 PW |
938 | } |
939 | ||
32a363c0 PW |
940 | /** |
941 | * clkdm_in_hwsup - is clockdomain @clkdm have hardware-supervised idle enabled? | |
942 | * @clkdm: struct clockdomain * | |
943 | * | |
944 | * Returns true if clockdomain @clkdm currently has | |
945 | * hardware-supervised idle enabled, or false if it does not or if | |
946 | * @clkdm is NULL. It is only valid to call this function after | |
947 | * clkdm_init() has been called. This function does not actually read | |
948 | * bits from the hardware; it instead tests an in-memory flag that is | |
949 | * changed whenever the clockdomain code changes the auto-idle mode. | |
950 | */ | |
951 | bool clkdm_in_hwsup(struct clockdomain *clkdm) | |
952 | { | |
555e74ea | 953 | bool ret; |
555e74ea | 954 | |
32a363c0 PW |
955 | if (!clkdm) |
956 | return false; | |
957 | ||
555e74ea | 958 | ret = (clkdm->_flags & _CLKDM_FLAG_HWSUP_ENABLED) ? true : false; |
555e74ea RN |
959 | |
960 | return ret; | |
32a363c0 | 961 | } |
d459bfe0 | 962 | |
b71c7217 PW |
963 | /** |
964 | * clkdm_missing_idle_reporting - can @clkdm enter autoidle even if in use? | |
965 | * @clkdm: struct clockdomain * | |
966 | * | |
967 | * Returns true if clockdomain @clkdm has the | |
968 | * CLKDM_MISSING_IDLE_REPORTING flag set, or false if not or @clkdm is | |
969 | * null. More information is available in the documentation for the | |
970 | * CLKDM_MISSING_IDLE_REPORTING macro. | |
971 | */ | |
972 | bool clkdm_missing_idle_reporting(struct clockdomain *clkdm) | |
973 | { | |
974 | if (!clkdm) | |
975 | return false; | |
976 | ||
977 | return (clkdm->flags & CLKDM_MISSING_IDLE_REPORTING) ? true : false; | |
978 | } | |
979 | ||
113a7413 BC |
980 | /* Clockdomain-to-clock/hwmod framework interface code */ |
981 | ||
982 | static int _clkdm_clk_hwmod_enable(struct clockdomain *clkdm) | |
983 | { | |
984 | if (!clkdm || !arch_clkdm || !arch_clkdm->clkdm_clk_enable) | |
985 | return -EINVAL; | |
986 | ||
3a090284 | 987 | pwrdm_lock(clkdm->pwrdm.ptr); |
64e29fd5 | 988 | |
113a7413 BC |
989 | /* |
990 | * For arch's with no autodeps, clkcm_clk_enable | |
991 | * should be called for every clock instance or hwmod that is | |
992 | * enabled, so the clkdm can be force woken up. | |
993 | */ | |
64e29fd5 | 994 | if ((atomic_inc_return(&clkdm->usecount) > 1) && autodeps) { |
3a090284 | 995 | pwrdm_unlock(clkdm->pwrdm.ptr); |
113a7413 | 996 | return 0; |
64e29fd5 | 997 | } |
113a7413 BC |
998 | |
999 | arch_clkdm->clkdm_clk_enable(clkdm); | |
3a090284 PW |
1000 | pwrdm_state_switch_nolock(clkdm->pwrdm.ptr); |
1001 | pwrdm_unlock(clkdm->pwrdm.ptr); | |
113a7413 | 1002 | |
7852ec05 | 1003 | pr_debug("clockdomain: %s: enabled\n", clkdm->name); |
113a7413 BC |
1004 | |
1005 | return 0; | |
1006 | } | |
1007 | ||
d459bfe0 | 1008 | /** |
4da71ae6 | 1009 | * clkdm_clk_enable - add an enabled downstream clock to this clkdm |
d459bfe0 PW |
1010 | * @clkdm: struct clockdomain * |
1011 | * @clk: struct clk * of the enabled downstream clock | |
1012 | * | |
f0271d65 PW |
1013 | * Increment the usecount of the clockdomain @clkdm and ensure that it |
1014 | * is awake before @clk is enabled. Intended to be called by | |
1015 | * clk_enable() code. If the clockdomain is in software-supervised | |
1016 | * idle mode, force the clockdomain to wake. If the clockdomain is in | |
1017 | * hardware-supervised idle mode, add clkdm-pwrdm autodependencies, to | |
1018 | * ensure that devices in the clockdomain can be read from/written to | |
1019 | * by on-chip processors. Returns -EINVAL if passed null pointers; | |
1020 | * returns 0 upon success or if the clockdomain is in hwsup idle mode. | |
d459bfe0 | 1021 | */ |
4da71ae6 | 1022 | int clkdm_clk_enable(struct clockdomain *clkdm, struct clk *clk) |
d459bfe0 | 1023 | { |
d459bfe0 PW |
1024 | /* |
1025 | * XXX Rewrite this code to maintain a list of enabled | |
1026 | * downstream clocks for debugging purposes? | |
1027 | */ | |
1028 | ||
113a7413 | 1029 | if (!clk) |
d459bfe0 PW |
1030 | return -EINVAL; |
1031 | ||
113a7413 | 1032 | return _clkdm_clk_hwmod_enable(clkdm); |
d459bfe0 PW |
1033 | } |
1034 | ||
1035 | /** | |
4da71ae6 | 1036 | * clkdm_clk_disable - remove an enabled downstream clock from this clkdm |
d459bfe0 PW |
1037 | * @clkdm: struct clockdomain * |
1038 | * @clk: struct clk * of the disabled downstream clock | |
1039 | * | |
f0271d65 PW |
1040 | * Decrement the usecount of this clockdomain @clkdm when @clk is |
1041 | * disabled. Intended to be called by clk_disable() code. If the | |
1042 | * clockdomain usecount goes to 0, put the clockdomain to sleep | |
1043 | * (software-supervised mode) or remove the clkdm autodependencies | |
1044 | * (hardware-supervised mode). Returns -EINVAL if passed null | |
113a7413 BC |
1045 | * pointers; -ERANGE if the @clkdm usecount underflows; or returns 0 |
1046 | * upon success or if the clockdomain is in hwsup idle mode. | |
d459bfe0 | 1047 | */ |
4da71ae6 | 1048 | int clkdm_clk_disable(struct clockdomain *clkdm, struct clk *clk) |
d459bfe0 | 1049 | { |
d043d87c | 1050 | if (!clkdm || !clk || !arch_clkdm || !arch_clkdm->clkdm_clk_disable) |
d459bfe0 PW |
1051 | return -EINVAL; |
1052 | ||
3a090284 | 1053 | pwrdm_lock(clkdm->pwrdm.ptr); |
d043d87c | 1054 | |
d043d87c | 1055 | /* corner case: disabling unused clocks */ |
29f0667f JH |
1056 | if ((__clk_get_enable_count(clk) == 0) && |
1057 | (atomic_read(&clkdm->usecount) == 0)) | |
d043d87c | 1058 | goto ccd_exit; |
d043d87c MT |
1059 | |
1060 | if (atomic_read(&clkdm->usecount) == 0) { | |
3a090284 | 1061 | pwrdm_unlock(clkdm->pwrdm.ptr); |
d043d87c MT |
1062 | WARN_ON(1); /* underflow */ |
1063 | return -ERANGE; | |
1064 | } | |
1065 | ||
1066 | if (atomic_dec_return(&clkdm->usecount) > 0) { | |
3a090284 | 1067 | pwrdm_unlock(clkdm->pwrdm.ptr); |
d043d87c MT |
1068 | return 0; |
1069 | } | |
1070 | ||
1071 | arch_clkdm->clkdm_clk_disable(clkdm); | |
3a090284 | 1072 | pwrdm_state_switch_nolock(clkdm->pwrdm.ptr); |
d043d87c MT |
1073 | |
1074 | pr_debug("clockdomain: %s: disabled\n", clkdm->name); | |
1075 | ||
d043d87c | 1076 | ccd_exit: |
3a090284 | 1077 | pwrdm_unlock(clkdm->pwrdm.ptr); |
d043d87c MT |
1078 | |
1079 | return 0; | |
113a7413 BC |
1080 | } |
1081 | ||
1082 | /** | |
1083 | * clkdm_hwmod_enable - add an enabled downstream hwmod to this clkdm | |
1084 | * @clkdm: struct clockdomain * | |
1085 | * @oh: struct omap_hwmod * of the enabled downstream hwmod | |
1086 | * | |
1087 | * Increment the usecount of the clockdomain @clkdm and ensure that it | |
1088 | * is awake before @oh is enabled. Intended to be called by | |
1089 | * module_enable() code. | |
1090 | * If the clockdomain is in software-supervised idle mode, force the | |
1091 | * clockdomain to wake. If the clockdomain is in hardware-supervised idle | |
1092 | * mode, add clkdm-pwrdm autodependencies, to ensure that devices in the | |
1093 | * clockdomain can be read from/written to by on-chip processors. | |
1094 | * Returns -EINVAL if passed null pointers; | |
1095 | * returns 0 upon success or if the clockdomain is in hwsup idle mode. | |
1096 | */ | |
1097 | int clkdm_hwmod_enable(struct clockdomain *clkdm, struct omap_hwmod *oh) | |
1098 | { | |
1099 | /* The clkdm attribute does not exist yet prior OMAP4 */ | |
1100 | if (cpu_is_omap24xx() || cpu_is_omap34xx()) | |
1101 | return 0; | |
1102 | ||
1103 | /* | |
1104 | * XXX Rewrite this code to maintain a list of enabled | |
1105 | * downstream hwmods for debugging purposes? | |
1106 | */ | |
1107 | ||
1108 | if (!oh) | |
4da71ae6 RN |
1109 | return -EINVAL; |
1110 | ||
113a7413 BC |
1111 | return _clkdm_clk_hwmod_enable(clkdm); |
1112 | } | |
d459bfe0 | 1113 | |
113a7413 BC |
1114 | /** |
1115 | * clkdm_hwmod_disable - remove an enabled downstream hwmod from this clkdm | |
1116 | * @clkdm: struct clockdomain * | |
1117 | * @oh: struct omap_hwmod * of the disabled downstream hwmod | |
1118 | * | |
1119 | * Decrement the usecount of this clockdomain @clkdm when @oh is | |
1120 | * disabled. Intended to be called by module_disable() code. | |
1121 | * If the clockdomain usecount goes to 0, put the clockdomain to sleep | |
1122 | * (software-supervised mode) or remove the clkdm autodependencies | |
1123 | * (hardware-supervised mode). | |
1124 | * Returns -EINVAL if passed null pointers; -ERANGE if the @clkdm usecount | |
1125 | * underflows; or returns 0 upon success or if the clockdomain is in hwsup | |
1126 | * idle mode. | |
1127 | */ | |
1128 | int clkdm_hwmod_disable(struct clockdomain *clkdm, struct omap_hwmod *oh) | |
1129 | { | |
1130 | /* The clkdm attribute does not exist yet prior OMAP4 */ | |
1131 | if (cpu_is_omap24xx() || cpu_is_omap34xx()) | |
d459bfe0 PW |
1132 | return 0; |
1133 | ||
113a7413 BC |
1134 | /* |
1135 | * XXX Rewrite this code to maintain a list of enabled | |
1136 | * downstream hwmods for debugging purposes? | |
1137 | */ | |
d459bfe0 | 1138 | |
d043d87c | 1139 | if (!clkdm || !oh || !arch_clkdm || !arch_clkdm->clkdm_clk_disable) |
113a7413 | 1140 | return -EINVAL; |
fe617af7 | 1141 | |
3a090284 | 1142 | pwrdm_lock(clkdm->pwrdm.ptr); |
d043d87c MT |
1143 | |
1144 | if (atomic_read(&clkdm->usecount) == 0) { | |
3a090284 | 1145 | pwrdm_unlock(clkdm->pwrdm.ptr); |
d043d87c MT |
1146 | WARN_ON(1); /* underflow */ |
1147 | return -ERANGE; | |
1148 | } | |
1149 | ||
1150 | if (atomic_dec_return(&clkdm->usecount) > 0) { | |
3a090284 | 1151 | pwrdm_unlock(clkdm->pwrdm.ptr); |
d043d87c MT |
1152 | return 0; |
1153 | } | |
1154 | ||
1155 | arch_clkdm->clkdm_clk_disable(clkdm); | |
3a090284 PW |
1156 | pwrdm_state_switch_nolock(clkdm->pwrdm.ptr); |
1157 | pwrdm_unlock(clkdm->pwrdm.ptr); | |
d043d87c MT |
1158 | |
1159 | pr_debug("clockdomain: %s: disabled\n", clkdm->name); | |
1160 | ||
1161 | return 0; | |
d459bfe0 PW |
1162 | } |
1163 |