1 /* SPDX-License-Identifier: GPL-2.0-only */
7  *  Copyright (C) 2011-2012 Linaro Ltd <mturquette@linaro.org>
24  * PRE_RATE_CHANGE - called immediately before the clk rate is changed,
35  * POST_RATE_CHANGE - called after the clk rate change has successfully
44  * struct clk_notifier - associate a clk with a notifier
61  * struct clk_notifier_data - rate data to pass to the notifier callback
66  * For a pre-notifier, old_rate is the clk's rate before this rate
68  * post-notifier, old_rate and new_rate are both set to the clk's
78  * struct clk_bulk_data - Data used for bulk clk operations.
80  * @id: clock consumer ID
88 	const char		*id;  member
95  * clk_notifier_register - register a clock rate-change notifier callback
106  * clk_notifier_unregister - unregister a clock rate-change notifier callback
113  * devm_clk_notifier_register - register a managed rate-change notifier callback
118  * Returns 0 on success, -EERROR otherwise
124  * clk_get_accuracy - obtain the clock accuracy in ppb (parts per billion)
134  * clk_set_phase - adjust the phase shift of a clock signal
135  * @clk: clock signal source
136  * @degrees: number of degrees the signal is shifted
138  * Shifts the phase of a clock signal by the specified degrees. Returns 0 on
139  * success, -EERROR otherwise.
144  * clk_get_phase - return the phase shift of a clock signal
145  * @clk: clock signal source
148  * -EERROR.
153  * clk_set_duty_cycle - adjust the duty cycle ratio of a clock signal
154  * @clk: clock signal source
158  * Adjust the duty cycle of a clock signal by the specified ratio. Returns 0 on
159  * success, -EERROR otherwise.
164  * clk_get_scaled_duty_cycle - return the duty cycle ratio of a clock signal
165  * @clk: clock signal source
169  * returns -EERROR.
174  * clk_is_match - check if two clk's point to the same hardware clock
191 	return -ENOTSUPP;  in clk_notifier_register()
197 	return -ENOTSUPP;  in clk_notifier_unregister()
204 	return -ENOTSUPP;  in devm_clk_notifier_register()
209 	return -ENOTSUPP;  in clk_get_accuracy()
214 	return -ENOTSUPP;  in clk_set_phase()
219 	return -ENOTSUPP;  in clk_get_phase()
225 	return -ENOTSUPP;  in clk_set_duty_cycle()
243  * clk_prepare - prepare a clock source
255  * clk_is_enabled_when_prepared - indicate if preparing a clock also enables it.
259  * making clk_enable()/clk_disable() no-ops, false otherwise.
291  * clk_unprepare - undo preparation of a clock source
316  * clk_get - lookup and obtain a reference to a clock producer.
318  * @id: clock consumer ID
322  * uses @dev and @id to determine the clock consumer, and thereby
323  * the clock producer.  (IOW, @id may be identical strings, but
330 struct clk *clk_get(struct device *dev, const char *id);
333  * clk_bulk_get - lookup and obtain a number of references to clock producer.
344  * The implementation uses @dev and @clk_bulk_data.id to determine the
355  * clk_bulk_get_all - lookup and obtain all available references to clock
376  * clk_bulk_get_optional - lookup and obtain a number of references to clock producer
382  * In this case, instead of returning -ENOENT, the function returns 0 and
388  * devm_clk_bulk_get - managed get multiple clk consumers
402  * devm_clk_bulk_get_optional - managed get multiple optional consumer clocks
408  * producer.  In this case, instead of returning -ENOENT, the function returns
414  * The implementation uses @dev and @clk_bulk_data.id to determine the
425  * devm_clk_bulk_get_all - managed get multiple clk consumers
442  * devm_clk_get - lookup and obtain a managed reference to a clock producer.
444  * @id: clock consumer ID
450  * uses @dev and @id to determine the clock consumer, and thereby
451  * the clock producer.  (IOW, @id may be identical strings, but
460 struct clk *devm_clk_get(struct device *dev, const char *id);
463  * devm_clk_get_prepared - devm_clk_get() + clk_prepare()
465  * @id: clock consumer ID
471  * uses @dev and @id to determine the clock consumer, and thereby
472  * the clock producer.  (IOW, @id may be identical strings, but
481 struct clk *devm_clk_get_prepared(struct device *dev, const char *id);
484  * devm_clk_get_enabled - devm_clk_get() + clk_prepare_enable()
486  * @id: clock consumer ID
492  * uses @dev and @id to determine the clock consumer, and thereby
493  * the clock producer.  (IOW, @id may be identical strings, but
501 struct clk *devm_clk_get_enabled(struct device *dev, const char *id);
504  * devm_clk_get_optional - lookup and obtain a managed reference to an optional
507  * @id: clock consumer ID
513  * uses @dev and @id to determine the clock consumer, and thereby
524 struct clk *devm_clk_get_optional(struct device *dev, const char *id);
527  * devm_clk_get_optional_prepared - devm_clk_get_optional() + clk_prepare()
529  * @id: clock consumer ID
535  * uses @dev and @id to determine the clock consumer, and thereby
546 struct clk *devm_clk_get_optional_prepared(struct device *dev, const char *id);
549  * devm_clk_get_optional_enabled - devm_clk_get_optional() +
552  * @id: clock consumer ID
558  * uses @dev and @id to determine the clock consumer, and thereby
568 struct clk *devm_clk_get_optional_enabled(struct device *dev, const char *id);
571  * devm_get_clk_from_child - lookup and obtain a managed reference to a
575  * @con_id: clock consumer ID
587  * clk_rate_exclusive_get - get exclusivity over the rate control of a
605  * clk_rate_exclusive_put - release exclusivity over the rate control of a
620  * clk_enable - inform the system when the clock source should be running.
632  * clk_bulk_enable - inform the system when the set of clks should be running.
644  * clk_disable - inform the system when the clock source is no longer required.
660  * clk_bulk_disable - inform the system when the set of clks is no
678  * clk_get_rate - obtain the current clock rate (in Hz) for a clock source.
685  * clk_put	- "free" the clock source
697  * clk_bulk_put	- "free" the clock source
710  * clk_bulk_put_all - "free" all the clock source
723  * devm_clk_put	- "free" a managed clock source
741  * clk_round_rate - adjust a rate to the exact rate a clock can provide
764  * clk_set_rate - set the clock rate for a clock source
768  * Updating the rate starts at the top-most affected clock and then
769  * walks the tree down to the bottom-most clock that needs updating.
776  * clk_set_rate_exclusive- set the clock rate and claim exclusivity over
793  * clk_has_parent - check if a clock is a possible parent for another
805  * clk_set_rate_range - set a rate range for a clock source
815  * clk_set_min_rate - set a minimum clock rate for a clock source
824  * clk_set_max_rate - set a maximum clock rate for a clock source
833  * clk_set_parent - set the parent clock source for this clock
842  * clk_get_parent - get the parent clock source for this clock
851  * clk_get_sys - get a clock based upon the device name
853  * @con_id: connection ID
868  * clk_save_context - save clock context for poweroff
877  * clk_restore_context - restore clock context after poweroff
886 static inline struct clk *clk_get(struct device *dev, const char *id)  in clk_get()  argument
909 static inline struct clk *devm_clk_get(struct device *dev, const char *id)  in devm_clk_get()  argument
915 						const char *id)  in devm_clk_get_prepared()  argument
921 					       const char *id)  in devm_clk_get_enabled()  argument
927 						const char *id)  in devm_clk_get_optional()  argument
933 							 const char *id)  in devm_clk_get_optional_prepared()  argument
939 							const char *id)  in devm_clk_get_optional_enabled()  argument
1067 /* clk_prepare_enable helps cases using clk_enable in non-atomic context. */
1082 /* clk_disable_unprepare helps cases using clk_disable in non-atomic context. */
1112  * clk_drop_range - Reset any range set on that clock
1123  * clk_get_optional - lookup and obtain a reference to an optional clock
1126  * @id: clock consumer ID
1129  * this case, instead of returning -ENOENT, the function returns NULL.
1131 static inline struct clk *clk_get_optional(struct device *dev, const char *id)  in clk_get_optional()  argument
1133 	struct clk *clk = clk_get(dev, id);  in clk_get_optional()
1135 	if (clk == ERR_PTR(-ENOENT))  in clk_get_optional()
1148 	return ERR_PTR(-ENOENT);  in of_clk_get()
1153 	return ERR_PTR(-ENOENT);  in of_clk_get_by_name()
1157 	return ERR_PTR(-ENOENT);  in of_clk_get_from_provider()