Commit | Line | Data |
---|---|---|
4c1184e8 LG |
1 | /* |
2 | * machine.h -- SoC Regulator support, machine/board driver API. | |
3 | * | |
4 | * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC. | |
5 | * | |
1dd68f01 | 6 | * Author: Liam Girdwood <lrg@slimlogic.co.uk> |
4c1184e8 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 Machine/Board Interface. | |
13 | */ | |
14 | ||
15 | #ifndef __LINUX_REGULATOR_MACHINE_H_ | |
16 | #define __LINUX_REGULATOR_MACHINE_H_ | |
17 | ||
18 | #include <linux/regulator/consumer.h> | |
19 | #include <linux/suspend.h> | |
20 | ||
21 | struct regulator; | |
22 | ||
23 | /* | |
24 | * Regulator operation constraint flags. These flags are used to enable | |
25 | * certain regulator operations and can be OR'ed together. | |
26 | * | |
27 | * VOLTAGE: Regulator output voltage can be changed by software on this | |
28 | * board/machine. | |
29 | * CURRENT: Regulator output current can be changed by software on this | |
30 | * board/machine. | |
31 | * MODE: Regulator operating mode can be changed by software on this | |
32 | * board/machine. | |
33 | * STATUS: Regulator can be enabled and disabled. | |
34 | * DRMS: Dynamic Regulator Mode Switching is enabled for this regulator. | |
f59c8f9f | 35 | * BYPASS: Regulator can be put into bypass mode |
4c1184e8 LG |
36 | */ |
37 | ||
38 | #define REGULATOR_CHANGE_VOLTAGE 0x1 | |
39 | #define REGULATOR_CHANGE_CURRENT 0x2 | |
40 | #define REGULATOR_CHANGE_MODE 0x4 | |
41 | #define REGULATOR_CHANGE_STATUS 0x8 | |
42 | #define REGULATOR_CHANGE_DRMS 0x10 | |
f59c8f9f | 43 | #define REGULATOR_CHANGE_BYPASS 0x20 |
4c1184e8 | 44 | |
670666b9 LD |
45 | /* Regulator active discharge flags */ |
46 | enum regulator_active_discharge { | |
47 | REGULATOR_ACTIVE_DISCHARGE_DEFAULT, | |
48 | REGULATOR_ACTIVE_DISCHARGE_DISABLE, | |
49 | REGULATOR_ACTIVE_DISCHARGE_ENABLE, | |
50 | }; | |
51 | ||
4c1184e8 | 52 | /** |
2e7e65ce | 53 | * struct regulator_state - regulator state during low power system states |
4c1184e8 | 54 | * |
638f85c5 MB |
55 | * This describes a regulators state during a system wide low power |
56 | * state. One of enabled or disabled must be set for the | |
57 | * configuration to be applied. | |
c8e7e464 MB |
58 | * |
59 | * @uV: Operating voltage during suspend. | |
60 | * @mode: Operating mode during suspend. | |
61 | * @enabled: Enabled during suspend. | |
638f85c5 | 62 | * @disabled: Disabled during suspend. |
4c1184e8 LG |
63 | */ |
64 | struct regulator_state { | |
65 | int uV; /* suspend voltage */ | |
66 | unsigned int mode; /* suspend regulator operating mode */ | |
67 | int enabled; /* is regulator enabled in this suspend state */ | |
638f85c5 | 68 | int disabled; /* is the regulator disbled in this suspend state */ |
4c1184e8 LG |
69 | }; |
70 | ||
71 | /** | |
72 | * struct regulation_constraints - regulator operating constraints. | |
73 | * | |
74 | * This struct describes regulator and board/machine specific constraints. | |
c8e7e464 MB |
75 | * |
76 | * @name: Descriptive name for the constraints, used for display purposes. | |
77 | * | |
78 | * @min_uV: Smallest voltage consumers may set. | |
79 | * @max_uV: Largest voltage consumers may set. | |
bf5892a8 MB |
80 | * @uV_offset: Offset applied to voltages from consumer to compensate for |
81 | * voltage drops. | |
c8e7e464 | 82 | * |
15c08f66 | 83 | * @min_uA: Smallest current consumers may set. |
c8e7e464 | 84 | * @max_uA: Largest current consumers may set. |
36e4f839 | 85 | * @ilim_uA: Maximum input current. |
22a10bca | 86 | * @system_load: Load that isn't captured by any consumer requests. |
c8e7e464 MB |
87 | * |
88 | * @valid_modes_mask: Mask of modes which may be configured by consumers. | |
89 | * @valid_ops_mask: Operations which may be performed by consumers. | |
90 | * | |
91 | * @always_on: Set if the regulator should never be disabled. | |
92 | * @boot_on: Set if the regulator is enabled when the system is initially | |
cacf90f2 MB |
93 | * started. If the regulator is not enabled by the hardware or |
94 | * bootloader then it will be enabled when the constraints are | |
95 | * applied. | |
c8e7e464 | 96 | * @apply_uV: Apply the voltage constraint when initialising. |
a8dbfeed | 97 | * @ramp_disable: Disable ramp delay when initialising or when setting voltage. |
c751ad0d | 98 | * @soft_start: Enable soft start so that voltage ramps slowly. |
23c779b9 | 99 | * @pull_down: Enable pull down when regulator is disabled. |
c8e7e464 MB |
100 | * |
101 | * @input_uV: Input voltage for regulator when supplied by another regulator. | |
102 | * | |
103 | * @state_disk: State for regulator when system is suspended in disk mode. | |
104 | * @state_mem: State for regulator when system is suspended in mem mode. | |
105 | * @state_standby: State for regulator when system is suspended in standby | |
106 | * mode. | |
107 | * @initial_state: Suspend state to set by default. | |
a308466c | 108 | * @initial_mode: Mode to set at startup. |
ea38d13f | 109 | * @ramp_delay: Time to settle down after voltage change (unit: uV/us) |
670666b9 LD |
110 | * @active_discharge: Enable/disable active discharge. The enum |
111 | * regulator_active_discharge values are used for | |
112 | * initialisation. | |
00c877c6 | 113 | * @enable_time: Turn-on time of the rails (unit: microseconds) |
4c1184e8 LG |
114 | */ |
115 | struct regulation_constraints { | |
116 | ||
0151546f | 117 | const char *name; |
4c1184e8 LG |
118 | |
119 | /* voltage output range (inclusive) - for voltage control */ | |
120 | int min_uV; | |
121 | int max_uV; | |
122 | ||
bf5892a8 MB |
123 | int uV_offset; |
124 | ||
4c1184e8 LG |
125 | /* current output range (inclusive) - for current control */ |
126 | int min_uA; | |
127 | int max_uA; | |
36e4f839 | 128 | int ilim_uA; |
4c1184e8 | 129 | |
22a10bca SB |
130 | int system_load; |
131 | ||
4c1184e8 LG |
132 | /* valid regulator operating modes for this machine */ |
133 | unsigned int valid_modes_mask; | |
134 | ||
135 | /* valid operations for regulator on this machine */ | |
136 | unsigned int valid_ops_mask; | |
137 | ||
138 | /* regulator input voltage - only if supply is another regulator */ | |
139 | int input_uV; | |
140 | ||
141 | /* regulator suspend states for global PMIC STANDBY/HIBERNATE */ | |
142 | struct regulator_state state_disk; | |
143 | struct regulator_state state_mem; | |
144 | struct regulator_state state_standby; | |
145 | suspend_state_t initial_state; /* suspend state to set at init */ | |
146 | ||
a308466c MB |
147 | /* mode to set on startup */ |
148 | unsigned int initial_mode; | |
149 | ||
6f0b2c69 | 150 | unsigned int ramp_delay; |
00c877c6 | 151 | unsigned int enable_time; |
6f0b2c69 | 152 | |
670666b9 LD |
153 | unsigned int active_discharge; |
154 | ||
2e7e65ce | 155 | /* constraint flags */ |
4c1184e8 LG |
156 | unsigned always_on:1; /* regulator never off when system is on */ |
157 | unsigned boot_on:1; /* bootloader/firmware enabled regulator */ | |
2e7e65ce | 158 | unsigned apply_uV:1; /* apply uV constraint if min == max */ |
1653ccf4 | 159 | unsigned ramp_disable:1; /* disable ramp delay */ |
57f66b78 | 160 | unsigned soft_start:1; /* ramp voltage slowly */ |
23c779b9 | 161 | unsigned pull_down:1; /* pull down resistor when regulator off */ |
3a003bae | 162 | unsigned over_current_protection:1; /* auto disable on over current */ |
4c1184e8 LG |
163 | }; |
164 | ||
a5766f11 LG |
165 | /** |
166 | * struct regulator_consumer_supply - supply -> device mapping | |
167 | * | |
15c08f66 AL |
168 | * This maps a supply name to a device. Use of dev_name allows support for |
169 | * buses which make struct device available late such as I2C. | |
c8e7e464 | 170 | * |
40f9244f | 171 | * @dev_name: Result of dev_name() for the consumer. |
c8e7e464 | 172 | * @supply: Name for the supply. |
a5766f11 LG |
173 | */ |
174 | struct regulator_consumer_supply { | |
40f9244f | 175 | const char *dev_name; /* dev_name() for consumer */ |
a5766f11 LG |
176 | const char *supply; /* consumer supply - e.g. "vcc" */ |
177 | }; | |
4c1184e8 | 178 | |
ed654324 | 179 | /* Initialize struct regulator_consumer_supply */ |
180 | #define REGULATOR_SUPPLY(_name, _dev_name) \ | |
181 | { \ | |
182 | .supply = _name, \ | |
183 | .dev_name = _dev_name, \ | |
184 | } | |
185 | ||
a5766f11 LG |
186 | /** |
187 | * struct regulator_init_data - regulator platform initialisation data. | |
188 | * | |
189 | * Initialisation constraints, our supply and consumers supplies. | |
c8e7e464 | 190 | * |
0178f3e2 MB |
191 | * @supply_regulator: Parent regulator. Specified using the regulator name |
192 | * as it appears in the name field in sysfs, which can | |
193 | * be explicitly set using the constraints field 'name'. | |
c8e7e464 MB |
194 | * |
195 | * @constraints: Constraints. These must be specified for the regulator to | |
196 | * be usable. | |
197 | * @num_consumer_supplies: Number of consumer device supplies. | |
198 | * @consumer_supplies: Consumer device supply configuration. | |
199 | * | |
200 | * @regulator_init: Callback invoked when the regulator has been registered. | |
201 | * @driver_data: Data passed to regulator_init. | |
a5766f11 LG |
202 | */ |
203 | struct regulator_init_data { | |
0178f3e2 | 204 | const char *supply_regulator; /* or NULL for system supply */ |
4c1184e8 | 205 | |
a5766f11 | 206 | struct regulation_constraints constraints; |
4c1184e8 | 207 | |
a5766f11 LG |
208 | int num_consumer_supplies; |
209 | struct regulator_consumer_supply *consumer_supplies; | |
210 | ||
211 | /* optional regulator machine specific init */ | |
212 | int (*regulator_init)(void *driver_data); | |
213 | void *driver_data; /* core does not touch this */ | |
214 | }; | |
4c1184e8 | 215 | |
9c19bc04 | 216 | #ifdef CONFIG_REGULATOR |
ca725561 | 217 | void regulator_has_full_constraints(void); |
50910276 KK |
218 | int regulator_suspend_prepare(suspend_state_t state); |
219 | int regulator_suspend_finish(void); | |
9c19bc04 MB |
220 | #else |
221 | static inline void regulator_has_full_constraints(void) | |
222 | { | |
223 | } | |
50910276 KK |
224 | static inline int regulator_suspend_prepare(suspend_state_t state) |
225 | { | |
226 | return 0; | |
227 | } | |
228 | static inline int regulator_suspend_finish(void) | |
229 | { | |
230 | return 0; | |
231 | } | |
9c19bc04 | 232 | #endif |
ca725561 | 233 | |
4c1184e8 | 234 | #endif |