1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * linux/include/linux/clk.h
5 * Copyright (C) 2004 ARM Limited.
6 * Written by Deep Blue Solutions Limited.
7 * Copyright (C) 2011-2012 Linaro Ltd <mturquette@linaro.org>
12 #include <linux/err.h>
13 #include <linux/kernel.h>
14 #include <linux/notifier.h>
19 struct of_phandle_args;
22 * DOC: clk notifier callback types
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
27 * rate change. Callbacks may either return NOTIFY_DONE, NOTIFY_OK,
28 * NOTIFY_STOP or NOTIFY_BAD.
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
33 * always return NOTIFY_DONE or NOTIFY_OK.
35 * POST_RATE_CHANGE - called after the clk rate change has successfully
36 * completed. Callbacks must always return NOTIFY_DONE or NOTIFY_OK.
39 #define PRE_RATE_CHANGE BIT(0)
40 #define POST_RATE_CHANGE BIT(1)
41 #define ABORT_RATE_CHANGE BIT(2)
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
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
56 struct srcu_notifier_head notifier_head;
57 struct list_head node;
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
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).
71 struct clk_notifier_data {
73 unsigned long old_rate;
74 unsigned long new_rate;
78 * struct clk_bulk_data - Data used for bulk clk operations.
80 * @id: clock consumer ID
81 * @clk: struct clk * to store the associated clock
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.
87 struct clk_bulk_data {
92 #ifdef CONFIG_COMMON_CLK
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
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
103 int clk_notifier_register(struct clk *clk, struct notifier_block *nb);
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
110 int clk_notifier_unregister(struct clk *clk, struct notifier_block *nb);
113 * clk_get_accuracy - obtain the clock accuracy in ppb (parts per billion)
114 * for a clock source.
117 * This gets the clock source accuracy expressed in ppb.
118 * A perfect clock returns 0.
120 long clk_get_accuracy(struct clk *clk);
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
127 * Shifts the phase of a clock signal by the specified degrees. Returns 0 on
128 * success, -EERROR otherwise.
130 int clk_set_phase(struct clk *clk, int degrees);
133 * clk_get_phase - return the phase shift of a clock signal
134 * @clk: clock signal source
136 * Returns the phase shift of a clock node in degrees, otherwise returns
139 int clk_get_phase(struct clk *clk);
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
147 * Adjust the duty cycle of a clock signal by the specified ratio. Returns 0 on
148 * success, -EERROR otherwise.
150 int clk_set_duty_cycle(struct clk *clk, unsigned int num, unsigned int den);
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
157 * Returns the duty cycle ratio multiplied by the scale provided, otherwise
160 int clk_get_scaled_duty_cycle(struct clk *clk, unsigned int scale);
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
167 * Returns true if the two struct clk pointers both point to the same hardware
168 * clock node. Put differently, returns true if @p and @q
169 * share the same &struct clk_core object.
171 * Returns false otherwise. Note that two NULL clks are treated as matching.
173 bool clk_is_match(const struct clk *p, const struct clk *q);
177 static inline int clk_notifier_register(struct clk *clk,
178 struct notifier_block *nb)
183 static inline int clk_notifier_unregister(struct clk *clk,
184 struct notifier_block *nb)
189 static inline long clk_get_accuracy(struct clk *clk)
194 static inline long clk_set_phase(struct clk *clk, int phase)
199 static inline long clk_get_phase(struct clk *clk)
204 static inline int clk_set_duty_cycle(struct clk *clk, unsigned int num,
210 static inline unsigned int clk_get_scaled_duty_cycle(struct clk *clk,
216 static inline bool clk_is_match(const struct clk *p, const struct clk *q)
224 * clk_prepare - prepare a clock source
227 * This prepares the clock source for use.
229 * Must not be called from within atomic context.
231 #ifdef CONFIG_HAVE_CLK_PREPARE
232 int clk_prepare(struct clk *clk);
233 int __must_check clk_bulk_prepare(int num_clks,
234 const struct clk_bulk_data *clks);
236 static inline int clk_prepare(struct clk *clk)
242 static inline int __must_check
243 clk_bulk_prepare(int num_clks, const struct clk_bulk_data *clks)
251 * clk_unprepare - undo preparation of a clock source
254 * This undoes a previously prepared clock. The caller must balance
255 * the number of prepare and unprepare calls.
257 * Must not be called from within atomic context.
259 #ifdef CONFIG_HAVE_CLK_PREPARE
260 void clk_unprepare(struct clk *clk);
261 void clk_bulk_unprepare(int num_clks, const struct clk_bulk_data *clks);
263 static inline void clk_unprepare(struct clk *clk)
267 static inline void clk_bulk_unprepare(int num_clks,
268 const struct clk_bulk_data *clks)
274 #ifdef CONFIG_HAVE_CLK
276 * clk_get - lookup and obtain a reference to a clock producer.
277 * @dev: device for clock "consumer"
278 * @id: clock consumer ID
280 * Returns a struct clk corresponding to the clock producer, or
281 * valid IS_ERR() condition containing errno. The implementation
282 * uses @dev and @id to determine the clock consumer, and thereby
283 * the clock producer. (IOW, @id may be identical strings, but
284 * clk_get may return different clock producers depending on @dev.)
286 * Drivers must assume that the clock source is not enabled.
288 * clk_get should not be called from within interrupt context.
290 struct clk *clk_get(struct device *dev, const char *id);
293 * clk_bulk_get - lookup and obtain a number of references to clock producer.
294 * @dev: device for clock "consumer"
295 * @num_clks: the number of clk_bulk_data
296 * @clks: the clk_bulk_data table of consumer
298 * This helper function allows drivers to get several clk consumers in one
299 * operation. If any of the clk cannot be acquired then any clks
300 * that were obtained will be freed before returning to the caller.
302 * Returns 0 if all clocks specified in clk_bulk_data table are obtained
303 * successfully, or valid IS_ERR() condition containing errno.
304 * The implementation uses @dev and @clk_bulk_data.id to determine the
305 * clock consumer, and thereby the clock producer.
306 * The clock returned is stored in each @clk_bulk_data.clk field.
308 * Drivers must assume that the clock source is not enabled.
310 * clk_bulk_get should not be called from within interrupt context.
312 int __must_check clk_bulk_get(struct device *dev, int num_clks,
313 struct clk_bulk_data *clks);
315 * clk_bulk_get_all - lookup and obtain all available references to clock
317 * @dev: device for clock "consumer"
318 * @clks: pointer to the clk_bulk_data table of consumer
320 * This helper function allows drivers to get all clk consumers in one
321 * operation. If any of the clk cannot be acquired then any clks
322 * that were obtained will be freed before returning to the caller.
324 * Returns a positive value for the number of clocks obtained while the
325 * clock references are stored in the clk_bulk_data table in @clks field.
326 * Returns 0 if there're none and a negative value if something failed.
328 * Drivers must assume that the clock source is not enabled.
330 * clk_bulk_get should not be called from within interrupt context.
332 int __must_check clk_bulk_get_all(struct device *dev,
333 struct clk_bulk_data **clks);
336 * clk_bulk_get_optional - lookup and obtain a number of references to clock producer
337 * @dev: device for clock "consumer"
338 * @num_clks: the number of clk_bulk_data
339 * @clks: the clk_bulk_data table of consumer
341 * Behaves the same as clk_bulk_get() except where there is no clock producer.
342 * In this case, instead of returning -ENOENT, the function returns 0 and
343 * NULL for a clk for which a clock producer could not be determined.
345 int __must_check clk_bulk_get_optional(struct device *dev, int num_clks,
346 struct clk_bulk_data *clks);
348 * devm_clk_bulk_get - managed get multiple clk consumers
349 * @dev: device for clock "consumer"
350 * @num_clks: the number of clk_bulk_data
351 * @clks: the clk_bulk_data table of consumer
353 * Return 0 on success, an errno on failure.
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.
359 int __must_check devm_clk_bulk_get(struct device *dev, int num_clks,
360 struct clk_bulk_data *clks);
362 * devm_clk_bulk_get_optional - managed get multiple optional consumer clocks
363 * @dev: device for clock "consumer"
364 * @num_clks: the number of clk_bulk_data
365 * @clks: pointer to the clk_bulk_data table of consumer
367 * Behaves the same as devm_clk_bulk_get() except where there is no clock
368 * producer. In this case, instead of returning -ENOENT, the function returns
369 * NULL for given clk. It is assumed all clocks in clk_bulk_data are optional.
371 * Returns 0 if all clocks specified in clk_bulk_data table are obtained
372 * successfully or for any clk there was no clk provider available, otherwise
373 * returns valid IS_ERR() condition containing errno.
374 * The implementation uses @dev and @clk_bulk_data.id to determine the
375 * clock consumer, and thereby the clock producer.
376 * The clock returned is stored in each @clk_bulk_data.clk field.
378 * Drivers must assume that the clock source is not enabled.
380 * clk_bulk_get should not be called from within interrupt context.
382 int __must_check devm_clk_bulk_get_optional(struct device *dev, int num_clks,
383 struct clk_bulk_data *clks);
385 * devm_clk_bulk_get_all - managed get multiple clk consumers
386 * @dev: device for clock "consumer"
387 * @clks: pointer to the clk_bulk_data table of consumer
389 * Returns a positive value for the number of clocks obtained while the
390 * clock references are stored in the clk_bulk_data table in @clks field.
391 * Returns 0 if there're none and a negative value if something failed.
393 * This helper function allows drivers to get several clk
394 * consumers in one operation with management, the clks will
395 * automatically be freed when the device is unbound.
398 int __must_check devm_clk_bulk_get_all(struct device *dev,
399 struct clk_bulk_data **clks);
402 * devm_clk_get - lookup and obtain a managed reference to a clock producer.
403 * @dev: device for clock "consumer"
404 * @id: clock consumer ID
406 * Returns a struct clk corresponding to the clock producer, or
407 * valid IS_ERR() condition containing errno. The implementation
408 * uses @dev and @id to determine the clock consumer, and thereby
409 * the clock producer. (IOW, @id may be identical strings, but
410 * clk_get may return different clock producers depending on @dev.)
412 * Drivers must assume that the clock source is not enabled.
414 * devm_clk_get should not be called from within interrupt context.
416 * The clock will automatically be freed when the device is unbound
419 struct clk *devm_clk_get(struct device *dev, const char *id);
422 * devm_clk_get_prepared - devm_clk_get() + clk_prepare()
423 * @dev: device for clock "consumer"
424 * @id: clock consumer ID
426 * Context: May sleep.
428 * Return: a struct clk corresponding to the clock producer, or
429 * valid IS_ERR() condition containing errno. The implementation
430 * uses @dev and @id to determine the clock consumer, and thereby
431 * the clock producer. (IOW, @id may be identical strings, but
432 * clk_get may return different clock producers depending on @dev.)
434 * The returned clk (if valid) is prepared. Drivers must however assume
435 * that the clock is not enabled.
437 * The clock will automatically be unprepared and freed when the device
438 * is unbound from the bus.
440 struct clk *devm_clk_get_prepared(struct device *dev, const char *id);
443 * devm_clk_get_enabled - devm_clk_get() + clk_prepare_enable()
444 * @dev: device for clock "consumer"
445 * @id: clock consumer ID
447 * Context: May sleep.
449 * Return: a struct clk corresponding to the clock producer, or
450 * valid IS_ERR() condition containing errno. The implementation
451 * uses @dev and @id to determine the clock consumer, and thereby
452 * the clock producer. (IOW, @id may be identical strings, but
453 * clk_get may return different clock producers depending on @dev.)
455 * The returned clk (if valid) is prepared and enabled.
457 * The clock will automatically be disabled, unprepared and freed
458 * when the device is unbound from the bus.
460 struct clk *devm_clk_get_enabled(struct device *dev, const char *id);
463 * devm_clk_get_optional - lookup and obtain a managed reference to an optional
465 * @dev: device for clock "consumer"
466 * @id: clock consumer ID
468 * Behaves the same as devm_clk_get() except where there is no clock producer.
469 * In this case, instead of returning -ENOENT, the function returns NULL.
471 struct clk *devm_clk_get_optional(struct device *dev, const char *id);
474 * devm_clk_get_optional_prepared - devm_clk_get_optional() + clk_prepare()
475 * @dev: device for clock "consumer"
476 * @id: clock consumer ID
478 * Context: May sleep.
480 * Return: a struct clk corresponding to the clock producer, or
481 * valid IS_ERR() condition containing errno. The implementation
482 * uses @dev and @id to determine the clock consumer, and thereby
483 * the clock producer. If no such clk is found, it returns NULL
484 * which serves as a dummy clk. That's the only difference compared
485 * to devm_clk_get_prepared().
487 * The returned clk (if valid) is prepared. Drivers must however
488 * assume that the clock is not enabled.
490 * The clock will automatically be unprepared and freed when the
491 * device is unbound from the bus.
493 struct clk *devm_clk_get_optional_prepared(struct device *dev, const char *id);
496 * devm_clk_get_optional_enabled - devm_clk_get_optional() +
497 * clk_prepare_enable()
498 * @dev: device for clock "consumer"
499 * @id: clock consumer ID
501 * Context: May sleep.
503 * Return: a struct clk corresponding to the clock producer, or
504 * valid IS_ERR() condition containing errno. The implementation
505 * uses @dev and @id to determine the clock consumer, and thereby
506 * the clock producer. If no such clk is found, it returns NULL
507 * which serves as a dummy clk. That's the only difference compared
508 * to devm_clk_get_enabled().
510 * The returned clk (if valid) is prepared and enabled.
512 * The clock will automatically be disabled, unprepared and freed
513 * when the device is unbound from the bus.
515 struct clk *devm_clk_get_optional_enabled(struct device *dev, const char *id);
518 * devm_get_clk_from_child - lookup and obtain a managed reference to a
519 * clock producer from child node.
520 * @dev: device for clock "consumer"
521 * @np: pointer to clock consumer node
522 * @con_id: clock consumer ID
524 * This function parses the clocks, and uses them to look up the
525 * struct clk from the registered list of clock providers by using
528 * The clock will automatically be freed when the device is unbound
531 struct clk *devm_get_clk_from_child(struct device *dev,
532 struct device_node *np, const char *con_id);
534 * clk_rate_exclusive_get - get exclusivity over the rate control of a
538 * This function allows drivers to get exclusive control over the rate of a
539 * provider. It prevents any other consumer to execute, even indirectly,
540 * opereation which could alter the rate of the provider or cause glitches
542 * If exlusivity is claimed more than once on clock, even by the same driver,
543 * the rate effectively gets locked as exclusivity can't be preempted.
545 * Must not be called from within atomic context.
547 * Returns success (0) or negative errno.
549 int clk_rate_exclusive_get(struct clk *clk);
552 * clk_rate_exclusive_put - release exclusivity over the rate control of a
556 * This function allows drivers to release the exclusivity it previously got
557 * from clk_rate_exclusive_get()
559 * The caller must balance the number of clk_rate_exclusive_get() and
560 * clk_rate_exclusive_put() calls.
562 * Must not be called from within atomic context.
564 void clk_rate_exclusive_put(struct clk *clk);
567 * clk_enable - inform the system when the clock source should be running.
570 * If the clock can not be enabled/disabled, this should return success.
572 * May be called from atomic contexts.
574 * Returns success (0) or negative errno.
576 int clk_enable(struct clk *clk);
579 * clk_bulk_enable - inform the system when the set of clks should be running.
580 * @num_clks: the number of clk_bulk_data
581 * @clks: the clk_bulk_data table of consumer
583 * May be called from atomic contexts.
585 * Returns success (0) or negative errno.
587 int __must_check clk_bulk_enable(int num_clks,
588 const struct clk_bulk_data *clks);
591 * clk_disable - inform the system when the clock source is no longer required.
594 * Inform the system that a clock source is no longer required by
595 * a driver and may be shut down.
597 * May be called from atomic contexts.
599 * Implementation detail: if the clock source is shared between
600 * multiple drivers, clk_enable() calls must be balanced by the
601 * same number of clk_disable() calls for the clock source to be
604 void clk_disable(struct clk *clk);
607 * clk_bulk_disable - inform the system when the set of clks is no
609 * @num_clks: the number of clk_bulk_data
610 * @clks: the clk_bulk_data table of consumer
612 * Inform the system that a set of clks is no longer required by
613 * a driver and may be shut down.
615 * May be called from atomic contexts.
617 * Implementation detail: if the set of clks is shared between
618 * multiple drivers, clk_bulk_enable() calls must be balanced by the
619 * same number of clk_bulk_disable() calls for the clock source to be
622 void clk_bulk_disable(int num_clks, const struct clk_bulk_data *clks);
625 * clk_get_rate - obtain the current clock rate (in Hz) for a clock source.
626 * This is only valid once the clock source has been enabled.
629 unsigned long clk_get_rate(struct clk *clk);
632 * clk_put - "free" the clock source
635 * Note: drivers must ensure that all clk_enable calls made on this
636 * clock source are balanced by clk_disable calls prior to calling
639 * clk_put should not be called from within interrupt context.
641 void clk_put(struct clk *clk);
644 * clk_bulk_put - "free" the clock source
645 * @num_clks: the number of clk_bulk_data
646 * @clks: the clk_bulk_data table of consumer
648 * Note: drivers must ensure that all clk_bulk_enable calls made on this
649 * clock source are balanced by clk_bulk_disable calls prior to calling
652 * clk_bulk_put should not be called from within interrupt context.
654 void clk_bulk_put(int num_clks, struct clk_bulk_data *clks);
657 * clk_bulk_put_all - "free" all the clock source
658 * @num_clks: the number of clk_bulk_data
659 * @clks: the clk_bulk_data table of consumer
661 * Note: drivers must ensure that all clk_bulk_enable calls made on this
662 * clock source are balanced by clk_bulk_disable calls prior to calling
665 * clk_bulk_put_all should not be called from within interrupt context.
667 void clk_bulk_put_all(int num_clks, struct clk_bulk_data *clks);
670 * devm_clk_put - "free" a managed clock source
671 * @dev: device used to acquire the clock
672 * @clk: clock source acquired with devm_clk_get()
674 * Note: drivers must ensure that all clk_enable calls made on this
675 * clock source are balanced by clk_disable calls prior to calling
678 * clk_put should not be called from within interrupt context.
680 void devm_clk_put(struct device *dev, struct clk *clk);
683 * The remaining APIs are optional for machine class support.
688 * clk_round_rate - adjust a rate to the exact rate a clock can provide
690 * @rate: desired clock rate in Hz
692 * This answers the question "if I were to pass @rate to clk_set_rate(),
693 * what clock rate would I end up with?" without changing the hardware
694 * in any way. In other words:
696 * rate = clk_round_rate(clk, r);
700 * clk_set_rate(clk, r);
701 * rate = clk_get_rate(clk);
703 * are equivalent except the former does not modify the clock hardware
706 * Returns rounded clock rate in Hz, or negative errno.
708 long clk_round_rate(struct clk *clk, unsigned long rate);
711 * clk_set_rate - set the clock rate for a clock source
713 * @rate: desired clock rate in Hz
715 * Returns success (0) or negative errno.
717 int clk_set_rate(struct clk *clk, unsigned long rate);
720 * clk_set_rate_exclusive- set the clock rate and claim exclusivity over
723 * @rate: desired clock rate in Hz
725 * This helper function allows drivers to atomically set the rate of a producer
726 * and claim exclusivity over the rate control of the producer.
728 * It is essentially a combination of clk_set_rate() and
729 * clk_rate_exclusite_get(). Caller must balance this call with a call to
730 * clk_rate_exclusive_put()
732 * Returns success (0) or negative errno.
734 int clk_set_rate_exclusive(struct clk *clk, unsigned long rate);
737 * clk_has_parent - check if a clock is a possible parent for another
739 * @parent: parent clock source
741 * This function can be used in drivers that need to check that a clock can be
742 * the parent of another without actually changing the parent.
744 * Returns true if @parent is a possible parent for @clk, false otherwise.
746 bool clk_has_parent(struct clk *clk, struct clk *parent);
749 * clk_set_rate_range - set a rate range for a clock source
751 * @min: desired minimum clock rate in Hz, inclusive
752 * @max: desired maximum clock rate in Hz, inclusive
754 * Returns success (0) or negative errno.
756 int clk_set_rate_range(struct clk *clk, unsigned long min, unsigned long max);
759 * clk_set_min_rate - set a minimum clock rate for a clock source
761 * @rate: desired minimum clock rate in Hz, inclusive
763 * Returns success (0) or negative errno.
765 int clk_set_min_rate(struct clk *clk, unsigned long rate);
768 * clk_set_max_rate - set a maximum clock rate for a clock source
770 * @rate: desired maximum clock rate in Hz, inclusive
772 * Returns success (0) or negative errno.
774 int clk_set_max_rate(struct clk *clk, unsigned long rate);
777 * clk_set_parent - set the parent clock source for this clock
779 * @parent: parent clock source
781 * Returns success (0) or negative errno.
783 int clk_set_parent(struct clk *clk, struct clk *parent);
786 * clk_get_parent - get the parent clock source for this clock
789 * Returns struct clk corresponding to parent clock source, or
790 * valid IS_ERR() condition containing errno.
792 struct clk *clk_get_parent(struct clk *clk);
795 * clk_get_sys - get a clock based upon the device name
796 * @dev_id: device name
797 * @con_id: connection ID
799 * Returns a struct clk corresponding to the clock producer, or
800 * valid IS_ERR() condition containing errno. The implementation
801 * uses @dev_id and @con_id to determine the clock consumer, and
802 * thereby the clock producer. In contrast to clk_get() this function
803 * takes the device name instead of the device itself for identification.
805 * Drivers must assume that the clock source is not enabled.
807 * clk_get_sys should not be called from within interrupt context.
809 struct clk *clk_get_sys(const char *dev_id, const char *con_id);
812 * clk_save_context - save clock context for poweroff
814 * Saves the context of the clock register for powerstates in which the
815 * contents of the registers will be lost. Occurs deep within the suspend
816 * code so locking is not necessary.
818 int clk_save_context(void);
821 * clk_restore_context - restore clock context after poweroff
823 * This occurs with all clocks enabled. Occurs deep within the resume code
824 * so locking is not necessary.
826 void clk_restore_context(void);
828 #else /* !CONFIG_HAVE_CLK */
830 static inline struct clk *clk_get(struct device *dev, const char *id)
835 static inline int __must_check clk_bulk_get(struct device *dev, int num_clks,
836 struct clk_bulk_data *clks)
841 static inline int __must_check clk_bulk_get_optional(struct device *dev,
842 int num_clks, struct clk_bulk_data *clks)
847 static inline int __must_check clk_bulk_get_all(struct device *dev,
848 struct clk_bulk_data **clks)
853 static inline struct clk *devm_clk_get(struct device *dev, const char *id)
858 static inline struct clk *devm_clk_get_prepared(struct device *dev,
864 static inline struct clk *devm_clk_get_enabled(struct device *dev,
870 static inline struct clk *devm_clk_get_optional(struct device *dev,
876 static inline struct clk *devm_clk_get_optional_prepared(struct device *dev,
882 static inline struct clk *devm_clk_get_optional_enabled(struct device *dev,
888 static inline int __must_check devm_clk_bulk_get(struct device *dev, int num_clks,
889 struct clk_bulk_data *clks)
894 static inline int __must_check devm_clk_bulk_get_optional(struct device *dev,
895 int num_clks, struct clk_bulk_data *clks)
900 static inline int __must_check devm_clk_bulk_get_all(struct device *dev,
901 struct clk_bulk_data **clks)
907 static inline struct clk *devm_get_clk_from_child(struct device *dev,
908 struct device_node *np, const char *con_id)
913 static inline void clk_put(struct clk *clk) {}
915 static inline void clk_bulk_put(int num_clks, struct clk_bulk_data *clks) {}
917 static inline void clk_bulk_put_all(int num_clks, struct clk_bulk_data *clks) {}
919 static inline void devm_clk_put(struct device *dev, struct clk *clk) {}
922 static inline int clk_rate_exclusive_get(struct clk *clk)
927 static inline void clk_rate_exclusive_put(struct clk *clk) {}
929 static inline int clk_enable(struct clk *clk)
934 static inline int __must_check clk_bulk_enable(int num_clks,
935 const struct clk_bulk_data *clks)
940 static inline void clk_disable(struct clk *clk) {}
943 static inline void clk_bulk_disable(int num_clks,
944 const struct clk_bulk_data *clks) {}
946 static inline unsigned long clk_get_rate(struct clk *clk)
951 static inline int clk_set_rate(struct clk *clk, unsigned long rate)
956 static inline int clk_set_rate_exclusive(struct clk *clk, unsigned long rate)
961 static inline long clk_round_rate(struct clk *clk, unsigned long rate)
966 static inline bool clk_has_parent(struct clk *clk, struct clk *parent)
971 static inline int clk_set_rate_range(struct clk *clk, unsigned long min,
977 static inline int clk_set_min_rate(struct clk *clk, unsigned long rate)
982 static inline int clk_set_max_rate(struct clk *clk, unsigned long rate)
987 static inline int clk_set_parent(struct clk *clk, struct clk *parent)
992 static inline struct clk *clk_get_parent(struct clk *clk)
997 static inline struct clk *clk_get_sys(const char *dev_id, const char *con_id)
1002 static inline int clk_save_context(void)
1007 static inline void clk_restore_context(void) {}
1011 /* clk_prepare_enable helps cases using clk_enable in non-atomic context. */
1012 static inline int clk_prepare_enable(struct clk *clk)
1016 ret = clk_prepare(clk);
1019 ret = clk_enable(clk);
1026 /* clk_disable_unprepare helps cases using clk_disable in non-atomic context. */
1027 static inline void clk_disable_unprepare(struct clk *clk)
1033 static inline int __must_check
1034 clk_bulk_prepare_enable(int num_clks, const struct clk_bulk_data *clks)
1038 ret = clk_bulk_prepare(num_clks, clks);
1041 ret = clk_bulk_enable(num_clks, clks);
1043 clk_bulk_unprepare(num_clks, clks);
1048 static inline void clk_bulk_disable_unprepare(int num_clks,
1049 const struct clk_bulk_data *clks)
1051 clk_bulk_disable(num_clks, clks);
1052 clk_bulk_unprepare(num_clks, clks);
1056 * clk_get_optional - lookup and obtain a reference to an optional clock
1058 * @dev: device for clock "consumer"
1059 * @id: clock consumer ID
1061 * Behaves the same as clk_get() except where there is no clock producer. In
1062 * this case, instead of returning -ENOENT, the function returns NULL.
1064 static inline struct clk *clk_get_optional(struct device *dev, const char *id)
1066 struct clk *clk = clk_get(dev, id);
1068 if (clk == ERR_PTR(-ENOENT))
1074 #if defined(CONFIG_OF) && defined(CONFIG_COMMON_CLK)
1075 struct clk *of_clk_get(struct device_node *np, int index);
1076 struct clk *of_clk_get_by_name(struct device_node *np, const char *name);
1077 struct clk *of_clk_get_from_provider(struct of_phandle_args *clkspec);
1079 static inline struct clk *of_clk_get(struct device_node *np, int index)
1081 return ERR_PTR(-ENOENT);
1083 static inline struct clk *of_clk_get_by_name(struct device_node *np,
1086 return ERR_PTR(-ENOENT);
1088 static inline struct clk *of_clk_get_from_provider(struct of_phandle_args *clkspec)
1090 return ERR_PTR(-ENOENT);