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
  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_VOLTAGE_BOOT,
 105         POWER_SUPPLY_PROP_CURRENT_MAX,
 106         POWER_SUPPLY_PROP_CURRENT_NOW,
 107         POWER_SUPPLY_PROP_CURRENT_AVG,
 108         POWER_SUPPLY_PROP_CURRENT_BOOT,
 109         POWER_SUPPLY_PROP_POWER_NOW,
 110         POWER_SUPPLY_PROP_POWER_AVG,
 111         POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
 112         POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN,
 113         POWER_SUPPLY_PROP_CHARGE_FULL,
 114         POWER_SUPPLY_PROP_CHARGE_EMPTY,
 115         POWER_SUPPLY_PROP_CHARGE_NOW,
 116         POWER_SUPPLY_PROP_CHARGE_AVG,
 117         POWER_SUPPLY_PROP_CHARGE_COUNTER,
 118         POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT,
 119         POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX,
 120         POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE,
 121         POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX,
 122         POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT,
 123         POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX,
 124         POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT,
 125         POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
 126         POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN,
 127         POWER_SUPPLY_PROP_ENERGY_FULL,
 128         POWER_SUPPLY_PROP_ENERGY_EMPTY,
 129         POWER_SUPPLY_PROP_ENERGY_NOW,
 130         POWER_SUPPLY_PROP_ENERGY_AVG,
 131         POWER_SUPPLY_PROP_CAPACITY, /* in percents! */
 132         POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN, /* in percents! */
 133         POWER_SUPPLY_PROP_CAPACITY_ALERT_MAX, /* in percents! */
 134         POWER_SUPPLY_PROP_CAPACITY_LEVEL,
 135         POWER_SUPPLY_PROP_TEMP,
 136         POWER_SUPPLY_PROP_TEMP_MAX,
 137         POWER_SUPPLY_PROP_TEMP_MIN,
 138         POWER_SUPPLY_PROP_TEMP_ALERT_MIN,
 139         POWER_SUPPLY_PROP_TEMP_ALERT_MAX,
 140         POWER_SUPPLY_PROP_TEMP_AMBIENT,
 141         POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MIN,
 142         POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MAX,
 143         POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
 144         POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
 145         POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
 146         POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
 147         POWER_SUPPLY_PROP_TYPE, /* use power_supply.type instead */
 148         POWER_SUPPLY_PROP_SCOPE,
 149         POWER_SUPPLY_PROP_PRECHARGE_CURRENT,
 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         POWER_SUPPLY_TYPE_USB_TYPE_C,           /* Type C Port */
 168         POWER_SUPPLY_TYPE_USB_PD,               /* Power Delivery Port */
 169         POWER_SUPPLY_TYPE_USB_PD_DRP,           /* PD Dual Role Port */
 170         POWER_SUPPLY_TYPE_APPLE_BRICK_ID,       /* Apple Charging Method */
 171 };
 172
 173 enum power_supply_notifier_events {
 174         PSY_EVENT_PROP_CHANGED,
 175 };
 176
 177 union power_supply_propval {
 178         int intval;
 179         const char *strval;
 180 };
 181
 182 struct device_node;
 183 struct power_supply;
 184
 185 /* Run-time specific power supply configuration */
 186 struct power_supply_config {
 187         struct device_node *of_node;
 188         /* Driver private data */
 189         void *drv_data;
 190
 191         char **supplied_to;
 192         size_t num_supplicants;
 193 };
 194
 195 /* Description of power supply */
 196 struct power_supply_desc {
 197         const char *name;
 198         enum power_supply_type type;
 199         enum power_supply_property *properties;
 200         size_t num_properties;
 201
 202         /*
 203          * Functions for drivers implementing power supply class.
 204          * These shouldn't be called directly by other drivers for accessing
 205          * this power supply. Instead use power_supply_*() functions (for
 206          * example power_supply_get_property()).
 207          */
 208         int (*get_property)(struct power_supply *psy,
 209                             enum power_supply_property psp,
 210                             union power_supply_propval *val);
 211         int (*set_property)(struct power_supply *psy,
 212                             enum power_supply_property psp,
 213                             const union power_supply_propval *val);
 214         /*
 215          * property_is_writeable() will be called during registration
 216          * of power supply. If this happens during device probe then it must
 217          * not access internal data of device (because probe did not end).
 218          */
 219         int (*property_is_writeable)(struct power_supply *psy,
 220                                      enum power_supply_property psp);
 221         void (*external_power_changed)(struct power_supply *psy);
 222         void (*set_charged)(struct power_supply *psy);
 223
 224         /*
 225          * Set if thermal zone should not be created for this power supply.
 226          * For example for virtual supplies forwarding calls to actual
 227          * sensors or other supplies.
 228          */
 229         bool no_thermal;
 230         /* For APM emulation, think legacy userspace. */
 231         int use_for_apm;
 232 };
 233
 234 struct power_supply {
 235         const struct power_supply_desc *desc;
 236
 237         char **supplied_to;
 238         size_t num_supplicants;
 239
 240         char **supplied_from;
 241         size_t num_supplies;
 242         struct device_node *of_node;
 243
 244         /* Driver private data */
 245         void *drv_data;
 246
 247         /* private */
 248         struct device dev;
 249         struct work_struct changed_work;
 250         struct delayed_work deferred_register_work;
 251         spinlock_t changed_lock;
 252         bool changed;
 253         bool initialized;
 254         atomic_t use_cnt;
 255 #ifdef CONFIG_THERMAL
 256         struct thermal_zone_device *tzd;
 257         struct thermal_cooling_device *tcd;
 258 #endif
 259
 260 #ifdef CONFIG_LEDS_TRIGGERS
 261         struct led_trigger *charging_full_trig;
 262         char *charging_full_trig_name;
 263         struct led_trigger *charging_trig;
 264         char *charging_trig_name;
 265         struct led_trigger *full_trig;
 266         char *full_trig_name;
 267         struct led_trigger *online_trig;
 268         char *online_trig_name;
 269         struct led_trigger *charging_blink_full_solid_trig;
 270         char *charging_blink_full_solid_trig_name;
 271 #endif
 272 };
 273
 274 /*
 275  * This is recommended structure to specify static power supply parameters.
 276  * Generic one, parametrizable for different power supplies. Power supply
 277  * class itself does not use it, but that's what implementing most platform
 278  * drivers, should try reuse for consistency.
 279  */
 280
 281 struct power_supply_info {
 282         const char *name;
 283         int technology;
 284         int voltage_max_design;
 285         int voltage_min_design;
 286         int charge_full_design;
 287         int charge_empty_design;
 288         int energy_full_design;
 289         int energy_empty_design;
 290         int use_for_apm;
 291 };
 292
 293 /*
 294  * This is the recommended struct to manage static battery parameters,
 295  * populated by power_supply_get_battery_info(). Most platform drivers should
 296  * use these for consistency.
 297  * Its field names must correspond to elements in enum power_supply_property.
 298  * The default field value is -EINVAL.
 299  * Power supply class itself doesn't use this.
 300  */
 301
 302 struct power_supply_battery_info {
 303         int energy_full_design_uwh;         /* microWatt-hours */
 304         int charge_full_design_uah;         /* microAmp-hours */
 305         int voltage_min_design_uv;          /* microVolts */
 306         int precharge_current_ua;           /* microAmps */
 307         int charge_term_current_ua;         /* microAmps */
 308         int constant_charge_current_max_ua; /* microAmps */
 309         int constant_charge_voltage_max_uv; /* microVolts */
 310 };
 311
 312 extern struct atomic_notifier_head power_supply_notifier;
 313 extern int power_supply_reg_notifier(struct notifier_block *nb);
 314 extern void power_supply_unreg_notifier(struct notifier_block *nb);
 315 extern struct power_supply *power_supply_get_by_name(const char *name);
 316 extern void power_supply_put(struct power_supply *psy);
 317 #ifdef CONFIG_OF
 318 extern struct power_supply *power_supply_get_by_phandle(struct device_node *np,
 319                                                         const char *property);
 320 extern struct power_supply *devm_power_supply_get_by_phandle(
 321                                     struct device *dev, const char *property);
 322 #else /* !CONFIG_OF */
 323 static inline struct power_supply *
 324 power_supply_get_by_phandle(struct device_node *np, const char *property)
 325 { return NULL; }
 326 static inline struct power_supply *
 327 devm_power_supply_get_by_phandle(struct device *dev, const char *property)
 328 { return NULL; }
 329 #endif /* CONFIG_OF */
 330
 331 extern int power_supply_get_battery_info(struct power_supply *psy,
 332                                          struct power_supply_battery_info *info);
 333 extern void power_supply_changed(struct power_supply *psy);
 334 extern int power_supply_am_i_supplied(struct power_supply *psy);
 335 extern int power_supply_set_input_current_limit_from_supplier(
 336                                          struct power_supply *psy);
 337 extern int power_supply_set_battery_charged(struct power_supply *psy);
 338
 339 #ifdef CONFIG_POWER_SUPPLY
 340 extern int power_supply_is_system_supplied(void);
 341 #else
 342 static inline int power_supply_is_system_supplied(void) { return -ENOSYS; }
 343 #endif
 344
 345 extern int power_supply_get_property(struct power_supply *psy,
 346                             enum power_supply_property psp,
 347                             union power_supply_propval *val);
 348 extern int power_supply_set_property(struct power_supply *psy,
 349                             enum power_supply_property psp,
 350                             const union power_supply_propval *val);
 351 extern int power_supply_property_is_writeable(struct power_supply *psy,
 352                                         enum power_supply_property psp);
 353 extern void power_supply_external_power_changed(struct power_supply *psy);
 354
 355 extern struct power_supply *__must_check
 356 power_supply_register(struct device *parent,
 357                                  const struct power_supply_desc *desc,
 358                                  const struct power_supply_config *cfg);
 359 extern struct power_supply *__must_check
 360 power_supply_register_no_ws(struct device *parent,
 361                                  const struct power_supply_desc *desc,
 362                                  const struct power_supply_config *cfg);
 363 extern struct power_supply *__must_check
 364 devm_power_supply_register(struct device *parent,
 365                                  const struct power_supply_desc *desc,
 366                                  const struct power_supply_config *cfg);
 367 extern struct power_supply *__must_check
 368 devm_power_supply_register_no_ws(struct device *parent,
 369                                  const struct power_supply_desc *desc,
 370                                  const struct power_supply_config *cfg);
 371 extern void power_supply_unregister(struct power_supply *psy);
 372 extern int power_supply_powers(struct power_supply *psy, struct device *dev);
 373
 374 #define to_power_supply(device) container_of(device, struct power_supply, dev)
 375
 376 extern void *power_supply_get_drvdata(struct power_supply *psy);
 377 /* For APM emulation, think legacy userspace. */
 378 extern struct class *power_supply_class;
 379
 380 static inline bool power_supply_is_amp_property(enum power_supply_property psp)
 381 {
 382         switch (psp) {
 383         case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
 384         case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN:
 385         case POWER_SUPPLY_PROP_CHARGE_FULL:
 386         case POWER_SUPPLY_PROP_CHARGE_EMPTY:
 387         case POWER_SUPPLY_PROP_CHARGE_NOW:
 388         case POWER_SUPPLY_PROP_CHARGE_AVG:
 389         case POWER_SUPPLY_PROP_CHARGE_COUNTER:
 390         case POWER_SUPPLY_PROP_PRECHARGE_CURRENT:
 391         case POWER_SUPPLY_PROP_CHARGE_TERM_CURRENT:
 392         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT:
 393         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX:
 394         case POWER_SUPPLY_PROP_CURRENT_MAX:
 395         case POWER_SUPPLY_PROP_CURRENT_NOW:
 396         case POWER_SUPPLY_PROP_CURRENT_AVG:
 397         case POWER_SUPPLY_PROP_CURRENT_BOOT:
 398                 return 1;
 399         default:
 400                 break;
 401         }
 402
 403         return 0;
 404 }
 405
 406 static inline bool power_supply_is_watt_property(enum power_supply_property psp)
 407 {
 408         switch (psp) {
 409         case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
 410         case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN:
 411         case POWER_SUPPLY_PROP_ENERGY_FULL:
 412         case POWER_SUPPLY_PROP_ENERGY_EMPTY:
 413         case POWER_SUPPLY_PROP_ENERGY_NOW:
 414         case POWER_SUPPLY_PROP_ENERGY_AVG:
 415         case POWER_SUPPLY_PROP_VOLTAGE_MAX:
 416         case POWER_SUPPLY_PROP_VOLTAGE_MIN:
 417         case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
 418         case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
 419         case POWER_SUPPLY_PROP_VOLTAGE_NOW:
 420         case POWER_SUPPLY_PROP_VOLTAGE_AVG:
 421         case POWER_SUPPLY_PROP_VOLTAGE_OCV:
 422         case POWER_SUPPLY_PROP_VOLTAGE_BOOT:
 423         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE:
 424         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX:
 425         case POWER_SUPPLY_PROP_POWER_NOW:
 426                 return 1;
 427         default:
 428                 break;
 429         }
 430
 431         return 0;
 432 }
 433
 434 #endif /* __LINUX_POWER_SUPPLY_H__ */