charger-manager: Fix struct charger_desc's misleading comment
[deliverable/linux.git] / include / linux / power_supply.h
CommitLineData
4a11b59d
AV
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
4a11b59d
AV
16#include <linux/workqueue.h>
17#include <linux/leds.h>
18
313162d0
PG
19struct device;
20
4a11b59d
AV
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
34enum {
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
ee8076ed
AS
42enum {
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
4a11b59d
AV
49enum {
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,
7e386e6e 56 POWER_SUPPLY_HEALTH_COLD,
4a11b59d
AV
57};
58
59enum {
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,
c7cc930f 66 POWER_SUPPLY_TECHNOLOGY_LiMn,
4a11b59d
AV
67};
68
b294a290
AS
69enum {
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
25a0bc2d
JF
78enum {
79 POWER_SUPPLY_SCOPE_UNKNOWN = 0,
80 POWER_SUPPLY_SCOPE_SYSTEM,
81 POWER_SUPPLY_SCOPE_DEVICE,
82};
83
4a11b59d
AV
84enum power_supply_property {
85 /* Properties of type `int' */
86 POWER_SUPPLY_PROP_STATUS = 0,
ee8076ed 87 POWER_SUPPLY_PROP_CHARGE_TYPE,
4a11b59d
AV
88 POWER_SUPPLY_PROP_HEALTH,
89 POWER_SUPPLY_PROP_PRESENT,
90 POWER_SUPPLY_PROP_ONLINE,
b1b56872 91 POWER_SUPPLY_PROP_AUTHENTIC,
4a11b59d 92 POWER_SUPPLY_PROP_TECHNOLOGY,
c955fe8e 93 POWER_SUPPLY_PROP_CYCLE_COUNT,
c7cc930f
DB
94 POWER_SUPPLY_PROP_VOLTAGE_MAX,
95 POWER_SUPPLY_PROP_VOLTAGE_MIN,
4a11b59d
AV
96 POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
97 POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
98 POWER_SUPPLY_PROP_VOLTAGE_NOW,
99 POWER_SUPPLY_PROP_VOLTAGE_AVG,
a2ebfe2f 100 POWER_SUPPLY_PROP_VOLTAGE_OCV,
fe3f6d09 101 POWER_SUPPLY_PROP_CURRENT_MAX,
4a11b59d
AV
102 POWER_SUPPLY_PROP_CURRENT_NOW,
103 POWER_SUPPLY_PROP_CURRENT_AVG,
7faa144a
AS
104 POWER_SUPPLY_PROP_POWER_NOW,
105 POWER_SUPPLY_PROP_POWER_AVG,
4a11b59d
AV
106 POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
107 POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN,
108 POWER_SUPPLY_PROP_CHARGE_FULL,
109 POWER_SUPPLY_PROP_CHARGE_EMPTY,
110 POWER_SUPPLY_PROP_CHARGE_NOW,
111 POWER_SUPPLY_PROP_CHARGE_AVG,
8e552c36 112 POWER_SUPPLY_PROP_CHARGE_COUNTER,
3824c477
RP
113 POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT,
114 POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE,
4a11b59d
AV
115 POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
116 POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN,
117 POWER_SUPPLY_PROP_ENERGY_FULL,
118 POWER_SUPPLY_PROP_ENERGY_EMPTY,
119 POWER_SUPPLY_PROP_ENERGY_NOW,
120 POWER_SUPPLY_PROP_ENERGY_AVG,
121 POWER_SUPPLY_PROP_CAPACITY, /* in percents! */
e908c418
RP
122 POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN, /* in percents! */
123 POWER_SUPPLY_PROP_CAPACITY_ALERT_MAX, /* in percents! */
b294a290 124 POWER_SUPPLY_PROP_CAPACITY_LEVEL,
4a11b59d 125 POWER_SUPPLY_PROP_TEMP,
e908c418
RP
126 POWER_SUPPLY_PROP_TEMP_ALERT_MIN,
127 POWER_SUPPLY_PROP_TEMP_ALERT_MAX,
4a11b59d 128 POWER_SUPPLY_PROP_TEMP_AMBIENT,
e908c418
RP
129 POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MIN,
130 POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MAX,
4a11b59d
AV
131 POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
132 POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
133 POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
134 POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
5f487cd3 135 POWER_SUPPLY_PROP_TYPE, /* use power_supply.type instead */
25a0bc2d 136 POWER_SUPPLY_PROP_SCOPE,
4a11b59d
AV
137 /* Properties of type `const char *' */
138 POWER_SUPPLY_PROP_MODEL_NAME,
139 POWER_SUPPLY_PROP_MANUFACTURER,
7c2670bb 140 POWER_SUPPLY_PROP_SERIAL_NUMBER,
4a11b59d
AV
141};
142
143enum power_supply_type {
9b887227
KM
144 POWER_SUPPLY_TYPE_UNKNOWN = 0,
145 POWER_SUPPLY_TYPE_BATTERY,
4a11b59d
AV
146 POWER_SUPPLY_TYPE_UPS,
147 POWER_SUPPLY_TYPE_MAINS,
85efc8a1
HK
148 POWER_SUPPLY_TYPE_USB, /* Standard Downstream Port */
149 POWER_SUPPLY_TYPE_USB_DCP, /* Dedicated Charging Port */
150 POWER_SUPPLY_TYPE_USB_CDP, /* Charging Downstream Port */
151 POWER_SUPPLY_TYPE_USB_ACA, /* Accessory Charger Adapters */
4a11b59d
AV
152};
153
154union power_supply_propval {
155 int intval;
156 const char *strval;
157};
158
159struct power_supply {
160 const char *name;
161 enum power_supply_type type;
162 enum power_supply_property *properties;
163 size_t num_properties;
164
165 char **supplied_to;
166 size_t num_supplicants;
167
168 int (*get_property)(struct power_supply *psy,
169 enum power_supply_property psp,
170 union power_supply_propval *val);
0011d2d4
DM
171 int (*set_property)(struct power_supply *psy,
172 enum power_supply_property psp,
173 const union power_supply_propval *val);
174 int (*property_is_writeable)(struct power_supply *psy,
175 enum power_supply_property psp);
4a11b59d 176 void (*external_power_changed)(struct power_supply *psy);
e5f5ccb6 177 void (*set_charged)(struct power_supply *psy);
4a11b59d
AV
178
179 /* For APM emulation, think legacy userspace. */
180 int use_for_apm;
181
182 /* private */
183 struct device *dev;
184 struct work_struct changed_work;
3be330bf
JT
185#ifdef CONFIG_THERMAL
186 struct thermal_zone_device *tzd;
187#endif
4a11b59d
AV
188
189#ifdef CONFIG_LEDS_TRIGGERS
190 struct led_trigger *charging_full_trig;
191 char *charging_full_trig_name;
192 struct led_trigger *charging_trig;
193 char *charging_trig_name;
194 struct led_trigger *full_trig;
195 char *full_trig_name;
196 struct led_trigger *online_trig;
197 char *online_trig_name;
6501f728
VK
198 struct led_trigger *charging_blink_full_solid_trig;
199 char *charging_blink_full_solid_trig_name;
4a11b59d
AV
200#endif
201};
202
203/*
204 * This is recommended structure to specify static power supply parameters.
205 * Generic one, parametrizable for different power supplies. Power supply
206 * class itself does not use it, but that's what implementing most platform
207 * drivers, should try reuse for consistency.
208 */
209
210struct power_supply_info {
211 const char *name;
212 int technology;
213 int voltage_max_design;
214 int voltage_min_design;
215 int charge_full_design;
216 int charge_empty_design;
217 int energy_full_design;
218 int energy_empty_design;
219 int use_for_apm;
220};
221
e5f5ccb6 222extern struct power_supply *power_supply_get_by_name(char *name);
4a11b59d
AV
223extern void power_supply_changed(struct power_supply *psy);
224extern int power_supply_am_i_supplied(struct power_supply *psy);
e5f5ccb6 225extern int power_supply_set_battery_charged(struct power_supply *psy);
4a11b59d 226
0d4ed4e2 227#ifdef CONFIG_POWER_SUPPLY
942ed161
MG
228extern int power_supply_is_system_supplied(void);
229#else
230static inline int power_supply_is_system_supplied(void) { return -ENOSYS; }
231#endif
232
4a11b59d
AV
233extern int power_supply_register(struct device *parent,
234 struct power_supply *psy);
235extern void power_supply_unregister(struct power_supply *psy);
83516651 236extern int power_supply_powers(struct power_supply *psy, struct device *dev);
4a11b59d
AV
237
238/* For APM emulation, think legacy userspace. */
239extern struct class *power_supply_class;
240
51d07566
RK
241static inline bool power_supply_is_amp_property(enum power_supply_property psp)
242{
243 switch (psp) {
244 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
245 case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN:
246 case POWER_SUPPLY_PROP_CHARGE_FULL:
247 case POWER_SUPPLY_PROP_CHARGE_EMPTY:
248 case POWER_SUPPLY_PROP_CHARGE_NOW:
249 case POWER_SUPPLY_PROP_CHARGE_AVG:
250 case POWER_SUPPLY_PROP_CHARGE_COUNTER:
3824c477 251 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT:
51d07566
RK
252 case POWER_SUPPLY_PROP_CURRENT_MAX:
253 case POWER_SUPPLY_PROP_CURRENT_NOW:
254 case POWER_SUPPLY_PROP_CURRENT_AVG:
255 return 1;
256 default:
257 break;
258 }
259
260 return 0;
261}
262
263static inline bool power_supply_is_watt_property(enum power_supply_property psp)
264{
265 switch (psp) {
266 case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
267 case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN:
268 case POWER_SUPPLY_PROP_ENERGY_FULL:
269 case POWER_SUPPLY_PROP_ENERGY_EMPTY:
270 case POWER_SUPPLY_PROP_ENERGY_NOW:
271 case POWER_SUPPLY_PROP_ENERGY_AVG:
272 case POWER_SUPPLY_PROP_VOLTAGE_MAX:
273 case POWER_SUPPLY_PROP_VOLTAGE_MIN:
274 case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
275 case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
276 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
277 case POWER_SUPPLY_PROP_VOLTAGE_AVG:
a2ebfe2f 278 case POWER_SUPPLY_PROP_VOLTAGE_OCV:
3824c477 279 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE:
35c9d267 280 case POWER_SUPPLY_PROP_POWER_NOW:
51d07566
RK
281 return 1;
282 default:
283 break;
284 }
285
286 return 0;
287}
288
4a11b59d 289#endif /* __LINUX_POWER_SUPPLY_H__ */
This page took 0.451812 seconds and 5 git commands to generate.