u-boot/include/clk-uclass.h

11 /* See clk.h for background documentation. */
13 #include <clk.h>
32 	int (*of_xlate)(struct clk *clock,
34 	int (*request)(struct clk *clock);
35 	ulong (*round_rate)(struct clk *clk, ulong rate);
36 	ulong (*get_rate)(struct clk *clk);
37 	ulong (*set_rate)(struct clk *clk, ulong rate);
38 	int (*set_parent)(struct clk *clk, struct clk *parent);
39 	int (*enable)(struct clk *clk);
40 	int (*disable)(struct clk *clk);
74 int of_xlate(struct clk *clock, struct ofnode_phandle_args *args);
97 int request(struct clk *clock);
101  * @clk:	The clock to query.
109  *     rounded = round_rate(clk, rate)
110  *     new_rate = set_rate(clk, rate)
118 ulong round_rate(struct clk *clk, ulong rate);
122  * @clk:	The clock to query.
128  *   disable(clk)
129  *   rate = get_rate(clk)
130  *   enable(clk)
131  *   assert(get_rate(clk) == rate)
134  * * The rate of @clk
135  * * -%ENOSYS if this function is not implemented for @clk
136  * * -%ENOENT if @clk->id is invalid. Prefer using an assert instead, and doing
141 ulong get_rate(struct clk *clk);
145  * @clk:	The clock to manipulate.
148  * Set the rate of @clk to @rate. The actual rate may be rounded. However,
163  * * -%ENOSYS if this function is not implemented for @clk
164  * * -%ENOENT if @clk->id is invalid. Prefer using an assert instead, and doing
166  * * -%EINVAL if @rate is not valid for @clk.
170 ulong set_rate(struct clk *clk, ulong rate);
174  * @clk:        The clock to manipulate.
177  * Set the current parent of @clk to @parent. The rate of the clock may be
178  * modified by this call. If @clk was enabled before this function, it should
184  * * -%ENOSYS if this function is not implemented for @clk
185  * * -%ENOENT if @clk->id or @parent->id is invalid. Prefer using an assert
187  * * -%EINVAL if @parent is not a valid parent for @clk.
191 int set_parent(struct clk *clk, struct clk *parent);
195  * @clk:	The clock to manipulate.
202  * * -%ENOSYS if this function is not implemented for @clk
203  * * -%ENOENT if @clk->id is invalid. Prefer using an assert instead, and doing
208 int enable(struct clk *clk);
212  * @clk:	The clock to manipulate.
218  * * -%ENOSYS if this function is not implemented for @clk
219  * * -%ENOENT if @clk->id is invalid. Prefer using an assert instead, and doing
224 int disable(struct clk *clk);
230  * If present, this function is called by "clk dump" command for each