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