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