Commit | Line | Data |
---|---|---|
b2476490 MT |
1 | /* |
2 | * linux/include/linux/clk-provider.h | |
3 | * | |
4 | * Copyright (c) 2010-2011 Jeremy Kerr <jeremy.kerr@canonical.com> | |
5 | * Copyright (C) 2011-2012 Linaro Ltd <mturquette@linaro.org> | |
6 | * | |
7 | * This program is free software; you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License version 2 as | |
9 | * published by the Free Software Foundation. | |
10 | */ | |
11 | #ifndef __LINUX_CLK_PROVIDER_H | |
12 | #define __LINUX_CLK_PROVIDER_H | |
13 | ||
14 | #include <linux/clk.h> | |
15 | ||
16 | #ifdef CONFIG_COMMON_CLK | |
17 | ||
b2476490 MT |
18 | /* |
19 | * flags used across common struct clk. these flags should only affect the | |
20 | * top-level framework. custom flags for dealing with hardware specifics | |
21 | * belong in struct clk_foo | |
22 | */ | |
23 | #define CLK_SET_RATE_GATE BIT(0) /* must be gated across rate change */ | |
24 | #define CLK_SET_PARENT_GATE BIT(1) /* must be gated across re-parent */ | |
25 | #define CLK_SET_RATE_PARENT BIT(2) /* propagate rate change up one level */ | |
26 | #define CLK_IGNORE_UNUSED BIT(3) /* do not gate even if unused */ | |
27 | #define CLK_IS_ROOT BIT(4) /* root clk, has no parent */ | |
f7d8caad | 28 | #define CLK_IS_BASIC BIT(5) /* Basic clk, can't do a to_clk_foo() */ |
a093bde2 | 29 | #define CLK_GET_RATE_NOCACHE BIT(6) /* do not use the cached clk rate */ |
b2476490 | 30 | |
0197b3ea SK |
31 | struct clk_hw; |
32 | ||
b2476490 MT |
33 | /** |
34 | * struct clk_ops - Callback operations for hardware clocks; these are to | |
35 | * be provided by the clock implementation, and will be called by drivers | |
36 | * through the clk_* api. | |
37 | * | |
38 | * @prepare: Prepare the clock for enabling. This must not return until | |
39 | * the clock is fully prepared, and it's safe to call clk_enable. | |
40 | * This callback is intended to allow clock implementations to | |
41 | * do any initialisation that may sleep. Called with | |
42 | * prepare_lock held. | |
43 | * | |
44 | * @unprepare: Release the clock from its prepared state. This will typically | |
45 | * undo any work done in the @prepare callback. Called with | |
46 | * prepare_lock held. | |
47 | * | |
3d6ee287 UH |
48 | * @is_prepared: Queries the hardware to determine if the clock is prepared. |
49 | * This function is allowed to sleep. Optional, if this op is not | |
50 | * set then the prepare count will be used. | |
51 | * | |
3cc8247f UH |
52 | * @unprepare_unused: Unprepare the clock atomically. Only called from |
53 | * clk_disable_unused for prepare clocks with special needs. | |
54 | * Called with prepare mutex held. This function may sleep. | |
55 | * | |
b2476490 MT |
56 | * @enable: Enable the clock atomically. This must not return until the |
57 | * clock is generating a valid clock signal, usable by consumer | |
58 | * devices. Called with enable_lock held. This function must not | |
59 | * sleep. | |
60 | * | |
61 | * @disable: Disable the clock atomically. Called with enable_lock held. | |
62 | * This function must not sleep. | |
63 | * | |
119c7127 SB |
64 | * @is_enabled: Queries the hardware to determine if the clock is enabled. |
65 | * This function must not sleep. Optional, if this op is not | |
66 | * set then the enable count will be used. | |
67 | * | |
7c045a55 MT |
68 | * @disable_unused: Disable the clock atomically. Only called from |
69 | * clk_disable_unused for gate clocks with special needs. | |
70 | * Called with enable_lock held. This function must not | |
71 | * sleep. | |
72 | * | |
7ce3e8cc | 73 | * @recalc_rate Recalculate the rate of this clock, by querying hardware. The |
b2476490 | 74 | * parent rate is an input parameter. It is up to the caller to |
7ce3e8cc | 75 | * ensure that the prepare_mutex is held across this call. |
b2476490 MT |
76 | * Returns the calculated rate. Optional, but recommended - if |
77 | * this op is not set then clock rate will be initialized to 0. | |
78 | * | |
79 | * @round_rate: Given a target rate as input, returns the closest rate actually | |
80 | * supported by the clock. | |
81 | * | |
82 | * @get_parent: Queries the hardware to determine the parent of a clock. The | |
83 | * return value is a u8 which specifies the index corresponding to | |
84 | * the parent clock. This index can be applied to either the | |
85 | * .parent_names or .parents arrays. In short, this function | |
86 | * translates the parent value read from hardware into an array | |
87 | * index. Currently only called when the clock is initialized by | |
88 | * __clk_init. This callback is mandatory for clocks with | |
89 | * multiple parents. It is optional (and unnecessary) for clocks | |
90 | * with 0 or 1 parents. | |
91 | * | |
92 | * @set_parent: Change the input source of this clock; for clocks with multiple | |
93 | * possible parents specify a new parent by passing in the index | |
94 | * as a u8 corresponding to the parent in either the .parent_names | |
95 | * or .parents arrays. This function in affect translates an | |
96 | * array index into the value programmed into the hardware. | |
97 | * Returns 0 on success, -EERROR otherwise. | |
98 | * | |
1c0035d7 SG |
99 | * @set_rate: Change the rate of this clock. The requested rate is specified |
100 | * by the second argument, which should typically be the return | |
101 | * of .round_rate call. The third argument gives the parent rate | |
102 | * which is likely helpful for most .set_rate implementation. | |
103 | * Returns 0 on success, -EERROR otherwise. | |
b2476490 MT |
104 | * |
105 | * The clk_enable/clk_disable and clk_prepare/clk_unprepare pairs allow | |
106 | * implementations to split any work between atomic (enable) and sleepable | |
107 | * (prepare) contexts. If enabling a clock requires code that might sleep, | |
108 | * this must be done in clk_prepare. Clock enable code that will never be | |
7ce3e8cc | 109 | * called in a sleepable context may be implemented in clk_enable. |
b2476490 MT |
110 | * |
111 | * Typically, drivers will call clk_prepare when a clock may be needed later | |
112 | * (eg. when a device is opened), and clk_enable when the clock is actually | |
113 | * required (eg. from an interrupt). Note that clk_prepare MUST have been | |
114 | * called before clk_enable. | |
115 | */ | |
116 | struct clk_ops { | |
117 | int (*prepare)(struct clk_hw *hw); | |
118 | void (*unprepare)(struct clk_hw *hw); | |
3d6ee287 | 119 | int (*is_prepared)(struct clk_hw *hw); |
3cc8247f | 120 | void (*unprepare_unused)(struct clk_hw *hw); |
b2476490 MT |
121 | int (*enable)(struct clk_hw *hw); |
122 | void (*disable)(struct clk_hw *hw); | |
123 | int (*is_enabled)(struct clk_hw *hw); | |
7c045a55 | 124 | void (*disable_unused)(struct clk_hw *hw); |
b2476490 MT |
125 | unsigned long (*recalc_rate)(struct clk_hw *hw, |
126 | unsigned long parent_rate); | |
127 | long (*round_rate)(struct clk_hw *hw, unsigned long, | |
128 | unsigned long *); | |
129 | int (*set_parent)(struct clk_hw *hw, u8 index); | |
130 | u8 (*get_parent)(struct clk_hw *hw); | |
1c0035d7 SG |
131 | int (*set_rate)(struct clk_hw *hw, unsigned long, |
132 | unsigned long); | |
b2476490 MT |
133 | void (*init)(struct clk_hw *hw); |
134 | }; | |
135 | ||
0197b3ea SK |
136 | /** |
137 | * struct clk_init_data - holds init data that's common to all clocks and is | |
138 | * shared between the clock provider and the common clock framework. | |
139 | * | |
140 | * @name: clock name | |
141 | * @ops: operations this clock supports | |
142 | * @parent_names: array of string names for all possible parents | |
143 | * @num_parents: number of possible parents | |
144 | * @flags: framework-level hints and quirks | |
145 | */ | |
146 | struct clk_init_data { | |
147 | const char *name; | |
148 | const struct clk_ops *ops; | |
149 | const char **parent_names; | |
150 | u8 num_parents; | |
151 | unsigned long flags; | |
152 | }; | |
153 | ||
154 | /** | |
155 | * struct clk_hw - handle for traversing from a struct clk to its corresponding | |
156 | * hardware-specific structure. struct clk_hw should be declared within struct | |
157 | * clk_foo and then referenced by the struct clk instance that uses struct | |
158 | * clk_foo's clk_ops | |
159 | * | |
160 | * @clk: pointer to the struct clk instance that points back to this struct | |
161 | * clk_hw instance | |
162 | * | |
163 | * @init: pointer to struct clk_init_data that contains the init data shared | |
164 | * with the common clock framework. | |
165 | */ | |
166 | struct clk_hw { | |
167 | struct clk *clk; | |
dc4cd941 | 168 | const struct clk_init_data *init; |
0197b3ea SK |
169 | }; |
170 | ||
9d9f78ed MT |
171 | /* |
172 | * DOC: Basic clock implementations common to many platforms | |
173 | * | |
174 | * Each basic clock hardware type is comprised of a structure describing the | |
175 | * clock hardware, implementations of the relevant callbacks in struct clk_ops, | |
176 | * unique flags for that hardware type, a registration function and an | |
177 | * alternative macro for static initialization | |
178 | */ | |
179 | ||
180 | /** | |
181 | * struct clk_fixed_rate - fixed-rate clock | |
182 | * @hw: handle between common and hardware-specific interfaces | |
183 | * @fixed_rate: constant frequency of clock | |
184 | */ | |
185 | struct clk_fixed_rate { | |
186 | struct clk_hw hw; | |
187 | unsigned long fixed_rate; | |
188 | u8 flags; | |
189 | }; | |
190 | ||
bffad66e | 191 | extern const struct clk_ops clk_fixed_rate_ops; |
9d9f78ed MT |
192 | struct clk *clk_register_fixed_rate(struct device *dev, const char *name, |
193 | const char *parent_name, unsigned long flags, | |
194 | unsigned long fixed_rate); | |
195 | ||
015ba402 GL |
196 | void of_fixed_clk_setup(struct device_node *np); |
197 | ||
9d9f78ed MT |
198 | /** |
199 | * struct clk_gate - gating clock | |
200 | * | |
201 | * @hw: handle between common and hardware-specific interfaces | |
202 | * @reg: register controlling gate | |
203 | * @bit_idx: single bit controlling gate | |
204 | * @flags: hardware-specific flags | |
205 | * @lock: register lock | |
206 | * | |
207 | * Clock which can gate its output. Implements .enable & .disable | |
208 | * | |
209 | * Flags: | |
1f73f31a | 210 | * CLK_GATE_SET_TO_DISABLE - by default this clock sets the bit at bit_idx to |
9d9f78ed MT |
211 | * enable the clock. Setting this flag does the opposite: setting the bit |
212 | * disable the clock and clearing it enables the clock | |
213 | */ | |
214 | struct clk_gate { | |
215 | struct clk_hw hw; | |
216 | void __iomem *reg; | |
217 | u8 bit_idx; | |
218 | u8 flags; | |
219 | spinlock_t *lock; | |
9d9f78ed MT |
220 | }; |
221 | ||
222 | #define CLK_GATE_SET_TO_DISABLE BIT(0) | |
223 | ||
bffad66e | 224 | extern const struct clk_ops clk_gate_ops; |
9d9f78ed MT |
225 | struct clk *clk_register_gate(struct device *dev, const char *name, |
226 | const char *parent_name, unsigned long flags, | |
227 | void __iomem *reg, u8 bit_idx, | |
228 | u8 clk_gate_flags, spinlock_t *lock); | |
229 | ||
357c3f0a RN |
230 | struct clk_div_table { |
231 | unsigned int val; | |
232 | unsigned int div; | |
233 | }; | |
234 | ||
9d9f78ed MT |
235 | /** |
236 | * struct clk_divider - adjustable divider clock | |
237 | * | |
238 | * @hw: handle between common and hardware-specific interfaces | |
239 | * @reg: register containing the divider | |
240 | * @shift: shift to the divider bit field | |
241 | * @width: width of the divider bit field | |
357c3f0a | 242 | * @table: array of value/divider pairs, last entry should have div = 0 |
9d9f78ed MT |
243 | * @lock: register lock |
244 | * | |
245 | * Clock with an adjustable divider affecting its output frequency. Implements | |
246 | * .recalc_rate, .set_rate and .round_rate | |
247 | * | |
248 | * Flags: | |
249 | * CLK_DIVIDER_ONE_BASED - by default the divisor is the value read from the | |
250 | * register plus one. If CLK_DIVIDER_ONE_BASED is set then the divider is | |
251 | * the raw value read from the register, with the value of zero considered | |
056b2053 | 252 | * invalid, unless CLK_DIVIDER_ALLOW_ZERO is set. |
9d9f78ed MT |
253 | * CLK_DIVIDER_POWER_OF_TWO - clock divisor is 2 raised to the value read from |
254 | * the hardware register | |
056b2053 SB |
255 | * CLK_DIVIDER_ALLOW_ZERO - Allow zero divisors. For dividers which have |
256 | * CLK_DIVIDER_ONE_BASED set, it is possible to end up with a zero divisor. | |
257 | * Some hardware implementations gracefully handle this case and allow a | |
258 | * zero divisor by not modifying their input clock | |
259 | * (divide by one / bypass). | |
9d9f78ed MT |
260 | */ |
261 | struct clk_divider { | |
262 | struct clk_hw hw; | |
263 | void __iomem *reg; | |
264 | u8 shift; | |
265 | u8 width; | |
266 | u8 flags; | |
357c3f0a | 267 | const struct clk_div_table *table; |
9d9f78ed | 268 | spinlock_t *lock; |
9d9f78ed MT |
269 | }; |
270 | ||
271 | #define CLK_DIVIDER_ONE_BASED BIT(0) | |
272 | #define CLK_DIVIDER_POWER_OF_TWO BIT(1) | |
056b2053 | 273 | #define CLK_DIVIDER_ALLOW_ZERO BIT(2) |
9d9f78ed | 274 | |
bffad66e | 275 | extern const struct clk_ops clk_divider_ops; |
9d9f78ed MT |
276 | struct clk *clk_register_divider(struct device *dev, const char *name, |
277 | const char *parent_name, unsigned long flags, | |
278 | void __iomem *reg, u8 shift, u8 width, | |
279 | u8 clk_divider_flags, spinlock_t *lock); | |
357c3f0a RN |
280 | struct clk *clk_register_divider_table(struct device *dev, const char *name, |
281 | const char *parent_name, unsigned long flags, | |
282 | void __iomem *reg, u8 shift, u8 width, | |
283 | u8 clk_divider_flags, const struct clk_div_table *table, | |
284 | spinlock_t *lock); | |
9d9f78ed MT |
285 | |
286 | /** | |
287 | * struct clk_mux - multiplexer clock | |
288 | * | |
289 | * @hw: handle between common and hardware-specific interfaces | |
290 | * @reg: register controlling multiplexer | |
291 | * @shift: shift to multiplexer bit field | |
292 | * @width: width of mutliplexer bit field | |
3566d40c | 293 | * @flags: hardware-specific flags |
9d9f78ed MT |
294 | * @lock: register lock |
295 | * | |
296 | * Clock with multiple selectable parents. Implements .get_parent, .set_parent | |
297 | * and .recalc_rate | |
298 | * | |
299 | * Flags: | |
300 | * CLK_MUX_INDEX_ONE - register index starts at 1, not 0 | |
1f73f31a | 301 | * CLK_MUX_INDEX_BIT - register index is a single bit (power of two) |
9d9f78ed MT |
302 | */ |
303 | struct clk_mux { | |
304 | struct clk_hw hw; | |
305 | void __iomem *reg; | |
ce4f3313 PDS |
306 | u32 *table; |
307 | u32 mask; | |
9d9f78ed | 308 | u8 shift; |
9d9f78ed MT |
309 | u8 flags; |
310 | spinlock_t *lock; | |
311 | }; | |
312 | ||
313 | #define CLK_MUX_INDEX_ONE BIT(0) | |
314 | #define CLK_MUX_INDEX_BIT BIT(1) | |
315 | ||
bffad66e | 316 | extern const struct clk_ops clk_mux_ops; |
ce4f3313 | 317 | |
9d9f78ed | 318 | struct clk *clk_register_mux(struct device *dev, const char *name, |
d305fb78 | 319 | const char **parent_names, u8 num_parents, unsigned long flags, |
9d9f78ed MT |
320 | void __iomem *reg, u8 shift, u8 width, |
321 | u8 clk_mux_flags, spinlock_t *lock); | |
b2476490 | 322 | |
ce4f3313 PDS |
323 | struct clk *clk_register_mux_table(struct device *dev, const char *name, |
324 | const char **parent_names, u8 num_parents, unsigned long flags, | |
325 | void __iomem *reg, u8 shift, u32 mask, | |
326 | u8 clk_mux_flags, u32 *table, spinlock_t *lock); | |
327 | ||
79b16641 GC |
328 | void of_fixed_factor_clk_setup(struct device_node *node); |
329 | ||
f0948f59 SH |
330 | /** |
331 | * struct clk_fixed_factor - fixed multiplier and divider clock | |
332 | * | |
333 | * @hw: handle between common and hardware-specific interfaces | |
334 | * @mult: multiplier | |
335 | * @div: divider | |
336 | * | |
337 | * Clock with a fixed multiplier and divider. The output frequency is the | |
338 | * parent clock rate divided by div and multiplied by mult. | |
339 | * Implements .recalc_rate, .set_rate and .round_rate | |
340 | */ | |
341 | ||
342 | struct clk_fixed_factor { | |
343 | struct clk_hw hw; | |
344 | unsigned int mult; | |
345 | unsigned int div; | |
346 | }; | |
347 | ||
348 | extern struct clk_ops clk_fixed_factor_ops; | |
349 | struct clk *clk_register_fixed_factor(struct device *dev, const char *name, | |
350 | const char *parent_name, unsigned long flags, | |
351 | unsigned int mult, unsigned int div); | |
352 | ||
ece70094 PG |
353 | /*** |
354 | * struct clk_composite - aggregate clock of mux, divider and gate clocks | |
355 | * | |
356 | * @hw: handle between common and hardware-specific interfaces | |
d3a1c7be MT |
357 | * @mux_hw: handle between composite and hardware-specific mux clock |
358 | * @rate_hw: handle between composite and hardware-specific rate clock | |
359 | * @gate_hw: handle between composite and hardware-specific gate clock | |
ece70094 | 360 | * @mux_ops: clock ops for mux |
d3a1c7be | 361 | * @rate_ops: clock ops for rate |
ece70094 PG |
362 | * @gate_ops: clock ops for gate |
363 | */ | |
364 | struct clk_composite { | |
365 | struct clk_hw hw; | |
366 | struct clk_ops ops; | |
367 | ||
368 | struct clk_hw *mux_hw; | |
d3a1c7be | 369 | struct clk_hw *rate_hw; |
ece70094 PG |
370 | struct clk_hw *gate_hw; |
371 | ||
372 | const struct clk_ops *mux_ops; | |
d3a1c7be | 373 | const struct clk_ops *rate_ops; |
ece70094 PG |
374 | const struct clk_ops *gate_ops; |
375 | }; | |
376 | ||
377 | struct clk *clk_register_composite(struct device *dev, const char *name, | |
378 | const char **parent_names, int num_parents, | |
379 | struct clk_hw *mux_hw, const struct clk_ops *mux_ops, | |
d3a1c7be | 380 | struct clk_hw *rate_hw, const struct clk_ops *rate_ops, |
ece70094 PG |
381 | struct clk_hw *gate_hw, const struct clk_ops *gate_ops, |
382 | unsigned long flags); | |
383 | ||
b2476490 MT |
384 | /** |
385 | * clk_register - allocate a new clock, register it and return an opaque cookie | |
386 | * @dev: device that is registering this clock | |
b2476490 | 387 | * @hw: link to hardware-specific clock data |
b2476490 MT |
388 | * |
389 | * clk_register is the primary interface for populating the clock tree with new | |
390 | * clock nodes. It returns a pointer to the newly allocated struct clk which | |
391 | * cannot be dereferenced by driver code but may be used in conjuction with the | |
d1302a36 MT |
392 | * rest of the clock API. In the event of an error clk_register will return an |
393 | * error code; drivers must test for an error code after calling clk_register. | |
b2476490 | 394 | */ |
0197b3ea | 395 | struct clk *clk_register(struct device *dev, struct clk_hw *hw); |
46c8773a | 396 | struct clk *devm_clk_register(struct device *dev, struct clk_hw *hw); |
b2476490 | 397 | |
1df5c939 | 398 | void clk_unregister(struct clk *clk); |
46c8773a | 399 | void devm_clk_unregister(struct device *dev, struct clk *clk); |
1df5c939 | 400 | |
b2476490 MT |
401 | /* helper functions */ |
402 | const char *__clk_get_name(struct clk *clk); | |
403 | struct clk_hw *__clk_get_hw(struct clk *clk); | |
404 | u8 __clk_get_num_parents(struct clk *clk); | |
405 | struct clk *__clk_get_parent(struct clk *clk); | |
93874681 LT |
406 | unsigned int __clk_get_enable_count(struct clk *clk); |
407 | unsigned int __clk_get_prepare_count(struct clk *clk); | |
b2476490 MT |
408 | unsigned long __clk_get_rate(struct clk *clk); |
409 | unsigned long __clk_get_flags(struct clk *clk); | |
3d6ee287 | 410 | bool __clk_is_prepared(struct clk *clk); |
2ac6b1f5 | 411 | bool __clk_is_enabled(struct clk *clk); |
b2476490 MT |
412 | struct clk *__clk_lookup(const char *name); |
413 | ||
414 | /* | |
415 | * FIXME clock api without lock protection | |
416 | */ | |
417 | int __clk_prepare(struct clk *clk); | |
418 | void __clk_unprepare(struct clk *clk); | |
419 | void __clk_reparent(struct clk *clk, struct clk *new_parent); | |
420 | unsigned long __clk_round_rate(struct clk *clk, unsigned long rate); | |
421 | ||
766e6a4e GL |
422 | struct of_device_id; |
423 | ||
424 | typedef void (*of_clk_init_cb_t)(struct device_node *); | |
425 | ||
426 | int of_clk_add_provider(struct device_node *np, | |
427 | struct clk *(*clk_src_get)(struct of_phandle_args *args, | |
428 | void *data), | |
429 | void *data); | |
430 | void of_clk_del_provider(struct device_node *np); | |
431 | struct clk *of_clk_src_simple_get(struct of_phandle_args *clkspec, | |
432 | void *data); | |
494bfec9 SG |
433 | struct clk_onecell_data { |
434 | struct clk **clks; | |
435 | unsigned int clk_num; | |
436 | }; | |
437 | struct clk *of_clk_src_onecell_get(struct of_phandle_args *clkspec, void *data); | |
766e6a4e | 438 | const char *of_clk_get_parent_name(struct device_node *np, int index); |
f2f6c255 | 439 | |
766e6a4e GL |
440 | void of_clk_init(const struct of_device_id *matches); |
441 | ||
f2f6c255 PG |
442 | #define CLK_OF_DECLARE(name, compat, fn) \ |
443 | static const struct of_device_id __clk_of_table_##name \ | |
444 | __used __section(__clk_of_table) \ | |
445 | = { .compatible = compat, .data = fn }; | |
446 | ||
b2476490 MT |
447 | #endif /* CONFIG_COMMON_CLK */ |
448 | #endif /* CLK_PROVIDER_H */ |