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