[linux-2.6-block.git] / include / linux / power_supply.h

/*
 *  Universal power supply monitor class
 *
 *  Copyright © 2007  Anton Vorontsov <cbou@mail.ru>
 *  Copyright © 2004  Szabolcs Gyurko
 *  Copyright © 2003  Ian Molton <spyro@f2s.com>
 *
 *  Modified: 2004, Oct     Szabolcs Gyurko
 *
 *  You may use this code as per GPL version 2
 */

#ifndef __LINUX_POWER_SUPPLY_H__
#define __LINUX_POWER_SUPPLY_H__

#include <linux/device.h>
#include <linux/workqueue.h>
#include <linux/leds.h>

/*
 * All voltages, currents, charges, energies, time and temperatures in uV,
 * µA, µAh, µWh, seconds and tenths of degree Celsius unless otherwise
 * stated. It's driver's job to convert its raw values to units in which
 * this class operates.
 */

/*
 * For systems where the charger determines the maximum battery capacity
 * the min and max fields should be used to present these values to user
 * space. Unused/unknown fields will not appear in sysfs.
 */

enum {
	POWER_SUPPLY_STATUS_UNKNOWN = 0,
	POWER_SUPPLY_STATUS_CHARGING,
	POWER_SUPPLY_STATUS_DISCHARGING,
	POWER_SUPPLY_STATUS_NOT_CHARGING,
	POWER_SUPPLY_STATUS_FULL,
};

enum {
	POWER_SUPPLY_CHARGE_TYPE_UNKNOWN = 0,
	POWER_SUPPLY_CHARGE_TYPE_NONE,
	POWER_SUPPLY_CHARGE_TYPE_TRICKLE,
	POWER_SUPPLY_CHARGE_TYPE_FAST,
};

enum {
	POWER_SUPPLY_HEALTH_UNKNOWN = 0,
	POWER_SUPPLY_HEALTH_GOOD,
	POWER_SUPPLY_HEALTH_OVERHEAT,
	POWER_SUPPLY_HEALTH_DEAD,
	POWER_SUPPLY_HEALTH_OVERVOLTAGE,
	POWER_SUPPLY_HEALTH_UNSPEC_FAILURE,
	POWER_SUPPLY_HEALTH_COLD,
};

enum {
	POWER_SUPPLY_TECHNOLOGY_UNKNOWN = 0,
	POWER_SUPPLY_TECHNOLOGY_NiMH,
	POWER_SUPPLY_TECHNOLOGY_LION,
	POWER_SUPPLY_TECHNOLOGY_LIPO,
	POWER_SUPPLY_TECHNOLOGY_LiFe,
	POWER_SUPPLY_TECHNOLOGY_NiCd,
	POWER_SUPPLY_TECHNOLOGY_LiMn,
};

enum {
	POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN = 0,
	POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL,
	POWER_SUPPLY_CAPACITY_LEVEL_LOW,
	POWER_SUPPLY_CAPACITY_LEVEL_NORMAL,
	POWER_SUPPLY_CAPACITY_LEVEL_HIGH,
	POWER_SUPPLY_CAPACITY_LEVEL_FULL,
};

enum power_supply_property {
	/* Properties of type `int' */
	POWER_SUPPLY_PROP_STATUS = 0,
	POWER_SUPPLY_PROP_CHARGE_TYPE,
	POWER_SUPPLY_PROP_HEALTH,
	POWER_SUPPLY_PROP_PRESENT,
	POWER_SUPPLY_PROP_ONLINE,
	POWER_SUPPLY_PROP_TECHNOLOGY,
	POWER_SUPPLY_PROP_CYCLE_COUNT,
	POWER_SUPPLY_PROP_VOLTAGE_MAX,
	POWER_SUPPLY_PROP_VOLTAGE_MIN,
	POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
	POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
	POWER_SUPPLY_PROP_VOLTAGE_NOW,
	POWER_SUPPLY_PROP_VOLTAGE_AVG,
	POWER_SUPPLY_PROP_CURRENT_NOW,
	POWER_SUPPLY_PROP_CURRENT_AVG,
	POWER_SUPPLY_PROP_POWER_NOW,
	POWER_SUPPLY_PROP_POWER_AVG,
	POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
	POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN,
	POWER_SUPPLY_PROP_CHARGE_FULL,
	POWER_SUPPLY_PROP_CHARGE_EMPTY,
	POWER_SUPPLY_PROP_CHARGE_NOW,
	POWER_SUPPLY_PROP_CHARGE_AVG,
	POWER_SUPPLY_PROP_CHARGE_COUNTER,
	POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
	POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN,
	POWER_SUPPLY_PROP_ENERGY_FULL,
	POWER_SUPPLY_PROP_ENERGY_EMPTY,
	POWER_SUPPLY_PROP_ENERGY_NOW,
	POWER_SUPPLY_PROP_ENERGY_AVG,
	POWER_SUPPLY_PROP_CAPACITY, /* in percents! */
	POWER_SUPPLY_PROP_CAPACITY_LEVEL,
	POWER_SUPPLY_PROP_TEMP,
	POWER_SUPPLY_PROP_TEMP_AMBIENT,
	POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
	POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
	POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
	POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
	/* Properties of type `const char *' */
	POWER_SUPPLY_PROP_MODEL_NAME,
	POWER_SUPPLY_PROP_MANUFACTURER,
	POWER_SUPPLY_PROP_SERIAL_NUMBER,
};

