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/device.h>
  17 #include <linux/workqueue.h>
  18 #include <linux/leds.h>
  19 #include <linux/spinlock.h>
  20 #include <linux/notifier.h>
  21 #include <linux/types.h>
  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         /* Local extensions */
 153         POWER_SUPPLY_PROP_USB_HC,
 154         POWER_SUPPLY_PROP_USB_OTG,
 155         POWER_SUPPLY_PROP_CHARGE_ENABLED,
 156         /* Local extensions of type int64_t */
 157         POWER_SUPPLY_PROP_CHARGE_COUNTER_EXT,
 158         /* Properties of type `const char *' */
 159         POWER_SUPPLY_PROP_MODEL_NAME,
 160         POWER_SUPPLY_PROP_MANUFACTURER,
 161         POWER_SUPPLY_PROP_SERIAL_NUMBER,
 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 };
 174
 175 enum power_supply_notifier_events {
 176         PSY_EVENT_PROP_CHANGED,
 177 };
 178
 179 union power_supply_propval {
 180         int intval;
 181         const char *strval;
 182         int64_t int64val;
 183 };
 184
 185 struct device_node;
 186 struct power_supply;
 187
 188 /* Run-time specific power supply configuration */
 189 struct power_supply_config {
 190         struct device_node *of_node;
 191         /* Driver private data */
 192         void *drv_data;
 193
 194         char **supplied_to;
 195         size_t num_supplicants;
 196 };
 197
 198 /* Description of power supply */
 199 struct power_supply_desc {
 200         const char *name;
 201         enum power_supply_type type;
 202         enum power_supply_property *properties;
 203         size_t num_properties;
 204
 205         /*
 206          * Functions for drivers implementing power supply class.
 207          * These shouldn't be called directly by other drivers for accessing
 208          * this power supply. Instead use power_supply_*() functions (for
 209          * example power_supply_get_property()).
 210          */
 211         int (*get_property)(struct power_supply *psy,
 212                             enum power_supply_property psp,
 213                             union power_supply_propval *val);
 214         int (*set_property)(struct power_supply *psy,
 215                             enum power_supply_property psp,
 216                             const union power_supply_propval *val);
 217         /*
 218          * property_is_writeable() will be called during registration
 219          * of power supply. If this happens during device probe then it must
 220          * not access internal data of device (because probe did not end).
 221          */
 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         /*
 228          * Set if thermal zone should not be created for this power supply.
 229          * For example for virtual supplies forwarding calls to actual
 230          * sensors or other supplies.
 231          */
 232         bool no_thermal;
 233         /* For APM emulation, think legacy userspace. */
 234         int use_for_apm;
 235 };
 236
 237 struct power_supply {
 238         const struct power_supply_desc *desc;
 239
 240         char **supplied_to;
 241         size_t num_supplicants;
 242
 243         char **supplied_from;
 244         size_t num_supplies;
 245         struct device_node *of_node;
 246
 247         /* Driver private data */
 248         void *drv_data;
 249
 250         /* private */
 251         struct device dev;
 252         struct work_struct changed_work;
 253         struct delayed_work deferred_register_work;
 254         spinlock_t changed_lock;
 255         bool changed;
 256         atomic_t use_cnt;
 257 #ifdef CONFIG_THERMAL
 258         struct thermal_zone_device *tzd;
 259         struct thermal_cooling_device *tcd;
 260 #endif
 261
 262 #ifdef CONFIG_LEDS_TRIGGERS
 263         struct led_trigger *charging_full_trig;
 264         char *charging_full_trig_name;
 265         struct led_trigger *charging_trig;
 266         char *charging_trig_name;
 267         struct led_trigger *full_trig;
 268         char *full_trig_name;
 269         struct led_trigger *online_trig;
 270         char *online_trig_name;
 271         struct led_trigger *charging_blink_full_solid_trig;
 272         char *charging_blink_full_solid_trig_name;
 273 #endif
 274 };
 275
 276 /*
 277  * This is recommended structure to specify static power supply parameters.
 278  * Generic one, parametrizable for different power supplies. Power supply
 279  * class itself does not use it, but that's what implementing most platform
 280  * drivers, should try reuse for consistency.
 281  */
 282
 283 struct power_supply_info {
 284         const char *name;
 285         int technology;
 286         int voltage_max_design;
 287         int voltage_min_design;
 288         int charge_full_design;
 289         int charge_empty_design;
 290         int energy_full_design;
 291         int energy_empty_design;
 292         int use_for_apm;
 293 };
 294
 295 extern struct atomic_notifier_head power_supply_notifier;
 296 extern int power_supply_reg_notifier(struct notifier_block *nb);
 297 extern void power_supply_unreg_notifier(struct notifier_block *nb);
 298 extern struct power_supply *power_supply_get_by_name(const char *name);
 299 extern void power_supply_put(struct power_supply *psy);
 300 #ifdef CONFIG_OF
 301 extern struct power_supply *power_supply_get_by_phandle(struct device_node *np,
 302                                                         const char *property);
 303 extern struct power_supply *devm_power_supply_get_by_phandle(
 304                                     struct device *dev, const char *property);
 305 #else /* !CONFIG_OF */
 306 static inline struct power_supply *
 307 power_supply_get_by_phandle(struct device_node *np, const char *property)
 308 { return NULL; }
 309 static inline struct power_supply *
 310 devm_power_supply_get_by_phandle(struct device *dev, const char *property)
 311 { return NULL; }
 312 #endif /* CONFIG_OF */
 313 extern void power_supply_changed(struct power_supply *psy);
 314 extern int power_supply_am_i_supplied(struct power_supply *psy);
 315 extern int power_supply_set_battery_charged(struct power_supply *psy);
 316
 317 #ifdef CONFIG_POWER_SUPPLY
 318 extern int power_supply_is_system_supplied(void);
 319 #else
 320 static inline int power_supply_is_system_supplied(void) { return -ENOSYS; }
 321 #endif
 322
 323 extern int power_supply_get_property(struct power_supply *psy,
 324                             enum power_supply_property psp,
 325                             union power_supply_propval *val);
 326 extern int power_supply_set_property(struct power_supply *psy,
 327                             enum power_supply_property psp,
 328                             const union power_supply_propval *val);
 329 extern int power_supply_property_is_writeable(struct power_supply *psy,
 330                                         enum power_supply_property psp);
 331 extern void power_supply_external_power_changed(struct power_supply *psy);
 332
 333 extern struct power_supply *__must_check
 334 power_supply_register(struct device *parent,
 335                                  const struct power_supply_desc *desc,
 336                                  const struct power_supply_config *cfg);
 337 extern struct power_supply *__must_check
 338 power_supply_register_no_ws(struct device *parent,
 339                                  const struct power_supply_desc *desc,
 340                                  const struct power_supply_config *cfg);
 341 extern struct power_supply *__must_check
 342 devm_power_supply_register(struct device *parent,
 343                                  const struct power_supply_desc *desc,
 344                                  const struct power_supply_config *cfg);
 345 extern struct power_supply *__must_check
 346 devm_power_supply_register_no_ws(struct device *parent,
 347                                  const struct power_supply_desc *desc,
 348                                  const struct power_supply_config *cfg);
 349 extern void power_supply_unregister(struct power_supply *psy);
 350 extern int power_supply_powers(struct power_supply *psy, struct device *dev);
 351
 352 extern void *power_supply_get_drvdata(struct power_supply *psy);
 353 /* For APM emulation, think legacy userspace. */
 354 extern struct class *power_supply_class;
 355
 356 static inline bool power_supply_is_amp_property(enum power_supply_property psp)
 357 {
 358         switch (psp) {
 359         case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
 360         case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN:
 361         case POWER_SUPPLY_PROP_CHARGE_FULL:
 362         case POWER_SUPPLY_PROP_CHARGE_EMPTY:
 363         case POWER_SUPPLY_PROP_CHARGE_NOW:
 364         case POWER_SUPPLY_PROP_CHARGE_AVG:
 365         case POWER_SUPPLY_PROP_CHARGE_COUNTER:
 366         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT:
 367         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX:
 368         case POWER_SUPPLY_PROP_CURRENT_MAX:
 369         case POWER_SUPPLY_PROP_CURRENT_NOW:
 370         case POWER_SUPPLY_PROP_CURRENT_AVG:
 371         case POWER_SUPPLY_PROP_CURRENT_BOOT:
 372                 return 1;
 373         default:
 374                 break;
 375         }
 376
 377         return 0;
 378 }
 379
 380 static inline bool power_supply_is_watt_property(enum power_supply_property psp)
 381 {
 382         switch (psp) {
 383         case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
 384         case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN:
 385         case POWER_SUPPLY_PROP_ENERGY_FULL:
 386         case POWER_SUPPLY_PROP_ENERGY_EMPTY:
 387         case POWER_SUPPLY_PROP_ENERGY_NOW:
 388         case POWER_SUPPLY_PROP_ENERGY_AVG:
 389         case POWER_SUPPLY_PROP_VOLTAGE_MAX:
 390         case POWER_SUPPLY_PROP_VOLTAGE_MIN:
 391         case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
 392         case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
 393         case POWER_SUPPLY_PROP_VOLTAGE_NOW:
 394         case POWER_SUPPLY_PROP_VOLTAGE_AVG:
 395         case POWER_SUPPLY_PROP_VOLTAGE_OCV:
 396         case POWER_SUPPLY_PROP_VOLTAGE_BOOT:
 397         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE:
 398         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX:
 399         case POWER_SUPPLY_PROP_POWER_NOW:
 400                 return 1;
 401         default:
 402                 break;
 403         }
 404
 405         return 0;
 406 }
 407
 408 #endif /* __LINUX_POWER_SUPPLY_H__ */