blob: 1392022fe509a7a18e0e9aad49ac0a747ca71423 [file] [log] [blame]
Liam Girdwood571a3542008-04-30 15:42:28 +01001/*
2 * driver.h -- SoC Regulator driver support.
3 *
4 * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC.
5 *
Liam Girdwood1dd68f02009-02-02 21:43:31 +00006 * Author: Liam Girdwood <lrg@slimlogic.co.uk>
Liam Girdwood571a3542008-04-30 15:42:28 +01007 *
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.
11 *
12 * Regulator Driver Interface.
13 */
14
15#ifndef __LINUX_REGULATOR_DRIVER_H_
16#define __LINUX_REGULATOR_DRIVER_H_
17
18#include <linux/device.h>
Paul Gortmakerced55d42011-07-17 16:24:35 -040019#include <linux/notifier.h>
Liam Girdwood571a3542008-04-30 15:42:28 +010020#include <linux/regulator/consumer.h>
21
Mark Brown65b19ce2012-04-15 11:16:05 +010022struct regmap;
Liam Girdwood571a3542008-04-30 15:42:28 +010023struct regulator_dev;
Krzysztof Kozlowskibfa21a02015-01-05 12:48:42 +010024struct regulator_config;
Liam Girdwooda5766f12008-10-10 13:22:20 +010025struct regulator_init_data;
Kim, Milof19b00d2013-02-18 06:50:39 +000026struct regulator_enable_gpio;
Liam Girdwood571a3542008-04-30 15:42:28 +010027
David Brownell853116a2009-01-14 23:03:17 -080028enum 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,
Mark Brownf59c8f92012-08-31 10:36:37 -070037 /* The regulator is enabled but not regulating */
38 REGULATOR_STATUS_BYPASS,
Krystian Garbaciak1beaf762012-07-12 13:53:35 +010039 /* in case that any other status doesn't apply */
40 REGULATOR_STATUS_UNDEFINED,
David Brownell853116a2009-01-14 23:03:17 -080041};
42
Liam Girdwood571a3542008-04-30 15:42:28 +010043/**
Randy Dunlap7c2330f2013-09-16 18:08:02 -070044 * struct regulator_linear_range - specify linear voltage ranges
45 *
Mark Brown94d33c02013-07-02 22:52:41 +010046 * Specify a range of voltages for regulator_map_linar_range() and
47 * regulator_list_linear_range().
48 *
49 * @min_uV: Lowest voltage in range
Mark Brown94d33c02013-07-02 22:52:41 +010050 * @min_sel: Lowest selector for range
51 * @max_sel: Highest selector for range
52 * @uV_step: Step size
53 */
54struct regulator_linear_range {
55 unsigned int min_uV;
Mark Brown94d33c02013-07-02 22:52:41 +010056 unsigned int min_sel;
57 unsigned int max_sel;
58 unsigned int uV_step;
59};
60
Axel Lin8828bae2013-10-11 09:32:18 +080061/* Initialize struct regulator_linear_range */
62#define REGULATOR_LINEAR_RANGE(_min_uV, _min_sel, _max_sel, _step_uV) \
63{ \
64 .min_uV = _min_uV, \
65 .min_sel = _min_sel, \
66 .max_sel = _max_sel, \
67 .uV_step = _step_uV, \
68}
69
Mark Brown94d33c02013-07-02 22:52:41 +010070/**
Liam Girdwood571a3542008-04-30 15:42:28 +010071 * struct regulator_ops - regulator operations.
72 *
David Brownell3b2a6062009-02-26 13:28:41 -080073 * @enable: Configure the regulator as enabled.
74 * @disable: Configure the regulator as disabled.
Wolfram Sangd87b9692009-09-18 22:44:46 +020075 * @is_enabled: Return 1 if the regulator is enabled, 0 if not.
76 * May also return negative errno.
Mark Brownc8e7e462008-12-31 12:52:42 +000077 *
78 * @set_voltage: Set the voltage for the regulator within the range specified.
79 * The driver should select the voltage closest to min_uV.
Mark Browne8eef822010-12-12 14:36:17 +000080 * @set_voltage_sel: Set the voltage for the regulator using the specified
81 * selector.
Mark Browne843fc42012-05-09 21:16:06 +010082 * @map_voltage: Convert a voltage into a selector
Mark Brownc8e7e462008-12-31 12:52:42 +000083 * @get_voltage: Return the currently configured voltage for the regulator.
Mark Brown476c2d82010-12-10 17:28:07 +000084 * @get_voltage_sel: Return the currently configured voltage selector for the
85 * regulator.
David Brownell4367cfd2009-02-26 11:48:36 -080086 * @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.
Mark Brownc8e7e462008-12-31 12:52:42 +000090 *
Mark Brownc8e7e462008-12-31 12:52:42 +000091 * @set_current_limit: Configure a limit for a current-limited regulator.
Axel Lin89009e12012-08-08 20:17:18 +080092 * The driver should select the current closest to max_uA.
David Brownell3b2a6062009-02-26 13:28:41 -080093 * @get_current_limit: Get the configured limit for a current-limited regulator.
Stephen Boyd36e4f832015-06-11 17:37:06 -070094 * @set_input_current_limit: Configure an input limit.
Mark Brownc8e7e462008-12-31 12:52:42 +000095 *
Luis de Bethencourtabf2f822016-03-23 11:35:39 +000096 * @set_over_current_protection: Support capability of automatically shutting
97 * down when detecting an over current event.
98 *
Laxman Dewangan670666b2016-03-02 16:24:46 +053099 * @set_active_discharge: Set active discharge enable/disable of regulators.
100 *
Randy Dunlap9f6532512009-04-03 21:31:30 -0700101 * @set_mode: Set the configured operating mode for the regulator.
David Brownell3b2a6062009-02-26 13:28:41 -0800102 * @get_mode: Get the configured operating mode for the regulator.
103 * @get_status: Return actual (not as-configured) status of regulator, as a
104 * REGULATOR_STATUS value (or negative errno)
Mark Brownc8e7e462008-12-31 12:52:42 +0000105 * @get_optimum_mode: Get the most efficient operating mode for the regulator
106 * when running with the specified parameters.
Bjorn Andersson8f4490e2015-02-11 19:39:12 -0800107 * @set_load: Set the load for the regulator.
Mark Brownc8e7e462008-12-31 12:52:42 +0000108 *
Mark Brownf59c8f92012-08-31 10:36:37 -0700109 * @set_bypass: Set the regulator in bypass mode.
110 * @get_bypass: Get the regulator bypass mode state.
111 *
Mark Brown31aae2b2009-12-21 12:21:52 +0000112 * @enable_time: Time taken for the regulator voltage output voltage to
Linus Walleij77af1b2642011-03-17 13:24:36 +0100113 * stabilise after being enabled, in microseconds.
Yadwinder Singh Brar6f0b2c62012-06-11 17:41:08 +0530114 * @set_ramp_delay: Set the ramp delay for the regulator. The driver should
115 * select ramp delay equal to or less than(closest) ramp_delay.
Linus Walleij77af1b2642011-03-17 13:24:36 +0100116 * @set_voltage_time_sel: Time taken for the regulator voltage output voltage
117 * to stabilise after being set to a new value, in microseconds.
118 * The function provides the from and to voltage selector, the
119 * function should return the worst case.
Stephen Boydc751ad02015-06-12 15:48:06 -0700120 * @set_soft_start: Enable soft start for the regulator.
Mark Brown31aae2b2009-12-21 12:21:52 +0000121 *
Mark Brownc8e7e462008-12-31 12:52:42 +0000122 * @set_suspend_voltage: Set the voltage for the regulator when the system
123 * is suspended.
124 * @set_suspend_enable: Mark the regulator as enabled when the system is
125 * suspended.
126 * @set_suspend_disable: Mark the regulator as disabled when the system is
127 * suspended.
128 * @set_suspend_mode: Set the operating mode for the regulator when the
129 * system is suspended.
David Brownell3b2a6062009-02-26 13:28:41 -0800130 *
Stephen Boyd23c779b2015-06-11 17:37:04 -0700131 * @set_pull_down: Configure the regulator to pull down when the regulator
132 * is disabled.
133 *
David Brownell3b2a6062009-02-26 13:28:41 -0800134 * This struct describes regulator operations which can be implemented by
135 * regulator chip drivers.
Liam Girdwood571a3542008-04-30 15:42:28 +0100136 */
137struct regulator_ops {
138
David Brownell4367cfd2009-02-26 11:48:36 -0800139 /* enumerate supported voltages */
140 int (*list_voltage) (struct regulator_dev *, unsigned selector);
141
Liam Girdwood571a3542008-04-30 15:42:28 +0100142 /* get/set regulator voltage */
Mark Brown3a93f2a2010-11-10 14:38:29 +0000143 int (*set_voltage) (struct regulator_dev *, int min_uV, int max_uV,
144 unsigned *selector);
Mark Browne843fc42012-05-09 21:16:06 +0100145 int (*map_voltage)(struct regulator_dev *, int min_uV, int max_uV);
Mark Browne8eef822010-12-12 14:36:17 +0000146 int (*set_voltage_sel) (struct regulator_dev *, unsigned selector);
Liam Girdwood571a3542008-04-30 15:42:28 +0100147 int (*get_voltage) (struct regulator_dev *);
Mark Brown476c2d82010-12-10 17:28:07 +0000148 int (*get_voltage_sel) (struct regulator_dev *);
Liam Girdwood571a3542008-04-30 15:42:28 +0100149
150 /* get/set regulator current */
151 int (*set_current_limit) (struct regulator_dev *,
152 int min_uA, int max_uA);
153 int (*get_current_limit) (struct regulator_dev *);
154
Stephen Boyd36e4f832015-06-11 17:37:06 -0700155 int (*set_input_current_limit) (struct regulator_dev *, int lim_uA);
Stephen Boyd3a003ba2015-07-17 14:41:54 -0700156 int (*set_over_current_protection) (struct regulator_dev *);
Laxman Dewangan670666b2016-03-02 16:24:46 +0530157 int (*set_active_discharge) (struct regulator_dev *, bool enable);
Stephen Boyd36e4f832015-06-11 17:37:06 -0700158
Liam Girdwood571a3542008-04-30 15:42:28 +0100159 /* enable/disable regulator */
160 int (*enable) (struct regulator_dev *);
161 int (*disable) (struct regulator_dev *);
162 int (*is_enabled) (struct regulator_dev *);
163
Kim, Milofde297bb2012-02-16 22:41:32 -0800164 /* get/set regulator operating mode (defined in consumer.h) */
Liam Girdwood571a3542008-04-30 15:42:28 +0100165 int (*set_mode) (struct regulator_dev *, unsigned int mode);
166 unsigned int (*get_mode) (struct regulator_dev *);
167
Linus Walleij77af1b2642011-03-17 13:24:36 +0100168 /* Time taken to enable or set voltage on the regulator */
Mark Brown31aae2b2009-12-21 12:21:52 +0000169 int (*enable_time) (struct regulator_dev *);
Yadwinder Singh Brar6f0b2c62012-06-11 17:41:08 +0530170 int (*set_ramp_delay) (struct regulator_dev *, int ramp_delay);
Linus Walleij77af1b2642011-03-17 13:24:36 +0100171 int (*set_voltage_time_sel) (struct regulator_dev *,
172 unsigned int old_selector,
173 unsigned int new_selector);
Mark Brown31aae2b2009-12-21 12:21:52 +0000174
Stephen Boyd57f66b72015-06-11 17:37:05 -0700175 int (*set_soft_start) (struct regulator_dev *);
176
David Brownell853116a2009-01-14 23:03:17 -0800177 /* report regulator status ... most other accessors report
178 * control inputs, this reports results of combining inputs
179 * from Linux (and other sources) with the actual load.
David Brownell3b2a6062009-02-26 13:28:41 -0800180 * returns REGULATOR_STATUS_* or negative errno.
David Brownell853116a2009-01-14 23:03:17 -0800181 */
182 int (*get_status)(struct regulator_dev *);
183
Liam Girdwood571a3542008-04-30 15:42:28 +0100184 /* get most efficient regulator operating mode for load */
185 unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV,
186 int output_uV, int load_uA);
Bjorn Andersson8f4490e2015-02-11 19:39:12 -0800187 /* set the load on the regulator */
188 int (*set_load)(struct regulator_dev *, int load_uA);
Liam Girdwood571a3542008-04-30 15:42:28 +0100189
Mark Brownf59c8f92012-08-31 10:36:37 -0700190 /* control and report on bypass mode */
191 int (*set_bypass)(struct regulator_dev *dev, bool enable);
192 int (*get_bypass)(struct regulator_dev *dev, bool *enable);
193
Liam Girdwood571a3542008-04-30 15:42:28 +0100194 /* the operations below are for configuration of regulator state when
Mark Brown3de89602008-09-09 16:21:17 +0100195 * its parent PMIC enters a global STANDBY/HIBERNATE state */
Liam Girdwood571a3542008-04-30 15:42:28 +0100196
197 /* set regulator suspend voltage */
198 int (*set_suspend_voltage) (struct regulator_dev *, int uV);
199
200 /* enable/disable regulator in suspend state */
201 int (*set_suspend_enable) (struct regulator_dev *);
202 int (*set_suspend_disable) (struct regulator_dev *);
203
Kim, Milofde297bb2012-02-16 22:41:32 -0800204 /* set regulator suspend operating mode (defined in consumer.h) */
Liam Girdwood571a3542008-04-30 15:42:28 +0100205 int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode);
Stephen Boyd23c779b2015-06-11 17:37:04 -0700206
207 int (*set_pull_down) (struct regulator_dev *);
Liam Girdwood571a3542008-04-30 15:42:28 +0100208};
209
210/*
211 * Regulators can either control voltage or current.
212 */
213enum regulator_type {
214 REGULATOR_VOLTAGE,
215 REGULATOR_CURRENT,
216};
217
218/**
Mark Brownc1727082012-04-04 00:50:22 +0100219 * struct regulator_desc - Static regulator descriptor
Liam Girdwood571a3542008-04-30 15:42:28 +0100220 *
Mark Brownc1727082012-04-04 00:50:22 +0100221 * Each regulator registered with the core is described with a
222 * structure of this type and a struct regulator_config. This
223 * structure contains the non-varying parts of the regulator
224 * description.
Mark Brownc8e7e462008-12-31 12:52:42 +0000225 *
226 * @name: Identifying name for the regulator.
Rajendra Nayak69511a42011-11-18 16:47:20 +0530227 * @supply_name: Identifying the regulator supply
Mark Browna0c7b162014-09-09 23:13:57 +0100228 * @of_match: Name used to identify regulator in DT.
229 * @regulators_node: Name of node containing regulator definitions in DT.
Krzysztof Kozlowskibfa21a02015-01-05 12:48:42 +0100230 * @of_parse_cb: Optional callback called only if of_match is present.
231 * Will be called for each regulator parsed from DT, during
232 * init_data parsing.
233 * The regulator_config passed as argument to the callback will
234 * be a copy of config passed to regulator_register, valid only
235 * for this particular call. Callback may freely change the
236 * config but it cannot store it for later usage.
237 * Callback should return 0 on success or negative ERRNO
238 * indicating failure.
Mark Brownc8e7e462008-12-31 12:52:42 +0000239 * @id: Numerical identifier for the regulator.
240 * @ops: Regulator operations table.
Randy Dunlap0ba48872009-01-08 11:50:23 -0800241 * @irq: Interrupt number for the regulator.
Mark Brownc8e7e462008-12-31 12:52:42 +0000242 * @type: Indicates if the regulator is a voltage or current regulator.
243 * @owner: Module providing the regulator, used for refcounting.
Mark Brownbca7bbf2012-05-09 21:38:33 +0100244 *
Pawel Mollbd7a2b62012-09-24 18:56:53 +0100245 * @continuous_voltage_range: Indicates if the regulator can set any
246 * voltage within constrains range.
Mark Brownbca7bbf2012-05-09 21:38:33 +0100247 * @n_voltages: Number of selectors available for ops.list_voltage().
248 *
249 * @min_uV: Voltage given by the lowest selector (if linear mapping)
250 * @uV_step: Voltage increase with each selector (if linear mapping)
Axel Lin33234e72012-11-27 10:24:33 +0800251 * @linear_min_sel: Minimal selector for starting linear mapping
Laxman Dewangan5a523602013-09-10 15:45:05 +0530252 * @fixed_uV: Fixed voltage of rails.
Axel Linea38d132012-06-18 14:03:16 +0800253 * @ramp_delay: Time to settle down after voltage change (unit: uV/us)
Sascha Hauer5abe4f22015-10-13 12:45:26 +0200254 * @min_dropout_uV: The minimum dropout voltage this regulator can handle
Randy Dunlapa8dbfee2014-08-27 14:31:24 -0700255 * @linear_ranges: A constant table of possible voltage ranges.
256 * @n_linear_ranges: Number of entries in the @linear_ranges table.
Axel Lincffc9592012-05-20 10:30:21 +0800257 * @volt_table: Voltage mapping table (if table based mapping)
Mark Brownbca7bbf2012-05-09 21:38:33 +0100258 *
Mark Brown4ab5b3d2012-04-15 11:23:30 +0100259 * @vsel_reg: Register for selector when using regulator_regmap_X_voltage_
260 * @vsel_mask: Mask for register bitfield used for selector
Luis de Bethencourtd13d3a52016-03-23 11:24:47 +0000261 * @csel_reg: Register for TPS65218 LS3 current regulator
262 * @csel_mask: Mask for TPS65218 LS3 current regulator
Axel Linc8520b42012-12-18 09:30:10 +0800263 * @apply_reg: Register for initiate voltage change on the output when
264 * using regulator_set_voltage_sel_regmap
265 * @apply_bit: Register bitfield used for initiate voltage change on the
266 * output when using regulator_set_voltage_sel_regmap
Mark Browncd6dffb2012-04-15 12:37:47 +0100267 * @enable_reg: Register for control when using regmap enable/disable ops
268 * @enable_mask: Mask for control when using regmap enable/disable ops
Carlo Caioneca5d1b32014-03-05 22:11:29 +0100269 * @enable_val: Enabling value for control when using regmap enable/disable ops
270 * @disable_val: Disabling value for control when using regmap enable/disable ops
Axel Lin51dcdaf2013-03-05 14:16:00 +0800271 * @enable_is_inverted: A flag to indicate set enable_mask bits to disable
272 * when using regulator_enable_regmap and friends APIs.
Nishanth Menon5838b032013-02-28 18:12:47 -0600273 * @bypass_reg: Register for control when using regmap set_bypass
274 * @bypass_mask: Mask for control when using regmap set_bypass
Carlo Caioneca5d1b32014-03-05 22:11:29 +0100275 * @bypass_val_on: Enabling value for control when using regmap set_bypass
276 * @bypass_val_off: Disabling value for control when using regmap set_bypass
Laxman Dewangan354794d2016-03-02 16:24:47 +0530277 * @active_discharge_off: Enabling value for control when using regmap
278 * set_active_discharge
279 * @active_discharge_on: Disabling value for control when using regmap
280 * set_active_discharge
281 * @active_discharge_mask: Mask for control when using regmap
282 * set_active_discharge
283 * @active_discharge_reg: Register for control when using regmap
284 * set_active_discharge
Mark Brown79511ed2012-06-27 14:23:10 +0100285 *
286 * @enable_time: Time taken for initial enable of regulator (in uS).
Guodong Xu871f5652014-08-13 19:33:40 +0800287 * @off_on_delay: guard time (in uS), before re-enabling a regulator
Javier Martinez Canillas87e1e0f2014-11-10 14:43:52 +0100288 *
289 * @of_map_mode: Maps a hardware mode defined in a DeviceTree to a standard mode
Liam Girdwood571a3542008-04-30 15:42:28 +0100290 */
291struct regulator_desc {
292 const char *name;
Rajendra Nayak69511a42011-11-18 16:47:20 +0530293 const char *supply_name;
Mark Browna0c7b162014-09-09 23:13:57 +0100294 const char *of_match;
295 const char *regulators_node;
Krzysztof Kozlowskibfa21a02015-01-05 12:48:42 +0100296 int (*of_parse_cb)(struct device_node *,
297 const struct regulator_desc *,
298 struct regulator_config *);
Liam Girdwood571a3542008-04-30 15:42:28 +0100299 int id;
Pawel Mollbd7a2b62012-09-24 18:56:53 +0100300 bool continuous_voltage_range;
David Brownell4367cfd2009-02-26 11:48:36 -0800301 unsigned n_voltages;
Axel Lindf11e502014-08-21 10:11:34 +0800302 const struct regulator_ops *ops;
Liam Girdwood571a3542008-04-30 15:42:28 +0100303 int irq;
304 enum regulator_type type;
305 struct module *owner;
Mark Brown4ab5b3d2012-04-15 11:23:30 +0100306
Mark Brownbca7bbf2012-05-09 21:38:33 +0100307 unsigned int min_uV;
308 unsigned int uV_step;
Axel Lin33234e72012-11-27 10:24:33 +0800309 unsigned int linear_min_sel;
Laxman Dewangan5a523602013-09-10 15:45:05 +0530310 int fixed_uV;
Yadwinder Singh Brar98a175b2012-06-09 16:40:38 +0530311 unsigned int ramp_delay;
Sascha Hauer5abe4f22015-10-13 12:45:26 +0200312 int min_dropout_uV;
Mark Brownbca7bbf2012-05-09 21:38:33 +0100313
Mark Brown94d33c02013-07-02 22:52:41 +0100314 const struct regulator_linear_range *linear_ranges;
315 int n_linear_ranges;
316
Axel Lincffc9592012-05-20 10:30:21 +0800317 const unsigned int *volt_table;
318
Mark Brown4ab5b3d2012-04-15 11:23:30 +0100319 unsigned int vsel_reg;
320 unsigned int vsel_mask;
Nikita Kiryanovc0ea88b2015-11-25 13:59:04 +0200321 unsigned int csel_reg;
322 unsigned int csel_mask;
Axel Linc8520b42012-12-18 09:30:10 +0800323 unsigned int apply_reg;
324 unsigned int apply_bit;
Mark Browncd6dffb2012-04-15 12:37:47 +0100325 unsigned int enable_reg;
326 unsigned int enable_mask;
Carlo Caioneca5d1b32014-03-05 22:11:29 +0100327 unsigned int enable_val;
328 unsigned int disable_val;
Axel Lin51dcdaf2013-03-05 14:16:00 +0800329 bool enable_is_inverted;
Mark Browndf367932012-08-27 16:04:23 -0700330 unsigned int bypass_reg;
331 unsigned int bypass_mask;
Carlo Caioneca5d1b32014-03-05 22:11:29 +0100332 unsigned int bypass_val_on;
333 unsigned int bypass_val_off;
Laxman Dewangan354794d2016-03-02 16:24:47 +0530334 unsigned int active_discharge_on;
335 unsigned int active_discharge_off;
336 unsigned int active_discharge_mask;
337 unsigned int active_discharge_reg;
Mark Brown79511ed2012-06-27 14:23:10 +0100338
339 unsigned int enable_time;
Guodong Xu871f5652014-08-13 19:33:40 +0800340
341 unsigned int off_on_delay;
Javier Martinez Canillas87e1e0f2014-11-10 14:43:52 +0100342
343 unsigned int (*of_map_mode)(unsigned int mode);
Liam Girdwood571a3542008-04-30 15:42:28 +0100344};
345
Mark Brownc1727082012-04-04 00:50:22 +0100346/**
347 * struct regulator_config - Dynamic regulator descriptor
348 *
349 * Each regulator registered with the core is described with a
350 * structure of this type and a struct regulator_desc. This structure
351 * contains the runtime variable parts of the regulator description.
352 *
353 * @dev: struct device for the regulator
354 * @init_data: platform provided init data, passed through by driver
355 * @driver_data: private regulator data
356 * @of_node: OpenFirmware node to parse for device tree bindings (may be
357 * NULL).
Axel Lincf392842015-03-18 08:57:41 +0800358 * @regmap: regmap to use for core regmap helpers if dev_get_regmap() is
Mark Brown380a0e62012-08-31 10:31:53 -0700359 * insufficient.
Markus Pargmann76f439d2014-10-08 15:47:05 +0200360 * @ena_gpio_initialized: GPIO controlling regulator enable was properly
361 * initialized, meaning that >= 0 is a valid gpio
362 * identifier and < 0 is a non existent gpio.
Mark Brown65f73502012-06-27 14:14:38 +0100363 * @ena_gpio: GPIO controlling regulator enable.
364 * @ena_gpio_invert: Sense for GPIO enable control.
365 * @ena_gpio_flags: Flags to use when calling gpio_request_one()
Mark Brownc1727082012-04-04 00:50:22 +0100366 */
367struct regulator_config {
368 struct device *dev;
369 const struct regulator_init_data *init_data;
370 void *driver_data;
371 struct device_node *of_node;
Mark Brown65b19ce2012-04-15 11:16:05 +0100372 struct regmap *regmap;
Mark Brown65f73502012-06-27 14:14:38 +0100373
Markus Pargmann76f439d2014-10-08 15:47:05 +0200374 bool ena_gpio_initialized;
Mark Brown65f73502012-06-27 14:14:38 +0100375 int ena_gpio;
376 unsigned int ena_gpio_invert:1;
377 unsigned int ena_gpio_flags;
Mark Brownc1727082012-04-04 00:50:22 +0100378};
379
Mark Brown1fa9ad52009-01-21 14:08:40 +0000380/*
381 * struct regulator_dev
382 *
383 * Voltage / Current regulator class device. One for each
384 * regulator.
385 *
386 * This should *not* be used directly by anything except the regulator
387 * core and notification injection (which should take the mutex and do
388 * no other direct access).
389 */
390struct regulator_dev {
Mark Brown65f26842012-04-03 20:46:53 +0100391 const struct regulator_desc *desc;
Mark Brown5ffbd132009-07-21 16:00:23 +0100392 int exclusive;
Mark Brown1130e5b2010-12-21 23:49:31 +0000393 u32 use_count;
394 u32 open_count;
Mark Brownf59c8f92012-08-31 10:36:37 -0700395 u32 bypass_count;
Mark Brown1fa9ad52009-01-21 14:08:40 +0000396
397 /* lists we belong to */
398 struct list_head list; /* list of all regulators */
Mark Brown1fa9ad52009-01-21 14:08:40 +0000399
400 /* lists we own */
401 struct list_head consumer_list; /* consumers we supply */
Mark Brown1fa9ad52009-01-21 14:08:40 +0000402
403 struct blocking_notifier_head notifier;
404 struct mutex mutex; /* consumer lock */
405 struct module *owner;
406 struct device dev;
407 struct regulation_constraints *constraints;
Mark Brown3801b862011-06-09 16:22:22 +0100408 struct regulator *supply; /* for tree */
Bjorn Andersson6261b062015-03-24 18:56:05 -0700409 const char *supply_name;
Mark Brown65b19ce2012-04-15 11:16:05 +0100410 struct regmap *regmap;
Mark Brown1fa9ad52009-01-21 14:08:40 +0000411
Mark Brownda07ecd2011-09-11 09:53:50 +0100412 struct delayed_work disable_work;
413 int deferred_disables;
414
Mark Brown1fa9ad52009-01-21 14:08:40 +0000415 void *reg_data; /* regulator_dev data */
Mark Brown1130e5b2010-12-21 23:49:31 +0000416
Mark Brown1130e5b2010-12-21 23:49:31 +0000417 struct dentry *debugfs;
Mark Brown65f73502012-06-27 14:14:38 +0100418
Kim, Milof19b00d2013-02-18 06:50:39 +0000419 struct regulator_enable_gpio *ena_pin;
Mark Brown65f73502012-06-27 14:14:38 +0100420 unsigned int ena_gpio_state:1;
Guodong Xu871f5652014-08-13 19:33:40 +0800421
422 /* time when this regulator was disabled last time */
423 unsigned long last_off_jiffy;
Mark Brown1fa9ad52009-01-21 14:08:40 +0000424};
425
Mark Brown65f26842012-04-03 20:46:53 +0100426struct regulator_dev *
427regulator_register(const struct regulator_desc *regulator_desc,
Mark Brownc1727082012-04-04 00:50:22 +0100428 const struct regulator_config *config);
Mark Brownb33e46b2013-08-31 11:58:26 +0100429struct regulator_dev *
430devm_regulator_register(struct device *dev,
431 const struct regulator_desc *regulator_desc,
432 const struct regulator_config *config);
Liam Girdwood571a3542008-04-30 15:42:28 +0100433void regulator_unregister(struct regulator_dev *rdev);
Mark Brownb33e46b2013-08-31 11:58:26 +0100434void devm_regulator_unregister(struct device *dev, struct regulator_dev *rdev);
Liam Girdwood571a3542008-04-30 15:42:28 +0100435
436int regulator_notifier_call_chain(struct regulator_dev *rdev,
437 unsigned long event, void *data);
438
439void *rdev_get_drvdata(struct regulator_dev *rdev);
Liam Girdwooda5766f12008-10-10 13:22:20 +0100440struct device *rdev_get_dev(struct regulator_dev *rdev);
Liam Girdwood571a3542008-04-30 15:42:28 +0100441int rdev_get_id(struct regulator_dev *rdev);
442
Mark Brownbe721972009-08-04 20:09:52 +0200443int regulator_mode_to_status(unsigned int);
444
Mark Brownbca7bbf2012-05-09 21:38:33 +0100445int regulator_list_voltage_linear(struct regulator_dev *rdev,
446 unsigned int selector);
Mark Brown94d33c02013-07-02 22:52:41 +0100447int regulator_list_voltage_linear_range(struct regulator_dev *rdev,
448 unsigned int selector);
Axel Lincffc9592012-05-20 10:30:21 +0800449int regulator_list_voltage_table(struct regulator_dev *rdev,
450 unsigned int selector);
Mark Brownbca7bbf2012-05-09 21:38:33 +0100451int regulator_map_voltage_linear(struct regulator_dev *rdev,
452 int min_uV, int max_uV);
Mark Brown94d33c02013-07-02 22:52:41 +0100453int regulator_map_voltage_linear_range(struct regulator_dev *rdev,
454 int min_uV, int max_uV);
Mark Browne843fc42012-05-09 21:16:06 +0100455int regulator_map_voltage_iterate(struct regulator_dev *rdev,
456 int min_uV, int max_uV);
Axel Linfcf371e2013-04-18 10:34:49 +0800457int regulator_map_voltage_ascend(struct regulator_dev *rdev,
458 int min_uV, int max_uV);
Mark Brown4ab5b3d2012-04-15 11:23:30 +0100459int regulator_get_voltage_sel_regmap(struct regulator_dev *rdev);
460int regulator_set_voltage_sel_regmap(struct regulator_dev *rdev, unsigned sel);
Mark Browncd6dffb2012-04-15 12:37:47 +0100461int regulator_is_enabled_regmap(struct regulator_dev *rdev);
462int regulator_enable_regmap(struct regulator_dev *rdev);
463int regulator_disable_regmap(struct regulator_dev *rdev);
Yadwinder Singh Brar98a175b2012-06-09 16:40:38 +0530464int regulator_set_voltage_time_sel(struct regulator_dev *rdev,
465 unsigned int old_selector,
466 unsigned int new_selector);
Mark Browndf367932012-08-27 16:04:23 -0700467int regulator_set_bypass_regmap(struct regulator_dev *rdev, bool enable);
468int regulator_get_bypass_regmap(struct regulator_dev *rdev, bool *enable);
Mark Brown4ab5b3d2012-04-15 11:23:30 +0100469
Laxman Dewangan354794d2016-03-02 16:24:47 +0530470int regulator_set_active_discharge_regmap(struct regulator_dev *rdev,
471 bool enable);
Liam Girdwooda5766f12008-10-10 13:22:20 +0100472void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data);
473
Liam Girdwood571a3542008-04-30 15:42:28 +0100474#endif