mmc: core: SDXC speed class support
[linux-2.6.git] / include / linux / clk.h
1 /*
2  *  linux/include/linux/clk.h
3  *
4  *  Copyright (C) 2004 ARM Limited.
5  *  Written by Deep Blue Solutions Limited.
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_H
12 #define __LINUX_CLK_H
13
14 struct device;
15
16 /*
17  * The base API.
18  */
19
20
21 /*
22  * struct clk - an machine class defined object / cookie.
23  */
24 struct clk;
25
26 /**
27  * clk_get - lookup and obtain a reference to a clock producer.
28  * @dev: device for clock "consumer"
29  * @id: clock comsumer ID
30  *
31  * Returns a struct clk corresponding to the clock producer, or
32  * valid IS_ERR() condition containing errno.  The implementation
33  * uses @dev and @id to determine the clock consumer, and thereby
34  * the clock producer.  (IOW, @id may be identical strings, but
35  * clk_get may return different clock producers depending on @dev.)
36  *
37  * Drivers must assume that the clock source is not enabled.
38  *
39  * clk_get should not be called from within interrupt context.
40  */
41 struct clk *clk_get(struct device *dev, const char *id);
42
43 /**
44  * devm_clk_get - lookup and obtain a managed reference to a clock producer.
45  * @dev: device for clock "consumer"
46  * @id: clock comsumer ID
47  *
48  * Returns a struct clk corresponding to the clock producer, or
49  * valid IS_ERR() condition containing errno.  The implementation
50  * uses @dev and @id to determine the clock consumer, and thereby
51  * the clock producer.  (IOW, @id may be identical strings, but
52  * clk_get may return different clock producers depending on @dev.)
53  *
54  * Drivers must assume that the clock source is not enabled.
55  *
56  * devm_clk_get should not be called from within interrupt context.
57  *
58  * The clock will automatically be freed when the device is unbound
59  * from the bus.
60  */
61 struct clk *devm_clk_get(struct device *dev, const char *id);
62
63 /**
64  * clk_enable - inform the system when the clock source should be running.
65  * @clk: clock source
66  *
67  * If the clock can not be enabled/disabled, this should return success.
68  *
69  * Returns success (0) or negative errno.
70  */
71 int clk_enable(struct clk *clk);
72
73 /**
74  * clk_disable - inform the system when the clock source is no longer required.
75  * @clk: clock source
76  *
77  * Inform the system that a clock source is no longer required by
78  * a driver and may be shut down.
79  *
80  * Implementation detail: if the clock source is shared between
81  * multiple drivers, clk_enable() calls must be balanced by the
82  * same number of clk_disable() calls for the clock source to be
83  * disabled.
84  */
85 void clk_disable(struct clk *clk);
86
87 /**
88  * clk_get_rate - obtain the current clock rate (in Hz) for a clock source.
89  *                This is only valid once the clock source has been enabled.
90  * @clk: clock source
91  */
92 unsigned long clk_get_rate(struct clk *clk);
93
94 /**
95  * clk_put      - "free" the clock source
96  * @clk: clock source
97  *
98  * Note: drivers must ensure that all clk_enable calls made on this
99  * clock source are balanced by clk_disable calls prior to calling
100  * this function.
101  *
102  * clk_put should not be called from within interrupt context.
103  */
104 void clk_put(struct clk *clk);
105
106 /**
107  * devm_clk_put - "free" a managed clock source
108  * @dev: device used to acuqire the clock
109  * @clk: clock source acquired with devm_clk_get()
110  *
111  * Note: drivers must ensure that all clk_enable calls made on this
112  * clock source are balanced by clk_disable calls prior to calling
113  * this function.
114  *
115  * clk_put should not be called from within interrupt context.
116  */
117 void devm_clk_put(struct device *dev, struct clk *clk);
118
119 /*
120  * The remaining APIs are optional for machine class support.
121  */
122
123
124 /**
125  * clk_round_rate - adjust a rate to the exact rate a clock can provide
126  * @clk: clock source
127  * @rate: desired clock rate in Hz
128  *
129  * Returns rounded clock rate in Hz, or negative errno.
130  */
131 long clk_round_rate(struct clk *clk, unsigned long rate);
132  
133 /**
134  * clk_set_rate - set the clock rate for a clock source
135  * @clk: clock source
136  * @rate: desired clock rate in Hz
137  *
138  * Returns success (0) or negative errno.
139  */
140 int clk_set_rate(struct clk *clk, unsigned long rate);
141  
142 /**
143  * clk_set_parent - set the parent clock source for this clock
144  * @clk: clock source
145  * @parent: parent clock source
146  *
147  * Returns success (0) or negative errno.
148  */
149 int clk_set_parent(struct clk *clk, struct clk *parent);
150
151 /**
152  * clk_get_parent - get the parent clock source for this clock
153  * @clk: clock source
154  *
155  * Returns struct clk corresponding to parent clock source, or
156  * valid IS_ERR() condition containing errno.
157  */
158 struct clk *clk_get_parent(struct clk *clk);
159
160 /**
161  * clk_get_sys - get a clock based upon the device name
162  * @dev_id: device name
163  * @con_id: connection ID
164  *
165  * Returns a struct clk corresponding to the clock producer, or
166  * valid IS_ERR() condition containing errno.  The implementation
167  * uses @dev_id and @con_id to determine the clock consumer, and
168  * thereby the clock producer. In contrast to clk_get() this function
169  * takes the device name instead of the device itself for identification.
170  *
171  * Drivers must assume that the clock source is not enabled.
172  *
173  * clk_get_sys should not be called from within interrupt context.
174  */
175 struct clk *clk_get_sys(const char *dev_id, const char *con_id);
176
177 /**
178  * clk_add_alias - add a new clock alias
179  * @alias: name for clock alias
180  * @alias_dev_name: device name
181  * @id: platform specific clock name
182  * @dev: device
183  *
184  * Allows using generic clock names for drivers by adding a new alias.
185  * Assumes clkdev, see clkdev.h for more info.
186  */
187 int clk_add_alias(const char *alias, const char *alias_dev_name, char *id,
188                         struct device *dev);
189
190 #endif