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