Gitiles
Code Review Sign In
gerrit-public.fairphone.software / kernel / msm-4.19 / 387750c3bf49c22f6189436032145e2131985076 / . / include / linux / power_supply.h
blob: 68ed19ccf1f702c1978c8fb5e18ed557f316484c [file] [log] [blame]
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400[diff] [blame]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/device.h>
17#include <linux/workqueue.h>
18#include <linux/leds.h>
19
20/*
21 * All voltages, currents, charges, energies, time and temperatures in uV,
22 * µA, µAh, µWh, seconds and tenths of degree Celsius unless otherwise
23 * stated. It's driver's job to convert its raw values to units in which
24 * this class operates.
25 */
26
27/*
28 * For systems where the charger determines the maximum battery capacity
29 * the min and max fields should be used to present these values to user
30 * space. Unused/unknown fields will not appear in sysfs.
31 */
32
33enum {
34 POWER_SUPPLY_STATUS_UNKNOWN = 0,
35 POWER_SUPPLY_STATUS_CHARGING,
36 POWER_SUPPLY_STATUS_DISCHARGING,
37 POWER_SUPPLY_STATUS_NOT_CHARGING,
38 POWER_SUPPLY_STATUS_FULL,
39};
40
41enum {
42 POWER_SUPPLY_HEALTH_UNKNOWN = 0,
43 POWER_SUPPLY_HEALTH_GOOD,
44 POWER_SUPPLY_HEALTH_OVERHEAT,
45 POWER_SUPPLY_HEALTH_DEAD,
46 POWER_SUPPLY_HEALTH_OVERVOLTAGE,
47 POWER_SUPPLY_HEALTH_UNSPEC_FAILURE,
48};
49
50enum {
51 POWER_SUPPLY_TECHNOLOGY_UNKNOWN = 0,
52 POWER_SUPPLY_TECHNOLOGY_NiMH,
53 POWER_SUPPLY_TECHNOLOGY_LION,
54 POWER_SUPPLY_TECHNOLOGY_LIPO,
55 POWER_SUPPLY_TECHNOLOGY_LiFe,
56 POWER_SUPPLY_TECHNOLOGY_NiCd,
Dmitry Baryshkovc7cc9302008-01-07 04:12:41 +0300[diff] [blame]57 POWER_SUPPLY_TECHNOLOGY_LiMn,
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400[diff] [blame]58};
59
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400[diff] [blame]60enum power_supply_property {
61 /* Properties of type `int' */
62 POWER_SUPPLY_PROP_STATUS = 0,
63 POWER_SUPPLY_PROP_HEALTH,
64 POWER_SUPPLY_PROP_PRESENT,
65 POWER_SUPPLY_PROP_ONLINE,
66 POWER_SUPPLY_PROP_TECHNOLOGY,
Dmitry Baryshkovc7cc9302008-01-07 04:12:41 +0300[diff] [blame]67 POWER_SUPPLY_PROP_VOLTAGE_MAX,
68 POWER_SUPPLY_PROP_VOLTAGE_MIN,
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400[diff] [blame]69 POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
70 POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
71 POWER_SUPPLY_PROP_VOLTAGE_NOW,
72 POWER_SUPPLY_PROP_VOLTAGE_AVG,
73 POWER_SUPPLY_PROP_CURRENT_NOW,
74 POWER_SUPPLY_PROP_CURRENT_AVG,
75 POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
76 POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN,
77 POWER_SUPPLY_PROP_CHARGE_FULL,
78 POWER_SUPPLY_PROP_CHARGE_EMPTY,
79 POWER_SUPPLY_PROP_CHARGE_NOW,
80 POWER_SUPPLY_PROP_CHARGE_AVG,
81 POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
82 POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN,
83 POWER_SUPPLY_PROP_ENERGY_FULL,
84 POWER_SUPPLY_PROP_ENERGY_EMPTY,
85 POWER_SUPPLY_PROP_ENERGY_NOW,
86 POWER_SUPPLY_PROP_ENERGY_AVG,
87 POWER_SUPPLY_PROP_CAPACITY, /* in percents! */
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400[diff] [blame]88 POWER_SUPPLY_PROP_TEMP,
89 POWER_SUPPLY_PROP_TEMP_AMBIENT,
90 POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
91 POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
92 POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
93 POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
94 /* Properties of type `const char *' */
95 POWER_SUPPLY_PROP_MODEL_NAME,
96 POWER_SUPPLY_PROP_MANUFACTURER,
maximilian attems7c2670b2008-01-22 18:46:50 +0100[diff] [blame]97 POWER_SUPPLY_PROP_SERIAL_NUMBER,
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400[diff] [blame]98};
99
100enum power_supply_type {
101 POWER_SUPPLY_TYPE_BATTERY = 0,
102 POWER_SUPPLY_TYPE_UPS,
103 POWER_SUPPLY_TYPE_MAINS,
104 POWER_SUPPLY_TYPE_USB,
105};
106
107union power_supply_propval {
108 int intval;
109 const char *strval;
110};
111
112struct power_supply {
113 const char *name;
114 enum power_supply_type type;
115 enum power_supply_property *properties;
116 size_t num_properties;
117
118 char **supplied_to;
119 size_t num_supplicants;
120
121 int (*get_property)(struct power_supply *psy,
122 enum power_supply_property psp,
123 union power_supply_propval *val);
124 void (*external_power_changed)(struct power_supply *psy);
125
126 /* For APM emulation, think legacy userspace. */
127 int use_for_apm;
128
129 /* private */
130 struct device *dev;
131 struct work_struct changed_work;
132
133#ifdef CONFIG_LEDS_TRIGGERS
134 struct led_trigger *charging_full_trig;
135 char *charging_full_trig_name;
136 struct led_trigger *charging_trig;
137 char *charging_trig_name;
138 struct led_trigger *full_trig;
139 char *full_trig_name;
140 struct led_trigger *online_trig;
141 char *online_trig_name;
142#endif
143};
144
145/*
146 * This is recommended structure to specify static power supply parameters.
147 * Generic one, parametrizable for different power supplies. Power supply
148 * class itself does not use it, but that's what implementing most platform
149 * drivers, should try reuse for consistency.
150 */
151
152struct power_supply_info {
153 const char *name;
154 int technology;
155 int voltage_max_design;
156 int voltage_min_design;
157 int charge_full_design;
158 int charge_empty_design;
159 int energy_full_design;
160 int energy_empty_design;
161 int use_for_apm;
162};
163
164extern void power_supply_changed(struct power_supply *psy);
165extern int power_supply_am_i_supplied(struct power_supply *psy);
166
167extern int power_supply_register(struct device *parent,
168 struct power_supply *psy);
169extern void power_supply_unregister(struct power_supply *psy);
170
171/* For APM emulation, think legacy userspace. */
172extern struct class *power_supply_class;
173
174#endif /* __LINUX_POWER_SUPPLY_H__ */