Commit | Line | Data |
---|---|---|
571a354b LG |
1 | /* |
2 | * driver.h -- SoC Regulator driver support. | |
3 | * | |
4 | * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC. | |
5 | * | |
1dd68f01 | 6 | * Author: Liam Girdwood <lrg@slimlogic.co.uk> |
571a354b LG |
7 | * |
8 | * This program is free software; you can redistribute it and/or modify | |
9 | * it under the terms of the GNU General Public License version 2 as | |
10 | * published by the Free Software Foundation. | |
11 | * | |
12 | * Regulator Driver Interface. | |
13 | */ | |
14 | ||
15 | #ifndef __LINUX_REGULATOR_DRIVER_H_ | |
16 | #define __LINUX_REGULATOR_DRIVER_H_ | |
17 | ||
18 | #include <linux/device.h> | |
ced55d4e | 19 | #include <linux/notifier.h> |
571a354b LG |
20 | #include <linux/regulator/consumer.h> |
21 | ||
65b19ce6 | 22 | struct regmap; |
571a354b | 23 | struct regulator_dev; |
a5766f11 | 24 | struct regulator_init_data; |
571a354b | 25 | |
853116a1 DB |
26 | enum regulator_status { |
27 | REGULATOR_STATUS_OFF, | |
28 | REGULATOR_STATUS_ON, | |
29 | REGULATOR_STATUS_ERROR, | |
30 | /* fast/normal/idle/standby are flavors of "on" */ | |
31 | REGULATOR_STATUS_FAST, | |
32 | REGULATOR_STATUS_NORMAL, | |
33 | REGULATOR_STATUS_IDLE, | |
34 | REGULATOR_STATUS_STANDBY, | |
35 | }; | |
36 | ||
571a354b LG |
37 | /** |
38 | * struct regulator_ops - regulator operations. | |
39 | * | |
3b2a6061 DB |
40 | * @enable: Configure the regulator as enabled. |
41 | * @disable: Configure the regulator as disabled. | |
d87b969d WS |
42 | * @is_enabled: Return 1 if the regulator is enabled, 0 if not. |
43 | * May also return negative errno. | |
c8e7e464 MB |
44 | * |
45 | * @set_voltage: Set the voltage for the regulator within the range specified. | |
46 | * The driver should select the voltage closest to min_uV. | |
e8eef82b MB |
47 | * @set_voltage_sel: Set the voltage for the regulator using the specified |
48 | * selector. | |
e843fc46 | 49 | * @map_voltage: Convert a voltage into a selector |
c8e7e464 | 50 | * @get_voltage: Return the currently configured voltage for the regulator. |
476c2d83 MB |
51 | * @get_voltage_sel: Return the currently configured voltage selector for the |
52 | * regulator. | |
4367cfdc DB |
53 | * @list_voltage: Return one of the supported voltages, in microvolts; zero |
54 | * if the selector indicates a voltage that is unusable on this system; | |
55 | * or negative errno. Selectors range from zero to one less than | |
56 | * regulator_desc.n_voltages. Voltages may be reported in any order. | |
c8e7e464 | 57 | * |
c8e7e464 | 58 | * @set_current_limit: Configure a limit for a current-limited regulator. |
3b2a6061 | 59 | * @get_current_limit: Get the configured limit for a current-limited regulator. |
c8e7e464 | 60 | * |
9f653251 | 61 | * @set_mode: Set the configured operating mode for the regulator. |
3b2a6061 DB |
62 | * @get_mode: Get the configured operating mode for the regulator. |
63 | * @get_status: Return actual (not as-configured) status of regulator, as a | |
64 | * REGULATOR_STATUS value (or negative errno) | |
c8e7e464 MB |
65 | * @get_optimum_mode: Get the most efficient operating mode for the regulator |
66 | * when running with the specified parameters. | |
67 | * | |
31aae2be | 68 | * @enable_time: Time taken for the regulator voltage output voltage to |
77af1b26 LW |
69 | * stabilise after being enabled, in microseconds. |
70 | * @set_voltage_time_sel: Time taken for the regulator voltage output voltage | |
71 | * to stabilise after being set to a new value, in microseconds. | |
72 | * The function provides the from and to voltage selector, the | |
73 | * function should return the worst case. | |
31aae2be | 74 | * |
c8e7e464 MB |
75 | * @set_suspend_voltage: Set the voltage for the regulator when the system |
76 | * is suspended. | |
77 | * @set_suspend_enable: Mark the regulator as enabled when the system is | |
78 | * suspended. | |
79 | * @set_suspend_disable: Mark the regulator as disabled when the system is | |
80 | * suspended. | |
81 | * @set_suspend_mode: Set the operating mode for the regulator when the | |
82 | * system is suspended. | |
3b2a6061 DB |
83 | * |
84 | * This struct describes regulator operations which can be implemented by | |
85 | * regulator chip drivers. | |
571a354b LG |
86 | */ |
87 | struct regulator_ops { | |
88 | ||
4367cfdc DB |
89 | /* enumerate supported voltages */ |
90 | int (*list_voltage) (struct regulator_dev *, unsigned selector); | |
91 | ||
571a354b | 92 | /* get/set regulator voltage */ |
3a93f2a9 MB |
93 | int (*set_voltage) (struct regulator_dev *, int min_uV, int max_uV, |
94 | unsigned *selector); | |
e843fc46 | 95 | int (*map_voltage)(struct regulator_dev *, int min_uV, int max_uV); |
e8eef82b | 96 | int (*set_voltage_sel) (struct regulator_dev *, unsigned selector); |
571a354b | 97 | int (*get_voltage) (struct regulator_dev *); |
476c2d83 | 98 | int (*get_voltage_sel) (struct regulator_dev *); |
571a354b LG |
99 | |
100 | /* get/set regulator current */ | |
101 | int (*set_current_limit) (struct regulator_dev *, | |
102 | int min_uA, int max_uA); | |
103 | int (*get_current_limit) (struct regulator_dev *); | |
104 | ||
105 | /* enable/disable regulator */ | |
106 | int (*enable) (struct regulator_dev *); | |
107 | int (*disable) (struct regulator_dev *); | |
108 | int (*is_enabled) (struct regulator_dev *); | |
109 | ||
fde297bb | 110 | /* get/set regulator operating mode (defined in consumer.h) */ |
571a354b LG |
111 | int (*set_mode) (struct regulator_dev *, unsigned int mode); |
112 | unsigned int (*get_mode) (struct regulator_dev *); | |
113 | ||
77af1b26 | 114 | /* Time taken to enable or set voltage on the regulator */ |
31aae2be | 115 | int (*enable_time) (struct regulator_dev *); |
77af1b26 LW |
116 | int (*set_voltage_time_sel) (struct regulator_dev *, |
117 | unsigned int old_selector, | |
118 | unsigned int new_selector); | |
31aae2be | 119 | |
853116a1 DB |
120 | /* report regulator status ... most other accessors report |
121 | * control inputs, this reports results of combining inputs | |
122 | * from Linux (and other sources) with the actual load. | |
3b2a6061 | 123 | * returns REGULATOR_STATUS_* or negative errno. |
853116a1 DB |
124 | */ |
125 | int (*get_status)(struct regulator_dev *); | |
126 | ||
571a354b LG |
127 | /* get most efficient regulator operating mode for load */ |
128 | unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV, | |
129 | int output_uV, int load_uA); | |
130 | ||
131 | /* the operations below are for configuration of regulator state when | |
3de89609 | 132 | * its parent PMIC enters a global STANDBY/HIBERNATE state */ |
571a354b LG |
133 | |
134 | /* set regulator suspend voltage */ | |
135 | int (*set_suspend_voltage) (struct regulator_dev *, int uV); | |
136 | ||
137 | /* enable/disable regulator in suspend state */ | |
138 | int (*set_suspend_enable) (struct regulator_dev *); | |
139 | int (*set_suspend_disable) (struct regulator_dev *); | |
140 | ||
fde297bb | 141 | /* set regulator suspend operating mode (defined in consumer.h) */ |
571a354b LG |
142 | int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode); |
143 | }; | |
144 | ||
145 | /* | |
146 | * Regulators can either control voltage or current. | |
147 | */ | |
148 | enum regulator_type { | |
149 | REGULATOR_VOLTAGE, | |
150 | REGULATOR_CURRENT, | |
151 | }; | |
152 | ||
153 | /** | |
c172708d | 154 | * struct regulator_desc - Static regulator descriptor |
571a354b | 155 | * |
c172708d MB |
156 | * Each regulator registered with the core is described with a |
157 | * structure of this type and a struct regulator_config. This | |
158 | * structure contains the non-varying parts of the regulator | |
159 | * description. | |
c8e7e464 MB |
160 | * |
161 | * @name: Identifying name for the regulator. | |
69511a45 | 162 | * @supply_name: Identifying the regulator supply |
c8e7e464 MB |
163 | * @id: Numerical identifier for the regulator. |
164 | * @ops: Regulator operations table. | |
0ba4887c | 165 | * @irq: Interrupt number for the regulator. |
c8e7e464 MB |
166 | * @type: Indicates if the regulator is a voltage or current regulator. |
167 | * @owner: Module providing the regulator, used for refcounting. | |
bca7bbff MB |
168 | * |
169 | * @n_voltages: Number of selectors available for ops.list_voltage(). | |
170 | * | |
171 | * @min_uV: Voltage given by the lowest selector (if linear mapping) | |
172 | * @uV_step: Voltage increase with each selector (if linear mapping) | |
98a175b6 | 173 | * @ramp_delay: Time to settle down after voltage change (unit: mV/us) |
cffc9592 | 174 | * @volt_table: Voltage mapping table (if table based mapping) |
bca7bbff | 175 | * |
4ab5b3d9 MB |
176 | * @vsel_reg: Register for selector when using regulator_regmap_X_voltage_ |
177 | * @vsel_mask: Mask for register bitfield used for selector | |
cd6dffb4 MB |
178 | * @enable_reg: Register for control when using regmap enable/disable ops |
179 | * @enable_mask: Mask for control when using regmap enable/disable ops | |
571a354b LG |
180 | */ |
181 | struct regulator_desc { | |
182 | const char *name; | |
69511a45 | 183 | const char *supply_name; |
571a354b | 184 | int id; |
4367cfdc | 185 | unsigned n_voltages; |
571a354b LG |
186 | struct regulator_ops *ops; |
187 | int irq; | |
188 | enum regulator_type type; | |
189 | struct module *owner; | |
4ab5b3d9 | 190 | |
bca7bbff MB |
191 | unsigned int min_uV; |
192 | unsigned int uV_step; | |
98a175b6 | 193 | unsigned int ramp_delay; |
bca7bbff | 194 | |
cffc9592 AL |
195 | const unsigned int *volt_table; |
196 | ||
4ab5b3d9 MB |
197 | unsigned int vsel_reg; |
198 | unsigned int vsel_mask; | |
cd6dffb4 MB |
199 | unsigned int enable_reg; |
200 | unsigned int enable_mask; | |
571a354b LG |
201 | }; |
202 | ||
c172708d MB |
203 | /** |
204 | * struct regulator_config - Dynamic regulator descriptor | |
205 | * | |
206 | * Each regulator registered with the core is described with a | |
207 | * structure of this type and a struct regulator_desc. This structure | |
208 | * contains the runtime variable parts of the regulator description. | |
209 | * | |
210 | * @dev: struct device for the regulator | |
211 | * @init_data: platform provided init data, passed through by driver | |
212 | * @driver_data: private regulator data | |
213 | * @of_node: OpenFirmware node to parse for device tree bindings (may be | |
214 | * NULL). | |
65b19ce6 | 215 | * @regmap: regmap to use for core regmap helpers |
c172708d MB |
216 | */ |
217 | struct regulator_config { | |
218 | struct device *dev; | |
219 | const struct regulator_init_data *init_data; | |
220 | void *driver_data; | |
221 | struct device_node *of_node; | |
65b19ce6 | 222 | struct regmap *regmap; |
c172708d MB |
223 | }; |
224 | ||
1fa9ad52 MB |
225 | /* |
226 | * struct regulator_dev | |
227 | * | |
228 | * Voltage / Current regulator class device. One for each | |
229 | * regulator. | |
230 | * | |
231 | * This should *not* be used directly by anything except the regulator | |
232 | * core and notification injection (which should take the mutex and do | |
233 | * no other direct access). | |
234 | */ | |
235 | struct regulator_dev { | |
65f26846 | 236 | const struct regulator_desc *desc; |
5ffbd136 | 237 | int exclusive; |
1130e5b3 MB |
238 | u32 use_count; |
239 | u32 open_count; | |
1fa9ad52 MB |
240 | |
241 | /* lists we belong to */ | |
242 | struct list_head list; /* list of all regulators */ | |
1fa9ad52 MB |
243 | |
244 | /* lists we own */ | |
245 | struct list_head consumer_list; /* consumers we supply */ | |
1fa9ad52 MB |
246 | |
247 | struct blocking_notifier_head notifier; | |
248 | struct mutex mutex; /* consumer lock */ | |
249 | struct module *owner; | |
250 | struct device dev; | |
251 | struct regulation_constraints *constraints; | |
3801b86a | 252 | struct regulator *supply; /* for tree */ |
65b19ce6 | 253 | struct regmap *regmap; |
1fa9ad52 | 254 | |
da07ecd9 MB |
255 | struct delayed_work disable_work; |
256 | int deferred_disables; | |
257 | ||
1fa9ad52 | 258 | void *reg_data; /* regulator_dev data */ |
1130e5b3 | 259 | |
1130e5b3 | 260 | struct dentry *debugfs; |
1fa9ad52 MB |
261 | }; |
262 | ||
65f26846 MB |
263 | struct regulator_dev * |
264 | regulator_register(const struct regulator_desc *regulator_desc, | |
c172708d | 265 | const struct regulator_config *config); |
571a354b LG |
266 | void regulator_unregister(struct regulator_dev *rdev); |
267 | ||
268 | int regulator_notifier_call_chain(struct regulator_dev *rdev, | |
269 | unsigned long event, void *data); | |
270 | ||
271 | void *rdev_get_drvdata(struct regulator_dev *rdev); | |
a5766f11 | 272 | struct device *rdev_get_dev(struct regulator_dev *rdev); |
571a354b LG |
273 | int rdev_get_id(struct regulator_dev *rdev); |
274 | ||
be721979 MB |
275 | int regulator_mode_to_status(unsigned int); |
276 | ||
bca7bbff MB |
277 | int regulator_list_voltage_linear(struct regulator_dev *rdev, |
278 | unsigned int selector); | |
cffc9592 AL |
279 | int regulator_list_voltage_table(struct regulator_dev *rdev, |
280 | unsigned int selector); | |
bca7bbff MB |
281 | int regulator_map_voltage_linear(struct regulator_dev *rdev, |
282 | int min_uV, int max_uV); | |
e843fc46 MB |
283 | int regulator_map_voltage_iterate(struct regulator_dev *rdev, |
284 | int min_uV, int max_uV); | |
4ab5b3d9 MB |
285 | int regulator_get_voltage_sel_regmap(struct regulator_dev *rdev); |
286 | int regulator_set_voltage_sel_regmap(struct regulator_dev *rdev, unsigned sel); | |
cd6dffb4 MB |
287 | int regulator_is_enabled_regmap(struct regulator_dev *rdev); |
288 | int regulator_enable_regmap(struct regulator_dev *rdev); | |
289 | int regulator_disable_regmap(struct regulator_dev *rdev); | |
98a175b6 YSB |
290 | int regulator_set_voltage_time_sel(struct regulator_dev *rdev, |
291 | unsigned int old_selector, | |
292 | unsigned int new_selector); | |
4ab5b3d9 | 293 | |
a5766f11 LG |
294 | void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data); |
295 | ||
571a354b | 296 | #endif |