]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/linux/clk-provider.h
clk: remove clk-private.h
[mirror_ubuntu-artful-kernel.git] / include / linux / clk-provider.h
CommitLineData
b2476490
MT
1/*
2 * linux/include/linux/clk-provider.h
3 *
4 * Copyright (c) 2010-2011 Jeremy Kerr <jeremy.kerr@canonical.com>
5 * Copyright (C) 2011-2012 Linaro Ltd <mturquette@linaro.org>
6 *
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.
10 */
11#ifndef __LINUX_CLK_PROVIDER_H
12#define __LINUX_CLK_PROVIDER_H
13
14#include <linux/clk.h>
aa514ce3 15#include <linux/io.h>
355bb165 16#include <linux/of.h>
b2476490
MT
17
18#ifdef CONFIG_COMMON_CLK
19
b2476490
MT
20/*
21 * flags used across common struct clk. these flags should only affect the
22 * top-level framework. custom flags for dealing with hardware specifics
23 * belong in struct clk_foo
24 */
25#define CLK_SET_RATE_GATE BIT(0) /* must be gated across rate change */
26#define CLK_SET_PARENT_GATE BIT(1) /* must be gated across re-parent */
27#define CLK_SET_RATE_PARENT BIT(2) /* propagate rate change up one level */
28#define CLK_IGNORE_UNUSED BIT(3) /* do not gate even if unused */
29#define CLK_IS_ROOT BIT(4) /* root clk, has no parent */
f7d8caad 30#define CLK_IS_BASIC BIT(5) /* Basic clk, can't do a to_clk_foo() */
a093bde2 31#define CLK_GET_RATE_NOCACHE BIT(6) /* do not use the cached clk rate */
819c1de3 32#define CLK_SET_RATE_NO_REPARENT BIT(7) /* don't re-parent on rate change */
5279fc40 33#define CLK_GET_ACCURACY_NOCACHE BIT(8) /* do not use the cached clk accuracy */
b2476490 34
0197b3ea 35struct clk_hw;
035a61c3 36struct clk_core;
c646cbf1 37struct dentry;
0197b3ea 38
b2476490
MT
39/**
40 * struct clk_ops - Callback operations for hardware clocks; these are to
41 * be provided by the clock implementation, and will be called by drivers
42 * through the clk_* api.
43 *
44 * @prepare: Prepare the clock for enabling. This must not return until
725b418b
GU
45 * the clock is fully prepared, and it's safe to call clk_enable.
46 * This callback is intended to allow clock implementations to
47 * do any initialisation that may sleep. Called with
48 * prepare_lock held.
b2476490
MT
49 *
50 * @unprepare: Release the clock from its prepared state. This will typically
725b418b
GU
51 * undo any work done in the @prepare callback. Called with
52 * prepare_lock held.
b2476490 53 *
3d6ee287
UH
54 * @is_prepared: Queries the hardware to determine if the clock is prepared.
55 * This function is allowed to sleep. Optional, if this op is not
56 * set then the prepare count will be used.
57 *
3cc8247f
UH
58 * @unprepare_unused: Unprepare the clock atomically. Only called from
59 * clk_disable_unused for prepare clocks with special needs.
60 * Called with prepare mutex held. This function may sleep.
61 *
b2476490 62 * @enable: Enable the clock atomically. This must not return until the
725b418b
GU
63 * clock is generating a valid clock signal, usable by consumer
64 * devices. Called with enable_lock held. This function must not
65 * sleep.
b2476490
MT
66 *
67 * @disable: Disable the clock atomically. Called with enable_lock held.
725b418b 68 * This function must not sleep.
b2476490 69 *
119c7127 70 * @is_enabled: Queries the hardware to determine if the clock is enabled.
725b418b
GU
71 * This function must not sleep. Optional, if this op is not
72 * set then the enable count will be used.
119c7127 73 *
7c045a55
MT
74 * @disable_unused: Disable the clock atomically. Only called from
75 * clk_disable_unused for gate clocks with special needs.
76 * Called with enable_lock held. This function must not
77 * sleep.
78 *
7ce3e8cc 79 * @recalc_rate Recalculate the rate of this clock, by querying hardware. The
725b418b
GU
80 * parent rate is an input parameter. It is up to the caller to
81 * ensure that the prepare_mutex is held across this call.
82 * Returns the calculated rate. Optional, but recommended - if
83 * this op is not set then clock rate will be initialized to 0.
b2476490
MT
84 *
85 * @round_rate: Given a target rate as input, returns the closest rate actually
54e73016
GU
86 * supported by the clock. The parent rate is an input/output
87 * parameter.
b2476490 88 *
71472c0c
JH
89 * @determine_rate: Given a target rate as input, returns the closest rate
90 * actually supported by the clock, and optionally the parent clock
91 * that should be used to provide the clock rate.
92 *
b2476490 93 * @set_parent: Change the input source of this clock; for clocks with multiple
54e73016
GU
94 * possible parents specify a new parent by passing in the index
95 * as a u8 corresponding to the parent in either the .parent_names
96 * or .parents arrays. This function in affect translates an
97 * array index into the value programmed into the hardware.
98 * Returns 0 on success, -EERROR otherwise.
99 *
b2476490 100 * @get_parent: Queries the hardware to determine the parent of a clock. The
725b418b
GU
101 * return value is a u8 which specifies the index corresponding to
102 * the parent clock. This index can be applied to either the
103 * .parent_names or .parents arrays. In short, this function
104 * translates the parent value read from hardware into an array
105 * index. Currently only called when the clock is initialized by
106 * __clk_init. This callback is mandatory for clocks with
107 * multiple parents. It is optional (and unnecessary) for clocks
108 * with 0 or 1 parents.
b2476490 109 *
1c0035d7
SG
110 * @set_rate: Change the rate of this clock. The requested rate is specified
111 * by the second argument, which should typically be the return
112 * of .round_rate call. The third argument gives the parent rate
113 * which is likely helpful for most .set_rate implementation.
114 * Returns 0 on success, -EERROR otherwise.
b2476490 115 *
3fa2252b
SB
116 * @set_rate_and_parent: Change the rate and the parent of this clock. The
117 * requested rate is specified by the second argument, which
118 * should typically be the return of .round_rate call. The
119 * third argument gives the parent rate which is likely helpful
120 * for most .set_rate_and_parent implementation. The fourth
121 * argument gives the parent index. This callback is optional (and
122 * unnecessary) for clocks with 0 or 1 parents as well as
123 * for clocks that can tolerate switching the rate and the parent
124 * separately via calls to .set_parent and .set_rate.
125 * Returns 0 on success, -EERROR otherwise.
126 *
54e73016
GU
127 * @recalc_accuracy: Recalculate the accuracy of this clock. The clock accuracy
128 * is expressed in ppb (parts per billion). The parent accuracy is
129 * an input parameter.
130 * Returns the calculated accuracy. Optional - if this op is not
131 * set then clock accuracy will be initialized to parent accuracy
132 * or 0 (perfect clock) if clock has no parent.
133 *
9824cf73
MR
134 * @get_phase: Queries the hardware to get the current phase of a clock.
135 * Returned values are 0-359 degrees on success, negative
136 * error codes on failure.
137 *
e59c5371
MT
138 * @set_phase: Shift the phase this clock signal in degrees specified
139 * by the second argument. Valid values for degrees are
140 * 0-359. Return 0 on success, otherwise -EERROR.
141 *
54e73016
GU
142 * @init: Perform platform-specific initialization magic.
143 * This is not not used by any of the basic clock types.
144 * Please consider other ways of solving initialization problems
145 * before using this callback, as its use is discouraged.
146 *
c646cbf1
AE
147 * @debug_init: Set up type-specific debugfs entries for this clock. This
148 * is called once, after the debugfs directory entry for this
149 * clock has been created. The dentry pointer representing that
150 * directory is provided as an argument. Called with
151 * prepare_lock held. Returns 0 on success, -EERROR otherwise.
152 *
3fa2252b 153 *
b2476490
MT
154 * The clk_enable/clk_disable and clk_prepare/clk_unprepare pairs allow
155 * implementations to split any work between atomic (enable) and sleepable
156 * (prepare) contexts. If enabling a clock requires code that might sleep,
157 * this must be done in clk_prepare. Clock enable code that will never be
7ce3e8cc 158 * called in a sleepable context may be implemented in clk_enable.
b2476490
MT
159 *
160 * Typically, drivers will call clk_prepare when a clock may be needed later
161 * (eg. when a device is opened), and clk_enable when the clock is actually
162 * required (eg. from an interrupt). Note that clk_prepare MUST have been
163 * called before clk_enable.
164 */
165struct clk_ops {
166 int (*prepare)(struct clk_hw *hw);
167 void (*unprepare)(struct clk_hw *hw);
3d6ee287 168 int (*is_prepared)(struct clk_hw *hw);
3cc8247f 169 void (*unprepare_unused)(struct clk_hw *hw);
b2476490
MT
170 int (*enable)(struct clk_hw *hw);
171 void (*disable)(struct clk_hw *hw);
172 int (*is_enabled)(struct clk_hw *hw);
7c045a55 173 void (*disable_unused)(struct clk_hw *hw);
b2476490
MT
174 unsigned long (*recalc_rate)(struct clk_hw *hw,
175 unsigned long parent_rate);
54e73016
GU
176 long (*round_rate)(struct clk_hw *hw, unsigned long rate,
177 unsigned long *parent_rate);
71472c0c
JH
178 long (*determine_rate)(struct clk_hw *hw, unsigned long rate,
179 unsigned long *best_parent_rate,
646cafc6 180 struct clk_hw **best_parent_hw);
b2476490
MT
181 int (*set_parent)(struct clk_hw *hw, u8 index);
182 u8 (*get_parent)(struct clk_hw *hw);
54e73016
GU
183 int (*set_rate)(struct clk_hw *hw, unsigned long rate,
184 unsigned long parent_rate);
3fa2252b
SB
185 int (*set_rate_and_parent)(struct clk_hw *hw,
186 unsigned long rate,
187 unsigned long parent_rate, u8 index);
5279fc40
BB
188 unsigned long (*recalc_accuracy)(struct clk_hw *hw,
189 unsigned long parent_accuracy);
9824cf73 190 int (*get_phase)(struct clk_hw *hw);
e59c5371 191 int (*set_phase)(struct clk_hw *hw, int degrees);
b2476490 192 void (*init)(struct clk_hw *hw);
c646cbf1 193 int (*debug_init)(struct clk_hw *hw, struct dentry *dentry);
b2476490
MT
194};
195
0197b3ea
SK
196/**
197 * struct clk_init_data - holds init data that's common to all clocks and is
198 * shared between the clock provider and the common clock framework.
199 *
200 * @name: clock name
201 * @ops: operations this clock supports
202 * @parent_names: array of string names for all possible parents
203 * @num_parents: number of possible parents
204 * @flags: framework-level hints and quirks
205 */
206struct clk_init_data {
207 const char *name;
208 const struct clk_ops *ops;
209 const char **parent_names;
210 u8 num_parents;
211 unsigned long flags;
212};
213
214/**
215 * struct clk_hw - handle for traversing from a struct clk to its corresponding
216 * hardware-specific structure. struct clk_hw should be declared within struct
217 * clk_foo and then referenced by the struct clk instance that uses struct
218 * clk_foo's clk_ops
219 *
035a61c3
TV
220 * @core: pointer to the struct clk_core instance that points back to this
221 * struct clk_hw instance
222 *
223 * @clk: pointer to the per-user struct clk instance that can be used to call
224 * into the clk API
0197b3ea
SK
225 *
226 * @init: pointer to struct clk_init_data that contains the init data shared
227 * with the common clock framework.
228 */
229struct clk_hw {
035a61c3 230 struct clk_core *core;
0197b3ea 231 struct clk *clk;
dc4cd941 232 const struct clk_init_data *init;
0197b3ea
SK
233};
234
9d9f78ed
MT
235/*
236 * DOC: Basic clock implementations common to many platforms
237 *
238 * Each basic clock hardware type is comprised of a structure describing the
239 * clock hardware, implementations of the relevant callbacks in struct clk_ops,
240 * unique flags for that hardware type, a registration function and an
241 * alternative macro for static initialization
242 */
243
244/**
245 * struct clk_fixed_rate - fixed-rate clock
246 * @hw: handle between common and hardware-specific interfaces
247 * @fixed_rate: constant frequency of clock
248 */
249struct clk_fixed_rate {
250 struct clk_hw hw;
251 unsigned long fixed_rate;
0903ea60 252 unsigned long fixed_accuracy;
9d9f78ed
MT
253 u8 flags;
254};
255
bffad66e 256extern const struct clk_ops clk_fixed_rate_ops;
9d9f78ed
MT
257struct clk *clk_register_fixed_rate(struct device *dev, const char *name,
258 const char *parent_name, unsigned long flags,
259 unsigned long fixed_rate);
0903ea60
BB
260struct clk *clk_register_fixed_rate_with_accuracy(struct device *dev,
261 const char *name, const char *parent_name, unsigned long flags,
262 unsigned long fixed_rate, unsigned long fixed_accuracy);
9d9f78ed 263
015ba402
GL
264void of_fixed_clk_setup(struct device_node *np);
265
9d9f78ed
MT
266/**
267 * struct clk_gate - gating clock
268 *
269 * @hw: handle between common and hardware-specific interfaces
270 * @reg: register controlling gate
271 * @bit_idx: single bit controlling gate
272 * @flags: hardware-specific flags
273 * @lock: register lock
274 *
275 * Clock which can gate its output. Implements .enable & .disable
276 *
277 * Flags:
1f73f31a 278 * CLK_GATE_SET_TO_DISABLE - by default this clock sets the bit at bit_idx to
725b418b
GU
279 * enable the clock. Setting this flag does the opposite: setting the bit
280 * disable the clock and clearing it enables the clock
04577994 281 * CLK_GATE_HIWORD_MASK - The gate settings are only in lower 16-bit
725b418b
GU
282 * of this register, and mask of gate bits are in higher 16-bit of this
283 * register. While setting the gate bits, higher 16-bit should also be
284 * updated to indicate changing gate bits.
9d9f78ed
MT
285 */
286struct clk_gate {
287 struct clk_hw hw;
288 void __iomem *reg;
289 u8 bit_idx;
290 u8 flags;
291 spinlock_t *lock;
9d9f78ed
MT
292};
293
294#define CLK_GATE_SET_TO_DISABLE BIT(0)
04577994 295#define CLK_GATE_HIWORD_MASK BIT(1)
9d9f78ed 296
bffad66e 297extern const struct clk_ops clk_gate_ops;
9d9f78ed
MT
298struct clk *clk_register_gate(struct device *dev, const char *name,
299 const char *parent_name, unsigned long flags,
300 void __iomem *reg, u8 bit_idx,
301 u8 clk_gate_flags, spinlock_t *lock);
4e3c021f 302void clk_unregister_gate(struct clk *clk);
9d9f78ed 303
357c3f0a
RN
304struct clk_div_table {
305 unsigned int val;
306 unsigned int div;
307};
308
9d9f78ed
MT
309/**
310 * struct clk_divider - adjustable divider clock
311 *
312 * @hw: handle between common and hardware-specific interfaces
313 * @reg: register containing the divider
314 * @shift: shift to the divider bit field
315 * @width: width of the divider bit field
357c3f0a 316 * @table: array of value/divider pairs, last entry should have div = 0
9d9f78ed
MT
317 * @lock: register lock
318 *
319 * Clock with an adjustable divider affecting its output frequency. Implements
320 * .recalc_rate, .set_rate and .round_rate
321 *
322 * Flags:
323 * CLK_DIVIDER_ONE_BASED - by default the divisor is the value read from the
725b418b
GU
324 * register plus one. If CLK_DIVIDER_ONE_BASED is set then the divider is
325 * the raw value read from the register, with the value of zero considered
056b2053 326 * invalid, unless CLK_DIVIDER_ALLOW_ZERO is set.
9d9f78ed 327 * CLK_DIVIDER_POWER_OF_TWO - clock divisor is 2 raised to the value read from
725b418b 328 * the hardware register
056b2053
SB
329 * CLK_DIVIDER_ALLOW_ZERO - Allow zero divisors. For dividers which have
330 * CLK_DIVIDER_ONE_BASED set, it is possible to end up with a zero divisor.
331 * Some hardware implementations gracefully handle this case and allow a
332 * zero divisor by not modifying their input clock
333 * (divide by one / bypass).
d57dfe75 334 * CLK_DIVIDER_HIWORD_MASK - The divider settings are only in lower 16-bit
725b418b
GU
335 * of this register, and mask of divider bits are in higher 16-bit of this
336 * register. While setting the divider bits, higher 16-bit should also be
337 * updated to indicate changing divider bits.
774b5143
MC
338 * CLK_DIVIDER_ROUND_CLOSEST - Makes the best calculated divider to be rounded
339 * to the closest integer instead of the up one.
79c6ab50
HS
340 * CLK_DIVIDER_READ_ONLY - The divider settings are preconfigured and should
341 * not be changed by the clock framework.
9d9f78ed
MT
342 */
343struct clk_divider {
344 struct clk_hw hw;
345 void __iomem *reg;
346 u8 shift;
347 u8 width;
348 u8 flags;
357c3f0a 349 const struct clk_div_table *table;
9d9f78ed 350 spinlock_t *lock;
9d9f78ed
MT
351};
352
353#define CLK_DIVIDER_ONE_BASED BIT(0)
354#define CLK_DIVIDER_POWER_OF_TWO BIT(1)
056b2053 355#define CLK_DIVIDER_ALLOW_ZERO BIT(2)
d57dfe75 356#define CLK_DIVIDER_HIWORD_MASK BIT(3)
774b5143 357#define CLK_DIVIDER_ROUND_CLOSEST BIT(4)
79c6ab50 358#define CLK_DIVIDER_READ_ONLY BIT(5)
9d9f78ed 359
bffad66e 360extern const struct clk_ops clk_divider_ops;
bca9690b
SB
361
362unsigned long divider_recalc_rate(struct clk_hw *hw, unsigned long parent_rate,
363 unsigned int val, const struct clk_div_table *table,
364 unsigned long flags);
365long divider_round_rate(struct clk_hw *hw, unsigned long rate,
366 unsigned long *prate, const struct clk_div_table *table,
367 u8 width, unsigned long flags);
368int divider_get_val(unsigned long rate, unsigned long parent_rate,
369 const struct clk_div_table *table, u8 width,
370 unsigned long flags);
371
9d9f78ed
MT
372struct clk *clk_register_divider(struct device *dev, const char *name,
373 const char *parent_name, unsigned long flags,
374 void __iomem *reg, u8 shift, u8 width,
375 u8 clk_divider_flags, spinlock_t *lock);
357c3f0a
RN
376struct clk *clk_register_divider_table(struct device *dev, const char *name,
377 const char *parent_name, unsigned long flags,
378 void __iomem *reg, u8 shift, u8 width,
379 u8 clk_divider_flags, const struct clk_div_table *table,
380 spinlock_t *lock);
4e3c021f 381void clk_unregister_divider(struct clk *clk);
9d9f78ed
MT
382
383/**
384 * struct clk_mux - multiplexer clock
385 *
386 * @hw: handle between common and hardware-specific interfaces
387 * @reg: register controlling multiplexer
388 * @shift: shift to multiplexer bit field
389 * @width: width of mutliplexer bit field
3566d40c 390 * @flags: hardware-specific flags
9d9f78ed
MT
391 * @lock: register lock
392 *
393 * Clock with multiple selectable parents. Implements .get_parent, .set_parent
394 * and .recalc_rate
395 *
396 * Flags:
397 * CLK_MUX_INDEX_ONE - register index starts at 1, not 0
1f73f31a 398 * CLK_MUX_INDEX_BIT - register index is a single bit (power of two)
ba492e90 399 * CLK_MUX_HIWORD_MASK - The mux settings are only in lower 16-bit of this
725b418b
GU
400 * register, and mask of mux bits are in higher 16-bit of this register.
401 * While setting the mux bits, higher 16-bit should also be updated to
402 * indicate changing mux bits.
15a02c1f
SB
403 * CLK_MUX_ROUND_CLOSEST - Use the parent rate that is closest to the desired
404 * frequency.
9d9f78ed
MT
405 */
406struct clk_mux {
407 struct clk_hw hw;
408 void __iomem *reg;
ce4f3313
PDS
409 u32 *table;
410 u32 mask;
9d9f78ed 411 u8 shift;
9d9f78ed
MT
412 u8 flags;
413 spinlock_t *lock;
414};
415
416#define CLK_MUX_INDEX_ONE BIT(0)
417#define CLK_MUX_INDEX_BIT BIT(1)
ba492e90 418#define CLK_MUX_HIWORD_MASK BIT(2)
15a02c1f
SB
419#define CLK_MUX_READ_ONLY BIT(3) /* mux can't be changed */
420#define CLK_MUX_ROUND_CLOSEST BIT(4)
9d9f78ed 421
bffad66e 422extern const struct clk_ops clk_mux_ops;
c57acd14 423extern const struct clk_ops clk_mux_ro_ops;
ce4f3313 424
9d9f78ed 425struct clk *clk_register_mux(struct device *dev, const char *name,
d305fb78 426 const char **parent_names, u8 num_parents, unsigned long flags,
9d9f78ed
MT
427 void __iomem *reg, u8 shift, u8 width,
428 u8 clk_mux_flags, spinlock_t *lock);
b2476490 429
ce4f3313
PDS
430struct clk *clk_register_mux_table(struct device *dev, const char *name,
431 const char **parent_names, u8 num_parents, unsigned long flags,
432 void __iomem *reg, u8 shift, u32 mask,
433 u8 clk_mux_flags, u32 *table, spinlock_t *lock);
434
4e3c021f
KK
435void clk_unregister_mux(struct clk *clk);
436
79b16641
GC
437void of_fixed_factor_clk_setup(struct device_node *node);
438
f0948f59
SH
439/**
440 * struct clk_fixed_factor - fixed multiplier and divider clock
441 *
442 * @hw: handle between common and hardware-specific interfaces
443 * @mult: multiplier
444 * @div: divider
445 *
446 * Clock with a fixed multiplier and divider. The output frequency is the
447 * parent clock rate divided by div and multiplied by mult.
448 * Implements .recalc_rate, .set_rate and .round_rate
449 */
450
451struct clk_fixed_factor {
452 struct clk_hw hw;
453 unsigned int mult;
454 unsigned int div;
455};
456
457extern struct clk_ops clk_fixed_factor_ops;
458struct clk *clk_register_fixed_factor(struct device *dev, const char *name,
459 const char *parent_name, unsigned long flags,
460 unsigned int mult, unsigned int div);
461
e2d0e90f
HK
462/**
463 * struct clk_fractional_divider - adjustable fractional divider clock
464 *
465 * @hw: handle between common and hardware-specific interfaces
466 * @reg: register containing the divider
467 * @mshift: shift to the numerator bit field
468 * @mwidth: width of the numerator bit field
469 * @nshift: shift to the denominator bit field
470 * @nwidth: width of the denominator bit field
471 * @lock: register lock
472 *
473 * Clock with adjustable fractional divider affecting its output frequency.
474 */
475
476struct clk_fractional_divider {
477 struct clk_hw hw;
478 void __iomem *reg;
479 u8 mshift;
480 u32 mmask;
481 u8 nshift;
482 u32 nmask;
483 u8 flags;
484 spinlock_t *lock;
485};
486
487extern const struct clk_ops clk_fractional_divider_ops;
488struct clk *clk_register_fractional_divider(struct device *dev,
489 const char *name, const char *parent_name, unsigned long flags,
490 void __iomem *reg, u8 mshift, u8 mwidth, u8 nshift, u8 nwidth,
491 u8 clk_divider_flags, spinlock_t *lock);
492
ece70094
PG
493/***
494 * struct clk_composite - aggregate clock of mux, divider and gate clocks
495 *
496 * @hw: handle between common and hardware-specific interfaces
d3a1c7be
MT
497 * @mux_hw: handle between composite and hardware-specific mux clock
498 * @rate_hw: handle between composite and hardware-specific rate clock
499 * @gate_hw: handle between composite and hardware-specific gate clock
ece70094 500 * @mux_ops: clock ops for mux
d3a1c7be 501 * @rate_ops: clock ops for rate
ece70094
PG
502 * @gate_ops: clock ops for gate
503 */
504struct clk_composite {
505 struct clk_hw hw;
506 struct clk_ops ops;
507
508 struct clk_hw *mux_hw;
d3a1c7be 509 struct clk_hw *rate_hw;
ece70094
PG
510 struct clk_hw *gate_hw;
511
512 const struct clk_ops *mux_ops;
d3a1c7be 513 const struct clk_ops *rate_ops;
ece70094
PG
514 const struct clk_ops *gate_ops;
515};
516
517struct clk *clk_register_composite(struct device *dev, const char *name,
518 const char **parent_names, int num_parents,
519 struct clk_hw *mux_hw, const struct clk_ops *mux_ops,
d3a1c7be 520 struct clk_hw *rate_hw, const struct clk_ops *rate_ops,
ece70094
PG
521 struct clk_hw *gate_hw, const struct clk_ops *gate_ops,
522 unsigned long flags);
523
c873d14d
JS
524/***
525 * struct clk_gpio_gate - gpio gated clock
526 *
527 * @hw: handle between common and hardware-specific interfaces
528 * @gpiod: gpio descriptor
529 *
530 * Clock with a gpio control for enabling and disabling the parent clock.
531 * Implements .enable, .disable and .is_enabled
532 */
533
534struct clk_gpio {
535 struct clk_hw hw;
536 struct gpio_desc *gpiod;
537};
538
539extern const struct clk_ops clk_gpio_gate_ops;
540struct clk *clk_register_gpio_gate(struct device *dev, const char *name,
541 const char *parent_name, struct gpio_desc *gpio,
542 unsigned long flags);
543
544void of_gpio_clk_gate_setup(struct device_node *node);
545
b2476490
MT
546/**
547 * clk_register - allocate a new clock, register it and return an opaque cookie
548 * @dev: device that is registering this clock
b2476490 549 * @hw: link to hardware-specific clock data
b2476490
MT
550 *
551 * clk_register is the primary interface for populating the clock tree with new
552 * clock nodes. It returns a pointer to the newly allocated struct clk which
553 * cannot be dereferenced by driver code but may be used in conjuction with the
d1302a36
MT
554 * rest of the clock API. In the event of an error clk_register will return an
555 * error code; drivers must test for an error code after calling clk_register.
b2476490 556 */
0197b3ea 557struct clk *clk_register(struct device *dev, struct clk_hw *hw);
46c8773a 558struct clk *devm_clk_register(struct device *dev, struct clk_hw *hw);
b2476490 559
1df5c939 560void clk_unregister(struct clk *clk);
46c8773a 561void devm_clk_unregister(struct device *dev, struct clk *clk);
1df5c939 562
b2476490
MT
563/* helper functions */
564const char *__clk_get_name(struct clk *clk);
565struct clk_hw *__clk_get_hw(struct clk *clk);
566u8 __clk_get_num_parents(struct clk *clk);
567struct clk *__clk_get_parent(struct clk *clk);
7ef3dcc8 568struct clk *clk_get_parent_by_index(struct clk *clk, u8 index);
93874681 569unsigned int __clk_get_enable_count(struct clk *clk);
b2476490
MT
570unsigned long __clk_get_rate(struct clk *clk);
571unsigned long __clk_get_flags(struct clk *clk);
3d6ee287 572bool __clk_is_prepared(struct clk *clk);
2ac6b1f5 573bool __clk_is_enabled(struct clk *clk);
b2476490 574struct clk *__clk_lookup(const char *name);
e366fdd7
JH
575long __clk_mux_determine_rate(struct clk_hw *hw, unsigned long rate,
576 unsigned long *best_parent_rate,
646cafc6 577 struct clk_hw **best_parent_p);
15a02c1f
SB
578long __clk_mux_determine_rate_closest(struct clk_hw *hw, unsigned long rate,
579 unsigned long *best_parent_rate,
580 struct clk_hw **best_parent_p);
b2476490
MT
581
582/*
583 * FIXME clock api without lock protection
584 */
b2476490
MT
585unsigned long __clk_round_rate(struct clk *clk, unsigned long rate);
586
766e6a4e
GL
587struct of_device_id;
588
589typedef void (*of_clk_init_cb_t)(struct device_node *);
590
0b151deb
SH
591struct clk_onecell_data {
592 struct clk **clks;
593 unsigned int clk_num;
594};
595
819b4861
TK
596extern struct of_device_id __clk_of_table;
597
54196ccb 598#define CLK_OF_DECLARE(name, compat, fn) OF_DECLARE_1(clk, name, compat, fn)
0b151deb
SH
599
600#ifdef CONFIG_OF
766e6a4e
GL
601int of_clk_add_provider(struct device_node *np,
602 struct clk *(*clk_src_get)(struct of_phandle_args *args,
603 void *data),
604 void *data);
605void of_clk_del_provider(struct device_node *np);
606struct clk *of_clk_src_simple_get(struct of_phandle_args *clkspec,
607 void *data);
494bfec9 608struct clk *of_clk_src_onecell_get(struct of_phandle_args *clkspec, void *data);
f6102742 609int of_clk_get_parent_count(struct device_node *np);
766e6a4e 610const char *of_clk_get_parent_name(struct device_node *np, int index);
f2f6c255 611
766e6a4e
GL
612void of_clk_init(const struct of_device_id *matches);
613
0b151deb 614#else /* !CONFIG_OF */
f2f6c255 615
0b151deb
SH
616static inline int of_clk_add_provider(struct device_node *np,
617 struct clk *(*clk_src_get)(struct of_phandle_args *args,
618 void *data),
619 void *data)
620{
621 return 0;
622}
623#define of_clk_del_provider(np) \
624 { while (0); }
625static inline struct clk *of_clk_src_simple_get(
626 struct of_phandle_args *clkspec, void *data)
627{
628 return ERR_PTR(-ENOENT);
629}
630static inline struct clk *of_clk_src_onecell_get(
631 struct of_phandle_args *clkspec, void *data)
632{
633 return ERR_PTR(-ENOENT);
634}
635static inline const char *of_clk_get_parent_name(struct device_node *np,
636 int index)
637{
638 return NULL;
639}
640#define of_clk_init(matches) \
641 { while (0); }
642#endif /* CONFIG_OF */
aa514ce3
GS
643
644/*
645 * wrap access to peripherals in accessor routines
646 * for improved portability across platforms
647 */
648
6d8cdb68
GS
649#if IS_ENABLED(CONFIG_PPC)
650
651static inline u32 clk_readl(u32 __iomem *reg)
652{
653 return ioread32be(reg);
654}
655
656static inline void clk_writel(u32 val, u32 __iomem *reg)
657{
658 iowrite32be(val, reg);
659}
660
661#else /* platform dependent I/O accessors */
662
aa514ce3
GS
663static inline u32 clk_readl(u32 __iomem *reg)
664{
665 return readl(reg);
666}
667
668static inline void clk_writel(u32 val, u32 __iomem *reg)
669{
670 writel(val, reg);
671}
672
6d8cdb68
GS
673#endif /* platform dependent I/O accessors */
674
fb2b3c9f 675#ifdef CONFIG_DEBUG_FS
61c7cddf 676struct dentry *clk_debugfs_add_file(struct clk_hw *hw, char *name, umode_t mode,
fb2b3c9f
PDS
677 void *data, const struct file_operations *fops);
678#endif
679
b2476490
MT
680#endif /* CONFIG_COMMON_CLK */
681#endif /* CLK_PROVIDER_H */