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.
95 * @set_mode: Set the configured operating mode for the regulator.
96 * @get_mode: Get the configured operating mode for the regulator.
97 * @get_status: Return actual (not as-configured) status of regulator, as a
98 * REGULATOR_STATUS value (or negative errno)
99 * @get_optimum_mode: Get the most efficient operating mode for the regulator
100 * when running with the specified parameters.
102 * @set_bypass: Set the regulator in bypass mode.
103 * @get_bypass: Get the regulator bypass mode state.
105 * @enable_time: Time taken for the regulator voltage output voltage to
106 * stabilise after being enabled, in microseconds.
107 * @set_ramp_delay: Set the ramp delay for the regulator. The driver should
108 * select ramp delay equal to or less than(closest) ramp_delay.
109 * @set_voltage_time_sel: Time taken for the regulator voltage output voltage
110 * to stabilise after being set to a new value, in microseconds.
111 * The function provides the from and to voltage selector, the
112 * function should return the worst case.
114 * @set_suspend_voltage: Set the voltage for the regulator when the system
116 * @set_suspend_enable: Mark the regulator as enabled when the system is
118 * @set_suspend_disable: Mark the regulator as disabled when the system is
120 * @set_suspend_mode: Set the operating mode for the regulator when the
121 * system is suspended.
123 * This struct describes regulator operations which can be implemented by
124 * regulator chip drivers.
126 struct regulator_ops
{
128 /* enumerate supported voltages */
129 int (*list_voltage
) (struct regulator_dev
*, unsigned selector
);
131 /* get/set regulator voltage */
132 int (*set_voltage
) (struct regulator_dev
*, int min_uV
, int max_uV
,
134 int (*map_voltage
)(struct regulator_dev
*, int min_uV
, int max_uV
);
135 int (*set_voltage_sel
) (struct regulator_dev
*, unsigned selector
);
136 int (*get_voltage
) (struct regulator_dev
*);
137 int (*get_voltage_sel
) (struct regulator_dev
*);
139 /* get/set regulator current */
140 int (*set_current_limit
) (struct regulator_dev
*,
141 int min_uA
, int max_uA
);
142 int (*get_current_limit
) (struct regulator_dev
*);
144 /* enable/disable regulator */
145 int (*enable
) (struct regulator_dev
*);
146 int (*disable
) (struct regulator_dev
*);
147 int (*is_enabled
) (struct regulator_dev
*);
149 /* get/set regulator operating mode (defined in consumer.h) */
150 int (*set_mode
) (struct regulator_dev
*, unsigned int mode
);
151 unsigned int (*get_mode
) (struct regulator_dev
*);
153 /* Time taken to enable or set voltage on the regulator */
154 int (*enable_time
) (struct regulator_dev
*);
155 int (*set_ramp_delay
) (struct regulator_dev
*, int ramp_delay
);
156 int (*set_voltage_time_sel
) (struct regulator_dev
*,
157 unsigned int old_selector
,
158 unsigned int new_selector
);
160 /* report regulator status ... most other accessors report
161 * control inputs, this reports results of combining inputs
162 * from Linux (and other sources) with the actual load.
163 * returns REGULATOR_STATUS_* or negative errno.
165 int (*get_status
)(struct regulator_dev
*);
167 /* get most efficient regulator operating mode for load */
168 unsigned int (*get_optimum_mode
) (struct regulator_dev
*, int input_uV
,
169 int output_uV
, int load_uA
);
171 /* control and report on bypass mode */
172 int (*set_bypass
)(struct regulator_dev
*dev
, bool enable
);
173 int (*get_bypass
)(struct regulator_dev
*dev
, bool *enable
);
175 /* the operations below are for configuration of regulator state when
176 * its parent PMIC enters a global STANDBY/HIBERNATE state */
178 /* set regulator suspend voltage */
179 int (*set_suspend_voltage
) (struct regulator_dev
*, int uV
);
181 /* enable/disable regulator in suspend state */
182 int (*set_suspend_enable
) (struct regulator_dev
*);
183 int (*set_suspend_disable
) (struct regulator_dev
*);
185 /* set regulator suspend operating mode (defined in consumer.h) */
186 int (*set_suspend_mode
) (struct regulator_dev
*, unsigned int mode
);
190 * Regulators can either control voltage or current.
192 enum regulator_type
{
198 * struct regulator_desc - Static regulator descriptor
200 * Each regulator registered with the core is described with a
201 * structure of this type and a struct regulator_config. This
202 * structure contains the non-varying parts of the regulator
205 * @name: Identifying name for the regulator.
206 * @supply_name: Identifying the regulator supply
207 * @of_match: Name used to identify regulator in DT.
208 * @regulators_node: Name of node containing regulator definitions in DT.
209 * @of_parse_cb: Optional callback called only if of_match is present.
210 * Will be called for each regulator parsed from DT, during
212 * The regulator_config passed as argument to the callback will
213 * be a copy of config passed to regulator_register, valid only
214 * for this particular call. Callback may freely change the
215 * config but it cannot store it for later usage.
216 * Callback should return 0 on success or negative ERRNO
217 * indicating failure.
218 * @id: Numerical identifier for the regulator.
219 * @ops: Regulator operations table.
220 * @irq: Interrupt number for the regulator.
221 * @type: Indicates if the regulator is a voltage or current regulator.
222 * @owner: Module providing the regulator, used for refcounting.
224 * @continuous_voltage_range: Indicates if the regulator can set any
225 * voltage within constrains range.
226 * @n_voltages: Number of selectors available for ops.list_voltage().
228 * @min_uV: Voltage given by the lowest selector (if linear mapping)
229 * @uV_step: Voltage increase with each selector (if linear mapping)
230 * @linear_min_sel: Minimal selector for starting linear mapping
231 * @fixed_uV: Fixed voltage of rails.
232 * @ramp_delay: Time to settle down after voltage change (unit: uV/us)
233 * @linear_ranges: A constant table of possible voltage ranges.
234 * @n_linear_ranges: Number of entries in the @linear_ranges table.
235 * @volt_table: Voltage mapping table (if table based mapping)
237 * @vsel_reg: Register for selector when using regulator_regmap_X_voltage_
238 * @vsel_mask: Mask for register bitfield used for selector
239 * @apply_reg: Register for initiate voltage change on the output when
240 * using regulator_set_voltage_sel_regmap
241 * @apply_bit: Register bitfield used for initiate voltage change on the
242 * output when using regulator_set_voltage_sel_regmap
243 * @enable_reg: Register for control when using regmap enable/disable ops
244 * @enable_mask: Mask for control when using regmap enable/disable ops
245 * @enable_val: Enabling value for control when using regmap enable/disable ops
246 * @disable_val: Disabling value for control when using regmap enable/disable ops
247 * @enable_is_inverted: A flag to indicate set enable_mask bits to disable
248 * when using regulator_enable_regmap and friends APIs.
249 * @bypass_reg: Register for control when using regmap set_bypass
250 * @bypass_mask: Mask for control when using regmap set_bypass
251 * @bypass_val_on: Enabling value for control when using regmap set_bypass
252 * @bypass_val_off: Disabling value for control when using regmap set_bypass
254 * @enable_time: Time taken for initial enable of regulator (in uS).
255 * @off_on_delay: guard time (in uS), before re-enabling a regulator
257 * @of_map_mode: Maps a hardware mode defined in a DeviceTree to a standard mode
259 struct regulator_desc
{
261 const char *supply_name
;
262 const char *of_match
;
263 const char *regulators_node
;
264 int (*of_parse_cb
)(struct device_node
*,
265 const struct regulator_desc
*,
266 struct regulator_config
*);
268 bool continuous_voltage_range
;
270 const struct regulator_ops
*ops
;
272 enum regulator_type type
;
273 struct module
*owner
;
276 unsigned int uV_step
;
277 unsigned int linear_min_sel
;
279 unsigned int ramp_delay
;
281 const struct regulator_linear_range
*linear_ranges
;
284 const unsigned int *volt_table
;
286 unsigned int vsel_reg
;
287 unsigned int vsel_mask
;
288 unsigned int apply_reg
;
289 unsigned int apply_bit
;
290 unsigned int enable_reg
;
291 unsigned int enable_mask
;
292 unsigned int enable_val
;
293 unsigned int disable_val
;
294 bool enable_is_inverted
;
295 unsigned int bypass_reg
;
296 unsigned int bypass_mask
;
297 unsigned int bypass_val_on
;
298 unsigned int bypass_val_off
;
300 unsigned int enable_time
;
302 unsigned int off_on_delay
;
304 unsigned int (*of_map_mode
)(unsigned int mode
);
308 * struct regulator_config - Dynamic regulator descriptor
310 * Each regulator registered with the core is described with a
311 * structure of this type and a struct regulator_desc. This structure
312 * contains the runtime variable parts of the regulator description.
314 * @dev: struct device for the regulator
315 * @init_data: platform provided init data, passed through by driver
316 * @driver_data: private regulator data
317 * @of_node: OpenFirmware node to parse for device tree bindings (may be
319 * @regmap: regmap to use for core regmap helpers if dev_get_regulator() is
321 * @ena_gpio_initialized: GPIO controlling regulator enable was properly
322 * initialized, meaning that >= 0 is a valid gpio
323 * identifier and < 0 is a non existent gpio.
324 * @ena_gpio: GPIO controlling regulator enable.
325 * @ena_gpio_invert: Sense for GPIO enable control.
326 * @ena_gpio_flags: Flags to use when calling gpio_request_one()
328 struct regulator_config
{
330 const struct regulator_init_data
*init_data
;
332 struct device_node
*of_node
;
333 struct regmap
*regmap
;
335 bool ena_gpio_initialized
;
337 unsigned int ena_gpio_invert
:1;
338 unsigned int ena_gpio_flags
;
342 * struct regulator_dev
344 * Voltage / Current regulator class device. One for each
347 * This should *not* be used directly by anything except the regulator
348 * core and notification injection (which should take the mutex and do
349 * no other direct access).
351 struct regulator_dev
{
352 const struct regulator_desc
*desc
;
358 /* lists we belong to */
359 struct list_head list
; /* list of all regulators */
362 struct list_head consumer_list
; /* consumers we supply */
364 struct blocking_notifier_head notifier
;
365 struct mutex mutex
; /* consumer lock */
366 struct module
*owner
;
368 struct regulation_constraints
*constraints
;
369 struct regulator
*supply
; /* for tree */
370 struct regmap
*regmap
;
372 struct delayed_work disable_work
;
373 int deferred_disables
;
375 void *reg_data
; /* regulator_dev data */
377 struct dentry
*debugfs
;
379 struct regulator_enable_gpio
*ena_pin
;
380 unsigned int ena_gpio_state
:1;
382 /* time when this regulator was disabled last time */
383 unsigned long last_off_jiffy
;
386 struct regulator_dev
*
387 regulator_register(const struct regulator_desc
*regulator_desc
,
388 const struct regulator_config
*config
);
389 struct regulator_dev
*
390 devm_regulator_register(struct device
*dev
,
391 const struct regulator_desc
*regulator_desc
,
392 const struct regulator_config
*config
);
393 void regulator_unregister(struct regulator_dev
*rdev
);
394 void devm_regulator_unregister(struct device
*dev
, struct regulator_dev
*rdev
);
396 int regulator_notifier_call_chain(struct regulator_dev
*rdev
,
397 unsigned long event
, void *data
);
399 void *rdev_get_drvdata(struct regulator_dev
*rdev
);
400 struct device
*rdev_get_dev(struct regulator_dev
*rdev
);
401 int rdev_get_id(struct regulator_dev
*rdev
);
403 int regulator_mode_to_status(unsigned int);
405 int regulator_list_voltage_linear(struct regulator_dev
*rdev
,
406 unsigned int selector
);
407 int regulator_list_voltage_linear_range(struct regulator_dev
*rdev
,
408 unsigned int selector
);
409 int regulator_list_voltage_table(struct regulator_dev
*rdev
,
410 unsigned int selector
);
411 int regulator_map_voltage_linear(struct regulator_dev
*rdev
,
412 int min_uV
, int max_uV
);
413 int regulator_map_voltage_linear_range(struct regulator_dev
*rdev
,
414 int min_uV
, int max_uV
);
415 int regulator_map_voltage_iterate(struct regulator_dev
*rdev
,
416 int min_uV
, int max_uV
);
417 int regulator_map_voltage_ascend(struct regulator_dev
*rdev
,
418 int min_uV
, int max_uV
);
419 int regulator_get_voltage_sel_regmap(struct regulator_dev
*rdev
);
420 int regulator_set_voltage_sel_regmap(struct regulator_dev
*rdev
, unsigned sel
);
421 int regulator_is_enabled_regmap(struct regulator_dev
*rdev
);
422 int regulator_enable_regmap(struct regulator_dev
*rdev
);
423 int regulator_disable_regmap(struct regulator_dev
*rdev
);
424 int regulator_set_voltage_time_sel(struct regulator_dev
*rdev
,
425 unsigned int old_selector
,
426 unsigned int new_selector
);
427 int regulator_set_bypass_regmap(struct regulator_dev
*rdev
, bool enable
);
428 int regulator_get_bypass_regmap(struct regulator_dev
*rdev
, bool *enable
);
430 void *regulator_get_init_drvdata(struct regulator_init_data
*reg_init_data
);