2 * driver.h -- SoC Regulator driver support.
4 * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC.
6 * Author: Liam Girdwood <lrg@slimlogic.co.uk>
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.
12 * Regulator Driver Interface.
15 #ifndef __LINUX_REGULATOR_DRIVER_H_
16 #define __LINUX_REGULATOR_DRIVER_H_
18 #include <linux/device.h>
19 #include <linux/notifier.h>
20 #include <linux/regulator/consumer.h>
24 struct regulator_config;
25 struct regulator_init_data;
26 struct regulator_enable_gpio;
28 enum regulator_status {
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,
44 * struct regulator_linear_range - specify linear voltage ranges
46 * Specify a range of voltages for regulator_map_linar_range() and
47 * regulator_list_linear_range().
49 * @min_uV: Lowest voltage in range
50 * @min_sel: Lowest selector for range
51 * @max_sel: Highest selector for range
54 struct regulator_linear_range {
61 /* Initialize struct regulator_linear_range */
62 #define REGULATOR_LINEAR_RANGE(_min_uV, _min_sel, _max_sel, _step_uV) \
65 .min_sel = _min_sel, \
66 .max_sel = _max_sel, \
67 .uV_step = _step_uV, \
71 * struct regulator_ops - regulator operations.
73 * @enable: Configure the regulator as enabled.
74 * @disable: Configure the regulator as disabled.
75 * @is_enabled: Return 1 if the regulator is enabled, 0 if not.
76 * May also return negative errno.
78 * @set_voltage: Set the voltage for the regulator within the range specified.
79 * The driver should select the voltage closest to min_uV.
80 * @set_voltage_sel: Set the voltage for the regulator using the specified
82 * @map_voltage: Convert a voltage into a selector
83 * @get_voltage: Return the currently configured voltage for the regulator.
84 * @get_voltage_sel: Return the currently configured voltage selector for the
86 * @list_voltage: Return one of the supported voltages, in microvolts; zero
87 * if the selector indicates a voltage that is unusable on this system;
88 * or negative errno. Selectors range from zero to one less than
89 * regulator_desc.n_voltages. Voltages may be reported in any order.
91 * @set_current_limit: Configure a limit for a current-limited regulator.
92 * The driver should select the current closest to max_uA.
93 * @get_current_limit: Get the configured limit for a current-limited regulator.
94 * @set_input_current_limit: Configure an input limit.
96 * @set_mode: Set the configured operating mode for the regulator.
97 * @get_mode: Get the configured operating mode for the regulator.
98 * @get_status: Return actual (not as-configured) status of regulator, as a
99 * REGULATOR_STATUS value (or negative errno)
100 * @get_optimum_mode: Get the most efficient operating mode for the regulator
101 * when running with the specified parameters.
102 * @set_load: Set the load for the regulator.
104 * @set_bypass: Set the regulator in bypass mode.
105 * @get_bypass: Get the regulator bypass mode state.
107 * @enable_time: Time taken for the regulator voltage output voltage to
108 * stabilise after being enabled, in microseconds.
109 * @set_ramp_delay: Set the ramp delay for the regulator. The driver should
110 * select ramp delay equal to or less than(closest) ramp_delay.
111 * @set_voltage_time_sel: Time taken for the regulator voltage output voltage
112 * to stabilise after being set to a new value, in microseconds.
113 * The function provides the from and to voltage selector, the
114 * function should return the worst case.
115 * @set_soft_start: Enable soft start for the regulator.
117 * @set_suspend_voltage: Set the voltage for the regulator when the system
119 * @set_suspend_enable: Mark the regulator as enabled when the system is
121 * @set_suspend_disable: Mark the regulator as disabled when the system is
123 * @set_suspend_mode: Set the operating mode for the regulator when the
124 * system is suspended.
126 * @set_pull_down: Configure the regulator to pull down when the regulator
129 * This struct describes regulator operations which can be implemented by
130 * regulator chip drivers.
132 struct regulator_ops {
134 /* enumerate supported voltages */
135 int (*list_voltage) (struct regulator_dev *, unsigned selector);
137 /* get/set regulator voltage */
138 int (*set_voltage) (struct regulator_dev *, int min_uV, int max_uV,
140 int (*map_voltage)(struct regulator_dev *, int min_uV, int max_uV);
141 int (*set_voltage_sel) (struct regulator_dev *, unsigned selector);
142 int (*get_voltage) (struct regulator_dev *);
143 int (*get_voltage_sel) (struct regulator_dev *);
145 /* get/set regulator current */
146 int (*set_current_limit) (struct regulator_dev *,
147 int min_uA, int max_uA);
148 int (*get_current_limit) (struct regulator_dev *);
150 int (*set_input_current_limit) (struct regulator_dev *, int lim_uA);
151 int (*set_over_current_protection) (struct regulator_dev *);
153 /* enable/disable regulator */
154 int (*enable) (struct regulator_dev *);
155 int (*disable) (struct regulator_dev *);
156 int (*is_enabled) (struct regulator_dev *);
158 /* get/set regulator operating mode (defined in consumer.h) */
159 int (*set_mode) (struct regulator_dev *, unsigned int mode);
160 unsigned int (*get_mode) (struct regulator_dev *);
162 /* Time taken to enable or set voltage on the regulator */
163 int (*enable_time) (struct regulator_dev *);
164 int (*set_ramp_delay) (struct regulator_dev *, int ramp_delay);
165 int (*set_voltage_time_sel) (struct regulator_dev *,
166 unsigned int old_selector,
167 unsigned int new_selector);
169 int (*set_soft_start) (struct regulator_dev *);
171 /* report regulator status ... most other accessors report
172 * control inputs, this reports results of combining inputs
173 * from Linux (and other sources) with the actual load.
174 * returns REGULATOR_STATUS_* or negative errno.
176 int (*get_status)(struct regulator_dev *);
178 /* get most efficient regulator operating mode for load */
179 unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV,
180 int output_uV, int load_uA);
181 /* set the load on the regulator */
182 int (*set_load)(struct regulator_dev *, int load_uA);
184 /* control and report on bypass mode */
185 int (*set_bypass)(struct regulator_dev *dev, bool enable);
186 int (*get_bypass)(struct regulator_dev *dev, bool *enable);
188 /* the operations below are for configuration of regulator state when
189 * its parent PMIC enters a global STANDBY/HIBERNATE state */
191 /* set regulator suspend voltage */
192 int (*set_suspend_voltage) (struct regulator_dev *, int uV);
194 /* enable/disable regulator in suspend state */
195 int (*set_suspend_enable) (struct regulator_dev *);
196 int (*set_suspend_disable) (struct regulator_dev *);
198 /* set regulator suspend operating mode (defined in consumer.h) */
199 int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode);
201 int (*set_pull_down) (struct regulator_dev *);
205 * Regulators can either control voltage or current.
207 enum regulator_type {
213 * struct regulator_desc - Static regulator descriptor
215 * Each regulator registered with the core is described with a
216 * structure of this type and a struct regulator_config. This
217 * structure contains the non-varying parts of the regulator
220 * @name: Identifying name for the regulator.
221 * @supply_name: Identifying the regulator supply
222 * @of_match: Name used to identify regulator in DT.
223 * @regulators_node: Name of node containing regulator definitions in DT.
224 * @of_parse_cb: Optional callback called only if of_match is present.
225 * Will be called for each regulator parsed from DT, during
227 * The regulator_config passed as argument to the callback will
228 * be a copy of config passed to regulator_register, valid only
229 * for this particular call. Callback may freely change the
230 * config but it cannot store it for later usage.
231 * Callback should return 0 on success or negative ERRNO
232 * indicating failure.
233 * @id: Numerical identifier for the regulator.
234 * @ops: Regulator operations table.
235 * @irq: Interrupt number for the regulator.
236 * @type: Indicates if the regulator is a voltage or current regulator.
237 * @owner: Module providing the regulator, used for refcounting.
239 * @continuous_voltage_range: Indicates if the regulator can set any
240 * voltage within constrains range.
241 * @n_voltages: Number of selectors available for ops.list_voltage().
243 * @min_uV: Voltage given by the lowest selector (if linear mapping)
244 * @uV_step: Voltage increase with each selector (if linear mapping)
245 * @linear_min_sel: Minimal selector for starting linear mapping
246 * @fixed_uV: Fixed voltage of rails.
247 * @ramp_delay: Time to settle down after voltage change (unit: uV/us)
248 * @min_dropout_uV: The minimum dropout voltage this regulator can handle
249 * @linear_ranges: A constant table of possible voltage ranges.
250 * @n_linear_ranges: Number of entries in the @linear_ranges table.
251 * @volt_table: Voltage mapping table (if table based mapping)
253 * @vsel_reg: Register for selector when using regulator_regmap_X_voltage_
254 * @vsel_mask: Mask for register bitfield used for selector
255 * @apply_reg: Register for initiate voltage change on the output when
256 * using regulator_set_voltage_sel_regmap
257 * @apply_bit: Register bitfield used for initiate voltage change on the
258 * output when using regulator_set_voltage_sel_regmap
259 * @enable_reg: Register for control when using regmap enable/disable ops
260 * @enable_mask: Mask for control when using regmap enable/disable ops
261 * @enable_val: Enabling value for control when using regmap enable/disable ops
262 * @disable_val: Disabling value for control when using regmap enable/disable ops
263 * @enable_is_inverted: A flag to indicate set enable_mask bits to disable
264 * when using regulator_enable_regmap and friends APIs.
265 * @bypass_reg: Register for control when using regmap set_bypass
266 * @bypass_mask: Mask for control when using regmap set_bypass
267 * @bypass_val_on: Enabling value for control when using regmap set_bypass
268 * @bypass_val_off: Disabling value for control when using regmap set_bypass
270 * @enable_time: Time taken for initial enable of regulator (in uS).
271 * @off_on_delay: guard time (in uS), before re-enabling a regulator
273 * @of_map_mode: Maps a hardware mode defined in a DeviceTree to a standard mode
275 struct regulator_desc {
277 const char *supply_name;
278 const char *of_match;
279 const char *regulators_node;
280 int (*of_parse_cb)(struct device_node *,
281 const struct regulator_desc *,
282 struct regulator_config *);
284 bool continuous_voltage_range;
286 const struct regulator_ops *ops;
288 enum regulator_type type;
289 struct module *owner;
292 unsigned int uV_step;
293 unsigned int linear_min_sel;
295 unsigned int ramp_delay;
298 const struct regulator_linear_range *linear_ranges;
301 const unsigned int *volt_table;
303 unsigned int vsel_reg;
304 unsigned int vsel_mask;
305 unsigned int apply_reg;
306 unsigned int apply_bit;
307 unsigned int enable_reg;
308 unsigned int enable_mask;
309 unsigned int enable_val;
310 unsigned int disable_val;
311 bool enable_is_inverted;
312 unsigned int bypass_reg;
313 unsigned int bypass_mask;
314 unsigned int bypass_val_on;
315 unsigned int bypass_val_off;
317 unsigned int enable_time;
319 unsigned int off_on_delay;
321 unsigned int (*of_map_mode)(unsigned int mode);
325 * struct regulator_config - Dynamic regulator descriptor
327 * Each regulator registered with the core is described with a
328 * structure of this type and a struct regulator_desc. This structure
329 * contains the runtime variable parts of the regulator description.
331 * @dev: struct device for the regulator
332 * @init_data: platform provided init data, passed through by driver
333 * @driver_data: private regulator data
334 * @of_node: OpenFirmware node to parse for device tree bindings (may be
336 * @regmap: regmap to use for core regmap helpers if dev_get_regmap() is
338 * @ena_gpio_initialized: GPIO controlling regulator enable was properly
339 * initialized, meaning that >= 0 is a valid gpio
340 * identifier and < 0 is a non existent gpio.
341 * @ena_gpio: GPIO controlling regulator enable.
342 * @ena_gpio_invert: Sense for GPIO enable control.
343 * @ena_gpio_flags: Flags to use when calling gpio_request_one()
345 struct regulator_config {
347 const struct regulator_init_data *init_data;
349 struct device_node *of_node;
350 struct regmap *regmap;
352 bool ena_gpio_initialized;
354 unsigned int ena_gpio_invert:1;
355 unsigned int ena_gpio_flags;
359 * struct regulator_dev
361 * Voltage / Current regulator class device. One for each
364 * This should *not* be used directly by anything except the regulator
365 * core and notification injection (which should take the mutex and do
366 * no other direct access).
368 struct regulator_dev {
369 const struct regulator_desc *desc;
375 /* lists we belong to */
376 struct list_head list; /* list of all regulators */
379 struct list_head consumer_list; /* consumers we supply */
381 struct blocking_notifier_head notifier;
382 struct mutex mutex; /* consumer lock */
383 struct module *owner;
385 struct regulation_constraints *constraints;
386 struct regulator *supply; /* for tree */
387 const char *supply_name;
388 struct regmap *regmap;
390 struct delayed_work disable_work;
391 int deferred_disables;
393 void *reg_data; /* regulator_dev data */
395 struct dentry *debugfs;
397 struct regulator_enable_gpio *ena_pin;
398 unsigned int ena_gpio_state:1;
400 /* time when this regulator was disabled last time */
401 unsigned long last_off_jiffy;
404 struct regulator_dev *
405 regulator_register(const struct regulator_desc *regulator_desc,
406 const struct regulator_config *config);
407 struct regulator_dev *
408 devm_regulator_register(struct device *dev,
409 const struct regulator_desc *regulator_desc,
410 const struct regulator_config *config);
411 void regulator_unregister(struct regulator_dev *rdev);
412 void devm_regulator_unregister(struct device *dev, struct regulator_dev *rdev);
414 int regulator_notifier_call_chain(struct regulator_dev *rdev,
415 unsigned long event, void *data);
417 void *rdev_get_drvdata(struct regulator_dev *rdev);
418 struct device *rdev_get_dev(struct regulator_dev *rdev);
419 int rdev_get_id(struct regulator_dev *rdev);
421 int regulator_mode_to_status(unsigned int);
423 int regulator_list_voltage_linear(struct regulator_dev *rdev,
424 unsigned int selector);
425 int regulator_list_voltage_linear_range(struct regulator_dev *rdev,
426 unsigned int selector);
427 int regulator_list_voltage_table(struct regulator_dev *rdev,
428 unsigned int selector);
429 int regulator_map_voltage_linear(struct regulator_dev *rdev,
430 int min_uV, int max_uV);
431 int regulator_map_voltage_linear_range(struct regulator_dev *rdev,
432 int min_uV, int max_uV);
433 int regulator_map_voltage_iterate(struct regulator_dev *rdev,
434 int min_uV, int max_uV);
435 int regulator_map_voltage_ascend(struct regulator_dev *rdev,
436 int min_uV, int max_uV);
437 int regulator_get_voltage_sel_regmap(struct regulator_dev *rdev);
438 int regulator_set_voltage_sel_regmap(struct regulator_dev *rdev, unsigned sel);
439 int regulator_is_enabled_regmap(struct regulator_dev *rdev);
440 int regulator_enable_regmap(struct regulator_dev *rdev);
441 int regulator_disable_regmap(struct regulator_dev *rdev);
442 int regulator_set_voltage_time_sel(struct regulator_dev *rdev,
443 unsigned int old_selector,
444 unsigned int new_selector);
445 int regulator_set_bypass_regmap(struct regulator_dev *rdev, bool enable);
446 int regulator_get_bypass_regmap(struct regulator_dev *rdev, bool *enable);
448 void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data);