Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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#include <linux/spinlock.h>
19#include <linux/notifier.h>
20
21struct device;
22
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
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
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,
58 POWER_SUPPLY_HEALTH_COLD,
59 POWER_SUPPLY_HEALTH_WATCHDOG_TIMER_EXPIRE,
60 POWER_SUPPLY_HEALTH_SAFETY_TIMER_EXPIRE,
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,
70 POWER_SUPPLY_TECHNOLOGY_LiMn,
71};
72
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
82enum {
83 POWER_SUPPLY_SCOPE_UNKNOWN = 0,
84 POWER_SUPPLY_SCOPE_SYSTEM,
85 POWER_SUPPLY_SCOPE_DEVICE,
86};
87
88enum power_supply_property {
89 /* Properties of type `int' */
90 POWER_SUPPLY_PROP_STATUS = 0,
91 POWER_SUPPLY_PROP_CHARGE_TYPE,
92 POWER_SUPPLY_PROP_HEALTH,
93 POWER_SUPPLY_PROP_PRESENT,
94 POWER_SUPPLY_PROP_ONLINE,
95 POWER_SUPPLY_PROP_AUTHENTIC,
96 POWER_SUPPLY_PROP_TECHNOLOGY,
97 POWER_SUPPLY_PROP_CYCLE_COUNT,
98 POWER_SUPPLY_PROP_VOLTAGE_MAX,
99 POWER_SUPPLY_PROP_VOLTAGE_MIN,
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,
104 POWER_SUPPLY_PROP_VOLTAGE_OCV,
105 POWER_SUPPLY_PROP_CURRENT_MAX,
106 POWER_SUPPLY_PROP_CURRENT_NOW,
107 POWER_SUPPLY_PROP_CURRENT_AVG,
108 POWER_SUPPLY_PROP_POWER_NOW,
109 POWER_SUPPLY_PROP_POWER_AVG,
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,
116 POWER_SUPPLY_PROP_CHARGE_COUNTER,
117 POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT,
118 POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX,
119 POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE,
120 POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX,
121 POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT,
122 POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX,
123 POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
124 POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN,
125 POWER_SUPPLY_PROP_ENERGY_FULL,
126 POWER_SUPPLY_PROP_ENERGY_EMPTY,
127 POWER_SUPPLY_PROP_ENERGY_NOW,
128 POWER_SUPPLY_PROP_ENERGY_AVG,
129 POWER_SUPPLY_PROP_CAPACITY, /* in percents! */
130 POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN, /* in percents! */
131 POWER_SUPPLY_PROP_CAPACITY_ALERT_MAX, /* in percents! */
132 POWER_SUPPLY_PROP_CAPACITY_LEVEL,
133 POWER_SUPPLY_PROP_TEMP,
134 POWER_SUPPLY_PROP_TEMP_ALERT_MIN,
135 POWER_SUPPLY_PROP_TEMP_ALERT_MAX,
136 POWER_SUPPLY_PROP_TEMP_AMBIENT,
137 POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MIN,
138 POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MAX,
139 POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
140 POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
141 POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
142 POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
143 POWER_SUPPLY_PROP_TYPE, /* use power_supply.type instead */
144 POWER_SUPPLY_PROP_SCOPE,
145 /* Properties of type `const char *' */
146 POWER_SUPPLY_PROP_MODEL_NAME,
147 POWER_SUPPLY_PROP_MANUFACTURER,
148 POWER_SUPPLY_PROP_SERIAL_NUMBER,
149};
150
151enum power_supply_type {
152 POWER_SUPPLY_TYPE_UNKNOWN = 0,
153 POWER_SUPPLY_TYPE_BATTERY,
154 POWER_SUPPLY_TYPE_UPS,
155 POWER_SUPPLY_TYPE_MAINS,
156 POWER_SUPPLY_TYPE_USB, /* Standard Downstream Port */
157 POWER_SUPPLY_TYPE_USB_DCP, /* Dedicated Charging Port */
158 POWER_SUPPLY_TYPE_USB_CDP, /* Charging Downstream Port */
159 POWER_SUPPLY_TYPE_USB_ACA, /* Accessory Charger Adapters */
160};
161
162enum power_supply_notifier_events {
163 PSY_EVENT_PROP_CHANGED,
164};
165
166union power_supply_propval {
167 int intval;
168 const char *strval;
169};
170
171struct device_node;
172
173struct power_supply {
174 const char *name;
175 enum power_supply_type type;
176 enum power_supply_property *properties;
177 size_t num_properties;
178
179 char **supplied_to;
180 size_t num_supplicants;
181
182 char **supplied_from;
183 size_t num_supplies;
184 struct device_node *of_node;
185
186 int (*get_property)(struct power_supply *psy,
187 enum power_supply_property psp,
188 union power_supply_propval *val);
189 int (*set_property)(struct power_supply *psy,
190 enum power_supply_property psp,
191 const union power_supply_propval *val);
192 int (*property_is_writeable)(struct power_supply *psy,
193 enum power_supply_property psp);
194 void (*external_power_changed)(struct power_supply *psy);
195 void (*set_charged)(struct power_supply *psy);
196
197 /* For APM emulation, think legacy userspace. */
198 int use_for_apm;
199
200 /* private */
201 struct device *dev;
202 struct work_struct changed_work;
203 spinlock_t changed_lock;
204 bool changed;
205#ifdef CONFIG_THERMAL
206 struct thermal_zone_device *tzd;
207 struct thermal_cooling_device *tcd;
208#endif
209
210#ifdef CONFIG_LEDS_TRIGGERS
211 struct led_trigger *charging_full_trig;
212 char *charging_full_trig_name;
213 struct led_trigger *charging_trig;
214 char *charging_trig_name;
215 struct led_trigger *full_trig;
216 char *full_trig_name;
217 struct led_trigger *online_trig;
218 char *online_trig_name;
219 struct led_trigger *charging_blink_full_solid_trig;
220 char *charging_blink_full_solid_trig_name;
221#endif
222};
223
224/*
225 * This is recommended structure to specify static power supply parameters.
226 * Generic one, parametrizable for different power supplies. Power supply
227 * class itself does not use it, but that's what implementing most platform
228 * drivers, should try reuse for consistency.
229 */
230
231struct power_supply_info {
232 const char *name;
233 int technology;
234 int voltage_max_design;
235 int voltage_min_design;
236 int charge_full_design;
237 int charge_empty_design;
238 int energy_full_design;
239 int energy_empty_design;
240 int use_for_apm;
241};
242
243extern struct atomic_notifier_head power_supply_notifier;
244extern int power_supply_reg_notifier(struct notifier_block *nb);
245extern void power_supply_unreg_notifier(struct notifier_block *nb);
246extern struct power_supply *power_supply_get_by_name(const char *name);
247#ifdef CONFIG_OF
248extern struct power_supply *power_supply_get_by_phandle(struct device_node *np,
249 const char *property);
250#else /* !CONFIG_OF */
251static inline struct power_supply *
252power_supply_get_by_phandle(struct device_node *np, const char *property)
253{ return NULL; }
254#endif /* CONFIG_OF */
255extern void power_supply_changed(struct power_supply *psy);
256extern int power_supply_am_i_supplied(struct power_supply *psy);
257extern int power_supply_set_battery_charged(struct power_supply *psy);
258
259#ifdef CONFIG_POWER_SUPPLY
260extern int power_supply_is_system_supplied(void);
261#else
262static inline int power_supply_is_system_supplied(void) { return -ENOSYS; }
263#endif
264
265extern int power_supply_register(struct device *parent,
266 struct power_supply *psy);
267extern int power_supply_register_no_ws(struct device *parent,
268 struct power_supply *psy);
269extern void power_supply_unregister(struct power_supply *psy);
270extern int power_supply_powers(struct power_supply *psy, struct device *dev);
271
272/* For APM emulation, think legacy userspace. */
273extern struct class *power_supply_class;
274
275static inline bool power_supply_is_amp_property(enum power_supply_property psp)
276{
277 switch (psp) {
278 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
279 case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN:
280 case POWER_SUPPLY_PROP_CHARGE_FULL:
281 case POWER_SUPPLY_PROP_CHARGE_EMPTY:
282 case POWER_SUPPLY_PROP_CHARGE_NOW:
283 case POWER_SUPPLY_PROP_CHARGE_AVG:
284 case POWER_SUPPLY_PROP_CHARGE_COUNTER:
285 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT:
286 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX:
287 case POWER_SUPPLY_PROP_CURRENT_MAX:
288 case POWER_SUPPLY_PROP_CURRENT_NOW:
289 case POWER_SUPPLY_PROP_CURRENT_AVG:
290 return 1;
291 default:
292 break;
293 }
294
295 return 0;
296}
297
298static inline bool power_supply_is_watt_property(enum power_supply_property psp)
299{
300 switch (psp) {
301 case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
302 case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN:
303 case POWER_SUPPLY_PROP_ENERGY_FULL:
304 case POWER_SUPPLY_PROP_ENERGY_EMPTY:
305 case POWER_SUPPLY_PROP_ENERGY_NOW:
306 case POWER_SUPPLY_PROP_ENERGY_AVG:
307 case POWER_SUPPLY_PROP_VOLTAGE_MAX:
308 case POWER_SUPPLY_PROP_VOLTAGE_MIN:
309 case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
310 case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
311 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
312 case POWER_SUPPLY_PROP_VOLTAGE_AVG:
313 case POWER_SUPPLY_PROP_VOLTAGE_OCV:
314 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE:
315 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX:
316 case POWER_SUPPLY_PROP_POWER_NOW:
317 return 1;
318 default:
319 break;
320 }
321
322 return 0;
323}
324
325#endif /* __LINUX_POWER_SUPPLY_H__ */