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