1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
2 | /* |
3 | * driver.h -- SoC Regulator driver support. |
4 | * |
5 | * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC. |
6 | * |
7 | * Author: Liam Girdwood <lrg@slimlogic.co.uk> |
8 | * |
9 | * Regulator Driver Interface. |
10 | */ |
11 | |
12 | #ifndef __LINUX_REGULATOR_DRIVER_H_ |
13 | #define __LINUX_REGULATOR_DRIVER_H_ |
14 | |
15 | #include <linux/device.h> |
16 | #include <linux/linear_range.h> |
17 | #include <linux/notifier.h> |
18 | #include <linux/regulator/consumer.h> |
19 | #include <linux/ww_mutex.h> |
20 | |
21 | struct gpio_desc; |
22 | struct regmap; |
23 | struct regulator_dev; |
24 | struct regulator_config; |
25 | struct regulator_init_data; |
26 | struct regulator_enable_gpio; |
27 | |
28 | enum regulator_status { |
29 | REGULATOR_STATUS_OFF, |
30 | REGULATOR_STATUS_ON, |
31 | REGULATOR_STATUS_ERROR, |
32 | /* fast/normal/idle/standby are flavors of "on" */ |
33 | REGULATOR_STATUS_FAST, |
34 | REGULATOR_STATUS_NORMAL, |
35 | REGULATOR_STATUS_IDLE, |
36 | REGULATOR_STATUS_STANDBY, |
37 | /* The regulator is enabled but not regulating */ |
38 | REGULATOR_STATUS_BYPASS, |
39 | /* in case that any other status doesn't apply */ |
40 | REGULATOR_STATUS_UNDEFINED, |
41 | }; |
42 | |
43 | enum regulator_detection_severity { |
44 | /* Hardware shut down voltage outputs if condition is detected */ |
45 | REGULATOR_SEVERITY_PROT, |
46 | /* Hardware is probably damaged/inoperable */ |
47 | REGULATOR_SEVERITY_ERR, |
48 | /* Hardware is still recoverable but recovery action must be taken */ |
49 | REGULATOR_SEVERITY_WARN, |
50 | }; |
51 | |
52 | /* Initialize struct linear_range for regulators */ |
53 | #define REGULATOR_LINEAR_RANGE(_min_uV, _min_sel, _max_sel, _step_uV) \ |
54 | { \ |
55 | .min = _min_uV, \ |
56 | .min_sel = _min_sel, \ |
57 | .max_sel = _max_sel, \ |
58 | .step = _step_uV, \ |
59 | } |
60 | |
61 | /** |
62 | * struct regulator_ops - regulator operations. |
63 | * |
64 | * @enable: Configure the regulator as enabled. |
65 | * @disable: Configure the regulator as disabled. |
66 | * @is_enabled: Return 1 if the regulator is enabled, 0 if not. |
67 | * May also return negative errno. |
68 | * |
69 | * @set_voltage: Set the voltage for the regulator within the range specified. |
70 | * The driver should select the voltage closest to min_uV. |
71 | * @set_voltage_sel: Set the voltage for the regulator using the specified |
72 | * selector. |
73 | * @map_voltage: Convert a voltage into a selector |
74 | * @get_voltage: Return the currently configured voltage for the regulator; |
75 | * return -ENOTRECOVERABLE if regulator can't be read at |
76 | * bootup and hasn't been set yet. |
77 | * @get_voltage_sel: Return the currently configured voltage selector for the |
78 | * regulator; return -ENOTRECOVERABLE if regulator can't |
79 | * be read at bootup and hasn't been set yet. |
80 | * @list_voltage: Return one of the supported voltages, in microvolts; zero |
81 | * if the selector indicates a voltage that is unusable on this system; |
82 | * or negative errno. Selectors range from zero to one less than |
83 | * regulator_desc.n_voltages. Voltages may be reported in any order. |
84 | * |
85 | * @set_current_limit: Configure a limit for a current-limited regulator. |
86 | * The driver should select the current closest to max_uA. |
87 | * @get_current_limit: Get the configured limit for a current-limited regulator. |
88 | * @set_input_current_limit: Configure an input limit. |
89 | * |
90 | * @set_over_current_protection: Support enabling of and setting limits for over |
91 | * current situation detection. Detection can be configured for three |
92 | * levels of severity. |
93 | * |
94 | * - REGULATOR_SEVERITY_PROT should automatically shut down the regulator(s). |
95 | * |
96 | * - REGULATOR_SEVERITY_ERR should indicate that over-current situation is |
97 | * caused by an unrecoverable error but HW does not perform |
98 | * automatic shut down. |
99 | * |
100 | * - REGULATOR_SEVERITY_WARN should indicate situation where hardware is |
101 | * still believed to not be damaged but that a board sepcific |
102 | * recovery action is needed. If lim_uA is 0 the limit should not |
103 | * be changed but the detection should just be enabled/disabled as |
104 | * is requested. |
105 | * |
106 | * @set_over_voltage_protection: Support enabling of and setting limits for over |
107 | * voltage situation detection. Detection can be configured for same |
108 | * severities as over current protection. Units of uV. |
109 | * @set_under_voltage_protection: Support enabling of and setting limits for |
110 | * under voltage situation detection. Detection can be configured for same |
111 | * severities as over current protection. Units of uV. |
112 | * @set_thermal_protection: Support enabling of and setting limits for over |
113 | * temperature situation detection.Detection can be configured for same |
114 | * severities as over current protection. Units of degree Kelvin. |
115 | * |
116 | * @set_active_discharge: Set active discharge enable/disable of regulators. |
117 | * |
118 | * @set_mode: Set the configured operating mode for the regulator. |
119 | * @get_mode: Get the configured operating mode for the regulator. |
120 | * @get_error_flags: Get the current error(s) for the regulator. |
121 | * @get_status: Return actual (not as-configured) status of regulator, as a |
122 | * REGULATOR_STATUS value (or negative errno) |
123 | * @get_optimum_mode: Get the most efficient operating mode for the regulator |
124 | * when running with the specified parameters. |
125 | * @set_load: Set the load for the regulator. |
126 | * |
127 | * @set_bypass: Set the regulator in bypass mode. |
128 | * @get_bypass: Get the regulator bypass mode state. |
129 | * |
130 | * @enable_time: Time taken for the regulator voltage output voltage to |
131 | * stabilise after being enabled, in microseconds. |
132 | * @set_ramp_delay: Set the ramp delay for the regulator. The driver should |
133 | * select ramp delay equal to or less than(closest) ramp_delay. |
134 | * @set_voltage_time: Time taken for the regulator voltage output voltage |
135 | * to stabilise after being set to a new value, in microseconds. |
136 | * The function receives the from and to voltage as input, it |
137 | * should return the worst case. |
138 | * @set_voltage_time_sel: Time taken for the regulator voltage output voltage |
139 | * to stabilise after being set to a new value, in microseconds. |
140 | * The function receives the from and to voltage selector as |
141 | * input, it should return the worst case. |
142 | * @set_soft_start: Enable soft start for the regulator. |
143 | * |
144 | * @set_suspend_voltage: Set the voltage for the regulator when the system |
145 | * is suspended. |
146 | * @set_suspend_enable: Mark the regulator as enabled when the system is |
147 | * suspended. |
148 | * @set_suspend_disable: Mark the regulator as disabled when the system is |
149 | * suspended. |
150 | * @set_suspend_mode: Set the operating mode for the regulator when the |
151 | * system is suspended. |
152 | * @resume: Resume operation of suspended regulator. |
153 | * @set_pull_down: Configure the regulator to pull down when the regulator |
154 | * is disabled. |
155 | * |
156 | * This struct describes regulator operations which can be implemented by |
157 | * regulator chip drivers. |
158 | */ |
159 | struct regulator_ops { |
160 | |
161 | /* enumerate supported voltages */ |
162 | int (*list_voltage) (struct regulator_dev *, unsigned selector); |
163 | |
164 | /* get/set regulator voltage */ |
165 | int (*set_voltage) (struct regulator_dev *, int min_uV, int max_uV, |
166 | unsigned *selector); |
167 | int (*map_voltage)(struct regulator_dev *, int min_uV, int max_uV); |
168 | int (*set_voltage_sel) (struct regulator_dev *, unsigned selector); |
169 | int (*get_voltage) (struct regulator_dev *); |
170 | int (*get_voltage_sel) (struct regulator_dev *); |
171 | |
172 | /* get/set regulator current */ |
173 | int (*set_current_limit) (struct regulator_dev *, |
174 | int min_uA, int max_uA); |
175 | int (*get_current_limit) (struct regulator_dev *); |
176 | |
177 | int (*set_input_current_limit) (struct regulator_dev *, int lim_uA); |
178 | int (*set_over_current_protection)(struct regulator_dev *, int lim_uA, |
179 | int severity, bool enable); |
180 | int (*set_over_voltage_protection)(struct regulator_dev *, int lim_uV, |
181 | int severity, bool enable); |
182 | int (*set_under_voltage_protection)(struct regulator_dev *, int lim_uV, |
183 | int severity, bool enable); |
184 | int (*set_thermal_protection)(struct regulator_dev *, int lim, |
185 | int severity, bool enable); |
186 | int (*set_active_discharge)(struct regulator_dev *, bool enable); |
187 | |
188 | /* enable/disable regulator */ |
189 | int (*enable) (struct regulator_dev *); |
190 | int (*disable) (struct regulator_dev *); |
191 | int (*is_enabled) (struct regulator_dev *); |
192 | |
193 | /* get/set regulator operating mode (defined in consumer.h) */ |
194 | int (*set_mode) (struct regulator_dev *, unsigned int mode); |
195 | unsigned int (*get_mode) (struct regulator_dev *); |
196 | |
197 | /* retrieve current error flags on the regulator */ |
198 | int (*get_error_flags)(struct regulator_dev *, unsigned int *flags); |
199 | |
200 | /* Time taken to enable or set voltage on the regulator */ |
201 | int (*enable_time) (struct regulator_dev *); |
202 | int (*set_ramp_delay) (struct regulator_dev *, int ramp_delay); |
203 | int (*set_voltage_time) (struct regulator_dev *, int old_uV, |
204 | int new_uV); |
205 | int (*set_voltage_time_sel) (struct regulator_dev *, |
206 | unsigned int old_selector, |
207 | unsigned int new_selector); |
208 | |
209 | int (*set_soft_start) (struct regulator_dev *); |
210 | |
211 | /* report regulator status ... most other accessors report |
212 | * control inputs, this reports results of combining inputs |
213 | * from Linux (and other sources) with the actual load. |
214 | * returns REGULATOR_STATUS_* or negative errno. |
215 | */ |
216 | int (*get_status)(struct regulator_dev *); |
217 | |
218 | /* get most efficient regulator operating mode for load */ |
219 | unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV, |
220 | int output_uV, int load_uA); |
221 | /* set the load on the regulator */ |
222 | int (*set_load)(struct regulator_dev *, int load_uA); |
223 | |
224 | /* control and report on bypass mode */ |
225 | int (*set_bypass)(struct regulator_dev *dev, bool enable); |
226 | int (*get_bypass)(struct regulator_dev *dev, bool *enable); |
227 | |
228 | /* the operations below are for configuration of regulator state when |
229 | * its parent PMIC enters a global STANDBY/HIBERNATE state */ |
230 | |
231 | /* set regulator suspend voltage */ |
232 | int (*set_suspend_voltage) (struct regulator_dev *, int uV); |
233 | |
234 | /* enable/disable regulator in suspend state */ |
235 | int (*set_suspend_enable) (struct regulator_dev *); |
236 | int (*set_suspend_disable) (struct regulator_dev *); |
237 | |
238 | /* set regulator suspend operating mode (defined in consumer.h) */ |
239 | int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode); |
240 | |
241 | int (*resume)(struct regulator_dev *rdev); |
242 | |
243 | int (*set_pull_down) (struct regulator_dev *); |
244 | }; |
245 | |
246 | /* |
247 | * Regulators can either control voltage or current. |
248 | */ |
249 | enum regulator_type { |
250 | REGULATOR_VOLTAGE, |
251 | REGULATOR_CURRENT, |
252 | }; |
253 | |
254 | /** |
255 | * struct regulator_desc - Static regulator descriptor |
256 | * |
257 | * Each regulator registered with the core is described with a |
258 | * structure of this type and a struct regulator_config. This |
259 | * structure contains the non-varying parts of the regulator |
260 | * description. |
261 | * |
262 | * @name: Identifying name for the regulator. |
263 | * @supply_name: Identifying the regulator supply |
264 | * @of_match: Name used to identify regulator in DT. |
265 | * @of_match_full_name: A flag to indicate that the of_match string, if |
266 | * present, should be matched against the node full_name. |
267 | * @regulators_node: Name of node containing regulator definitions in DT. |
268 | * @of_parse_cb: Optional callback called only if of_match is present. |
269 | * Will be called for each regulator parsed from DT, during |
270 | * init_data parsing. |
271 | * The regulator_config passed as argument to the callback will |
272 | * be a copy of config passed to regulator_register, valid only |
273 | * for this particular call. Callback may freely change the |
274 | * config but it cannot store it for later usage. |
275 | * Callback should return 0 on success or negative ERRNO |
276 | * indicating failure. |
277 | * @id: Numerical identifier for the regulator. |
278 | * @ops: Regulator operations table. |
279 | * @irq: Interrupt number for the regulator. |
280 | * @type: Indicates if the regulator is a voltage or current regulator. |
281 | * @owner: Module providing the regulator, used for refcounting. |
282 | * |
283 | * @continuous_voltage_range: Indicates if the regulator can set any |
284 | * voltage within constrains range. |
285 | * @n_voltages: Number of selectors available for ops.list_voltage(). |
286 | * @n_current_limits: Number of selectors available for current limits |
287 | * |
288 | * @min_uV: Voltage given by the lowest selector (if linear mapping) |
289 | * @uV_step: Voltage increase with each selector (if linear mapping) |
290 | * @linear_min_sel: Minimal selector for starting linear mapping |
291 | * @fixed_uV: Fixed voltage of rails. |
292 | * @ramp_delay: Time to settle down after voltage change (unit: uV/us) |
293 | * @min_dropout_uV: The minimum dropout voltage this regulator can handle |
294 | * @linear_ranges: A constant table of possible voltage ranges. |
295 | * @linear_range_selectors_bitfield: A constant table of voltage range |
296 | * selectors as bitfield values. If |
297 | * pickable ranges are used each range |
298 | * must have corresponding selector here. |
299 | * @n_linear_ranges: Number of entries in the @linear_ranges (and in |
300 | * linear_range_selectors_bitfield if used) table(s). |
301 | * @volt_table: Voltage mapping table (if table based mapping) |
302 | * @curr_table: Current limit mapping table (if table based mapping) |
303 | * |
304 | * @vsel_range_reg: Register for range selector when using pickable ranges |
305 | * and ``regulator_map_*_voltage_*_pickable`` functions. |
306 | * @vsel_range_mask: Mask for register bitfield used for range selector |
307 | * @vsel_reg: Register for selector when using ``regulator_map_*_voltage_*`` |
308 | * @vsel_mask: Mask for register bitfield used for selector |
309 | * @vsel_step: Specify the resolution of selector stepping when setting |
310 | * voltage. If 0, then no stepping is done (requested selector is |
311 | * set directly), if >0 then the regulator API will ramp the |
312 | * voltage up/down gradually each time increasing/decreasing the |
313 | * selector by the specified step value. |
314 | * @csel_reg: Register for current limit selector using regmap set_current_limit |
315 | * @csel_mask: Mask for register bitfield used for current limit selector |
316 | * @apply_reg: Register for initiate voltage change on the output when |
317 | * using regulator_set_voltage_sel_regmap |
318 | * @apply_bit: Register bitfield used for initiate voltage change on the |
319 | * output when using regulator_set_voltage_sel_regmap |
320 | * @enable_reg: Register for control when using regmap enable/disable ops |
321 | * @enable_mask: Mask for control when using regmap enable/disable ops |
322 | * @enable_val: Enabling value for control when using regmap enable/disable ops |
323 | * @disable_val: Disabling value for control when using regmap enable/disable ops |
324 | * @enable_is_inverted: A flag to indicate set enable_mask bits to disable |
325 | * when using regulator_enable_regmap and friends APIs. |
326 | * @bypass_reg: Register for control when using regmap set_bypass |
327 | * @bypass_mask: Mask for control when using regmap set_bypass |
328 | * @bypass_val_on: Enabling value for control when using regmap set_bypass |
329 | * @bypass_val_off: Disabling value for control when using regmap set_bypass |
330 | * @active_discharge_off: Enabling value for control when using regmap |
331 | * set_active_discharge |
332 | * @active_discharge_on: Disabling value for control when using regmap |
333 | * set_active_discharge |
334 | * @active_discharge_mask: Mask for control when using regmap |
335 | * set_active_discharge |
336 | * @active_discharge_reg: Register for control when using regmap |
337 | * set_active_discharge |
338 | * @soft_start_reg: Register for control when using regmap set_soft_start |
339 | * @soft_start_mask: Mask for control when using regmap set_soft_start |
340 | * @soft_start_val_on: Enabling value for control when using regmap |
341 | * set_soft_start |
342 | * @pull_down_reg: Register for control when using regmap set_pull_down |
343 | * @pull_down_mask: Mask for control when using regmap set_pull_down |
344 | * @pull_down_val_on: Enabling value for control when using regmap |
345 | * set_pull_down |
346 | * |
347 | * @ramp_reg: Register for controlling the regulator ramp-rate. |
348 | * @ramp_mask: Bitmask for the ramp-rate control register. |
349 | * @ramp_delay_table: Table for mapping the regulator ramp-rate values. Values |
350 | * should be given in units of V/S (uV/uS). See the |
351 | * regulator_set_ramp_delay_regmap(). |
352 | * @n_ramp_values: number of elements at @ramp_delay_table. |
353 | * |
354 | * @enable_time: Time taken for initial enable of regulator (in uS). |
355 | * @off_on_delay: guard time (in uS), before re-enabling a regulator |
356 | * |
357 | * @poll_enabled_time: The polling interval (in uS) to use while checking that |
358 | * the regulator was actually enabled. Max upto enable_time. |
359 | * |
360 | * @of_map_mode: Maps a hardware mode defined in a DeviceTree to a standard mode |
361 | */ |
362 | struct regulator_desc { |
363 | const char *name; |
364 | const char *supply_name; |
365 | const char *of_match; |
366 | bool of_match_full_name; |
367 | const char *regulators_node; |
368 | int (*of_parse_cb)(struct device_node *, |
369 | const struct regulator_desc *, |
370 | struct regulator_config *); |
371 | int id; |
372 | unsigned int continuous_voltage_range:1; |
373 | unsigned n_voltages; |
374 | unsigned int n_current_limits; |
375 | const struct regulator_ops *ops; |
376 | int irq; |
377 | enum regulator_type type; |
378 | struct module *owner; |
379 | |
380 | unsigned int min_uV; |
381 | unsigned int uV_step; |
382 | unsigned int linear_min_sel; |
383 | int fixed_uV; |
384 | unsigned int ramp_delay; |
385 | int min_dropout_uV; |
386 | |
387 | const struct linear_range *linear_ranges; |
388 | const unsigned int *linear_range_selectors_bitfield; |
389 | |
390 | int n_linear_ranges; |
391 | |
392 | const unsigned int *volt_table; |
393 | const unsigned int *curr_table; |
394 | |
395 | unsigned int vsel_range_reg; |
396 | unsigned int vsel_range_mask; |
397 | unsigned int vsel_reg; |
398 | unsigned int vsel_mask; |
399 | unsigned int vsel_step; |
400 | unsigned int csel_reg; |
401 | unsigned int csel_mask; |
402 | unsigned int apply_reg; |
403 | unsigned int apply_bit; |
404 | unsigned int enable_reg; |
405 | unsigned int enable_mask; |
406 | unsigned int enable_val; |
407 | unsigned int disable_val; |
408 | bool enable_is_inverted; |
409 | unsigned int bypass_reg; |
410 | unsigned int bypass_mask; |
411 | unsigned int bypass_val_on; |
412 | unsigned int bypass_val_off; |
413 | unsigned int active_discharge_on; |
414 | unsigned int active_discharge_off; |
415 | unsigned int active_discharge_mask; |
416 | unsigned int active_discharge_reg; |
417 | unsigned int soft_start_reg; |
418 | unsigned int soft_start_mask; |
419 | unsigned int soft_start_val_on; |
420 | unsigned int pull_down_reg; |
421 | unsigned int pull_down_mask; |
422 | unsigned int pull_down_val_on; |
423 | unsigned int ramp_reg; |
424 | unsigned int ramp_mask; |
425 | const unsigned int *ramp_delay_table; |
426 | unsigned int n_ramp_values; |
427 | |
428 | unsigned int enable_time; |
429 | |
430 | unsigned int off_on_delay; |
431 | |
432 | unsigned int poll_enabled_time; |
433 | |
434 | unsigned int (*of_map_mode)(unsigned int mode); |
435 | }; |
436 | |
437 | /** |
438 | * struct regulator_config - Dynamic regulator descriptor |
439 | * |
440 | * Each regulator registered with the core is described with a |
441 | * structure of this type and a struct regulator_desc. This structure |
442 | * contains the runtime variable parts of the regulator description. |
443 | * |
444 | * @dev: struct device for the regulator |
445 | * @init_data: platform provided init data, passed through by driver |
446 | * @driver_data: private regulator data |
447 | * @of_node: OpenFirmware node to parse for device tree bindings (may be |
448 | * NULL). |
449 | * @regmap: regmap to use for core regmap helpers if dev_get_regmap() is |
450 | * insufficient. |
451 | * @ena_gpiod: GPIO controlling regulator enable. |
452 | */ |
453 | struct regulator_config { |
454 | struct device *dev; |
455 | const struct regulator_init_data *init_data; |
456 | void *driver_data; |
457 | struct device_node *of_node; |
458 | struct regmap *regmap; |
459 | |
460 | struct gpio_desc *ena_gpiod; |
461 | }; |
462 | |
463 | /** |
464 | * struct regulator_err_state - regulator error/notification status |
465 | * |
466 | * @rdev: Regulator which status the struct indicates. |
467 | * @notifs: Events which have occurred on the regulator. |
468 | * @errors: Errors which are active on the regulator. |
469 | * @possible_errs: Errors which can be signaled (by given IRQ). |
470 | */ |
471 | struct regulator_err_state { |
472 | struct regulator_dev *rdev; |
473 | unsigned long notifs; |
474 | unsigned long errors; |
475 | int possible_errs; |
476 | }; |
477 | |
478 | /** |
479 | * struct regulator_irq_data - regulator error/notification status data |
480 | * |
481 | * @states: Status structs for each of the associated regulators. |
482 | * @num_states: Amount of associated regulators. |
483 | * @data: Driver data pointer given at regulator_irq_desc. |
484 | * @opaque: Value storage for IC driver. Core does not update this. ICs |
485 | * may want to store status register value here at map_event and |
486 | * compare contents at 'renable' callback to see if new problems |
487 | * have been added to status. If that is the case it may be |
488 | * desirable to return REGULATOR_ERROR_CLEARED and not |
489 | * REGULATOR_ERROR_ON to allow IRQ fire again and to generate |
490 | * notifications also for the new issues. |
491 | * |
492 | * This structure is passed to 'map_event' and 'renable' callbacks for |
493 | * reporting regulator status to core. |
494 | */ |
495 | struct regulator_irq_data { |
496 | struct regulator_err_state *states; |
497 | int num_states; |
498 | void *data; |
499 | long opaque; |
500 | }; |
501 | |
502 | /** |
503 | * struct regulator_irq_desc - notification sender for IRQ based events. |
504 | * |
505 | * @name: The visible name for the IRQ |
506 | * @fatal_cnt: If this IRQ is used to signal HW damaging condition it may be |
507 | * best to shut-down regulator(s) or reboot the SOC if error |
508 | * handling is repeatedly failing. If fatal_cnt is given the IRQ |
509 | * handling is aborted if it fails for fatal_cnt times and die() |
510 | * callback (if populated) is called. If die() is not populated |
511 | * poweroff for the system is attempted in order to prevent any |
512 | * further damage. |
513 | * @reread_ms: The time which is waited before attempting to re-read status |
514 | * at the worker if IC reading fails. Immediate re-read is done |
515 | * if time is not specified. |
516 | * @irq_off_ms: The time which IRQ is kept disabled before re-evaluating the |
517 | * status for devices which keep IRQ disabled for duration of the |
518 | * error. If this is not given the IRQ is left enabled and renable |
519 | * is not called. |
520 | * @skip_off: If set to true the IRQ handler will attempt to check if any of |
521 | * the associated regulators are enabled prior to taking other |
522 | * actions. If no regulators are enabled and this is set to true |
523 | * a spurious IRQ is assumed and IRQ_NONE is returned. |
524 | * @high_prio: Boolean to indicate that high priority WQ should be used. |
525 | * @data: Driver private data pointer which will be passed as such to |
526 | * the renable, map_event and die callbacks in regulator_irq_data. |
527 | * @die: Protection callback. If IC status reading or recovery actions |
528 | * fail fatal_cnt times this callback is called or system is |
529 | * powered off. This callback should implement a final protection |
530 | * attempt like disabling the regulator. If protection succeeded |
531 | * die() may return 0. If anything else is returned the core |
532 | * assumes final protection failed and attempts to perform a |
533 | * poweroff as a last resort. |
534 | * @map_event: Driver callback to map IRQ status into regulator devices with |
535 | * events / errors. NOTE: callback MUST initialize both the |
536 | * errors and notifs for all rdevs which it signals having |
537 | * active events as core does not clean the map data. |
538 | * REGULATOR_FAILED_RETRY can be returned to indicate that the |
539 | * status reading from IC failed. If this is repeated for |
540 | * fatal_cnt times the core will call die() callback or power-off |
541 | * the system as a last resort to protect the HW. |
542 | * @renable: Optional callback to check status (if HW supports that) before |
543 | * re-enabling IRQ. If implemented this should clear the error |
544 | * flags so that errors fetched by regulator_get_error_flags() |
545 | * are updated. If callback is not implemented then errors are |
546 | * assumed to be cleared and IRQ is re-enabled. |
547 | * REGULATOR_FAILED_RETRY can be returned to |
548 | * indicate that the status reading from IC failed. If this is |
549 | * repeated for 'fatal_cnt' times the core will call die() |
550 | * callback or if die() is not populated then attempt to power-off |
551 | * the system as a last resort to protect the HW. |
552 | * Returning zero indicates that the problem in HW has been solved |
553 | * and IRQ will be re-enabled. Returning REGULATOR_ERROR_ON |
554 | * indicates the error condition is still active and keeps IRQ |
555 | * disabled. Please note that returning REGULATOR_ERROR_ON does |
556 | * not retrigger evaluating what events are active or resending |
557 | * notifications. If this is needed you probably want to return |
558 | * zero and allow IRQ to retrigger causing events to be |
559 | * re-evaluated and re-sent. |
560 | * |
561 | * This structure is used for registering regulator IRQ notification helper. |
562 | */ |
563 | struct regulator_irq_desc { |
564 | const char *name; |
565 | int fatal_cnt; |
566 | int reread_ms; |
567 | int irq_off_ms; |
568 | bool skip_off; |
569 | bool high_prio; |
570 | void *data; |
571 | |
572 | int (*die)(struct regulator_irq_data *rid); |
573 | int (*map_event)(int irq, struct regulator_irq_data *rid, |
574 | unsigned long *dev_mask); |
575 | int (*renable)(struct regulator_irq_data *rid); |
576 | }; |
577 | |
578 | /* |
579 | * Return values for regulator IRQ helpers. |
580 | */ |
581 | enum { |
582 | REGULATOR_ERROR_CLEARED, |
583 | REGULATOR_FAILED_RETRY, |
584 | REGULATOR_ERROR_ON, |
585 | }; |
586 | |
587 | /* |
588 | * struct coupling_desc |
589 | * |
590 | * Describes coupling of regulators. Each regulator should have |
591 | * at least a pointer to itself in coupled_rdevs array. |
592 | * When a new coupled regulator is resolved, n_resolved is |
593 | * incremented. |
594 | */ |
595 | struct coupling_desc { |
596 | struct regulator_dev **coupled_rdevs; |
597 | struct regulator_coupler *coupler; |
598 | int n_resolved; |
599 | int n_coupled; |
600 | }; |
601 | |
602 | /* |
603 | * struct regulator_dev |
604 | * |
605 | * Voltage / Current regulator class device. One for each |
606 | * regulator. |
607 | * |
608 | * This should *not* be used directly by anything except the regulator |
609 | * core and notification injection (which should take the mutex and do |
610 | * no other direct access). |
611 | */ |
612 | struct regulator_dev { |
613 | const struct regulator_desc *desc; |
614 | int exclusive; |
615 | u32 use_count; |
616 | u32 open_count; |
617 | u32 bypass_count; |
618 | |
619 | /* lists we belong to */ |
620 | struct list_head list; /* list of all regulators */ |
621 | |
622 | /* lists we own */ |
623 | struct list_head consumer_list; /* consumers we supply */ |
624 | |
625 | struct coupling_desc coupling_desc; |
626 | |
627 | struct blocking_notifier_head notifier; |
628 | struct ww_mutex mutex; /* consumer lock */ |
629 | struct task_struct *mutex_owner; |
630 | int ref_cnt; |
631 | struct module *owner; |
632 | struct device dev; |
633 | struct regulation_constraints *constraints; |
634 | struct regulator *supply; /* for tree */ |
635 | const char *supply_name; |
636 | struct regmap *regmap; |
637 | |
638 | struct delayed_work disable_work; |
639 | |
640 | void *reg_data; /* regulator_dev data */ |
641 | |
642 | struct dentry *debugfs; |
643 | |
644 | struct regulator_enable_gpio *ena_pin; |
645 | unsigned int ena_gpio_state:1; |
646 | |
647 | unsigned int is_switch:1; |
648 | |
649 | /* time when this regulator was disabled last time */ |
650 | ktime_t last_off; |
651 | int cached_err; |
652 | bool use_cached_err; |
653 | spinlock_t err_lock; |
654 | }; |
655 | |
656 | /* |
657 | * Convert error flags to corresponding notifications. |
658 | * |
659 | * Can be used by drivers which use the notification helpers to |
660 | * find out correct notification flags based on the error flags. Drivers |
661 | * can avoid storing both supported notification and error flags which |
662 | * may save few bytes. |
663 | */ |
664 | static inline int regulator_err2notif(int err) |
665 | { |
666 | switch (err) { |
667 | case REGULATOR_ERROR_UNDER_VOLTAGE: |
668 | return REGULATOR_EVENT_UNDER_VOLTAGE; |
669 | case REGULATOR_ERROR_OVER_CURRENT: |
670 | return REGULATOR_EVENT_OVER_CURRENT; |
671 | case REGULATOR_ERROR_REGULATION_OUT: |
672 | return REGULATOR_EVENT_REGULATION_OUT; |
673 | case REGULATOR_ERROR_FAIL: |
674 | return REGULATOR_EVENT_FAIL; |
675 | case REGULATOR_ERROR_OVER_TEMP: |
676 | return REGULATOR_EVENT_OVER_TEMP; |
677 | case REGULATOR_ERROR_UNDER_VOLTAGE_WARN: |
678 | return REGULATOR_EVENT_UNDER_VOLTAGE_WARN; |
679 | case REGULATOR_ERROR_OVER_CURRENT_WARN: |
680 | return REGULATOR_EVENT_OVER_CURRENT_WARN; |
681 | case REGULATOR_ERROR_OVER_VOLTAGE_WARN: |
682 | return REGULATOR_EVENT_OVER_VOLTAGE_WARN; |
683 | case REGULATOR_ERROR_OVER_TEMP_WARN: |
684 | return REGULATOR_EVENT_OVER_TEMP_WARN; |
685 | } |
686 | return 0; |
687 | } |
688 | |
689 | |
690 | struct regulator_dev * |
691 | regulator_register(struct device *dev, |
692 | const struct regulator_desc *regulator_desc, |
693 | const struct regulator_config *config); |
694 | struct regulator_dev * |
695 | devm_regulator_register(struct device *dev, |
696 | const struct regulator_desc *regulator_desc, |
697 | const struct regulator_config *config); |
698 | void regulator_unregister(struct regulator_dev *rdev); |
699 | |
700 | int regulator_notifier_call_chain(struct regulator_dev *rdev, |
701 | unsigned long event, void *data); |
702 | void *devm_regulator_irq_helper(struct device *dev, |
703 | const struct regulator_irq_desc *d, int irq, |
704 | int irq_flags, int common_errs, |
705 | int *per_rdev_errs, struct regulator_dev **rdev, |
706 | int rdev_amount); |
707 | void *regulator_irq_helper(struct device *dev, |
708 | const struct regulator_irq_desc *d, int irq, |
709 | int irq_flags, int common_errs, int *per_rdev_errs, |
710 | struct regulator_dev **rdev, int rdev_amount); |
711 | void regulator_irq_helper_cancel(void **handle); |
712 | int regulator_irq_map_event_simple(int irq, struct regulator_irq_data *rid, |
713 | unsigned long *dev_mask); |
714 | |
715 | void *rdev_get_drvdata(struct regulator_dev *rdev); |
716 | struct device *rdev_get_dev(struct regulator_dev *rdev); |
717 | struct regmap *rdev_get_regmap(struct regulator_dev *rdev); |
718 | int rdev_get_id(struct regulator_dev *rdev); |
719 | |
720 | int regulator_mode_to_status(unsigned int); |
721 | |
722 | int regulator_list_voltage_linear(struct regulator_dev *rdev, |
723 | unsigned int selector); |
724 | int regulator_list_voltage_pickable_linear_range(struct regulator_dev *rdev, |
725 | unsigned int selector); |
726 | int regulator_list_voltage_linear_range(struct regulator_dev *rdev, |
727 | unsigned int selector); |
728 | int regulator_list_voltage_table(struct regulator_dev *rdev, |
729 | unsigned int selector); |
730 | int regulator_map_voltage_linear(struct regulator_dev *rdev, |
731 | int min_uV, int max_uV); |
732 | int regulator_map_voltage_pickable_linear_range(struct regulator_dev *rdev, |
733 | int min_uV, int max_uV); |
734 | int regulator_map_voltage_linear_range(struct regulator_dev *rdev, |
735 | int min_uV, int max_uV); |
736 | int regulator_map_voltage_iterate(struct regulator_dev *rdev, |
737 | int min_uV, int max_uV); |
738 | int regulator_map_voltage_ascend(struct regulator_dev *rdev, |
739 | int min_uV, int max_uV); |
740 | int regulator_get_voltage_sel_pickable_regmap(struct regulator_dev *rdev); |
741 | int regulator_set_voltage_sel_pickable_regmap(struct regulator_dev *rdev, |
742 | unsigned int sel); |
743 | int regulator_get_voltage_sel_regmap(struct regulator_dev *rdev); |
744 | int regulator_set_voltage_sel_regmap(struct regulator_dev *rdev, unsigned sel); |
745 | int regulator_is_enabled_regmap(struct regulator_dev *rdev); |
746 | int regulator_enable_regmap(struct regulator_dev *rdev); |
747 | int regulator_disable_regmap(struct regulator_dev *rdev); |
748 | int regulator_set_voltage_time_sel(struct regulator_dev *rdev, |
749 | unsigned int old_selector, |
750 | unsigned int new_selector); |
751 | int regulator_set_bypass_regmap(struct regulator_dev *rdev, bool enable); |
752 | int regulator_get_bypass_regmap(struct regulator_dev *rdev, bool *enable); |
753 | int regulator_set_soft_start_regmap(struct regulator_dev *rdev); |
754 | int regulator_set_pull_down_regmap(struct regulator_dev *rdev); |
755 | |
756 | int regulator_set_active_discharge_regmap(struct regulator_dev *rdev, |
757 | bool enable); |
758 | int regulator_set_current_limit_regmap(struct regulator_dev *rdev, |
759 | int min_uA, int max_uA); |
760 | int regulator_get_current_limit_regmap(struct regulator_dev *rdev); |
761 | void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data); |
762 | int regulator_find_closest_bigger(unsigned int target, const unsigned int *table, |
763 | unsigned int num_sel, unsigned int *sel); |
764 | int regulator_set_ramp_delay_regmap(struct regulator_dev *rdev, int ramp_delay); |
765 | int regulator_sync_voltage_rdev(struct regulator_dev *rdev); |
766 | |
767 | /* |
768 | * Helper functions intended to be used by regulator drivers prior registering |
769 | * their regulators. |
770 | */ |
771 | int regulator_desc_list_voltage_linear_range(const struct regulator_desc *desc, |
772 | unsigned int selector); |
773 | |
774 | int regulator_desc_list_voltage_linear(const struct regulator_desc *desc, |
775 | unsigned int selector); |
776 | |
777 | #ifdef CONFIG_REGULATOR |
778 | const char *rdev_get_name(struct regulator_dev *rdev); |
779 | #else |
780 | static inline const char *rdev_get_name(struct regulator_dev *rdev) |
781 | { |
782 | return NULL; |
783 | } |
784 | #endif |
785 | |
786 | #endif |
787 | |