]>
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> | |
aa514ce3 | 15 | #include <linux/io.h> |
355bb165 | 16 | #include <linux/of.h> |
b2476490 MT |
17 | |
18 | #ifdef CONFIG_COMMON_CLK | |
19 | ||
b2476490 MT |
20 | /* |
21 | * flags used across common struct clk. these flags should only affect the | |
22 | * top-level framework. custom flags for dealing with hardware specifics | |
23 | * belong in struct clk_foo | |
24 | */ | |
25 | #define CLK_SET_RATE_GATE BIT(0) /* must be gated across rate change */ | |
26 | #define CLK_SET_PARENT_GATE BIT(1) /* must be gated across re-parent */ | |
27 | #define CLK_SET_RATE_PARENT BIT(2) /* propagate rate change up one level */ | |
28 | #define CLK_IGNORE_UNUSED BIT(3) /* do not gate even if unused */ | |
29 | #define CLK_IS_ROOT BIT(4) /* root clk, has no parent */ | |
f7d8caad | 30 | #define CLK_IS_BASIC BIT(5) /* Basic clk, can't do a to_clk_foo() */ |
a093bde2 | 31 | #define CLK_GET_RATE_NOCACHE BIT(6) /* do not use the cached clk rate */ |
819c1de3 | 32 | #define CLK_SET_RATE_NO_REPARENT BIT(7) /* don't re-parent on rate change */ |
5279fc40 | 33 | #define CLK_GET_ACCURACY_NOCACHE BIT(8) /* do not use the cached clk accuracy */ |
b2476490 | 34 | |
0197b3ea | 35 | struct clk_hw; |
035a61c3 | 36 | struct clk_core; |
c646cbf1 | 37 | struct dentry; |
0197b3ea | 38 | |
b2476490 MT |
39 | /** |
40 | * struct clk_ops - Callback operations for hardware clocks; these are to | |
41 | * be provided by the clock implementation, and will be called by drivers | |
42 | * through the clk_* api. | |
43 | * | |
44 | * @prepare: Prepare the clock for enabling. This must not return until | |
725b418b GU |
45 | * the clock is fully prepared, and it's safe to call clk_enable. |
46 | * This callback is intended to allow clock implementations to | |
47 | * do any initialisation that may sleep. Called with | |
48 | * prepare_lock held. | |
b2476490 MT |
49 | * |
50 | * @unprepare: Release the clock from its prepared state. This will typically | |
725b418b GU |
51 | * undo any work done in the @prepare callback. Called with |
52 | * prepare_lock held. | |
b2476490 | 53 | * |
3d6ee287 UH |
54 | * @is_prepared: Queries the hardware to determine if the clock is prepared. |
55 | * This function is allowed to sleep. Optional, if this op is not | |
56 | * set then the prepare count will be used. | |
57 | * | |
3cc8247f UH |
58 | * @unprepare_unused: Unprepare the clock atomically. Only called from |
59 | * clk_disable_unused for prepare clocks with special needs. | |
60 | * Called with prepare mutex held. This function may sleep. | |
61 | * | |
b2476490 | 62 | * @enable: Enable the clock atomically. This must not return until the |
725b418b GU |
63 | * clock is generating a valid clock signal, usable by consumer |
64 | * devices. Called with enable_lock held. This function must not | |
65 | * sleep. | |
b2476490 MT |
66 | * |
67 | * @disable: Disable the clock atomically. Called with enable_lock held. | |
725b418b | 68 | * This function must not sleep. |
b2476490 | 69 | * |
119c7127 | 70 | * @is_enabled: Queries the hardware to determine if the clock is enabled. |
725b418b GU |
71 | * This function must not sleep. Optional, if this op is not |
72 | * set then the enable count will be used. | |
119c7127 | 73 | * |
7c045a55 MT |
74 | * @disable_unused: Disable the clock atomically. Only called from |
75 | * clk_disable_unused for gate clocks with special needs. | |
76 | * Called with enable_lock held. This function must not | |
77 | * sleep. | |
78 | * | |
7ce3e8cc | 79 | * @recalc_rate Recalculate the rate of this clock, by querying hardware. The |
725b418b GU |
80 | * parent rate is an input parameter. It is up to the caller to |
81 | * ensure that the prepare_mutex is held across this call. | |
82 | * Returns the calculated rate. Optional, but recommended - if | |
83 | * this op is not set then clock rate will be initialized to 0. | |
b2476490 MT |
84 | * |
85 | * @round_rate: Given a target rate as input, returns the closest rate actually | |
54e73016 GU |
86 | * supported by the clock. The parent rate is an input/output |
87 | * parameter. | |
b2476490 | 88 | * |
71472c0c JH |
89 | * @determine_rate: Given a target rate as input, returns the closest rate |
90 | * actually supported by the clock, and optionally the parent clock | |
91 | * that should be used to provide the clock rate. | |
92 | * | |
b2476490 | 93 | * @set_parent: Change the input source of this clock; for clocks with multiple |
54e73016 GU |
94 | * possible parents specify a new parent by passing in the index |
95 | * as a u8 corresponding to the parent in either the .parent_names | |
96 | * or .parents arrays. This function in affect translates an | |
97 | * array index into the value programmed into the hardware. | |
98 | * Returns 0 on success, -EERROR otherwise. | |
99 | * | |
b2476490 | 100 | * @get_parent: Queries the hardware to determine the parent of a clock. The |
725b418b GU |
101 | * return value is a u8 which specifies the index corresponding to |
102 | * the parent clock. This index can be applied to either the | |
103 | * .parent_names or .parents arrays. In short, this function | |
104 | * translates the parent value read from hardware into an array | |
105 | * index. Currently only called when the clock is initialized by | |
106 | * __clk_init. This callback is mandatory for clocks with | |
107 | * multiple parents. It is optional (and unnecessary) for clocks | |
108 | * with 0 or 1 parents. | |
b2476490 | 109 | * |
1c0035d7 SG |
110 | * @set_rate: Change the rate of this clock. The requested rate is specified |
111 | * by the second argument, which should typically be the return | |
112 | * of .round_rate call. The third argument gives the parent rate | |
113 | * which is likely helpful for most .set_rate implementation. | |
114 | * Returns 0 on success, -EERROR otherwise. | |
b2476490 | 115 | * |
3fa2252b SB |
116 | * @set_rate_and_parent: Change the rate and the parent of this clock. The |
117 | * requested rate is specified by the second argument, which | |
118 | * should typically be the return of .round_rate call. The | |
119 | * third argument gives the parent rate which is likely helpful | |
120 | * for most .set_rate_and_parent implementation. The fourth | |
121 | * argument gives the parent index. This callback is optional (and | |
122 | * unnecessary) for clocks with 0 or 1 parents as well as | |
123 | * for clocks that can tolerate switching the rate and the parent | |
124 | * separately via calls to .set_parent and .set_rate. | |
125 | * Returns 0 on success, -EERROR otherwise. | |
126 | * | |
54e73016 GU |
127 | * @recalc_accuracy: Recalculate the accuracy of this clock. The clock accuracy |
128 | * is expressed in ppb (parts per billion). The parent accuracy is | |
129 | * an input parameter. | |
130 | * Returns the calculated accuracy. Optional - if this op is not | |
131 | * set then clock accuracy will be initialized to parent accuracy | |
132 | * or 0 (perfect clock) if clock has no parent. | |
133 | * | |
9824cf73 MR |
134 | * @get_phase: Queries the hardware to get the current phase of a clock. |
135 | * Returned values are 0-359 degrees on success, negative | |
136 | * error codes on failure. | |
137 | * | |
e59c5371 MT |
138 | * @set_phase: Shift the phase this clock signal in degrees specified |
139 | * by the second argument. Valid values for degrees are | |
140 | * 0-359. Return 0 on success, otherwise -EERROR. | |
141 | * | |
54e73016 GU |
142 | * @init: Perform platform-specific initialization magic. |
143 | * This is not not used by any of the basic clock types. | |
144 | * Please consider other ways of solving initialization problems | |
145 | * before using this callback, as its use is discouraged. | |
146 | * | |
c646cbf1 AE |
147 | * @debug_init: Set up type-specific debugfs entries for this clock. This |
148 | * is called once, after the debugfs directory entry for this | |
149 | * clock has been created. The dentry pointer representing that | |
150 | * directory is provided as an argument. Called with | |
151 | * prepare_lock held. Returns 0 on success, -EERROR otherwise. | |
152 | * | |
3fa2252b | 153 | * |
b2476490 MT |
154 | * The clk_enable/clk_disable and clk_prepare/clk_unprepare pairs allow |
155 | * implementations to split any work between atomic (enable) and sleepable | |
156 | * (prepare) contexts. If enabling a clock requires code that might sleep, | |
157 | * this must be done in clk_prepare. Clock enable code that will never be | |
7ce3e8cc | 158 | * called in a sleepable context may be implemented in clk_enable. |
b2476490 MT |
159 | * |
160 | * Typically, drivers will call clk_prepare when a clock may be needed later | |
161 | * (eg. when a device is opened), and clk_enable when the clock is actually | |
162 | * required (eg. from an interrupt). Note that clk_prepare MUST have been | |
163 | * called before clk_enable. | |
164 | */ | |
165 | struct clk_ops { | |
166 | int (*prepare)(struct clk_hw *hw); | |
167 | void (*unprepare)(struct clk_hw *hw); | |
3d6ee287 | 168 | int (*is_prepared)(struct clk_hw *hw); |
3cc8247f | 169 | void (*unprepare_unused)(struct clk_hw *hw); |
b2476490 MT |
170 | int (*enable)(struct clk_hw *hw); |
171 | void (*disable)(struct clk_hw *hw); | |
172 | int (*is_enabled)(struct clk_hw *hw); | |
7c045a55 | 173 | void (*disable_unused)(struct clk_hw *hw); |
b2476490 MT |
174 | unsigned long (*recalc_rate)(struct clk_hw *hw, |
175 | unsigned long parent_rate); | |
54e73016 GU |
176 | long (*round_rate)(struct clk_hw *hw, unsigned long rate, |
177 | unsigned long *parent_rate); | |
1c8e6004 TV |
178 | long (*determine_rate)(struct clk_hw *hw, |
179 | unsigned long rate, | |
180 | unsigned long min_rate, | |
181 | unsigned long max_rate, | |
182 | unsigned long *best_parent_rate, | |
183 | struct clk_hw **best_parent_hw); | |
b2476490 MT |
184 | int (*set_parent)(struct clk_hw *hw, u8 index); |
185 | u8 (*get_parent)(struct clk_hw *hw); | |
54e73016 GU |
186 | int (*set_rate)(struct clk_hw *hw, unsigned long rate, |
187 | unsigned long parent_rate); | |
3fa2252b SB |
188 | int (*set_rate_and_parent)(struct clk_hw *hw, |
189 | unsigned long rate, | |
190 | unsigned long parent_rate, u8 index); | |
5279fc40 BB |
191 | unsigned long (*recalc_accuracy)(struct clk_hw *hw, |
192 | unsigned long parent_accuracy); | |
9824cf73 | 193 | int (*get_phase)(struct clk_hw *hw); |
e59c5371 | 194 | int (*set_phase)(struct clk_hw *hw, int degrees); |
b2476490 | 195 | void (*init)(struct clk_hw *hw); |
c646cbf1 | 196 | int (*debug_init)(struct clk_hw *hw, struct dentry *dentry); |
b2476490 MT |
197 | }; |
198 | ||
0197b3ea SK |
199 | /** |
200 | * struct clk_init_data - holds init data that's common to all clocks and is | |
201 | * shared between the clock provider and the common clock framework. | |
202 | * | |
203 | * @name: clock name | |
204 | * @ops: operations this clock supports | |
205 | * @parent_names: array of string names for all possible parents | |
206 | * @num_parents: number of possible parents | |
207 | * @flags: framework-level hints and quirks | |
208 | */ | |
209 | struct clk_init_data { | |
210 | const char *name; | |
211 | const struct clk_ops *ops; | |
2893c379 | 212 | const char * const *parent_names; |
0197b3ea SK |
213 | u8 num_parents; |
214 | unsigned long flags; | |
215 | }; | |
216 | ||
217 | /** | |
218 | * struct clk_hw - handle for traversing from a struct clk to its corresponding | |
219 | * hardware-specific structure. struct clk_hw should be declared within struct | |
220 | * clk_foo and then referenced by the struct clk instance that uses struct | |
221 | * clk_foo's clk_ops | |
222 | * | |
035a61c3 TV |
223 | * @core: pointer to the struct clk_core instance that points back to this |
224 | * struct clk_hw instance | |
225 | * | |
226 | * @clk: pointer to the per-user struct clk instance that can be used to call | |
227 | * into the clk API | |
0197b3ea SK |
228 | * |
229 | * @init: pointer to struct clk_init_data that contains the init data shared | |
230 | * with the common clock framework. | |
231 | */ | |
232 | struct clk_hw { | |
035a61c3 | 233 | struct clk_core *core; |
0197b3ea | 234 | struct clk *clk; |
dc4cd941 | 235 | const struct clk_init_data *init; |
0197b3ea SK |
236 | }; |
237 | ||
9d9f78ed MT |
238 | /* |
239 | * DOC: Basic clock implementations common to many platforms | |
240 | * | |
241 | * Each basic clock hardware type is comprised of a structure describing the | |
242 | * clock hardware, implementations of the relevant callbacks in struct clk_ops, | |
243 | * unique flags for that hardware type, a registration function and an | |
244 | * alternative macro for static initialization | |
245 | */ | |
246 | ||
247 | /** | |
248 | * struct clk_fixed_rate - fixed-rate clock | |
249 | * @hw: handle between common and hardware-specific interfaces | |
250 | * @fixed_rate: constant frequency of clock | |
251 | */ | |
252 | struct clk_fixed_rate { | |
253 | struct clk_hw hw; | |
254 | unsigned long fixed_rate; | |
0903ea60 | 255 | unsigned long fixed_accuracy; |
9d9f78ed MT |
256 | u8 flags; |
257 | }; | |
258 | ||
bffad66e | 259 | extern const struct clk_ops clk_fixed_rate_ops; |
9d9f78ed MT |
260 | struct clk *clk_register_fixed_rate(struct device *dev, const char *name, |
261 | const char *parent_name, unsigned long flags, | |
262 | unsigned long fixed_rate); | |
0903ea60 BB |
263 | struct clk *clk_register_fixed_rate_with_accuracy(struct device *dev, |
264 | const char *name, const char *parent_name, unsigned long flags, | |
265 | unsigned long fixed_rate, unsigned long fixed_accuracy); | |
9d9f78ed | 266 | |
015ba402 GL |
267 | void of_fixed_clk_setup(struct device_node *np); |
268 | ||
9d9f78ed MT |
269 | /** |
270 | * struct clk_gate - gating clock | |
271 | * | |
272 | * @hw: handle between common and hardware-specific interfaces | |
273 | * @reg: register controlling gate | |
274 | * @bit_idx: single bit controlling gate | |
275 | * @flags: hardware-specific flags | |
276 | * @lock: register lock | |
277 | * | |
278 | * Clock which can gate its output. Implements .enable & .disable | |
279 | * | |
280 | * Flags: | |
1f73f31a | 281 | * CLK_GATE_SET_TO_DISABLE - by default this clock sets the bit at bit_idx to |
725b418b GU |
282 | * enable the clock. Setting this flag does the opposite: setting the bit |
283 | * disable the clock and clearing it enables the clock | |
04577994 | 284 | * CLK_GATE_HIWORD_MASK - The gate settings are only in lower 16-bit |
725b418b GU |
285 | * of this register, and mask of gate bits are in higher 16-bit of this |
286 | * register. While setting the gate bits, higher 16-bit should also be | |
287 | * updated to indicate changing gate bits. | |
9d9f78ed MT |
288 | */ |
289 | struct clk_gate { | |
290 | struct clk_hw hw; | |
291 | void __iomem *reg; | |
292 | u8 bit_idx; | |
293 | u8 flags; | |
294 | spinlock_t *lock; | |
9d9f78ed MT |
295 | }; |
296 | ||
297 | #define CLK_GATE_SET_TO_DISABLE BIT(0) | |
04577994 | 298 | #define CLK_GATE_HIWORD_MASK BIT(1) |
9d9f78ed | 299 | |
bffad66e | 300 | extern const struct clk_ops clk_gate_ops; |
9d9f78ed MT |
301 | struct clk *clk_register_gate(struct device *dev, const char *name, |
302 | const char *parent_name, unsigned long flags, | |
303 | void __iomem *reg, u8 bit_idx, | |
304 | u8 clk_gate_flags, spinlock_t *lock); | |
4e3c021f | 305 | void clk_unregister_gate(struct clk *clk); |
9d9f78ed | 306 | |
357c3f0a RN |
307 | struct clk_div_table { |
308 | unsigned int val; | |
309 | unsigned int div; | |
310 | }; | |
311 | ||
9d9f78ed MT |
312 | /** |
313 | * struct clk_divider - adjustable divider clock | |
314 | * | |
315 | * @hw: handle between common and hardware-specific interfaces | |
316 | * @reg: register containing the divider | |
317 | * @shift: shift to the divider bit field | |
318 | * @width: width of the divider bit field | |
357c3f0a | 319 | * @table: array of value/divider pairs, last entry should have div = 0 |
9d9f78ed MT |
320 | * @lock: register lock |
321 | * | |
322 | * Clock with an adjustable divider affecting its output frequency. Implements | |
323 | * .recalc_rate, .set_rate and .round_rate | |
324 | * | |
325 | * Flags: | |
326 | * CLK_DIVIDER_ONE_BASED - by default the divisor is the value read from the | |
725b418b GU |
327 | * register plus one. If CLK_DIVIDER_ONE_BASED is set then the divider is |
328 | * the raw value read from the register, with the value of zero considered | |
056b2053 | 329 | * invalid, unless CLK_DIVIDER_ALLOW_ZERO is set. |
9d9f78ed | 330 | * CLK_DIVIDER_POWER_OF_TWO - clock divisor is 2 raised to the value read from |
725b418b | 331 | * the hardware register |
056b2053 SB |
332 | * CLK_DIVIDER_ALLOW_ZERO - Allow zero divisors. For dividers which have |
333 | * CLK_DIVIDER_ONE_BASED set, it is possible to end up with a zero divisor. | |
334 | * Some hardware implementations gracefully handle this case and allow a | |
335 | * zero divisor by not modifying their input clock | |
336 | * (divide by one / bypass). | |
d57dfe75 | 337 | * CLK_DIVIDER_HIWORD_MASK - The divider settings are only in lower 16-bit |
725b418b GU |
338 | * of this register, and mask of divider bits are in higher 16-bit of this |
339 | * register. While setting the divider bits, higher 16-bit should also be | |
340 | * updated to indicate changing divider bits. | |
774b5143 MC |
341 | * CLK_DIVIDER_ROUND_CLOSEST - Makes the best calculated divider to be rounded |
342 | * to the closest integer instead of the up one. | |
79c6ab50 HS |
343 | * CLK_DIVIDER_READ_ONLY - The divider settings are preconfigured and should |
344 | * not be changed by the clock framework. | |
9d9f78ed MT |
345 | */ |
346 | struct clk_divider { | |
347 | struct clk_hw hw; | |
348 | void __iomem *reg; | |
349 | u8 shift; | |
350 | u8 width; | |
351 | u8 flags; | |
357c3f0a | 352 | const struct clk_div_table *table; |
9d9f78ed | 353 | spinlock_t *lock; |
9d9f78ed MT |
354 | }; |
355 | ||
356 | #define CLK_DIVIDER_ONE_BASED BIT(0) | |
357 | #define CLK_DIVIDER_POWER_OF_TWO BIT(1) | |
056b2053 | 358 | #define CLK_DIVIDER_ALLOW_ZERO BIT(2) |
d57dfe75 | 359 | #define CLK_DIVIDER_HIWORD_MASK BIT(3) |
774b5143 | 360 | #define CLK_DIVIDER_ROUND_CLOSEST BIT(4) |
79c6ab50 | 361 | #define CLK_DIVIDER_READ_ONLY BIT(5) |
9d9f78ed | 362 | |
bffad66e | 363 | extern const struct clk_ops clk_divider_ops; |
bca9690b SB |
364 | |
365 | unsigned long divider_recalc_rate(struct clk_hw *hw, unsigned long parent_rate, | |
366 | unsigned int val, const struct clk_div_table *table, | |
367 | unsigned long flags); | |
368 | long divider_round_rate(struct clk_hw *hw, unsigned long rate, | |
369 | unsigned long *prate, const struct clk_div_table *table, | |
370 | u8 width, unsigned long flags); | |
371 | int divider_get_val(unsigned long rate, unsigned long parent_rate, | |
372 | const struct clk_div_table *table, u8 width, | |
373 | unsigned long flags); | |
374 | ||
9d9f78ed MT |
375 | struct clk *clk_register_divider(struct device *dev, const char *name, |
376 | const char *parent_name, unsigned long flags, | |
377 | void __iomem *reg, u8 shift, u8 width, | |
378 | u8 clk_divider_flags, spinlock_t *lock); | |
357c3f0a RN |
379 | struct clk *clk_register_divider_table(struct device *dev, const char *name, |
380 | const char *parent_name, unsigned long flags, | |
381 | void __iomem *reg, u8 shift, u8 width, | |
382 | u8 clk_divider_flags, const struct clk_div_table *table, | |
383 | spinlock_t *lock); | |
4e3c021f | 384 | void clk_unregister_divider(struct clk *clk); |
9d9f78ed MT |
385 | |
386 | /** | |
387 | * struct clk_mux - multiplexer clock | |
388 | * | |
389 | * @hw: handle between common and hardware-specific interfaces | |
390 | * @reg: register controlling multiplexer | |
391 | * @shift: shift to multiplexer bit field | |
392 | * @width: width of mutliplexer bit field | |
3566d40c | 393 | * @flags: hardware-specific flags |
9d9f78ed MT |
394 | * @lock: register lock |
395 | * | |
396 | * Clock with multiple selectable parents. Implements .get_parent, .set_parent | |
397 | * and .recalc_rate | |
398 | * | |
399 | * Flags: | |
400 | * CLK_MUX_INDEX_ONE - register index starts at 1, not 0 | |
1f73f31a | 401 | * CLK_MUX_INDEX_BIT - register index is a single bit (power of two) |
ba492e90 | 402 | * CLK_MUX_HIWORD_MASK - The mux settings are only in lower 16-bit of this |
725b418b GU |
403 | * register, and mask of mux bits are in higher 16-bit of this register. |
404 | * While setting the mux bits, higher 16-bit should also be updated to | |
405 | * indicate changing mux bits. | |
15a02c1f SB |
406 | * CLK_MUX_ROUND_CLOSEST - Use the parent rate that is closest to the desired |
407 | * frequency. | |
9d9f78ed MT |
408 | */ |
409 | struct clk_mux { | |
410 | struct clk_hw hw; | |
411 | void __iomem *reg; | |
ce4f3313 PDS |
412 | u32 *table; |
413 | u32 mask; | |
9d9f78ed | 414 | u8 shift; |
9d9f78ed MT |
415 | u8 flags; |
416 | spinlock_t *lock; | |
417 | }; | |
418 | ||
419 | #define CLK_MUX_INDEX_ONE BIT(0) | |
420 | #define CLK_MUX_INDEX_BIT BIT(1) | |
ba492e90 | 421 | #define CLK_MUX_HIWORD_MASK BIT(2) |
15a02c1f SB |
422 | #define CLK_MUX_READ_ONLY BIT(3) /* mux can't be changed */ |
423 | #define CLK_MUX_ROUND_CLOSEST BIT(4) | |
9d9f78ed | 424 | |
bffad66e | 425 | extern const struct clk_ops clk_mux_ops; |
c57acd14 | 426 | extern const struct clk_ops clk_mux_ro_ops; |
ce4f3313 | 427 | |
9d9f78ed | 428 | struct clk *clk_register_mux(struct device *dev, const char *name, |
2893c379 SH |
429 | const char * const *parent_names, u8 num_parents, |
430 | unsigned long flags, | |
9d9f78ed MT |
431 | void __iomem *reg, u8 shift, u8 width, |
432 | u8 clk_mux_flags, spinlock_t *lock); | |
b2476490 | 433 | |
ce4f3313 | 434 | struct clk *clk_register_mux_table(struct device *dev, const char *name, |
2893c379 SH |
435 | const char * const *parent_names, u8 num_parents, |
436 | unsigned long flags, | |
ce4f3313 PDS |
437 | void __iomem *reg, u8 shift, u32 mask, |
438 | u8 clk_mux_flags, u32 *table, spinlock_t *lock); | |
439 | ||
4e3c021f KK |
440 | void clk_unregister_mux(struct clk *clk); |
441 | ||
79b16641 GC |
442 | void of_fixed_factor_clk_setup(struct device_node *node); |
443 | ||
f0948f59 SH |
444 | /** |
445 | * struct clk_fixed_factor - fixed multiplier and divider clock | |
446 | * | |
447 | * @hw: handle between common and hardware-specific interfaces | |
448 | * @mult: multiplier | |
449 | * @div: divider | |
450 | * | |
451 | * Clock with a fixed multiplier and divider. The output frequency is the | |
452 | * parent clock rate divided by div and multiplied by mult. | |
453 | * Implements .recalc_rate, .set_rate and .round_rate | |
454 | */ | |
455 | ||
456 | struct clk_fixed_factor { | |
457 | struct clk_hw hw; | |
458 | unsigned int mult; | |
459 | unsigned int div; | |
460 | }; | |
461 | ||
462 | extern struct clk_ops clk_fixed_factor_ops; | |
463 | struct clk *clk_register_fixed_factor(struct device *dev, const char *name, | |
464 | const char *parent_name, unsigned long flags, | |
465 | unsigned int mult, unsigned int div); | |
466 | ||
e2d0e90f HK |
467 | /** |
468 | * struct clk_fractional_divider - adjustable fractional divider clock | |
469 | * | |
470 | * @hw: handle between common and hardware-specific interfaces | |
471 | * @reg: register containing the divider | |
472 | * @mshift: shift to the numerator bit field | |
473 | * @mwidth: width of the numerator bit field | |
474 | * @nshift: shift to the denominator bit field | |
475 | * @nwidth: width of the denominator bit field | |
476 | * @lock: register lock | |
477 | * | |
478 | * Clock with adjustable fractional divider affecting its output frequency. | |
479 | */ | |
480 | ||
481 | struct clk_fractional_divider { | |
482 | struct clk_hw hw; | |
483 | void __iomem *reg; | |
484 | u8 mshift; | |
485 | u32 mmask; | |
486 | u8 nshift; | |
487 | u32 nmask; | |
488 | u8 flags; | |
489 | spinlock_t *lock; | |
490 | }; | |
491 | ||
492 | extern const struct clk_ops clk_fractional_divider_ops; | |
493 | struct clk *clk_register_fractional_divider(struct device *dev, | |
494 | const char *name, const char *parent_name, unsigned long flags, | |
495 | void __iomem *reg, u8 mshift, u8 mwidth, u8 nshift, u8 nwidth, | |
496 | u8 clk_divider_flags, spinlock_t *lock); | |
497 | ||
ece70094 PG |
498 | /*** |
499 | * struct clk_composite - aggregate clock of mux, divider and gate clocks | |
500 | * | |
501 | * @hw: handle between common and hardware-specific interfaces | |
d3a1c7be MT |
502 | * @mux_hw: handle between composite and hardware-specific mux clock |
503 | * @rate_hw: handle between composite and hardware-specific rate clock | |
504 | * @gate_hw: handle between composite and hardware-specific gate clock | |
ece70094 | 505 | * @mux_ops: clock ops for mux |
d3a1c7be | 506 | * @rate_ops: clock ops for rate |
ece70094 PG |
507 | * @gate_ops: clock ops for gate |
508 | */ | |
509 | struct clk_composite { | |
510 | struct clk_hw hw; | |
511 | struct clk_ops ops; | |
512 | ||
513 | struct clk_hw *mux_hw; | |
d3a1c7be | 514 | struct clk_hw *rate_hw; |
ece70094 PG |
515 | struct clk_hw *gate_hw; |
516 | ||
517 | const struct clk_ops *mux_ops; | |
d3a1c7be | 518 | const struct clk_ops *rate_ops; |
ece70094 PG |
519 | const struct clk_ops *gate_ops; |
520 | }; | |
521 | ||
522 | struct clk *clk_register_composite(struct device *dev, const char *name, | |
2893c379 | 523 | const char * const *parent_names, int num_parents, |
ece70094 | 524 | struct clk_hw *mux_hw, const struct clk_ops *mux_ops, |
d3a1c7be | 525 | struct clk_hw *rate_hw, const struct clk_ops *rate_ops, |
ece70094 PG |
526 | struct clk_hw *gate_hw, const struct clk_ops *gate_ops, |
527 | unsigned long flags); | |
528 | ||
c873d14d JS |
529 | /*** |
530 | * struct clk_gpio_gate - gpio gated clock | |
531 | * | |
532 | * @hw: handle between common and hardware-specific interfaces | |
533 | * @gpiod: gpio descriptor | |
534 | * | |
535 | * Clock with a gpio control for enabling and disabling the parent clock. | |
536 | * Implements .enable, .disable and .is_enabled | |
537 | */ | |
538 | ||
539 | struct clk_gpio { | |
540 | struct clk_hw hw; | |
541 | struct gpio_desc *gpiod; | |
542 | }; | |
543 | ||
544 | extern const struct clk_ops clk_gpio_gate_ops; | |
545 | struct clk *clk_register_gpio_gate(struct device *dev, const char *name, | |
820ad975 | 546 | const char *parent_name, unsigned gpio, bool active_low, |
c873d14d JS |
547 | unsigned long flags); |
548 | ||
549 | void of_gpio_clk_gate_setup(struct device_node *node); | |
550 | ||
b2476490 MT |
551 | /** |
552 | * clk_register - allocate a new clock, register it and return an opaque cookie | |
553 | * @dev: device that is registering this clock | |
b2476490 | 554 | * @hw: link to hardware-specific clock data |
b2476490 MT |
555 | * |
556 | * clk_register is the primary interface for populating the clock tree with new | |
557 | * clock nodes. It returns a pointer to the newly allocated struct clk which | |
558 | * cannot be dereferenced by driver code but may be used in conjuction with the | |
d1302a36 MT |
559 | * rest of the clock API. In the event of an error clk_register will return an |
560 | * error code; drivers must test for an error code after calling clk_register. | |
b2476490 | 561 | */ |
0197b3ea | 562 | struct clk *clk_register(struct device *dev, struct clk_hw *hw); |
46c8773a | 563 | struct clk *devm_clk_register(struct device *dev, struct clk_hw *hw); |
b2476490 | 564 | |
1df5c939 | 565 | void clk_unregister(struct clk *clk); |
46c8773a | 566 | void devm_clk_unregister(struct device *dev, struct clk *clk); |
1df5c939 | 567 | |
b2476490 MT |
568 | /* helper functions */ |
569 | const char *__clk_get_name(struct clk *clk); | |
570 | struct clk_hw *__clk_get_hw(struct clk *clk); | |
571 | u8 __clk_get_num_parents(struct clk *clk); | |
572 | struct clk *__clk_get_parent(struct clk *clk); | |
7ef3dcc8 | 573 | struct clk *clk_get_parent_by_index(struct clk *clk, u8 index); |
93874681 | 574 | unsigned int __clk_get_enable_count(struct clk *clk); |
b2476490 MT |
575 | unsigned long __clk_get_rate(struct clk *clk); |
576 | unsigned long __clk_get_flags(struct clk *clk); | |
3d6ee287 | 577 | bool __clk_is_prepared(struct clk *clk); |
2ac6b1f5 | 578 | bool __clk_is_enabled(struct clk *clk); |
b2476490 | 579 | struct clk *__clk_lookup(const char *name); |
e366fdd7 | 580 | long __clk_mux_determine_rate(struct clk_hw *hw, unsigned long rate, |
1c8e6004 TV |
581 | unsigned long min_rate, |
582 | unsigned long max_rate, | |
e366fdd7 | 583 | unsigned long *best_parent_rate, |
646cafc6 | 584 | struct clk_hw **best_parent_p); |
1c8e6004 TV |
585 | unsigned long __clk_determine_rate(struct clk_hw *core, |
586 | unsigned long rate, | |
587 | unsigned long min_rate, | |
588 | unsigned long max_rate); | |
15a02c1f | 589 | long __clk_mux_determine_rate_closest(struct clk_hw *hw, unsigned long rate, |
1c8e6004 TV |
590 | unsigned long min_rate, |
591 | unsigned long max_rate, | |
15a02c1f SB |
592 | unsigned long *best_parent_rate, |
593 | struct clk_hw **best_parent_p); | |
b2476490 | 594 | |
2e65d8bf JMC |
595 | static inline void __clk_hw_set_clk(struct clk_hw *dst, struct clk_hw *src) |
596 | { | |
597 | dst->clk = src->clk; | |
598 | dst->core = src->core; | |
599 | } | |
600 | ||
b2476490 MT |
601 | /* |
602 | * FIXME clock api without lock protection | |
603 | */ | |
b2476490 MT |
604 | unsigned long __clk_round_rate(struct clk *clk, unsigned long rate); |
605 | ||
766e6a4e GL |
606 | struct of_device_id; |
607 | ||
608 | typedef void (*of_clk_init_cb_t)(struct device_node *); | |
609 | ||
0b151deb SH |
610 | struct clk_onecell_data { |
611 | struct clk **clks; | |
612 | unsigned int clk_num; | |
613 | }; | |
614 | ||
819b4861 TK |
615 | extern struct of_device_id __clk_of_table; |
616 | ||
54196ccb | 617 | #define CLK_OF_DECLARE(name, compat, fn) OF_DECLARE_1(clk, name, compat, fn) |
0b151deb SH |
618 | |
619 | #ifdef CONFIG_OF | |
766e6a4e GL |
620 | int of_clk_add_provider(struct device_node *np, |
621 | struct clk *(*clk_src_get)(struct of_phandle_args *args, | |
622 | void *data), | |
623 | void *data); | |
624 | void of_clk_del_provider(struct device_node *np); | |
625 | struct clk *of_clk_src_simple_get(struct of_phandle_args *clkspec, | |
626 | void *data); | |
494bfec9 | 627 | struct clk *of_clk_src_onecell_get(struct of_phandle_args *clkspec, void *data); |
f6102742 | 628 | int of_clk_get_parent_count(struct device_node *np); |
766e6a4e | 629 | const char *of_clk_get_parent_name(struct device_node *np, int index); |
f2f6c255 | 630 | |
766e6a4e GL |
631 | void of_clk_init(const struct of_device_id *matches); |
632 | ||
0b151deb | 633 | #else /* !CONFIG_OF */ |
f2f6c255 | 634 | |
0b151deb SH |
635 | static inline int of_clk_add_provider(struct device_node *np, |
636 | struct clk *(*clk_src_get)(struct of_phandle_args *args, | |
637 | void *data), | |
638 | void *data) | |
639 | { | |
640 | return 0; | |
641 | } | |
642 | #define of_clk_del_provider(np) \ | |
643 | { while (0); } | |
644 | static inline struct clk *of_clk_src_simple_get( | |
645 | struct of_phandle_args *clkspec, void *data) | |
646 | { | |
647 | return ERR_PTR(-ENOENT); | |
648 | } | |
649 | static inline struct clk *of_clk_src_onecell_get( | |
650 | struct of_phandle_args *clkspec, void *data) | |
651 | { | |
652 | return ERR_PTR(-ENOENT); | |
653 | } | |
654 | static inline const char *of_clk_get_parent_name(struct device_node *np, | |
655 | int index) | |
656 | { | |
657 | return NULL; | |
658 | } | |
659 | #define of_clk_init(matches) \ | |
660 | { while (0); } | |
661 | #endif /* CONFIG_OF */ | |
aa514ce3 GS |
662 | |
663 | /* | |
664 | * wrap access to peripherals in accessor routines | |
665 | * for improved portability across platforms | |
666 | */ | |
667 | ||
6d8cdb68 GS |
668 | #if IS_ENABLED(CONFIG_PPC) |
669 | ||
670 | static inline u32 clk_readl(u32 __iomem *reg) | |
671 | { | |
672 | return ioread32be(reg); | |
673 | } | |
674 | ||
675 | static inline void clk_writel(u32 val, u32 __iomem *reg) | |
676 | { | |
677 | iowrite32be(val, reg); | |
678 | } | |
679 | ||
680 | #else /* platform dependent I/O accessors */ | |
681 | ||
aa514ce3 GS |
682 | static inline u32 clk_readl(u32 __iomem *reg) |
683 | { | |
684 | return readl(reg); | |
685 | } | |
686 | ||
687 | static inline void clk_writel(u32 val, u32 __iomem *reg) | |
688 | { | |
689 | writel(val, reg); | |
690 | } | |
691 | ||
6d8cdb68 GS |
692 | #endif /* platform dependent I/O accessors */ |
693 | ||
fb2b3c9f | 694 | #ifdef CONFIG_DEBUG_FS |
61c7cddf | 695 | struct dentry *clk_debugfs_add_file(struct clk_hw *hw, char *name, umode_t mode, |
fb2b3c9f PDS |
696 | void *data, const struct file_operations *fops); |
697 | #endif | |
698 | ||
b2476490 MT |
699 | #endif /* CONFIG_COMMON_CLK */ |
700 | #endif /* CLK_PROVIDER_H */ |