linux/include/linux/power_supply.h
<<
>>
Prefs
   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};
  58
  59enum {
  60        POWER_SUPPLY_TECHNOLOGY_UNKNOWN = 0,
  61        POWER_SUPPLY_TECHNOLOGY_NiMH,
  62        POWER_SUPPLY_TECHNOLOGY_LION,
  63        POWER_SUPPLY_TECHNOLOGY_LIPO,
  64        POWER_SUPPLY_TECHNOLOGY_LiFe,
  65        POWER_SUPPLY_TECHNOLOGY_NiCd,
  66        POWER_SUPPLY_TECHNOLOGY_LiMn,
  67};
  68
  69enum {
  70        POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN = 0,
  71        POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL,
  72        POWER_SUPPLY_CAPACITY_LEVEL_LOW,
  73        POWER_SUPPLY_CAPACITY_LEVEL_NORMAL,
  74        POWER_SUPPLY_CAPACITY_LEVEL_HIGH,
  75        POWER_SUPPLY_CAPACITY_LEVEL_FULL,
  76};
  77
  78enum {
  79        POWER_SUPPLY_SCOPE_UNKNOWN = 0,
  80        POWER_SUPPLY_SCOPE_SYSTEM,
  81        POWER_SUPPLY_SCOPE_DEVICE,
  82};
  83
  84enum power_supply_property {
  85        /* Properties of type `int' */
  86        POWER_SUPPLY_PROP_STATUS = 0,
  87        POWER_SUPPLY_PROP_CHARGE_TYPE,
  88        POWER_SUPPLY_PROP_HEALTH,
  89        POWER_SUPPLY_PROP_PRESENT,
  90        POWER_SUPPLY_PROP_ONLINE,
  91        POWER_SUPPLY_PROP_TECHNOLOGY,
  92        POWER_SUPPLY_PROP_CYCLE_COUNT,
  93        POWER_SUPPLY_PROP_VOLTAGE_MAX,
  94        POWER_SUPPLY_PROP_VOLTAGE_MIN,
  95        POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
  96        POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
  97        POWER_SUPPLY_PROP_VOLTAGE_NOW,
  98        POWER_SUPPLY_PROP_VOLTAGE_AVG,
  99        POWER_SUPPLY_PROP_VOLTAGE_OCV,
 100        POWER_SUPPLY_PROP_CURRENT_MAX,
 101        POWER_SUPPLY_PROP_CURRENT_NOW,
 102        POWER_SUPPLY_PROP_CURRENT_AVG,
 103        POWER_SUPPLY_PROP_POWER_NOW,
 104        POWER_SUPPLY_PROP_POWER_AVG,
 105        POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
 106        POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN,
 107        POWER_SUPPLY_PROP_CHARGE_FULL,
 108        POWER_SUPPLY_PROP_CHARGE_EMPTY,
 109        POWER_SUPPLY_PROP_CHARGE_NOW,
 110        POWER_SUPPLY_PROP_CHARGE_AVG,
 111        POWER_SUPPLY_PROP_CHARGE_COUNTER,
 112        POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT,
 113        POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE,
 114        POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
 115        POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN,
 116        POWER_SUPPLY_PROP_ENERGY_FULL,
 117        POWER_SUPPLY_PROP_ENERGY_EMPTY,
 118        POWER_SUPPLY_PROP_ENERGY_NOW,
 119        POWER_SUPPLY_PROP_ENERGY_AVG,
 120        POWER_SUPPLY_PROP_CAPACITY, /* in percents! */
 121        POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN, /* in percents! */
 122        POWER_SUPPLY_PROP_CAPACITY_ALERT_MAX, /* in percents! */
 123        POWER_SUPPLY_PROP_CAPACITY_LEVEL,
 124        POWER_SUPPLY_PROP_TEMP,
 125        POWER_SUPPLY_PROP_TEMP_ALERT_MIN,
 126        POWER_SUPPLY_PROP_TEMP_ALERT_MAX,
 127        POWER_SUPPLY_PROP_TEMP_AMBIENT,
 128        POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MIN,
 129        POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MAX,
 130        POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
 131        POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
 132        POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
 133        POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
 134        POWER_SUPPLY_PROP_TYPE, /* use power_supply.type instead */
 135        POWER_SUPPLY_PROP_SCOPE,
 136        /* Properties of type `const char *' */
 137        POWER_SUPPLY_PROP_MODEL_NAME,
 138        POWER_SUPPLY_PROP_MANUFACTURER,
 139        POWER_SUPPLY_PROP_SERIAL_NUMBER,
 140};
 141
 142enum power_supply_type {
 143        POWER_SUPPLY_TYPE_UNKNOWN = 0,
 144        POWER_SUPPLY_TYPE_BATTERY,
 145        POWER_SUPPLY_TYPE_UPS,
 146        POWER_SUPPLY_TYPE_MAINS,
 147        POWER_SUPPLY_TYPE_USB,          /* Standard Downstream Port */
 148        POWER_SUPPLY_TYPE_USB_DCP,      /* Dedicated Charging Port */
 149        POWER_SUPPLY_TYPE_USB_CDP,      /* Charging Downstream Port */
 150        POWER_SUPPLY_TYPE_USB_ACA,      /* Accessory Charger Adapters */
 151};
 152
 153union power_supply_propval {
 154        int intval;
 155        const char *strval;
 156};
 157
 158struct power_supply {
 159        const char *name;
 160        enum power_supply_type type;
 161        enum power_supply_property *properties;
 162        size_t num_properties;
 163
 164        char **supplied_to;
 165        size_t num_supplicants;
 166
 167        int (*get_property)(struct power_supply *psy,
 168                            enum power_supply_property psp,
 169                            union power_supply_propval *val);
 170        int (*set_property)(struct power_supply *psy,
 171                            enum power_supply_property psp,
 172                            const union power_supply_propval *val);
 173        int (*property_is_writeable)(struct power_supply *psy,
 174                                     enum power_supply_property psp);
 175        void (*external_power_changed)(struct power_supply *psy);
 176        void (*set_charged)(struct power_supply *psy);
 177
 178        /* For APM emulation, think legacy userspace. */
 179        int use_for_apm;
 180
 181        /* private */
 182        struct device *dev;
 183        struct work_struct changed_work;
 184#ifdef CONFIG_THERMAL
 185        struct thermal_zone_device *tzd;
 186#endif
 187
 188#ifdef CONFIG_LEDS_TRIGGERS
 189        struct led_trigger *charging_full_trig;
 190        char *charging_full_trig_name;
 191        struct led_trigger *charging_trig;
 192        char *charging_trig_name;
 193        struct led_trigger *full_trig;
 194        char *full_trig_name;
 195        struct led_trigger *online_trig;
 196        char *online_trig_name;
 197        struct led_trigger *charging_blink_full_solid_trig;
 198        char *charging_blink_full_solid_trig_name;
 199#endif
 200};
 201
 202/*
 203 * This is recommended structure to specify static power supply parameters.
 204 * Generic one, parametrizable for different power supplies. Power supply
 205 * class itself does not use it, but that's what implementing most platform
 206 * drivers, should try reuse for consistency.
 207 */
 208
 209struct power_supply_info {
 210        const char *name;
 211        int technology;
 212        int voltage_max_design;
 213        int voltage_min_design;
 214        int charge_full_design;
 215        int charge_empty_design;
 216        int energy_full_design;
 217        int energy_empty_design;
 218        int use_for_apm;
 219};
 220
 221extern struct power_supply *power_supply_get_by_name(char *name);
 222extern void power_supply_changed(struct power_supply *psy);
 223extern int power_supply_am_i_supplied(struct power_supply *psy);
 224extern int power_supply_set_battery_charged(struct power_supply *psy);
 225
 226#ifdef CONFIG_POWER_SUPPLY
 227extern int power_supply_is_system_supplied(void);
 228#else
 229static inline int power_supply_is_system_supplied(void) { return -ENOSYS; }
 230#endif
 231
 232extern int power_supply_register(struct device *parent,
 233                                 struct power_supply *psy);
 234extern void power_supply_unregister(struct power_supply *psy);
 235extern int power_supply_powers(struct power_supply *psy, struct device *dev);
 236
 237/* For APM emulation, think legacy userspace. */
 238extern struct class *power_supply_class;
 239
 240static inline bool power_supply_is_amp_property(enum power_supply_property psp)
 241{
 242        switch (psp) {
 243        case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
 244        case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN:
 245        case POWER_SUPPLY_PROP_CHARGE_FULL:
 246        case POWER_SUPPLY_PROP_CHARGE_EMPTY:
 247        case POWER_SUPPLY_PROP_CHARGE_NOW:
 248        case POWER_SUPPLY_PROP_CHARGE_AVG:
 249        case POWER_SUPPLY_PROP_CHARGE_COUNTER:
 250        case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT:
 251        case POWER_SUPPLY_PROP_CURRENT_MAX:
 252        case POWER_SUPPLY_PROP_CURRENT_NOW:
 253        case POWER_SUPPLY_PROP_CURRENT_AVG:
 254                return 1;
 255        default:
 256                break;
 257        }
 258
 259        return 0;
 260}
 261
 262static inline bool power_supply_is_watt_property(enum power_supply_property psp)
 263{
 264        switch (psp) {
 265        case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
 266        case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN:
 267        case POWER_SUPPLY_PROP_ENERGY_FULL:
 268        case POWER_SUPPLY_PROP_ENERGY_EMPTY:
 269        case POWER_SUPPLY_PROP_ENERGY_NOW:
 270        case POWER_SUPPLY_PROP_ENERGY_AVG:
 271        case POWER_SUPPLY_PROP_VOLTAGE_MAX:
 272        case POWER_SUPPLY_PROP_VOLTAGE_MIN:
 273        case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
 274        case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
 275        case POWER_SUPPLY_PROP_VOLTAGE_NOW:
 276        case POWER_SUPPLY_PROP_VOLTAGE_AVG:
 277        case POWER_SUPPLY_PROP_VOLTAGE_OCV:
 278        case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE:
 279        case POWER_SUPPLY_PROP_POWER_NOW:
 280                return 1;
 281        default:
 282                break;
 283        }
 284
 285        return 0;
 286}
 287
 288#endif /* __LINUX_POWER_SUPPLY_H__ */
 289
lxr.linux.no kindly hosted by Redpill Linpro AS, provider of Linux consulting and operations services since 1995.