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/device.h>
  17#include <linux/workqueue.h>
  18#include <linux/leds.h>
  19
  20/*
  21 * All voltages, currents, charges, energies, time and temperatures in uV,
  22 * ÂµA, ÂµAh, ÂµWh, seconds and tenths of degree Celsius unless otherwise
  23 * stated. It's driver's job to convert its raw values to units in which
  24 * this class operates.
  25 */
  26
  27/*
  28 * For systems where the charger determines the maximum battery capacity
  29 * the min and max fields should be used to present these values to user
  30 * space. Unused/unknown fields will not appear in sysfs.
  31 */
  32
  33enum {
  34        POWER_SUPPLY_STATUS_UNKNOWN = 0,
  35        POWER_SUPPLY_STATUS_CHARGING,
  36        POWER_SUPPLY_STATUS_DISCHARGING,
  37        POWER_SUPPLY_STATUS_NOT_CHARGING,
  38        POWER_SUPPLY_STATUS_FULL,
  39};
  40
  41enum {
  42        POWER_SUPPLY_CHARGE_TYPE_UNKNOWN = 0,
  43        POWER_SUPPLY_CHARGE_TYPE_NONE,
  44        POWER_SUPPLY_CHARGE_TYPE_TRICKLE,
  45        POWER_SUPPLY_CHARGE_TYPE_FAST,
  46};
  47
  48enum {
  49        POWER_SUPPLY_HEALTH_UNKNOWN = 0,
  50        POWER_SUPPLY_HEALTH_GOOD,
  51        POWER_SUPPLY_HEALTH_OVERHEAT,
  52        POWER_SUPPLY_HEALTH_DEAD,
  53        POWER_SUPPLY_HEALTH_OVERVOLTAGE,
  54        POWER_SUPPLY_HEALTH_UNSPEC_FAILURE,
  55        POWER_SUPPLY_HEALTH_COLD,
  56};
  57
  58enum {
  59        POWER_SUPPLY_TECHNOLOGY_UNKNOWN = 0,
  60        POWER_SUPPLY_TECHNOLOGY_NiMH,
  61        POWER_SUPPLY_TECHNOLOGY_LION,
  62        POWER_SUPPLY_TECHNOLOGY_LIPO,
  63        POWER_SUPPLY_TECHNOLOGY_LiFe,
  64        POWER_SUPPLY_TECHNOLOGY_NiCd,
  65        POWER_SUPPLY_TECHNOLOGY_LiMn,
  66};
  67
  68enum {
  69        POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN = 0,
  70        POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL,
  71        POWER_SUPPLY_CAPACITY_LEVEL_LOW,
  72        POWER_SUPPLY_CAPACITY_LEVEL_NORMAL,
  73        POWER_SUPPLY_CAPACITY_LEVEL_HIGH,
  74        POWER_SUPPLY_CAPACITY_LEVEL_FULL,
  75};
  76
  77enum {
  78        POWER_SUPPLY_SCOPE_UNKNOWN = 0,
  79        POWER_SUPPLY_SCOPE_SYSTEM,
  80        POWER_SUPPLY_SCOPE_DEVICE,
  81};
  82
  83enum power_supply_property {
  84        /* Properties of type `int' */
  85        POWER_SUPPLY_PROP_STATUS = 0,
  86        POWER_SUPPLY_PROP_CHARGE_TYPE,
  87        POWER_SUPPLY_PROP_HEALTH,
  88        POWER_SUPPLY_PROP_PRESENT,
  89        POWER_SUPPLY_PROP_ONLINE,
  90        POWER_SUPPLY_PROP_TECHNOLOGY,
  91        POWER_SUPPLY_PROP_CYCLE_COUNT,
  92        POWER_SUPPLY_PROP_VOLTAGE_MAX,
  93        POWER_SUPPLY_PROP_VOLTAGE_MIN,
  94        POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
  95        POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
  96        POWER_SUPPLY_PROP_VOLTAGE_NOW,
  97        POWER_SUPPLY_PROP_VOLTAGE_AVG,
  98        POWER_SUPPLY_PROP_CURRENT_MAX,
  99        POWER_SUPPLY_PROP_CURRENT_NOW,
 100        POWER_SUPPLY_PROP_CURRENT_AVG,
 101        POWER_SUPPLY_PROP_POWER_NOW,
 102        POWER_SUPPLY_PROP_POWER_AVG,
 103        POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
 104        POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN,
 105        POWER_SUPPLY_PROP_CHARGE_FULL,
 106        POWER_SUPPLY_PROP_CHARGE_EMPTY,
 107        POWER_SUPPLY_PROP_CHARGE_NOW,
 108        POWER_SUPPLY_PROP_CHARGE_AVG,
 109        POWER_SUPPLY_PROP_CHARGE_COUNTER,
 110        POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
 111        POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN,
 112        POWER_SUPPLY_PROP_ENERGY_FULL,
 113        POWER_SUPPLY_PROP_ENERGY_EMPTY,
 114        POWER_SUPPLY_PROP_ENERGY_NOW,
 115        POWER_SUPPLY_PROP_ENERGY_AVG,
 116        POWER_SUPPLY_PROP_CAPACITY, /* in percents! */
 117        POWER_SUPPLY_PROP_CAPACITY_LEVEL,
 118        POWER_SUPPLY_PROP_TEMP,
 119        POWER_SUPPLY_PROP_TEMP_AMBIENT,
 120        POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
 121        POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
 122        POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
 123        POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
 124        POWER_SUPPLY_PROP_TYPE, /* use power_supply.type instead */
 125        POWER_SUPPLY_PROP_SCOPE,
 126        /* Properties of type `const char *' */
 127        POWER_SUPPLY_PROP_MODEL_NAME,
 128        POWER_SUPPLY_PROP_MANUFACTURER,
 129        POWER_SUPPLY_PROP_SERIAL_NUMBER,
 130};
 131
 132enum power_supply_type {
 133        POWER_SUPPLY_TYPE_UNKNOWN = 0,
 134        POWER_SUPPLY_TYPE_BATTERY,
 135        POWER_SUPPLY_TYPE_UPS,
 136        POWER_SUPPLY_TYPE_MAINS,
 137        POWER_SUPPLY_TYPE_USB,          /* Standard Downstream Port */
 138        POWER_SUPPLY_TYPE_USB_DCP,      /* Dedicated Charging Port */
 139        POWER_SUPPLY_TYPE_USB_CDP,      /* Charging Downstream Port */
 140        POWER_SUPPLY_TYPE_USB_ACA,      /* Accessory Charger Adapters */
 141};
 142
 143union power_supply_propval {
 144        int intval;
 145        const char *strval;
 146};
 147
 148struct power_supply {
 149        const char *name;
 150        enum power_supply_type type;
 151        enum power_supply_property *properties;
 152        size_t num_properties;
 153
 154        char **supplied_to;
 155        size_t num_supplicants;
 156
 157        int (*get_property)(struct power_supply *psy,
 158                            enum power_supply_property psp,
 159                            union power_supply_propval *val);
 160        int (*set_property)(struct power_supply *psy,
 161                            enum power_supply_property psp,
 162                            const union power_supply_propval *val);
 163        int (*property_is_writeable)(struct power_supply *psy,
 164                                     enum power_supply_property psp);
 165        void (*external_power_changed)(struct power_supply *psy);
 166        void (*set_charged)(struct power_supply *psy);
 167
 168        /* For APM emulation, think legacy userspace. */
 169        int use_for_apm;
 170
 171        /* private */
 172        struct device *dev;
 173        struct work_struct changed_work;
 174
 175#ifdef CONFIG_LEDS_TRIGGERS
 176        struct led_trigger *charging_full_trig;
 177        char *charging_full_trig_name;
 178        struct led_trigger *charging_trig;
 179        char *charging_trig_name;
 180        struct led_trigger *full_trig;
 181        char *full_trig_name;
 182        struct led_trigger *online_trig;
 183        char *online_trig_name;
 184        struct led_trigger *charging_blink_full_solid_trig;
 185        char *charging_blink_full_solid_trig_name;
 186#endif
 187};
 188
 189/*
 190 * This is recommended structure to specify static power supply parameters.
 191 * Generic one, parametrizable for different power supplies. Power supply
 192 * class itself does not use it, but that's what implementing most platform
 193 * drivers, should try reuse for consistency.
 194 */
 195
 196struct power_supply_info {
 197        const char *name;
 198        int technology;
 199        int voltage_max_design;
 200        int voltage_min_design;
 201        int charge_full_design;
 202        int charge_empty_design;
 203        int energy_full_design;
 204        int energy_empty_design;
 205        int use_for_apm;
 206};
 207
 208extern struct power_supply *power_supply_get_by_name(char *name);
 209extern void power_supply_changed(struct power_supply *psy);
 210extern int power_supply_am_i_supplied(struct power_supply *psy);
 211extern int power_supply_set_battery_charged(struct power_supply *psy);
 212
 213#if defined(CONFIG_POWER_SUPPLY) || defined(CONFIG_POWER_SUPPLY_MODULE)
 214extern int power_supply_is_system_supplied(void);
 215#else
 216static inline int power_supply_is_system_supplied(void) { return -ENOSYS; }
 217#endif
 218
 219extern int power_supply_register(struct device *parent,
 220                                 struct power_supply *psy);
 221extern void power_supply_unregister(struct power_supply *psy);
 222extern int power_supply_powers(struct power_supply *psy, struct device *dev);
 223
 224/* For APM emulation, think legacy userspace. */
 225extern struct class *power_supply_class;
 226
 227static inline bool power_supply_is_amp_property(enum power_supply_property psp)
 228{
 229        switch (psp) {
 230        case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
 231        case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN:
 232        case POWER_SUPPLY_PROP_CHARGE_FULL:
 233        case POWER_SUPPLY_PROP_CHARGE_EMPTY:
 234        case POWER_SUPPLY_PROP_CHARGE_NOW:
 235        case POWER_SUPPLY_PROP_CHARGE_AVG:
 236        case POWER_SUPPLY_PROP_CHARGE_COUNTER:
 237        case POWER_SUPPLY_PROP_CURRENT_MAX:
 238        case POWER_SUPPLY_PROP_CURRENT_NOW:
 239        case POWER_SUPPLY_PROP_CURRENT_AVG:
 240                return 1;
 241        default:
 242                break;
 243        }
 244
 245        return 0;
 246}
 247
 248static inline bool power_supply_is_watt_property(enum power_supply_property psp)
 249{
 250        switch (psp) {
 251        case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
 252        case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN:
 253        case POWER_SUPPLY_PROP_ENERGY_FULL:
 254        case POWER_SUPPLY_PROP_ENERGY_EMPTY:
 255        case POWER_SUPPLY_PROP_ENERGY_NOW:
 256        case POWER_SUPPLY_PROP_ENERGY_AVG:
 257        case POWER_SUPPLY_PROP_VOLTAGE_MAX:
 258        case POWER_SUPPLY_PROP_VOLTAGE_MIN:
 259        case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
 260        case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
 261        case POWER_SUPPLY_PROP_VOLTAGE_NOW:
 262        case POWER_SUPPLY_PROP_VOLTAGE_AVG:
 263        case POWER_SUPPLY_PROP_POWER_NOW:
 264                return 1;
 265        default:
 266                break;
 267        }
 268
 269        return 0;
 270}
 271
 272#endif /* __LINUX_POWER_SUPPLY_H__ */
 273