enum power_supply_type {
	POWER_SUPPLY_TYPE_BATTERY = 0,
	POWER_SUPPLY_TYPE_UPS,
	POWER_SUPPLY_TYPE_MAINS,
	POWER_SUPPLY_TYPE_USB,
};

union power_supply_propval {
	int intval;
	const char *strval;
};

struct power_supply {
	const char *name;
	enum power_supply_type type;
	enum power_supply_property *properties;
	size_t num_properties;

	char **supplied_to;
	size_t num_supplicants;

	int (*get_property)(struct power_supply *psy,
			    enum power_supply_property psp,
			    union power_supply_propval *val);
	void (*external_power_changed)(struct power_supply *psy);
	void (*set_charged)(struct power_supply *psy);

	/* For APM emulation, think legacy userspace. */
	int use_for_apm;

	/* private */
	struct device *dev;
	struct work_struct changed_work;

#ifdef CONFIG_LEDS_TRIGGERS
	struct led_trigger *charging_full_trig;
	char *charging_full_trig_name;
	struct led_trigger *charging_trig;
	char *charging_trig_name;
	struct led_trigger *full_trig;
	char *full_trig_name;
	struct led_trigger *online_trig;
	char *online_trig_name;
#endif
};

/*
 * This is recommended structure to specify static power supply parameters.
 * Generic one, parametrizable for different power supplies. Power supply
 * class itself does not use it, but that's what implementing most platform
 * drivers, should try reuse for consistency.
 */

struct power_supply_info {
	const char *name;
	int technology;
	int voltage_max_design;
	int voltage_min_design;
	int charge_full_design;
	int charge_empty_design;
	int energy_full_design;
	int energy_empty_design;
	int use_for_apm;
};

extern struct power_supply *power_supply_get_by_name(char *name);
extern void power_supply_changed(struct power_supply *psy);
extern int power_supply_am_i_supplied(struct power_supply *psy);
extern int power_supply_set_battery_charged(struct power_supply *psy);

#if defined(CONFIG_POWER_SUPPLY) || defined(CONFIG_POWER_SUPPLY_MODULE)
extern int power_supply_is_system_supplied(void);
#else
static inline int power_supply_is_system_supplied(void) { return -ENOSYS; }
#endif

extern int power_supply_register(struct device *parent,
				 struct power_supply *psy);
extern void power_supply_unregister(struct power_supply *psy);

/* For APM emulation, think legacy userspace. */
extern struct class *power_supply_class;

