101f8044d22e47941a5e5aefea9ecce57a2f7504
[linux-3.10.git] / include / linux / regulator / machine.h
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
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.
35  * BYPASS:   Regulator can be put into bypass mode
36  * CONTROL:  Dynamic change control mode of Regulator i.e I2C or PWM.
37  */
38
39 #define REGULATOR_CHANGE_VOLTAGE        0x1
40 #define REGULATOR_CHANGE_CURRENT        0x2
41 #define REGULATOR_CHANGE_MODE           0x4
42 #define REGULATOR_CHANGE_STATUS         0x8
43 #define REGULATOR_CHANGE_DRMS           0x10
44 #define REGULATOR_CHANGE_BYPASS         0x20
45 #define REGULATOR_CHANGE_CONTROL        0x40
46
47 /**
48  * struct regulator_state - regulator state during low power system states
49  *
50  * This describes a regulators state during a system wide low power
51  * state.  One of enabled or disabled must be set for the
52  * configuration to be applied.
53  *
54  * @uV: Operating voltage during suspend.
55  * @mode: Operating mode during suspend.
56  * @enabled: Enabled during suspend.
57  * @disabled: Disabled during suspend.
58  */
59 struct regulator_state {
60         int uV; /* suspend voltage */
61         unsigned int mode; /* suspend regulator operating mode */
62         int enabled; /* is regulator enabled in this suspend state */
63         int disabled; /* is the regulator disbled in this suspend state */
64 };
65
66 /**
67  * struct regulation_constraints - regulator operating constraints.
68  *
69  * This struct describes regulator and board/machine specific constraints.
70  *
71  * @name: Descriptive name for the constraints, used for display purposes.
72  *
73  * @min_uV: Smallest voltage consumers may set.
74  * @max_uV: Largest voltage consumers may set.
75  * @init_uV: Initial voltage consumers may set.
76  * @uV_offset: Offset applied to voltages from consumer to compensate for
77  *             voltage drops.
78  *
79  * @min_uA: Smallest current consumers may set.
80  * @max_uA: Largest current consumers may set.
81  *
82  * @valid_modes_mask: Mask of modes which may be configured by consumers.
83  * @valid_ops_mask: Operations which may be performed by consumers.
84  *
85  * @always_on: Set if the regulator should never be disabled.
86  * @boot_on: Set if the regulator is enabled when the system is initially
87  *           started.  If the regulator is not enabled by the hardware or
88  *           bootloader then it will be enabled when the constraints are
89  *           applied.
90  * @apply_uV: Apply the voltage constraint when initialising.
91  *
92  * @input_uV: Input voltage for regulator when supplied by another regulator.
93  *
94  * @state_disk: State for regulator when system is suspended in disk mode.
95  * @state_mem: State for regulator when system is suspended in mem mode.
96  * @state_standby: State for regulator when system is suspended in standby
97  *                 mode.
98  * @initial_state: Suspend state to set by default.
99  * @initial_mode: Mode to set at startup.
100  * @ramp_delay: Time to settle down after voltage change (unit: uV/us)
101  */
102 struct regulation_constraints {
103
104         const char *name;
105
106         /* voltage output range (inclusive) - for voltage control */
107         int min_uV;
108         int max_uV;
109         int init_uV;
110
111         int uV_offset;
112
113         /* current output range (inclusive) - for current control */
114         int min_uA;
115         int max_uA;
116
117         /* valid regulator operating modes for this machine */
118         unsigned int valid_modes_mask;
119
120         /* valid operations for regulator on this machine */
121         unsigned int valid_ops_mask;
122
123         /* regulator input voltage - only if supply is another regulator */
124         int input_uV;
125
126         /* regulator suspend states for global PMIC STANDBY/HIBERNATE */
127         struct regulator_state state_disk;
128         struct regulator_state state_mem;
129         struct regulator_state state_standby;
130         suspend_state_t initial_state; /* suspend state to set at init */
131
132         /* mode to set on startup */
133         unsigned int initial_mode;
134
135         /* mode to be set on sleep mode */
136         unsigned int sleep_mode;
137
138         unsigned int ramp_delay;
139
140         /* constraint flags */
141         unsigned always_on:1;   /* regulator never off when system is on */
142         unsigned boot_on:1;     /* bootloader/firmware enabled regulator */
143         unsigned apply_uV:1;    /* apply uV constraint if min == max */
144 };
145
146 /**
147  * struct regulator_consumer_supply - supply -> device mapping
148  *
149  * This maps a supply name to a device. Use of dev_name allows support for
150  * buses which make struct device available late such as I2C.
151  *
152  * @dev_name: Result of dev_name() for the consumer.
153  * @supply: Name for the supply.
154  */
155 struct regulator_consumer_supply {
156         const char *dev_name;   /* dev_name() for consumer */
157         const char *supply;     /* consumer supply - e.g. "vcc" */
158 };
159
160 /* Initialize struct regulator_consumer_supply */
161 #define REGULATOR_SUPPLY(_name, _dev_name)                      \
162 {                                                               \
163         .supply         = _name,                                \
164         .dev_name       = _dev_name,                            \
165 }
166
167 /**
168  * struct regulator_init_data - regulator platform initialisation data.
169  *
170  * Initialisation constraints, our supply and consumers supplies.
171  *
172  * @supply_regulator: Parent regulator.  Specified using the regulator name
173  *                    as it appears in the name field in sysfs, which can
174  *                    be explicitly set using the constraints field 'name'.
175  *
176  * @constraints: Constraints.  These must be specified for the regulator to
177  *               be usable.
178  * @num_consumer_supplies: Number of consumer device supplies.
179  * @consumer_supplies: Consumer device supply configuration.
180  *
181  * @regulator_init: Callback invoked when the regulator has been registered.
182  * @driver_data: Data passed to regulator_init.
183  */
184 struct regulator_init_data {
185         const char *supply_regulator;        /* or NULL for system supply */
186
187         struct regulation_constraints constraints;
188
189         int num_consumer_supplies;
190         struct regulator_consumer_supply *consumer_supplies;
191
192         /* optional regulator machine specific init */
193         int (*regulator_init)(void *driver_data);
194         void *driver_data;      /* core does not touch this */
195 };
196
197 int regulator_suspend_prepare(suspend_state_t state);
198 int regulator_suspend_finish(void);
199
200 #ifdef CONFIG_REGULATOR
201 void regulator_has_full_constraints(void);
202 void regulator_use_dummy_regulator(void);
203 #else
204 static inline void regulator_has_full_constraints(void)
205 {
206 }
207
208 static inline void regulator_use_dummy_regulator(void)
209 {
210 }
211 #endif
212
213 #endif