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