1 /* 2 * Universal power supply monitor class 3 * 4 * Copyright © 2007 Anton Vorontsov <[email protected]> 5 * Copyright © 2004 Szabolcs Gyurko 6 * Copyright © 2003 Ian Molton <[email protected]> 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_HEALTH_UNKNOWN = 0, 43 POWER_SUPPLY_HEALTH_GOOD, 44 POWER_SUPPLY_HEALTH_OVERHEAT, 45 POWER_SUPPLY_HEALTH_DEAD, 46 POWER_SUPPLY_HEALTH_OVERVOLTAGE, 47 POWER_SUPPLY_HEALTH_UNSPEC_FAILURE, 48 POWER_SUPPLY_HEALTH_COLD, 49 }; 50 51 enum { 52 POWER_SUPPLY_TECHNOLOGY_UNKNOWN = 0, 53 POWER_SUPPLY_TECHNOLOGY_NiMH, 54 POWER_SUPPLY_TECHNOLOGY_LION, 55 POWER_SUPPLY_TECHNOLOGY_LIPO, 56 POWER_SUPPLY_TECHNOLOGY_LiFe, 57 POWER_SUPPLY_TECHNOLOGY_NiCd, 58 POWER_SUPPLY_TECHNOLOGY_LiMn, 59 }; 60 61 enum power_supply_property { 62 /* Properties of type `int' */ 63 POWER_SUPPLY_PROP_STATUS = 0, 64 POWER_SUPPLY_PROP_HEALTH, 65 POWER_SUPPLY_PROP_PRESENT, 66 POWER_SUPPLY_PROP_ONLINE, 67 POWER_SUPPLY_PROP_TECHNOLOGY, 68 POWER_SUPPLY_PROP_VOLTAGE_MAX, 69 POWER_SUPPLY_PROP_VOLTAGE_MIN, 70 POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN, 71 POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN, 72 POWER_SUPPLY_PROP_VOLTAGE_NOW, 73 POWER_SUPPLY_PROP_VOLTAGE_AVG, 74 POWER_SUPPLY_PROP_CURRENT_NOW, 75 POWER_SUPPLY_PROP_CURRENT_AVG, 76 POWER_SUPPLY_PROP_POWER_NOW, 77 POWER_SUPPLY_PROP_POWER_AVG, 78 POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN, 79 POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN, 80 POWER_SUPPLY_PROP_CHARGE_FULL, 81 POWER_SUPPLY_PROP_CHARGE_EMPTY, 82 POWER_SUPPLY_PROP_CHARGE_NOW, 83 POWER_SUPPLY_PROP_CHARGE_AVG, 84 POWER_SUPPLY_PROP_CHARGE_COUNTER, 85 POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN, 86 POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN, 87 POWER_SUPPLY_PROP_ENERGY_FULL, 88 POWER_SUPPLY_PROP_ENERGY_EMPTY, 89 POWER_SUPPLY_PROP_ENERGY_NOW, 90 POWER_SUPPLY_PROP_ENERGY_AVG, 91 POWER_SUPPLY_PROP_CAPACITY, /* in percents! */ 92 POWER_SUPPLY_PROP_TEMP, 93 POWER_SUPPLY_PROP_TEMP_AMBIENT, 94 POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW, 95 POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG, 96 POWER_SUPPLY_PROP_TIME_TO_FULL_NOW, 97 POWER_SUPPLY_PROP_TIME_TO_FULL_AVG, 98 /* Properties of type `const char *' */ 99 POWER_SUPPLY_PROP_MODEL_NAME, 100 POWER_SUPPLY_PROP_MANUFACTURER, 101 POWER_SUPPLY_PROP_SERIAL_NUMBER, 102 }; 103 104 enum power_supply_type { 105 POWER_SUPPLY_TYPE_BATTERY = 0, 106 POWER_SUPPLY_TYPE_UPS, 107 POWER_SUPPLY_TYPE_MAINS, 108 POWER_SUPPLY_TYPE_USB, 109 }; 110 111 union power_supply_propval { 112 int intval; 113 const char *strval; 114 }; 115 116 struct power_supply { 117 const char *name; 118 enum power_supply_type type; 119 enum power_supply_property *properties; 120 size_t num_properties; 121 122 char **supplied_to; 123 size_t num_supplicants; 124 125 int (*get_property)(struct power_supply *psy, 126 enum power_supply_property psp, 127 union power_supply_propval *val); 128 void (*external_power_changed)(struct power_supply *psy); 129 130 /* For APM emulation, think legacy userspace. */ 131 int use_for_apm; 132 133 /* private */ 134 struct device *dev; 135 struct work_struct changed_work; 136 137 #ifdef CONFIG_LEDS_TRIGGERS 138 struct led_trigger *charging_full_trig; 139 char *charging_full_trig_name; 140 struct led_trigger *charging_trig; 141 char *charging_trig_name; 142 struct led_trigger *full_trig; 143 char *full_trig_name; 144 struct led_trigger *online_trig; 145 char *online_trig_name; 146 #endif 147 }; 148 149 /* 150 * This is recommended structure to specify static power supply parameters. 151 * Generic one, parametrizable for different power supplies. Power supply 152 * class itself does not use it, but that's what implementing most platform 153 * drivers, should try reuse for consistency. 154 */ 155 156 struct power_supply_info { 157 const char *name; 158 int technology; 159 int voltage_max_design; 160 int voltage_min_design; 161 int charge_full_design; 162 int charge_empty_design; 163 int energy_full_design; 164 int energy_empty_design; 165 int use_for_apm; 166 }; 167 168 extern void power_supply_changed(struct power_supply *psy); 169 extern int power_supply_am_i_supplied(struct power_supply *psy); 170 171 #if defined(CONFIG_POWER_SUPPLY) || defined(CONFIG_POWER_SUPPLY_MODULE) 172 extern int power_supply_is_system_supplied(void); 173 #else 174 static inline int power_supply_is_system_supplied(void) { return -ENOSYS; } 175 #endif 176 177 extern int power_supply_register(struct device *parent, 178 struct power_supply *psy); 179 extern void power_supply_unregister(struct power_supply *psy); 180 181 /* For APM emulation, think legacy userspace. */ 182 extern struct class *power_supply_class; 183 184 #endif /* __LINUX_POWER_SUPPLY_H__ */ 185