Lines Matching +full:clk +full:- +full:phase +full:-
1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * linux/include/linux/clk.h
7 * Copyright (C) 2011-2012 Linaro Ltd <mturquette@linaro.org>
17 struct clk;
22 * DOC: clk notifier callback types
24 * PRE_RATE_CHANGE - called immediately before the clk rate is changed,
32 * the clk will be called with ABORT_RATE_CHANGE. Callbacks must
35 * POST_RATE_CHANGE - called after the clk rate change has successfully
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
51 * particular @clk. Future notifiers on that @clk are added to the
55 struct clk *clk; member
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
68 * post-notifier, old_rate and new_rate are both set to the clk's
72 struct clk *clk; member
78 * struct clk_bulk_data - Data used for bulk clk operations.
81 * @clk: struct clk * to store the associated clock
83 * The CLK APIs provide a series of clk_bulk_() API calls as
89 struct clk *clk; member
95 * clk_notifier_register: register a clock rate-change notifier callback
96 * @clk: clock whose rate we are interested in
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
110 int clk_notifier_unregister(struct clk *clk, struct notifier_block *nb);
113 * devm_clk_notifier_register - register a managed rate-change notifier callback
115 * @clk: clock whose rate we are interested in
118 * Returns 0 on success, -EERROR otherwise
120 int devm_clk_notifier_register(struct device *dev, struct clk *clk,
124 * clk_get_accuracy - obtain the clock accuracy in ppb (parts per billion)
126 * @clk: clock source
131 long clk_get_accuracy(struct clk *clk);
134 * clk_set_phase - adjust the phase shift of a clock signal
135 * @clk: clock signal source
138 * Shifts the phase of a clock signal by the specified degrees. Returns 0 on
139 * success, -EERROR otherwise.
141 int clk_set_phase(struct clk *clk, int degrees);
144 * clk_get_phase - return the phase shift of a clock signal
145 * @clk: clock signal source
147 * Returns the phase shift of a clock node in degrees, otherwise returns
148 * -EERROR.
150 int clk_get_phase(struct clk *clk);
153 * clk_set_duty_cycle - adjust the duty cycle ratio of a clock signal
154 * @clk: clock signal source
159 * success, -EERROR otherwise.
161 int clk_set_duty_cycle(struct clk *clk, unsigned int num, unsigned int den);
164 * clk_get_duty_cycle - return the duty cycle ratio of a clock signal
165 * @clk: clock signal source
169 * returns -EERROR.
171 int clk_get_scaled_duty_cycle(struct clk *clk, unsigned int scale);
174 * clk_is_match - check if two clk's point to the same hardware clock
175 * @p: clk compared against q
176 * @q: clk compared against p
178 * Returns true if the two struct clk pointers both point to the same hardware
184 bool clk_is_match(const struct clk *p, const struct clk *q);
188 static inline int clk_notifier_register(struct clk *clk, in clk_notifier_register() argument
191 return -ENOTSUPP; in clk_notifier_register()
194 static inline int clk_notifier_unregister(struct clk *clk, in clk_notifier_unregister() argument
197 return -ENOTSUPP; in clk_notifier_unregister()
201 struct clk *clk, in devm_clk_notifier_register() argument
204 return -ENOTSUPP; in devm_clk_notifier_register()
207 static inline long clk_get_accuracy(struct clk *clk) in clk_get_accuracy() argument
209 return -ENOTSUPP; in clk_get_accuracy()
212 static inline long clk_set_phase(struct clk *clk, int phase) in clk_set_phase() argument
214 return -ENOTSUPP; in clk_set_phase()
217 static inline long clk_get_phase(struct clk *clk) in clk_get_phase() argument
219 return -ENOTSUPP; in clk_get_phase()
222 static inline int clk_set_duty_cycle(struct clk *clk, unsigned int num, in clk_set_duty_cycle() argument
225 return -ENOTSUPP; in clk_set_duty_cycle()
228 static inline unsigned int clk_get_scaled_duty_cycle(struct clk *clk, in clk_get_scaled_duty_cycle() argument
234 static inline bool clk_is_match(const struct clk *p, const struct clk *q) in clk_is_match()
242 * clk_prepare - prepare a clock source
243 * @clk: clock source
250 int clk_prepare(struct clk *clk);
254 static inline int clk_prepare(struct clk *clk) in clk_prepare() argument
269 * clk_unprepare - undo preparation of a clock source
270 * @clk: clock source
278 void clk_unprepare(struct clk *clk);
281 static inline void clk_unprepare(struct clk *clk) in clk_unprepare() argument
294 * clk_get - lookup and obtain a reference to a clock producer.
298 * Returns a struct clk corresponding to the clock producer, or
308 struct clk *clk_get(struct device *dev, const char *id);
311 * clk_bulk_get - lookup and obtain a number of references to clock producer.
316 * This helper function allows drivers to get several clk consumers in one
317 * operation. If any of the clk cannot be acquired then any clks
324 * The clock returned is stored in each @clk_bulk_data.clk field.
333 * clk_bulk_get_all - lookup and obtain all available references to clock
338 * This helper function allows drivers to get all clk consumers in one
339 * operation. If any of the clk cannot be acquired then any clks
354 * clk_bulk_get_optional - lookup and obtain a number of references to clock producer
360 * In this case, instead of returning -ENOENT, the function returns 0 and
361 * NULL for a clk for which a clock producer could not be determined.
366 * devm_clk_bulk_get - managed get multiple clk consumers
373 * This helper function allows drivers to get several clk
380 * devm_clk_bulk_get_optional - managed get multiple optional consumer clocks
386 * producer. In this case, instead of returning -ENOENT, the function returns
387 * NULL for given clk. It is assumed all clocks in clk_bulk_data are optional.
390 * successfully or for any clk there was no clk provider available, otherwise
394 * The clock returned is stored in each @clk_bulk_data.clk field.
403 * devm_clk_bulk_get_all - managed get multiple clk consumers
411 * This helper function allows drivers to get several clk
420 * devm_clk_get - lookup and obtain a managed reference to a clock producer.
424 * Returns a struct clk corresponding to the clock producer, or
437 struct clk *devm_clk_get(struct device *dev, const char *id);
440 * devm_clk_get_optional - lookup and obtain a managed reference to an optional
446 * In this case, instead of returning -ENOENT, the function returns NULL.
448 struct clk *devm_clk_get_optional(struct device *dev, const char *id);
451 * devm_get_clk_from_child - lookup and obtain a managed reference to a
458 * struct clk from the registered list of clock providers by using
464 struct clk *devm_get_clk_from_child(struct device *dev,
467 * clk_rate_exclusive_get - get exclusivity over the rate control of a
469 * @clk: clock source
482 int clk_rate_exclusive_get(struct clk *clk);
485 * clk_rate_exclusive_put - release exclusivity over the rate control of a
487 * @clk: clock source
497 void clk_rate_exclusive_put(struct clk *clk);
500 * clk_enable - inform the system when the clock source should be running.
501 * @clk: clock source
509 int clk_enable(struct clk *clk);
512 * clk_bulk_enable - inform the system when the set of clks should be running.
524 * clk_disable - inform the system when the clock source is no longer required.
525 * @clk: clock source
537 void clk_disable(struct clk *clk);
540 * clk_bulk_disable - inform the system when the set of clks is no
558 * clk_get_rate - obtain the current clock rate (in Hz) for a clock source.
560 * @clk: clock source
562 unsigned long clk_get_rate(struct clk *clk);
565 * clk_put - "free" the clock source
566 * @clk: clock source
574 void clk_put(struct clk *clk);
577 * clk_bulk_put - "free" the clock source
590 * clk_bulk_put_all - "free" all the clock source
603 * devm_clk_put - "free" a managed clock source
605 * @clk: clock source acquired with devm_clk_get()
613 void devm_clk_put(struct device *dev, struct clk *clk);
621 * clk_round_rate - adjust a rate to the exact rate a clock can provide
622 * @clk: clock source
629 * rate = clk_round_rate(clk, r);
633 * clk_set_rate(clk, r);
634 * rate = clk_get_rate(clk);
641 long clk_round_rate(struct clk *clk, unsigned long rate);
644 * clk_set_rate - set the clock rate for a clock source
645 * @clk: clock source
648 * Updating the rate starts at the top-most affected clock and then
649 * walks the tree down to the bottom-most clock that needs updating.
653 int clk_set_rate(struct clk *clk, unsigned long rate);
656 * clk_set_rate_exclusive- set the clock rate and claim exclusivity over
658 * @clk: clock source
670 int clk_set_rate_exclusive(struct clk *clk, unsigned long rate);
673 * clk_has_parent - check if a clock is a possible parent for another
674 * @clk: clock source
680 * Returns true if @parent is a possible parent for @clk, false otherwise.
682 bool clk_has_parent(struct clk *clk, struct clk *parent);
685 * clk_set_rate_range - set a rate range for a clock source
686 * @clk: clock source
692 int clk_set_rate_range(struct clk *clk, unsigned long min, unsigned long max);
695 * clk_set_min_rate - set a minimum clock rate for a clock source
696 * @clk: clock source
701 int clk_set_min_rate(struct clk *clk, unsigned long rate);
704 * clk_set_max_rate - set a maximum clock rate for a clock source
705 * @clk: clock source
710 int clk_set_max_rate(struct clk *clk, unsigned long rate);
713 * clk_set_parent - set the parent clock source for this clock
714 * @clk: clock source
719 int clk_set_parent(struct clk *clk, struct clk *parent);
722 * clk_get_parent - get the parent clock source for this clock
723 * @clk: clock source
725 * Returns struct clk corresponding to parent clock source, or
728 struct clk *clk_get_parent(struct clk *clk);
731 * clk_get_sys - get a clock based upon the device name
735 * Returns a struct clk corresponding to the clock producer, or
745 struct clk *clk_get_sys(const char *dev_id, const char *con_id);
748 * clk_save_context - save clock context for poweroff
757 * clk_restore_context - restore clock context after poweroff
766 static inline struct clk *clk_get(struct device *dev, const char *id) in clk_get()
789 static inline struct clk *devm_clk_get(struct device *dev, const char *id) in devm_clk_get()
794 static inline struct clk *devm_clk_get_optional(struct device *dev, in devm_clk_get_optional()
819 static inline struct clk *devm_get_clk_from_child(struct device *dev, in devm_get_clk_from_child()
825 static inline void clk_put(struct clk *clk) {} in clk_put() argument
831 static inline void devm_clk_put(struct device *dev, struct clk *clk) {} in devm_clk_put() argument
834 static inline int clk_rate_exclusive_get(struct clk *clk) in clk_rate_exclusive_get() argument
839 static inline void clk_rate_exclusive_put(struct clk *clk) {} in clk_rate_exclusive_put() argument
841 static inline int clk_enable(struct clk *clk) in clk_enable() argument
852 static inline void clk_disable(struct clk *clk) {} in clk_disable() argument
858 static inline unsigned long clk_get_rate(struct clk *clk) in clk_get_rate() argument
863 static inline int clk_set_rate(struct clk *clk, unsigned long rate) in clk_set_rate() argument
868 static inline int clk_set_rate_exclusive(struct clk *clk, unsigned long rate) in clk_set_rate_exclusive() argument
873 static inline long clk_round_rate(struct clk *clk, unsigned long rate) in clk_round_rate() argument
878 static inline bool clk_has_parent(struct clk *clk, struct clk *parent) in clk_has_parent() argument
883 static inline int clk_set_rate_range(struct clk *clk, unsigned long min, in clk_set_rate_range() argument
889 static inline int clk_set_min_rate(struct clk *clk, unsigned long rate) in clk_set_min_rate() argument
894 static inline int clk_set_max_rate(struct clk *clk, unsigned long rate) in clk_set_max_rate() argument
899 static inline int clk_set_parent(struct clk *clk, struct clk *parent) in clk_set_parent() argument
904 static inline struct clk *clk_get_parent(struct clk *clk) in clk_get_parent() argument
909 static inline struct clk *clk_get_sys(const char *dev_id, const char *con_id) in clk_get_sys()
923 /* clk_prepare_enable helps cases using clk_enable in non-atomic context. */
924 static inline int clk_prepare_enable(struct clk *clk) in clk_prepare_enable() argument
928 ret = clk_prepare(clk); in clk_prepare_enable()
931 ret = clk_enable(clk); in clk_prepare_enable()
933 clk_unprepare(clk); in clk_prepare_enable()
938 /* clk_disable_unprepare helps cases using clk_disable in non-atomic context. */
939 static inline void clk_disable_unprepare(struct clk *clk) in clk_disable_unprepare() argument
941 clk_disable(clk); in clk_disable_unprepare()
942 clk_unprepare(clk); in clk_disable_unprepare()
968 * clk_get_optional - lookup and obtain a reference to an optional clock
974 * this case, instead of returning -ENOENT, the function returns NULL.
976 static inline struct clk *clk_get_optional(struct device *dev, const char *id) in clk_get_optional()
978 struct clk *clk = clk_get(dev, id); in clk_get_optional() local
980 if (clk == ERR_PTR(-ENOENT)) in clk_get_optional()
983 return clk; in clk_get_optional()
987 struct clk *of_clk_get(struct device_node *np, int index);
988 struct clk *of_clk_get_by_name(struct device_node *np, const char *name);
989 struct clk *of_clk_get_from_provider(struct of_phandle_args *clkspec);
991 static inline struct clk *of_clk_get(struct device_node *np, int index) in of_clk_get()
993 return ERR_PTR(-ENOENT); in of_clk_get()
995 static inline struct clk *of_clk_get_by_name(struct device_node *np, in of_clk_get_by_name()
998 return ERR_PTR(-ENOENT); in of_clk_get_by_name()
1000 static inline struct clk *of_clk_get_from_provider(struct of_phandle_args *clkspec) in of_clk_get_from_provider()
1002 return ERR_PTR(-ENOENT); in of_clk_get_from_provider()