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 /*
  22  * All voltages, currents, charges, energies, time and temperatures in uV,
  23  * µA, µAh, µWh, seconds and tenths of degree Celsius unless otherwise
  24  * stated. It's driver's job to convert its raw values to units in which
  25  * this class operates.
  26  */
  27
  28 /*
  29  * For systems where the charger determines the maximum battery capacity
  30  * the min and max fields should be used to present these values to user
  31  * space. Unused/unknown fields will not appear in sysfs.
  32  */
  33
  34 enum {
  35         POWER_SUPPLY_STATUS_UNKNOWN = 0,
  36         POWER_SUPPLY_STATUS_CHARGING,
  37         POWER_SUPPLY_STATUS_DISCHARGING,
  38         POWER_SUPPLY_STATUS_NOT_CHARGING,
  39         POWER_SUPPLY_STATUS_FULL,
  40 };
  41
  42 enum {
  43         POWER_SUPPLY_CHARGE_TYPE_UNKNOWN = 0,
  44         POWER_SUPPLY_CHARGE_TYPE_NONE,
  45         POWER_SUPPLY_CHARGE_TYPE_TRICKLE,
  46         POWER_SUPPLY_CHARGE_TYPE_FAST,
  47 };
  48
  49 enum {
  50         POWER_SUPPLY_HEALTH_UNKNOWN = 0,
  51         POWER_SUPPLY_HEALTH_GOOD,
  52         POWER_SUPPLY_HEALTH_OVERHEAT,
  53         POWER_SUPPLY_HEALTH_DEAD,
  54         POWER_SUPPLY_HEALTH_OVERVOLTAGE,
  55         POWER_SUPPLY_HEALTH_UNSPEC_FAILURE,
  56         POWER_SUPPLY_HEALTH_COLD,
  57         POWER_SUPPLY_HEALTH_WATCHDOG_TIMER_EXPIRE,
  58         POWER_SUPPLY_HEALTH_SAFETY_TIMER_EXPIRE,
  59 };
  60
  61 enum {
  62         POWER_SUPPLY_TECHNOLOGY_UNKNOWN = 0,
  63         POWER_SUPPLY_TECHNOLOGY_NiMH,
  64         POWER_SUPPLY_TECHNOLOGY_LION,
  65         POWER_SUPPLY_TECHNOLOGY_LIPO,
  66         POWER_SUPPLY_TECHNOLOGY_LiFe,
  67         POWER_SUPPLY_TECHNOLOGY_NiCd,
  68         POWER_SUPPLY_TECHNOLOGY_LiMn,
  69 };
  70
  71 enum {
  72         POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN = 0,
  73         POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL,
  74         POWER_SUPPLY_CAPACITY_LEVEL_LOW,
  75         POWER_SUPPLY_CAPACITY_LEVEL_NORMAL,
  76         POWER_SUPPLY_CAPACITY_LEVEL_HIGH,
  77         POWER_SUPPLY_CAPACITY_LEVEL_FULL,
  78 };
  79
  80 enum {
  81         POWER_SUPPLY_SCOPE_UNKNOWN = 0,
  82         POWER_SUPPLY_SCOPE_SYSTEM,
  83         POWER_SUPPLY_SCOPE_DEVICE,
  84 };
  85
  86 enum power_supply_property {
  87         /* Properties of type `int' */
  88         POWER_SUPPLY_PROP_STATUS = 0,
  89         POWER_SUPPLY_PROP_CHARGE_TYPE,
  90         POWER_SUPPLY_PROP_HEALTH,
  91         POWER_SUPPLY_PROP_PRESENT,
  92         POWER_SUPPLY_PROP_ONLINE,
  93         POWER_SUPPLY_PROP_AUTHENTIC,
  94         POWER_SUPPLY_PROP_TECHNOLOGY,
  95         POWER_SUPPLY_PROP_CYCLE_COUNT,
  96         POWER_SUPPLY_PROP_VOLTAGE_MAX,
  97         POWER_SUPPLY_PROP_VOLTAGE_MIN,
  98         POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
  99         POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
 100         POWER_SUPPLY_PROP_VOLTAGE_NOW,
 101         POWER_SUPPLY_PROP_VOLTAGE_AVG,
 102         POWER_SUPPLY_PROP_VOLTAGE_OCV,
 103         POWER_SUPPLY_PROP_VOLTAGE_BOOT,
 104         POWER_SUPPLY_PROP_CURRENT_MAX,
 105         POWER_SUPPLY_PROP_CURRENT_NOW,
 106         POWER_SUPPLY_PROP_CURRENT_AVG,
 107         POWER_SUPPLY_PROP_CURRENT_BOOT,
 108         POWER_SUPPLY_PROP_POWER_NOW,
 109         POWER_SUPPLY_PROP_POWER_AVG,
 110         POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
 111         POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN,
 112         POWER_SUPPLY_PROP_CHARGE_FULL,
 113         POWER_SUPPLY_PROP_CHARGE_EMPTY,
 114         POWER_SUPPLY_PROP_CHARGE_NOW,
 115         POWER_SUPPLY_PROP_CHARGE_AVG,
 116         POWER_SUPPLY_PROP_CHARGE_COUNTER,
 117         POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT,
 118         POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX,
 119         POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE,
 120         POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX,
 121         POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT,
 122         POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX,
 123         POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT,
 124         POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
 125         POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN,
 126         POWER_SUPPLY_PROP_ENERGY_FULL,
 127         POWER_SUPPLY_PROP_ENERGY_EMPTY,
 128         POWER_SUPPLY_PROP_ENERGY_NOW,
 129         POWER_SUPPLY_PROP_ENERGY_AVG,
 130         POWER_SUPPLY_PROP_CAPACITY, /* in percents! */
 131         POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN, /* in percents! */
 132         POWER_SUPPLY_PROP_CAPACITY_ALERT_MAX, /* in percents! */
 133         POWER_SUPPLY_PROP_CAPACITY_LEVEL,
 134         POWER_SUPPLY_PROP_TEMP,
 135         POWER_SUPPLY_PROP_TEMP_MAX,
 136         POWER_SUPPLY_PROP_TEMP_MIN,
 137         POWER_SUPPLY_PROP_TEMP_ALERT_MIN,
 138         POWER_SUPPLY_PROP_TEMP_ALERT_MAX,
 139         POWER_SUPPLY_PROP_TEMP_AMBIENT,
 140         POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MIN,
 141         POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MAX,
 142         POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
 143         POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
 144         POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
 145         POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
 146         POWER_SUPPLY_PROP_TYPE, /* use power_supply.type instead */
 147         POWER_SUPPLY_PROP_SCOPE,
 148         POWER_SUPPLY_PROP_CHARGE_TERM_CURRENT,
 149         POWER_SUPPLY_PROP_CALIBRATE,
 150         /* Properties of type `const char *' */
 151         POWER_SUPPLY_PROP_MODEL_NAME,
 152         POWER_SUPPLY_PROP_MANUFACTURER,
 153         POWER_SUPPLY_PROP_SERIAL_NUMBER,
 154 };
 155
 156 enum power_supply_type {
 157         POWER_SUPPLY_TYPE_UNKNOWN = 0,
 158         POWER_SUPPLY_TYPE_BATTERY,
 159         POWER_SUPPLY_TYPE_UPS,
 160         POWER_SUPPLY_TYPE_MAINS,
 161         POWER_SUPPLY_TYPE_USB,          /* Standard Downstream Port */
 162         POWER_SUPPLY_TYPE_USB_DCP,      /* Dedicated Charging Port */
 163         POWER_SUPPLY_TYPE_USB_CDP,      /* Charging Downstream Port */
 164         POWER_SUPPLY_TYPE_USB_ACA,      /* Accessory Charger Adapters */
 165 };
 166
 167 enum power_supply_notifier_events {
 168         PSY_EVENT_PROP_CHANGED,
 169 };
 170
 171 union power_supply_propval {
 172         int intval;
 173         const char *strval;
 174 };
 175
 176 struct device;
 177 struct device_node;
 178
 179 /* Power supply instance specific configuration */
 180 struct power_supply_config {
 181         struct device_node *of_node;
 182         /* Driver private data */
 183         void *drv_data;
 184
 185         char **supplied_to;
 186         size_t num_supplicants;
 187 };
 188
 189 struct power_supply {
 190         const char *name;
 191         enum power_supply_type type;
 192         enum power_supply_property *properties;
 193         size_t num_properties;
 194
 195         char **supplied_to;
 196         size_t num_supplicants;
 197
 198         char **supplied_from;
 199         size_t num_supplies;
 200         struct device_node *of_node;
 201
 202         int (*get_property)(struct power_supply *psy,
 203                             enum power_supply_property psp,
 204                             union power_supply_propval *val);
 205         int (*set_property)(struct power_supply *psy,
 206                             enum power_supply_property psp,
 207                             const union power_supply_propval *val);
 208         int (*property_is_writeable)(struct power_supply *psy,
 209                                      enum power_supply_property psp);
 210         void (*external_power_changed)(struct power_supply *psy);
 211         void (*set_charged)(struct power_supply *psy);
 212
 213         /*
 214          * Set if thermal zone should not be created for this power supply.
 215          * For example for virtual supplies forwarding calls to actual
 216          * sensors or other supplies.
 217          */
 218         bool no_thermal;
 219         /* For APM emulation, think legacy userspace. */
 220         int use_for_apm;
 221
 222         /* Driver private data */
 223         void *drv_data;
 224
 225         /* private */
 226         struct device *dev;
 227         struct work_struct changed_work;
 228         spinlock_t changed_lock;
 229         bool changed;
 230 #ifdef CONFIG_THERMAL
 231         struct thermal_zone_device *tzd;
 232         struct thermal_cooling_device *tcd;
 233 #endif
 234
 235 #ifdef CONFIG_LEDS_TRIGGERS
 236         struct led_trigger *charging_full_trig;
 237         char *charging_full_trig_name;
 238         struct led_trigger *charging_trig;
 239         char *charging_trig_name;
 240         struct led_trigger *full_trig;
 241         char *full_trig_name;
 242         struct led_trigger *online_trig;
 243         char *online_trig_name;
 244         struct led_trigger *charging_blink_full_solid_trig;
 245         char *charging_blink_full_solid_trig_name;
 246 #endif
 247 };
 248
 249 /*
 250  * This is recommended structure to specify static power supply parameters.
 251  * Generic one, parametrizable for different power supplies. Power supply
 252  * class itself does not use it, but that's what implementing most platform
 253  * drivers, should try reuse for consistency.
 254  */
 255
 256 struct power_supply_info {
 257         const char *name;
 258         int technology;
 259         int voltage_max_design;
 260         int voltage_min_design;
 261         int charge_full_design;
 262         int charge_empty_design;
 263         int energy_full_design;
 264         int energy_empty_design;
 265         int use_for_apm;
 266 };
 267
 268 extern struct atomic_notifier_head power_supply_notifier;
 269 extern int power_supply_reg_notifier(struct notifier_block *nb);
 270 extern void power_supply_unreg_notifier(struct notifier_block *nb);
 271 extern struct power_supply *power_supply_get_by_name(const char *name);
 272 #ifdef CONFIG_OF
 273 extern struct power_supply *power_supply_get_by_phandle(struct device_node *np,
 274                                                         const char *property);
 275 #else /* !CONFIG_OF */
 276 static inline struct power_supply *
 277 power_supply_get_by_phandle(struct device_node *np, const char *property)
 278 { return NULL; }
 279 #endif /* CONFIG_OF */
 280 extern void power_supply_changed(struct power_supply *psy);
 281 extern int power_supply_am_i_supplied(struct power_supply *psy);
 282 extern int power_supply_set_battery_charged(struct power_supply *psy);
 283
 284 #ifdef CONFIG_POWER_SUPPLY
 285 extern int power_supply_is_system_supplied(void);
 286 #else
 287 static inline int power_supply_is_system_supplied(void) { return -ENOSYS; }
 288 #endif
 289
 290 extern int power_supply_register(struct device *parent,
 291                                  struct power_supply *psy,
 292                                  const struct power_supply_config *cfg);
 293 extern int power_supply_register_no_ws(struct device *parent,
 294                                  struct power_supply *psy,
 295                                  const struct power_supply_config *cfg);
 296 extern int devm_power_supply_register(struct device *parent,
 297                                  struct power_supply *psy,
 298                                  const struct power_supply_config *cfg);
 299 extern int devm_power_supply_register_no_ws(struct device *parent,
 300                                  struct power_supply *psy,
 301                                  const struct power_supply_config *cfg);
 302 extern void power_supply_unregister(struct power_supply *psy);
 303 extern int power_supply_powers(struct power_supply *psy, struct device *dev);
 304
 305 extern void *power_supply_get_drvdata(struct power_supply *psy);
 306 /* For APM emulation, think legacy userspace. */
 307 extern struct class *power_supply_class;
 308
 309 static inline bool power_supply_is_amp_property(enum power_supply_property psp)
 310 {
 311         switch (psp) {
 312         case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
 313         case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN:
 314         case POWER_SUPPLY_PROP_CHARGE_FULL:
 315         case POWER_SUPPLY_PROP_CHARGE_EMPTY:
 316         case POWER_SUPPLY_PROP_CHARGE_NOW:
 317         case POWER_SUPPLY_PROP_CHARGE_AVG:
 318         case POWER_SUPPLY_PROP_CHARGE_COUNTER:
 319         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT:
 320         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX:
 321         case POWER_SUPPLY_PROP_CURRENT_MAX:
 322         case POWER_SUPPLY_PROP_CURRENT_NOW:
 323         case POWER_SUPPLY_PROP_CURRENT_AVG:
 324         case POWER_SUPPLY_PROP_CURRENT_BOOT:
 325                 return 1;
 326         default:
 327                 break;
 328         }
 329
 330         return 0;
 331 }
 332
 333 static inline bool power_supply_is_watt_property(enum power_supply_property psp)
 334 {
 335         switch (psp) {
 336         case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
 337         case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN:
 338         case POWER_SUPPLY_PROP_ENERGY_FULL:
 339         case POWER_SUPPLY_PROP_ENERGY_EMPTY:
 340         case POWER_SUPPLY_PROP_ENERGY_NOW:
 341         case POWER_SUPPLY_PROP_ENERGY_AVG:
 342         case POWER_SUPPLY_PROP_VOLTAGE_MAX:
 343         case POWER_SUPPLY_PROP_VOLTAGE_MIN:
 344         case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
 345         case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
 346         case POWER_SUPPLY_PROP_VOLTAGE_NOW:
 347         case POWER_SUPPLY_PROP_VOLTAGE_AVG:
 348         case POWER_SUPPLY_PROP_VOLTAGE_OCV:
 349         case POWER_SUPPLY_PROP_VOLTAGE_BOOT:
 350         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE:
 351         case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX:
 352         case POWER_SUPPLY_PROP_POWER_NOW:
 353                 return 1;
 354         default:
 355                 break;
 356         }
 357
 358         return 0;
 359 }
 360
 361 #endif /* __LINUX_POWER_SUPPLY_H__ */