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. | |
35 | */ | |
36 | ||
37 | #define REGULATOR_CHANGE_VOLTAGE 0x1 | |
38 | #define REGULATOR_CHANGE_CURRENT 0x2 | |
39 | #define REGULATOR_CHANGE_MODE 0x4 | |
40 | #define REGULATOR_CHANGE_STATUS 0x8 | |
41 | #define REGULATOR_CHANGE_DRMS 0x10 | |
42 | ||
43 | /** | |
44 | * struct regulator_state - regulator state during low power syatem states | |
45 | * | |
46 | * This describes a regulators state during a system wide low power state. | |
c8e7e464 MB |
47 | * |
48 | * @uV: Operating voltage during suspend. | |
49 | * @mode: Operating mode during suspend. | |
50 | * @enabled: Enabled during suspend. | |
4c1184e8 LG |
51 | */ |
52 | struct regulator_state { | |
53 | int uV; /* suspend voltage */ | |
54 | unsigned int mode; /* suspend regulator operating mode */ | |
55 | int enabled; /* is regulator enabled in this suspend state */ | |
56 | }; | |
57 | ||
58 | /** | |
59 | * struct regulation_constraints - regulator operating constraints. | |
60 | * | |
61 | * This struct describes regulator and board/machine specific constraints. | |
c8e7e464 MB |
62 | * |
63 | * @name: Descriptive name for the constraints, used for display purposes. | |
64 | * | |
65 | * @min_uV: Smallest voltage consumers may set. | |
66 | * @max_uV: Largest voltage consumers may set. | |
67 | * | |
68 | * @min_uA: Smallest consumers consumers may set. | |
69 | * @max_uA: Largest current consumers may set. | |
70 | * | |
71 | * @valid_modes_mask: Mask of modes which may be configured by consumers. | |
72 | * @valid_ops_mask: Operations which may be performed by consumers. | |
73 | * | |
74 | * @always_on: Set if the regulator should never be disabled. | |
75 | * @boot_on: Set if the regulator is enabled when the system is initially | |
cacf90f2 MB |
76 | * started. If the regulator is not enabled by the hardware or |
77 | * bootloader then it will be enabled when the constraints are | |
78 | * applied. | |
c8e7e464 MB |
79 | * @apply_uV: Apply the voltage constraint when initialising. |
80 | * | |
81 | * @input_uV: Input voltage for regulator when supplied by another regulator. | |
82 | * | |
83 | * @state_disk: State for regulator when system is suspended in disk mode. | |
84 | * @state_mem: State for regulator when system is suspended in mem mode. | |
85 | * @state_standby: State for regulator when system is suspended in standby | |
86 | * mode. | |
87 | * @initial_state: Suspend state to set by default. | |
a308466c | 88 | * @initial_mode: Mode to set at startup. |
4c1184e8 LG |
89 | */ |
90 | struct regulation_constraints { | |
91 | ||
92 | char *name; | |
93 | ||
94 | /* voltage output range (inclusive) - for voltage control */ | |
95 | int min_uV; | |
96 | int max_uV; | |
97 | ||
98 | /* current output range (inclusive) - for current control */ | |
99 | int min_uA; | |
100 | int max_uA; | |
101 | ||
102 | /* valid regulator operating modes for this machine */ | |
103 | unsigned int valid_modes_mask; | |
104 | ||
105 | /* valid operations for regulator on this machine */ | |
106 | unsigned int valid_ops_mask; | |
107 | ||
108 | /* regulator input voltage - only if supply is another regulator */ | |
109 | int input_uV; | |
110 | ||
111 | /* regulator suspend states for global PMIC STANDBY/HIBERNATE */ | |
112 | struct regulator_state state_disk; | |
113 | struct regulator_state state_mem; | |
114 | struct regulator_state state_standby; | |
115 | suspend_state_t initial_state; /* suspend state to set at init */ | |
116 | ||
a308466c MB |
117 | /* mode to set on startup */ |
118 | unsigned int initial_mode; | |
119 | ||
4c1184e8 LG |
120 | /* constriant flags */ |
121 | unsigned always_on:1; /* regulator never off when system is on */ | |
122 | unsigned boot_on:1; /* bootloader/firmware enabled regulator */ | |
123 | unsigned apply_uV:1; /* apply uV constraint iff min == max */ | |
124 | }; | |
125 | ||
a5766f11 LG |
126 | /** |
127 | * struct regulator_consumer_supply - supply -> device mapping | |
128 | * | |
129 | * This maps a supply name to a device. | |
c8e7e464 MB |
130 | * |
131 | * @dev: Device structure for the consumer. | |
132 | * @supply: Name for the supply. | |
a5766f11 LG |
133 | */ |
134 | struct regulator_consumer_supply { | |
135 | struct device *dev; /* consumer */ | |
136 | const char *supply; /* consumer supply - e.g. "vcc" */ | |
137 | }; | |
4c1184e8 | 138 | |
a5766f11 LG |
139 | /** |
140 | * struct regulator_init_data - regulator platform initialisation data. | |
141 | * | |
142 | * Initialisation constraints, our supply and consumers supplies. | |
c8e7e464 MB |
143 | * |
144 | * @supply_regulator_dev: Parent regulator (if any). | |
145 | * | |
146 | * @constraints: Constraints. These must be specified for the regulator to | |
147 | * be usable. | |
148 | * @num_consumer_supplies: Number of consumer device supplies. | |
149 | * @consumer_supplies: Consumer device supply configuration. | |
150 | * | |
151 | * @regulator_init: Callback invoked when the regulator has been registered. | |
152 | * @driver_data: Data passed to regulator_init. | |
a5766f11 LG |
153 | */ |
154 | struct regulator_init_data { | |
155 | struct device *supply_regulator_dev; /* or NULL for LINE */ | |
4c1184e8 | 156 | |
a5766f11 | 157 | struct regulation_constraints constraints; |
4c1184e8 | 158 | |
a5766f11 LG |
159 | int num_consumer_supplies; |
160 | struct regulator_consumer_supply *consumer_supplies; | |
161 | ||
162 | /* optional regulator machine specific init */ | |
163 | int (*regulator_init)(void *driver_data); | |
164 | void *driver_data; /* core does not touch this */ | |
165 | }; | |
4c1184e8 LG |
166 | |
167 | int regulator_suspend_prepare(suspend_state_t state); | |
168 | ||
ca725561 MB |
169 | void regulator_has_full_constraints(void); |
170 | ||
4c1184e8 | 171 | #endif |