#endif /* __LINUX_POWER_SUPPLY_H__ */
Commit	Line	Data
4a11b59d AV	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
ee8076ed AS	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
4a11b59d AV	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,
7e386e6e	55	POWER_SUPPLY_HEALTH_COLD,
4a11b59d AV	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,
c7cc930f	65	POWER_SUPPLY_TECHNOLOGY_LiMn,
4a11b59d AV	66	};
4a11b59d AV	67
b294a290 AS	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
4a11b59d AV	77	enum power_supply_property {
	78	/* Properties of type `int' */
	79	POWER_SUPPLY_PROP_STATUS = 0,
ee8076ed	80	POWER_SUPPLY_PROP_CHARGE_TYPE,
4a11b59d AV	81	POWER_SUPPLY_PROP_HEALTH,
	82	POWER_SUPPLY_PROP_PRESENT,
	83	POWER_SUPPLY_PROP_ONLINE,
	84	POWER_SUPPLY_PROP_TECHNOLOGY,
c955fe8e	85	POWER_SUPPLY_PROP_CYCLE_COUNT,
c7cc930f DB	86	POWER_SUPPLY_PROP_VOLTAGE_MAX,
c7cc930f DB	87	POWER_SUPPLY_PROP_VOLTAGE_MIN,
4a11b59d AV	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_NOW,
	93	POWER_SUPPLY_PROP_CURRENT_AVG,
7faa144a AS	94	POWER_SUPPLY_PROP_POWER_NOW,
7faa144a AS	95	POWER_SUPPLY_PROP_POWER_AVG,
4a11b59d AV	96	POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
	97	POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN,
	98	POWER_SUPPLY_PROP_CHARGE_FULL,
	99	POWER_SUPPLY_PROP_CHARGE_EMPTY,
	100	POWER_SUPPLY_PROP_CHARGE_NOW,
	101	POWER_SUPPLY_PROP_CHARGE_AVG,
8e552c36	102	POWER_SUPPLY_PROP_CHARGE_COUNTER,
4a11b59d AV	103	POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
	104	POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN,
	105	POWER_SUPPLY_PROP_ENERGY_FULL,
	106	POWER_SUPPLY_PROP_ENERGY_EMPTY,
	107	POWER_SUPPLY_PROP_ENERGY_NOW,
	108	POWER_SUPPLY_PROP_ENERGY_AVG,
	109	POWER_SUPPLY_PROP_CAPACITY, /* in percents! */
b294a290	110	POWER_SUPPLY_PROP_CAPACITY_LEVEL,
4a11b59d AV	111	POWER_SUPPLY_PROP_TEMP,
	112	POWER_SUPPLY_PROP_TEMP_AMBIENT,
	113	POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
	114	POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
	115	POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
	116	POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
	117	/* Properties of type `const char ' /
	118	POWER_SUPPLY_PROP_MODEL_NAME,
	119	POWER_SUPPLY_PROP_MANUFACTURER,
7c2670bb	120	POWER_SUPPLY_PROP_SERIAL_NUMBER,
4a11b59d AV	121	};
	122
	123	enum power_supply_type {
	124	POWER_SUPPLY_TYPE_BATTERY = 0,
	125	POWER_SUPPLY_TYPE_UPS,
	126	POWER_SUPPLY_TYPE_MAINS,
	127	POWER_SUPPLY_TYPE_USB,
	128	};
	129
	130	union power_supply_propval {
	131	int intval;
	132	const char *strval;
	133	};
	134
	135	struct power_supply {
	136	const char *name;
	137	enum power_supply_type type;
	138	enum power_supply_property *properties;
	139	size_t num_properties;
	140
	141	char **supplied_to;
	142	size_t num_supplicants;
	143
	144	int (get_property)(struct power_supply psy,
	145	enum power_supply_property psp,
	146	union power_supply_propval *val);
	147	void (external_power_changed)(struct power_supply psy);
e5f5ccb6	148	void (set_charged)(struct power_supply psy);
4a11b59d AV	149
	150	/* For APM emulation, think legacy userspace. */
	151	int use_for_apm;
	152
	153	/* private */
	154	struct device *dev;
	155	struct work_struct changed_work;
	156
	157	#ifdef CONFIG_LEDS_TRIGGERS
	158	struct led_trigger *charging_full_trig;
	159	char *charging_full_trig_name;
	160	struct led_trigger *charging_trig;
	161	char *charging_trig_name;
	162	struct led_trigger *full_trig;
	163	char *full_trig_name;
	164	struct led_trigger *online_trig;
	165	char *online_trig_name;
	166	#endif
	167	};
	168
	169	/*
	170	* This is recommended structure to specify static power supply parameters.
	171	* Generic one, parametrizable for different power supplies. Power supply
	172	* class itself does not use it, but that's what implementing most platform
	173	* drivers, should try reuse for consistency.
	174	*/
	175
	176	struct power_supply_info {
	177	const char *name;
	178	int technology;
	179	int voltage_max_design;
	180	int voltage_min_design;
	181	int charge_full_design;
	182	int charge_empty_design;
	183	int energy_full_design;
	184	int energy_empty_design;
	185	int use_for_apm;
	186	};
	187
e5f5ccb6	188	extern struct power_supply power_supply_get_by_name(char name);
4a11b59d AV	189	extern void power_supply_changed(struct power_supply *psy);
4a11b59d AV	190	extern int power_supply_am_i_supplied(struct power_supply *psy);
e5f5ccb6	191	extern int power_supply_set_battery_charged(struct power_supply *psy);
4a11b59d	192
942ed161 MG	193	#if defined(CONFIG_POWER_SUPPLY) \|\| defined(CONFIG_POWER_SUPPLY_MODULE)
	194	extern int power_supply_is_system_supplied(void);
	195	#else
	196	static inline int power_supply_is_system_supplied(void) { return -ENOSYS; }
	197	#endif
	198
4a11b59d AV	199	extern int power_supply_register(struct device *parent,
	200	struct power_supply *psy);
	201	extern void power_supply_unregister(struct power_supply *psy);
	202
	203	/* For APM emulation, think legacy userspace. */
	204	extern struct class *power_supply_class;
	205
	206	#endif /* __LINUX_POWER_SUPPLY_H__ */