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/device.h>
17 #include <linux/wakelock.h>
18 #include <linux/workqueue.h>
19 #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,
78 enum power_supply_property {
79 /* Properties of type `int' */
80 POWER_SUPPLY_PROP_STATUS = 0,
81 POWER_SUPPLY_PROP_CHARGE_TYPE,
82 POWER_SUPPLY_PROP_HEALTH,
83 POWER_SUPPLY_PROP_PRESENT,
84 POWER_SUPPLY_PROP_ONLINE,
85 POWER_SUPPLY_PROP_TECHNOLOGY,
86 POWER_SUPPLY_PROP_CYCLE_COUNT,
87 POWER_SUPPLY_PROP_VOLTAGE_MAX,
88 POWER_SUPPLY_PROP_VOLTAGE_MIN,
89 POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
90 POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
91 POWER_SUPPLY_PROP_VOLTAGE_NOW,
92 POWER_SUPPLY_PROP_VOLTAGE_AVG,
93 POWER_SUPPLY_PROP_CURRENT_MAX,
94 POWER_SUPPLY_PROP_CURRENT_NOW,
95 POWER_SUPPLY_PROP_CURRENT_AVG,
96 POWER_SUPPLY_PROP_POWER_NOW,
97 POWER_SUPPLY_PROP_POWER_AVG,
98 POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
99 POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN,
100 POWER_SUPPLY_PROP_CHARGE_FULL,
101 POWER_SUPPLY_PROP_CHARGE_EMPTY,
102 POWER_SUPPLY_PROP_CHARGE_NOW,
103 POWER_SUPPLY_PROP_CHARGE_AVG,
104 POWER_SUPPLY_PROP_CHARGE_COUNTER,
105 POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
106 POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN,
107 POWER_SUPPLY_PROP_ENERGY_FULL,
108 POWER_SUPPLY_PROP_ENERGY_EMPTY,
109 POWER_SUPPLY_PROP_ENERGY_NOW,
110 POWER_SUPPLY_PROP_ENERGY_AVG,
111 POWER_SUPPLY_PROP_CAPACITY, /* in percents! */
112 POWER_SUPPLY_PROP_CAPACITY_LEVEL,
113 POWER_SUPPLY_PROP_TEMP,
114 POWER_SUPPLY_PROP_TEMP_AMBIENT,
115 POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
116 POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
117 POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
118 POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
119 POWER_SUPPLY_PROP_TYPE, /* use power_supply.type instead */
120 /* Properties of type `const char *' */
121 POWER_SUPPLY_PROP_MODEL_NAME,
122 POWER_SUPPLY_PROP_MANUFACTURER,
123 POWER_SUPPLY_PROP_SERIAL_NUMBER,
126 enum power_supply_type {
127 POWER_SUPPLY_TYPE_BATTERY = 0,
128 POWER_SUPPLY_TYPE_UPS,
129 POWER_SUPPLY_TYPE_MAINS,
130 POWER_SUPPLY_TYPE_USB, /* Standard Downstream Port */
131 POWER_SUPPLY_TYPE_USB_DCP, /* Dedicated Charging Port */
132 POWER_SUPPLY_TYPE_USB_CDP, /* Charging Downstream Port */
133 POWER_SUPPLY_TYPE_USB_ACA, /* Accessory Charger Adapters */
136 union power_supply_propval {
141 struct power_supply {
143 enum power_supply_type type;
144 enum power_supply_property *properties;
145 size_t num_properties;
148 size_t num_supplicants;
150 int (*get_property)(struct power_supply *psy,
151 enum power_supply_property psp,
152 union power_supply_propval *val);
153 int (*set_property)(struct power_supply *psy,
154 enum power_supply_property psp,
155 const union power_supply_propval *val);
156 int (*property_is_writeable)(struct power_supply *psy,
157 enum power_supply_property psp);
158 void (*external_power_changed)(struct power_supply *psy);
159 void (*set_charged)(struct power_supply *psy);
161 /* For APM emulation, think legacy userspace. */
166 struct work_struct changed_work;
167 spinlock_t changed_lock;
169 struct wake_lock work_wake_lock;
171 #ifdef CONFIG_LEDS_TRIGGERS
172 struct led_trigger *charging_full_trig;
173 char *charging_full_trig_name;
174 struct led_trigger *charging_trig;
175 char *charging_trig_name;
176 struct led_trigger *full_trig;
177 char *full_trig_name;
178 struct led_trigger *online_trig;
179 char *online_trig_name;
180 struct led_trigger *charging_blink_full_solid_trig;
181 char *charging_blink_full_solid_trig_name;
186 * This is recommended structure to specify static power supply parameters.
187 * Generic one, parametrizable for different power supplies. Power supply
188 * class itself does not use it, but that's what implementing most platform
189 * drivers, should try reuse for consistency.
192 struct power_supply_info {
195 int voltage_max_design;
196 int voltage_min_design;
197 int charge_full_design;
198 int charge_empty_design;
199 int energy_full_design;
200 int energy_empty_design;
204 extern struct power_supply *power_supply_get_by_name(char *name);
205 extern void power_supply_changed(struct power_supply *psy);
206 extern int power_supply_am_i_supplied(struct power_supply *psy);
207 extern int power_supply_set_battery_charged(struct power_supply *psy);
209 #if defined(CONFIG_POWER_SUPPLY) || defined(CONFIG_POWER_SUPPLY_MODULE)
210 extern int power_supply_is_system_supplied(void);
212 static inline int power_supply_is_system_supplied(void) { return -ENOSYS; }
215 extern int power_supply_register(struct device *parent,
216 struct power_supply *psy);
217 extern void power_supply_unregister(struct power_supply *psy);
219 /* For APM emulation, think legacy userspace. */
220 extern struct class *power_supply_class;
222 static inline bool power_supply_is_amp_property(enum power_supply_property psp)
225 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
226 case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN:
227 case POWER_SUPPLY_PROP_CHARGE_FULL:
228 case POWER_SUPPLY_PROP_CHARGE_EMPTY:
229 case POWER_SUPPLY_PROP_CHARGE_NOW:
230 case POWER_SUPPLY_PROP_CHARGE_AVG:
231 case POWER_SUPPLY_PROP_CHARGE_COUNTER:
232 case POWER_SUPPLY_PROP_CURRENT_MAX:
233 case POWER_SUPPLY_PROP_CURRENT_NOW:
234 case POWER_SUPPLY_PROP_CURRENT_AVG:
243 static inline bool power_supply_is_watt_property(enum power_supply_property psp)
246 case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
247 case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN:
248 case POWER_SUPPLY_PROP_ENERGY_FULL:
249 case POWER_SUPPLY_PROP_ENERGY_EMPTY:
250 case POWER_SUPPLY_PROP_ENERGY_NOW:
251 case POWER_SUPPLY_PROP_ENERGY_AVG:
252 case POWER_SUPPLY_PROP_VOLTAGE_MAX:
253 case POWER_SUPPLY_PROP_VOLTAGE_MIN:
254 case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
255 case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
256 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
257 case POWER_SUPPLY_PROP_VOLTAGE_AVG:
258 case POWER_SUPPLY_PROP_POWER_NOW:
267 #endif /* __LINUX_POWER_SUPPLY_H__ */