2 * Universal power supply monitor class
4 * Copyright © 2007 Anton Vorontsov <cbou@mail.ru>
5 * Copyright © 2004 Szabolcs Gyurko
6 * Copyright © 2003 Ian Molton <spyro@f2s.com>
8 * Modified: 2004, Oct Szabolcs Gyurko
10 * You may use this code as per GPL version 2
13 #ifndef __LINUX_POWER_SUPPLY_H__
14 #define __LINUX_POWER_SUPPLY_H__
16 #include <linux/workqueue.h>
17 #include <linux/leds.h>
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.
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.
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
,
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
,
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
,
56 POWER_SUPPLY_HEALTH_COLD
,
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
,
66 POWER_SUPPLY_TECHNOLOGY_LiMn
,
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
,
79 POWER_SUPPLY_SCOPE_UNKNOWN
= 0,
80 POWER_SUPPLY_SCOPE_SYSTEM
,
81 POWER_SUPPLY_SCOPE_DEVICE
,
84 enum power_supply_property
{
85 /* Properties of type `int' */
86 POWER_SUPPLY_PROP_STATUS
= 0,
87 POWER_SUPPLY_PROP_CHARGE_TYPE
,
88 POWER_SUPPLY_PROP_HEALTH
,
89 POWER_SUPPLY_PROP_PRESENT
,
90 POWER_SUPPLY_PROP_ONLINE
,
91 POWER_SUPPLY_PROP_AUTHENTIC
,
92 POWER_SUPPLY_PROP_TECHNOLOGY
,
93 POWER_SUPPLY_PROP_CYCLE_COUNT
,
94 POWER_SUPPLY_PROP_VOLTAGE_MAX
,
95 POWER_SUPPLY_PROP_VOLTAGE_MIN
,
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
,
100 POWER_SUPPLY_PROP_VOLTAGE_OCV
,
101 POWER_SUPPLY_PROP_CURRENT_MAX
,
102 POWER_SUPPLY_PROP_CURRENT_NOW
,
103 POWER_SUPPLY_PROP_CURRENT_AVG
,
104 POWER_SUPPLY_PROP_POWER_NOW
,
105 POWER_SUPPLY_PROP_POWER_AVG
,
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
,
112 POWER_SUPPLY_PROP_CHARGE_COUNTER
,
113 POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT
,
114 POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX
,
115 POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE
,
116 POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX
,
117 POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT
,
118 POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX
,
119 POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN
,
120 POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN
,
121 POWER_SUPPLY_PROP_ENERGY_FULL
,
122 POWER_SUPPLY_PROP_ENERGY_EMPTY
,
123 POWER_SUPPLY_PROP_ENERGY_NOW
,
124 POWER_SUPPLY_PROP_ENERGY_AVG
,
125 POWER_SUPPLY_PROP_CAPACITY
, /* in percents! */
126 POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN
, /* in percents! */
127 POWER_SUPPLY_PROP_CAPACITY_ALERT_MAX
, /* in percents! */
128 POWER_SUPPLY_PROP_CAPACITY_LEVEL
,
129 POWER_SUPPLY_PROP_TEMP
,
130 POWER_SUPPLY_PROP_TEMP_ALERT_MIN
,
131 POWER_SUPPLY_PROP_TEMP_ALERT_MAX
,
132 POWER_SUPPLY_PROP_TEMP_AMBIENT
,
133 POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MIN
,
134 POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MAX
,
135 POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW
,
136 POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG
,
137 POWER_SUPPLY_PROP_TIME_TO_FULL_NOW
,
138 POWER_SUPPLY_PROP_TIME_TO_FULL_AVG
,
139 POWER_SUPPLY_PROP_TYPE
, /* use power_supply.type instead */
140 POWER_SUPPLY_PROP_SCOPE
,
141 /* Properties of type `const char *' */
142 POWER_SUPPLY_PROP_MODEL_NAME
,
143 POWER_SUPPLY_PROP_MANUFACTURER
,
144 POWER_SUPPLY_PROP_SERIAL_NUMBER
,
147 enum power_supply_type
{
148 POWER_SUPPLY_TYPE_UNKNOWN
= 0,
149 POWER_SUPPLY_TYPE_BATTERY
,
150 POWER_SUPPLY_TYPE_UPS
,
151 POWER_SUPPLY_TYPE_MAINS
,
152 POWER_SUPPLY_TYPE_USB
, /* Standard Downstream Port */
153 POWER_SUPPLY_TYPE_USB_DCP
, /* Dedicated Charging Port */
154 POWER_SUPPLY_TYPE_USB_CDP
, /* Charging Downstream Port */
155 POWER_SUPPLY_TYPE_USB_ACA
, /* Accessory Charger Adapters */
158 union power_supply_propval
{
163 struct power_supply
{
165 enum power_supply_type type
;
166 enum power_supply_property
*properties
;
167 size_t num_properties
;
170 size_t num_supplicants
;
172 int (*get_property
)(struct power_supply
*psy
,
173 enum power_supply_property psp
,
174 union power_supply_propval
*val
);
175 int (*set_property
)(struct power_supply
*psy
,
176 enum power_supply_property psp
,
177 const union power_supply_propval
*val
);
178 int (*property_is_writeable
)(struct power_supply
*psy
,
179 enum power_supply_property psp
);
180 void (*external_power_changed
)(struct power_supply
*psy
);
181 void (*set_charged
)(struct power_supply
*psy
);
183 /* For APM emulation, think legacy userspace. */
188 struct work_struct changed_work
;
189 #ifdef CONFIG_THERMAL
190 struct thermal_zone_device
*tzd
;
191 struct thermal_cooling_device
*tcd
;
194 #ifdef CONFIG_LEDS_TRIGGERS
195 struct led_trigger
*charging_full_trig
;
196 char *charging_full_trig_name
;
197 struct led_trigger
*charging_trig
;
198 char *charging_trig_name
;
199 struct led_trigger
*full_trig
;
200 char *full_trig_name
;
201 struct led_trigger
*online_trig
;
202 char *online_trig_name
;
203 struct led_trigger
*charging_blink_full_solid_trig
;
204 char *charging_blink_full_solid_trig_name
;
209 * This is recommended structure to specify static power supply parameters.
210 * Generic one, parametrizable for different power supplies. Power supply
211 * class itself does not use it, but that's what implementing most platform
212 * drivers, should try reuse for consistency.
215 struct power_supply_info
{
218 int voltage_max_design
;
219 int voltage_min_design
;
220 int charge_full_design
;
221 int charge_empty_design
;
222 int energy_full_design
;
223 int energy_empty_design
;
227 extern struct power_supply
*power_supply_get_by_name(char *name
);
228 extern void power_supply_changed(struct power_supply
*psy
);
229 extern int power_supply_am_i_supplied(struct power_supply
*psy
);
230 extern int power_supply_set_battery_charged(struct power_supply
*psy
);
232 #ifdef CONFIG_POWER_SUPPLY
233 extern int power_supply_is_system_supplied(void);
235 static inline int power_supply_is_system_supplied(void) { return -ENOSYS
; }
238 extern int power_supply_register(struct device
*parent
,
239 struct power_supply
*psy
);
240 extern void power_supply_unregister(struct power_supply
*psy
);
241 extern int power_supply_powers(struct power_supply
*psy
, struct device
*dev
);
243 /* For APM emulation, think legacy userspace. */
244 extern struct class *power_supply_class
;
246 static inline bool power_supply_is_amp_property(enum power_supply_property psp
)
249 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN
:
250 case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN
:
251 case POWER_SUPPLY_PROP_CHARGE_FULL
:
252 case POWER_SUPPLY_PROP_CHARGE_EMPTY
:
253 case POWER_SUPPLY_PROP_CHARGE_NOW
:
254 case POWER_SUPPLY_PROP_CHARGE_AVG
:
255 case POWER_SUPPLY_PROP_CHARGE_COUNTER
:
256 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT
:
257 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX
:
258 case POWER_SUPPLY_PROP_CURRENT_MAX
:
259 case POWER_SUPPLY_PROP_CURRENT_NOW
:
260 case POWER_SUPPLY_PROP_CURRENT_AVG
:
269 static inline bool power_supply_is_watt_property(enum power_supply_property psp
)
272 case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN
:
273 case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN
:
274 case POWER_SUPPLY_PROP_ENERGY_FULL
:
275 case POWER_SUPPLY_PROP_ENERGY_EMPTY
:
276 case POWER_SUPPLY_PROP_ENERGY_NOW
:
277 case POWER_SUPPLY_PROP_ENERGY_AVG
:
278 case POWER_SUPPLY_PROP_VOLTAGE_MAX
:
279 case POWER_SUPPLY_PROP_VOLTAGE_MIN
:
280 case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN
:
281 case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN
:
282 case POWER_SUPPLY_PROP_VOLTAGE_NOW
:
283 case POWER_SUPPLY_PROP_VOLTAGE_AVG
:
284 case POWER_SUPPLY_PROP_VOLTAGE_OCV
:
285 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE
:
286 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX
:
287 case POWER_SUPPLY_PROP_POWER_NOW
:
296 #endif /* __LINUX_POWER_SUPPLY_H__ */