regulator: add support for changing control mode of regulator
[linux-2.6.git] / include / linux / regulator / driver.h
1 /*
2  * driver.h -- SoC Regulator driver support.
3  *
4  * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC.
5  *
6  * Author: Liam Girdwood <lrg@slimlogic.co.uk>
7  *
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>
19 #include <linux/notifier.h>
20 #include <linux/regulator/consumer.h>
21
22 struct regulator_dev;
23 struct regulator_init_data;
24
25 enum regulator_status {
26         REGULATOR_STATUS_OFF,
27         REGULATOR_STATUS_ON,
28         REGULATOR_STATUS_ERROR,
29         /* fast/normal/idle/standby are flavors of "on" */
30         REGULATOR_STATUS_FAST,
31         REGULATOR_STATUS_NORMAL,
32         REGULATOR_STATUS_IDLE,
33         REGULATOR_STATUS_STANDBY,
34 };
35
36 /**
37  * struct regulator_ops - regulator operations.
38  *
39  * @enable: Configure the regulator as enabled.
40  * @disable: Configure the regulator as disabled.
41  * @is_enabled: Return 1 if the regulator is enabled, 0 if not.
42  *              May also return negative errno.
43  *
44  * @set_voltage: Set the voltage for the regulator within the range specified.
45  *               The driver should select the voltage closest to min_uV.
46  * @set_voltage_sel: Set the voltage for the regulator using the specified
47  *                   selector.
48  * @get_voltage: Return the currently configured voltage for the regulator.
49  * @get_voltage_sel: Return the currently configured voltage selector for the
50  *                   regulator.
51  * @list_voltage: Return one of the supported voltages, in microvolts; zero
52  *      if the selector indicates a voltage that is unusable on this system;
53  *      or negative errno.  Selectors range from zero to one less than
54  *      regulator_desc.n_voltages.  Voltages may be reported in any order.
55  *
56  * @set_current_limit: Configure a limit for a current-limited regulator.
57  * @get_current_limit: Get the configured limit for a current-limited regulator.
58  *
59  * @set_mode: Set the configured operating mode for the regulator.
60  * @get_mode: Get the configured operating mode for the regulator.
61  * @get_status: Return actual (not as-configured) status of regulator, as a
62  *      REGULATOR_STATUS value (or negative errno)
63  * @get_optimum_mode: Get the most efficient operating mode for the regulator
64  *                    when running with the specified parameters.
65  *
66  * @set_control_mode: Set the control mode for the regulator.
67  * @get_control_mode: Get the control mode for the regulator.
68  *
69  * @enable_time: Time taken for the regulator voltage output voltage to
70  *               stabilise after being enabled, in microseconds.
71  * @set_voltage_time_sel: Time taken for the regulator voltage output voltage
72  *               to stabilise after being set to a new value, in microseconds.
73  *               The function provides the from and to voltage selector, the
74  *               function should return the worst case.
75  *
76  * @set_suspend_voltage: Set the voltage for the regulator when the system
77  *                       is suspended.
78  * @set_suspend_enable: Mark the regulator as enabled when the system is
79  *                      suspended.
80  * @set_suspend_disable: Mark the regulator as disabled when the system is
81  *                       suspended.
82  * @set_suspend_mode: Set the operating mode for the regulator when the
83  *                    system is suspended.
84  *
85  * This struct describes regulator operations which can be implemented by
86  * regulator chip drivers.
87  */
88 struct regulator_ops {
89
90         /* enumerate supported voltages */
91         int (*list_voltage) (struct regulator_dev *, unsigned selector);
92
93         /* get/set regulator voltage */
94         int (*set_voltage) (struct regulator_dev *, int min_uV, int max_uV,
95                             unsigned *selector);
96         int (*set_voltage_sel) (struct regulator_dev *, unsigned selector);
97         int (*get_voltage) (struct regulator_dev *);
98         int (*get_voltage_sel) (struct regulator_dev *);
99
100         /* get/set regulator current  */
101         int (*set_current_limit) (struct regulator_dev *,
102                                  int min_uA, int max_uA);
103         int (*get_current_limit) (struct regulator_dev *);
104
105         /* enable/disable regulator */
106         int (*enable) (struct regulator_dev *);
107         int (*disable) (struct regulator_dev *);
108         int (*is_enabled) (struct regulator_dev *);
109
110         /* get/set regulator operating mode (defined in consumer.h) */
111         int (*set_mode) (struct regulator_dev *, unsigned int mode);
112         unsigned int (*get_mode) (struct regulator_dev *);
113
114         /* get/set regulator control mode (defined in consumer.h) */
115         int (*set_control_mode) (struct regulator_dev *, unsigned int mode);
116         unsigned int (*get_control_mode) (struct regulator_dev *);
117
118         /* Time taken to enable or set voltage on the regulator */
119         int (*enable_time) (struct regulator_dev *);
120         int (*set_voltage_time_sel) (struct regulator_dev *,
121                                      unsigned int old_selector,
122                                      unsigned int new_selector);
123
124         /* report regulator status ... most other accessors report
125          * control inputs, this reports results of combining inputs
126          * from Linux (and other sources) with the actual load.
127          * returns REGULATOR_STATUS_* or negative errno.
128          */
129         int (*get_status)(struct regulator_dev *);
130
131         /* get most efficient regulator operating mode for load */
132         unsigned int (*get_optimum_mode) (struct regulator_dev *, int input_uV,
133                                           int output_uV, int load_uA);
134
135         /* the operations below are for configuration of regulator state when
136          * its parent PMIC enters a global STANDBY/HIBERNATE state */
137
138         /* set regulator suspend voltage */
139         int (*set_suspend_voltage) (struct regulator_dev *, int uV);
140
141         /* enable/disable regulator in suspend state */
142         int (*set_suspend_enable) (struct regulator_dev *);
143         int (*set_suspend_disable) (struct regulator_dev *);
144
145         /* set regulator suspend operating mode (defined in consumer.h) */
146         int (*set_suspend_mode) (struct regulator_dev *, unsigned int mode);
147 };
148
149 /*
150  * Regulators can either control voltage or current.
151  */
152 enum regulator_type {
153         REGULATOR_VOLTAGE,
154         REGULATOR_CURRENT,
155 };
156
157 /**
158  * struct regulator_desc - Regulator descriptor
159  *
160  * Each regulator registered with the core is described with a structure of
161  * this type.
162  *
163  * @name: Identifying name for the regulator.
164  * @supply_name: Identifying the regulator supply
165  * @id: Numerical identifier for the regulator.
166  * @n_voltages: Number of selectors available for ops.list_voltage().
167  * @ops: Regulator operations table.
168  * @irq: Interrupt number for the regulator.
169  * @type: Indicates if the regulator is a voltage or current regulator.
170  * @owner: Module providing the regulator, used for refcounting.
171  */
172 struct regulator_desc {
173         const char *name;
174         const char *supply_name;
175         int id;
176         unsigned n_voltages;
177         struct regulator_ops *ops;
178         int irq;
179         enum regulator_type type;
180         struct module *owner;
181         unsigned int vsel_reg;
182         unsigned int vsel_mask;
183         unsigned int enable_reg;
184         unsigned int enable_mask;
185 };
186
187 /*
188  * struct regulator_dev
189  *
190  * Voltage / Current regulator class device. One for each
191  * regulator.
192  *
193  * This should *not* be used directly by anything except the regulator
194  * core and notification injection (which should take the mutex and do
195  * no other direct access).
196  */
197 struct regulator_dev {
198         struct regulator_desc *desc;
199         int exclusive;
200         u32 use_count;
201         u32 open_count;
202
203         /* lists we belong to */
204         struct list_head list; /* list of all regulators */
205
206         /* lists we own */
207         struct list_head consumer_list; /* consumers we supply */
208
209         struct blocking_notifier_head notifier;
210         struct mutex mutex; /* consumer lock */
211         struct module *owner;
212         struct device dev;
213         struct regulation_constraints *constraints;
214         struct regulator *supply;       /* for tree */
215
216         struct delayed_work disable_work;
217         int deferred_disables;
218
219         void *reg_data;         /* regulator_dev data */
220
221         struct dentry *debugfs;
222 };
223
224 struct regulator_dev *regulator_register(struct regulator_desc *regulator_desc,
225         struct device *dev, const struct regulator_init_data *init_data,
226         void *driver_data, struct device_node *of_node);
227 void regulator_unregister(struct regulator_dev *rdev);
228
229 int regulator_notifier_call_chain(struct regulator_dev *rdev,
230                                   unsigned long event, void *data);
231
232 void *rdev_get_drvdata(struct regulator_dev *rdev);
233 struct device *rdev_get_dev(struct regulator_dev *rdev);
234 int rdev_get_id(struct regulator_dev *rdev);
235
236 int regulator_mode_to_status(unsigned int);
237
238 void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data);
239
240 #endif