]>
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, | |
f59c8f9f MB |
35 | /* The regulator is enabled but not regulating */ |
36 | REGULATOR_STATUS_BYPASS, | |
1beaf762 KG |
37 | /* in case that any other status doesn't apply */ |
38 | REGULATOR_STATUS_UNDEFINED, | |
853116a1 DB |
39 | }; |
40 | ||
571a354b LG |
41 | /** |
42 | * struct regulator_ops - regulator operations. | |
43 | * | |
3b2a6061 DB |
44 | * @enable: Configure the regulator as enabled. |
45 | * @disable: Configure the regulator as disabled. | |
d87b969d WS |
46 | * @is_enabled: Return 1 if the regulator is enabled, 0 if not. |
47 | * May also return negative errno. | |
c8e7e464 MB |
48 | * |
49 | * @set_voltage: Set the voltage for the regulator within the range specified. | |
50 | * The driver should select the voltage closest to min_uV. | |
e8eef82b MB |
51 | * @set_voltage_sel: Set the voltage for the regulator using the specified |
52 | * selector. | |
e843fc46 | 53 | * @map_voltage: Convert a voltage into a selector |
c8e7e464 | 54 | * @get_voltage: Return the currently configured voltage for the regulator. |
476c2d83 MB |
55 | * @get_voltage_sel: Return the currently configured voltage selector for the |
56 | * regulator. | |
4367cfdc DB |
57 | * @list_voltage: Return one of the supported voltages, in microvolts; zero |
58 | * if the selector indicates a voltage that is unusable on this system; | |
59 | * or negative errno. Selectors range from zero to one less than | |
60 | * regulator_desc.n_voltages. Voltages may be reported in any order. | |
c8e7e464 | 61 | * |
c8e7e464 | 62 | * @set_current_limit: Configure a limit for a current-limited regulator. |
89009e18 | 63 | * The driver should select the current closest to max_uA. |
3b2a6061 | 64 | * @get_current_limit: Get the configured limit for a current-limited regulator. |
c8e7e464 | 65 | * |
9f653251 | 66 | * @set_mode: Set the configured operating mode for the regulator. |
3b2a6061 DB |
67 | * @get_mode: Get the configured operating mode for the regulator. |
68 | * @get_status: Return actual (not as-configured) status of regulator, as a | |
69 | * REGULATOR_STATUS value (or negative errno) | |
c8e7e464 MB |
70 | * @get_optimum_mode: Get the most efficient operating mode for the regulator |
71 | * when running with the specified parameters. | |
72 | * | |
f59c8f9f MB |
73 | * @set_bypass: Set the regulator in bypass mode. |
74 | * @get_bypass: Get the regulator bypass mode state. | |
75 | * | |
31aae2be | 76 | * @enable_time: Time taken for the regulator voltage output voltage to |
77af1b26 | 77 | * stabilise after being enabled, in microseconds. |
6f0b2c69 YSB |
78 | * @set_ramp_delay: Set the ramp delay for the regulator. The driver should |
79 | * select ramp delay equal to or less than(closest) ramp_delay. | |
77af1b26 LW |
80 | * @set_voltage_time_sel: Time taken for the regulator voltage output voltage |
81 | * to stabilise after being set to a new value, in microseconds. | |
82 | * The function provides the from and to voltage selector, the | |
83 | * function should return the worst case. | |
31aae2be | 84 | * |
c8e7e464 MB |
85 | * @set_suspend_voltage: Set the voltage for the regulator when the system |
86 | * is suspended. | |
87 | * @set_suspend_enable: Mark the regulator as enabled when the system is | |
88 | * suspended. | |
89 | * @set_suspend_disable: Mark the regulator as disabled when the system is | |
90 | * suspended. | |
91 | * @set_suspend_mode: Set the operating mode for the regulator when the | |
92 | * system is suspended. | |
3b2a6061 DB |
93 | * |
94 | * This struct describes regulator operations which can be implemented by | |
95 | * regulator chip drivers. | |
571a354b LG |
96 | */ |
97 | struct regulator_ops { | |
98 | ||
4367cfdc DB |
99 | /* enumerate supported voltages */ |
100 | int (*list_voltage) (struct regulator_dev *, unsigned selector); | |
101 | ||
571a354b | 102 | /* get/set regulator voltage */ |
3a93f2a9 MB |
103 | int (*set_voltage) (struct regulator_dev *, int min_uV, int max_uV, |
104 | unsigned *selector); | |
e843fc46 | 105 | int (*map_voltage)(struct regulator_dev *, int min_uV, int max_uV); |
e8eef82b | 106 | int (*set_voltage_sel) (struct regulator_dev *, unsigned selector); |
571a354b | 107 | int (*get_voltage) (struct regulator_dev *); |
476c2d83 | 108 | int (*get_voltage_sel) (struct regulator_dev *); |
571a354b LG |
109 | |
110 | /* get/set regulator current */ | |
111 | int (*set_current_limit) (struct regulator_dev *, | |
112 | int min_uA, int max_uA); | |
113 | int (*get_current_limit) (struct regulator_dev *); | |
114 | ||
115 | /* enable/disable regulator */ | |
116 | int (*enable) (struct regulator_dev *); | |
117 | int (*disable) (struct regulator_dev *); | |
118 | int (*is_enabled) (struct regulator_dev *); | |
119 | ||
fde297bb | 120 | /* get/set regulator operating mode (defined in consumer.h) */ |
571a354b LG |
121 | int (*set_mode) (struct regulator_dev *, unsigned int mode); |
122 | unsigned int (*get_mode) (struct regulator_dev *); | |
123 | ||
77af1b26 | 124 | /* Time taken to enable or set voltage on the regulator */ |
31aae2be | 125 | int (*enable_time) (struct regulator_dev *); |
6f0b2c69 | 126 | int (*set_ramp_delay) (struct regulator_dev *, int ramp_delay); |
77af1b26 LW |
127 | int (*set_voltage_time_sel) (struct regulator_dev *, |
128 | unsigned int old_selector, | |
129 | unsigned int new_selector); | |
31aae2be | 130 | |
853116a1 DB |
131 | /* report regulator status ... most other accessors report |
132 | * control inputs, this reports results of combining inputs | |
133 | * from Linux (and other sources) with the actual load. | |
3b2a6061 | 134 | * returns REGULATOR_STATUS_* or negative errno. |
853116a1 DB |
135 | */ |
136 | int (*get_status)(struct regulator_dev *); | |
137 | ||
571a354b LG |
138 | /* get most efficient regulator operating mode for load */ |
139 | unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV, | |
140 | int output_uV, int load_uA); | |
141 | ||
f59c8f9f MB |
142 | /* control and report on bypass mode */ |
143 | int (*set_bypass)(struct regulator_dev *dev, bool enable); | |
144 | int (*get_bypass)(struct regulator_dev *dev, bool *enable); | |
145 | ||
571a354b | 146 | /* the operations below are for configuration of regulator state when |
3de89609 | 147 | * its parent PMIC enters a global STANDBY/HIBERNATE state */ |
571a354b LG |
148 | |
149 | /* set regulator suspend voltage */ | |
150 | int (*set_suspend_voltage) (struct regulator_dev *, int uV); | |
151 | ||
152 | /* enable/disable regulator in suspend state */ | |
153 | int (*set_suspend_enable) (struct regulator_dev *); | |
154 | int (*set_suspend_disable) (struct regulator_dev *); | |
155 | ||
fde297bb | 156 | /* set regulator suspend operating mode (defined in consumer.h) */ |
571a354b LG |
157 | int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode); |
158 | }; | |
159 | ||
160 | /* | |
161 | * Regulators can either control voltage or current. | |
162 | */ | |
163 | enum regulator_type { | |
164 | REGULATOR_VOLTAGE, | |
165 | REGULATOR_CURRENT, | |
166 | }; | |
167 | ||
168 | /** | |
c172708d | 169 | * struct regulator_desc - Static regulator descriptor |
571a354b | 170 | * |
c172708d MB |
171 | * Each regulator registered with the core is described with a |
172 | * structure of this type and a struct regulator_config. This | |
173 | * structure contains the non-varying parts of the regulator | |
174 | * description. | |
c8e7e464 MB |
175 | * |
176 | * @name: Identifying name for the regulator. | |
69511a45 | 177 | * @supply_name: Identifying the regulator supply |
c8e7e464 MB |
178 | * @id: Numerical identifier for the regulator. |
179 | * @ops: Regulator operations table. | |
0ba4887c | 180 | * @irq: Interrupt number for the regulator. |
c8e7e464 MB |
181 | * @type: Indicates if the regulator is a voltage or current regulator. |
182 | * @owner: Module providing the regulator, used for refcounting. | |
bca7bbff | 183 | * |
bd7a2b60 PM |
184 | * @continuous_voltage_range: Indicates if the regulator can set any |
185 | * voltage within constrains range. | |
bca7bbff MB |
186 | * @n_voltages: Number of selectors available for ops.list_voltage(). |
187 | * | |
188 | * @min_uV: Voltage given by the lowest selector (if linear mapping) | |
189 | * @uV_step: Voltage increase with each selector (if linear mapping) | |
33234e79 | 190 | * @linear_min_sel: Minimal selector for starting linear mapping |
ea38d13f | 191 | * @ramp_delay: Time to settle down after voltage change (unit: uV/us) |
cffc9592 | 192 | * @volt_table: Voltage mapping table (if table based mapping) |
bca7bbff | 193 | * |
4ab5b3d9 MB |
194 | * @vsel_reg: Register for selector when using regulator_regmap_X_voltage_ |
195 | * @vsel_mask: Mask for register bitfield used for selector | |
cd6dffb4 MB |
196 | * @enable_reg: Register for control when using regmap enable/disable ops |
197 | * @enable_mask: Mask for control when using regmap enable/disable ops | |
79511ed3 MB |
198 | * |
199 | * @enable_time: Time taken for initial enable of regulator (in uS). | |
571a354b LG |
200 | */ |
201 | struct regulator_desc { | |
202 | const char *name; | |
69511a45 | 203 | const char *supply_name; |
571a354b | 204 | int id; |
bd7a2b60 | 205 | bool continuous_voltage_range; |
4367cfdc | 206 | unsigned n_voltages; |
571a354b LG |
207 | struct regulator_ops *ops; |
208 | int irq; | |
209 | enum regulator_type type; | |
210 | struct module *owner; | |
4ab5b3d9 | 211 | |
bca7bbff MB |
212 | unsigned int min_uV; |
213 | unsigned int uV_step; | |
33234e79 | 214 | unsigned int linear_min_sel; |
98a175b6 | 215 | unsigned int ramp_delay; |
bca7bbff | 216 | |
cffc9592 AL |
217 | const unsigned int *volt_table; |
218 | ||
4ab5b3d9 MB |
219 | unsigned int vsel_reg; |
220 | unsigned int vsel_mask; | |
cd6dffb4 MB |
221 | unsigned int enable_reg; |
222 | unsigned int enable_mask; | |
df367931 MB |
223 | unsigned int bypass_reg; |
224 | unsigned int bypass_mask; | |
79511ed3 MB |
225 | |
226 | unsigned int enable_time; | |
571a354b LG |
227 | }; |
228 | ||
c172708d MB |
229 | /** |
230 | * struct regulator_config - Dynamic regulator descriptor | |
231 | * | |
232 | * Each regulator registered with the core is described with a | |
233 | * structure of this type and a struct regulator_desc. This structure | |
234 | * contains the runtime variable parts of the regulator description. | |
235 | * | |
236 | * @dev: struct device for the regulator | |
237 | * @init_data: platform provided init data, passed through by driver | |
238 | * @driver_data: private regulator data | |
239 | * @of_node: OpenFirmware node to parse for device tree bindings (may be | |
240 | * NULL). | |
380a0e6f MB |
241 | * @regmap: regmap to use for core regmap helpers if dev_get_regulator() is |
242 | * insufficient. | |
65f73508 MB |
243 | * @ena_gpio: GPIO controlling regulator enable. |
244 | * @ena_gpio_invert: Sense for GPIO enable control. | |
245 | * @ena_gpio_flags: Flags to use when calling gpio_request_one() | |
c172708d MB |
246 | */ |
247 | struct regulator_config { | |
248 | struct device *dev; | |
249 | const struct regulator_init_data *init_data; | |
250 | void *driver_data; | |
251 | struct device_node *of_node; | |
65b19ce6 | 252 | struct regmap *regmap; |
65f73508 MB |
253 | |
254 | int ena_gpio; | |
255 | unsigned int ena_gpio_invert:1; | |
256 | unsigned int ena_gpio_flags; | |
c172708d MB |
257 | }; |
258 | ||
1fa9ad52 MB |
259 | /* |
260 | * struct regulator_dev | |
261 | * | |
262 | * Voltage / Current regulator class device. One for each | |
263 | * regulator. | |
264 | * | |
265 | * This should *not* be used directly by anything except the regulator | |
266 | * core and notification injection (which should take the mutex and do | |
267 | * no other direct access). | |
268 | */ | |
269 | struct regulator_dev { | |
65f26846 | 270 | const struct regulator_desc *desc; |
5ffbd136 | 271 | int exclusive; |
1130e5b3 MB |
272 | u32 use_count; |
273 | u32 open_count; | |
f59c8f9f | 274 | u32 bypass_count; |
1fa9ad52 MB |
275 | |
276 | /* lists we belong to */ | |
277 | struct list_head list; /* list of all regulators */ | |
1fa9ad52 MB |
278 | |
279 | /* lists we own */ | |
280 | struct list_head consumer_list; /* consumers we supply */ | |
1fa9ad52 MB |
281 | |
282 | struct blocking_notifier_head notifier; | |
283 | struct mutex mutex; /* consumer lock */ | |
284 | struct module *owner; | |
285 | struct device dev; | |
286 | struct regulation_constraints *constraints; | |
3801b86a | 287 | struct regulator *supply; /* for tree */ |
65b19ce6 | 288 | struct regmap *regmap; |
1fa9ad52 | 289 | |
da07ecd9 MB |
290 | struct delayed_work disable_work; |
291 | int deferred_disables; | |
292 | ||
1fa9ad52 | 293 | void *reg_data; /* regulator_dev data */ |
1130e5b3 | 294 | |
1130e5b3 | 295 | struct dentry *debugfs; |
65f73508 MB |
296 | |
297 | int ena_gpio; | |
298 | unsigned int ena_gpio_invert:1; | |
299 | unsigned int ena_gpio_state:1; | |
1fa9ad52 MB |
300 | }; |
301 | ||
65f26846 MB |
302 | struct regulator_dev * |
303 | regulator_register(const struct regulator_desc *regulator_desc, | |
c172708d | 304 | const struct regulator_config *config); |
571a354b LG |
305 | void regulator_unregister(struct regulator_dev *rdev); |
306 | ||
307 | int regulator_notifier_call_chain(struct regulator_dev *rdev, | |
308 | unsigned long event, void *data); | |
309 | ||
310 | void *rdev_get_drvdata(struct regulator_dev *rdev); | |
a5766f11 | 311 | struct device *rdev_get_dev(struct regulator_dev *rdev); |
571a354b LG |
312 | int rdev_get_id(struct regulator_dev *rdev); |
313 | ||
be721979 MB |
314 | int regulator_mode_to_status(unsigned int); |
315 | ||
bca7bbff MB |
316 | int regulator_list_voltage_linear(struct regulator_dev *rdev, |
317 | unsigned int selector); | |
cffc9592 AL |
318 | int regulator_list_voltage_table(struct regulator_dev *rdev, |
319 | unsigned int selector); | |
bca7bbff MB |
320 | int regulator_map_voltage_linear(struct regulator_dev *rdev, |
321 | int min_uV, int max_uV); | |
e843fc46 MB |
322 | int regulator_map_voltage_iterate(struct regulator_dev *rdev, |
323 | int min_uV, int max_uV); | |
4ab5b3d9 MB |
324 | int regulator_get_voltage_sel_regmap(struct regulator_dev *rdev); |
325 | int regulator_set_voltage_sel_regmap(struct regulator_dev *rdev, unsigned sel); | |
cd6dffb4 MB |
326 | int regulator_is_enabled_regmap(struct regulator_dev *rdev); |
327 | int regulator_enable_regmap(struct regulator_dev *rdev); | |
328 | int regulator_disable_regmap(struct regulator_dev *rdev); | |
98a175b6 YSB |
329 | int regulator_set_voltage_time_sel(struct regulator_dev *rdev, |
330 | unsigned int old_selector, | |
331 | unsigned int new_selector); | |
df367931 MB |
332 | int regulator_set_bypass_regmap(struct regulator_dev *rdev, bool enable); |
333 | int regulator_get_bypass_regmap(struct regulator_dev *rdev, bool *enable); | |
4ab5b3d9 | 334 | |
a5766f11 LG |
335 | void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data); |
336 | ||
571a354b | 337 | #endif |