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/spinlock.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         /* Properties of type `const char *' */
 145         POWER_SUPPLY_PROP_MODEL_NAME,
 146         POWER_SUPPLY_PROP_MANUFACTURER,
 147         POWER_SUPPLY_PROP_SERIAL_NUMBER,
 148 };
 149
 150 enum power_supply_type {
 151         POWER_SUPPLY_TYPE_UNKNOWN = 0,
 152         POWER_SUPPLY_TYPE_BATTERY,
 153         POWER_SUPPLY_TYPE_UPS,
 154         POWER_SUPPLY_TYPE_MAINS,
 155         POWER_SUPPLY_TYPE_USB,          /* Standard Downstream Port */
 156         POWER_SUPPLY_TYPE_USB_DCP,      /* Dedicated Charging Port */
 157         POWER_SUPPLY_TYPE_USB_CDP,      /* Charging Downstream Port */
 158         POWER_SUPPLY_TYPE_USB_ACA,      /* Accessory Charger Adapters */
 159 };
 160
 161 union power_supply_propval {
 162         int intval;
 163         const char *strval;
 164 };
 165
 166 struct device_node;
 167
 168 struct power_supply {
 169         const char *name;
 170         enum power_supply_type type;
 171         enum power_supply_property *properties;
 172         size_t num_properties;
 173
 174         char **supplied_to;
 175         size_t num_supplicants;
 176
 177         char **supplied_from;
 178         size_t num_supplies;
 179         struct device_node *of_node;
 180
 181         int (*get_property)(struct power_supply *psy,
 182                             enum power_supply_property psp,
 183                             union power_supply_propval *val);
 184         int (*set_property)(struct power_supply *psy,
 185                             enum power_supply_property psp,
 186                             const union power_supply_propval *val);
 187         int (*property_is_writeable)(struct power_supply *psy,
 188                                      enum power_supply_property psp);
 189         void (*external_power_changed)(struct power_supply *psy);
 190         void (*set_charged)(struct power_supply *psy);
 191
 192         /* For APM emulation, think legacy userspace. */
 193         int use_for_apm;
 194
 195         /* private */
 196         struct device *dev;
 197         struct work_struct changed_work;
 198         spinlock_t changed_lock;
 199         bool changed;
 200 #ifdef CONFIG_THERMAL
 201         struct thermal_zone_device *tzd;
 202         struct thermal_cooling_device *tcd;
 203 #endif
 204
 205 #ifdef CONFIG_LEDS_TRIGGERS
 206         struct led_trigger *charging_full_trig;
 207         char *charging_full_trig_name;
 208         struct led_trigger *charging_trig;
 209         char *charging_trig_name;
 210         struct led_trigger *full_trig;
 211         char *full_trig_name;
 212         struct led_trigger *online_trig;
 213         char *online_trig_name;
 214         struct led_trigger *charging_blink_full_solid_trig;
 215         char *charging_blink_full_solid_trig_name;
 216 #endif
 217 };
 218
 219 /*
 220  * This is recommended structure to specify static power supply parameters.
 221  * Generic one, parametrizable for different power supplies. Power supply
 222  * class itself does not use it, but that's what implementing most platform
 223  * drivers, should try reuse for consistency.
 224  */
 225
 226 struct power_supply_info {
 227         const char *name;
 228         int technology;
 229         int voltage_max_design;
 230         int voltage_min_design;
 231         int charge_full_design;
 232         int charge_empty_design;
 233         int energy_full_design;
 234         int energy_empty_design;
 235         int use_for_apm;
 236 };
 237
 238 extern struct power_supply *power_supply_get_by_name(const char *name);
 239 extern void power_supply_changed(struct power_supply *psy);
 240 extern int power_supply_am_i_supplied(struct power_supply *psy);
 241 extern int power_supply_set_battery_charged(struct power_supply *psy);
 242
 243 #ifdef CONFIG_POWER_SUPPLY
 244 extern int power_supply_is_system_supplied(void);
 245 #else
 246 static inline int power_supply_is_system_supplied(void) { return -ENOSYS; }
 247 #endif
 248
 249 extern int power_supply_register(struct device *parent,
 250                                  struct power_supply *psy);
 251 extern void power_supply_unregister(struct power_supply *psy);
 252 extern int power_supply_powers(struct power_supply *psy, struct device *dev);
 253
 254 /* For APM emulation, think legacy userspace. */
 255 extern struct class *power_supply_class;
 256
 257 static inline bool power_supply_is_amp_property(enum power_supply_property psp)
 258 {
 259         switch (psp) {
 260         case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
 261         case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN:
 262         case POWER_SUPPLY_PROP_CHARGE_FULL:
 263         case POWER_SUPPLY_PROP_CHARGE_EMPTY:
 264         case POWER_SUPPLY_PROP_CHARGE_NOW:
 265         case POWER_SUPPLY_PROP_CHARGE_AVG:
 266         case POWER_SUPPLY_PROP_CHARGE_COUNTER:
 267         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT:
 268         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX:
 269         case POWER_SUPPLY_PROP_CURRENT_MAX:
 270         case POWER_SUPPLY_PROP_CURRENT_NOW:
 271         case POWER_SUPPLY_PROP_CURRENT_AVG:
 272                 return 1;
 273         default:
 274                 break;
 275         }
 276
 277         return 0;
 278 }
 279
 280 static inline bool power_supply_is_watt_property(enum power_supply_property psp)
 281 {
 282         switch (psp) {
 283         case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
 284         case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN:
 285         case POWER_SUPPLY_PROP_ENERGY_FULL:
 286         case POWER_SUPPLY_PROP_ENERGY_EMPTY:
 287         case POWER_SUPPLY_PROP_ENERGY_NOW:
 288         case POWER_SUPPLY_PROP_ENERGY_AVG:
 289         case POWER_SUPPLY_PROP_VOLTAGE_MAX:
 290         case POWER_SUPPLY_PROP_VOLTAGE_MIN:
 291         case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
 292         case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
 293         case POWER_SUPPLY_PROP_VOLTAGE_NOW:
 294         case POWER_SUPPLY_PROP_VOLTAGE_AVG:
 295         case POWER_SUPPLY_PROP_VOLTAGE_OCV:
 296         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE:
 297         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX:
 298         case POWER_SUPPLY_PROP_POWER_NOW:
 299                 return 1;
 300         default:
 301                 break;
 302         }
 303
 304         return 0;
 305 }
 306
 307 #endif /* __LINUX_POWER_SUPPLY_H__ */