LXR linux/include/linux/power

   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
  19struct device;
  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
  34enum {
  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
  42enum {
  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
  49enum {
  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
  61enum {
  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
  71enum {
  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
  80enum {
  81        POWER_SUPPLY_SCOPE_UNKNOWN = 0,
  82        POWER_SUPPLY_SCOPE_SYSTEM,
  83        POWER_SUPPLY_SCOPE_DEVICE,
  84};
  85
  86enum 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_CURRENT_MAX,
 104        POWER_SUPPLY_PROP_CURRENT_NOW,
 105        POWER_SUPPLY_PROP_CURRENT_AVG,
 106        POWER_SUPPLY_PROP_POWER_NOW,
 107        POWER_SUPPLY_PROP_POWER_AVG,
 108        POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
 109        POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN,
 110        POWER_SUPPLY_PROP_CHARGE_FULL,
 111        POWER_SUPPLY_PROP_CHARGE_EMPTY,
 112        POWER_SUPPLY_PROP_CHARGE_NOW,
 113        POWER_SUPPLY_PROP_CHARGE_AVG,
 114        POWER_SUPPLY_PROP_CHARGE_COUNTER,
 115        POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT,
 116        POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX,
 117        POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE,
 118        POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX,
 119        POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT,
 120        POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX,
 121        POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
 122        POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN,
 123        POWER_SUPPLY_PROP_ENERGY_FULL,
 124        POWER_SUPPLY_PROP_ENERGY_EMPTY,
 125        POWER_SUPPLY_PROP_ENERGY_NOW,
 126        POWER_SUPPLY_PROP_ENERGY_AVG,
 127        POWER_SUPPLY_PROP_CAPACITY, /* in percents! */
 128        POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN, /* in percents! */
 129        POWER_SUPPLY_PROP_CAPACITY_ALERT_MAX, /* in percents! */
 130        POWER_SUPPLY_PROP_CAPACITY_LEVEL,
 131        POWER_SUPPLY_PROP_TEMP,
 132        POWER_SUPPLY_PROP_TEMP_ALERT_MIN,
 133        POWER_SUPPLY_PROP_TEMP_ALERT_MAX,
 134        POWER_SUPPLY_PROP_TEMP_AMBIENT,
 135        POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MIN,
 136        POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MAX,
 137        POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
 138        POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
 139        POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
 140        POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
 141        POWER_SUPPLY_PROP_TYPE, /* use power_supply.type instead */
 142        POWER_SUPPLY_PROP_SCOPE,
 143        /* Properties of type `const char *' */
 144        POWER_SUPPLY_PROP_MODEL_NAME,
 145        POWER_SUPPLY_PROP_MANUFACTURER,
 146        POWER_SUPPLY_PROP_SERIAL_NUMBER,
 147};
 148
 149enum power_supply_type {
 150        POWER_SUPPLY_TYPE_UNKNOWN = 0,
 151        POWER_SUPPLY_TYPE_BATTERY,
 152        POWER_SUPPLY_TYPE_UPS,
 153        POWER_SUPPLY_TYPE_MAINS,
 154        POWER_SUPPLY_TYPE_USB,          /* Standard Downstream Port */
 155        POWER_SUPPLY_TYPE_USB_DCP,      /* Dedicated Charging Port */
 156        POWER_SUPPLY_TYPE_USB_CDP,      /* Charging Downstream Port */
 157        POWER_SUPPLY_TYPE_USB_ACA,      /* Accessory Charger Adapters */
 158};
 159
 160union power_supply_propval {
 161        int intval;
 162        const char *strval;
 163};
 164
 165struct power_supply {
 166        const char *name;
 167        enum power_supply_type type;
 168        enum power_supply_property *properties;
 169        size_t num_properties;
 170
 171        char **supplied_to;
 172        size_t num_supplicants;
 173
 174        char **supplied_from;
 175        size_t num_supplies;
 176#ifdef CONFIG_OF
 177        struct device_node *of_node;
 178#endif
 179
 180        int (*get_property)(struct power_supply *psy,
 181                            enum power_supply_property psp,
 182                            union power_supply_propval *val);
 183        int (*set_property)(struct power_supply *psy,
 184                            enum power_supply_property psp,
 185                            const union power_supply_propval *val);
 186        int (*property_is_writeable)(struct power_supply *psy,
 187                                     enum power_supply_property psp);
 188        void (*external_power_changed)(struct power_supply *psy);
 189        void (*set_charged)(struct power_supply *psy);
 190
 191        /* For APM emulation, think legacy userspace. */
 192        int use_for_apm;
 193
 194        /* private */
 195        struct device *dev;
 196        struct work_struct changed_work;
 197#ifdef CONFIG_THERMAL
 198        struct thermal_zone_device *tzd;
 199        struct thermal_cooling_device *tcd;
 200#endif
 201
 202#ifdef CONFIG_LEDS_TRIGGERS
 203        struct led_trigger *charging_full_trig;
 204        char *charging_full_trig_name;
 205        struct led_trigger *charging_trig;
 206        char *charging_trig_name;
 207        struct led_trigger *full_trig;
 208        char *full_trig_name;
 209        struct led_trigger *online_trig;
 210        char *online_trig_name;
 211        struct led_trigger *charging_blink_full_solid_trig;
 212        char *charging_blink_full_solid_trig_name;
 213#endif
 214};
 215
 216/*
 217 * This is recommended structure to specify static power supply parameters.
 218 * Generic one, parametrizable for different power supplies. Power supply
 219 * class itself does not use it, but that's what implementing most platform
 220 * drivers, should try reuse for consistency.
 221 */
 222
 223struct power_supply_info {
 224        const char *name;
 225        int technology;
 226        int voltage_max_design;
 227        int voltage_min_design;
 228        int charge_full_design;
 229        int charge_empty_design;
 230        int energy_full_design;
 231        int energy_empty_design;
 232        int use_for_apm;
 233};
 234
 235extern struct power_supply *power_supply_get_by_name(const char *name);
 236extern void power_supply_changed(struct power_supply *psy);
 237extern int power_supply_am_i_supplied(struct power_supply *psy);
 238extern int power_supply_set_battery_charged(struct power_supply *psy);
 239
 240#ifdef CONFIG_POWER_SUPPLY
 241extern int power_supply_is_system_supplied(void);
 242#else
 243static inline int power_supply_is_system_supplied(void) { return -ENOSYS; }
 244#endif
 245
 246extern int power_supply_register(struct device *parent,
 247                                 struct power_supply *psy);
 248extern void power_supply_unregister(struct power_supply *psy);
 249extern int power_supply_powers(struct power_supply *psy, struct device *dev);
 250
 251/* For APM emulation, think legacy userspace. */
 252extern struct class *power_supply_class;
 253
 254static inline bool power_supply_is_amp_property(enum power_supply_property psp)
 255{
 256        switch (psp) {
 257        case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
 258        case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN:
 259        case POWER_SUPPLY_PROP_CHARGE_FULL:
 260        case POWER_SUPPLY_PROP_CHARGE_EMPTY:
 261        case POWER_SUPPLY_PROP_CHARGE_NOW:
 262        case POWER_SUPPLY_PROP_CHARGE_AVG:
 263        case POWER_SUPPLY_PROP_CHARGE_COUNTER:
 264        case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT:
 265        case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX:
 266        case POWER_SUPPLY_PROP_CURRENT_MAX:
 267        case POWER_SUPPLY_PROP_CURRENT_NOW:
 268        case POWER_SUPPLY_PROP_CURRENT_AVG:
 269                return 1;
 270        default:
 271                break;
 272        }
 273
 274        return 0;
 275}
 276
 277static inline bool power_supply_is_watt_property(enum power_supply_property psp)
 278{
 279        switch (psp) {
 280        case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
 281        case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN:
 282        case POWER_SUPPLY_PROP_ENERGY_FULL:
 283        case POWER_SUPPLY_PROP_ENERGY_EMPTY:
 284        case POWER_SUPPLY_PROP_ENERGY_NOW:
 285        case POWER_SUPPLY_PROP_ENERGY_AVG:
 286        case POWER_SUPPLY_PROP_VOLTAGE_MAX:
 287        case POWER_SUPPLY_PROP_VOLTAGE_MIN:
 288        case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
 289        case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
 290        case POWER_SUPPLY_PROP_VOLTAGE_NOW:
 291        case POWER_SUPPLY_PROP_VOLTAGE_AVG:
 292        case POWER_SUPPLY_PROP_VOLTAGE_OCV:
 293        case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE:
 294        case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX:
 295        case POWER_SUPPLY_PROP_POWER_NOW:
 296                return 1;
 297        default:
 298                break;
 299        }
 300
 301        return 0;
 302}
 303
 304#endif /* __LINUX_POWER_SUPPLY_H__ */
 305