2 * linux/include/linux/clk-provider.h
4 * Copyright (c) 2010-2011 Jeremy Kerr <jeremy.kerr@canonical.com>
5 * Copyright (C) 2011-2012 Linaro Ltd <mturquette@linaro.org>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
11 #ifndef __LINUX_CLK_PROVIDER_H
12 #define __LINUX_CLK_PROVIDER_H
17 #ifdef CONFIG_COMMON_CLK
20 * flags used across common struct clk. these flags should only affect the
21 * top-level framework. custom flags for dealing with hardware specifics
22 * belong in struct clk_foo
24 #define CLK_SET_RATE_GATE BIT(0) /* must be gated across rate change */
25 #define CLK_SET_PARENT_GATE BIT(1) /* must be gated across re-parent */
26 #define CLK_SET_RATE_PARENT BIT(2) /* propagate rate change up one level */
27 #define CLK_IGNORE_UNUSED BIT(3) /* do not gate even if unused */
28 #define CLK_IS_ROOT BIT(4) /* root clk, has no parent */
29 #define CLK_IS_BASIC BIT(5) /* Basic clk, can't do a to_clk_foo() */
30 #define CLK_GET_RATE_NOCACHE BIT(6) /* do not use the cached clk rate */
31 #define CLK_SET_RATE_NO_REPARENT BIT(7) /* don't re-parent on rate change */
32 #define CLK_GET_ACCURACY_NOCACHE BIT(8) /* do not use the cached clk accuracy */
33 #define CLK_RECALC_NEW_RATES BIT(9) /* recalc rates after notifications */
34 #define CLK_SET_RATE_UNGATE BIT(10) /* clock needs to run to set rate */
42 * struct clk_rate_request - Structure encoding the clk constraints that
43 * a clock user might require.
45 * @rate: Requested clock rate. This field will be adjusted by
46 * clock drivers according to hardware capabilities.
47 * @min_rate: Minimum rate imposed by clk users.
48 * @max_rate: Maximum rate imposed by clk users.
49 * @best_parent_rate: The best parent rate a parent can provide to fulfill the
50 * requested constraints.
51 * @best_parent_hw: The most appropriate parent clock that fulfills the
52 * requested constraints.
55 struct clk_rate_request
{
57 unsigned long min_rate
;
58 unsigned long max_rate
;
59 unsigned long best_parent_rate
;
60 struct clk_hw
*best_parent_hw
;
64 * struct clk_ops - Callback operations for hardware clocks; these are to
65 * be provided by the clock implementation, and will be called by drivers
66 * through the clk_* api.
68 * @prepare: Prepare the clock for enabling. This must not return until
69 * the clock is fully prepared, and it's safe to call clk_enable.
70 * This callback is intended to allow clock implementations to
71 * do any initialisation that may sleep. Called with
74 * @unprepare: Release the clock from its prepared state. This will typically
75 * undo any work done in the @prepare callback. Called with
78 * @is_prepared: Queries the hardware to determine if the clock is prepared.
79 * This function is allowed to sleep. Optional, if this op is not
80 * set then the prepare count will be used.
82 * @unprepare_unused: Unprepare the clock atomically. Only called from
83 * clk_disable_unused for prepare clocks with special needs.
84 * Called with prepare mutex held. This function may sleep.
86 * @enable: Enable the clock atomically. This must not return until the
87 * clock is generating a valid clock signal, usable by consumer
88 * devices. Called with enable_lock held. This function must not
91 * @disable: Disable the clock atomically. Called with enable_lock held.
92 * This function must not sleep.
94 * @is_enabled: Queries the hardware to determine if the clock is enabled.
95 * This function must not sleep. Optional, if this op is not
96 * set then the enable count will be used.
98 * @disable_unused: Disable the clock atomically. Only called from
99 * clk_disable_unused for gate clocks with special needs.
100 * Called with enable_lock held. This function must not
103 * @recalc_rate Recalculate the rate of this clock, by querying hardware. The
104 * parent rate is an input parameter. It is up to the caller to
105 * ensure that the prepare_mutex is held across this call.
106 * Returns the calculated rate. Optional, but recommended - if
107 * this op is not set then clock rate will be initialized to 0.
109 * @round_rate: Given a target rate as input, returns the closest rate actually
110 * supported by the clock. The parent rate is an input/output
113 * @determine_rate: Given a target rate as input, returns the closest rate
114 * actually supported by the clock, and optionally the parent clock
115 * that should be used to provide the clock rate.
117 * @set_parent: Change the input source of this clock; for clocks with multiple
118 * possible parents specify a new parent by passing in the index
119 * as a u8 corresponding to the parent in either the .parent_names
120 * or .parents arrays. This function in affect translates an
121 * array index into the value programmed into the hardware.
122 * Returns 0 on success, -EERROR otherwise.
124 * @get_parent: Queries the hardware to determine the parent of a clock. The
125 * return value is a u8 which specifies the index corresponding to
126 * the parent clock. This index can be applied to either the
127 * .parent_names or .parents arrays. In short, this function
128 * translates the parent value read from hardware into an array
129 * index. Currently only called when the clock is initialized by
130 * __clk_init. This callback is mandatory for clocks with
131 * multiple parents. It is optional (and unnecessary) for clocks
132 * with 0 or 1 parents.
134 * @set_rate: Change the rate of this clock. The requested rate is specified
135 * by the second argument, which should typically be the return
136 * of .round_rate call. The third argument gives the parent rate
137 * which is likely helpful for most .set_rate implementation.
138 * Returns 0 on success, -EERROR otherwise.
140 * @set_rate_and_parent: Change the rate and the parent of this clock. The
141 * requested rate is specified by the second argument, which
142 * should typically be the return of .round_rate call. The
143 * third argument gives the parent rate which is likely helpful
144 * for most .set_rate_and_parent implementation. The fourth
145 * argument gives the parent index. This callback is optional (and
146 * unnecessary) for clocks with 0 or 1 parents as well as
147 * for clocks that can tolerate switching the rate and the parent
148 * separately via calls to .set_parent and .set_rate.
149 * Returns 0 on success, -EERROR otherwise.
151 * @recalc_accuracy: Recalculate the accuracy of this clock. The clock accuracy
152 * is expressed in ppb (parts per billion). The parent accuracy is
153 * an input parameter.
154 * Returns the calculated accuracy. Optional - if this op is not
155 * set then clock accuracy will be initialized to parent accuracy
156 * or 0 (perfect clock) if clock has no parent.
158 * @get_phase: Queries the hardware to get the current phase of a clock.
159 * Returned values are 0-359 degrees on success, negative
160 * error codes on failure.
162 * @set_phase: Shift the phase this clock signal in degrees specified
163 * by the second argument. Valid values for degrees are
164 * 0-359. Return 0 on success, otherwise -EERROR.
166 * @init: Perform platform-specific initialization magic.
167 * This is not not used by any of the basic clock types.
168 * Please consider other ways of solving initialization problems
169 * before using this callback, as its use is discouraged.
171 * @debug_init: Set up type-specific debugfs entries for this clock. This
172 * is called once, after the debugfs directory entry for this
173 * clock has been created. The dentry pointer representing that
174 * directory is provided as an argument. Called with
175 * prepare_lock held. Returns 0 on success, -EERROR otherwise.
178 * The clk_enable/clk_disable and clk_prepare/clk_unprepare pairs allow
179 * implementations to split any work between atomic (enable) and sleepable
180 * (prepare) contexts. If enabling a clock requires code that might sleep,
181 * this must be done in clk_prepare. Clock enable code that will never be
182 * called in a sleepable context may be implemented in clk_enable.
184 * Typically, drivers will call clk_prepare when a clock may be needed later
185 * (eg. when a device is opened), and clk_enable when the clock is actually
186 * required (eg. from an interrupt). Note that clk_prepare MUST have been
187 * called before clk_enable.
190 int (*prepare
)(struct clk_hw
*hw
);
191 void (*unprepare
)(struct clk_hw
*hw
);
192 int (*is_prepared
)(struct clk_hw
*hw
);
193 void (*unprepare_unused
)(struct clk_hw
*hw
);
194 int (*enable
)(struct clk_hw
*hw
);
195 void (*disable
)(struct clk_hw
*hw
);
196 int (*is_enabled
)(struct clk_hw
*hw
);
197 void (*disable_unused
)(struct clk_hw
*hw
);
198 unsigned long (*recalc_rate
)(struct clk_hw
*hw
,
199 unsigned long parent_rate
);
200 long (*round_rate
)(struct clk_hw
*hw
, unsigned long rate
,
201 unsigned long *parent_rate
);
202 int (*determine_rate
)(struct clk_hw
*hw
,
203 struct clk_rate_request
*req
);
204 int (*set_parent
)(struct clk_hw
*hw
, u8 index
);
205 u8 (*get_parent
)(struct clk_hw
*hw
);
206 int (*set_rate
)(struct clk_hw
*hw
, unsigned long rate
,
207 unsigned long parent_rate
);
208 int (*set_rate_and_parent
)(struct clk_hw
*hw
,
210 unsigned long parent_rate
, u8 index
);
211 unsigned long (*recalc_accuracy
)(struct clk_hw
*hw
,
212 unsigned long parent_accuracy
);
213 int (*get_phase
)(struct clk_hw
*hw
);
214 int (*set_phase
)(struct clk_hw
*hw
, int degrees
);
215 void (*init
)(struct clk_hw
*hw
);
216 int (*debug_init
)(struct clk_hw
*hw
, struct dentry
*dentry
);
220 * struct clk_init_data - holds init data that's common to all clocks and is
221 * shared between the clock provider and the common clock framework.
224 * @ops: operations this clock supports
225 * @parent_names: array of string names for all possible parents
226 * @num_parents: number of possible parents
227 * @flags: framework-level hints and quirks
229 struct clk_init_data
{
231 const struct clk_ops
*ops
;
232 const char * const *parent_names
;
238 * struct clk_hw - handle for traversing from a struct clk to its corresponding
239 * hardware-specific structure. struct clk_hw should be declared within struct
240 * clk_foo and then referenced by the struct clk instance that uses struct
243 * @core: pointer to the struct clk_core instance that points back to this
244 * struct clk_hw instance
246 * @clk: pointer to the per-user struct clk instance that can be used to call
249 * @init: pointer to struct clk_init_data that contains the init data shared
250 * with the common clock framework.
253 struct clk_core
*core
;
255 const struct clk_init_data
*init
;
259 * DOC: Basic clock implementations common to many platforms
261 * Each basic clock hardware type is comprised of a structure describing the
262 * clock hardware, implementations of the relevant callbacks in struct clk_ops,
263 * unique flags for that hardware type, a registration function and an
264 * alternative macro for static initialization
268 * struct clk_fixed_rate - fixed-rate clock
269 * @hw: handle between common and hardware-specific interfaces
270 * @fixed_rate: constant frequency of clock
272 struct clk_fixed_rate
{
274 unsigned long fixed_rate
;
275 unsigned long fixed_accuracy
;
279 extern const struct clk_ops clk_fixed_rate_ops
;
280 struct clk
*clk_register_fixed_rate(struct device
*dev
, const char *name
,
281 const char *parent_name
, unsigned long flags
,
282 unsigned long fixed_rate
);
283 struct clk
*clk_register_fixed_rate_with_accuracy(struct device
*dev
,
284 const char *name
, const char *parent_name
, unsigned long flags
,
285 unsigned long fixed_rate
, unsigned long fixed_accuracy
);
287 void of_fixed_clk_setup(struct device_node
*np
);
290 * struct clk_gate - gating clock
292 * @hw: handle between common and hardware-specific interfaces
293 * @reg: register controlling gate
294 * @bit_idx: single bit controlling gate
295 * @flags: hardware-specific flags
296 * @lock: register lock
298 * Clock which can gate its output. Implements .enable & .disable
301 * CLK_GATE_SET_TO_DISABLE - by default this clock sets the bit at bit_idx to
302 * enable the clock. Setting this flag does the opposite: setting the bit
303 * disable the clock and clearing it enables the clock
304 * CLK_GATE_HIWORD_MASK - The gate settings are only in lower 16-bit
305 * of this register, and mask of gate bits are in higher 16-bit of this
306 * register. While setting the gate bits, higher 16-bit should also be
307 * updated to indicate changing gate bits.
317 #define CLK_GATE_SET_TO_DISABLE BIT(0)
318 #define CLK_GATE_HIWORD_MASK BIT(1)
320 extern const struct clk_ops clk_gate_ops
;
321 struct clk
*clk_register_gate(struct device
*dev
, const char *name
,
322 const char *parent_name
, unsigned long flags
,
323 void __iomem
*reg
, u8 bit_idx
,
324 u8 clk_gate_flags
, spinlock_t
*lock
);
325 void clk_unregister_gate(struct clk
*clk
);
327 struct clk_div_table
{
333 * struct clk_divider - adjustable divider clock
335 * @hw: handle between common and hardware-specific interfaces
336 * @reg: register containing the divider
337 * @shift: shift to the divider bit field
338 * @width: width of the divider bit field
339 * @table: array of value/divider pairs, last entry should have div = 0
340 * @lock: register lock
342 * Clock with an adjustable divider affecting its output frequency. Implements
343 * .recalc_rate, .set_rate and .round_rate
346 * CLK_DIVIDER_ONE_BASED - by default the divisor is the value read from the
347 * register plus one. If CLK_DIVIDER_ONE_BASED is set then the divider is
348 * the raw value read from the register, with the value of zero considered
349 * invalid, unless CLK_DIVIDER_ALLOW_ZERO is set.
350 * CLK_DIVIDER_POWER_OF_TWO - clock divisor is 2 raised to the value read from
351 * the hardware register
352 * CLK_DIVIDER_ALLOW_ZERO - Allow zero divisors. For dividers which have
353 * CLK_DIVIDER_ONE_BASED set, it is possible to end up with a zero divisor.
354 * Some hardware implementations gracefully handle this case and allow a
355 * zero divisor by not modifying their input clock
356 * (divide by one / bypass).
357 * CLK_DIVIDER_HIWORD_MASK - The divider settings are only in lower 16-bit
358 * of this register, and mask of divider bits are in higher 16-bit of this
359 * register. While setting the divider bits, higher 16-bit should also be
360 * updated to indicate changing divider bits.
361 * CLK_DIVIDER_ROUND_CLOSEST - Makes the best calculated divider to be rounded
362 * to the closest integer instead of the up one.
363 * CLK_DIVIDER_READ_ONLY - The divider settings are preconfigured and should
364 * not be changed by the clock framework.
365 * CLK_DIVIDER_MAX_AT_ZERO - For dividers which are like CLK_DIVIDER_ONE_BASED
366 * except when the value read from the register is zero, the divisor is
367 * 2^width of the field.
375 const struct clk_div_table
*table
;
379 #define CLK_DIVIDER_ONE_BASED BIT(0)
380 #define CLK_DIVIDER_POWER_OF_TWO BIT(1)
381 #define CLK_DIVIDER_ALLOW_ZERO BIT(2)
382 #define CLK_DIVIDER_HIWORD_MASK BIT(3)
383 #define CLK_DIVIDER_ROUND_CLOSEST BIT(4)
384 #define CLK_DIVIDER_READ_ONLY BIT(5)
385 #define CLK_DIVIDER_MAX_AT_ZERO BIT(6)
387 extern const struct clk_ops clk_divider_ops
;
389 unsigned long divider_recalc_rate(struct clk_hw
*hw
, unsigned long parent_rate
,
390 unsigned int val
, const struct clk_div_table
*table
,
391 unsigned long flags
);
392 long divider_round_rate(struct clk_hw
*hw
, unsigned long rate
,
393 unsigned long *prate
, const struct clk_div_table
*table
,
394 u8 width
, unsigned long flags
);
395 int divider_get_val(unsigned long rate
, unsigned long parent_rate
,
396 const struct clk_div_table
*table
, u8 width
,
397 unsigned long flags
);
399 struct clk
*clk_register_divider(struct device
*dev
, const char *name
,
400 const char *parent_name
, unsigned long flags
,
401 void __iomem
*reg
, u8 shift
, u8 width
,
402 u8 clk_divider_flags
, spinlock_t
*lock
);
403 struct clk
*clk_register_divider_table(struct device
*dev
, const char *name
,
404 const char *parent_name
, unsigned long flags
,
405 void __iomem
*reg
, u8 shift
, u8 width
,
406 u8 clk_divider_flags
, const struct clk_div_table
*table
,
408 void clk_unregister_divider(struct clk
*clk
);
411 * struct clk_mux - multiplexer clock
413 * @hw: handle between common and hardware-specific interfaces
414 * @reg: register controlling multiplexer
415 * @shift: shift to multiplexer bit field
416 * @width: width of mutliplexer bit field
417 * @flags: hardware-specific flags
418 * @lock: register lock
420 * Clock with multiple selectable parents. Implements .get_parent, .set_parent
424 * CLK_MUX_INDEX_ONE - register index starts at 1, not 0
425 * CLK_MUX_INDEX_BIT - register index is a single bit (power of two)
426 * CLK_MUX_HIWORD_MASK - The mux settings are only in lower 16-bit of this
427 * register, and mask of mux bits are in higher 16-bit of this register.
428 * While setting the mux bits, higher 16-bit should also be updated to
429 * indicate changing mux bits.
430 * CLK_MUX_ROUND_CLOSEST - Use the parent rate that is closest to the desired
443 #define CLK_MUX_INDEX_ONE BIT(0)
444 #define CLK_MUX_INDEX_BIT BIT(1)
445 #define CLK_MUX_HIWORD_MASK BIT(2)
446 #define CLK_MUX_READ_ONLY BIT(3) /* mux can't be changed */
447 #define CLK_MUX_ROUND_CLOSEST BIT(4)
449 extern const struct clk_ops clk_mux_ops
;
450 extern const struct clk_ops clk_mux_ro_ops
;
452 struct clk
*clk_register_mux(struct device
*dev
, const char *name
,
453 const char * const *parent_names
, u8 num_parents
,
455 void __iomem
*reg
, u8 shift
, u8 width
,
456 u8 clk_mux_flags
, spinlock_t
*lock
);
458 struct clk
*clk_register_mux_table(struct device
*dev
, const char *name
,
459 const char * const *parent_names
, u8 num_parents
,
461 void __iomem
*reg
, u8 shift
, u32 mask
,
462 u8 clk_mux_flags
, u32
*table
, spinlock_t
*lock
);
464 void clk_unregister_mux(struct clk
*clk
);
466 void of_fixed_factor_clk_setup(struct device_node
*node
);
469 * struct clk_fixed_factor - fixed multiplier and divider clock
471 * @hw: handle between common and hardware-specific interfaces
475 * Clock with a fixed multiplier and divider. The output frequency is the
476 * parent clock rate divided by div and multiplied by mult.
477 * Implements .recalc_rate, .set_rate and .round_rate
480 struct clk_fixed_factor
{
486 extern const struct clk_ops clk_fixed_factor_ops
;
487 struct clk
*clk_register_fixed_factor(struct device
*dev
, const char *name
,
488 const char *parent_name
, unsigned long flags
,
489 unsigned int mult
, unsigned int div
);
492 * struct clk_fractional_divider - adjustable fractional divider clock
494 * @hw: handle between common and hardware-specific interfaces
495 * @reg: register containing the divider
496 * @mshift: shift to the numerator bit field
497 * @mwidth: width of the numerator bit field
498 * @nshift: shift to the denominator bit field
499 * @nwidth: width of the denominator bit field
500 * @lock: register lock
502 * Clock with adjustable fractional divider affecting its output frequency.
504 struct clk_fractional_divider
{
517 extern const struct clk_ops clk_fractional_divider_ops
;
518 struct clk
*clk_register_fractional_divider(struct device
*dev
,
519 const char *name
, const char *parent_name
, unsigned long flags
,
520 void __iomem
*reg
, u8 mshift
, u8 mwidth
, u8 nshift
, u8 nwidth
,
521 u8 clk_divider_flags
, spinlock_t
*lock
);
524 * struct clk_multiplier - adjustable multiplier clock
526 * @hw: handle between common and hardware-specific interfaces
527 * @reg: register containing the multiplier
528 * @shift: shift to the multiplier bit field
529 * @width: width of the multiplier bit field
530 * @lock: register lock
532 * Clock with an adjustable multiplier affecting its output frequency.
533 * Implements .recalc_rate, .set_rate and .round_rate
536 * CLK_MULTIPLIER_ZERO_BYPASS - By default, the multiplier is the value read
537 * from the register, with 0 being a valid value effectively
538 * zeroing the output clock rate. If CLK_MULTIPLIER_ZERO_BYPASS is
539 * set, then a null multiplier will be considered as a bypass,
540 * leaving the parent rate unmodified.
541 * CLK_MULTIPLIER_ROUND_CLOSEST - Makes the best calculated divider to be
542 * rounded to the closest integer instead of the down one.
544 struct clk_multiplier
{
553 #define CLK_MULTIPLIER_ZERO_BYPASS BIT(0)
554 #define CLK_MULTIPLIER_ROUND_CLOSEST BIT(1)
556 extern const struct clk_ops clk_multiplier_ops
;
559 * struct clk_composite - aggregate clock of mux, divider and gate clocks
561 * @hw: handle between common and hardware-specific interfaces
562 * @mux_hw: handle between composite and hardware-specific mux clock
563 * @rate_hw: handle between composite and hardware-specific rate clock
564 * @gate_hw: handle between composite and hardware-specific gate clock
565 * @mux_ops: clock ops for mux
566 * @rate_ops: clock ops for rate
567 * @gate_ops: clock ops for gate
569 struct clk_composite
{
573 struct clk_hw
*mux_hw
;
574 struct clk_hw
*rate_hw
;
575 struct clk_hw
*gate_hw
;
577 const struct clk_ops
*mux_ops
;
578 const struct clk_ops
*rate_ops
;
579 const struct clk_ops
*gate_ops
;
582 struct clk
*clk_register_composite(struct device
*dev
, const char *name
,
583 const char * const *parent_names
, int num_parents
,
584 struct clk_hw
*mux_hw
, const struct clk_ops
*mux_ops
,
585 struct clk_hw
*rate_hw
, const struct clk_ops
*rate_ops
,
586 struct clk_hw
*gate_hw
, const struct clk_ops
*gate_ops
,
587 unsigned long flags
);
590 * struct clk_gpio_gate - gpio gated clock
592 * @hw: handle between common and hardware-specific interfaces
593 * @gpiod: gpio descriptor
595 * Clock with a gpio control for enabling and disabling the parent clock.
596 * Implements .enable, .disable and .is_enabled
601 struct gpio_desc
*gpiod
;
604 extern const struct clk_ops clk_gpio_gate_ops
;
605 struct clk
*clk_register_gpio_gate(struct device
*dev
, const char *name
,
606 const char *parent_name
, unsigned gpio
, bool active_low
,
607 unsigned long flags
);
609 void of_gpio_clk_gate_setup(struct device_node
*node
);
612 * struct clk_gpio_mux - gpio controlled clock multiplexer
614 * @hw: see struct clk_gpio
615 * @gpiod: gpio descriptor to select the parent of this clock multiplexer
617 * Clock with a gpio control for selecting the parent clock.
618 * Implements .get_parent, .set_parent and .determine_rate
621 extern const struct clk_ops clk_gpio_mux_ops
;
622 struct clk
*clk_register_gpio_mux(struct device
*dev
, const char *name
,
623 const char * const *parent_names
, u8 num_parents
, unsigned gpio
,
624 bool active_low
, unsigned long flags
);
626 void of_gpio_mux_clk_setup(struct device_node
*node
);
629 * clk_register - allocate a new clock, register it and return an opaque cookie
630 * @dev: device that is registering this clock
631 * @hw: link to hardware-specific clock data
633 * clk_register is the primary interface for populating the clock tree with new
634 * clock nodes. It returns a pointer to the newly allocated struct clk which
635 * cannot be dereferenced by driver code but may be used in conjuction with the
636 * rest of the clock API. In the event of an error clk_register will return an
637 * error code; drivers must test for an error code after calling clk_register.
639 struct clk
*clk_register(struct device
*dev
, struct clk_hw
*hw
);
640 struct clk
*devm_clk_register(struct device
*dev
, struct clk_hw
*hw
);
642 void clk_unregister(struct clk
*clk
);
643 void devm_clk_unregister(struct device
*dev
, struct clk
*clk
);
645 /* helper functions */
646 const char *__clk_get_name(const struct clk
*clk
);
647 const char *clk_hw_get_name(const struct clk_hw
*hw
);
648 struct clk_hw
*__clk_get_hw(struct clk
*clk
);
649 unsigned int clk_hw_get_num_parents(const struct clk_hw
*hw
);
650 struct clk_hw
*clk_hw_get_parent(const struct clk_hw
*hw
);
651 struct clk_hw
*clk_hw_get_parent_by_index(const struct clk_hw
*hw
,
653 unsigned int __clk_get_enable_count(struct clk
*clk
);
654 unsigned long clk_hw_get_rate(const struct clk_hw
*hw
);
655 unsigned long __clk_get_flags(struct clk
*clk
);
656 unsigned long clk_hw_get_flags(const struct clk_hw
*hw
);
657 bool clk_hw_is_prepared(const struct clk_hw
*hw
);
658 bool clk_hw_is_enabled(const struct clk_hw
*hw
);
659 bool __clk_is_enabled(struct clk
*clk
);
660 struct clk
*__clk_lookup(const char *name
);
661 int __clk_mux_determine_rate(struct clk_hw
*hw
,
662 struct clk_rate_request
*req
);
663 int __clk_determine_rate(struct clk_hw
*core
, struct clk_rate_request
*req
);
664 int __clk_mux_determine_rate_closest(struct clk_hw
*hw
,
665 struct clk_rate_request
*req
);
666 void clk_hw_reparent(struct clk_hw
*hw
, struct clk_hw
*new_parent
);
667 void clk_hw_set_rate_range(struct clk_hw
*hw
, unsigned long min_rate
,
668 unsigned long max_rate
);
670 static inline void __clk_hw_set_clk(struct clk_hw
*dst
, struct clk_hw
*src
)
673 dst
->core
= src
->core
;
677 * FIXME clock api without lock protection
679 unsigned long clk_hw_round_rate(struct clk_hw
*hw
, unsigned long rate
);
683 typedef void (*of_clk_init_cb_t
)(struct device_node
*);
685 struct clk_onecell_data
{
687 unsigned int clk_num
;
690 extern struct of_device_id __clk_of_table
;
692 #define CLK_OF_DECLARE(name, compat, fn) OF_DECLARE_1(clk, name, compat, fn)
695 int of_clk_add_provider(struct device_node
*np
,
696 struct clk
*(*clk_src_get
)(struct of_phandle_args
*args
,
699 void of_clk_del_provider(struct device_node
*np
);
700 struct clk
*of_clk_src_simple_get(struct of_phandle_args
*clkspec
,
702 struct clk
*of_clk_src_onecell_get(struct of_phandle_args
*clkspec
, void *data
);
703 int of_clk_get_parent_count(struct device_node
*np
);
704 int of_clk_parent_fill(struct device_node
*np
, const char **parents
,
706 const char *of_clk_get_parent_name(struct device_node
*np
, int index
);
708 void of_clk_init(const struct of_device_id
*matches
);
710 #else /* !CONFIG_OF */
712 static inline int of_clk_add_provider(struct device_node
*np
,
713 struct clk
*(*clk_src_get
)(struct of_phandle_args
*args
,
719 static inline void of_clk_del_provider(struct device_node
*np
) {}
720 static inline struct clk
*of_clk_src_simple_get(
721 struct of_phandle_args
*clkspec
, void *data
)
723 return ERR_PTR(-ENOENT
);
725 static inline struct clk
*of_clk_src_onecell_get(
726 struct of_phandle_args
*clkspec
, void *data
)
728 return ERR_PTR(-ENOENT
);
730 static inline int of_clk_get_parent_count(struct device_node
*np
)
734 static inline int of_clk_parent_fill(struct device_node
*np
,
735 const char **parents
, unsigned int size
)
739 static inline const char *of_clk_get_parent_name(struct device_node
*np
,
744 static inline void of_clk_init(const struct of_device_id
*matches
) {}
745 #endif /* CONFIG_OF */
748 * wrap access to peripherals in accessor routines
749 * for improved portability across platforms
752 #if IS_ENABLED(CONFIG_PPC)
754 static inline u32
clk_readl(u32 __iomem
*reg
)
756 return ioread32be(reg
);
759 static inline void clk_writel(u32 val
, u32 __iomem
*reg
)
761 iowrite32be(val
, reg
);
764 #else /* platform dependent I/O accessors */
766 static inline u32
clk_readl(u32 __iomem
*reg
)
771 static inline void clk_writel(u32 val
, u32 __iomem
*reg
)
776 #endif /* platform dependent I/O accessors */
778 #ifdef CONFIG_DEBUG_FS
779 struct dentry
*clk_debugfs_add_file(struct clk_hw
*hw
, char *name
, umode_t mode
,
780 void *data
, const struct file_operations
*fops
);
783 #endif /* CONFIG_COMMON_CLK */
784 #endif /* CLK_PROVIDER_H */