1/*
2 * machine.h -- SoC Regulator support, machine/board driver API.
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 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
21struct 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.
35 * BYPASS: Regulator can be put into bypass mode
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
43#define REGULATOR_CHANGE_BYPASS 0x20
44
45/*
46 * operations in suspend mode
47 * DO_NOTHING_IN_SUSPEND - the default value
48 * DISABLE_IN_SUSPEND - turn off regulator in suspend states
49 * ENABLE_IN_SUSPEND - keep regulator on in suspend states
50 */
51#define DO_NOTHING_IN_SUSPEND 0
52#define DISABLE_IN_SUSPEND 1
53#define ENABLE_IN_SUSPEND 2
54
55/* Regulator active discharge flags */
56enum regulator_active_discharge {
57 REGULATOR_ACTIVE_DISCHARGE_DEFAULT,
58 REGULATOR_ACTIVE_DISCHARGE_DISABLE,
59 REGULATOR_ACTIVE_DISCHARGE_ENABLE,
60};
61
62/**
63 * struct regulator_state - regulator state during low power system states
64 *
65 * This describes a regulators state during a system wide low power
66 * state. One of enabled or disabled must be set for the
67 * configuration to be applied.
68 *
69 * @uV: Default operating voltage during suspend, it can be adjusted
70 * among <min_uV, max_uV>.
71 * @min_uV: Minimum suspend voltage may be set.
72 * @max_uV: Maximum suspend voltage may be set.
73 * @mode: Operating mode during suspend.
74 * @enabled: operations during suspend.
75 * - DO_NOTHING_IN_SUSPEND
76 * - DISABLE_IN_SUSPEND
77 * - ENABLE_IN_SUSPEND
78 * @changeable: Is this state can be switched between enabled/disabled,
79 */
80struct regulator_state {
81 int uV;
82 int min_uV;
83 int max_uV;
84 unsigned int mode;
85 int enabled;
86 bool changeable;
87};
88
89/**
90 * struct regulation_constraints - regulator operating constraints.
91 *
92 * This struct describes regulator and board/machine specific constraints.
93 *
94 * @name: Descriptive name for the constraints, used for display purposes.
95 *
96 * @min_uV: Smallest voltage consumers may set.
97 * @max_uV: Largest voltage consumers may set.
98 * @uV_offset: Offset applied to voltages from consumer to compensate for
99 * voltage drops.
100 *
101 * @min_uA: Smallest current consumers may set.
102 * @max_uA: Largest current consumers may set.
103 * @ilim_uA: Maximum input current.
104 * @system_load: Load that isn't captured by any consumer requests.
105 *
106 * @max_spread: Max possible spread between coupled regulators
107 * @valid_modes_mask: Mask of modes which may be configured by consumers.
108 * @valid_ops_mask: Operations which may be performed by consumers.
109 *
110 * @always_on: Set if the regulator should never be disabled.
111 * @boot_on: Set if the regulator is enabled when the system is initially
112 * started. If the regulator is not enabled by the hardware or
113 * bootloader then it will be enabled when the constraints are
114 * applied.
115 * @apply_uV: Apply the voltage constraint when initialising.
116 * @ramp_disable: Disable ramp delay when initialising or when setting voltage.
117 * @soft_start: Enable soft start so that voltage ramps slowly.
118 * @pull_down: Enable pull down when regulator is disabled.
119 * @over_current_protection: Auto disable on over current event.
120 *
121 * @input_uV: Input voltage for regulator when supplied by another regulator.
122 *
123 * @state_disk: State for regulator when system is suspended in disk mode.
124 * @state_mem: State for regulator when system is suspended in mem mode.
125 * @state_standby: State for regulator when system is suspended in standby
126 * mode.
127 * @initial_state: Suspend state to set by default.
128 * @initial_mode: Mode to set at startup.
129 * @ramp_delay: Time to settle down after voltage change (unit: uV/us)
130 * @settling_time: Time to settle down after voltage change when voltage
131 * change is non-linear (unit: microseconds).
132 * @settling_time_up: Time to settle down after voltage increase when voltage
133 * change is non-linear (unit: microseconds).
134 * @settling_time_down : Time to settle down after voltage decrease when
135 * voltage change is non-linear (unit: microseconds).
136 * @active_discharge: Enable/disable active discharge. The enum
137 * regulator_active_discharge values are used for
138 * initialisation.
139 * @enable_time: Turn-on time of the rails (unit: microseconds)
140 */
141struct regulation_constraints {
142
143 const char *name;
144
145 /* voltage output range (inclusive) - for voltage control */
146 int min_uV;
147 int max_uV;
148
149 int uV_offset;
150
151 /* current output range (inclusive) - for current control */
152 int min_uA;
153 int max_uA;
154 int ilim_uA;
155
156 int system_load;
157
158 /* used for coupled regulators */
159 int max_spread;
160
161 /* used for changing voltage in steps */
162 int max_uV_step;
163
164 /* valid regulator operating modes for this machine */
165 unsigned int valid_modes_mask;
166
167 /* valid operations for regulator on this machine */
168 unsigned int valid_ops_mask;
169
170 /* regulator input voltage - only if supply is another regulator */
171 int input_uV;
172
173 /* regulator suspend states for global PMIC STANDBY/HIBERNATE */
174 struct regulator_state state_disk;
175 struct regulator_state state_mem;
176 struct regulator_state state_standby;
177 suspend_state_t initial_state; /* suspend state to set at init */
178
179 /* mode to set on startup */
180 unsigned int initial_mode;
181
182 unsigned int ramp_delay;
183 unsigned int settling_time;
184 unsigned int settling_time_up;
185 unsigned int settling_time_down;
186 unsigned int enable_time;
187
188 unsigned int active_discharge;
189
190 /* constraint flags */
191 unsigned always_on:1; /* regulator never off when system is on */
192 unsigned boot_on:1; /* bootloader/firmware enabled regulator */
193 unsigned apply_uV:1; /* apply uV constraint if min == max */
194 unsigned ramp_disable:1; /* disable ramp delay */
195 unsigned soft_start:1; /* ramp voltage slowly */
196 unsigned pull_down:1; /* pull down resistor when regulator off */
197 unsigned over_current_protection:1; /* auto disable on over current */
198};
199
200/**
201 * struct regulator_consumer_supply - supply -> device mapping
202 *
203 * This maps a supply name to a device. Use of dev_name allows support for
204 * buses which make struct device available late such as I2C.
205 *
206 * @dev_name: Result of dev_name() for the consumer.
207 * @supply: Name for the supply.
208 */
209struct regulator_consumer_supply {
210 const char *dev_name; /* dev_name() for consumer */
211 const char *supply; /* consumer supply - e.g. "vcc" */
212};
213
214/* Initialize struct regulator_consumer_supply */
215#define REGULATOR_SUPPLY(_name, _dev_name) \
216{ \
217 .supply = _name, \
218 .dev_name = _dev_name, \
219}
220
221/**
222 * struct regulator_init_data - regulator platform initialisation data.
223 *
224 * Initialisation constraints, our supply and consumers supplies.
225 *
226 * @supply_regulator: Parent regulator. Specified using the regulator name
227 * as it appears in the name field in sysfs, which can
228 * be explicitly set using the constraints field 'name'.
229 *
230 * @constraints: Constraints. These must be specified for the regulator to
231 * be usable.
232 * @num_consumer_supplies: Number of consumer device supplies.
233 * @consumer_supplies: Consumer device supply configuration.
234 *
235 * @regulator_init: Callback invoked when the regulator has been registered.
236 * @driver_data: Data passed to regulator_init.
237 */
238struct regulator_init_data {
239 const char *supply_regulator; /* or NULL for system supply */
240
241 struct regulation_constraints constraints;
242
243 int num_consumer_supplies;
244 struct regulator_consumer_supply *consumer_supplies;
245
246 /* optional regulator machine specific init */
247 int (*regulator_init)(void *driver_data);
248 void *driver_data; /* core does not touch this */
249};
250
251#ifdef CONFIG_REGULATOR
252void regulator_has_full_constraints(void);
253#else
254static inline void regulator_has_full_constraints(void)
255{
256}
257#endif
258
259static inline int regulator_suspend_prepare(suspend_state_t state)
260{
261 return 0;
262}
263static inline int regulator_suspend_finish(void)
264{
265 return 0;
266}
267
268#endif
269