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 * Specify a range of voltages for regulator_map_linar_range() and
44 * regulator_list_linear_range().
46 * @min_uV: Lowest voltage in range
47 * @max_uV: Highest voltage in range
48 * @min_sel: Lowest selector for range
49 * @max_sel: Highest selector for range
52 struct regulator_linear_range
{
61 * struct regulator_ops - regulator operations.
63 * @enable: Configure the regulator as enabled.
64 * @disable: Configure the regulator as disabled.
65 * @is_enabled: Return 1 if the regulator is enabled, 0 if not.
66 * May also return negative errno.
68 * @set_voltage: Set the voltage for the regulator within the range specified.
69 * The driver should select the voltage closest to min_uV.
70 * @set_voltage_sel: Set the voltage for the regulator using the specified
72 * @map_voltage: Convert a voltage into a selector
73 * @get_voltage: Return the currently configured voltage for the regulator.
74 * @get_voltage_sel: Return the currently configured voltage selector for the
76 * @list_voltage: Return one of the supported voltages, in microvolts; zero
77 * if the selector indicates a voltage that is unusable on this system;
78 * or negative errno. Selectors range from zero to one less than
79 * regulator_desc.n_voltages. Voltages may be reported in any order.
81 * @set_current_limit: Configure a limit for a current-limited regulator.
82 * The driver should select the current closest to max_uA.
83 * @get_current_limit: Get the configured limit for a current-limited regulator.
85 * @set_mode: Set the configured operating mode for the regulator.
86 * @get_mode: Get the configured operating mode for the regulator.
87 * @get_status: Return actual (not as-configured) status of regulator, as a
88 * REGULATOR_STATUS value (or negative errno)
89 * @get_optimum_mode: Get the most efficient operating mode for the regulator
90 * when running with the specified parameters.
92 * @set_bypass: Set the regulator in bypass mode.
93 * @get_bypass: Get the regulator bypass mode state.
95 * @enable_time: Time taken for the regulator voltage output voltage to
96 * stabilise after being enabled, in microseconds.
97 * @set_ramp_delay: Set the ramp delay for the regulator. The driver should
98 * select ramp delay equal to or less than(closest) ramp_delay.
99 * @set_voltage_time_sel: Time taken for the regulator voltage output voltage
100 * to stabilise after being set to a new value, in microseconds.
101 * The function provides the from and to voltage selector, the
102 * function should return the worst case.
104 * @set_suspend_voltage: Set the voltage for the regulator when the system
106 * @set_suspend_enable: Mark the regulator as enabled when the system is
108 * @set_suspend_disable: Mark the regulator as disabled when the system is
110 * @set_suspend_mode: Set the operating mode for the regulator when the
111 * system is suspended.
113 * This struct describes regulator operations which can be implemented by
114 * regulator chip drivers.
116 struct regulator_ops
{
118 /* enumerate supported voltages */
119 int (*list_voltage
) (struct regulator_dev
*, unsigned selector
);
121 /* get/set regulator voltage */
122 int (*set_voltage
) (struct regulator_dev
*, int min_uV
, int max_uV
,
124 int (*map_voltage
)(struct regulator_dev
*, int min_uV
, int max_uV
);
125 int (*set_voltage_sel
) (struct regulator_dev
*, unsigned selector
);
126 int (*get_voltage
) (struct regulator_dev
*);
127 int (*get_voltage_sel
) (struct regulator_dev
*);
129 /* get/set regulator current */
130 int (*set_current_limit
) (struct regulator_dev
*,
131 int min_uA
, int max_uA
);
132 int (*get_current_limit
) (struct regulator_dev
*);
134 /* enable/disable regulator */
135 int (*enable
) (struct regulator_dev
*);
136 int (*disable
) (struct regulator_dev
*);
137 int (*is_enabled
) (struct regulator_dev
*);
139 /* get/set regulator operating mode (defined in consumer.h) */
140 int (*set_mode
) (struct regulator_dev
*, unsigned int mode
);
141 unsigned int (*get_mode
) (struct regulator_dev
*);
143 /* Time taken to enable or set voltage on the regulator */
144 int (*enable_time
) (struct regulator_dev
*);
145 int (*set_ramp_delay
) (struct regulator_dev
*, int ramp_delay
);
146 int (*set_voltage_time_sel
) (struct regulator_dev
*,
147 unsigned int old_selector
,
148 unsigned int new_selector
);
150 /* report regulator status ... most other accessors report
151 * control inputs, this reports results of combining inputs
152 * from Linux (and other sources) with the actual load.
153 * returns REGULATOR_STATUS_* or negative errno.
155 int (*get_status
)(struct regulator_dev
*);
157 /* get most efficient regulator operating mode for load */
158 unsigned int (*get_optimum_mode
) (struct regulator_dev
*, int input_uV
,
159 int output_uV
, int load_uA
);
161 /* control and report on bypass mode */
162 int (*set_bypass
)(struct regulator_dev
*dev
, bool enable
);
163 int (*get_bypass
)(struct regulator_dev
*dev
, bool *enable
);
165 /* the operations below are for configuration of regulator state when
166 * its parent PMIC enters a global STANDBY/HIBERNATE state */
168 /* set regulator suspend voltage */
169 int (*set_suspend_voltage
) (struct regulator_dev
*, int uV
);
171 /* enable/disable regulator in suspend state */
172 int (*set_suspend_enable
) (struct regulator_dev
*);
173 int (*set_suspend_disable
) (struct regulator_dev
*);
175 /* set regulator suspend operating mode (defined in consumer.h) */
176 int (*set_suspend_mode
) (struct regulator_dev
*, unsigned int mode
);
180 * Regulators can either control voltage or current.
182 enum regulator_type
{
188 * struct regulator_desc - Static regulator descriptor
190 * Each regulator registered with the core is described with a
191 * structure of this type and a struct regulator_config. This
192 * structure contains the non-varying parts of the regulator
195 * @name: Identifying name for the regulator.
196 * @supply_name: Identifying the regulator supply
197 * @id: Numerical identifier for the regulator.
198 * @ops: Regulator operations table.
199 * @irq: Interrupt number for the regulator.
200 * @type: Indicates if the regulator is a voltage or current regulator.
201 * @owner: Module providing the regulator, used for refcounting.
203 * @continuous_voltage_range: Indicates if the regulator can set any
204 * voltage within constrains range.
205 * @n_voltages: Number of selectors available for ops.list_voltage().
207 * @min_uV: Voltage given by the lowest selector (if linear mapping)
208 * @uV_step: Voltage increase with each selector (if linear mapping)
209 * @linear_min_sel: Minimal selector for starting linear mapping
210 * @ramp_delay: Time to settle down after voltage change (unit: uV/us)
211 * @volt_table: Voltage mapping table (if table based mapping)
213 * @vsel_reg: Register for selector when using regulator_regmap_X_voltage_
214 * @vsel_mask: Mask for register bitfield used for selector
215 * @apply_reg: Register for initiate voltage change on the output when
216 * using regulator_set_voltage_sel_regmap
217 * @apply_bit: Register bitfield used for initiate voltage change on the
218 * output when using regulator_set_voltage_sel_regmap
219 * @enable_reg: Register for control when using regmap enable/disable ops
220 * @enable_mask: Mask for control when using regmap enable/disable ops
221 * @enable_is_inverted: A flag to indicate set enable_mask bits to disable
222 * when using regulator_enable_regmap and friends APIs.
223 * @bypass_reg: Register for control when using regmap set_bypass
224 * @bypass_mask: Mask for control when using regmap set_bypass
226 * @enable_time: Time taken for initial enable of regulator (in uS).
228 struct regulator_desc
{
230 const char *supply_name
;
232 bool continuous_voltage_range
;
234 struct regulator_ops
*ops
;
236 enum regulator_type type
;
237 struct module
*owner
;
240 unsigned int uV_step
;
241 unsigned int linear_min_sel
;
242 unsigned int ramp_delay
;
244 const struct regulator_linear_range
*linear_ranges
;
247 const unsigned int *volt_table
;
249 unsigned int vsel_reg
;
250 unsigned int vsel_mask
;
251 unsigned int apply_reg
;
252 unsigned int apply_bit
;
253 unsigned int enable_reg
;
254 unsigned int enable_mask
;
255 bool enable_is_inverted
;
256 unsigned int bypass_reg
;
257 unsigned int bypass_mask
;
259 unsigned int enable_time
;
263 * struct regulator_config - Dynamic regulator descriptor
265 * Each regulator registered with the core is described with a
266 * structure of this type and a struct regulator_desc. This structure
267 * contains the runtime variable parts of the regulator description.
269 * @dev: struct device for the regulator
270 * @init_data: platform provided init data, passed through by driver
271 * @driver_data: private regulator data
272 * @of_node: OpenFirmware node to parse for device tree bindings (may be
274 * @regmap: regmap to use for core regmap helpers if dev_get_regulator() is
276 * @ena_gpio: GPIO controlling regulator enable.
277 * @ena_gpio_invert: Sense for GPIO enable control.
278 * @ena_gpio_flags: Flags to use when calling gpio_request_one()
280 struct regulator_config
{
282 const struct regulator_init_data
*init_data
;
284 struct device_node
*of_node
;
285 struct regmap
*regmap
;
288 unsigned int ena_gpio_invert
:1;
289 unsigned int ena_gpio_flags
;
293 * struct regulator_dev
295 * Voltage / Current regulator class device. One for each
298 * This should *not* be used directly by anything except the regulator
299 * core and notification injection (which should take the mutex and do
300 * no other direct access).
302 struct regulator_dev
{
303 const struct regulator_desc
*desc
;
309 /* lists we belong to */
310 struct list_head list
; /* list of all regulators */
313 struct list_head consumer_list
; /* consumers we supply */
315 struct blocking_notifier_head notifier
;
316 struct mutex mutex
; /* consumer lock */
317 struct module
*owner
;
319 struct regulation_constraints
*constraints
;
320 struct regulator
*supply
; /* for tree */
321 struct regmap
*regmap
;
323 struct delayed_work disable_work
;
324 int deferred_disables
;
326 void *reg_data
; /* regulator_dev data */
328 struct dentry
*debugfs
;
330 struct regulator_enable_gpio
*ena_pin
;
331 unsigned int ena_gpio_state
:1;
334 struct regulator_dev
*
335 regulator_register(const struct regulator_desc
*regulator_desc
,
336 const struct regulator_config
*config
);
337 void regulator_unregister(struct regulator_dev
*rdev
);
339 int regulator_notifier_call_chain(struct regulator_dev
*rdev
,
340 unsigned long event
, void *data
);
342 void *rdev_get_drvdata(struct regulator_dev
*rdev
);
343 struct device
*rdev_get_dev(struct regulator_dev
*rdev
);
344 int rdev_get_id(struct regulator_dev
*rdev
);
346 int regulator_mode_to_status(unsigned int);
348 int regulator_list_voltage_linear(struct regulator_dev
*rdev
,
349 unsigned int selector
);
350 int regulator_list_voltage_linear_range(struct regulator_dev
*rdev
,
351 unsigned int selector
);
352 int regulator_list_voltage_table(struct regulator_dev
*rdev
,
353 unsigned int selector
);
354 int regulator_map_voltage_linear(struct regulator_dev
*rdev
,
355 int min_uV
, int max_uV
);
356 int regulator_map_voltage_linear_range(struct regulator_dev
*rdev
,
357 int min_uV
, int max_uV
);
358 int regulator_map_voltage_iterate(struct regulator_dev
*rdev
,
359 int min_uV
, int max_uV
);
360 int regulator_map_voltage_ascend(struct regulator_dev
*rdev
,
361 int min_uV
, int max_uV
);
362 int regulator_get_voltage_sel_regmap(struct regulator_dev
*rdev
);
363 int regulator_set_voltage_sel_regmap(struct regulator_dev
*rdev
, unsigned sel
);
364 int regulator_is_enabled_regmap(struct regulator_dev
*rdev
);
365 int regulator_enable_regmap(struct regulator_dev
*rdev
);
366 int regulator_disable_regmap(struct regulator_dev
*rdev
);
367 int regulator_set_voltage_time_sel(struct regulator_dev
*rdev
,
368 unsigned int old_selector
,
369 unsigned int new_selector
);
370 int regulator_set_bypass_regmap(struct regulator_dev
*rdev
, bool enable
);
371 int regulator_get_bypass_regmap(struct regulator_dev
*rdev
, bool *enable
);
373 void *regulator_get_init_drvdata(struct regulator_init_data
*reg_init_data
);