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_init_data;
25 struct regulator_enable_gpio;
27 enum regulator_status {
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,
36 /* The regulator is enabled but not regulating */
37 REGULATOR_STATUS_BYPASS,
38 /* in case that any other status doesn't apply */
39 REGULATOR_STATUS_UNDEFINED,
43 * struct regulator_ops - regulator operations.
45 * @enable: Configure the regulator as enabled.
46 * @disable: Configure the regulator as disabled.
47 * @is_enabled: Return 1 if the regulator is enabled, 0 if not.
48 * May also return negative errno.
50 * @set_voltage: Set the voltage for the regulator within the range specified.
51 * The driver should select the voltage closest to min_uV.
52 * @set_voltage_sel: Set the voltage for the regulator using the specified
54 * @map_voltage: Convert a voltage into a selector
55 * @get_voltage: Return the currently configured voltage for the regulator.
56 * @get_voltage_sel: Return the currently configured voltage selector for the
58 * @list_voltage: Return one of the supported voltages, in microvolts; zero
59 * if the selector indicates a voltage that is unusable on this system;
60 * or negative errno. Selectors range from zero to one less than
61 * regulator_desc.n_voltages. Voltages may be reported in any order.
63 * @set_current_limit: Configure a limit for a current-limited regulator.
64 * The driver should select the current closest to max_uA.
65 * @get_current_limit: Get the configured limit for a current-limited regulator.
67 * @set_mode: Set the configured operating mode for the regulator.
68 * @get_mode: Get the configured operating mode for the regulator.
69 * @get_status: Return actual (not as-configured) status of regulator, as a
70 * REGULATOR_STATUS value (or negative errno)
71 * @get_optimum_mode: Get the most efficient operating mode for the regulator
72 * when running with the specified parameters.
74 * @set_bypass: Set the regulator in bypass mode.
75 * @get_bypass: Get the regulator bypass mode state.
77 * @enable_time: Time taken for the regulator voltage output voltage to
78 * stabilise after being enabled, in microseconds.
79 * @set_ramp_delay: Set the ramp delay for the regulator. The driver should
80 * select ramp delay equal to or less than(closest) ramp_delay.
81 * @set_voltage_time_sel: Time taken for the regulator voltage output voltage
82 * to stabilise after being set to a new value, in microseconds.
83 * The function provides the from and to voltage selector, the
84 * function should return the worst case.
86 * @set_suspend_voltage: Set the voltage for the regulator when the system
88 * @set_suspend_enable: Mark the regulator as enabled when the system is
90 * @set_suspend_disable: Mark the regulator as disabled when the system is
92 * @set_suspend_mode: Set the operating mode for the regulator when the
93 * system is suspended.
95 * This struct describes regulator operations which can be implemented by
96 * regulator chip drivers.
98 struct regulator_ops {
100 /* enumerate supported voltages */
101 int (*list_voltage) (struct regulator_dev *, unsigned selector);
103 /* get/set regulator voltage */
104 int (*set_voltage) (struct regulator_dev *, int min_uV, int max_uV,
106 int (*map_voltage)(struct regulator_dev *, int min_uV, int max_uV);
107 int (*set_voltage_sel) (struct regulator_dev *, unsigned selector);
108 int (*get_voltage) (struct regulator_dev *);
109 int (*get_voltage_sel) (struct regulator_dev *);
111 /* get/set regulator current */
112 int (*set_current_limit) (struct regulator_dev *,
113 int min_uA, int max_uA);
114 int (*get_current_limit) (struct regulator_dev *);
116 /* enable/disable regulator */
117 int (*enable) (struct regulator_dev *);
118 int (*disable) (struct regulator_dev *);
119 int (*is_enabled) (struct regulator_dev *);
121 /* get/set regulator operating mode (defined in consumer.h) */
122 int (*set_mode) (struct regulator_dev *, unsigned int mode);
123 unsigned int (*get_mode) (struct regulator_dev *);
125 /* Time taken to enable or set voltage on the regulator */
126 int (*enable_time) (struct regulator_dev *);
127 int (*set_ramp_delay) (struct regulator_dev *, int ramp_delay);
128 int (*set_voltage_time_sel) (struct regulator_dev *,
129 unsigned int old_selector,
130 unsigned int new_selector);
132 /* report regulator status ... most other accessors report
133 * control inputs, this reports results of combining inputs
134 * from Linux (and other sources) with the actual load.
135 * returns REGULATOR_STATUS_* or negative errno.
137 int (*get_status)(struct regulator_dev *);
139 /* get most efficient regulator operating mode for load */
140 unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV,
141 int output_uV, int load_uA);
143 /* control and report on bypass mode */
144 int (*set_bypass)(struct regulator_dev *dev, bool enable);
145 int (*get_bypass)(struct regulator_dev *dev, bool *enable);
147 /* the operations below are for configuration of regulator state when
148 * its parent PMIC enters a global STANDBY/HIBERNATE state */
150 /* set regulator suspend voltage */
151 int (*set_suspend_voltage) (struct regulator_dev *, int uV);
153 /* enable/disable regulator in suspend state */
154 int (*set_suspend_enable) (struct regulator_dev *);
155 int (*set_suspend_disable) (struct regulator_dev *);
157 /* set regulator suspend operating mode (defined in consumer.h) */
158 int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode);
162 * Regulators can either control voltage or current.
164 enum regulator_type {
170 * struct regulator_desc - Static regulator descriptor
172 * Each regulator registered with the core is described with a
173 * structure of this type and a struct regulator_config. This
174 * structure contains the non-varying parts of the regulator
177 * @name: Identifying name for the regulator.
178 * @supply_name: Identifying the regulator supply
179 * @id: Numerical identifier for the regulator.
180 * @ops: Regulator operations table.
181 * @irq: Interrupt number for the regulator.
182 * @type: Indicates if the regulator is a voltage or current regulator.
183 * @owner: Module providing the regulator, used for refcounting.
185 * @continuous_voltage_range: Indicates if the regulator can set any
186 * voltage within constrains range.
187 * @n_voltages: Number of selectors available for ops.list_voltage().
189 * @min_uV: Voltage given by the lowest selector (if linear mapping)
190 * @uV_step: Voltage increase with each selector (if linear mapping)
191 * @linear_min_sel: Minimal selector for starting linear mapping
192 * @ramp_delay: Time to settle down after voltage change (unit: uV/us)
193 * @volt_table: Voltage mapping table (if table based mapping)
195 * @vsel_reg: Register for selector when using regulator_regmap_X_voltage_
196 * @vsel_mask: Mask for register bitfield used for selector
197 * @apply_reg: Register for initiate voltage change on the output when
198 * using regulator_set_voltage_sel_regmap
199 * @apply_bit: Register bitfield used for initiate voltage change on the
200 * output when using regulator_set_voltage_sel_regmap
201 * @enable_reg: Register for control when using regmap enable/disable ops
202 * @enable_mask: Mask for control when using regmap enable/disable ops
204 * @enable_time: Time taken for initial enable of regulator (in uS).
206 struct regulator_desc {
208 const char *supply_name;
210 bool continuous_voltage_range;
212 struct regulator_ops *ops;
214 enum regulator_type type;
215 struct module *owner;
218 unsigned int uV_step;
219 unsigned int linear_min_sel;
220 unsigned int ramp_delay;
222 const unsigned int *volt_table;
224 unsigned int vsel_reg;
225 unsigned int vsel_mask;
226 unsigned int apply_reg;
227 unsigned int apply_bit;
228 unsigned int enable_reg;
229 unsigned int enable_mask;
230 unsigned int bypass_reg;
231 unsigned int bypass_mask;
233 unsigned int enable_time;
237 * struct regulator_config - Dynamic regulator descriptor
239 * Each regulator registered with the core is described with a
240 * structure of this type and a struct regulator_desc. This structure
241 * contains the runtime variable parts of the regulator description.
243 * @dev: struct device for the regulator
244 * @init_data: platform provided init data, passed through by driver
245 * @driver_data: private regulator data
246 * @of_node: OpenFirmware node to parse for device tree bindings (may be
248 * @regmap: regmap to use for core regmap helpers if dev_get_regulator() is
250 * @ena_gpio: GPIO controlling regulator enable.
251 * @ena_gpio_invert: Sense for GPIO enable control.
252 * @ena_gpio_flags: Flags to use when calling gpio_request_one()
254 struct regulator_config {
256 const struct regulator_init_data *init_data;
258 struct device_node *of_node;
259 struct regmap *regmap;
262 unsigned int ena_gpio_invert:1;
263 unsigned int ena_gpio_flags;
267 * struct regulator_dev
269 * Voltage / Current regulator class device. One for each
272 * This should *not* be used directly by anything except the regulator
273 * core and notification injection (which should take the mutex and do
274 * no other direct access).
276 struct regulator_dev {
277 const struct regulator_desc *desc;
283 /* lists we belong to */
284 struct list_head list; /* list of all regulators */
287 struct list_head consumer_list; /* consumers we supply */
289 struct blocking_notifier_head notifier;
290 struct mutex mutex; /* consumer lock */
291 struct module *owner;
293 struct regulation_constraints *constraints;
294 struct regulator *supply; /* for tree */
295 struct regmap *regmap;
297 struct delayed_work disable_work;
298 int deferred_disables;
300 void *reg_data; /* regulator_dev data */
302 struct dentry *debugfs;
304 struct regulator_enable_gpio *ena_pin;
305 unsigned int ena_gpio_state:1;
308 struct regulator_dev *
309 regulator_register(const struct regulator_desc *regulator_desc,
310 const struct regulator_config *config);
311 void regulator_unregister(struct regulator_dev *rdev);
313 int regulator_notifier_call_chain(struct regulator_dev *rdev,
314 unsigned long event, void *data);
316 void *rdev_get_drvdata(struct regulator_dev *rdev);
317 struct device *rdev_get_dev(struct regulator_dev *rdev);
318 int rdev_get_id(struct regulator_dev *rdev);
320 int regulator_mode_to_status(unsigned int);
322 int regulator_list_voltage_linear(struct regulator_dev *rdev,
323 unsigned int selector);
324 int regulator_list_voltage_table(struct regulator_dev *rdev,
325 unsigned int selector);
326 int regulator_map_voltage_linear(struct regulator_dev *rdev,
327 int min_uV, int max_uV);
328 int regulator_map_voltage_iterate(struct regulator_dev *rdev,
329 int min_uV, int max_uV);
330 int regulator_get_voltage_sel_regmap(struct regulator_dev *rdev);
331 int regulator_set_voltage_sel_regmap(struct regulator_dev *rdev, unsigned sel);
332 int regulator_is_enabled_regmap(struct regulator_dev *rdev);
333 int regulator_enable_regmap(struct regulator_dev *rdev);
334 int regulator_disable_regmap(struct regulator_dev *rdev);
335 int regulator_set_voltage_time_sel(struct regulator_dev *rdev,
336 unsigned int old_selector,
337 unsigned int new_selector);
338 int regulator_set_bypass_regmap(struct regulator_dev *rdev, bool enable);
339 int regulator_get_bypass_regmap(struct regulator_dev *rdev, bool *enable);
341 void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data);