blob: 2839c639f0920942d1e835dd464598432e22e974 [file] [log] [blame]
Mike Turquetteb24764902012-03-15 23:11:19 -07001/*
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>
Gerhard Sittigaa514ce2013-07-22 14:14:40 +020015#include <linux/io.h>
Maxime Ripard355bb162014-08-30 21:18:00 +020016#include <linux/of.h>
Mike Turquetteb24764902012-03-15 23:11:19 -070017
18#ifdef CONFIG_COMMON_CLK
19
Mike Turquetteb24764902012-03-15 23:11:19 -070020/*
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 */
Rajendra Nayakf7d8caa2012-06-01 14:02:47 +053030#define CLK_IS_BASIC BIT(5) /* Basic clk, can't do a to_clk_foo() */
Ulf Hanssona093bde2012-08-31 14:21:28 +020031#define CLK_GET_RATE_NOCACHE BIT(6) /* do not use the cached clk rate */
James Hogan819c1de2013-07-29 12:25:01 +010032#define CLK_SET_RATE_NO_REPARENT BIT(7) /* don't re-parent on rate change */
Boris BREZILLON5279fc42013-12-21 10:34:47 +010033#define CLK_GET_ACCURACY_NOCACHE BIT(8) /* do not use the cached clk accuracy */
Mike Turquetteb24764902012-03-15 23:11:19 -070034
Saravana Kannan0197b3e2012-04-25 22:58:56 -070035struct clk_hw;
Alex Elderc646cbf2014-03-21 06:43:56 -050036struct dentry;
Saravana Kannan0197b3e2012-04-25 22:58:56 -070037
Mike Turquetteb24764902012-03-15 23:11:19 -070038/**
39 * struct clk_ops - Callback operations for hardware clocks; these are to
40 * be provided by the clock implementation, and will be called by drivers
41 * through the clk_* api.
42 *
43 * @prepare: Prepare the clock for enabling. This must not return until
Geert Uytterhoeven725b4182014-04-22 15:11:41 +020044 * the clock is fully prepared, and it's safe to call clk_enable.
45 * This callback is intended to allow clock implementations to
46 * do any initialisation that may sleep. Called with
47 * prepare_lock held.
Mike Turquetteb24764902012-03-15 23:11:19 -070048 *
49 * @unprepare: Release the clock from its prepared state. This will typically
Geert Uytterhoeven725b4182014-04-22 15:11:41 +020050 * undo any work done in the @prepare callback. Called with
51 * prepare_lock held.
Mike Turquetteb24764902012-03-15 23:11:19 -070052 *
Ulf Hansson3d6ee282013-03-12 20:26:02 +010053 * @is_prepared: Queries the hardware to determine if the clock is prepared.
54 * This function is allowed to sleep. Optional, if this op is not
55 * set then the prepare count will be used.
56 *
Ulf Hansson3cc82472013-03-12 20:26:04 +010057 * @unprepare_unused: Unprepare the clock atomically. Only called from
58 * clk_disable_unused for prepare clocks with special needs.
59 * Called with prepare mutex held. This function may sleep.
60 *
Mike Turquetteb24764902012-03-15 23:11:19 -070061 * @enable: Enable the clock atomically. This must not return until the
Geert Uytterhoeven725b4182014-04-22 15:11:41 +020062 * clock is generating a valid clock signal, usable by consumer
63 * devices. Called with enable_lock held. This function must not
64 * sleep.
Mike Turquetteb24764902012-03-15 23:11:19 -070065 *
66 * @disable: Disable the clock atomically. Called with enable_lock held.
Geert Uytterhoeven725b4182014-04-22 15:11:41 +020067 * This function must not sleep.
Mike Turquetteb24764902012-03-15 23:11:19 -070068 *
Stephen Boyd119c7122012-10-03 23:38:53 -070069 * @is_enabled: Queries the hardware to determine if the clock is enabled.
Geert Uytterhoeven725b4182014-04-22 15:11:41 +020070 * This function must not sleep. Optional, if this op is not
71 * set then the enable count will be used.
Stephen Boyd119c7122012-10-03 23:38:53 -070072 *
Mike Turquette7c045a52012-12-04 11:00:35 -080073 * @disable_unused: Disable the clock atomically. Only called from
74 * clk_disable_unused for gate clocks with special needs.
75 * Called with enable_lock held. This function must not
76 * sleep.
77 *
Stephen Boyd7ce3e8c2012-10-03 23:38:54 -070078 * @recalc_rate Recalculate the rate of this clock, by querying hardware. The
Geert Uytterhoeven725b4182014-04-22 15:11:41 +020079 * parent rate is an input parameter. It is up to the caller to
80 * ensure that the prepare_mutex is held across this call.
81 * Returns the calculated rate. Optional, but recommended - if
82 * this op is not set then clock rate will be initialized to 0.
Mike Turquetteb24764902012-03-15 23:11:19 -070083 *
84 * @round_rate: Given a target rate as input, returns the closest rate actually
Geert Uytterhoeven54e73012014-04-22 15:11:42 +020085 * supported by the clock. The parent rate is an input/output
86 * parameter.
Mike Turquetteb24764902012-03-15 23:11:19 -070087 *
James Hogan71472c02013-07-29 12:25:00 +010088 * @determine_rate: Given a target rate as input, returns the closest rate
89 * actually supported by the clock, and optionally the parent clock
90 * that should be used to provide the clock rate.
91 *
Mike Turquetteb24764902012-03-15 23:11:19 -070092 * @set_parent: Change the input source of this clock; for clocks with multiple
Geert Uytterhoeven54e73012014-04-22 15:11:42 +020093 * possible parents specify a new parent by passing in the index
94 * as a u8 corresponding to the parent in either the .parent_names
95 * or .parents arrays. This function in affect translates an
96 * array index into the value programmed into the hardware.
97 * Returns 0 on success, -EERROR otherwise.
98 *
Mike Turquetteb24764902012-03-15 23:11:19 -070099 * @get_parent: Queries the hardware to determine the parent of a clock. The
Geert Uytterhoeven725b4182014-04-22 15:11:41 +0200100 * return value is a u8 which specifies the index corresponding to
101 * the parent clock. This index can be applied to either the
102 * .parent_names or .parents arrays. In short, this function
103 * translates the parent value read from hardware into an array
104 * index. Currently only called when the clock is initialized by
105 * __clk_init. This callback is mandatory for clocks with
106 * multiple parents. It is optional (and unnecessary) for clocks
107 * with 0 or 1 parents.
Mike Turquetteb24764902012-03-15 23:11:19 -0700108 *
Shawn Guo1c0035d2012-04-12 20:50:18 +0800109 * @set_rate: Change the rate of this clock. The requested rate is specified
110 * by the second argument, which should typically be the return
111 * of .round_rate call. The third argument gives the parent rate
112 * which is likely helpful for most .set_rate implementation.
113 * Returns 0 on success, -EERROR otherwise.
Mike Turquetteb24764902012-03-15 23:11:19 -0700114 *
Stephen Boyd3fa22522014-01-15 10:47:22 -0800115 * @set_rate_and_parent: Change the rate and the parent of this clock. The
116 * requested rate is specified by the second argument, which
117 * should typically be the return of .round_rate call. The
118 * third argument gives the parent rate which is likely helpful
119 * for most .set_rate_and_parent implementation. The fourth
120 * argument gives the parent index. This callback is optional (and
121 * unnecessary) for clocks with 0 or 1 parents as well as
122 * for clocks that can tolerate switching the rate and the parent
123 * separately via calls to .set_parent and .set_rate.
124 * Returns 0 on success, -EERROR otherwise.
125 *
Geert Uytterhoeven54e73012014-04-22 15:11:42 +0200126 * @recalc_accuracy: Recalculate the accuracy of this clock. The clock accuracy
127 * is expressed in ppb (parts per billion). The parent accuracy is
128 * an input parameter.
129 * Returns the calculated accuracy. Optional - if this op is not
130 * set then clock accuracy will be initialized to parent accuracy
131 * or 0 (perfect clock) if clock has no parent.
132 *
Maxime Ripard9824cf72014-07-14 13:53:27 +0200133 * @get_phase: Queries the hardware to get the current phase of a clock.
134 * Returned values are 0-359 degrees on success, negative
135 * error codes on failure.
136 *
Mike Turquettee59c5372014-02-18 21:21:25 -0800137 * @set_phase: Shift the phase this clock signal in degrees specified
138 * by the second argument. Valid values for degrees are
139 * 0-359. Return 0 on success, otherwise -EERROR.
140 *
Geert Uytterhoeven54e73012014-04-22 15:11:42 +0200141 * @init: Perform platform-specific initialization magic.
142 * This is not not used by any of the basic clock types.
143 * Please consider other ways of solving initialization problems
144 * before using this callback, as its use is discouraged.
145 *
Alex Elderc646cbf2014-03-21 06:43:56 -0500146 * @debug_init: Set up type-specific debugfs entries for this clock. This
147 * is called once, after the debugfs directory entry for this
148 * clock has been created. The dentry pointer representing that
149 * directory is provided as an argument. Called with
150 * prepare_lock held. Returns 0 on success, -EERROR otherwise.
151 *
Stephen Boyd3fa22522014-01-15 10:47:22 -0800152 *
Mike Turquetteb24764902012-03-15 23:11:19 -0700153 * The clk_enable/clk_disable and clk_prepare/clk_unprepare pairs allow
154 * implementations to split any work between atomic (enable) and sleepable
155 * (prepare) contexts. If enabling a clock requires code that might sleep,
156 * this must be done in clk_prepare. Clock enable code that will never be
Stephen Boyd7ce3e8c2012-10-03 23:38:54 -0700157 * called in a sleepable context may be implemented in clk_enable.
Mike Turquetteb24764902012-03-15 23:11:19 -0700158 *
159 * Typically, drivers will call clk_prepare when a clock may be needed later
160 * (eg. when a device is opened), and clk_enable when the clock is actually
161 * required (eg. from an interrupt). Note that clk_prepare MUST have been
162 * called before clk_enable.
163 */
164struct clk_ops {
165 int (*prepare)(struct clk_hw *hw);
166 void (*unprepare)(struct clk_hw *hw);
Ulf Hansson3d6ee282013-03-12 20:26:02 +0100167 int (*is_prepared)(struct clk_hw *hw);
Ulf Hansson3cc82472013-03-12 20:26:04 +0100168 void (*unprepare_unused)(struct clk_hw *hw);
Mike Turquetteb24764902012-03-15 23:11:19 -0700169 int (*enable)(struct clk_hw *hw);
170 void (*disable)(struct clk_hw *hw);
171 int (*is_enabled)(struct clk_hw *hw);
Mike Turquette7c045a52012-12-04 11:00:35 -0800172 void (*disable_unused)(struct clk_hw *hw);
Mike Turquetteb24764902012-03-15 23:11:19 -0700173 unsigned long (*recalc_rate)(struct clk_hw *hw,
174 unsigned long parent_rate);
Geert Uytterhoeven54e73012014-04-22 15:11:42 +0200175 long (*round_rate)(struct clk_hw *hw, unsigned long rate,
176 unsigned long *parent_rate);
James Hogan71472c02013-07-29 12:25:00 +0100177 long (*determine_rate)(struct clk_hw *hw, unsigned long rate,
178 unsigned long *best_parent_rate,
179 struct clk **best_parent_clk);
Mike Turquetteb24764902012-03-15 23:11:19 -0700180 int (*set_parent)(struct clk_hw *hw, u8 index);
181 u8 (*get_parent)(struct clk_hw *hw);
Geert Uytterhoeven54e73012014-04-22 15:11:42 +0200182 int (*set_rate)(struct clk_hw *hw, unsigned long rate,
183 unsigned long parent_rate);
Stephen Boyd3fa22522014-01-15 10:47:22 -0800184 int (*set_rate_and_parent)(struct clk_hw *hw,
185 unsigned long rate,
186 unsigned long parent_rate, u8 index);
Boris BREZILLON5279fc42013-12-21 10:34:47 +0100187 unsigned long (*recalc_accuracy)(struct clk_hw *hw,
188 unsigned long parent_accuracy);
Maxime Ripard9824cf72014-07-14 13:53:27 +0200189 int (*get_phase)(struct clk_hw *hw);
Mike Turquettee59c5372014-02-18 21:21:25 -0800190 int (*set_phase)(struct clk_hw *hw, int degrees);
Mike Turquetteb24764902012-03-15 23:11:19 -0700191 void (*init)(struct clk_hw *hw);
Alex Elderc646cbf2014-03-21 06:43:56 -0500192 int (*debug_init)(struct clk_hw *hw, struct dentry *dentry);
Mike Turquetteb24764902012-03-15 23:11:19 -0700193};
194
Saravana Kannan0197b3e2012-04-25 22:58:56 -0700195/**
196 * struct clk_init_data - holds init data that's common to all clocks and is
197 * shared between the clock provider and the common clock framework.
198 *
199 * @name: clock name
200 * @ops: operations this clock supports
201 * @parent_names: array of string names for all possible parents
202 * @num_parents: number of possible parents
203 * @flags: framework-level hints and quirks
204 */
205struct clk_init_data {
206 const char *name;
207 const struct clk_ops *ops;
208 const char **parent_names;
209 u8 num_parents;
210 unsigned long flags;
211};
212
213/**
214 * struct clk_hw - handle for traversing from a struct clk to its corresponding
215 * hardware-specific structure. struct clk_hw should be declared within struct
216 * clk_foo and then referenced by the struct clk instance that uses struct
217 * clk_foo's clk_ops
218 *
219 * @clk: pointer to the struct clk instance that points back to this struct
220 * clk_hw instance
221 *
222 * @init: pointer to struct clk_init_data that contains the init data shared
223 * with the common clock framework.
224 */
225struct clk_hw {
226 struct clk *clk;
Mark Browndc4cd942012-05-14 15:12:42 +0100227 const struct clk_init_data *init;
Saravana Kannan0197b3e2012-04-25 22:58:56 -0700228};
229
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700230/*
231 * DOC: Basic clock implementations common to many platforms
232 *
233 * Each basic clock hardware type is comprised of a structure describing the
234 * clock hardware, implementations of the relevant callbacks in struct clk_ops,
235 * unique flags for that hardware type, a registration function and an
236 * alternative macro for static initialization
237 */
238
239/**
240 * struct clk_fixed_rate - fixed-rate clock
241 * @hw: handle between common and hardware-specific interfaces
242 * @fixed_rate: constant frequency of clock
243 */
244struct clk_fixed_rate {
245 struct clk_hw hw;
246 unsigned long fixed_rate;
Boris BREZILLON0903ea62013-12-21 10:34:48 +0100247 unsigned long fixed_accuracy;
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700248 u8 flags;
249};
250
Shawn Guobffad662012-03-27 15:23:23 +0800251extern const struct clk_ops clk_fixed_rate_ops;
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700252struct clk *clk_register_fixed_rate(struct device *dev, const char *name,
253 const char *parent_name, unsigned long flags,
254 unsigned long fixed_rate);
Boris BREZILLON0903ea62013-12-21 10:34:48 +0100255struct clk *clk_register_fixed_rate_with_accuracy(struct device *dev,
256 const char *name, const char *parent_name, unsigned long flags,
257 unsigned long fixed_rate, unsigned long fixed_accuracy);
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700258
Grant Likely015ba402012-04-07 21:39:39 -0500259void of_fixed_clk_setup(struct device_node *np);
260
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700261/**
262 * struct clk_gate - gating clock
263 *
264 * @hw: handle between common and hardware-specific interfaces
265 * @reg: register controlling gate
266 * @bit_idx: single bit controlling gate
267 * @flags: hardware-specific flags
268 * @lock: register lock
269 *
270 * Clock which can gate its output. Implements .enable & .disable
271 *
272 * Flags:
Viresh Kumar1f73f312012-04-17 16:45:35 +0530273 * CLK_GATE_SET_TO_DISABLE - by default this clock sets the bit at bit_idx to
Geert Uytterhoeven725b4182014-04-22 15:11:41 +0200274 * enable the clock. Setting this flag does the opposite: setting the bit
275 * disable the clock and clearing it enables the clock
Haojian Zhuang04577992013-06-08 22:47:19 +0800276 * CLK_GATE_HIWORD_MASK - The gate settings are only in lower 16-bit
Geert Uytterhoeven725b4182014-04-22 15:11:41 +0200277 * of this register, and mask of gate bits are in higher 16-bit of this
278 * register. While setting the gate bits, higher 16-bit should also be
279 * updated to indicate changing gate bits.
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700280 */
281struct clk_gate {
282 struct clk_hw hw;
283 void __iomem *reg;
284 u8 bit_idx;
285 u8 flags;
286 spinlock_t *lock;
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700287};
288
289#define CLK_GATE_SET_TO_DISABLE BIT(0)
Haojian Zhuang04577992013-06-08 22:47:19 +0800290#define CLK_GATE_HIWORD_MASK BIT(1)
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700291
Shawn Guobffad662012-03-27 15:23:23 +0800292extern const struct clk_ops clk_gate_ops;
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700293struct clk *clk_register_gate(struct device *dev, const char *name,
294 const char *parent_name, unsigned long flags,
295 void __iomem *reg, u8 bit_idx,
296 u8 clk_gate_flags, spinlock_t *lock);
297
Rajendra Nayak357c3f02012-06-29 19:06:32 +0530298struct clk_div_table {
299 unsigned int val;
300 unsigned int div;
301};
302
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700303/**
304 * struct clk_divider - adjustable divider clock
305 *
306 * @hw: handle between common and hardware-specific interfaces
307 * @reg: register containing the divider
308 * @shift: shift to the divider bit field
309 * @width: width of the divider bit field
Rajendra Nayak357c3f02012-06-29 19:06:32 +0530310 * @table: array of value/divider pairs, last entry should have div = 0
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700311 * @lock: register lock
312 *
313 * Clock with an adjustable divider affecting its output frequency. Implements
314 * .recalc_rate, .set_rate and .round_rate
315 *
316 * Flags:
317 * CLK_DIVIDER_ONE_BASED - by default the divisor is the value read from the
Geert Uytterhoeven725b4182014-04-22 15:11:41 +0200318 * register plus one. If CLK_DIVIDER_ONE_BASED is set then the divider is
319 * the raw value read from the register, with the value of zero considered
Soren Brinkmann056b20532013-04-02 15:36:56 -0700320 * invalid, unless CLK_DIVIDER_ALLOW_ZERO is set.
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700321 * CLK_DIVIDER_POWER_OF_TWO - clock divisor is 2 raised to the value read from
Geert Uytterhoeven725b4182014-04-22 15:11:41 +0200322 * the hardware register
Soren Brinkmann056b20532013-04-02 15:36:56 -0700323 * CLK_DIVIDER_ALLOW_ZERO - Allow zero divisors. For dividers which have
324 * CLK_DIVIDER_ONE_BASED set, it is possible to end up with a zero divisor.
325 * Some hardware implementations gracefully handle this case and allow a
326 * zero divisor by not modifying their input clock
327 * (divide by one / bypass).
Haojian Zhuangd57dfe72013-06-08 22:47:18 +0800328 * CLK_DIVIDER_HIWORD_MASK - The divider settings are only in lower 16-bit
Geert Uytterhoeven725b4182014-04-22 15:11:41 +0200329 * of this register, and mask of divider bits are in higher 16-bit of this
330 * register. While setting the divider bits, higher 16-bit should also be
331 * updated to indicate changing divider bits.
Maxime COQUELIN774b5142014-01-29 17:24:07 +0100332 * CLK_DIVIDER_ROUND_CLOSEST - Makes the best calculated divider to be rounded
333 * to the closest integer instead of the up one.
Heiko Stuebner79c6ab52014-05-23 18:32:15 +0530334 * CLK_DIVIDER_READ_ONLY - The divider settings are preconfigured and should
335 * not be changed by the clock framework.
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700336 */
337struct clk_divider {
338 struct clk_hw hw;
339 void __iomem *reg;
340 u8 shift;
341 u8 width;
342 u8 flags;
Rajendra Nayak357c3f02012-06-29 19:06:32 +0530343 const struct clk_div_table *table;
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700344 spinlock_t *lock;
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700345};
346
347#define CLK_DIVIDER_ONE_BASED BIT(0)
348#define CLK_DIVIDER_POWER_OF_TWO BIT(1)
Soren Brinkmann056b20532013-04-02 15:36:56 -0700349#define CLK_DIVIDER_ALLOW_ZERO BIT(2)
Haojian Zhuangd57dfe72013-06-08 22:47:18 +0800350#define CLK_DIVIDER_HIWORD_MASK BIT(3)
Maxime COQUELIN774b5142014-01-29 17:24:07 +0100351#define CLK_DIVIDER_ROUND_CLOSEST BIT(4)
Heiko Stuebner79c6ab52014-05-23 18:32:15 +0530352#define CLK_DIVIDER_READ_ONLY BIT(5)
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700353
Shawn Guobffad662012-03-27 15:23:23 +0800354extern const struct clk_ops clk_divider_ops;
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700355struct clk *clk_register_divider(struct device *dev, const char *name,
356 const char *parent_name, unsigned long flags,
357 void __iomem *reg, u8 shift, u8 width,
358 u8 clk_divider_flags, spinlock_t *lock);
Rajendra Nayak357c3f02012-06-29 19:06:32 +0530359struct clk *clk_register_divider_table(struct device *dev, const char *name,
360 const char *parent_name, unsigned long flags,
361 void __iomem *reg, u8 shift, u8 width,
362 u8 clk_divider_flags, const struct clk_div_table *table,
363 spinlock_t *lock);
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700364
365/**
366 * struct clk_mux - multiplexer clock
367 *
368 * @hw: handle between common and hardware-specific interfaces
369 * @reg: register controlling multiplexer
370 * @shift: shift to multiplexer bit field
371 * @width: width of mutliplexer bit field
James Hogan3566d402013-03-25 14:35:07 +0000372 * @flags: hardware-specific flags
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700373 * @lock: register lock
374 *
375 * Clock with multiple selectable parents. Implements .get_parent, .set_parent
376 * and .recalc_rate
377 *
378 * Flags:
379 * CLK_MUX_INDEX_ONE - register index starts at 1, not 0
Viresh Kumar1f73f312012-04-17 16:45:35 +0530380 * CLK_MUX_INDEX_BIT - register index is a single bit (power of two)
Haojian Zhuangba492e92013-06-08 22:47:17 +0800381 * CLK_MUX_HIWORD_MASK - The mux settings are only in lower 16-bit of this
Geert Uytterhoeven725b4182014-04-22 15:11:41 +0200382 * register, and mask of mux bits are in higher 16-bit of this register.
383 * While setting the mux bits, higher 16-bit should also be updated to
384 * indicate changing mux bits.
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700385 */
386struct clk_mux {
387 struct clk_hw hw;
388 void __iomem *reg;
Peter De Schrijverce4f3312013-03-22 14:07:53 +0200389 u32 *table;
390 u32 mask;
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700391 u8 shift;
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700392 u8 flags;
393 spinlock_t *lock;
394};
395
396#define CLK_MUX_INDEX_ONE BIT(0)
397#define CLK_MUX_INDEX_BIT BIT(1)
Haojian Zhuangba492e92013-06-08 22:47:17 +0800398#define CLK_MUX_HIWORD_MASK BIT(2)
Tomasz Figac57acd12013-07-23 01:49:18 +0200399#define CLK_MUX_READ_ONLY BIT(3) /* mux setting cannot be changed */
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700400
Shawn Guobffad662012-03-27 15:23:23 +0800401extern const struct clk_ops clk_mux_ops;
Tomasz Figac57acd12013-07-23 01:49:18 +0200402extern const struct clk_ops clk_mux_ro_ops;
Peter De Schrijverce4f3312013-03-22 14:07:53 +0200403
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700404struct clk *clk_register_mux(struct device *dev, const char *name,
Mark Brownd305fb72012-03-21 20:01:20 +0000405 const char **parent_names, u8 num_parents, unsigned long flags,
Mike Turquette9d9f78e2012-03-15 23:11:20 -0700406 void __iomem *reg, u8 shift, u8 width,
407 u8 clk_mux_flags, spinlock_t *lock);
Mike Turquetteb24764902012-03-15 23:11:19 -0700408
Peter De Schrijverce4f3312013-03-22 14:07:53 +0200409struct clk *clk_register_mux_table(struct device *dev, const char *name,
410 const char **parent_names, u8 num_parents, unsigned long flags,
411 void __iomem *reg, u8 shift, u32 mask,
412 u8 clk_mux_flags, u32 *table, spinlock_t *lock);
413
Gregory CLEMENT79b16642013-04-12 13:57:44 +0200414void of_fixed_factor_clk_setup(struct device_node *node);
415
Mike Turquetteb24764902012-03-15 23:11:19 -0700416/**
Sascha Hauerf0948f52012-05-03 15:36:14 +0530417 * struct clk_fixed_factor - fixed multiplier and divider clock
418 *
419 * @hw: handle between common and hardware-specific interfaces
420 * @mult: multiplier
421 * @div: divider
422 *
423 * Clock with a fixed multiplier and divider. The output frequency is the
424 * parent clock rate divided by div and multiplied by mult.
425 * Implements .recalc_rate, .set_rate and .round_rate
426 */
427
428struct clk_fixed_factor {
429 struct clk_hw hw;
430 unsigned int mult;
431 unsigned int div;
432};
433
434extern struct clk_ops clk_fixed_factor_ops;
435struct clk *clk_register_fixed_factor(struct device *dev, const char *name,
436 const char *parent_name, unsigned long flags,
437 unsigned int mult, unsigned int div);
438
Heikki Krogeruse2d0e902014-05-15 16:40:25 +0300439/**
440 * struct clk_fractional_divider - adjustable fractional divider clock
441 *
442 * @hw: handle between common and hardware-specific interfaces
443 * @reg: register containing the divider
444 * @mshift: shift to the numerator bit field
445 * @mwidth: width of the numerator bit field
446 * @nshift: shift to the denominator bit field
447 * @nwidth: width of the denominator bit field
448 * @lock: register lock
449 *
450 * Clock with adjustable fractional divider affecting its output frequency.
451 */
452
453struct clk_fractional_divider {
454 struct clk_hw hw;
455 void __iomem *reg;
456 u8 mshift;
457 u32 mmask;
458 u8 nshift;
459 u32 nmask;
460 u8 flags;
461 spinlock_t *lock;
462};
463
464extern const struct clk_ops clk_fractional_divider_ops;
465struct clk *clk_register_fractional_divider(struct device *dev,
466 const char *name, const char *parent_name, unsigned long flags,
467 void __iomem *reg, u8 mshift, u8 mwidth, u8 nshift, u8 nwidth,
468 u8 clk_divider_flags, spinlock_t *lock);
469
Prashant Gaikwadece70092013-03-20 17:30:34 +0530470/***
471 * struct clk_composite - aggregate clock of mux, divider and gate clocks
472 *
473 * @hw: handle between common and hardware-specific interfaces
Mike Turquetted3a1c7b2013-04-11 11:31:36 -0700474 * @mux_hw: handle between composite and hardware-specific mux clock
475 * @rate_hw: handle between composite and hardware-specific rate clock
476 * @gate_hw: handle between composite and hardware-specific gate clock
Prashant Gaikwadece70092013-03-20 17:30:34 +0530477 * @mux_ops: clock ops for mux
Mike Turquetted3a1c7b2013-04-11 11:31:36 -0700478 * @rate_ops: clock ops for rate
Prashant Gaikwadece70092013-03-20 17:30:34 +0530479 * @gate_ops: clock ops for gate
480 */
481struct clk_composite {
482 struct clk_hw hw;
483 struct clk_ops ops;
484
485 struct clk_hw *mux_hw;
Mike Turquetted3a1c7b2013-04-11 11:31:36 -0700486 struct clk_hw *rate_hw;
Prashant Gaikwadece70092013-03-20 17:30:34 +0530487 struct clk_hw *gate_hw;
488
489 const struct clk_ops *mux_ops;
Mike Turquetted3a1c7b2013-04-11 11:31:36 -0700490 const struct clk_ops *rate_ops;
Prashant Gaikwadece70092013-03-20 17:30:34 +0530491 const struct clk_ops *gate_ops;
492};
493
494struct clk *clk_register_composite(struct device *dev, const char *name,
495 const char **parent_names, int num_parents,
496 struct clk_hw *mux_hw, const struct clk_ops *mux_ops,
Mike Turquetted3a1c7b2013-04-11 11:31:36 -0700497 struct clk_hw *rate_hw, const struct clk_ops *rate_ops,
Prashant Gaikwadece70092013-03-20 17:30:34 +0530498 struct clk_hw *gate_hw, const struct clk_ops *gate_ops,
499 unsigned long flags);
500
Jyri Sarhac873d142014-09-05 15:21:34 +0300501/***
502 * struct clk_gpio_gate - gpio gated clock
503 *
504 * @hw: handle between common and hardware-specific interfaces
505 * @gpiod: gpio descriptor
506 *
507 * Clock with a gpio control for enabling and disabling the parent clock.
508 * Implements .enable, .disable and .is_enabled
509 */
510
511struct clk_gpio {
512 struct clk_hw hw;
513 struct gpio_desc *gpiod;
514};
515
516extern const struct clk_ops clk_gpio_gate_ops;
517struct clk *clk_register_gpio_gate(struct device *dev, const char *name,
518 const char *parent_name, struct gpio_desc *gpio,
519 unsigned long flags);
520
521void of_gpio_clk_gate_setup(struct device_node *node);
522
Sascha Hauerf0948f52012-05-03 15:36:14 +0530523/**
Mike Turquetteb24764902012-03-15 23:11:19 -0700524 * clk_register - allocate a new clock, register it and return an opaque cookie
525 * @dev: device that is registering this clock
Mike Turquetteb24764902012-03-15 23:11:19 -0700526 * @hw: link to hardware-specific clock data
Mike Turquetteb24764902012-03-15 23:11:19 -0700527 *
528 * clk_register is the primary interface for populating the clock tree with new
529 * clock nodes. It returns a pointer to the newly allocated struct clk which
530 * cannot be dereferenced by driver code but may be used in conjuction with the
Mike Turquetted1302a32012-03-29 14:30:40 -0700531 * rest of the clock API. In the event of an error clk_register will return an
532 * error code; drivers must test for an error code after calling clk_register.
Mike Turquetteb24764902012-03-15 23:11:19 -0700533 */
Saravana Kannan0197b3e2012-04-25 22:58:56 -0700534struct clk *clk_register(struct device *dev, struct clk_hw *hw);
Stephen Boyd46c87732012-09-24 13:38:04 -0700535struct clk *devm_clk_register(struct device *dev, struct clk_hw *hw);
Mike Turquetteb24764902012-03-15 23:11:19 -0700536
Mark Brown1df5c932012-04-18 09:07:12 +0100537void clk_unregister(struct clk *clk);
Stephen Boyd46c87732012-09-24 13:38:04 -0700538void devm_clk_unregister(struct device *dev, struct clk *clk);
Mark Brown1df5c932012-04-18 09:07:12 +0100539
Mike Turquetteb24764902012-03-15 23:11:19 -0700540/* helper functions */
541const char *__clk_get_name(struct clk *clk);
542struct clk_hw *__clk_get_hw(struct clk *clk);
543u8 __clk_get_num_parents(struct clk *clk);
544struct clk *__clk_get_parent(struct clk *clk);
James Hogan7ef3dcc2013-07-29 12:24:58 +0100545struct clk *clk_get_parent_by_index(struct clk *clk, u8 index);
Linus Torvalds93874682012-12-11 11:25:08 -0800546unsigned int __clk_get_enable_count(struct clk *clk);
547unsigned int __clk_get_prepare_count(struct clk *clk);
Mike Turquetteb24764902012-03-15 23:11:19 -0700548unsigned long __clk_get_rate(struct clk *clk);
Boris BREZILLON5279fc42013-12-21 10:34:47 +0100549unsigned long __clk_get_accuracy(struct clk *clk);
Mike Turquetteb24764902012-03-15 23:11:19 -0700550unsigned long __clk_get_flags(struct clk *clk);
Ulf Hansson3d6ee282013-03-12 20:26:02 +0100551bool __clk_is_prepared(struct clk *clk);
Stephen Boyd2ac6b1f2012-10-03 23:38:55 -0700552bool __clk_is_enabled(struct clk *clk);
Mike Turquetteb24764902012-03-15 23:11:19 -0700553struct clk *__clk_lookup(const char *name);
James Hogane366fdd2013-07-29 12:25:02 +0100554long __clk_mux_determine_rate(struct clk_hw *hw, unsigned long rate,
555 unsigned long *best_parent_rate,
556 struct clk **best_parent_p);
Mike Turquetteb24764902012-03-15 23:11:19 -0700557
558/*
559 * FIXME clock api without lock protection
560 */
561int __clk_prepare(struct clk *clk);
562void __clk_unprepare(struct clk *clk);
563void __clk_reparent(struct clk *clk, struct clk *new_parent);
564unsigned long __clk_round_rate(struct clk *clk, unsigned long rate);
565
Grant Likely766e6a42012-04-09 14:50:06 -0500566struct of_device_id;
567
568typedef void (*of_clk_init_cb_t)(struct device_node *);
569
Sebastian Hesselbarth0b151de2013-05-01 02:58:28 +0200570struct clk_onecell_data {
571 struct clk **clks;
572 unsigned int clk_num;
573};
574
Tero Kristo819b4862013-10-22 11:39:36 +0300575extern struct of_device_id __clk_of_table;
576
Rob Herring54196cc2014-05-08 16:09:24 -0500577#define CLK_OF_DECLARE(name, compat, fn) OF_DECLARE_1(clk, name, compat, fn)
Sebastian Hesselbarth0b151de2013-05-01 02:58:28 +0200578
579#ifdef CONFIG_OF
Grant Likely766e6a42012-04-09 14:50:06 -0500580int of_clk_add_provider(struct device_node *np,
581 struct clk *(*clk_src_get)(struct of_phandle_args *args,
582 void *data),
583 void *data);
584void of_clk_del_provider(struct device_node *np);
585struct clk *of_clk_src_simple_get(struct of_phandle_args *clkspec,
586 void *data);
Shawn Guo494bfec2012-08-22 21:36:27 +0800587struct clk *of_clk_src_onecell_get(struct of_phandle_args *clkspec, void *data);
Mike Turquettef6102742013-10-07 23:12:13 -0700588int of_clk_get_parent_count(struct device_node *np);
Grant Likely766e6a42012-04-09 14:50:06 -0500589const char *of_clk_get_parent_name(struct device_node *np, int index);
Prashant Gaikwadf2f6c252013-01-04 12:30:52 +0530590
Grant Likely766e6a42012-04-09 14:50:06 -0500591void of_clk_init(const struct of_device_id *matches);
592
Sebastian Hesselbarth0b151de2013-05-01 02:58:28 +0200593#else /* !CONFIG_OF */
Prashant Gaikwadf2f6c252013-01-04 12:30:52 +0530594
Sebastian Hesselbarth0b151de2013-05-01 02:58:28 +0200595static inline int of_clk_add_provider(struct device_node *np,
596 struct clk *(*clk_src_get)(struct of_phandle_args *args,
597 void *data),
598 void *data)
599{
600 return 0;
601}
602#define of_clk_del_provider(np) \
603 { while (0); }
604static inline struct clk *of_clk_src_simple_get(
605 struct of_phandle_args *clkspec, void *data)
606{
607 return ERR_PTR(-ENOENT);
608}
609static inline struct clk *of_clk_src_onecell_get(
610 struct of_phandle_args *clkspec, void *data)
611{
612 return ERR_PTR(-ENOENT);
613}
614static inline const char *of_clk_get_parent_name(struct device_node *np,
615 int index)
616{
617 return NULL;
618}
619#define of_clk_init(matches) \
620 { while (0); }
621#endif /* CONFIG_OF */
Gerhard Sittigaa514ce2013-07-22 14:14:40 +0200622
623/*
624 * wrap access to peripherals in accessor routines
625 * for improved portability across platforms
626 */
627
Gerhard Sittig6d8cdb62013-11-30 23:51:24 +0100628#if IS_ENABLED(CONFIG_PPC)
629
630static inline u32 clk_readl(u32 __iomem *reg)
631{
632 return ioread32be(reg);
633}
634
635static inline void clk_writel(u32 val, u32 __iomem *reg)
636{
637 iowrite32be(val, reg);
638}
639
640#else /* platform dependent I/O accessors */
641
Gerhard Sittigaa514ce2013-07-22 14:14:40 +0200642static inline u32 clk_readl(u32 __iomem *reg)
643{
644 return readl(reg);
645}
646
647static inline void clk_writel(u32 val, u32 __iomem *reg)
648{
649 writel(val, reg);
650}
651
Gerhard Sittig6d8cdb62013-11-30 23:51:24 +0100652#endif /* platform dependent I/O accessors */
653
Peter De Schrijverfb2b3c92014-06-26 18:00:53 +0300654#ifdef CONFIG_DEBUG_FS
655struct dentry *clk_debugfs_add_file(struct clk *clk, char *name, umode_t mode,
656 void *data, const struct file_operations *fops);
657#endif
658
Mike Turquetteb24764902012-03-15 23:11:19 -0700659#endif /* CONFIG_COMMON_CLK */
660#endif /* CLK_PROVIDER_H */