1 /*
2  * OMAP2/3 clockdomain framework functions
3  *
4  * Copyright (C) 2008, 2012 Texas Instruments, Inc.
5  * Copyright (C) 2008-2011 Nokia Corporation
6  *
7  * Paul Walmsley
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 
14 #ifndef __ARCH_ARM_MACH_OMAP2_CLOCKDOMAIN_H
15 #define __ARCH_ARM_MACH_OMAP2_CLOCKDOMAIN_H
16 
17 #include <linux/init.h>
18 
19 #include "powerdomain.h"
20 #include "clock.h"
21 
22 /*
23  * Clockdomain flags
24  *
25  * XXX Document CLKDM_CAN_* flags
26  *
27  * CLKDM_NO_AUTODEPS: Prevent "autodeps" from being added/removed from this
28  *     clockdomain.  (Currently, this applies to OMAP3 clockdomains only.)
29  * CLKDM_ACTIVE_WITH_MPU: The PRCM guarantees that this clockdomain is
30  *     active whenever the MPU is active.  True for interconnects and
31  *     the WKUP clockdomains.
32  * CLKDM_MISSING_IDLE_REPORTING: The idle status of the IP blocks and
33  *     clocks inside this clockdomain are not taken into account by
34  *     the PRCM when determining whether the clockdomain is idle.
35  *     Without this flag, if the clockdomain is set to
36  *     hardware-supervised idle mode, the PRCM may transition the
37  *     enclosing powerdomain to a low power state, even when devices
38  *     inside the clockdomain and powerdomain are in use.  (An example
39  *     of such a clockdomain is the EMU clockdomain on OMAP3/4.)  If
40  *     this flag is set, and the clockdomain does not support the
41  *     force-sleep mode, then the HW_AUTO mode will be used to put the
42  *     clockdomain to sleep.  Similarly, if the clockdomain supports
43  *     the force-wakeup mode, then it will be used whenever a clock or
44  *     IP block inside the clockdomain is active, rather than the
45  *     HW_AUTO mode.
46  */
47 #define CLKDM_CAN_FORCE_SLEEP			(1 << 0)
48 #define CLKDM_CAN_FORCE_WAKEUP			(1 << 1)
49 #define CLKDM_CAN_ENABLE_AUTO			(1 << 2)
50 #define CLKDM_CAN_DISABLE_AUTO			(1 << 3)
51 #define CLKDM_NO_AUTODEPS			(1 << 4)
52 #define CLKDM_ACTIVE_WITH_MPU			(1 << 5)
53 #define CLKDM_MISSING_IDLE_REPORTING		(1 << 6)
54 
55 #define CLKDM_CAN_HWSUP		(CLKDM_CAN_ENABLE_AUTO | CLKDM_CAN_DISABLE_AUTO)
56 #define CLKDM_CAN_SWSUP		(CLKDM_CAN_FORCE_SLEEP | CLKDM_CAN_FORCE_WAKEUP)
57 #define CLKDM_CAN_HWSUP_SWSUP	(CLKDM_CAN_SWSUP | CLKDM_CAN_HWSUP)
58 
59 /**
60  * struct clkdm_autodep - clkdm deps to add when entering/exiting hwsup mode
61  * @clkdm: clockdomain to add wkdep+sleepdep on - set name member only
62  *
63  * A clockdomain that should have wkdeps and sleepdeps added when a
64  * clockdomain should stay active in hwsup mode; and conversely,
65  * removed when the clockdomain should be allowed to go inactive in
66  * hwsup mode.
67  *
68  * Autodeps are deprecated and should be removed after
69  * omap_hwmod-based fine-grained module idle control is added.
70  */
71 struct clkdm_autodep {
72 	union {
73 		const char *name;
74 		struct clockdomain *ptr;
75 	} clkdm;
76 };
77 
78 /**
79  * struct clkdm_dep - encode dependencies between clockdomains
80  * @clkdm_name: clockdomain name
81  * @clkdm: pointer to the struct clockdomain of @clkdm_name
82  * @wkdep_usecount: Number of wakeup dependencies causing this clkdm to wake
83  * @sleepdep_usecount: Number of sleep deps that could prevent clkdm from idle
84  *
85  * Statically defined.  @clkdm is resolved from @clkdm_name at runtime and
86  * should not be pre-initialized.
87  *
88  * XXX Should also include hardware (fixed) dependencies.
89  */
90 struct clkdm_dep {
91 	const char *clkdm_name;
92 	struct clockdomain *clkdm;
93 	s16 wkdep_usecount;
94 	s16 sleepdep_usecount;
95 };
96 
97 /* Possible flags for struct clockdomain._flags */
98 #define _CLKDM_FLAG_HWSUP_ENABLED		BIT(0)
99 
100 struct omap_hwmod;
101 
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
109  * @_flags: Flags for use only by internal clockdomain code
110  * @dep_bit: Bit shift of this clockdomain's PM_WKDEP/CM_SLEEPDEP bit
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
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
116  * @usecount: Usecount tracking
117  * @forcewake_count: Usecount for forcing the domain active
118  * @node: list_head to link all clockdomains together
119  *
120  * @prcm_partition should be a macro from mach-omap2/prcm44xx.h (OMAP4 only)
121  * @cm_inst should be a macro ending in _INST from the OMAP4 CM instance
122  *     definitions (OMAP4 only)
123  * @clkdm_offs should be a macro ending in _CDOFFS from the OMAP4 CM instance
124  *     definitions (OMAP4 only)
125  */
126 struct clockdomain {
127 	const char *name;
128 	union {
129 		const char *name;
130 		struct powerdomain *ptr;
131 	} pwrdm;
132 	const u16 clktrctrl_mask;
133 	const u8 flags;
134 	u8 _flags;
135 	const u8 dep_bit;
136 	const u8 prcm_partition;
137 	const u16 cm_inst;
138 	const u16 clkdm_offs;
139 	struct clkdm_dep *wkdep_srcs;
140 	struct clkdm_dep *sleepdep_srcs;
141 	int usecount;
142 	int forcewake_count;
143 	struct list_head node;
144 	u32 context;
145 };
146 
147 /**
148  * struct clkdm_ops - Arch specific function implementations
149  * @clkdm_add_wkdep: Add a wakeup dependency between clk domains
150  * @clkdm_del_wkdep: Delete a wakeup dependency between clk domains
151  * @clkdm_read_wkdep: Read wakeup dependency state between clk domains
152  * @clkdm_clear_all_wkdeps: Remove all wakeup dependencies from the clk domain
153  * @clkdm_add_sleepdep: Add a sleep dependency between clk domains
154  * @clkdm_del_sleepdep: Delete a sleep dependency between clk domains
155  * @clkdm_read_sleepdep: Read sleep dependency state between clk domains
156  * @clkdm_clear_all_sleepdeps: Remove all sleep dependencies from the clk domain
157  * @clkdm_sleep: Force a clockdomain to sleep
158  * @clkdm_wakeup: Force a clockdomain to wakeup
159  * @clkdm_allow_idle: Enable hw supervised idle transitions for clock domain
160  * @clkdm_deny_idle: Disable hw supervised idle transitions for clock domain
161  * @clkdm_clk_enable: Put the clkdm in right state for a clock enable
162  * @clkdm_clk_disable: Put the clkdm in right state for a clock disable
163  * @clkdm_save_context: Save the current clkdm context
164  * @clkdm_restore_context: Restore the clkdm context
165  */
166 struct clkdm_ops {
167 	int	(*clkdm_add_wkdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
168 	int	(*clkdm_del_wkdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
169 	int	(*clkdm_read_wkdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
170 	int	(*clkdm_clear_all_wkdeps)(struct clockdomain *clkdm);
171 	int	(*clkdm_add_sleepdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
172 	int	(*clkdm_del_sleepdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
173 	int	(*clkdm_read_sleepdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
174 	int	(*clkdm_clear_all_sleepdeps)(struct clockdomain *clkdm);
175 	int	(*clkdm_sleep)(struct clockdomain *clkdm);
176 	int	(*clkdm_wakeup)(struct clockdomain *clkdm);
177 	void	(*clkdm_allow_idle)(struct clockdomain *clkdm);
178 	void	(*clkdm_deny_idle)(struct clockdomain *clkdm);
179 	int	(*clkdm_clk_enable)(struct clockdomain *clkdm);
180 	int	(*clkdm_clk_disable)(struct clockdomain *clkdm);
181 	int	(*clkdm_save_context)(struct clockdomain *clkdm);
182 	int	(*clkdm_restore_context)(struct clockdomain *clkdm);
183 };
184 
185 int clkdm_register_platform_funcs(struct clkdm_ops *co);
186 int clkdm_register_autodeps(struct clkdm_autodep *ia);
187 int clkdm_register_clkdms(struct clockdomain **c);
188 int clkdm_complete_init(void);
189 
190 struct clockdomain *clkdm_lookup(const char *name);
191 
192 int clkdm_for_each(int (*fn)(struct clockdomain *clkdm, void *user),
193 			void *user);
194 struct powerdomain *clkdm_get_pwrdm(struct clockdomain *clkdm);
195 
196 int clkdm_add_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
197 int clkdm_del_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
198 int clkdm_read_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
199 int clkdm_clear_all_wkdeps(struct clockdomain *clkdm);
200 int clkdm_add_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
201 int clkdm_del_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
202 int clkdm_read_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
203 int clkdm_clear_all_sleepdeps(struct clockdomain *clkdm);
204 
205 void clkdm_allow_idle_nolock(struct clockdomain *clkdm);
206 void clkdm_allow_idle(struct clockdomain *clkdm);
207 void clkdm_deny_idle_nolock(struct clockdomain *clkdm);
208 void clkdm_deny_idle(struct clockdomain *clkdm);
209 bool clkdm_in_hwsup(struct clockdomain *clkdm);
210 bool clkdm_missing_idle_reporting(struct clockdomain *clkdm);
211 
212 int clkdm_wakeup_nolock(struct clockdomain *clkdm);
213 int clkdm_wakeup(struct clockdomain *clkdm);
214 int clkdm_sleep_nolock(struct clockdomain *clkdm);
215 int clkdm_sleep(struct clockdomain *clkdm);
216 
217 int clkdm_clk_enable(struct clockdomain *clkdm, struct clk *clk);
218 int clkdm_clk_disable(struct clockdomain *clkdm, struct clk *clk);
219 int clkdm_hwmod_enable(struct clockdomain *clkdm, struct omap_hwmod *oh);
220 int clkdm_hwmod_disable(struct clockdomain *clkdm, struct omap_hwmod *oh);
221 
222 void clkdm_save_context(void);
223 void clkdm_restore_context(void);
224 
225 extern void __init omap242x_clockdomains_init(void);
226 extern void __init omap243x_clockdomains_init(void);
227 extern void __init omap3xxx_clockdomains_init(void);
228 extern void __init am33xx_clockdomains_init(void);
229 extern void __init ti814x_clockdomains_init(void);
230 extern void __init ti816x_clockdomains_init(void);
231 extern void __init omap44xx_clockdomains_init(void);
232 extern void __init omap54xx_clockdomains_init(void);
233 extern void __init dra7xx_clockdomains_init(void);
234 void am43xx_clockdomains_init(void);
235 
236 extern void clkdm_add_autodeps(struct clockdomain *clkdm);
237 extern void clkdm_del_autodeps(struct clockdomain *clkdm);
238 
239 extern struct clkdm_ops omap2_clkdm_operations;
240 extern struct clkdm_ops omap3_clkdm_operations;
241 extern struct clkdm_ops omap4_clkdm_operations;
242 extern struct clkdm_ops am33xx_clkdm_operations;
243 extern struct clkdm_ops am43xx_clkdm_operations;
244 
245 extern struct clkdm_dep gfx_24xx_wkdeps[];
246 extern struct clkdm_dep dsp_24xx_wkdeps[];
247 extern struct clockdomain wkup_common_clkdm;
248 
249 #endif
250