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