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