projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge tag 'kvm-arm-for-3.18' of git://git.kernel.org/pub/scm/linux/kernel/git/kvmarm...
[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>
948dcf96 18#include <linux/spinlock.h>
d36240d2 19#include <linux/notifier.h>
4a11b59d 20
313162d0
PG		 21struct device;
22
4a11b59d
AV		 23/*
24 * All voltages, currents, charges, energies, time and temperatures in uV,
25 * µA, µAh, µWh, seconds and tenths of degree Celsius unless otherwise
26 * stated. It's driver's job to convert its raw values to units in which
27 * this class operates.
28 */
29
30/*
31 * For systems where the charger determines the maximum battery capacity
32 * the min and max fields should be used to present these values to user
33 * space. Unused/unknown fields will not appear in sysfs.
34 */
35
36enum {
37 POWER_SUPPLY_STATUS_UNKNOWN = 0,
38 POWER_SUPPLY_STATUS_CHARGING,
39 POWER_SUPPLY_STATUS_DISCHARGING,
40 POWER_SUPPLY_STATUS_NOT_CHARGING,
41 POWER_SUPPLY_STATUS_FULL,
42};
43
ee8076ed
AS		 44enum {
45 POWER_SUPPLY_CHARGE_TYPE_UNKNOWN = 0,
46 POWER_SUPPLY_CHARGE_TYPE_NONE,
47 POWER_SUPPLY_CHARGE_TYPE_TRICKLE,
48 POWER_SUPPLY_CHARGE_TYPE_FAST,
49};
50
4a11b59d
AV		 51enum {
52 POWER_SUPPLY_HEALTH_UNKNOWN = 0,
53 POWER_SUPPLY_HEALTH_GOOD,
54 POWER_SUPPLY_HEALTH_OVERHEAT,
55 POWER_SUPPLY_HEALTH_DEAD,
56 POWER_SUPPLY_HEALTH_OVERVOLTAGE,
57 POWER_SUPPLY_HEALTH_UNSPEC_FAILURE,
7e386e6e 58 POWER_SUPPLY_HEALTH_COLD,
a05be991
RP		 59 POWER_SUPPLY_HEALTH_WATCHDOG_TIMER_EXPIRE,
60 POWER_SUPPLY_HEALTH_SAFETY_TIMER_EXPIRE,
4a11b59d
AV		 61};
62
63enum {
64 POWER_SUPPLY_TECHNOLOGY_UNKNOWN = 0,
65 POWER_SUPPLY_TECHNOLOGY_NiMH,
66 POWER_SUPPLY_TECHNOLOGY_LION,
67 POWER_SUPPLY_TECHNOLOGY_LIPO,
68 POWER_SUPPLY_TECHNOLOGY_LiFe,
69 POWER_SUPPLY_TECHNOLOGY_NiCd,
c7cc930f 70 POWER_SUPPLY_TECHNOLOGY_LiMn,
4a11b59d
AV		 71};
72
b294a290
AS		 73enum {
74 POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN = 0,
75 POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL,
76 POWER_SUPPLY_CAPACITY_LEVEL_LOW,
77 POWER_SUPPLY_CAPACITY_LEVEL_NORMAL,
78 POWER_SUPPLY_CAPACITY_LEVEL_HIGH,
79 POWER_SUPPLY_CAPACITY_LEVEL_FULL,
80};
81
25a0bc2d
JF		 82enum {
83 POWER_SUPPLY_SCOPE_UNKNOWN = 0,
84 POWER_SUPPLY_SCOPE_SYSTEM,
85 POWER_SUPPLY_SCOPE_DEVICE,
86};
87
4a11b59d
AV		 88enum power_supply_property {
89 /* Properties of type `int' */
90 POWER_SUPPLY_PROP_STATUS = 0,
ee8076ed 91 POWER_SUPPLY_PROP_CHARGE_TYPE,
4a11b59d
AV		 92 POWER_SUPPLY_PROP_HEALTH,
93 POWER_SUPPLY_PROP_PRESENT,
94 POWER_SUPPLY_PROP_ONLINE,
b1b56872 95 POWER_SUPPLY_PROP_AUTHENTIC,
4a11b59d 96 POWER_SUPPLY_PROP_TECHNOLOGY,
c955fe8e 97 POWER_SUPPLY_PROP_CYCLE_COUNT,
c7cc930f
DB		 98 POWER_SUPPLY_PROP_VOLTAGE_MAX,
99 POWER_SUPPLY_PROP_VOLTAGE_MIN,
4a11b59d
AV		 100 POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
101 POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
102 POWER_SUPPLY_PROP_VOLTAGE_NOW,
103 POWER_SUPPLY_PROP_VOLTAGE_AVG,
a2ebfe2f 104 POWER_SUPPLY_PROP_VOLTAGE_OCV,
fe3f6d09 105 POWER_SUPPLY_PROP_CURRENT_MAX,
4a11b59d
AV		 106 POWER_SUPPLY_PROP_CURRENT_NOW,
107 POWER_SUPPLY_PROP_CURRENT_AVG,
7faa144a
AS		 108 POWER_SUPPLY_PROP_POWER_NOW,
109 POWER_SUPPLY_PROP_POWER_AVG,
4a11b59d
AV		 110 POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
111 POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN,
112 POWER_SUPPLY_PROP_CHARGE_FULL,
113 POWER_SUPPLY_PROP_CHARGE_EMPTY,
114 POWER_SUPPLY_PROP_CHARGE_NOW,
115 POWER_SUPPLY_PROP_CHARGE_AVG,
8e552c36 116 POWER_SUPPLY_PROP_CHARGE_COUNTER,
3824c477 117 POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT,
2815b786 118 POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX,
3824c477 119 POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE,
2815b786 120 POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX,
ea2ce92e
RP		 121 POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT,
122 POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX,
6bb1d272 123 POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT,
4a11b59d
AV		 124 POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
125 POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN,
126 POWER_SUPPLY_PROP_ENERGY_FULL,
127 POWER_SUPPLY_PROP_ENERGY_EMPTY,
128 POWER_SUPPLY_PROP_ENERGY_NOW,
129 POWER_SUPPLY_PROP_ENERGY_AVG,
130 POWER_SUPPLY_PROP_CAPACITY, /* in percents! */
e908c418
RP		 131 POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN, /* in percents! */
132 POWER_SUPPLY_PROP_CAPACITY_ALERT_MAX, /* in percents! */
b294a290 133 POWER_SUPPLY_PROP_CAPACITY_LEVEL,
4a11b59d 134 POWER_SUPPLY_PROP_TEMP,
6bb1d272
JT		 135 POWER_SUPPLY_PROP_TEMP_MAX,
136 POWER_SUPPLY_PROP_TEMP_MIN,
e908c418
RP		 137 POWER_SUPPLY_PROP_TEMP_ALERT_MIN,
138 POWER_SUPPLY_PROP_TEMP_ALERT_MAX,
4a11b59d 139 POWER_SUPPLY_PROP_TEMP_AMBIENT,
e908c418
RP		 140 POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MIN,
141 POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MAX,
4a11b59d
AV		 142 POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
143 POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
144 POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
145 POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
5f487cd3 146 POWER_SUPPLY_PROP_TYPE, /* use power_supply.type instead */
25a0bc2d 147 POWER_SUPPLY_PROP_SCOPE,
6bb1d272 148 POWER_SUPPLY_PROP_CHARGE_TERM_CURRENT,
4a11b59d
AV		 149 /* Properties of type `const char *' */
150 POWER_SUPPLY_PROP_MODEL_NAME,
151 POWER_SUPPLY_PROP_MANUFACTURER,
7c2670bb 152 POWER_SUPPLY_PROP_SERIAL_NUMBER,
4a11b59d
AV		 153};
154
155enum power_supply_type {
9b887227
KM		 156 POWER_SUPPLY_TYPE_UNKNOWN = 0,
157 POWER_SUPPLY_TYPE_BATTERY,
4a11b59d
AV		 158 POWER_SUPPLY_TYPE_UPS,
159 POWER_SUPPLY_TYPE_MAINS,
85efc8a1
HK		 160 POWER_SUPPLY_TYPE_USB, /* Standard Downstream Port */
161 POWER_SUPPLY_TYPE_USB_DCP, /* Dedicated Charging Port */
162 POWER_SUPPLY_TYPE_USB_CDP, /* Charging Downstream Port */
163 POWER_SUPPLY_TYPE_USB_ACA, /* Accessory Charger Adapters */
4a11b59d
AV		 164};
165
d36240d2
PR		 166enum power_supply_notifier_events {
167 PSY_EVENT_PROP_CHANGED,
168};
169
4a11b59d
AV		 170union power_supply_propval {
171 int intval;
172 const char *strval;
173};
174
b50df95c
AV		 175struct device_node;
176
4a11b59d
AV		 177struct power_supply {
178 const char *name;
179 enum power_supply_type type;
180 enum power_supply_property *properties;
181 size_t num_properties;
182
183 char **supplied_to;
184 size_t num_supplicants;
185
5e0848c6
RK		 186 char **supplied_from;
187 size_t num_supplies;
f6e0b081 188 struct device_node *of_node;
5e0848c6 189
4a11b59d
AV		 190 int (*get_property)(struct power_supply *psy,
191 enum power_supply_property psp,
192 union power_supply_propval *val);
0011d2d4
DM		 193 int (*set_property)(struct power_supply *psy,
194 enum power_supply_property psp,
195 const union power_supply_propval *val);
196 int (*property_is_writeable)(struct power_supply *psy,
197 enum power_supply_property psp);
4a11b59d 198 void (*external_power_changed)(struct power_supply *psy);
e5f5ccb6 199 void (*set_charged)(struct power_supply *psy);
4a11b59d
AV		 200
201 /* For APM emulation, think legacy userspace. */
202 int use_for_apm;
203
204 /* private */
205 struct device *dev;
206 struct work_struct changed_work;
948dcf96
ZM		 207 spinlock_t changed_lock;
208 bool changed;
3be330bf
JT		 209#ifdef CONFIG_THERMAL
210 struct thermal_zone_device *tzd;
952aeeb3 211 struct thermal_cooling_device *tcd;
3be330bf 212#endif
4a11b59d
AV		 213
214#ifdef CONFIG_LEDS_TRIGGERS
215 struct led_trigger *charging_full_trig;
216 char *charging_full_trig_name;
217 struct led_trigger *charging_trig;
218 char *charging_trig_name;
219 struct led_trigger *full_trig;
220 char *full_trig_name;
221 struct led_trigger *online_trig;
222 char *online_trig_name;
6501f728
VK		 223 struct led_trigger *charging_blink_full_solid_trig;
224 char *charging_blink_full_solid_trig_name;
4a11b59d
AV		 225#endif
226};
227
228/*
229 * This is recommended structure to specify static power supply parameters.
230 * Generic one, parametrizable for different power supplies. Power supply
231 * class itself does not use it, but that's what implementing most platform
232 * drivers, should try reuse for consistency.
233 */
234
235struct power_supply_info {
236 const char *name;
237 int technology;
238 int voltage_max_design;
239 int voltage_min_design;
240 int charge_full_design;
241 int charge_empty_design;
242 int energy_full_design;
243 int energy_empty_design;
244 int use_for_apm;
245};
246
d36240d2
PR		 247extern struct atomic_notifier_head power_supply_notifier;
248extern int power_supply_reg_notifier(struct notifier_block *nb);
249extern void power_supply_unreg_notifier(struct notifier_block *nb);
9f3b795a 250extern struct power_supply *power_supply_get_by_name(const char *name);
abce9770
SR		 251#ifdef CONFIG_OF
252extern struct power_supply *power_supply_get_by_phandle(struct device_node *np,
253 const char *property);
254#else /* !CONFIG_OF */
255static inline struct power_supply *
256power_supply_get_by_phandle(struct device_node *np, const char *property)
257{ return NULL; }
258#endif /* CONFIG_OF */
4a11b59d
AV		 259extern void power_supply_changed(struct power_supply *psy);
260extern int power_supply_am_i_supplied(struct power_supply *psy);
e5f5ccb6 261extern int power_supply_set_battery_charged(struct power_supply *psy);
4a11b59d 262
0d4ed4e2 263#ifdef CONFIG_POWER_SUPPLY
942ed161
MG		 264extern int power_supply_is_system_supplied(void);
265#else
266static inline int power_supply_is_system_supplied(void) { return -ENOSYS; }
267#endif
268
4a11b59d
AV		 269extern int power_supply_register(struct device *parent,
270 struct power_supply *psy);
9113e260
ZR		 271extern int power_supply_register_no_ws(struct device *parent,
272 struct power_supply *psy);
4a11b59d 273extern void power_supply_unregister(struct power_supply *psy);
83516651 274extern int power_supply_powers(struct power_supply *psy, struct device *dev);
4a11b59d
AV		 275
276/* For APM emulation, think legacy userspace. */
277extern struct class *power_supply_class;
278
51d07566
RK		 279static inline bool power_supply_is_amp_property(enum power_supply_property psp)
280{
281 switch (psp) {
282 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
283 case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN:
284 case POWER_SUPPLY_PROP_CHARGE_FULL:
285 case POWER_SUPPLY_PROP_CHARGE_EMPTY:
286 case POWER_SUPPLY_PROP_CHARGE_NOW:
287 case POWER_SUPPLY_PROP_CHARGE_AVG:
288 case POWER_SUPPLY_PROP_CHARGE_COUNTER:
3824c477 289 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT:
2815b786 290 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX:
51d07566
RK		 291 case POWER_SUPPLY_PROP_CURRENT_MAX:
292 case POWER_SUPPLY_PROP_CURRENT_NOW:
293 case POWER_SUPPLY_PROP_CURRENT_AVG:
294 return 1;
295 default:
296 break;
297 }
298
299 return 0;
300}
301
302static inline bool power_supply_is_watt_property(enum power_supply_property psp)
303{
304 switch (psp) {
305 case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
306 case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN:
307 case POWER_SUPPLY_PROP_ENERGY_FULL:
308 case POWER_SUPPLY_PROP_ENERGY_EMPTY:
309 case POWER_SUPPLY_PROP_ENERGY_NOW:
310 case POWER_SUPPLY_PROP_ENERGY_AVG:
311 case POWER_SUPPLY_PROP_VOLTAGE_MAX:
312 case POWER_SUPPLY_PROP_VOLTAGE_MIN:
313 case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
314 case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
315 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
316 case POWER_SUPPLY_PROP_VOLTAGE_AVG:
a2ebfe2f 317 case POWER_SUPPLY_PROP_VOLTAGE_OCV:
3824c477 318 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE:
2815b786 319 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX:
35c9d267 320 case POWER_SUPPLY_PROP_POWER_NOW:
51d07566
RK		 321 return 1;
322 default:
323 break;
324 }
325
326 return 0;
327}
328
4a11b59d 329#endif /* __LINUX_POWER_SUPPLY_H__ */
Linux kernel - Deliverables
This page took 0.535963 seconds and 5 git commands to generate.