Commit | Line | Data |
---|---|---|
d459bfe0 | 1 | /* |
d459bfe0 PW |
2 | * OMAP2/3 clockdomain framework functions |
3 | * | |
b71c7217 | 4 | * Copyright (C) 2008, 2012 Texas Instruments, Inc. |
570b54c7 | 5 | * Copyright (C) 2008-2011 Nokia Corporation |
d459bfe0 | 6 | * |
dc0b3a70 | 7 | * Paul Walmsley |
d459bfe0 PW |
8 | * |
9 | * This program is free software; you can redistribute it and/or modify | |
10 | * it under the terms of the GNU General Public License version 2 as | |
11 | * published by the Free Software Foundation. | |
12 | */ | |
13 | ||
1540f214 PW |
14 | #ifndef __ARCH_ARM_MACH_OMAP2_CLOCKDOMAIN_H |
15 | #define __ARCH_ARM_MACH_OMAP2_CLOCKDOMAIN_H | |
d459bfe0 | 16 | |
dc0b3a70 | 17 | #include <linux/init.h> |
555e74ea | 18 | #include <linux/spinlock.h> |
dc0b3a70 | 19 | |
72e06d08 | 20 | #include "powerdomain.h" |
a135eaae | 21 | #include "clock.h" |
2a296c8f | 22 | #include "omap_hwmod.h" |
d459bfe0 | 23 | |
570b54c7 PW |
24 | /* |
25 | * Clockdomain flags | |
26 | * | |
27 | * XXX Document CLKDM_CAN_* flags | |
28 | * | |
29 | * CLKDM_NO_AUTODEPS: Prevent "autodeps" from being added/removed from this | |
30 | * clockdomain. (Currently, this applies to OMAP3 clockdomains only.) | |
006c7f18 PW |
31 | * CLKDM_ACTIVE_WITH_MPU: The PRCM guarantees that this clockdomain is |
32 | * active whenever the MPU is active. True for interconnects and | |
33 | * the WKUP clockdomains. | |
b71c7217 PW |
34 | * CLKDM_MISSING_IDLE_REPORTING: The idle status of the IP blocks and |
35 | * clocks inside this clockdomain are not taken into account by | |
36 | * the PRCM when determining whether the clockdomain is idle. | |
37 | * Without this flag, if the clockdomain is set to | |
38 | * hardware-supervised idle mode, the PRCM may transition the | |
39 | * enclosing powerdomain to a low power state, even when devices | |
40 | * inside the clockdomain and powerdomain are in use. (An example | |
41 | * of such a clockdomain is the EMU clockdomain on OMAP3/4.) If | |
42 | * this flag is set, and the clockdomain does not support the | |
43 | * force-sleep mode, then the HW_AUTO mode will be used to put the | |
44 | * clockdomain to sleep. Similarly, if the clockdomain supports | |
45 | * the force-wakeup mode, then it will be used whenever a clock or | |
46 | * IP block inside the clockdomain is active, rather than the | |
47 | * HW_AUTO mode. | |
570b54c7 | 48 | */ |
d459bfe0 PW |
49 | #define CLKDM_CAN_FORCE_SLEEP (1 << 0) |
50 | #define CLKDM_CAN_FORCE_WAKEUP (1 << 1) | |
51 | #define CLKDM_CAN_ENABLE_AUTO (1 << 2) | |
52 | #define CLKDM_CAN_DISABLE_AUTO (1 << 3) | |
570b54c7 | 53 | #define CLKDM_NO_AUTODEPS (1 << 4) |
006c7f18 | 54 | #define CLKDM_ACTIVE_WITH_MPU (1 << 5) |
b71c7217 | 55 | #define CLKDM_MISSING_IDLE_REPORTING (1 << 6) |
d459bfe0 PW |
56 | |
57 | #define CLKDM_CAN_HWSUP (CLKDM_CAN_ENABLE_AUTO | CLKDM_CAN_DISABLE_AUTO) | |
58 | #define CLKDM_CAN_SWSUP (CLKDM_CAN_FORCE_SLEEP | CLKDM_CAN_FORCE_WAKEUP) | |
59 | #define CLKDM_CAN_HWSUP_SWSUP (CLKDM_CAN_SWSUP | CLKDM_CAN_HWSUP) | |
60 | ||
f0271d65 PW |
61 | /** |
62 | * struct clkdm_autodep - clkdm deps to add when entering/exiting hwsup mode | |
63 | * @clkdm: clockdomain to add wkdep+sleepdep on - set name member only | |
f0271d65 PW |
64 | * |
65 | * A clockdomain that should have wkdeps and sleepdeps added when a | |
66 | * clockdomain should stay active in hwsup mode; and conversely, | |
67 | * removed when the clockdomain should be allowed to go inactive in | |
68 | * hwsup mode. | |
69 | * | |
70 | * Autodeps are deprecated and should be removed after | |
71 | * omap_hwmod-based fine-grained module idle control is added. | |
d459bfe0 | 72 | */ |
55ed9694 | 73 | struct clkdm_autodep { |
5b74c676 | 74 | union { |
5b74c676 | 75 | const char *name; |
55ed9694 PW |
76 | struct clockdomain *ptr; |
77 | } clkdm; | |
d459bfe0 PW |
78 | }; |
79 | ||
f0271d65 PW |
80 | /** |
81 | * struct clkdm_dep - encode dependencies between clockdomains | |
82 | * @clkdm_name: clockdomain name | |
83 | * @clkdm: pointer to the struct clockdomain of @clkdm_name | |
f0271d65 PW |
84 | * @wkdep_usecount: Number of wakeup dependencies causing this clkdm to wake |
85 | * @sleepdep_usecount: Number of sleep deps that could prevent clkdm from idle | |
86 | * | |
87 | * Statically defined. @clkdm is resolved from @clkdm_name at runtime and | |
88 | * should not be pre-initialized. | |
89 | * | |
90 | * XXX Should also include hardware (fixed) dependencies. | |
91 | */ | |
55ed9694 | 92 | struct clkdm_dep { |
55ed9694 | 93 | const char *clkdm_name; |
55ed9694 | 94 | struct clockdomain *clkdm; |
369d5614 | 95 | atomic_t wkdep_usecount; |
369d5614 | 96 | atomic_t sleepdep_usecount; |
55ed9694 PW |
97 | }; |
98 | ||
32a363c0 PW |
99 | /* Possible flags for struct clockdomain._flags */ |
100 | #define _CLKDM_FLAG_HWSUP_ENABLED BIT(0) | |
101 | ||
f0271d65 PW |
102 | /** |
103 | * struct clockdomain - OMAP clockdomain | |
104 | * @name: clockdomain name | |
105 | * @pwrdm: powerdomain containing this clockdomain | |
106 | * @clktrctrl_reg: CLKSTCTRL reg for the given clock domain | |
107 | * @clktrctrl_mask: CLKTRCTRL/AUTOSTATE field mask in CM_CLKSTCTRL reg | |
108 | * @flags: Clockdomain capability flags | |
32a363c0 | 109 | * @_flags: Flags for use only by internal clockdomain code |
f0271d65 | 110 | * @dep_bit: Bit shift of this clockdomain's PM_WKDEP/CM_SLEEPDEP bit |
bd2122ca PW |
111 | * @prcm_partition: (OMAP4 only) PRCM partition ID for this clkdm's registers |
112 | * @cm_inst: (OMAP4 only) CM instance register offset | |
113 | * @clkdm_offs: (OMAP4 only) CM clockdomain register offset | |
f0271d65 PW |
114 | * @wkdep_srcs: Clockdomains that can be told to wake this powerdomain up |
115 | * @sleepdep_srcs: Clockdomains that can be told to keep this clkdm from inact | |
f0271d65 PW |
116 | * @usecount: Usecount tracking |
117 | * @node: list_head to link all clockdomains together | |
bd2122ca PW |
118 | * |
119 | * @prcm_partition should be a macro from mach-omap2/prcm44xx.h (OMAP4 only) | |
120 | * @cm_inst should be a macro ending in _INST from the OMAP4 CM instance | |
121 | * definitions (OMAP4 only) | |
122 | * @clkdm_offs should be a macro ending in _CDOFFS from the OMAP4 CM instance | |
123 | * definitions (OMAP4 only) | |
f0271d65 | 124 | */ |
d459bfe0 | 125 | struct clockdomain { |
d459bfe0 | 126 | const char *name; |
5b74c676 | 127 | union { |
5b74c676 | 128 | const char *name; |
5b74c676 PW |
129 | struct powerdomain *ptr; |
130 | } pwrdm; | |
d459bfe0 | 131 | const u16 clktrctrl_mask; |
d459bfe0 | 132 | const u8 flags; |
32a363c0 | 133 | u8 _flags; |
55ed9694 | 134 | const u8 dep_bit; |
bd2122ca PW |
135 | const u8 prcm_partition; |
136 | const s16 cm_inst; | |
137 | const u16 clkdm_offs; | |
55ed9694 | 138 | struct clkdm_dep *wkdep_srcs; |
55ed9694 | 139 | struct clkdm_dep *sleepdep_srcs; |
d459bfe0 | 140 | atomic_t usecount; |
d459bfe0 | 141 | struct list_head node; |
555e74ea | 142 | spinlock_t lock; |
d459bfe0 PW |
143 | }; |
144 | ||
32d4034e | 145 | /** |
25985edc | 146 | * struct clkdm_ops - Arch specific function implementations |
32d4034e RN |
147 | * @clkdm_add_wkdep: Add a wakeup dependency between clk domains |
148 | * @clkdm_del_wkdep: Delete a wakeup dependency between clk domains | |
149 | * @clkdm_read_wkdep: Read wakeup dependency state between clk domains | |
150 | * @clkdm_clear_all_wkdeps: Remove all wakeup dependencies from the clk domain | |
151 | * @clkdm_add_sleepdep: Add a sleep dependency between clk domains | |
152 | * @clkdm_del_sleepdep: Delete a sleep dependency between clk domains | |
153 | * @clkdm_read_sleepdep: Read sleep dependency state between clk domains | |
154 | * @clkdm_clear_all_sleepdeps: Remove all sleep dependencies from the clk domain | |
155 | * @clkdm_sleep: Force a clockdomain to sleep | |
156 | * @clkdm_wakeup: Force a clockdomain to wakeup | |
157 | * @clkdm_allow_idle: Enable hw supervised idle transitions for clock domain | |
158 | * @clkdm_deny_idle: Disable hw supervised idle transitions for clock domain | |
159 | * @clkdm_clk_enable: Put the clkdm in right state for a clock enable | |
160 | * @clkdm_clk_disable: Put the clkdm in right state for a clock disable | |
161 | */ | |
162 | struct clkdm_ops { | |
163 | int (*clkdm_add_wkdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); | |
164 | int (*clkdm_del_wkdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); | |
165 | int (*clkdm_read_wkdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); | |
166 | int (*clkdm_clear_all_wkdeps)(struct clockdomain *clkdm); | |
167 | int (*clkdm_add_sleepdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); | |
168 | int (*clkdm_del_sleepdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); | |
169 | int (*clkdm_read_sleepdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); | |
170 | int (*clkdm_clear_all_sleepdeps)(struct clockdomain *clkdm); | |
171 | int (*clkdm_sleep)(struct clockdomain *clkdm); | |
172 | int (*clkdm_wakeup)(struct clockdomain *clkdm); | |
173 | void (*clkdm_allow_idle)(struct clockdomain *clkdm); | |
174 | void (*clkdm_deny_idle)(struct clockdomain *clkdm); | |
175 | int (*clkdm_clk_enable)(struct clockdomain *clkdm); | |
176 | int (*clkdm_clk_disable)(struct clockdomain *clkdm); | |
177 | }; | |
178 | ||
08cb9703 PW |
179 | int clkdm_register_platform_funcs(struct clkdm_ops *co); |
180 | int clkdm_register_autodeps(struct clkdm_autodep *ia); | |
181 | int clkdm_register_clkdms(struct clockdomain **c); | |
182 | int clkdm_complete_init(void); | |
183 | ||
d459bfe0 PW |
184 | struct clockdomain *clkdm_lookup(const char *name); |
185 | ||
a23456e9 PDS |
186 | int clkdm_for_each(int (*fn)(struct clockdomain *clkdm, void *user), |
187 | void *user); | |
d459bfe0 PW |
188 | struct powerdomain *clkdm_get_pwrdm(struct clockdomain *clkdm); |
189 | ||
55ed9694 PW |
190 | int clkdm_add_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); |
191 | int clkdm_del_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); | |
192 | int clkdm_read_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); | |
369d5614 | 193 | int clkdm_clear_all_wkdeps(struct clockdomain *clkdm); |
55ed9694 PW |
194 | int clkdm_add_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); |
195 | int clkdm_del_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); | |
196 | int clkdm_read_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); | |
369d5614 | 197 | int clkdm_clear_all_sleepdeps(struct clockdomain *clkdm); |
55ed9694 | 198 | |
5cd1937b RN |
199 | void clkdm_allow_idle(struct clockdomain *clkdm); |
200 | void clkdm_deny_idle(struct clockdomain *clkdm); | |
32a363c0 | 201 | bool clkdm_in_hwsup(struct clockdomain *clkdm); |
b71c7217 | 202 | bool clkdm_missing_idle_reporting(struct clockdomain *clkdm); |
d459bfe0 | 203 | |
68b921ad RN |
204 | int clkdm_wakeup(struct clockdomain *clkdm); |
205 | int clkdm_sleep(struct clockdomain *clkdm); | |
d459bfe0 | 206 | |
4da71ae6 RN |
207 | int clkdm_clk_enable(struct clockdomain *clkdm, struct clk *clk); |
208 | int clkdm_clk_disable(struct clockdomain *clkdm, struct clk *clk); | |
113a7413 BC |
209 | int clkdm_hwmod_enable(struct clockdomain *clkdm, struct omap_hwmod *oh); |
210 | int clkdm_hwmod_disable(struct clockdomain *clkdm, struct omap_hwmod *oh); | |
d459bfe0 | 211 | |
a5ffef6a PW |
212 | extern void __init omap242x_clockdomains_init(void); |
213 | extern void __init omap243x_clockdomains_init(void); | |
4aef7a2a | 214 | extern void __init omap3xxx_clockdomains_init(void); |
9c80f3aa | 215 | extern void __init am33xx_clockdomains_init(void); |
dc0b3a70 | 216 | extern void __init omap44xx_clockdomains_init(void); |
5cd1937b RN |
217 | extern void _clkdm_add_autodeps(struct clockdomain *clkdm); |
218 | extern void _clkdm_del_autodeps(struct clockdomain *clkdm); | |
dc0b3a70 | 219 | |
4aef7a2a RN |
220 | extern struct clkdm_ops omap2_clkdm_operations; |
221 | extern struct clkdm_ops omap3_clkdm_operations; | |
68b921ad | 222 | extern struct clkdm_ops omap4_clkdm_operations; |
9c80f3aa | 223 | extern struct clkdm_ops am33xx_clkdm_operations; |
dc0b3a70 | 224 | |
a5ffef6a PW |
225 | extern struct clkdm_dep gfx_24xx_wkdeps[]; |
226 | extern struct clkdm_dep dsp_24xx_wkdeps[]; | |
227 | extern struct clockdomain wkup_common_clkdm; | |
a5ffef6a | 228 | |
d459bfe0 | 229 | #endif |