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