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/wakelock.h>
  17 #include <linux/workqueue.h>
  18 #include <linux/leds.h>
  19 #include <linux/types.h>
  20
  21 struct device;
  22
  23 /*
  24  * All voltages, currents, charges, energies, time and temperatures in uV,
  25  * µA, µAh, µWh, seconds and tenths of degree Celsius unless otherwise
  26  * stated. It's driver's job to convert its raw values to units in which
  27  * this class operates.
  28  */
  29
  30 /*
  31  * For systems where the charger determines the maximum battery capacity
  32  * the min and max fields should be used to present these values to user
  33  * space. Unused/unknown fields will not appear in sysfs.
  34  */
  35
  36 enum {
  37         POWER_SUPPLY_STATUS_UNKNOWN = 0,
  38         POWER_SUPPLY_STATUS_CHARGING,
  39         POWER_SUPPLY_STATUS_DISCHARGING,
  40         POWER_SUPPLY_STATUS_NOT_CHARGING,
  41         POWER_SUPPLY_STATUS_FULL,
  42 };
  43
  44 enum {
  45         POWER_SUPPLY_CHARGE_TYPE_UNKNOWN = 0,
  46         POWER_SUPPLY_CHARGE_TYPE_NONE,
  47         POWER_SUPPLY_CHARGE_TYPE_TRICKLE,
  48         POWER_SUPPLY_CHARGE_TYPE_FAST,
  49         POWER_SUPPLY_CHARGE_TYPE_SLOW,
  50 };
  51
  52 enum {
  53         POWER_SUPPLY_HEALTH_UNKNOWN = 0,
  54         POWER_SUPPLY_HEALTH_GOOD,
  55         POWER_SUPPLY_HEALTH_OVERHEAT,
  56         POWER_SUPPLY_HEALTH_WARM,
  57         POWER_SUPPLY_HEALTH_DEAD,
  58         POWER_SUPPLY_HEALTH_OVERVOLTAGE,
  59         POWER_SUPPLY_HEALTH_UNSPEC_FAILURE,
  60         POWER_SUPPLY_HEALTH_COLD,
  61         POWER_SUPPLY_HEALTH_COOL,
  62         POWER_SUPPLY_HEALTH_WATCHDOG_TIMER_EXPIRE,
  63         POWER_SUPPLY_HEALTH_SAFETY_TIMER_EXPIRE,
  64         POWER_SUPPLY_HEALTH_UNDERVOLTAGE,
  65         POWER_SUPPLY_HEALTH_OVERHEATLIMIT,
  66 };
  67
  68 enum {
  69         POWER_SUPPLY_TECHNOLOGY_UNKNOWN = 0,
  70         POWER_SUPPLY_TECHNOLOGY_NiMH,
  71         POWER_SUPPLY_TECHNOLOGY_LION,
  72         POWER_SUPPLY_TECHNOLOGY_LIPO,
  73         POWER_SUPPLY_TECHNOLOGY_LiFe,
  74         POWER_SUPPLY_TECHNOLOGY_NiCd,
  75         POWER_SUPPLY_TECHNOLOGY_LiMn,
  76 };
  77
  78 enum {
  79         POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN = 0,
  80         POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL,
  81         POWER_SUPPLY_CAPACITY_LEVEL_LOW,
  82         POWER_SUPPLY_CAPACITY_LEVEL_NORMAL,
  83         POWER_SUPPLY_CAPACITY_LEVEL_HIGH,
  84         POWER_SUPPLY_CAPACITY_LEVEL_FULL,
  85 };
  86
  87 enum {
  88         POWER_SUPPLY_SCOPE_UNKNOWN = 0,
  89         POWER_SUPPLY_SCOPE_SYSTEM,
  90         POWER_SUPPLY_SCOPE_DEVICE,
  91 };
  92
  93 enum power_supply_property {
  94         /* Properties of type `int' */
  95         POWER_SUPPLY_PROP_STATUS = 0,
  96         POWER_SUPPLY_PROP_CHARGE_TYPE,
  97         POWER_SUPPLY_PROP_HEALTH,
  98         POWER_SUPPLY_PROP_PRESENT,
  99         POWER_SUPPLY_PROP_ONLINE,
 100         POWER_SUPPLY_PROP_AUTHENTIC,
 101         POWER_SUPPLY_PROP_TECHNOLOGY,
 102         POWER_SUPPLY_PROP_CYCLE_COUNT,
 103         POWER_SUPPLY_PROP_VOLTAGE_MAX,
 104         POWER_SUPPLY_PROP_VOLTAGE_MIN,
 105         POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
 106         POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
 107         POWER_SUPPLY_PROP_VOLTAGE_NOW,
 108         POWER_SUPPLY_PROP_VOLTAGE_AVG,
 109         POWER_SUPPLY_PROP_VOLTAGE_OCV,
 110         POWER_SUPPLY_PROP_CURRENT_MAX,
 111         POWER_SUPPLY_PROP_CURRENT_NOW,
 112         POWER_SUPPLY_PROP_CURRENT_AVG,
 113         POWER_SUPPLY_PROP_POWER_NOW,
 114         POWER_SUPPLY_PROP_POWER_AVG,
 115         POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
 116         POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN,
 117         POWER_SUPPLY_PROP_CHARGE_FULL,
 118         POWER_SUPPLY_PROP_CHARGE_EMPTY,
 119         POWER_SUPPLY_PROP_CHARGE_NOW,
 120         POWER_SUPPLY_PROP_CHARGE_AVG,
 121         POWER_SUPPLY_PROP_CHARGE_COUNTER,
 122         POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT,
 123         POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX,
 124         POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE,
 125         POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX,
 126         POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT,
 127         POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX,
 128         POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
 129         POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN,
 130         POWER_SUPPLY_PROP_ENERGY_FULL,
 131         POWER_SUPPLY_PROP_ENERGY_EMPTY,
 132         POWER_SUPPLY_PROP_ENERGY_NOW,
 133         POWER_SUPPLY_PROP_ENERGY_AVG,
 134         POWER_SUPPLY_PROP_CAPACITY, /* in percents! */
 135         POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN, /* in percents! */
 136         POWER_SUPPLY_PROP_CAPACITY_ALERT_MAX, /* in percents! */
 137         POWER_SUPPLY_PROP_CAPACITY_LEVEL,
 138         POWER_SUPPLY_PROP_TEMP,
 139         POWER_SUPPLY_PROP_TEMP_ALERT_MIN,
 140         POWER_SUPPLY_PROP_TEMP_ALERT_MAX,
 141         POWER_SUPPLY_PROP_TEMP_AMBIENT,
 142         POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MIN,
 143         POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MAX,
 144         POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
 145         POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
 146         POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
 147         POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
 148         POWER_SUPPLY_PROP_TYPE, /* use power_supply.type instead */
 149         POWER_SUPPLY_PROP_SCOPE,
 150         /* Local extensions */
 151         POWER_SUPPLY_PROP_USB_HC,
 152         POWER_SUPPLY_PROP_USB_OTG,
 153         POWER_SUPPLY_PROP_CHARGE_ENABLED,
 154         /* Local extensions of type int64_t */
 155         POWER_SUPPLY_PROP_CHARGE_COUNTER_EXT,
 156         /* Properties of type `const char *' */
 157         POWER_SUPPLY_PROP_MODEL_NAME,
 158         POWER_SUPPLY_PROP_MANUFACTURER,
 159         POWER_SUPPLY_PROP_SERIAL_NUMBER,
 160         POWER_SUPPLY_PROP_CHARGE_OTG_CONTROL,
 161         POWER_SUPPLY_PROP_POWER_STATUS
 162 };
 163
 164 enum power_supply_type {
 165         POWER_SUPPLY_TYPE_UNKNOWN = 0,
 166         POWER_SUPPLY_TYPE_BATTERY,
 167         POWER_SUPPLY_TYPE_UPS,
 168         POWER_SUPPLY_TYPE_MAINS,
 169         POWER_SUPPLY_TYPE_USB,          /* Standard Downstream Port */
 170         POWER_SUPPLY_TYPE_USB_DCP,      /* Dedicated Charging Port */
 171         POWER_SUPPLY_TYPE_USB_CDP,      /* Charging Downstream Port */
 172         POWER_SUPPLY_TYPE_USB_ACA,      /* Accessory Charger Adapters */
 173         POWER_SUPPLY_TYPE_BMS,                          /* Battery Monitor System (8) */
 174         POWER_SUPPLY_TYPE_MISC,                         /* 9 */
 175         POWER_SUPPLY_TYPE_WIRELESS,                     /* 10 */
 176         POWER_SUPPLY_TYPE_CARDOCK,                      /* 11 */
 177         POWER_SUPPLY_TYPE_UARTOFF,                      /* 12 */
 178         POWER_SUPPLY_TYPE_OTG,                          /* 13 */
 179         POWER_SUPPLY_TYPE_LAN_HUB,                      /* 14 */
 180         POWER_SUPPLY_TYPE_MHL_500,                      /* 15 */
 181         POWER_SUPPLY_TYPE_MHL_900,                      /* 16 */
 182         POWER_SUPPLY_TYPE_MHL_1500,                     /* 17 */
 183         POWER_SUPPLY_TYPE_MHL_USB,                      /* 18 */
 184         POWER_SUPPLY_TYPE_SMART_OTG,            /* 19 */
 185         POWER_SUPPLY_TYPE_SMART_NOTG,           /* 20 */
 186         POWER_SUPPLY_TYPE_POWER_SHARING,                /* power sharing cable(21) */
 187         POWER_SUPPLY_TYPE_HV_MAINS,             /* 22 */
 188         POWER_SUPPLY_TYPE_WPC,
 189         POWER_SUPPLY_TYPE_HV_PREPARE_MAINS,
 190         POWER_SUPPLY_TYPE_MHL_USB_100,
 191         POWER_SUPPLY_TYPE_MHL_2000,
 192         POWER_SUPPLY_TYPE_WIRELESS_REMOVE, /* Always last value (23)*/
 193 };
 194
 195 union power_supply_propval {
 196         int intval;
 197         const char *strval;
 198         int64_t int64val;
 199 };
 200
 201 struct power_supply {
 202         const char *name;
 203         enum power_supply_type type;
 204         enum power_supply_property *properties;
 205         size_t num_properties;
 206
 207         char **supplied_to;
 208         size_t num_supplicants;
 209
 210         char **supplied_from;
 211         size_t num_supplies;
 212 #ifdef CONFIG_OF
 213         struct device_node *of_node;
 214 #endif
 215
 216         int (*get_property)(struct power_supply *psy,
 217                             enum power_supply_property psp,
 218                             union power_supply_propval *val);
 219         int (*set_property)(struct power_supply *psy,
 220                             enum power_supply_property psp,
 221                             const union power_supply_propval *val);
 222         int (*property_is_writeable)(struct power_supply *psy,
 223                                      enum power_supply_property psp);
 224         void (*external_power_changed)(struct power_supply *psy);
 225         void (*set_charged)(struct power_supply *psy);
 226
 227         /* For APM emulation, think legacy userspace. */
 228         int use_for_apm;
 229
 230         /* private */
 231         struct device *dev;
 232         struct work_struct changed_work;
 233         spinlock_t changed_lock;
 234         bool changed;
 235 #ifdef CONFIG_THERMAL
 236         struct thermal_zone_device *tzd;
 237         struct thermal_cooling_device *tcd;
 238 #endif
 239
 240 #ifdef CONFIG_LEDS_TRIGGERS
 241         struct led_trigger *charging_full_trig;
 242         char *charging_full_trig_name;
 243         struct led_trigger *charging_trig;
 244         char *charging_trig_name;
 245         struct led_trigger *full_trig;
 246         char *full_trig_name;
 247         struct led_trigger *online_trig;
 248         char *online_trig_name;
 249         struct led_trigger *charging_blink_full_solid_trig;
 250         char *charging_blink_full_solid_trig_name;
 251 #endif
 252 };
 253
 254 /*
 255  * This is recommended structure to specify static power supply parameters.
 256  * Generic one, parametrizable for different power supplies. Power supply
 257  * class itself does not use it, but that's what implementing most platform
 258  * drivers, should try reuse for consistency.
 259  */
 260
 261 struct power_supply_info {
 262         const char *name;
 263         int technology;
 264         int voltage_max_design;
 265         int voltage_min_design;
 266         int charge_full_design;
 267         int charge_empty_design;
 268         int energy_full_design;
 269         int energy_empty_design;
 270         int use_for_apm;
 271 };
 272
 273 extern struct power_supply *power_supply_get_by_name(const char *name);
 274 extern void power_supply_changed(struct power_supply *psy);
 275 extern int power_supply_am_i_supplied(struct power_supply *psy);
 276 extern int power_supply_set_battery_charged(struct power_supply *psy);
 277
 278 #ifdef CONFIG_POWER_SUPPLY
 279 extern int power_supply_is_system_supplied(void);
 280 #else
 281 static inline int power_supply_is_system_supplied(void) { return -ENOSYS; }
 282 #endif
 283
 284 extern int power_supply_register(struct device *parent,
 285                                  struct power_supply *psy);
 286 extern void power_supply_unregister(struct power_supply *psy);
 287 extern int power_supply_powers(struct power_supply *psy, struct device *dev);
 288
 289 /* For APM emulation, think legacy userspace. */
 290 extern struct class *power_supply_class;
 291
 292 static inline bool power_supply_is_amp_property(enum power_supply_property psp)
 293 {
 294         switch (psp) {
 295         case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
 296         case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN:
 297         case POWER_SUPPLY_PROP_CHARGE_FULL:
 298         case POWER_SUPPLY_PROP_CHARGE_EMPTY:
 299         case POWER_SUPPLY_PROP_CHARGE_NOW:
 300         case POWER_SUPPLY_PROP_CHARGE_AVG:
 301         case POWER_SUPPLY_PROP_CHARGE_COUNTER:
 302         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT:
 303         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX:
 304         case POWER_SUPPLY_PROP_CURRENT_MAX:
 305         case POWER_SUPPLY_PROP_CURRENT_NOW:
 306         case POWER_SUPPLY_PROP_CURRENT_AVG:
 307                 return 1;
 308         default:
 309                 break;
 310         }
 311
 312         return 0;
 313 }
 314
 315 static inline bool power_supply_is_watt_property(enum power_supply_property psp)
 316 {
 317         switch (psp) {
 318         case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
 319         case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN:
 320         case POWER_SUPPLY_PROP_ENERGY_FULL:
 321         case POWER_SUPPLY_PROP_ENERGY_EMPTY:
 322         case POWER_SUPPLY_PROP_ENERGY_NOW:
 323         case POWER_SUPPLY_PROP_ENERGY_AVG:
 324         case POWER_SUPPLY_PROP_VOLTAGE_MAX:
 325         case POWER_SUPPLY_PROP_VOLTAGE_MIN:
 326         case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
 327         case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
 328         case POWER_SUPPLY_PROP_VOLTAGE_NOW:
 329         case POWER_SUPPLY_PROP_VOLTAGE_AVG:
 330         case POWER_SUPPLY_PROP_VOLTAGE_OCV:
 331         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE:
 332         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX:
 333         case POWER_SUPPLY_PROP_POWER_NOW:
 334                 return 1;
 335         default:
 336                 break;
 337         }
 338
 339         return 0;
 340 }
 341
 342 #endif /* __LINUX_POWER_SUPPLY_H__ */