Commit | Line | Data |
---|---|---|
d2912cb1 | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
1da177e4 | 2 | /* |
f8ce2547 | 3 | * linux/include/linux/clk.h |
1da177e4 LT |
4 | * |
5 | * Copyright (C) 2004 ARM Limited. | |
6 | * Written by Deep Blue Solutions Limited. | |
b2476490 | 7 | * Copyright (C) 2011-2012 Linaro Ltd <mturquette@linaro.org> |
1da177e4 | 8 | */ |
686f8c5d TP |
9 | #ifndef __LINUX_CLK_H |
10 | #define __LINUX_CLK_H | |
1da177e4 | 11 | |
9f1612d3 | 12 | #include <linux/err.h> |
40d3e0f4 | 13 | #include <linux/kernel.h> |
b2476490 | 14 | #include <linux/notifier.h> |
40d3e0f4 | 15 | |
1da177e4 | 16 | struct device; |
b2476490 | 17 | struct clk; |
71a2f115 KM |
18 | struct device_node; |
19 | struct of_phandle_args; | |
b2476490 | 20 | |
b2476490 MT |
21 | /** |
22 | * DOC: clk notifier callback types | |
23 | * | |
24 | * PRE_RATE_CHANGE - called immediately before the clk rate is changed, | |
25 | * to indicate that the rate change will proceed. Drivers must | |
26 | * immediately terminate any operations that will be affected by the | |
fb72a059 SB |
27 | * rate change. Callbacks may either return NOTIFY_DONE, NOTIFY_OK, |
28 | * NOTIFY_STOP or NOTIFY_BAD. | |
b2476490 MT |
29 | * |
30 | * ABORT_RATE_CHANGE: called if the rate change failed for some reason | |
31 | * after PRE_RATE_CHANGE. In this case, all registered notifiers on | |
32 | * the clk will be called with ABORT_RATE_CHANGE. Callbacks must | |
fb72a059 | 33 | * always return NOTIFY_DONE or NOTIFY_OK. |
b2476490 MT |
34 | * |
35 | * POST_RATE_CHANGE - called after the clk rate change has successfully | |
fb72a059 | 36 | * completed. Callbacks must always return NOTIFY_DONE or NOTIFY_OK. |
b2476490 | 37 | * |
1da177e4 | 38 | */ |
b2476490 MT |
39 | #define PRE_RATE_CHANGE BIT(0) |
40 | #define POST_RATE_CHANGE BIT(1) | |
41 | #define ABORT_RATE_CHANGE BIT(2) | |
1da177e4 | 42 | |
b2476490 MT |
43 | /** |
44 | * struct clk_notifier - associate a clk with a notifier | |
45 | * @clk: struct clk * to associate the notifier with | |
46 | * @notifier_head: a blocking_notifier_head for this clk | |
47 | * @node: linked list pointers | |
48 | * | |
49 | * A list of struct clk_notifier is maintained by the notifier code. | |
50 | * An entry is created whenever code registers the first notifier on a | |
51 | * particular @clk. Future notifiers on that @clk are added to the | |
52 | * @notifier_head. | |
53 | */ | |
54 | struct clk_notifier { | |
55 | struct clk *clk; | |
56 | struct srcu_notifier_head notifier_head; | |
57 | struct list_head node; | |
58 | }; | |
1da177e4 | 59 | |
b2476490 MT |
60 | /** |
61 | * struct clk_notifier_data - rate data to pass to the notifier callback | |
62 | * @clk: struct clk * being changed | |
63 | * @old_rate: previous rate of this clk | |
64 | * @new_rate: new rate of this clk | |
65 | * | |
66 | * For a pre-notifier, old_rate is the clk's rate before this rate | |
67 | * change, and new_rate is what the rate will be in the future. For a | |
68 | * post-notifier, old_rate and new_rate are both set to the clk's | |
69 | * current rate (this was done to optimize the implementation). | |
1da177e4 | 70 | */ |
b2476490 MT |
71 | struct clk_notifier_data { |
72 | struct clk *clk; | |
73 | unsigned long old_rate; | |
74 | unsigned long new_rate; | |
75 | }; | |
76 | ||
266e4e9d DA |
77 | /** |
78 | * struct clk_bulk_data - Data used for bulk clk operations. | |
79 | * | |
80 | * @id: clock consumer ID | |
81 | * @clk: struct clk * to store the associated clock | |
82 | * | |
83 | * The CLK APIs provide a series of clk_bulk_() API calls as | |
84 | * a convenience to consumers which require multiple clks. This | |
85 | * structure is used to manage data for these calls. | |
86 | */ | |
87 | struct clk_bulk_data { | |
88 | const char *id; | |
89 | struct clk *clk; | |
90 | }; | |
91 | ||
e81b87d2 KK |
92 | #ifdef CONFIG_COMMON_CLK |
93 | ||
86bcfa2e MT |
94 | /** |
95 | * clk_notifier_register: register a clock rate-change notifier callback | |
96 | * @clk: clock whose rate we are interested in | |
97 | * @nb: notifier block with callback function pointer | |
98 | * | |
99 | * ProTip: debugging across notifier chains can be frustrating. Make sure that | |
100 | * your notifier callback function prints a nice big warning in case of | |
101 | * failure. | |
102 | */ | |
b2476490 MT |
103 | int clk_notifier_register(struct clk *clk, struct notifier_block *nb); |
104 | ||
86bcfa2e MT |
105 | /** |
106 | * clk_notifier_unregister: unregister a clock rate-change notifier callback | |
107 | * @clk: clock whose rate we are no longer interested in | |
108 | * @nb: notifier block which will be unregistered | |
109 | */ | |
b2476490 MT |
110 | int clk_notifier_unregister(struct clk *clk, struct notifier_block *nb); |
111 | ||
5279fc40 BB |
112 | /** |
113 | * clk_get_accuracy - obtain the clock accuracy in ppb (parts per billion) | |
114 | * for a clock source. | |
115 | * @clk: clock source | |
116 | * | |
117 | * This gets the clock source accuracy expressed in ppb. | |
118 | * A perfect clock returns 0. | |
119 | */ | |
120 | long clk_get_accuracy(struct clk *clk); | |
121 | ||
e59c5371 MT |
122 | /** |
123 | * clk_set_phase - adjust the phase shift of a clock signal | |
124 | * @clk: clock signal source | |
125 | * @degrees: number of degrees the signal is shifted | |
126 | * | |
127 | * Shifts the phase of a clock signal by the specified degrees. Returns 0 on | |
128 | * success, -EERROR otherwise. | |
129 | */ | |
130 | int clk_set_phase(struct clk *clk, int degrees); | |
131 | ||
132 | /** | |
133 | * clk_get_phase - return the phase shift of a clock signal | |
134 | * @clk: clock signal source | |
135 | * | |
136 | * Returns the phase shift of a clock node in degrees, otherwise returns | |
137 | * -EERROR. | |
138 | */ | |
139 | int clk_get_phase(struct clk *clk); | |
140 | ||
9fba738a JB |
141 | /** |
142 | * clk_set_duty_cycle - adjust the duty cycle ratio of a clock signal | |
143 | * @clk: clock signal source | |
144 | * @num: numerator of the duty cycle ratio to be applied | |
145 | * @den: denominator of the duty cycle ratio to be applied | |
146 | * | |
147 | * Adjust the duty cycle of a clock signal by the specified ratio. Returns 0 on | |
148 | * success, -EERROR otherwise. | |
149 | */ | |
150 | int clk_set_duty_cycle(struct clk *clk, unsigned int num, unsigned int den); | |
151 | ||
152 | /** | |
153 | * clk_get_duty_cycle - return the duty cycle ratio of a clock signal | |
154 | * @clk: clock signal source | |
155 | * @scale: scaling factor to be applied to represent the ratio as an integer | |
156 | * | |
157 | * Returns the duty cycle ratio multiplied by the scale provided, otherwise | |
158 | * returns -EERROR. | |
159 | */ | |
160 | int clk_get_scaled_duty_cycle(struct clk *clk, unsigned int scale); | |
161 | ||
3d3801ef MT |
162 | /** |
163 | * clk_is_match - check if two clk's point to the same hardware clock | |
164 | * @p: clk compared against q | |
165 | * @q: clk compared against p | |
166 | * | |
167 | * Returns true if the two struct clk pointers both point to the same hardware | |
0e056eb5 | 168 | * clock node. Put differently, returns true if @p and @q |
169 | * share the same &struct clk_core object. | |
3d3801ef MT |
170 | * |
171 | * Returns false otherwise. Note that two NULL clks are treated as matching. | |
172 | */ | |
173 | bool clk_is_match(const struct clk *p, const struct clk *q); | |
174 | ||
5279fc40 BB |
175 | #else |
176 | ||
e81b87d2 KK |
177 | static inline int clk_notifier_register(struct clk *clk, |
178 | struct notifier_block *nb) | |
179 | { | |
180 | return -ENOTSUPP; | |
181 | } | |
182 | ||
183 | static inline int clk_notifier_unregister(struct clk *clk, | |
184 | struct notifier_block *nb) | |
185 | { | |
186 | return -ENOTSUPP; | |
187 | } | |
188 | ||
5279fc40 BB |
189 | static inline long clk_get_accuracy(struct clk *clk) |
190 | { | |
191 | return -ENOTSUPP; | |
192 | } | |
193 | ||
e59c5371 MT |
194 | static inline long clk_set_phase(struct clk *clk, int phase) |
195 | { | |
196 | return -ENOTSUPP; | |
197 | } | |
198 | ||
199 | static inline long clk_get_phase(struct clk *clk) | |
200 | { | |
201 | return -ENOTSUPP; | |
202 | } | |
203 | ||
9fba738a JB |
204 | static inline int clk_set_duty_cycle(struct clk *clk, unsigned int num, |
205 | unsigned int den) | |
206 | { | |
207 | return -ENOTSUPP; | |
208 | } | |
209 | ||
210 | static inline unsigned int clk_get_scaled_duty_cycle(struct clk *clk, | |
211 | unsigned int scale) | |
212 | { | |
213 | return 0; | |
214 | } | |
215 | ||
3d3801ef MT |
216 | static inline bool clk_is_match(const struct clk *p, const struct clk *q) |
217 | { | |
218 | return p == q; | |
219 | } | |
220 | ||
7e87aed9 | 221 | #endif |
1da177e4 | 222 | |
93abe8e4 VK |
223 | /** |
224 | * clk_prepare - prepare a clock source | |
225 | * @clk: clock source | |
226 | * | |
227 | * This prepares the clock source for use. | |
228 | * | |
229 | * Must not be called from within atomic context. | |
230 | */ | |
231 | #ifdef CONFIG_HAVE_CLK_PREPARE | |
232 | int clk_prepare(struct clk *clk); | |
266e4e9d DA |
233 | int __must_check clk_bulk_prepare(int num_clks, |
234 | const struct clk_bulk_data *clks); | |
93abe8e4 VK |
235 | #else |
236 | static inline int clk_prepare(struct clk *clk) | |
237 | { | |
238 | might_sleep(); | |
239 | return 0; | |
240 | } | |
266e4e9d | 241 | |
6e0d4ff4 | 242 | static inline int __must_check clk_bulk_prepare(int num_clks, struct clk_bulk_data *clks) |
266e4e9d DA |
243 | { |
244 | might_sleep(); | |
245 | return 0; | |
246 | } | |
93abe8e4 VK |
247 | #endif |
248 | ||
249 | /** | |
250 | * clk_unprepare - undo preparation of a clock source | |
251 | * @clk: clock source | |
252 | * | |
253 | * This undoes a previously prepared clock. The caller must balance | |
254 | * the number of prepare and unprepare calls. | |
255 | * | |
256 | * Must not be called from within atomic context. | |
257 | */ | |
258 | #ifdef CONFIG_HAVE_CLK_PREPARE | |
259 | void clk_unprepare(struct clk *clk); | |
266e4e9d | 260 | void clk_bulk_unprepare(int num_clks, const struct clk_bulk_data *clks); |
93abe8e4 VK |
261 | #else |
262 | static inline void clk_unprepare(struct clk *clk) | |
263 | { | |
264 | might_sleep(); | |
265 | } | |
266e4e9d DA |
266 | static inline void clk_bulk_unprepare(int num_clks, struct clk_bulk_data *clks) |
267 | { | |
268 | might_sleep(); | |
269 | } | |
93abe8e4 VK |
270 | #endif |
271 | ||
272 | #ifdef CONFIG_HAVE_CLK | |
1da177e4 LT |
273 | /** |
274 | * clk_get - lookup and obtain a reference to a clock producer. | |
275 | * @dev: device for clock "consumer" | |
a58b3a4a | 276 | * @id: clock consumer ID |
1da177e4 LT |
277 | * |
278 | * Returns a struct clk corresponding to the clock producer, or | |
ea3f4eac RK |
279 | * valid IS_ERR() condition containing errno. The implementation |
280 | * uses @dev and @id to determine the clock consumer, and thereby | |
281 | * the clock producer. (IOW, @id may be identical strings, but | |
282 | * clk_get may return different clock producers depending on @dev.) | |
f47fc0ac RK |
283 | * |
284 | * Drivers must assume that the clock source is not enabled. | |
f7ad160b AR |
285 | * |
286 | * clk_get should not be called from within interrupt context. | |
1da177e4 LT |
287 | */ |
288 | struct clk *clk_get(struct device *dev, const char *id); | |
289 | ||
266e4e9d DA |
290 | /** |
291 | * clk_bulk_get - lookup and obtain a number of references to clock producer. | |
292 | * @dev: device for clock "consumer" | |
293 | * @num_clks: the number of clk_bulk_data | |
294 | * @clks: the clk_bulk_data table of consumer | |
295 | * | |
296 | * This helper function allows drivers to get several clk consumers in one | |
297 | * operation. If any of the clk cannot be acquired then any clks | |
298 | * that were obtained will be freed before returning to the caller. | |
299 | * | |
300 | * Returns 0 if all clocks specified in clk_bulk_data table are obtained | |
301 | * successfully, or valid IS_ERR() condition containing errno. | |
302 | * The implementation uses @dev and @clk_bulk_data.id to determine the | |
303 | * clock consumer, and thereby the clock producer. | |
304 | * The clock returned is stored in each @clk_bulk_data.clk field. | |
305 | * | |
306 | * Drivers must assume that the clock source is not enabled. | |
307 | * | |
308 | * clk_bulk_get should not be called from within interrupt context. | |
309 | */ | |
310 | int __must_check clk_bulk_get(struct device *dev, int num_clks, | |
311 | struct clk_bulk_data *clks); | |
616e45df DA |
312 | /** |
313 | * clk_bulk_get_all - lookup and obtain all available references to clock | |
314 | * producer. | |
315 | * @dev: device for clock "consumer" | |
316 | * @clks: pointer to the clk_bulk_data table of consumer | |
317 | * | |
318 | * This helper function allows drivers to get all clk consumers in one | |
319 | * operation. If any of the clk cannot be acquired then any clks | |
320 | * that were obtained will be freed before returning to the caller. | |
321 | * | |
322 | * Returns a positive value for the number of clocks obtained while the | |
323 | * clock references are stored in the clk_bulk_data table in @clks field. | |
324 | * Returns 0 if there're none and a negative value if something failed. | |
325 | * | |
326 | * Drivers must assume that the clock source is not enabled. | |
327 | * | |
328 | * clk_bulk_get should not be called from within interrupt context. | |
329 | */ | |
330 | int __must_check clk_bulk_get_all(struct device *dev, | |
331 | struct clk_bulk_data **clks); | |
618aee02 DA |
332 | /** |
333 | * devm_clk_bulk_get - managed get multiple clk consumers | |
334 | * @dev: device for clock "consumer" | |
335 | * @num_clks: the number of clk_bulk_data | |
336 | * @clks: the clk_bulk_data table of consumer | |
337 | * | |
338 | * Return 0 on success, an errno on failure. | |
339 | * | |
340 | * This helper function allows drivers to get several clk | |
341 | * consumers in one operation with management, the clks will | |
342 | * automatically be freed when the device is unbound. | |
343 | */ | |
344 | int __must_check devm_clk_bulk_get(struct device *dev, int num_clks, | |
345 | struct clk_bulk_data *clks); | |
f08c2e28 DA |
346 | /** |
347 | * devm_clk_bulk_get_all - managed get multiple clk consumers | |
348 | * @dev: device for clock "consumer" | |
349 | * @clks: pointer to the clk_bulk_data table of consumer | |
350 | * | |
351 | * Returns a positive value for the number of clocks obtained while the | |
352 | * clock references are stored in the clk_bulk_data table in @clks field. | |
353 | * Returns 0 if there're none and a negative value if something failed. | |
354 | * | |
355 | * This helper function allows drivers to get several clk | |
356 | * consumers in one operation with management, the clks will | |
357 | * automatically be freed when the device is unbound. | |
358 | */ | |
359 | ||
360 | int __must_check devm_clk_bulk_get_all(struct device *dev, | |
361 | struct clk_bulk_data **clks); | |
618aee02 | 362 | |
a8a97db9 MB |
363 | /** |
364 | * devm_clk_get - lookup and obtain a managed reference to a clock producer. | |
365 | * @dev: device for clock "consumer" | |
a58b3a4a | 366 | * @id: clock consumer ID |
a8a97db9 MB |
367 | * |
368 | * Returns a struct clk corresponding to the clock producer, or | |
369 | * valid IS_ERR() condition containing errno. The implementation | |
370 | * uses @dev and @id to determine the clock consumer, and thereby | |
371 | * the clock producer. (IOW, @id may be identical strings, but | |
372 | * clk_get may return different clock producers depending on @dev.) | |
373 | * | |
374 | * Drivers must assume that the clock source is not enabled. | |
375 | * | |
376 | * devm_clk_get should not be called from within interrupt context. | |
377 | * | |
378 | * The clock will automatically be freed when the device is unbound | |
379 | * from the bus. | |
380 | */ | |
381 | struct clk *devm_clk_get(struct device *dev, const char *id); | |
382 | ||
60b8f0dd PE |
383 | /** |
384 | * devm_clk_get_optional - lookup and obtain a managed reference to an optional | |
385 | * clock producer. | |
386 | * @dev: device for clock "consumer" | |
387 | * @id: clock consumer ID | |
388 | * | |
389 | * Behaves the same as devm_clk_get() except where there is no clock producer. | |
390 | * In this case, instead of returning -ENOENT, the function returns NULL. | |
391 | */ | |
392 | struct clk *devm_clk_get_optional(struct device *dev, const char *id); | |
393 | ||
71a2f115 KM |
394 | /** |
395 | * devm_get_clk_from_child - lookup and obtain a managed reference to a | |
396 | * clock producer from child node. | |
397 | * @dev: device for clock "consumer" | |
398 | * @np: pointer to clock consumer node | |
399 | * @con_id: clock consumer ID | |
400 | * | |
401 | * This function parses the clocks, and uses them to look up the | |
402 | * struct clk from the registered list of clock providers by using | |
403 | * @np and @con_id | |
404 | * | |
405 | * The clock will automatically be freed when the device is unbound | |
406 | * from the bus. | |
407 | */ | |
408 | struct clk *devm_get_clk_from_child(struct device *dev, | |
409 | struct device_node *np, const char *con_id); | |
55e9b8b7 JB |
410 | /** |
411 | * clk_rate_exclusive_get - get exclusivity over the rate control of a | |
412 | * producer | |
413 | * @clk: clock source | |
414 | * | |
415 | * This function allows drivers to get exclusive control over the rate of a | |
416 | * provider. It prevents any other consumer to execute, even indirectly, | |
417 | * opereation which could alter the rate of the provider or cause glitches | |
418 | * | |
419 | * If exlusivity is claimed more than once on clock, even by the same driver, | |
420 | * the rate effectively gets locked as exclusivity can't be preempted. | |
421 | * | |
422 | * Must not be called from within atomic context. | |
423 | * | |
424 | * Returns success (0) or negative errno. | |
425 | */ | |
426 | int clk_rate_exclusive_get(struct clk *clk); | |
427 | ||
428 | /** | |
429 | * clk_rate_exclusive_put - release exclusivity over the rate control of a | |
430 | * producer | |
431 | * @clk: clock source | |
432 | * | |
433 | * This function allows drivers to release the exclusivity it previously got | |
434 | * from clk_rate_exclusive_get() | |
435 | * | |
436 | * The caller must balance the number of clk_rate_exclusive_get() and | |
437 | * clk_rate_exclusive_put() calls. | |
438 | * | |
439 | * Must not be called from within atomic context. | |
440 | */ | |
441 | void clk_rate_exclusive_put(struct clk *clk); | |
71a2f115 | 442 | |
1da177e4 LT |
443 | /** |
444 | * clk_enable - inform the system when the clock source should be running. | |
445 | * @clk: clock source | |
446 | * | |
447 | * If the clock can not be enabled/disabled, this should return success. | |
448 | * | |
40d3e0f4 RK |
449 | * May be called from atomic contexts. |
450 | * | |
1da177e4 LT |
451 | * Returns success (0) or negative errno. |
452 | */ | |
453 | int clk_enable(struct clk *clk); | |
454 | ||
266e4e9d DA |
455 | /** |
456 | * clk_bulk_enable - inform the system when the set of clks should be running. | |
457 | * @num_clks: the number of clk_bulk_data | |
458 | * @clks: the clk_bulk_data table of consumer | |
459 | * | |
460 | * May be called from atomic contexts. | |
461 | * | |
462 | * Returns success (0) or negative errno. | |
463 | */ | |
464 | int __must_check clk_bulk_enable(int num_clks, | |
465 | const struct clk_bulk_data *clks); | |
466 | ||
1da177e4 LT |
467 | /** |
468 | * clk_disable - inform the system when the clock source is no longer required. | |
469 | * @clk: clock source | |
f47fc0ac RK |
470 | * |
471 | * Inform the system that a clock source is no longer required by | |
472 | * a driver and may be shut down. | |
473 | * | |
40d3e0f4 RK |
474 | * May be called from atomic contexts. |
475 | * | |
f47fc0ac RK |
476 | * Implementation detail: if the clock source is shared between |
477 | * multiple drivers, clk_enable() calls must be balanced by the | |
478 | * same number of clk_disable() calls for the clock source to be | |
479 | * disabled. | |
1da177e4 LT |
480 | */ |
481 | void clk_disable(struct clk *clk); | |
482 | ||
266e4e9d DA |
483 | /** |
484 | * clk_bulk_disable - inform the system when the set of clks is no | |
485 | * longer required. | |
486 | * @num_clks: the number of clk_bulk_data | |
487 | * @clks: the clk_bulk_data table of consumer | |
488 | * | |
489 | * Inform the system that a set of clks is no longer required by | |
490 | * a driver and may be shut down. | |
491 | * | |
492 | * May be called from atomic contexts. | |
493 | * | |
494 | * Implementation detail: if the set of clks is shared between | |
495 | * multiple drivers, clk_bulk_enable() calls must be balanced by the | |
496 | * same number of clk_bulk_disable() calls for the clock source to be | |
497 | * disabled. | |
498 | */ | |
499 | void clk_bulk_disable(int num_clks, const struct clk_bulk_data *clks); | |
500 | ||
1da177e4 LT |
501 | /** |
502 | * clk_get_rate - obtain the current clock rate (in Hz) for a clock source. | |
503 | * This is only valid once the clock source has been enabled. | |
504 | * @clk: clock source | |
505 | */ | |
506 | unsigned long clk_get_rate(struct clk *clk); | |
507 | ||
508 | /** | |
509 | * clk_put - "free" the clock source | |
510 | * @clk: clock source | |
f47fc0ac RK |
511 | * |
512 | * Note: drivers must ensure that all clk_enable calls made on this | |
513 | * clock source are balanced by clk_disable calls prior to calling | |
514 | * this function. | |
f7ad160b AR |
515 | * |
516 | * clk_put should not be called from within interrupt context. | |
1da177e4 LT |
517 | */ |
518 | void clk_put(struct clk *clk); | |
519 | ||
266e4e9d DA |
520 | /** |
521 | * clk_bulk_put - "free" the clock source | |
522 | * @num_clks: the number of clk_bulk_data | |
523 | * @clks: the clk_bulk_data table of consumer | |
524 | * | |
525 | * Note: drivers must ensure that all clk_bulk_enable calls made on this | |
526 | * clock source are balanced by clk_bulk_disable calls prior to calling | |
527 | * this function. | |
528 | * | |
529 | * clk_bulk_put should not be called from within interrupt context. | |
530 | */ | |
531 | void clk_bulk_put(int num_clks, struct clk_bulk_data *clks); | |
532 | ||
616e45df DA |
533 | /** |
534 | * clk_bulk_put_all - "free" all the clock source | |
535 | * @num_clks: the number of clk_bulk_data | |
536 | * @clks: the clk_bulk_data table of consumer | |
537 | * | |
538 | * Note: drivers must ensure that all clk_bulk_enable calls made on this | |
539 | * clock source are balanced by clk_bulk_disable calls prior to calling | |
540 | * this function. | |
541 | * | |
542 | * clk_bulk_put_all should not be called from within interrupt context. | |
543 | */ | |
544 | void clk_bulk_put_all(int num_clks, struct clk_bulk_data *clks); | |
545 | ||
a8a97db9 MB |
546 | /** |
547 | * devm_clk_put - "free" a managed clock source | |
da3dae54 | 548 | * @dev: device used to acquire the clock |
a8a97db9 MB |
549 | * @clk: clock source acquired with devm_clk_get() |
550 | * | |
551 | * Note: drivers must ensure that all clk_enable calls made on this | |
552 | * clock source are balanced by clk_disable calls prior to calling | |
553 | * this function. | |
554 | * | |
555 | * clk_put should not be called from within interrupt context. | |
556 | */ | |
557 | void devm_clk_put(struct device *dev, struct clk *clk); | |
1da177e4 LT |
558 | |
559 | /* | |
560 | * The remaining APIs are optional for machine class support. | |
561 | */ | |
562 | ||
563 | ||
564 | /** | |
565 | * clk_round_rate - adjust a rate to the exact rate a clock can provide | |
566 | * @clk: clock source | |
567 | * @rate: desired clock rate in Hz | |
568 | * | |
d2d14a77 RK |
569 | * This answers the question "if I were to pass @rate to clk_set_rate(), |
570 | * what clock rate would I end up with?" without changing the hardware | |
571 | * in any way. In other words: | |
572 | * | |
573 | * rate = clk_round_rate(clk, r); | |
574 | * | |
575 | * and: | |
576 | * | |
577 | * clk_set_rate(clk, r); | |
578 | * rate = clk_get_rate(clk); | |
579 | * | |
580 | * are equivalent except the former does not modify the clock hardware | |
581 | * in any way. | |
582 | * | |
1da177e4 LT |
583 | * Returns rounded clock rate in Hz, or negative errno. |
584 | */ | |
585 | long clk_round_rate(struct clk *clk, unsigned long rate); | |
8b7730dd | 586 | |
1da177e4 LT |
587 | /** |
588 | * clk_set_rate - set the clock rate for a clock source | |
589 | * @clk: clock source | |
590 | * @rate: desired clock rate in Hz | |
591 | * | |
592 | * Returns success (0) or negative errno. | |
593 | */ | |
594 | int clk_set_rate(struct clk *clk, unsigned long rate); | |
8b7730dd | 595 | |
55e9b8b7 JB |
596 | /** |
597 | * clk_set_rate_exclusive- set the clock rate and claim exclusivity over | |
598 | * clock source | |
599 | * @clk: clock source | |
600 | * @rate: desired clock rate in Hz | |
601 | * | |
602 | * This helper function allows drivers to atomically set the rate of a producer | |
603 | * and claim exclusivity over the rate control of the producer. | |
604 | * | |
605 | * It is essentially a combination of clk_set_rate() and | |
606 | * clk_rate_exclusite_get(). Caller must balance this call with a call to | |
607 | * clk_rate_exclusive_put() | |
608 | * | |
609 | * Returns success (0) or negative errno. | |
610 | */ | |
611 | int clk_set_rate_exclusive(struct clk *clk, unsigned long rate); | |
612 | ||
4e88f3de TR |
613 | /** |
614 | * clk_has_parent - check if a clock is a possible parent for another | |
615 | * @clk: clock source | |
616 | * @parent: parent clock source | |
617 | * | |
618 | * This function can be used in drivers that need to check that a clock can be | |
619 | * the parent of another without actually changing the parent. | |
620 | * | |
621 | * Returns true if @parent is a possible parent for @clk, false otherwise. | |
622 | */ | |
623 | bool clk_has_parent(struct clk *clk, struct clk *parent); | |
624 | ||
1c8e6004 TV |
625 | /** |
626 | * clk_set_rate_range - set a rate range for a clock source | |
627 | * @clk: clock source | |
628 | * @min: desired minimum clock rate in Hz, inclusive | |
629 | * @max: desired maximum clock rate in Hz, inclusive | |
630 | * | |
631 | * Returns success (0) or negative errno. | |
632 | */ | |
633 | int clk_set_rate_range(struct clk *clk, unsigned long min, unsigned long max); | |
634 | ||
635 | /** | |
636 | * clk_set_min_rate - set a minimum clock rate for a clock source | |
637 | * @clk: clock source | |
638 | * @rate: desired minimum clock rate in Hz, inclusive | |
639 | * | |
640 | * Returns success (0) or negative errno. | |
641 | */ | |
642 | int clk_set_min_rate(struct clk *clk, unsigned long rate); | |
643 | ||
644 | /** | |
645 | * clk_set_max_rate - set a maximum clock rate for a clock source | |
646 | * @clk: clock source | |
647 | * @rate: desired maximum clock rate in Hz, inclusive | |
648 | * | |
649 | * Returns success (0) or negative errno. | |
650 | */ | |
651 | int clk_set_max_rate(struct clk *clk, unsigned long rate); | |
652 | ||
1da177e4 LT |
653 | /** |
654 | * clk_set_parent - set the parent clock source for this clock | |
655 | * @clk: clock source | |
656 | * @parent: parent clock source | |
657 | * | |
658 | * Returns success (0) or negative errno. | |
659 | */ | |
660 | int clk_set_parent(struct clk *clk, struct clk *parent); | |
661 | ||
662 | /** | |
663 | * clk_get_parent - get the parent clock source for this clock | |
664 | * @clk: clock source | |
665 | * | |
666 | * Returns struct clk corresponding to parent clock source, or | |
667 | * valid IS_ERR() condition containing errno. | |
668 | */ | |
669 | struct clk *clk_get_parent(struct clk *clk); | |
670 | ||
05fd8e73 SH |
671 | /** |
672 | * clk_get_sys - get a clock based upon the device name | |
673 | * @dev_id: device name | |
674 | * @con_id: connection ID | |
675 | * | |
676 | * Returns a struct clk corresponding to the clock producer, or | |
677 | * valid IS_ERR() condition containing errno. The implementation | |
678 | * uses @dev_id and @con_id to determine the clock consumer, and | |
679 | * thereby the clock producer. In contrast to clk_get() this function | |
680 | * takes the device name instead of the device itself for identification. | |
681 | * | |
682 | * Drivers must assume that the clock source is not enabled. | |
683 | * | |
684 | * clk_get_sys should not be called from within interrupt context. | |
685 | */ | |
686 | struct clk *clk_get_sys(const char *dev_id, const char *con_id); | |
687 | ||
8b95d1ce RD |
688 | /** |
689 | * clk_save_context - save clock context for poweroff | |
690 | * | |
691 | * Saves the context of the clock register for powerstates in which the | |
692 | * contents of the registers will be lost. Occurs deep within the suspend | |
693 | * code so locking is not necessary. | |
694 | */ | |
695 | int clk_save_context(void); | |
696 | ||
697 | /** | |
698 | * clk_restore_context - restore clock context after poweroff | |
699 | * | |
700 | * This occurs with all clocks enabled. Occurs deep within the resume code | |
701 | * so locking is not necessary. | |
702 | */ | |
703 | void clk_restore_context(void); | |
704 | ||
93abe8e4 VK |
705 | #else /* !CONFIG_HAVE_CLK */ |
706 | ||
707 | static inline struct clk *clk_get(struct device *dev, const char *id) | |
708 | { | |
709 | return NULL; | |
710 | } | |
711 | ||
6e0d4ff4 DA |
712 | static inline int __must_check clk_bulk_get(struct device *dev, int num_clks, |
713 | struct clk_bulk_data *clks) | |
266e4e9d DA |
714 | { |
715 | return 0; | |
716 | } | |
717 | ||
616e45df DA |
718 | static inline int __must_check clk_bulk_get_all(struct device *dev, |
719 | struct clk_bulk_data **clks) | |
720 | { | |
721 | return 0; | |
722 | } | |
723 | ||
93abe8e4 VK |
724 | static inline struct clk *devm_clk_get(struct device *dev, const char *id) |
725 | { | |
726 | return NULL; | |
727 | } | |
728 | ||
60b8f0dd PE |
729 | static inline struct clk *devm_clk_get_optional(struct device *dev, |
730 | const char *id) | |
731 | { | |
732 | return NULL; | |
733 | } | |
734 | ||
6e0d4ff4 DA |
735 | static inline int __must_check devm_clk_bulk_get(struct device *dev, int num_clks, |
736 | struct clk_bulk_data *clks) | |
618aee02 DA |
737 | { |
738 | return 0; | |
739 | } | |
740 | ||
f08c2e28 DA |
741 | static inline int __must_check devm_clk_bulk_get_all(struct device *dev, |
742 | struct clk_bulk_data **clks) | |
743 | { | |
744 | ||
745 | return 0; | |
746 | } | |
747 | ||
71a2f115 KM |
748 | static inline struct clk *devm_get_clk_from_child(struct device *dev, |
749 | struct device_node *np, const char *con_id) | |
750 | { | |
751 | return NULL; | |
752 | } | |
753 | ||
93abe8e4 VK |
754 | static inline void clk_put(struct clk *clk) {} |
755 | ||
266e4e9d DA |
756 | static inline void clk_bulk_put(int num_clks, struct clk_bulk_data *clks) {} |
757 | ||
616e45df DA |
758 | static inline void clk_bulk_put_all(int num_clks, struct clk_bulk_data *clks) {} |
759 | ||
93abe8e4 VK |
760 | static inline void devm_clk_put(struct device *dev, struct clk *clk) {} |
761 | ||
55e9b8b7 JB |
762 | |
763 | static inline int clk_rate_exclusive_get(struct clk *clk) | |
764 | { | |
765 | return 0; | |
766 | } | |
767 | ||
768 | static inline void clk_rate_exclusive_put(struct clk *clk) {} | |
769 | ||
93abe8e4 VK |
770 | static inline int clk_enable(struct clk *clk) |
771 | { | |
772 | return 0; | |
773 | } | |
774 | ||
6e0d4ff4 | 775 | static inline int __must_check clk_bulk_enable(int num_clks, struct clk_bulk_data *clks) |
266e4e9d DA |
776 | { |
777 | return 0; | |
778 | } | |
779 | ||
93abe8e4 VK |
780 | static inline void clk_disable(struct clk *clk) {} |
781 | ||
266e4e9d DA |
782 | |
783 | static inline void clk_bulk_disable(int num_clks, | |
784 | struct clk_bulk_data *clks) {} | |
785 | ||
93abe8e4 VK |
786 | static inline unsigned long clk_get_rate(struct clk *clk) |
787 | { | |
788 | return 0; | |
789 | } | |
790 | ||
791 | static inline int clk_set_rate(struct clk *clk, unsigned long rate) | |
792 | { | |
793 | return 0; | |
794 | } | |
795 | ||
55e9b8b7 JB |
796 | static inline int clk_set_rate_exclusive(struct clk *clk, unsigned long rate) |
797 | { | |
798 | return 0; | |
799 | } | |
800 | ||
93abe8e4 VK |
801 | static inline long clk_round_rate(struct clk *clk, unsigned long rate) |
802 | { | |
803 | return 0; | |
804 | } | |
805 | ||
4e88f3de TR |
806 | static inline bool clk_has_parent(struct clk *clk, struct clk *parent) |
807 | { | |
808 | return true; | |
809 | } | |
810 | ||
b88c9f41 DO |
811 | static inline int clk_set_rate_range(struct clk *clk, unsigned long min, |
812 | unsigned long max) | |
813 | { | |
814 | return 0; | |
815 | } | |
816 | ||
817 | static inline int clk_set_min_rate(struct clk *clk, unsigned long rate) | |
818 | { | |
819 | return 0; | |
820 | } | |
821 | ||
822 | static inline int clk_set_max_rate(struct clk *clk, unsigned long rate) | |
823 | { | |
824 | return 0; | |
825 | } | |
826 | ||
93abe8e4 VK |
827 | static inline int clk_set_parent(struct clk *clk, struct clk *parent) |
828 | { | |
829 | return 0; | |
830 | } | |
831 | ||
832 | static inline struct clk *clk_get_parent(struct clk *clk) | |
833 | { | |
834 | return NULL; | |
835 | } | |
836 | ||
b81ea968 DL |
837 | static inline struct clk *clk_get_sys(const char *dev_id, const char *con_id) |
838 | { | |
839 | return NULL; | |
840 | } | |
8b95d1ce RD |
841 | |
842 | static inline int clk_save_context(void) | |
843 | { | |
844 | return 0; | |
845 | } | |
846 | ||
847 | static inline void clk_restore_context(void) {} | |
848 | ||
93abe8e4 VK |
849 | #endif |
850 | ||
851 | /* clk_prepare_enable helps cases using clk_enable in non-atomic context. */ | |
852 | static inline int clk_prepare_enable(struct clk *clk) | |
853 | { | |
854 | int ret; | |
855 | ||
856 | ret = clk_prepare(clk); | |
857 | if (ret) | |
858 | return ret; | |
859 | ret = clk_enable(clk); | |
860 | if (ret) | |
861 | clk_unprepare(clk); | |
862 | ||
863 | return ret; | |
864 | } | |
865 | ||
866 | /* clk_disable_unprepare helps cases using clk_disable in non-atomic context. */ | |
867 | static inline void clk_disable_unprepare(struct clk *clk) | |
868 | { | |
869 | clk_disable(clk); | |
870 | clk_unprepare(clk); | |
871 | } | |
872 | ||
6e0d4ff4 DA |
873 | static inline int __must_check clk_bulk_prepare_enable(int num_clks, |
874 | struct clk_bulk_data *clks) | |
3c48d86c BA |
875 | { |
876 | int ret; | |
877 | ||
878 | ret = clk_bulk_prepare(num_clks, clks); | |
879 | if (ret) | |
880 | return ret; | |
881 | ret = clk_bulk_enable(num_clks, clks); | |
882 | if (ret) | |
883 | clk_bulk_unprepare(num_clks, clks); | |
884 | ||
885 | return ret; | |
886 | } | |
887 | ||
888 | static inline void clk_bulk_disable_unprepare(int num_clks, | |
889 | struct clk_bulk_data *clks) | |
890 | { | |
891 | clk_bulk_disable(num_clks, clks); | |
892 | clk_bulk_unprepare(num_clks, clks); | |
893 | } | |
894 | ||
60b8f0dd PE |
895 | /** |
896 | * clk_get_optional - lookup and obtain a reference to an optional clock | |
897 | * producer. | |
898 | * @dev: device for clock "consumer" | |
899 | * @id: clock consumer ID | |
900 | * | |
901 | * Behaves the same as clk_get() except where there is no clock producer. In | |
902 | * this case, instead of returning -ENOENT, the function returns NULL. | |
903 | */ | |
904 | static inline struct clk *clk_get_optional(struct device *dev, const char *id) | |
905 | { | |
906 | struct clk *clk = clk_get(dev, id); | |
907 | ||
908 | if (clk == ERR_PTR(-ENOENT)) | |
909 | return NULL; | |
910 | ||
911 | return clk; | |
912 | } | |
913 | ||
137f8a72 | 914 | #if defined(CONFIG_OF) && defined(CONFIG_COMMON_CLK) |
766e6a4e GL |
915 | struct clk *of_clk_get(struct device_node *np, int index); |
916 | struct clk *of_clk_get_by_name(struct device_node *np, const char *name); | |
917 | struct clk *of_clk_get_from_provider(struct of_phandle_args *clkspec); | |
918 | #else | |
919 | static inline struct clk *of_clk_get(struct device_node *np, int index) | |
920 | { | |
9f1612d3 | 921 | return ERR_PTR(-ENOENT); |
766e6a4e GL |
922 | } |
923 | static inline struct clk *of_clk_get_by_name(struct device_node *np, | |
924 | const char *name) | |
925 | { | |
9f1612d3 | 926 | return ERR_PTR(-ENOENT); |
766e6a4e | 927 | } |
428c9de5 GU |
928 | static inline struct clk *of_clk_get_from_provider(struct of_phandle_args *clkspec) |
929 | { | |
930 | return ERR_PTR(-ENOENT); | |
931 | } | |
766e6a4e GL |
932 | #endif |
933 | ||
1da177e4 | 934 | #endif |