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 #include <linux/notifier.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 };
  50
  51 enum {
  52         POWER_SUPPLY_HEALTH_UNKNOWN = 0,
  53         POWER_SUPPLY_HEALTH_GOOD,
  54         POWER_SUPPLY_HEALTH_OVERHEAT,
  55         POWER_SUPPLY_HEALTH_DEAD,
  56         POWER_SUPPLY_HEALTH_OVERVOLTAGE,
  57         POWER_SUPPLY_HEALTH_UNSPEC_FAILURE,
  58         POWER_SUPPLY_HEALTH_COLD,
  59         POWER_SUPPLY_HEALTH_WATCHDOG_TIMER_EXPIRE,
  60         POWER_SUPPLY_HEALTH_SAFETY_TIMER_EXPIRE,
  61 };
  62
  63 enum {
  64         POWER_SUPPLY_TECHNOLOGY_UNKNOWN = 0,
  65         POWER_SUPPLY_TECHNOLOGY_NiMH,
  66         POWER_SUPPLY_TECHNOLOGY_LION,
  67         POWER_SUPPLY_TECHNOLOGY_LIPO,
  68         POWER_SUPPLY_TECHNOLOGY_LiFe,
  69         POWER_SUPPLY_TECHNOLOGY_NiCd,
  70         POWER_SUPPLY_TECHNOLOGY_LiMn,
  71 };
  72
  73 enum {
  74         POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN = 0,
  75         POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL,
  76         POWER_SUPPLY_CAPACITY_LEVEL_LOW,
  77         POWER_SUPPLY_CAPACITY_LEVEL_NORMAL,
  78         POWER_SUPPLY_CAPACITY_LEVEL_HIGH,
  79         POWER_SUPPLY_CAPACITY_LEVEL_FULL,
  80 };
  81
  82 enum {
  83         POWER_SUPPLY_SCOPE_UNKNOWN = 0,
  84         POWER_SUPPLY_SCOPE_SYSTEM,
  85         POWER_SUPPLY_SCOPE_DEVICE,
  86 };
  87
  88 enum power_supply_property {
  89         /* Properties of type `int' */
  90         POWER_SUPPLY_PROP_STATUS = 0,
  91         POWER_SUPPLY_PROP_CHARGE_TYPE,
  92         POWER_SUPPLY_PROP_HEALTH,
  93         POWER_SUPPLY_PROP_PRESENT,
  94         POWER_SUPPLY_PROP_ONLINE,
  95         POWER_SUPPLY_PROP_AUTHENTIC,
  96         POWER_SUPPLY_PROP_TECHNOLOGY,
  97         POWER_SUPPLY_PROP_CYCLE_COUNT,
  98         POWER_SUPPLY_PROP_VOLTAGE_MAX,
  99         POWER_SUPPLY_PROP_VOLTAGE_MIN,
 100         POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
 101         POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
 102         POWER_SUPPLY_PROP_VOLTAGE_NOW,
 103         POWER_SUPPLY_PROP_VOLTAGE_AVG,
 104         POWER_SUPPLY_PROP_VOLTAGE_OCV,
 105         POWER_SUPPLY_PROP_VOLTAGE_BOOT,
 106         POWER_SUPPLY_PROP_CURRENT_MAX,
 107         POWER_SUPPLY_PROP_CURRENT_NOW,
 108         POWER_SUPPLY_PROP_CURRENT_AVG,
 109         POWER_SUPPLY_PROP_CURRENT_BOOT,
 110         POWER_SUPPLY_PROP_POWER_NOW,
 111         POWER_SUPPLY_PROP_POWER_AVG,
 112         POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
 113         POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN,
 114         POWER_SUPPLY_PROP_CHARGE_FULL,
 115         POWER_SUPPLY_PROP_CHARGE_EMPTY,
 116         POWER_SUPPLY_PROP_CHARGE_NOW,
 117         POWER_SUPPLY_PROP_CHARGE_AVG,
 118         POWER_SUPPLY_PROP_CHARGE_COUNTER,
 119         POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT,
 120         POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX,
 121         POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE,
 122         POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX,
 123         POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT,
 124         POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX,
 125         POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT,
 126         POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
 127         POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN,
 128         POWER_SUPPLY_PROP_ENERGY_FULL,
 129         POWER_SUPPLY_PROP_ENERGY_EMPTY,
 130         POWER_SUPPLY_PROP_ENERGY_NOW,
 131         POWER_SUPPLY_PROP_ENERGY_AVG,
 132         POWER_SUPPLY_PROP_CAPACITY, /* in percents! */
 133         POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN, /* in percents! */
 134         POWER_SUPPLY_PROP_CAPACITY_ALERT_MAX, /* in percents! */
 135         POWER_SUPPLY_PROP_CAPACITY_LEVEL,
 136         POWER_SUPPLY_PROP_TEMP,
 137         POWER_SUPPLY_PROP_TEMP_MAX,
 138         POWER_SUPPLY_PROP_TEMP_MIN,
 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         POWER_SUPPLY_PROP_CHARGE_TERM_CURRENT,
 151         POWER_SUPPLY_PROP_CALIBRATE,
 152         /* Properties of type `const char *' */
 153         POWER_SUPPLY_PROP_MODEL_NAME,
 154         POWER_SUPPLY_PROP_MANUFACTURER,
 155         POWER_SUPPLY_PROP_SERIAL_NUMBER,
 156 };
 157
 158 enum power_supply_type {
 159         POWER_SUPPLY_TYPE_UNKNOWN = 0,
 160         POWER_SUPPLY_TYPE_BATTERY,
 161         POWER_SUPPLY_TYPE_UPS,
 162         POWER_SUPPLY_TYPE_MAINS,
 163         POWER_SUPPLY_TYPE_USB,          /* Standard Downstream Port */
 164         POWER_SUPPLY_TYPE_USB_DCP,      /* Dedicated Charging Port */
 165         POWER_SUPPLY_TYPE_USB_CDP,      /* Charging Downstream Port */
 166         POWER_SUPPLY_TYPE_USB_ACA,      /* Accessory Charger Adapters */
 167 };
 168
 169 enum power_supply_notifier_events {
 170         PSY_EVENT_PROP_CHANGED,
 171 };
 172
 173 union power_supply_propval {
 174         int intval;
 175         const char *strval;
 176 };
 177
 178 struct device_node;
 179
 180 struct power_supply {
 181         const char *name;
 182         enum power_supply_type type;
 183         enum power_supply_property *properties;
 184         size_t num_properties;
 185
 186         char **supplied_to;
 187         size_t num_supplicants;
 188
 189         char **supplied_from;
 190         size_t num_supplies;
 191         struct device_node *of_node;
 192
 193         int (*get_property)(struct power_supply *psy,
 194                             enum power_supply_property psp,
 195                             union power_supply_propval *val);
 196         int (*set_property)(struct power_supply *psy,
 197                             enum power_supply_property psp,
 198                             const union power_supply_propval *val);
 199         int (*property_is_writeable)(struct power_supply *psy,
 200                                      enum power_supply_property psp);
 201         void (*external_power_changed)(struct power_supply *psy);
 202         void (*set_charged)(struct power_supply *psy);
 203
 204         /* For APM emulation, think legacy userspace. */
 205         int use_for_apm;
 206
 207         /* private */
 208         struct device *dev;
 209         struct work_struct changed_work;
 210         spinlock_t changed_lock;
 211         bool changed;
 212 #ifdef CONFIG_THERMAL
 213         struct thermal_zone_device *tzd;
 214         struct thermal_cooling_device *tcd;
 215 #endif
 216
 217 #ifdef CONFIG_LEDS_TRIGGERS
 218         struct led_trigger *charging_full_trig;
 219         char *charging_full_trig_name;
 220         struct led_trigger *charging_trig;
 221         char *charging_trig_name;
 222         struct led_trigger *full_trig;
 223         char *full_trig_name;
 224         struct led_trigger *online_trig;
 225         char *online_trig_name;
 226         struct led_trigger *charging_blink_full_solid_trig;
 227         char *charging_blink_full_solid_trig_name;
 228 #endif
 229 };
 230
 231 /*
 232  * This is recommended structure to specify static power supply parameters.
 233  * Generic one, parametrizable for different power supplies. Power supply
 234  * class itself does not use it, but that's what implementing most platform
 235  * drivers, should try reuse for consistency.
 236  */
 237
 238 struct power_supply_info {
 239         const char *name;
 240         int technology;
 241         int voltage_max_design;
 242         int voltage_min_design;
 243         int charge_full_design;
 244         int charge_empty_design;
 245         int energy_full_design;
 246         int energy_empty_design;
 247         int use_for_apm;
 248 };
 249
 250 extern struct atomic_notifier_head power_supply_notifier;
 251 extern int power_supply_reg_notifier(struct notifier_block *nb);
 252 extern void power_supply_unreg_notifier(struct notifier_block *nb);
 253 extern struct power_supply *power_supply_get_by_name(const char *name);
 254 #ifdef CONFIG_OF
 255 extern struct power_supply *power_supply_get_by_phandle(struct device_node *np,
 256                                                         const char *property);
 257 #else /* !CONFIG_OF */
 258 static inline struct power_supply *
 259 power_supply_get_by_phandle(struct device_node *np, const char *property)
 260 { return NULL; }
 261 #endif /* CONFIG_OF */
 262 extern void power_supply_changed(struct power_supply *psy);
 263 extern int power_supply_am_i_supplied(struct power_supply *psy);
 264 extern int power_supply_set_battery_charged(struct power_supply *psy);
 265
 266 #ifdef CONFIG_POWER_SUPPLY
 267 extern int power_supply_is_system_supplied(void);
 268 #else
 269 static inline int power_supply_is_system_supplied(void) { return -ENOSYS; }
 270 #endif
 271
 272 extern int power_supply_register(struct device *parent,
 273                                  struct power_supply *psy);
 274 extern int power_supply_register_no_ws(struct device *parent,
 275                                  struct power_supply *psy);
 276 extern void power_supply_unregister(struct power_supply *psy);
 277 extern int power_supply_powers(struct power_supply *psy, struct device *dev);
 278
 279 /* For APM emulation, think legacy userspace. */
 280 extern struct class *power_supply_class;
 281
 282 static inline bool power_supply_is_amp_property(enum power_supply_property psp)
 283 {
 284         switch (psp) {
 285         case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
 286         case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN:
 287         case POWER_SUPPLY_PROP_CHARGE_FULL:
 288         case POWER_SUPPLY_PROP_CHARGE_EMPTY:
 289         case POWER_SUPPLY_PROP_CHARGE_NOW:
 290         case POWER_SUPPLY_PROP_CHARGE_AVG:
 291         case POWER_SUPPLY_PROP_CHARGE_COUNTER:
 292         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT:
 293         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX:
 294         case POWER_SUPPLY_PROP_CURRENT_MAX:
 295         case POWER_SUPPLY_PROP_CURRENT_NOW:
 296         case POWER_SUPPLY_PROP_CURRENT_AVG:
 297         case POWER_SUPPLY_PROP_CURRENT_BOOT:
 298                 return 1;
 299         default:
 300                 break;
 301         }
 302
 303         return 0;
 304 }
 305
 306 static inline bool power_supply_is_watt_property(enum power_supply_property psp)
 307 {
 308         switch (psp) {
 309         case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
 310         case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN:
 311         case POWER_SUPPLY_PROP_ENERGY_FULL:
 312         case POWER_SUPPLY_PROP_ENERGY_EMPTY:
 313         case POWER_SUPPLY_PROP_ENERGY_NOW:
 314         case POWER_SUPPLY_PROP_ENERGY_AVG:
 315         case POWER_SUPPLY_PROP_VOLTAGE_MAX:
 316         case POWER_SUPPLY_PROP_VOLTAGE_MIN:
 317         case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
 318         case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
 319         case POWER_SUPPLY_PROP_VOLTAGE_NOW:
 320         case POWER_SUPPLY_PROP_VOLTAGE_AVG:
 321         case POWER_SUPPLY_PROP_VOLTAGE_OCV:
 322         case POWER_SUPPLY_PROP_VOLTAGE_BOOT:
 323         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE:
 324         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX:
 325         case POWER_SUPPLY_PROP_POWER_NOW:
 326                 return 1;
 327         default:
 328                 break;
 329         }
 330
 331         return 0;
 332 }
 333
 334 #endif /* __LINUX_POWER_SUPPLY_H__ */