| 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/workqueue.h> |
| 17 | #include <linux/leds.h> |
| 18 | |
| 19 | struct device; |
| 20 | |
| 21 | /* |
| 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. |
| 26 | */ |
| 27 | |
| 28 | /* |
| 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. |
| 32 | */ |
| 33 | |
| 34 | enum { |
| 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, |
| 40 | }; |
| 41 | |
| 42 | enum { |
| 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, |
| 47 | }; |
| 48 | |
| 49 | enum { |
| 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, |
| 57 | }; |
| 58 | |
| 59 | enum { |
| 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, |
| 67 | }; |
| 68 | |
| 69 | enum { |
| 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, |
| 76 | }; |
| 77 | |
| 78 | enum { |
| 79 | POWER_SUPPLY_SCOPE_UNKNOWN = 0, |
| 80 | POWER_SUPPLY_SCOPE_SYSTEM, |
| 81 | POWER_SUPPLY_SCOPE_DEVICE, |
| 82 | }; |
| 83 | |
| 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_TECHNOLOGY, |
| 92 | POWER_SUPPLY_PROP_CYCLE_COUNT, |
| 93 | POWER_SUPPLY_PROP_VOLTAGE_MAX, |
| 94 | POWER_SUPPLY_PROP_VOLTAGE_MIN, |
| 95 | POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN, |
| 96 | POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN, |
| 97 | POWER_SUPPLY_PROP_VOLTAGE_NOW, |
| 98 | POWER_SUPPLY_PROP_VOLTAGE_AVG, |
| 99 | POWER_SUPPLY_PROP_VOLTAGE_OCV, |
| 100 | POWER_SUPPLY_PROP_CURRENT_MAX, |
| 101 | POWER_SUPPLY_PROP_CURRENT_NOW, |
| 102 | POWER_SUPPLY_PROP_CURRENT_AVG, |
| 103 | POWER_SUPPLY_PROP_POWER_NOW, |
| 104 | POWER_SUPPLY_PROP_POWER_AVG, |
| 105 | POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN, |
| 106 | POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN, |
| 107 | POWER_SUPPLY_PROP_CHARGE_FULL, |
| 108 | POWER_SUPPLY_PROP_CHARGE_EMPTY, |
| 109 | POWER_SUPPLY_PROP_CHARGE_NOW, |
| 110 | POWER_SUPPLY_PROP_CHARGE_AVG, |
| 111 | POWER_SUPPLY_PROP_CHARGE_COUNTER, |
| 112 | POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN, |
| 113 | POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN, |
| 114 | POWER_SUPPLY_PROP_ENERGY_FULL, |
| 115 | POWER_SUPPLY_PROP_ENERGY_EMPTY, |
| 116 | POWER_SUPPLY_PROP_ENERGY_NOW, |
| 117 | POWER_SUPPLY_PROP_ENERGY_AVG, |
| 118 | POWER_SUPPLY_PROP_CAPACITY, /* in percents! */ |
| 119 | POWER_SUPPLY_PROP_CAPACITY_LEVEL, |
| 120 | POWER_SUPPLY_PROP_TEMP, |
| 121 | POWER_SUPPLY_PROP_TEMP_AMBIENT, |
| 122 | POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW, |
| 123 | POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG, |
| 124 | POWER_SUPPLY_PROP_TIME_TO_FULL_NOW, |
| 125 | POWER_SUPPLY_PROP_TIME_TO_FULL_AVG, |
| 126 | POWER_SUPPLY_PROP_TYPE, /* use power_supply.type instead */ |
| 127 | POWER_SUPPLY_PROP_SCOPE, |
| 128 | /* Properties of type `const char *' */ |
| 129 | POWER_SUPPLY_PROP_MODEL_NAME, |
| 130 | POWER_SUPPLY_PROP_MANUFACTURER, |
| 131 | POWER_SUPPLY_PROP_SERIAL_NUMBER, |
| 132 | }; |
| 133 | |
| 134 | enum power_supply_type { |
| 135 | POWER_SUPPLY_TYPE_UNKNOWN = 0, |
| 136 | POWER_SUPPLY_TYPE_BATTERY, |
| 137 | POWER_SUPPLY_TYPE_UPS, |
| 138 | POWER_SUPPLY_TYPE_MAINS, |
| 139 | POWER_SUPPLY_TYPE_USB, /* Standard Downstream Port */ |
| 140 | POWER_SUPPLY_TYPE_USB_DCP, /* Dedicated Charging Port */ |
| 141 | POWER_SUPPLY_TYPE_USB_CDP, /* Charging Downstream Port */ |
| 142 | POWER_SUPPLY_TYPE_USB_ACA, /* Accessory Charger Adapters */ |
| 143 | }; |
| 144 | |
| 145 | union power_supply_propval { |
| 146 | int intval; |
| 147 | const char *strval; |
| 148 | }; |
| 149 | |
| 150 | struct power_supply { |
| 151 | const char *name; |
| 152 | enum power_supply_type type; |
| 153 | enum power_supply_property *properties; |
| 154 | size_t num_properties; |
| 155 | |
| 156 | char **supplied_to; |
| 157 | size_t num_supplicants; |
| 158 | |
| 159 | int (*get_property)(struct power_supply *psy, |
| 160 | enum power_supply_property psp, |
| 161 | union power_supply_propval *val); |
| 162 | int (*set_property)(struct power_supply *psy, |
| 163 | enum power_supply_property psp, |
| 164 | const union power_supply_propval *val); |
| 165 | int (*property_is_writeable)(struct power_supply *psy, |
| 166 | enum power_supply_property psp); |
| 167 | void (*external_power_changed)(struct power_supply *psy); |
| 168 | void (*set_charged)(struct power_supply *psy); |
| 169 | |
| 170 | /* For APM emulation, think legacy userspace. */ |
| 171 | int use_for_apm; |
| 172 | |
| 173 | /* private */ |
| 174 | struct device *dev; |
| 175 | struct work_struct changed_work; |
| 176 | |
| 177 | #ifdef CONFIG_LEDS_TRIGGERS |
| 178 | struct led_trigger *charging_full_trig; |
| 179 | char *charging_full_trig_name; |
| 180 | struct led_trigger *charging_trig; |
| 181 | char *charging_trig_name; |
| 182 | struct led_trigger *full_trig; |
| 183 | char *full_trig_name; |
| 184 | struct led_trigger *online_trig; |
| 185 | char *online_trig_name; |
| 186 | struct led_trigger *charging_blink_full_solid_trig; |
| 187 | char *charging_blink_full_solid_trig_name; |
| 188 | #endif |
| 189 | }; |
| 190 | |
| 191 | /* |
| 192 | * This is recommended structure to specify static power supply parameters. |
| 193 | * Generic one, parametrizable for different power supplies. Power supply |
| 194 | * class itself does not use it, but that's what implementing most platform |
| 195 | * drivers, should try reuse for consistency. |
| 196 | */ |
| 197 | |
| 198 | struct power_supply_info { |
| 199 | const char *name; |
| 200 | int technology; |
| 201 | int voltage_max_design; |
| 202 | int voltage_min_design; |
| 203 | int charge_full_design; |
| 204 | int charge_empty_design; |
| 205 | int energy_full_design; |
| 206 | int energy_empty_design; |
| 207 | int use_for_apm; |
| 208 | }; |
| 209 | |
| 210 | extern struct power_supply *power_supply_get_by_name(char *name); |
| 211 | extern void power_supply_changed(struct power_supply *psy); |
| 212 | extern int power_supply_am_i_supplied(struct power_supply *psy); |
| 213 | extern int power_supply_set_battery_charged(struct power_supply *psy); |
| 214 | |
| 215 | #ifdef CONFIG_POWER_SUPPLY |
| 216 | extern int power_supply_is_system_supplied(void); |
| 217 | #else |
| 218 | static inline int power_supply_is_system_supplied(void) { return -ENOSYS; } |
| 219 | #endif |
| 220 | |
| 221 | extern int power_supply_register(struct device *parent, |
| 222 | struct power_supply *psy); |
| 223 | extern void power_supply_unregister(struct power_supply *psy); |
| 224 | extern int power_supply_powers(struct power_supply *psy, struct device *dev); |
| 225 | |
| 226 | /* For APM emulation, think legacy userspace. */ |
| 227 | extern struct class *power_supply_class; |
| 228 | |
| 229 | static inline bool power_supply_is_amp_property(enum power_supply_property psp) |
| 230 | { |
| 231 | switch (psp) { |
| 232 | case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN: |
| 233 | case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN: |
| 234 | case POWER_SUPPLY_PROP_CHARGE_FULL: |
| 235 | case POWER_SUPPLY_PROP_CHARGE_EMPTY: |
| 236 | case POWER_SUPPLY_PROP_CHARGE_NOW: |
| 237 | case POWER_SUPPLY_PROP_CHARGE_AVG: |
| 238 | case POWER_SUPPLY_PROP_CHARGE_COUNTER: |
| 239 | case POWER_SUPPLY_PROP_CURRENT_MAX: |
| 240 | case POWER_SUPPLY_PROP_CURRENT_NOW: |
| 241 | case POWER_SUPPLY_PROP_CURRENT_AVG: |
| 242 | return 1; |
| 243 | default: |
| 244 | break; |
| 245 | } |
| 246 | |
| 247 | return 0; |
| 248 | } |
| 249 | |
| 250 | static inline bool power_supply_is_watt_property(enum power_supply_property psp) |
| 251 | { |
| 252 | switch (psp) { |
| 253 | case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN: |
| 254 | case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN: |
| 255 | case POWER_SUPPLY_PROP_ENERGY_FULL: |
| 256 | case POWER_SUPPLY_PROP_ENERGY_EMPTY: |
| 257 | case POWER_SUPPLY_PROP_ENERGY_NOW: |
| 258 | case POWER_SUPPLY_PROP_ENERGY_AVG: |
| 259 | case POWER_SUPPLY_PROP_VOLTAGE_MAX: |
| 260 | case POWER_SUPPLY_PROP_VOLTAGE_MIN: |
| 261 | case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN: |
| 262 | case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN: |
| 263 | case POWER_SUPPLY_PROP_VOLTAGE_NOW: |
| 264 | case POWER_SUPPLY_PROP_VOLTAGE_AVG: |
| 265 | case POWER_SUPPLY_PROP_VOLTAGE_OCV: |
| 266 | case POWER_SUPPLY_PROP_POWER_NOW: |
| 267 | return 1; |
| 268 | default: |
| 269 | break; |
| 270 | } |
| 271 | |
| 272 | return 0; |
| 273 | } |
| 274 | |
| 275 | #endif /* __LINUX_POWER_SUPPLY_H__ */ |