xref: /openbmc/linux/include/linux/clk.h (revision 616e45df7c4aa71279c07cc803a1d51f43f89f37)
1f8ce2547SRussell King /*
2f8ce2547SRussell King  *  linux/include/linux/clk.h
3f8ce2547SRussell King  *
4f8ce2547SRussell King  *  Copyright (C) 2004 ARM Limited.
5f8ce2547SRussell King  *  Written by Deep Blue Solutions Limited.
6b2476490SMike Turquette  *  Copyright (C) 2011-2012 Linaro Ltd <mturquette@linaro.org>
7f8ce2547SRussell King  *
8f8ce2547SRussell King  * This program is free software; you can redistribute it and/or modify
9f8ce2547SRussell King  * it under the terms of the GNU General Public License version 2 as
10f8ce2547SRussell King  * published by the Free Software Foundation.
11f8ce2547SRussell King  */
12686f8c5dSTodd Poynor #ifndef __LINUX_CLK_H
13686f8c5dSTodd Poynor #define __LINUX_CLK_H
14f8ce2547SRussell King 
159f1612d3SShawn Guo #include <linux/err.h>
1640d3e0f4SRussell King #include <linux/kernel.h>
17b2476490SMike Turquette #include <linux/notifier.h>
1840d3e0f4SRussell King 
19f8ce2547SRussell King struct device;
20f8ce2547SRussell King struct clk;
2171a2f115SKuninori Morimoto struct device_node;
2271a2f115SKuninori Morimoto struct of_phandle_args;
23f8ce2547SRussell King 
24b2476490SMike Turquette /**
25b2476490SMike Turquette  * DOC: clk notifier callback types
26b2476490SMike Turquette  *
27b2476490SMike Turquette  * PRE_RATE_CHANGE - called immediately before the clk rate is changed,
28b2476490SMike Turquette  *     to indicate that the rate change will proceed.  Drivers must
29b2476490SMike Turquette  *     immediately terminate any operations that will be affected by the
30fb72a059SSoren Brinkmann  *     rate change.  Callbacks may either return NOTIFY_DONE, NOTIFY_OK,
31fb72a059SSoren Brinkmann  *     NOTIFY_STOP or NOTIFY_BAD.
32b2476490SMike Turquette  *
33b2476490SMike Turquette  * ABORT_RATE_CHANGE: called if the rate change failed for some reason
34b2476490SMike Turquette  *     after PRE_RATE_CHANGE.  In this case, all registered notifiers on
35b2476490SMike Turquette  *     the clk will be called with ABORT_RATE_CHANGE. Callbacks must
36fb72a059SSoren Brinkmann  *     always return NOTIFY_DONE or NOTIFY_OK.
37b2476490SMike Turquette  *
38b2476490SMike Turquette  * POST_RATE_CHANGE - called after the clk rate change has successfully
39fb72a059SSoren Brinkmann  *     completed.  Callbacks must always return NOTIFY_DONE or NOTIFY_OK.
40b2476490SMike Turquette  *
41b2476490SMike Turquette  */
42b2476490SMike Turquette #define PRE_RATE_CHANGE			BIT(0)
43b2476490SMike Turquette #define POST_RATE_CHANGE		BIT(1)
44b2476490SMike Turquette #define ABORT_RATE_CHANGE		BIT(2)
45b2476490SMike Turquette 
46b2476490SMike Turquette /**
47b2476490SMike Turquette  * struct clk_notifier - associate a clk with a notifier
48b2476490SMike Turquette  * @clk: struct clk * to associate the notifier with
49b2476490SMike Turquette  * @notifier_head: a blocking_notifier_head for this clk
50b2476490SMike Turquette  * @node: linked list pointers
51b2476490SMike Turquette  *
52b2476490SMike Turquette  * A list of struct clk_notifier is maintained by the notifier code.
53b2476490SMike Turquette  * An entry is created whenever code registers the first notifier on a
54b2476490SMike Turquette  * particular @clk.  Future notifiers on that @clk are added to the
55b2476490SMike Turquette  * @notifier_head.
56b2476490SMike Turquette  */
57b2476490SMike Turquette struct clk_notifier {
58b2476490SMike Turquette 	struct clk			*clk;
59b2476490SMike Turquette 	struct srcu_notifier_head	notifier_head;
60b2476490SMike Turquette 	struct list_head		node;
61b2476490SMike Turquette };
62b2476490SMike Turquette 
63b2476490SMike Turquette /**
64b2476490SMike Turquette  * struct clk_notifier_data - rate data to pass to the notifier callback
65b2476490SMike Turquette  * @clk: struct clk * being changed
66b2476490SMike Turquette  * @old_rate: previous rate of this clk
67b2476490SMike Turquette  * @new_rate: new rate of this clk
68b2476490SMike Turquette  *
69b2476490SMike Turquette  * For a pre-notifier, old_rate is the clk's rate before this rate
70b2476490SMike Turquette  * change, and new_rate is what the rate will be in the future.  For a
71b2476490SMike Turquette  * post-notifier, old_rate and new_rate are both set to the clk's
72b2476490SMike Turquette  * current rate (this was done to optimize the implementation).
73b2476490SMike Turquette  */
74b2476490SMike Turquette struct clk_notifier_data {
75b2476490SMike Turquette 	struct clk		*clk;
76b2476490SMike Turquette 	unsigned long		old_rate;
77b2476490SMike Turquette 	unsigned long		new_rate;
78b2476490SMike Turquette };
79b2476490SMike Turquette 
80266e4e9dSDong Aisheng /**
81266e4e9dSDong Aisheng  * struct clk_bulk_data - Data used for bulk clk operations.
82266e4e9dSDong Aisheng  *
83266e4e9dSDong Aisheng  * @id: clock consumer ID
84266e4e9dSDong Aisheng  * @clk: struct clk * to store the associated clock
85266e4e9dSDong Aisheng  *
86266e4e9dSDong Aisheng  * The CLK APIs provide a series of clk_bulk_() API calls as
87266e4e9dSDong Aisheng  * a convenience to consumers which require multiple clks.  This
88266e4e9dSDong Aisheng  * structure is used to manage data for these calls.
89266e4e9dSDong Aisheng  */
90266e4e9dSDong Aisheng struct clk_bulk_data {
91266e4e9dSDong Aisheng 	const char		*id;
92266e4e9dSDong Aisheng 	struct clk		*clk;
93266e4e9dSDong Aisheng };
94266e4e9dSDong Aisheng 
95e81b87d2SKrzysztof Kozlowski #ifdef CONFIG_COMMON_CLK
96e81b87d2SKrzysztof Kozlowski 
9786bcfa2eSMike Turquette /**
9886bcfa2eSMike Turquette  * clk_notifier_register: register a clock rate-change notifier callback
9986bcfa2eSMike Turquette  * @clk: clock whose rate we are interested in
10086bcfa2eSMike Turquette  * @nb: notifier block with callback function pointer
10186bcfa2eSMike Turquette  *
10286bcfa2eSMike Turquette  * ProTip: debugging across notifier chains can be frustrating. Make sure that
10386bcfa2eSMike Turquette  * your notifier callback function prints a nice big warning in case of
10486bcfa2eSMike Turquette  * failure.
10586bcfa2eSMike Turquette  */
106b2476490SMike Turquette int clk_notifier_register(struct clk *clk, struct notifier_block *nb);
107b2476490SMike Turquette 
10886bcfa2eSMike Turquette /**
10986bcfa2eSMike Turquette  * clk_notifier_unregister: unregister a clock rate-change notifier callback
11086bcfa2eSMike Turquette  * @clk: clock whose rate we are no longer interested in
11186bcfa2eSMike Turquette  * @nb: notifier block which will be unregistered
11286bcfa2eSMike Turquette  */
113b2476490SMike Turquette int clk_notifier_unregister(struct clk *clk, struct notifier_block *nb);
114b2476490SMike Turquette 
1155279fc40SBoris BREZILLON /**
1165279fc40SBoris BREZILLON  * clk_get_accuracy - obtain the clock accuracy in ppb (parts per billion)
1175279fc40SBoris BREZILLON  *		      for a clock source.
1185279fc40SBoris BREZILLON  * @clk: clock source
1195279fc40SBoris BREZILLON  *
1205279fc40SBoris BREZILLON  * This gets the clock source accuracy expressed in ppb.
1215279fc40SBoris BREZILLON  * A perfect clock returns 0.
1225279fc40SBoris BREZILLON  */
1235279fc40SBoris BREZILLON long clk_get_accuracy(struct clk *clk);
1245279fc40SBoris BREZILLON 
125e59c5371SMike Turquette /**
126e59c5371SMike Turquette  * clk_set_phase - adjust the phase shift of a clock signal
127e59c5371SMike Turquette  * @clk: clock signal source
128e59c5371SMike Turquette  * @degrees: number of degrees the signal is shifted
129e59c5371SMike Turquette  *
130e59c5371SMike Turquette  * Shifts the phase of a clock signal by the specified degrees. Returns 0 on
131e59c5371SMike Turquette  * success, -EERROR otherwise.
132e59c5371SMike Turquette  */
133e59c5371SMike Turquette int clk_set_phase(struct clk *clk, int degrees);
134e59c5371SMike Turquette 
135e59c5371SMike Turquette /**
136e59c5371SMike Turquette  * clk_get_phase - return the phase shift of a clock signal
137e59c5371SMike Turquette  * @clk: clock signal source
138e59c5371SMike Turquette  *
139e59c5371SMike Turquette  * Returns the phase shift of a clock node in degrees, otherwise returns
140e59c5371SMike Turquette  * -EERROR.
141e59c5371SMike Turquette  */
142e59c5371SMike Turquette int clk_get_phase(struct clk *clk);
143e59c5371SMike Turquette 
1443d3801efSMichael Turquette /**
1459fba738aSJerome Brunet  * clk_set_duty_cycle - adjust the duty cycle ratio of a clock signal
1469fba738aSJerome Brunet  * @clk: clock signal source
1479fba738aSJerome Brunet  * @num: numerator of the duty cycle ratio to be applied
1489fba738aSJerome Brunet  * @den: denominator of the duty cycle ratio to be applied
1499fba738aSJerome Brunet  *
1509fba738aSJerome Brunet  * Adjust the duty cycle of a clock signal by the specified ratio. Returns 0 on
1519fba738aSJerome Brunet  * success, -EERROR otherwise.
1529fba738aSJerome Brunet  */
1539fba738aSJerome Brunet int clk_set_duty_cycle(struct clk *clk, unsigned int num, unsigned int den);
1549fba738aSJerome Brunet 
1559fba738aSJerome Brunet /**
1569fba738aSJerome Brunet  * clk_get_duty_cycle - return the duty cycle ratio of a clock signal
1579fba738aSJerome Brunet  * @clk: clock signal source
1589fba738aSJerome Brunet  * @scale: scaling factor to be applied to represent the ratio as an integer
1599fba738aSJerome Brunet  *
1609fba738aSJerome Brunet  * Returns the duty cycle ratio multiplied by the scale provided, otherwise
1619fba738aSJerome Brunet  * returns -EERROR.
1629fba738aSJerome Brunet  */
1639fba738aSJerome Brunet int clk_get_scaled_duty_cycle(struct clk *clk, unsigned int scale);
1649fba738aSJerome Brunet 
1659fba738aSJerome Brunet /**
1663d3801efSMichael Turquette  * clk_is_match - check if two clk's point to the same hardware clock
1673d3801efSMichael Turquette  * @p: clk compared against q
1683d3801efSMichael Turquette  * @q: clk compared against p
1693d3801efSMichael Turquette  *
1703d3801efSMichael Turquette  * Returns true if the two struct clk pointers both point to the same hardware
1710e056eb5Smchehab@s-opensource.com  * clock node. Put differently, returns true if @p and @q
1720e056eb5Smchehab@s-opensource.com  * share the same &struct clk_core object.
1733d3801efSMichael Turquette  *
1743d3801efSMichael Turquette  * Returns false otherwise. Note that two NULL clks are treated as matching.
1753d3801efSMichael Turquette  */
1763d3801efSMichael Turquette bool clk_is_match(const struct clk *p, const struct clk *q);
1773d3801efSMichael Turquette 
1785279fc40SBoris BREZILLON #else
1795279fc40SBoris BREZILLON 
180e81b87d2SKrzysztof Kozlowski static inline int clk_notifier_register(struct clk *clk,
181e81b87d2SKrzysztof Kozlowski 					struct notifier_block *nb)
182e81b87d2SKrzysztof Kozlowski {
183e81b87d2SKrzysztof Kozlowski 	return -ENOTSUPP;
184e81b87d2SKrzysztof Kozlowski }
185e81b87d2SKrzysztof Kozlowski 
186e81b87d2SKrzysztof Kozlowski static inline int clk_notifier_unregister(struct clk *clk,
187e81b87d2SKrzysztof Kozlowski 					  struct notifier_block *nb)
188e81b87d2SKrzysztof Kozlowski {
189e81b87d2SKrzysztof Kozlowski 	return -ENOTSUPP;
190e81b87d2SKrzysztof Kozlowski }
191e81b87d2SKrzysztof Kozlowski 
1925279fc40SBoris BREZILLON static inline long clk_get_accuracy(struct clk *clk)
1935279fc40SBoris BREZILLON {
1945279fc40SBoris BREZILLON 	return -ENOTSUPP;
1955279fc40SBoris BREZILLON }
1965279fc40SBoris BREZILLON 
197e59c5371SMike Turquette static inline long clk_set_phase(struct clk *clk, int phase)
198e59c5371SMike Turquette {
199e59c5371SMike Turquette 	return -ENOTSUPP;
200e59c5371SMike Turquette }
201e59c5371SMike Turquette 
202e59c5371SMike Turquette static inline long clk_get_phase(struct clk *clk)
203e59c5371SMike Turquette {
204e59c5371SMike Turquette 	return -ENOTSUPP;
205e59c5371SMike Turquette }
206e59c5371SMike Turquette 
2079fba738aSJerome Brunet static inline int clk_set_duty_cycle(struct clk *clk, unsigned int num,
2089fba738aSJerome Brunet 				     unsigned int den)
2099fba738aSJerome Brunet {
2109fba738aSJerome Brunet 	return -ENOTSUPP;
2119fba738aSJerome Brunet }
2129fba738aSJerome Brunet 
2139fba738aSJerome Brunet static inline unsigned int clk_get_scaled_duty_cycle(struct clk *clk,
2149fba738aSJerome Brunet 						     unsigned int scale)
2159fba738aSJerome Brunet {
2169fba738aSJerome Brunet 	return 0;
2179fba738aSJerome Brunet }
2189fba738aSJerome Brunet 
2193d3801efSMichael Turquette static inline bool clk_is_match(const struct clk *p, const struct clk *q)
2203d3801efSMichael Turquette {
2213d3801efSMichael Turquette 	return p == q;
2223d3801efSMichael Turquette }
2233d3801efSMichael Turquette 
2247e87aed9SMark Brown #endif
225b2476490SMike Turquette 
226f8ce2547SRussell King /**
22793abe8e4SViresh Kumar  * clk_prepare - prepare a clock source
22893abe8e4SViresh Kumar  * @clk: clock source
22993abe8e4SViresh Kumar  *
23093abe8e4SViresh Kumar  * This prepares the clock source for use.
23193abe8e4SViresh Kumar  *
23293abe8e4SViresh Kumar  * Must not be called from within atomic context.
23393abe8e4SViresh Kumar  */
23493abe8e4SViresh Kumar #ifdef CONFIG_HAVE_CLK_PREPARE
23593abe8e4SViresh Kumar int clk_prepare(struct clk *clk);
236266e4e9dSDong Aisheng int __must_check clk_bulk_prepare(int num_clks,
237266e4e9dSDong Aisheng 				  const struct clk_bulk_data *clks);
23893abe8e4SViresh Kumar #else
23993abe8e4SViresh Kumar static inline int clk_prepare(struct clk *clk)
24093abe8e4SViresh Kumar {
24193abe8e4SViresh Kumar 	might_sleep();
24293abe8e4SViresh Kumar 	return 0;
24393abe8e4SViresh Kumar }
244266e4e9dSDong Aisheng 
2456e0d4ff4SDong Aisheng static inline int __must_check clk_bulk_prepare(int num_clks, struct clk_bulk_data *clks)
246266e4e9dSDong Aisheng {
247266e4e9dSDong Aisheng 	might_sleep();
248266e4e9dSDong Aisheng 	return 0;
249266e4e9dSDong Aisheng }
25093abe8e4SViresh Kumar #endif
25193abe8e4SViresh Kumar 
25293abe8e4SViresh Kumar /**
25393abe8e4SViresh Kumar  * clk_unprepare - undo preparation of a clock source
25493abe8e4SViresh Kumar  * @clk: clock source
25593abe8e4SViresh Kumar  *
25693abe8e4SViresh Kumar  * This undoes a previously prepared clock.  The caller must balance
25793abe8e4SViresh Kumar  * the number of prepare and unprepare calls.
25893abe8e4SViresh Kumar  *
25993abe8e4SViresh Kumar  * Must not be called from within atomic context.
26093abe8e4SViresh Kumar  */
26193abe8e4SViresh Kumar #ifdef CONFIG_HAVE_CLK_PREPARE
26293abe8e4SViresh Kumar void clk_unprepare(struct clk *clk);
263266e4e9dSDong Aisheng void clk_bulk_unprepare(int num_clks, const struct clk_bulk_data *clks);
26493abe8e4SViresh Kumar #else
26593abe8e4SViresh Kumar static inline void clk_unprepare(struct clk *clk)
26693abe8e4SViresh Kumar {
26793abe8e4SViresh Kumar 	might_sleep();
26893abe8e4SViresh Kumar }
269266e4e9dSDong Aisheng static inline void clk_bulk_unprepare(int num_clks, struct clk_bulk_data *clks)
270266e4e9dSDong Aisheng {
271266e4e9dSDong Aisheng 	might_sleep();
272266e4e9dSDong Aisheng }
27393abe8e4SViresh Kumar #endif
27493abe8e4SViresh Kumar 
27593abe8e4SViresh Kumar #ifdef CONFIG_HAVE_CLK
27693abe8e4SViresh Kumar /**
277f8ce2547SRussell King  * clk_get - lookup and obtain a reference to a clock producer.
278f8ce2547SRussell King  * @dev: device for clock "consumer"
279a58b3a4aSJan-Simon Möller  * @id: clock consumer ID
280f8ce2547SRussell King  *
281f8ce2547SRussell King  * Returns a struct clk corresponding to the clock producer, or
282f8ce2547SRussell King  * valid IS_ERR() condition containing errno.  The implementation
283f8ce2547SRussell King  * uses @dev and @id to determine the clock consumer, and thereby
284f8ce2547SRussell King  * the clock producer.  (IOW, @id may be identical strings, but
285f8ce2547SRussell King  * clk_get may return different clock producers depending on @dev.)
286f8ce2547SRussell King  *
287f8ce2547SRussell King  * Drivers must assume that the clock source is not enabled.
288f7ad160bSAlex Raimondi  *
289f7ad160bSAlex Raimondi  * clk_get should not be called from within interrupt context.
290f8ce2547SRussell King  */
291f8ce2547SRussell King struct clk *clk_get(struct device *dev, const char *id);
292f8ce2547SRussell King 
293f8ce2547SRussell King /**
294266e4e9dSDong Aisheng  * clk_bulk_get - lookup and obtain a number of references to clock producer.
295266e4e9dSDong Aisheng  * @dev: device for clock "consumer"
296266e4e9dSDong Aisheng  * @num_clks: the number of clk_bulk_data
297266e4e9dSDong Aisheng  * @clks: the clk_bulk_data table of consumer
298266e4e9dSDong Aisheng  *
299266e4e9dSDong Aisheng  * This helper function allows drivers to get several clk consumers in one
300266e4e9dSDong Aisheng  * operation. If any of the clk cannot be acquired then any clks
301266e4e9dSDong Aisheng  * that were obtained will be freed before returning to the caller.
302266e4e9dSDong Aisheng  *
303266e4e9dSDong Aisheng  * Returns 0 if all clocks specified in clk_bulk_data table are obtained
304266e4e9dSDong Aisheng  * successfully, or valid IS_ERR() condition containing errno.
305266e4e9dSDong Aisheng  * The implementation uses @dev and @clk_bulk_data.id to determine the
306266e4e9dSDong Aisheng  * clock consumer, and thereby the clock producer.
307266e4e9dSDong Aisheng  * The clock returned is stored in each @clk_bulk_data.clk field.
308266e4e9dSDong Aisheng  *
309266e4e9dSDong Aisheng  * Drivers must assume that the clock source is not enabled.
310266e4e9dSDong Aisheng  *
311266e4e9dSDong Aisheng  * clk_bulk_get should not be called from within interrupt context.
312266e4e9dSDong Aisheng  */
313266e4e9dSDong Aisheng int __must_check clk_bulk_get(struct device *dev, int num_clks,
314266e4e9dSDong Aisheng 			      struct clk_bulk_data *clks);
315*616e45dfSDong Aisheng /**
316*616e45dfSDong Aisheng  * clk_bulk_get_all - lookup and obtain all available references to clock
317*616e45dfSDong Aisheng  *		      producer.
318*616e45dfSDong Aisheng  * @dev: device for clock "consumer"
319*616e45dfSDong Aisheng  * @clks: pointer to the clk_bulk_data table of consumer
320*616e45dfSDong Aisheng  *
321*616e45dfSDong Aisheng  * This helper function allows drivers to get all clk consumers in one
322*616e45dfSDong Aisheng  * operation. If any of the clk cannot be acquired then any clks
323*616e45dfSDong Aisheng  * that were obtained will be freed before returning to the caller.
324*616e45dfSDong Aisheng  *
325*616e45dfSDong Aisheng  * Returns a positive value for the number of clocks obtained while the
326*616e45dfSDong Aisheng  * clock references are stored in the clk_bulk_data table in @clks field.
327*616e45dfSDong Aisheng  * Returns 0 if there're none and a negative value if something failed.
328*616e45dfSDong Aisheng  *
329*616e45dfSDong Aisheng  * Drivers must assume that the clock source is not enabled.
330*616e45dfSDong Aisheng  *
331*616e45dfSDong Aisheng  * clk_bulk_get should not be called from within interrupt context.
332*616e45dfSDong Aisheng  */
333*616e45dfSDong Aisheng int __must_check clk_bulk_get_all(struct device *dev,
334*616e45dfSDong Aisheng 				  struct clk_bulk_data **clks);
335266e4e9dSDong Aisheng /**
336618aee02SDong Aisheng  * devm_clk_bulk_get - managed get multiple clk consumers
337618aee02SDong Aisheng  * @dev: device for clock "consumer"
338618aee02SDong Aisheng  * @num_clks: the number of clk_bulk_data
339618aee02SDong Aisheng  * @clks: the clk_bulk_data table of consumer
340618aee02SDong Aisheng  *
341618aee02SDong Aisheng  * Return 0 on success, an errno on failure.
342618aee02SDong Aisheng  *
343618aee02SDong Aisheng  * This helper function allows drivers to get several clk
344618aee02SDong Aisheng  * consumers in one operation with management, the clks will
345618aee02SDong Aisheng  * automatically be freed when the device is unbound.
346618aee02SDong Aisheng  */
347618aee02SDong Aisheng int __must_check devm_clk_bulk_get(struct device *dev, int num_clks,
348618aee02SDong Aisheng 				   struct clk_bulk_data *clks);
349618aee02SDong Aisheng 
350618aee02SDong Aisheng /**
351a8a97db9SMark Brown  * devm_clk_get - lookup and obtain a managed reference to a clock producer.
352a8a97db9SMark Brown  * @dev: device for clock "consumer"
353a58b3a4aSJan-Simon Möller  * @id: clock consumer ID
354a8a97db9SMark Brown  *
355a8a97db9SMark Brown  * Returns a struct clk corresponding to the clock producer, or
356a8a97db9SMark Brown  * valid IS_ERR() condition containing errno.  The implementation
357a8a97db9SMark Brown  * uses @dev and @id to determine the clock consumer, and thereby
358a8a97db9SMark Brown  * the clock producer.  (IOW, @id may be identical strings, but
359a8a97db9SMark Brown  * clk_get may return different clock producers depending on @dev.)
360a8a97db9SMark Brown  *
361a8a97db9SMark Brown  * Drivers must assume that the clock source is not enabled.
362a8a97db9SMark Brown  *
363a8a97db9SMark Brown  * devm_clk_get should not be called from within interrupt context.
364a8a97db9SMark Brown  *
365a8a97db9SMark Brown  * The clock will automatically be freed when the device is unbound
366a8a97db9SMark Brown  * from the bus.
367a8a97db9SMark Brown  */
368a8a97db9SMark Brown struct clk *devm_clk_get(struct device *dev, const char *id);
369a8a97db9SMark Brown 
370a8a97db9SMark Brown /**
37171a2f115SKuninori Morimoto  * devm_get_clk_from_child - lookup and obtain a managed reference to a
37271a2f115SKuninori Morimoto  *			     clock producer from child node.
37371a2f115SKuninori Morimoto  * @dev: device for clock "consumer"
37471a2f115SKuninori Morimoto  * @np: pointer to clock consumer node
37571a2f115SKuninori Morimoto  * @con_id: clock consumer ID
37671a2f115SKuninori Morimoto  *
37771a2f115SKuninori Morimoto  * This function parses the clocks, and uses them to look up the
37871a2f115SKuninori Morimoto  * struct clk from the registered list of clock providers by using
37971a2f115SKuninori Morimoto  * @np and @con_id
38071a2f115SKuninori Morimoto  *
38171a2f115SKuninori Morimoto  * The clock will automatically be freed when the device is unbound
38271a2f115SKuninori Morimoto  * from the bus.
38371a2f115SKuninori Morimoto  */
38471a2f115SKuninori Morimoto struct clk *devm_get_clk_from_child(struct device *dev,
38571a2f115SKuninori Morimoto 				    struct device_node *np, const char *con_id);
38655e9b8b7SJerome Brunet /**
38755e9b8b7SJerome Brunet  * clk_rate_exclusive_get - get exclusivity over the rate control of a
38855e9b8b7SJerome Brunet  *                          producer
38955e9b8b7SJerome Brunet  * @clk: clock source
39055e9b8b7SJerome Brunet  *
39155e9b8b7SJerome Brunet  * This function allows drivers to get exclusive control over the rate of a
39255e9b8b7SJerome Brunet  * provider. It prevents any other consumer to execute, even indirectly,
39355e9b8b7SJerome Brunet  * opereation which could alter the rate of the provider or cause glitches
39455e9b8b7SJerome Brunet  *
39555e9b8b7SJerome Brunet  * If exlusivity is claimed more than once on clock, even by the same driver,
39655e9b8b7SJerome Brunet  * the rate effectively gets locked as exclusivity can't be preempted.
39755e9b8b7SJerome Brunet  *
39855e9b8b7SJerome Brunet  * Must not be called from within atomic context.
39955e9b8b7SJerome Brunet  *
40055e9b8b7SJerome Brunet  * Returns success (0) or negative errno.
40155e9b8b7SJerome Brunet  */
40255e9b8b7SJerome Brunet int clk_rate_exclusive_get(struct clk *clk);
40355e9b8b7SJerome Brunet 
40455e9b8b7SJerome Brunet /**
40555e9b8b7SJerome Brunet  * clk_rate_exclusive_put - release exclusivity over the rate control of a
40655e9b8b7SJerome Brunet  *                          producer
40755e9b8b7SJerome Brunet  * @clk: clock source
40855e9b8b7SJerome Brunet  *
40955e9b8b7SJerome Brunet  * This function allows drivers to release the exclusivity it previously got
41055e9b8b7SJerome Brunet  * from clk_rate_exclusive_get()
41155e9b8b7SJerome Brunet  *
41255e9b8b7SJerome Brunet  * The caller must balance the number of clk_rate_exclusive_get() and
41355e9b8b7SJerome Brunet  * clk_rate_exclusive_put() calls.
41455e9b8b7SJerome Brunet  *
41555e9b8b7SJerome Brunet  * Must not be called from within atomic context.
41655e9b8b7SJerome Brunet  */
41755e9b8b7SJerome Brunet void clk_rate_exclusive_put(struct clk *clk);
41871a2f115SKuninori Morimoto 
41971a2f115SKuninori Morimoto /**
420f8ce2547SRussell King  * clk_enable - inform the system when the clock source should be running.
421f8ce2547SRussell King  * @clk: clock source
422f8ce2547SRussell King  *
423f8ce2547SRussell King  * If the clock can not be enabled/disabled, this should return success.
424f8ce2547SRussell King  *
42540d3e0f4SRussell King  * May be called from atomic contexts.
42640d3e0f4SRussell King  *
427f8ce2547SRussell King  * Returns success (0) or negative errno.
428f8ce2547SRussell King  */
429f8ce2547SRussell King int clk_enable(struct clk *clk);
430f8ce2547SRussell King 
431f8ce2547SRussell King /**
432266e4e9dSDong Aisheng  * clk_bulk_enable - inform the system when the set of clks should be running.
433266e4e9dSDong Aisheng  * @num_clks: the number of clk_bulk_data
434266e4e9dSDong Aisheng  * @clks: the clk_bulk_data table of consumer
435266e4e9dSDong Aisheng  *
436266e4e9dSDong Aisheng  * May be called from atomic contexts.
437266e4e9dSDong Aisheng  *
438266e4e9dSDong Aisheng  * Returns success (0) or negative errno.
439266e4e9dSDong Aisheng  */
440266e4e9dSDong Aisheng int __must_check clk_bulk_enable(int num_clks,
441266e4e9dSDong Aisheng 				 const struct clk_bulk_data *clks);
442266e4e9dSDong Aisheng 
443266e4e9dSDong Aisheng /**
444f8ce2547SRussell King  * clk_disable - inform the system when the clock source is no longer required.
445f8ce2547SRussell King  * @clk: clock source
446f8ce2547SRussell King  *
447f8ce2547SRussell King  * Inform the system that a clock source is no longer required by
448f8ce2547SRussell King  * a driver and may be shut down.
449f8ce2547SRussell King  *
45040d3e0f4SRussell King  * May be called from atomic contexts.
45140d3e0f4SRussell King  *
452f8ce2547SRussell King  * Implementation detail: if the clock source is shared between
453f8ce2547SRussell King  * multiple drivers, clk_enable() calls must be balanced by the
454f8ce2547SRussell King  * same number of clk_disable() calls for the clock source to be
455f8ce2547SRussell King  * disabled.
456f8ce2547SRussell King  */
457f8ce2547SRussell King void clk_disable(struct clk *clk);
458f8ce2547SRussell King 
459f8ce2547SRussell King /**
460266e4e9dSDong Aisheng  * clk_bulk_disable - inform the system when the set of clks is no
461266e4e9dSDong Aisheng  *		      longer required.
462266e4e9dSDong Aisheng  * @num_clks: the number of clk_bulk_data
463266e4e9dSDong Aisheng  * @clks: the clk_bulk_data table of consumer
464266e4e9dSDong Aisheng  *
465266e4e9dSDong Aisheng  * Inform the system that a set of clks is no longer required by
466266e4e9dSDong Aisheng  * a driver and may be shut down.
467266e4e9dSDong Aisheng  *
468266e4e9dSDong Aisheng  * May be called from atomic contexts.
469266e4e9dSDong Aisheng  *
470266e4e9dSDong Aisheng  * Implementation detail: if the set of clks is shared between
471266e4e9dSDong Aisheng  * multiple drivers, clk_bulk_enable() calls must be balanced by the
472266e4e9dSDong Aisheng  * same number of clk_bulk_disable() calls for the clock source to be
473266e4e9dSDong Aisheng  * disabled.
474266e4e9dSDong Aisheng  */
475266e4e9dSDong Aisheng void clk_bulk_disable(int num_clks, const struct clk_bulk_data *clks);
476266e4e9dSDong Aisheng 
477266e4e9dSDong Aisheng /**
478f8ce2547SRussell King  * clk_get_rate - obtain the current clock rate (in Hz) for a clock source.
479f8ce2547SRussell King  *		  This is only valid once the clock source has been enabled.
480f8ce2547SRussell King  * @clk: clock source
481f8ce2547SRussell King  */
482f8ce2547SRussell King unsigned long clk_get_rate(struct clk *clk);
483f8ce2547SRussell King 
484f8ce2547SRussell King /**
485f8ce2547SRussell King  * clk_put	- "free" the clock source
486f8ce2547SRussell King  * @clk: clock source
487f8ce2547SRussell King  *
488f8ce2547SRussell King  * Note: drivers must ensure that all clk_enable calls made on this
489f8ce2547SRussell King  * clock source are balanced by clk_disable calls prior to calling
490f8ce2547SRussell King  * this function.
491f7ad160bSAlex Raimondi  *
492f7ad160bSAlex Raimondi  * clk_put should not be called from within interrupt context.
493f8ce2547SRussell King  */
494f8ce2547SRussell King void clk_put(struct clk *clk);
495f8ce2547SRussell King 
496a8a97db9SMark Brown /**
497266e4e9dSDong Aisheng  * clk_bulk_put	- "free" the clock source
498266e4e9dSDong Aisheng  * @num_clks: the number of clk_bulk_data
499266e4e9dSDong Aisheng  * @clks: the clk_bulk_data table of consumer
500266e4e9dSDong Aisheng  *
501266e4e9dSDong Aisheng  * Note: drivers must ensure that all clk_bulk_enable calls made on this
502266e4e9dSDong Aisheng  * clock source are balanced by clk_bulk_disable calls prior to calling
503266e4e9dSDong Aisheng  * this function.
504266e4e9dSDong Aisheng  *
505266e4e9dSDong Aisheng  * clk_bulk_put should not be called from within interrupt context.
506266e4e9dSDong Aisheng  */
507266e4e9dSDong Aisheng void clk_bulk_put(int num_clks, struct clk_bulk_data *clks);
508266e4e9dSDong Aisheng 
509266e4e9dSDong Aisheng /**
510*616e45dfSDong Aisheng  * clk_bulk_put_all - "free" all the clock source
511*616e45dfSDong Aisheng  * @num_clks: the number of clk_bulk_data
512*616e45dfSDong Aisheng  * @clks: the clk_bulk_data table of consumer
513*616e45dfSDong Aisheng  *
514*616e45dfSDong Aisheng  * Note: drivers must ensure that all clk_bulk_enable calls made on this
515*616e45dfSDong Aisheng  * clock source are balanced by clk_bulk_disable calls prior to calling
516*616e45dfSDong Aisheng  * this function.
517*616e45dfSDong Aisheng  *
518*616e45dfSDong Aisheng  * clk_bulk_put_all should not be called from within interrupt context.
519*616e45dfSDong Aisheng  */
520*616e45dfSDong Aisheng void clk_bulk_put_all(int num_clks, struct clk_bulk_data *clks);
521*616e45dfSDong Aisheng 
522*616e45dfSDong Aisheng /**
523a8a97db9SMark Brown  * devm_clk_put	- "free" a managed clock source
524da3dae54SMasanari Iida  * @dev: device used to acquire the clock
525a8a97db9SMark Brown  * @clk: clock source acquired with devm_clk_get()
526a8a97db9SMark Brown  *
527a8a97db9SMark Brown  * Note: drivers must ensure that all clk_enable calls made on this
528a8a97db9SMark Brown  * clock source are balanced by clk_disable calls prior to calling
529a8a97db9SMark Brown  * this function.
530a8a97db9SMark Brown  *
531a8a97db9SMark Brown  * clk_put should not be called from within interrupt context.
532a8a97db9SMark Brown  */
533a8a97db9SMark Brown void devm_clk_put(struct device *dev, struct clk *clk);
534f8ce2547SRussell King 
535f8ce2547SRussell King /*
536f8ce2547SRussell King  * The remaining APIs are optional for machine class support.
537f8ce2547SRussell King  */
538f8ce2547SRussell King 
539f8ce2547SRussell King 
540f8ce2547SRussell King /**
541f8ce2547SRussell King  * clk_round_rate - adjust a rate to the exact rate a clock can provide
542f8ce2547SRussell King  * @clk: clock source
543f8ce2547SRussell King  * @rate: desired clock rate in Hz
544f8ce2547SRussell King  *
545d2d14a77SRussell King  * This answers the question "if I were to pass @rate to clk_set_rate(),
546d2d14a77SRussell King  * what clock rate would I end up with?" without changing the hardware
547d2d14a77SRussell King  * in any way.  In other words:
548d2d14a77SRussell King  *
549d2d14a77SRussell King  *   rate = clk_round_rate(clk, r);
550d2d14a77SRussell King  *
551d2d14a77SRussell King  * and:
552d2d14a77SRussell King  *
553d2d14a77SRussell King  *   clk_set_rate(clk, r);
554d2d14a77SRussell King  *   rate = clk_get_rate(clk);
555d2d14a77SRussell King  *
556d2d14a77SRussell King  * are equivalent except the former does not modify the clock hardware
557d2d14a77SRussell King  * in any way.
558d2d14a77SRussell King  *
559f8ce2547SRussell King  * Returns rounded clock rate in Hz, or negative errno.
560f8ce2547SRussell King  */
561f8ce2547SRussell King long clk_round_rate(struct clk *clk, unsigned long rate);
562f8ce2547SRussell King 
563f8ce2547SRussell King /**
564f8ce2547SRussell King  * clk_set_rate - set the clock rate for a clock source
565f8ce2547SRussell King  * @clk: clock source
566f8ce2547SRussell King  * @rate: desired clock rate in Hz
567f8ce2547SRussell King  *
568f8ce2547SRussell King  * Returns success (0) or negative errno.
569f8ce2547SRussell King  */
570f8ce2547SRussell King int clk_set_rate(struct clk *clk, unsigned long rate);
571f8ce2547SRussell King 
572f8ce2547SRussell King /**
57355e9b8b7SJerome Brunet  * clk_set_rate_exclusive- set the clock rate and claim exclusivity over
57455e9b8b7SJerome Brunet  *                         clock source
57555e9b8b7SJerome Brunet  * @clk: clock source
57655e9b8b7SJerome Brunet  * @rate: desired clock rate in Hz
57755e9b8b7SJerome Brunet  *
57855e9b8b7SJerome Brunet  * This helper function allows drivers to atomically set the rate of a producer
57955e9b8b7SJerome Brunet  * and claim exclusivity over the rate control of the producer.
58055e9b8b7SJerome Brunet  *
58155e9b8b7SJerome Brunet  * It is essentially a combination of clk_set_rate() and
58255e9b8b7SJerome Brunet  * clk_rate_exclusite_get(). Caller must balance this call with a call to
58355e9b8b7SJerome Brunet  * clk_rate_exclusive_put()
58455e9b8b7SJerome Brunet  *
58555e9b8b7SJerome Brunet  * Returns success (0) or negative errno.
58655e9b8b7SJerome Brunet  */
58755e9b8b7SJerome Brunet int clk_set_rate_exclusive(struct clk *clk, unsigned long rate);
58855e9b8b7SJerome Brunet 
58955e9b8b7SJerome Brunet /**
5904e88f3deSThierry Reding  * clk_has_parent - check if a clock is a possible parent for another
5914e88f3deSThierry Reding  * @clk: clock source
5924e88f3deSThierry Reding  * @parent: parent clock source
5934e88f3deSThierry Reding  *
5944e88f3deSThierry Reding  * This function can be used in drivers that need to check that a clock can be
5954e88f3deSThierry Reding  * the parent of another without actually changing the parent.
5964e88f3deSThierry Reding  *
5974e88f3deSThierry Reding  * Returns true if @parent is a possible parent for @clk, false otherwise.
5984e88f3deSThierry Reding  */
5994e88f3deSThierry Reding bool clk_has_parent(struct clk *clk, struct clk *parent);
6004e88f3deSThierry Reding 
6014e88f3deSThierry Reding /**
6021c8e6004STomeu Vizoso  * clk_set_rate_range - set a rate range for a clock source
6031c8e6004STomeu Vizoso  * @clk: clock source
6041c8e6004STomeu Vizoso  * @min: desired minimum clock rate in Hz, inclusive
6051c8e6004STomeu Vizoso  * @max: desired maximum clock rate in Hz, inclusive
6061c8e6004STomeu Vizoso  *
6071c8e6004STomeu Vizoso  * Returns success (0) or negative errno.
6081c8e6004STomeu Vizoso  */
6091c8e6004STomeu Vizoso int clk_set_rate_range(struct clk *clk, unsigned long min, unsigned long max);
6101c8e6004STomeu Vizoso 
6111c8e6004STomeu Vizoso /**
6121c8e6004STomeu Vizoso  * clk_set_min_rate - set a minimum clock rate for a clock source
6131c8e6004STomeu Vizoso  * @clk: clock source
6141c8e6004STomeu Vizoso  * @rate: desired minimum clock rate in Hz, inclusive
6151c8e6004STomeu Vizoso  *
6161c8e6004STomeu Vizoso  * Returns success (0) or negative errno.
6171c8e6004STomeu Vizoso  */
6181c8e6004STomeu Vizoso int clk_set_min_rate(struct clk *clk, unsigned long rate);
6191c8e6004STomeu Vizoso 
6201c8e6004STomeu Vizoso /**
6211c8e6004STomeu Vizoso  * clk_set_max_rate - set a maximum clock rate for a clock source
6221c8e6004STomeu Vizoso  * @clk: clock source
6231c8e6004STomeu Vizoso  * @rate: desired maximum clock rate in Hz, inclusive
6241c8e6004STomeu Vizoso  *
6251c8e6004STomeu Vizoso  * Returns success (0) or negative errno.
6261c8e6004STomeu Vizoso  */
6271c8e6004STomeu Vizoso int clk_set_max_rate(struct clk *clk, unsigned long rate);
6281c8e6004STomeu Vizoso 
6291c8e6004STomeu Vizoso /**
630f8ce2547SRussell King  * clk_set_parent - set the parent clock source for this clock
631f8ce2547SRussell King  * @clk: clock source
632f8ce2547SRussell King  * @parent: parent clock source
633f8ce2547SRussell King  *
634f8ce2547SRussell King  * Returns success (0) or negative errno.
635f8ce2547SRussell King  */
636f8ce2547SRussell King int clk_set_parent(struct clk *clk, struct clk *parent);
637f8ce2547SRussell King 
638f8ce2547SRussell King /**
639f8ce2547SRussell King  * clk_get_parent - get the parent clock source for this clock
640f8ce2547SRussell King  * @clk: clock source
641f8ce2547SRussell King  *
642f8ce2547SRussell King  * Returns struct clk corresponding to parent clock source, or
643f8ce2547SRussell King  * valid IS_ERR() condition containing errno.
644f8ce2547SRussell King  */
645f8ce2547SRussell King struct clk *clk_get_parent(struct clk *clk);
646f8ce2547SRussell King 
64705fd8e73SSascha Hauer /**
64805fd8e73SSascha Hauer  * clk_get_sys - get a clock based upon the device name
64905fd8e73SSascha Hauer  * @dev_id: device name
65005fd8e73SSascha Hauer  * @con_id: connection ID
65105fd8e73SSascha Hauer  *
65205fd8e73SSascha Hauer  * Returns a struct clk corresponding to the clock producer, or
65305fd8e73SSascha Hauer  * valid IS_ERR() condition containing errno.  The implementation
65405fd8e73SSascha Hauer  * uses @dev_id and @con_id to determine the clock consumer, and
65505fd8e73SSascha Hauer  * thereby the clock producer. In contrast to clk_get() this function
65605fd8e73SSascha Hauer  * takes the device name instead of the device itself for identification.
65705fd8e73SSascha Hauer  *
65805fd8e73SSascha Hauer  * Drivers must assume that the clock source is not enabled.
65905fd8e73SSascha Hauer  *
66005fd8e73SSascha Hauer  * clk_get_sys should not be called from within interrupt context.
66105fd8e73SSascha Hauer  */
66205fd8e73SSascha Hauer struct clk *clk_get_sys(const char *dev_id, const char *con_id);
66305fd8e73SSascha Hauer 
66493abe8e4SViresh Kumar #else /* !CONFIG_HAVE_CLK */
66593abe8e4SViresh Kumar 
66693abe8e4SViresh Kumar static inline struct clk *clk_get(struct device *dev, const char *id)
66793abe8e4SViresh Kumar {
66893abe8e4SViresh Kumar 	return NULL;
66993abe8e4SViresh Kumar }
67093abe8e4SViresh Kumar 
6716e0d4ff4SDong Aisheng static inline int __must_check clk_bulk_get(struct device *dev, int num_clks,
672266e4e9dSDong Aisheng 					    struct clk_bulk_data *clks)
673266e4e9dSDong Aisheng {
674266e4e9dSDong Aisheng 	return 0;
675266e4e9dSDong Aisheng }
676266e4e9dSDong Aisheng 
677*616e45dfSDong Aisheng static inline int __must_check clk_bulk_get_all(struct device *dev,
678*616e45dfSDong Aisheng 					 struct clk_bulk_data **clks)
679*616e45dfSDong Aisheng {
680*616e45dfSDong Aisheng 	return 0;
681*616e45dfSDong Aisheng }
682*616e45dfSDong Aisheng 
68393abe8e4SViresh Kumar static inline struct clk *devm_clk_get(struct device *dev, const char *id)
68493abe8e4SViresh Kumar {
68593abe8e4SViresh Kumar 	return NULL;
68693abe8e4SViresh Kumar }
68793abe8e4SViresh Kumar 
6886e0d4ff4SDong Aisheng static inline int __must_check devm_clk_bulk_get(struct device *dev, int num_clks,
689618aee02SDong Aisheng 						 struct clk_bulk_data *clks)
690618aee02SDong Aisheng {
691618aee02SDong Aisheng 	return 0;
692618aee02SDong Aisheng }
693618aee02SDong Aisheng 
69471a2f115SKuninori Morimoto static inline struct clk *devm_get_clk_from_child(struct device *dev,
69571a2f115SKuninori Morimoto 				struct device_node *np, const char *con_id)
69671a2f115SKuninori Morimoto {
69771a2f115SKuninori Morimoto 	return NULL;
69871a2f115SKuninori Morimoto }
69971a2f115SKuninori Morimoto 
70093abe8e4SViresh Kumar static inline void clk_put(struct clk *clk) {}
70193abe8e4SViresh Kumar 
702266e4e9dSDong Aisheng static inline void clk_bulk_put(int num_clks, struct clk_bulk_data *clks) {}
703266e4e9dSDong Aisheng 
704*616e45dfSDong Aisheng static inline void clk_bulk_put_all(int num_clks, struct clk_bulk_data *clks) {}
705*616e45dfSDong Aisheng 
70693abe8e4SViresh Kumar static inline void devm_clk_put(struct device *dev, struct clk *clk) {}
70793abe8e4SViresh Kumar 
70855e9b8b7SJerome Brunet 
70955e9b8b7SJerome Brunet static inline int clk_rate_exclusive_get(struct clk *clk)
71055e9b8b7SJerome Brunet {
71155e9b8b7SJerome Brunet 	return 0;
71255e9b8b7SJerome Brunet }
71355e9b8b7SJerome Brunet 
71455e9b8b7SJerome Brunet static inline void clk_rate_exclusive_put(struct clk *clk) {}
71555e9b8b7SJerome Brunet 
71693abe8e4SViresh Kumar static inline int clk_enable(struct clk *clk)
71793abe8e4SViresh Kumar {
71893abe8e4SViresh Kumar 	return 0;
71993abe8e4SViresh Kumar }
72093abe8e4SViresh Kumar 
7216e0d4ff4SDong Aisheng static inline int __must_check clk_bulk_enable(int num_clks, struct clk_bulk_data *clks)
722266e4e9dSDong Aisheng {
723266e4e9dSDong Aisheng 	return 0;
724266e4e9dSDong Aisheng }
725266e4e9dSDong Aisheng 
72693abe8e4SViresh Kumar static inline void clk_disable(struct clk *clk) {}
72793abe8e4SViresh Kumar 
728266e4e9dSDong Aisheng 
729266e4e9dSDong Aisheng static inline void clk_bulk_disable(int num_clks,
730266e4e9dSDong Aisheng 				    struct clk_bulk_data *clks) {}
731266e4e9dSDong Aisheng 
73293abe8e4SViresh Kumar static inline unsigned long clk_get_rate(struct clk *clk)
73393abe8e4SViresh Kumar {
73493abe8e4SViresh Kumar 	return 0;
73593abe8e4SViresh Kumar }
73693abe8e4SViresh Kumar 
73793abe8e4SViresh Kumar static inline int clk_set_rate(struct clk *clk, unsigned long rate)
73893abe8e4SViresh Kumar {
73993abe8e4SViresh Kumar 	return 0;
74093abe8e4SViresh Kumar }
74193abe8e4SViresh Kumar 
74255e9b8b7SJerome Brunet static inline int clk_set_rate_exclusive(struct clk *clk, unsigned long rate)
74355e9b8b7SJerome Brunet {
74455e9b8b7SJerome Brunet 	return 0;
74555e9b8b7SJerome Brunet }
74655e9b8b7SJerome Brunet 
74793abe8e4SViresh Kumar static inline long clk_round_rate(struct clk *clk, unsigned long rate)
74893abe8e4SViresh Kumar {
74993abe8e4SViresh Kumar 	return 0;
75093abe8e4SViresh Kumar }
75193abe8e4SViresh Kumar 
7524e88f3deSThierry Reding static inline bool clk_has_parent(struct clk *clk, struct clk *parent)
7534e88f3deSThierry Reding {
7544e88f3deSThierry Reding 	return true;
7554e88f3deSThierry Reding }
7564e88f3deSThierry Reding 
75793abe8e4SViresh Kumar static inline int clk_set_parent(struct clk *clk, struct clk *parent)
75893abe8e4SViresh Kumar {
75993abe8e4SViresh Kumar 	return 0;
76093abe8e4SViresh Kumar }
76193abe8e4SViresh Kumar 
76293abe8e4SViresh Kumar static inline struct clk *clk_get_parent(struct clk *clk)
76393abe8e4SViresh Kumar {
76493abe8e4SViresh Kumar 	return NULL;
76593abe8e4SViresh Kumar }
76693abe8e4SViresh Kumar 
767b81ea968SDaniel Lezcano static inline struct clk *clk_get_sys(const char *dev_id, const char *con_id)
768b81ea968SDaniel Lezcano {
769b81ea968SDaniel Lezcano 	return NULL;
770b81ea968SDaniel Lezcano }
77193abe8e4SViresh Kumar #endif
77293abe8e4SViresh Kumar 
77393abe8e4SViresh Kumar /* clk_prepare_enable helps cases using clk_enable in non-atomic context. */
77493abe8e4SViresh Kumar static inline int clk_prepare_enable(struct clk *clk)
77593abe8e4SViresh Kumar {
77693abe8e4SViresh Kumar 	int ret;
77793abe8e4SViresh Kumar 
77893abe8e4SViresh Kumar 	ret = clk_prepare(clk);
77993abe8e4SViresh Kumar 	if (ret)
78093abe8e4SViresh Kumar 		return ret;
78193abe8e4SViresh Kumar 	ret = clk_enable(clk);
78293abe8e4SViresh Kumar 	if (ret)
78393abe8e4SViresh Kumar 		clk_unprepare(clk);
78493abe8e4SViresh Kumar 
78593abe8e4SViresh Kumar 	return ret;
78693abe8e4SViresh Kumar }
78793abe8e4SViresh Kumar 
78893abe8e4SViresh Kumar /* clk_disable_unprepare helps cases using clk_disable in non-atomic context. */
78993abe8e4SViresh Kumar static inline void clk_disable_unprepare(struct clk *clk)
79093abe8e4SViresh Kumar {
79193abe8e4SViresh Kumar 	clk_disable(clk);
79293abe8e4SViresh Kumar 	clk_unprepare(clk);
79393abe8e4SViresh Kumar }
79493abe8e4SViresh Kumar 
7956e0d4ff4SDong Aisheng static inline int __must_check clk_bulk_prepare_enable(int num_clks,
7963c48d86cSBjorn Andersson 					struct clk_bulk_data *clks)
7973c48d86cSBjorn Andersson {
7983c48d86cSBjorn Andersson 	int ret;
7993c48d86cSBjorn Andersson 
8003c48d86cSBjorn Andersson 	ret = clk_bulk_prepare(num_clks, clks);
8013c48d86cSBjorn Andersson 	if (ret)
8023c48d86cSBjorn Andersson 		return ret;
8033c48d86cSBjorn Andersson 	ret = clk_bulk_enable(num_clks, clks);
8043c48d86cSBjorn Andersson 	if (ret)
8053c48d86cSBjorn Andersson 		clk_bulk_unprepare(num_clks, clks);
8063c48d86cSBjorn Andersson 
8073c48d86cSBjorn Andersson 	return ret;
8083c48d86cSBjorn Andersson }
8093c48d86cSBjorn Andersson 
8103c48d86cSBjorn Andersson static inline void clk_bulk_disable_unprepare(int num_clks,
8113c48d86cSBjorn Andersson 					      struct clk_bulk_data *clks)
8123c48d86cSBjorn Andersson {
8133c48d86cSBjorn Andersson 	clk_bulk_disable(num_clks, clks);
8143c48d86cSBjorn Andersson 	clk_bulk_unprepare(num_clks, clks);
8153c48d86cSBjorn Andersson }
8163c48d86cSBjorn Andersson 
817137f8a72SRob Herring #if defined(CONFIG_OF) && defined(CONFIG_COMMON_CLK)
818766e6a4eSGrant Likely struct clk *of_clk_get(struct device_node *np, int index);
819766e6a4eSGrant Likely struct clk *of_clk_get_by_name(struct device_node *np, const char *name);
820766e6a4eSGrant Likely struct clk *of_clk_get_from_provider(struct of_phandle_args *clkspec);
821766e6a4eSGrant Likely #else
822766e6a4eSGrant Likely static inline struct clk *of_clk_get(struct device_node *np, int index)
823766e6a4eSGrant Likely {
8249f1612d3SShawn Guo 	return ERR_PTR(-ENOENT);
825766e6a4eSGrant Likely }
826766e6a4eSGrant Likely static inline struct clk *of_clk_get_by_name(struct device_node *np,
827766e6a4eSGrant Likely 					     const char *name)
828766e6a4eSGrant Likely {
8299f1612d3SShawn Guo 	return ERR_PTR(-ENOENT);
830766e6a4eSGrant Likely }
831428c9de5SGeert Uytterhoeven static inline struct clk *of_clk_get_from_provider(struct of_phandle_args *clkspec)
832428c9de5SGeert Uytterhoeven {
833428c9de5SGeert Uytterhoeven 	return ERR_PTR(-ENOENT);
834428c9de5SGeert Uytterhoeven }
835766e6a4eSGrant Likely #endif
836766e6a4eSGrant Likely 
837f8ce2547SRussell King #endif
838