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

source code of linux/include/linux/regulator/driver.h