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
  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
  33 enum {
  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
  41 enum {
  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
  48 enum {
  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
  58 enum {
  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
  68 enum {
  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
  77 enum power_supply_property {
  78         /* Properties of type `int' */
  79         POWER_SUPPLY_PROP_STATUS = 0,
  80         POWER_SUPPLY_PROP_CHARGE_TYPE,
  81         POWER_SUPPLY_PROP_HEALTH,
  82         POWER_SUPPLY_PROP_PRESENT,
  83         POWER_SUPPLY_PROP_ONLINE,
  84         POWER_SUPPLY_PROP_TECHNOLOGY,
  85         POWER_SUPPLY_PROP_CYCLE_COUNT,
  86         POWER_SUPPLY_PROP_VOLTAGE_MAX,
  87         POWER_SUPPLY_PROP_VOLTAGE_MIN,
  88         POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
  89         POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
  90         POWER_SUPPLY_PROP_VOLTAGE_NOW,
  91         POWER_SUPPLY_PROP_VOLTAGE_AVG,
  92         POWER_SUPPLY_PROP_CURRENT_MAX,
  93         POWER_SUPPLY_PROP_CURRENT_NOW,
  94         POWER_SUPPLY_PROP_CURRENT_AVG,
  95         POWER_SUPPLY_PROP_POWER_NOW,
  96         POWER_SUPPLY_PROP_POWER_AVG,
  97         POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
  98         POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN,
  99         POWER_SUPPLY_PROP_CHARGE_FULL,
 100         POWER_SUPPLY_PROP_CHARGE_EMPTY,
 101         POWER_SUPPLY_PROP_CHARGE_NOW,
 102         POWER_SUPPLY_PROP_CHARGE_AVG,
 103         POWER_SUPPLY_PROP_CHARGE_COUNTER,
 104         POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
 105         POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN,
 106         POWER_SUPPLY_PROP_ENERGY_FULL,
 107         POWER_SUPPLY_PROP_ENERGY_EMPTY,
 108         POWER_SUPPLY_PROP_ENERGY_NOW,
 109         POWER_SUPPLY_PROP_ENERGY_AVG,
 110         POWER_SUPPLY_PROP_CAPACITY, /* in percents! */
 111         POWER_SUPPLY_PROP_CAPACITY_LEVEL,
 112         POWER_SUPPLY_PROP_TEMP,
 113         POWER_SUPPLY_PROP_TEMP_AMBIENT,
 114         POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
 115         POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
 116         POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
 117         POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
 118         POWER_SUPPLY_PROP_TYPE, /* use power_supply.type instead */
 119         /* Properties of type `const char *' */
 120         POWER_SUPPLY_PROP_MODEL_NAME,
 121         POWER_SUPPLY_PROP_MANUFACTURER,
 122         POWER_SUPPLY_PROP_SERIAL_NUMBER,
 123 };
 124
 125 enum power_supply_type {
 126         POWER_SUPPLY_TYPE_BATTERY = 0,
 127         POWER_SUPPLY_TYPE_UPS,
 128         POWER_SUPPLY_TYPE_MAINS,
 129         POWER_SUPPLY_TYPE_USB,          /* Standard Downstream Port */
 130         POWER_SUPPLY_TYPE_USB_DCP,      /* Dedicated Charging Port */
 131         POWER_SUPPLY_TYPE_USB_CDP,      /* Charging Downstream Port */
 132         POWER_SUPPLY_TYPE_USB_ACA,      /* Accessory Charger Adapters */
 133 };
 134
 135 union power_supply_propval {
 136         int intval;
 137         const char *strval;
 138 };
 139
 140 struct power_supply {
 141         const char *name;
 142         enum power_supply_type type;
 143         enum power_supply_property *properties;
 144         size_t num_properties;
 145
 146         char **supplied_to;
 147         size_t num_supplicants;
 148
 149         int (*get_property)(struct power_supply *psy,
 150                             enum power_supply_property psp,
 151                             union power_supply_propval *val);
 152         int (*set_property)(struct power_supply *psy,
 153                             enum power_supply_property psp,
 154                             const union power_supply_propval *val);
 155         int (*property_is_writeable)(struct power_supply *psy,
 156                                      enum power_supply_property psp);
 157         void (*external_power_changed)(struct power_supply *psy);
 158         void (*set_charged)(struct power_supply *psy);
 159
 160         /* For APM emulation, think legacy userspace. */
 161         int use_for_apm;
 162
 163         /* private */
 164         struct device *dev;
 165         struct work_struct changed_work;
 166
 167 #ifdef CONFIG_LEDS_TRIGGERS
 168         struct led_trigger *charging_full_trig;
 169         char *charging_full_trig_name;
 170         struct led_trigger *charging_trig;
 171         char *charging_trig_name;
 172         struct led_trigger *full_trig;
 173         char *full_trig_name;
 174         struct led_trigger *online_trig;
 175         char *online_trig_name;
 176         struct led_trigger *charging_blink_full_solid_trig;
 177         char *charging_blink_full_solid_trig_name;
 178 #endif
 179 };
 180
 181 /*
 182  * This is recommended structure to specify static power supply parameters.
 183  * Generic one, parametrizable for different power supplies. Power supply
 184  * class itself does not use it, but that's what implementing most platform
 185  * drivers, should try reuse for consistency.
 186  */
 187
 188 struct power_supply_info {
 189         const char *name;
 190         int technology;
 191         int voltage_max_design;
 192         int voltage_min_design;
 193         int charge_full_design;
 194         int charge_empty_design;
 195         int energy_full_design;
 196         int energy_empty_design;
 197         int use_for_apm;
 198 };
 199
 200 extern struct power_supply *power_supply_get_by_name(char *name);
 201 extern void power_supply_changed(struct power_supply *psy);
 202 extern int power_supply_am_i_supplied(struct power_supply *psy);
 203 extern int power_supply_set_battery_charged(struct power_supply *psy);
 204
 205 #if defined(CONFIG_POWER_SUPPLY) || defined(CONFIG_POWER_SUPPLY_MODULE)
 206 extern int power_supply_is_system_supplied(void);
 207 #else
 208 static inline int power_supply_is_system_supplied(void) { return -ENOSYS; }
 209 #endif
 210
 211 extern int power_supply_register(struct device *parent,
 212                                  struct power_supply *psy);
 213 extern void power_supply_unregister(struct power_supply *psy);
 214
 215 /* For APM emulation, think legacy userspace. */
 216 extern struct class *power_supply_class;
 217
 218 static inline bool power_supply_is_amp_property(enum power_supply_property psp)
 219 {
 220         switch (psp) {
 221         case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
 222         case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN:
 223         case POWER_SUPPLY_PROP_CHARGE_FULL:
 224         case POWER_SUPPLY_PROP_CHARGE_EMPTY:
 225         case POWER_SUPPLY_PROP_CHARGE_NOW:
 226         case POWER_SUPPLY_PROP_CHARGE_AVG:
 227         case POWER_SUPPLY_PROP_CHARGE_COUNTER:
 228         case POWER_SUPPLY_PROP_CURRENT_MAX:
 229         case POWER_SUPPLY_PROP_CURRENT_NOW:
 230         case POWER_SUPPLY_PROP_CURRENT_AVG:
 231                 return 1;
 232         default:
 233                 break;
 234         }
 235
 236         return 0;
 237 }
 238
 239 static inline bool power_supply_is_watt_property(enum power_supply_property psp)
 240 {
 241         switch (psp) {
 242         case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
 243         case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN:
 244         case POWER_SUPPLY_PROP_ENERGY_FULL:
 245         case POWER_SUPPLY_PROP_ENERGY_EMPTY:
 246         case POWER_SUPPLY_PROP_ENERGY_NOW:
 247         case POWER_SUPPLY_PROP_ENERGY_AVG:
 248         case POWER_SUPPLY_PROP_VOLTAGE_MAX:
 249         case POWER_SUPPLY_PROP_VOLTAGE_MIN:
 250         case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
 251         case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
 252         case POWER_SUPPLY_PROP_VOLTAGE_NOW:
 253         case POWER_SUPPLY_PROP_VOLTAGE_AVG:
 254         case POWER_SUPPLY_PROP_POWER_NOW:
 255                 return 1;
 256         default:
 257                 break;
 258         }
 259
 260         return 0;
 261 }
 262
 263 #endif /* __LINUX_POWER_SUPPLY_H__ */