1 /*
2 * Universal power supply monitor class
3 *
4 * Copyright © 2007 Anton Vorontsov <cbou@mail.ru>
5 * Copyright © 2004 Szabolcs Gyurko
6 * Copyright © 2003 Ian Molton <spyro@f2s.com>
7 *
8 * Modified: 2004, Oct Szabolcs Gyurko
9 *
10 * You may use this code as per GPL version 2
11 */
12
13 #ifndef __LINUX_POWER_SUPPLY_H__
14 #define __LINUX_POWER_SUPPLY_H__
15
16 #include <linux/workqueue.h>
17 #include <linux/leds.h>
18
19 struct device;
20
21 /*
22 * All voltages, currents, charges, energies, time and temperatures in uV,
23 * µA, µAh, µWh, seconds and tenths of degree Celsius unless otherwise
24 * stated. It's driver's job to convert its raw values to units in which
25 * this class operates.
26 */
27
28 /*
29 * For systems where the charger determines the maximum battery capacity
30 * the min and max fields should be used to present these values to user
31 * space. Unused/unknown fields will not appear in sysfs.
32 */
33
34 enum {
35 POWER_SUPPLY_STATUS_UNKNOWN = 0,
36 POWER_SUPPLY_STATUS_CHARGING,
37 POWER_SUPPLY_STATUS_DISCHARGING,
38 POWER_SUPPLY_STATUS_NOT_CHARGING,
39 POWER_SUPPLY_STATUS_FULL,
40 };
41
42 enum {
43 POWER_SUPPLY_CHARGE_TYPE_UNKNOWN = 0,
44 POWER_SUPPLY_CHARGE_TYPE_NONE,
45 POWER_SUPPLY_CHARGE_TYPE_TRICKLE,
46 POWER_SUPPLY_CHARGE_TYPE_FAST,
47 };
48
49 enum {
50 POWER_SUPPLY_HEALTH_UNKNOWN = 0,
51 POWER_SUPPLY_HEALTH_GOOD,
52 POWER_SUPPLY_HEALTH_OVERHEAT,
53 POWER_SUPPLY_HEALTH_DEAD,
54 POWER_SUPPLY_HEALTH_OVERVOLTAGE,
55 POWER_SUPPLY_HEALTH_UNSPEC_FAILURE,
56 POWER_SUPPLY_HEALTH_COLD,
57 };
58
59 enum {
60 POWER_SUPPLY_TECHNOLOGY_UNKNOWN = 0,
61 POWER_SUPPLY_TECHNOLOGY_NiMH,
62 POWER_SUPPLY_TECHNOLOGY_LION,
63 POWER_SUPPLY_TECHNOLOGY_LIPO,
64 POWER_SUPPLY_TECHNOLOGY_LiFe,
65 POWER_SUPPLY_TECHNOLOGY_NiCd,
66 POWER_SUPPLY_TECHNOLOGY_LiMn,
67 };
68
69 enum {
70 POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN = 0,
71 POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL,
72 POWER_SUPPLY_CAPACITY_LEVEL_LOW,
73 POWER_SUPPLY_CAPACITY_LEVEL_NORMAL,
74 POWER_SUPPLY_CAPACITY_LEVEL_HIGH,
75 POWER_SUPPLY_CAPACITY_LEVEL_FULL,
76 };
77
78 enum {
79 POWER_SUPPLY_SCOPE_UNKNOWN = 0,
80 POWER_SUPPLY_SCOPE_SYSTEM,
81 POWER_SUPPLY_SCOPE_DEVICE,
82 };
83
84 enum power_supply_property {
85 /* Properties of type `int' */
86 POWER_SUPPLY_PROP_STATUS = 0,
87 POWER_SUPPLY_PROP_CHARGE_TYPE,
88 POWER_SUPPLY_PROP_HEALTH,
89 POWER_SUPPLY_PROP_PRESENT,
90 POWER_SUPPLY_PROP_ONLINE,
91 POWER_SUPPLY_PROP_TECHNOLOGY,
92 POWER_SUPPLY_PROP_CYCLE_COUNT,
93 POWER_SUPPLY_PROP_VOLTAGE_MAX,
94 POWER_SUPPLY_PROP_VOLTAGE_MIN,
95 POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
96 POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
97 POWER_SUPPLY_PROP_VOLTAGE_NOW,
98 POWER_SUPPLY_PROP_VOLTAGE_AVG,
99 POWER_SUPPLY_PROP_CURRENT_MAX,
100 POWER_SUPPLY_PROP_CURRENT_NOW,
101 POWER_SUPPLY_PROP_CURRENT_AVG,
102 POWER_SUPPLY_PROP_POWER_NOW,
103 POWER_SUPPLY_PROP_POWER_AVG,
104 POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
105 POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN,
106 POWER_SUPPLY_PROP_CHARGE_FULL,
107 POWER_SUPPLY_PROP_CHARGE_EMPTY,
108 POWER_SUPPLY_PROP_CHARGE_NOW,
109 POWER_SUPPLY_PROP_CHARGE_AVG,
110 POWER_SUPPLY_PROP_CHARGE_COUNTER,
111 POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
112 POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN,
113 POWER_SUPPLY_PROP_ENERGY_FULL,
114 POWER_SUPPLY_PROP_ENERGY_EMPTY,
115 POWER_SUPPLY_PROP_ENERGY_NOW,
116 POWER_SUPPLY_PROP_ENERGY_AVG,
117 POWER_SUPPLY_PROP_CAPACITY, /* in percents! */
118 POWER_SUPPLY_PROP_CAPACITY_LEVEL,
119 POWER_SUPPLY_PROP_TEMP,
120 POWER_SUPPLY_PROP_TEMP_AMBIENT,
121 POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
122 POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
123 POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
124 POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
125 POWER_SUPPLY_PROP_TYPE, /* use power_supply.type instead */
126 POWER_SUPPLY_PROP_SCOPE,
127 /* Properties of type `const char *' */
128 POWER_SUPPLY_PROP_MODEL_NAME,
129 POWER_SUPPLY_PROP_MANUFACTURER,
130 POWER_SUPPLY_PROP_SERIAL_NUMBER,
131 };
132
133 enum power_supply_type {
134 POWER_SUPPLY_TYPE_UNKNOWN = 0,
135 POWER_SUPPLY_TYPE_BATTERY,
136 POWER_SUPPLY_TYPE_UPS,
137 POWER_SUPPLY_TYPE_MAINS,
138 POWER_SUPPLY_TYPE_USB, /* Standard Downstream Port */
139 POWER_SUPPLY_TYPE_USB_DCP, /* Dedicated Charging Port */
140 POWER_SUPPLY_TYPE_USB_CDP, /* Charging Downstream Port */
141 POWER_SUPPLY_TYPE_USB_ACA, /* Accessory Charger Adapters */
142 };
143
144 union power_supply_propval {
145 int intval;
146 const char *strval;
147 };
148
149 struct power_supply {
150 const char *name;
151 enum power_supply_type type;
152 enum power_supply_property *properties;
153 size_t num_properties;
154
155 char **supplied_to;
156 size_t num_supplicants;
157
158 int (*get_property)(struct power_supply *psy,
159 enum power_supply_property psp,
160 union power_supply_propval *val);
161 int (*set_property)(struct power_supply *psy,
162 enum power_supply_property psp,
163 const union power_supply_propval *val);
164 int (*property_is_writeable)(struct power_supply *psy,
165 enum power_supply_property psp);
166 void (*external_power_changed)(struct power_supply *psy);
167 void (*set_charged)(struct power_supply *psy);
168
169 /* For APM emulation, think legacy userspace. */
170 int use_for_apm;
171
172 /* private */
173 struct device *dev;
174 struct work_struct changed_work;
175
176 #ifdef CONFIG_LEDS_TRIGGERS
177 struct led_trigger *charging_full_trig;
178 char *charging_full_trig_name;
179 struct led_trigger *charging_trig;
180 char *charging_trig_name;
181 struct led_trigger *full_trig;
182 char *full_trig_name;
183 struct led_trigger *online_trig;
184 char *online_trig_name;
185 struct led_trigger *charging_blink_full_solid_trig;
186 char *charging_blink_full_solid_trig_name;
187 #endif
188 };
189
190 /*
191 * This is recommended structure to specify static power supply parameters.
192 * Generic one, parametrizable for different power supplies. Power supply
193 * class itself does not use it, but that's what implementing most platform
194 * drivers, should try reuse for consistency.
195 */
196
197 struct power_supply_info {
198 const char *name;
199 int technology;
200 int voltage_max_design;
201 int voltage_min_design;
202 int charge_full_design;
203 int charge_empty_design;
204 int energy_full_design;
205 int energy_empty_design;
206 int use_for_apm;
207 };
208
209 extern struct power_supply *power_supply_get_by_name(char *name);
210 extern void power_supply_changed(struct power_supply *psy);
211 extern int power_supply_am_i_supplied(struct power_supply *psy);
212 extern int power_supply_set_battery_charged(struct power_supply *psy);
213
214 #if defined(CONFIG_POWER_SUPPLY) || defined(CONFIG_POWER_SUPPLY_MODULE)
215 extern int power_supply_is_system_supplied(void);
216 #else
power_supply_is_system_supplied(void)217 static inline int power_supply_is_system_supplied(void) { return -ENOSYS; }
218 #endif
219
220 extern int power_supply_register(struct device *parent,
221 struct power_supply *psy);
222 extern void power_supply_unregister(struct power_supply *psy);
223 extern int power_supply_powers(struct power_supply *psy, struct device *dev);
224
225 /* For APM emulation, think legacy userspace. */
226 extern struct class *power_supply_class;
227
power_supply_is_amp_property(enum power_supply_property psp)228 static inline bool power_supply_is_amp_property(enum power_supply_property psp)
229 {
230 switch (psp) {
231 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
232 case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN:
233 case POWER_SUPPLY_PROP_CHARGE_FULL:
234 case POWER_SUPPLY_PROP_CHARGE_EMPTY:
235 case POWER_SUPPLY_PROP_CHARGE_NOW:
236 case POWER_SUPPLY_PROP_CHARGE_AVG:
237 case POWER_SUPPLY_PROP_CHARGE_COUNTER:
238 case POWER_SUPPLY_PROP_CURRENT_MAX:
239 case POWER_SUPPLY_PROP_CURRENT_NOW:
240 case POWER_SUPPLY_PROP_CURRENT_AVG:
241 return 1;
242 default:
243 break;
244 }
245
246 return 0;
247 }
248
power_supply_is_watt_property(enum power_supply_property psp)249 static inline bool power_supply_is_watt_property(enum power_supply_property psp)
250 {
251 switch (psp) {
252 case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
253 case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN:
254 case POWER_SUPPLY_PROP_ENERGY_FULL:
255 case POWER_SUPPLY_PROP_ENERGY_EMPTY:
256 case POWER_SUPPLY_PROP_ENERGY_NOW:
257 case POWER_SUPPLY_PROP_ENERGY_AVG:
258 case POWER_SUPPLY_PROP_VOLTAGE_MAX:
259 case POWER_SUPPLY_PROP_VOLTAGE_MIN:
260 case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
261 case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
262 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
263 case POWER_SUPPLY_PROP_VOLTAGE_AVG:
264 case POWER_SUPPLY_PROP_POWER_NOW:
265 return 1;
266 default:
267 break;
268 }
269
270 return 0;
271 }
272
273 #endif /* __LINUX_POWER_SUPPLY_H__ */
274