power_supply: Add cold to the POWER_SUPPLY_HEALTH report values
[linux-2.6.git] / include / linux / power_supply.h
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
33 enum {
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
41 enum {
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         POWER_SUPPLY_HEALTH_COLD,
49 };
50
51 enum {
52         POWER_SUPPLY_TECHNOLOGY_UNKNOWN = 0,
53         POWER_SUPPLY_TECHNOLOGY_NiMH,
54         POWER_SUPPLY_TECHNOLOGY_LION,
55         POWER_SUPPLY_TECHNOLOGY_LIPO,
56         POWER_SUPPLY_TECHNOLOGY_LiFe,
57         POWER_SUPPLY_TECHNOLOGY_NiCd,
58         POWER_SUPPLY_TECHNOLOGY_LiMn,
59 };
60
61 enum power_supply_property {
62         /* Properties of type `int' */
63         POWER_SUPPLY_PROP_STATUS = 0,
64         POWER_SUPPLY_PROP_HEALTH,
65         POWER_SUPPLY_PROP_PRESENT,
66         POWER_SUPPLY_PROP_ONLINE,
67         POWER_SUPPLY_PROP_TECHNOLOGY,
68         POWER_SUPPLY_PROP_VOLTAGE_MAX,
69         POWER_SUPPLY_PROP_VOLTAGE_MIN,
70         POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
71         POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
72         POWER_SUPPLY_PROP_VOLTAGE_NOW,
73         POWER_SUPPLY_PROP_VOLTAGE_AVG,
74         POWER_SUPPLY_PROP_CURRENT_NOW,
75         POWER_SUPPLY_PROP_CURRENT_AVG,
76         POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
77         POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN,
78         POWER_SUPPLY_PROP_CHARGE_FULL,
79         POWER_SUPPLY_PROP_CHARGE_EMPTY,
80         POWER_SUPPLY_PROP_CHARGE_NOW,
81         POWER_SUPPLY_PROP_CHARGE_AVG,
82         POWER_SUPPLY_PROP_CHARGE_COUNTER,
83         POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
84         POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN,
85         POWER_SUPPLY_PROP_ENERGY_FULL,
86         POWER_SUPPLY_PROP_ENERGY_EMPTY,
87         POWER_SUPPLY_PROP_ENERGY_NOW,
88         POWER_SUPPLY_PROP_ENERGY_AVG,
89         POWER_SUPPLY_PROP_CAPACITY, /* in percents! */
90         POWER_SUPPLY_PROP_TEMP,
91         POWER_SUPPLY_PROP_TEMP_AMBIENT,
92         POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
93         POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
94         POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
95         POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
96         /* Properties of type `const char *' */
97         POWER_SUPPLY_PROP_MODEL_NAME,
98         POWER_SUPPLY_PROP_MANUFACTURER,
99         POWER_SUPPLY_PROP_SERIAL_NUMBER,
100 };
101
102 enum power_supply_type {
103         POWER_SUPPLY_TYPE_BATTERY = 0,
104         POWER_SUPPLY_TYPE_UPS,
105         POWER_SUPPLY_TYPE_MAINS,
106         POWER_SUPPLY_TYPE_USB,
107 };
108
109 union power_supply_propval {
110         int intval;
111         const char *strval;
112 };
113
114 struct power_supply {
115         const char *name;
116         enum power_supply_type type;
117         enum power_supply_property *properties;
118         size_t num_properties;
119
120         char **supplied_to;
121         size_t num_supplicants;
122
123         int (*get_property)(struct power_supply *psy,
124                             enum power_supply_property psp,
125                             union power_supply_propval *val);
126         void (*external_power_changed)(struct power_supply *psy);
127
128         /* For APM emulation, think legacy userspace. */
129         int use_for_apm;
130
131         /* private */
132         struct device *dev;
133         struct work_struct changed_work;
134
135 #ifdef CONFIG_LEDS_TRIGGERS
136         struct led_trigger *charging_full_trig;
137         char *charging_full_trig_name;
138         struct led_trigger *charging_trig;
139         char *charging_trig_name;
140         struct led_trigger *full_trig;
141         char *full_trig_name;
142         struct led_trigger *online_trig;
143         char *online_trig_name;
144 #endif
145 };
146
147 /*
148  * This is recommended structure to specify static power supply parameters.
149  * Generic one, parametrizable for different power supplies. Power supply
150  * class itself does not use it, but that's what implementing most platform
151  * drivers, should try reuse for consistency.
152  */
153
154 struct power_supply_info {
155         const char *name;
156         int technology;
157         int voltage_max_design;
158         int voltage_min_design;
159         int charge_full_design;
160         int charge_empty_design;
161         int energy_full_design;
162         int energy_empty_design;
163         int use_for_apm;
164 };
165
166 extern void power_supply_changed(struct power_supply *psy);
167 extern int power_supply_am_i_supplied(struct power_supply *psy);
168
169 #if defined(CONFIG_POWER_SUPPLY) || defined(CONFIG_POWER_SUPPLY_MODULE)
170 extern int power_supply_is_system_supplied(void);
171 #else
172 static inline int power_supply_is_system_supplied(void) { return -ENOSYS; }
173 #endif
174
175 extern int power_supply_register(struct device *parent,
176                                  struct power_supply *psy);
177 extern void power_supply_unregister(struct power_supply *psy);
178
179 /* For APM emulation, think legacy userspace. */
180 extern struct class *power_supply_class;
181
182 #endif /* __LINUX_POWER_SUPPLY_H__ */