[mirror_ubuntu-bionic-kernel.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>
#include <linux/spinlock.h>
#include <linux/notifier.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,
	POWER_SUPPLY_HEALTH_WATCHDOG_TIMER_EXPIRE,
	POWER_SUPPLY_HEALTH_SAFETY_TIMER_EXPIRE,
};

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_SCOPE_UNKNOWN = 0,
	POWER_SUPPLY_SCOPE_SYSTEM,
	POWER_SUPPLY_SCOPE_DEVICE,
};

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_AUTHENTIC,
	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_VOLTAGE_OCV,
	POWER_SUPPLY_PROP_VOLTAGE_BOOT,
	POWER_SUPPLY_PROP_CURRENT_MAX,
	POWER_SUPPLY_PROP_CURRENT_NOW,
	POWER_SUPPLY_PROP_CURRENT_AVG,
	POWER_SUPPLY_PROP_CURRENT_BOOT,
	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_CONSTANT_CHARGE_CURRENT,
	POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX,
	POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE,
	POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX,
	POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT,
	POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX,
	POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT,
	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_ALERT_MIN, /* in percents! */
	POWER_SUPPLY_PROP_CAPACITY_ALERT_MAX, /* in percents! */
	POWER_SUPPLY_PROP_CAPACITY_LEVEL,
	POWER_SUPPLY_PROP_TEMP,
	POWER_SUPPLY_PROP_TEMP_MAX,
	POWER_SUPPLY_PROP_TEMP_MIN,
	POWER_SUPPLY_PROP_TEMP_ALERT_MIN,
	POWER_SUPPLY_PROP_TEMP_ALERT_MAX,
	POWER_SUPPLY_PROP_TEMP_AMBIENT,
	POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MIN,
	POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MAX,
	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,
	POWER_SUPPLY_PROP_TYPE, /* use power_supply.type instead */
	POWER_SUPPLY_PROP_SCOPE,
	POWER_SUPPLY_PROP_PRECHARGE_CURRENT,
	POWER_SUPPLY_PROP_CHARGE_TERM_CURRENT,
	POWER_SUPPLY_PROP_CALIBRATE,
	/* 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_UNKNOWN = 0,
	POWER_SUPPLY_TYPE_BATTERY,
	POWER_SUPPLY_TYPE_UPS,
	POWER_SUPPLY_TYPE_MAINS,
	POWER_SUPPLY_TYPE_USB,			/* Standard Downstream Port */
	POWER_SUPPLY_TYPE_USB_DCP,		/* Dedicated Charging Port */
	POWER_SUPPLY_TYPE_USB_CDP,		/* Charging Downstream Port */
	POWER_SUPPLY_TYPE_USB_ACA,		/* Accessory Charger Adapters */
	POWER_SUPPLY_TYPE_USB_TYPE_C,		/* Type C Port */
	POWER_SUPPLY_TYPE_USB_PD,		/* Power Delivery Port */
	POWER_SUPPLY_TYPE_USB_PD_DRP,		/* PD Dual Role Port */
	POWER_SUPPLY_TYPE_APPLE_BRICK_ID,	/* Apple Charging Method */
};

enum power_supply_notifier_events {
	PSY_EVENT_PROP_CHANGED,
};

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

struct device_node;
struct power_supply;

/* Run-time specific power supply configuration */
struct power_supply_config {
	struct device_node *of_node;
	/* Driver private data */
	void *drv_data;

	char **supplied_to;
	size_t num_supplicants;
};

/* Description of power supply */
struct power_supply_desc {
	const char *name;
	enum power_supply_type type;
	enum power_supply_property *properties;
	size_t num_properties;

	/*
	 * Functions for drivers implementing power supply class.
	 * These shouldn't be called directly by other drivers for accessing
	 * this power supply. Instead use power_supply_*() functions (for
	 * example power_supply_get_property()).
	 */
	int (*get_property)(struct power_supply *psy,
			    enum power_supply_property psp,
			    union power_supply_propval *val);
	int (*set_property)(struct power_supply *psy,
			    enum power_supply_property psp,
			    const union power_supply_propval *val);
	/*
	 * property_is_writeable() will be called during registration
	 * of power supply. If this happens during device probe then it must
	 * not access internal data of device (because probe did not end).
	 */
	int (*property_is_writeable)(struct power_supply *psy,
				     enum power_supply_property psp);
	void (*external_power_changed)(struct power_supply *psy);
	void (*set_charged)(struct power_supply *psy);

	/*
	 * Set if thermal zone should not be created for this power supply.
	 * For example for virtual supplies forwarding calls to actual
	 * sensors or other supplies.
	 */
	bool no_thermal;
	/* For APM emulation, think legacy userspace. */
	int use_for_apm;
};

struct power_supply {
	const struct power_supply_desc *desc;

	char **supplied_to;
	size_t num_supplicants;

	char **supplied_from;
	size_t num_supplies;
	struct device_node *of_node;

	/* Driver private data */
	void *drv_data;

	/* private */
	struct device dev;
	struct work_struct changed_work;
	struct delayed_work deferred_register_work;
	spinlock_t changed_lock;
	bool changed;
	bool initialized;
	bool removing;
	atomic_t use_cnt;
#ifdef CONFIG_THERMAL
	struct thermal_zone_device *tzd;
	struct thermal_cooling_device *tcd;
#endif

#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;
	struct led_trigger *charging_blink_full_solid_trig;
	char *charging_blink_full_solid_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;
};

/*
 * This is the recommended struct to manage static battery parameters,
 * populated by power_supply_get_battery_info(). Most platform drivers should
 * use these for consistency.
 * Its field names must correspond to elements in enum power_supply_property.
 * The default field value is -EINVAL.
 * Power supply class itself doesn't use this.
 */

struct power_supply_battery_info {
	int energy_full_design_uwh;	    /* microWatt-hours */
	int charge_full_design_uah;	    /* microAmp-hours */
	int voltage_min_design_uv;	    /* microVolts */
	int precharge_current_ua;	    /* microAmps */
	int charge_term_current_ua;	    /* microAmps */
	int constant_charge_current_max_ua; /* microAmps */
	int constant_charge_voltage_max_uv; /* microVolts */
};

extern struct atomic_notifier_head power_supply_notifier;
extern int power_supply_reg_notifier(struct notifier_block *nb);
extern void power_supply_unreg_notifier(struct notifier_block *nb);
extern struct power_supply *power_supply_get_by_name(const char *name);
extern void power_supply_put(struct power_supply *psy);
#ifdef CONFIG_OF
extern struct power_supply *power_supply_get_by_phandle(struct device_node *np,
							const char *property);
extern struct power_supply *devm_power_supply_get_by_phandle(
				    struct device *dev, const char *property);
#else /* !CONFIG_OF */
static inline struct power_supply *
power_supply_get_by_phandle(struct device_node *np, const char *property)
{ return NULL; }
static inline struct power_supply *
devm_power_supply_get_by_phandle(struct device *dev, const char *property)
{ return NULL; }
#endif /* CONFIG_OF */

extern int power_supply_get_battery_info(struct power_supply *psy,
					 struct power_supply_battery_info *info);
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_input_current_limit_from_supplier(
					 struct power_supply *psy);
extern int power_supply_set_battery_charged(struct power_supply *psy);

#ifdef CONFIG_POWER_SUPPLY
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_get_property(struct power_supply *psy,
			    enum power_supply_property psp,
			    union power_supply_propval *val);
extern int power_supply_set_property(struct power_supply *psy,
			    enum power_supply_property psp,
			    const union power_supply_propval *val);
extern int power_supply_property_is_writeable(struct power_supply *psy,
					enum power_supply_property psp);
extern void power_supply_external_power_changed(struct power_supply *psy);

extern struct power_supply *__must_check
power_supply_register(struct device *parent,
				 const struct power_supply_desc *desc,
				 const struct power_supply_config *cfg);
extern struct power_supply *__must_check
power_supply_register_no_ws(struct device *parent,
				 const struct power_supply_desc *desc,
				 const struct power_supply_config *cfg);
extern struct power_supply *__must_check
devm_power_supply_register(struct device *parent,
				 const struct power_supply_desc *desc,
				 const struct power_supply_config *cfg);
extern struct power_supply *__must_check
devm_power_supply_register_no_ws(struct device *parent,
				 const struct power_supply_desc *desc,
				 const struct power_supply_config *cfg);
extern void power_supply_unregister(struct power_supply *psy);
extern int power_supply_powers(struct power_supply *psy, struct device *dev);

extern void *power_supply_get_drvdata(struct power_supply *psy);
/* For APM emulation, think legacy userspace. */
extern struct class *power_supply_class;

static inline bool power_supply_is_amp_property(enum power_supply_property psp)
{
	switch (psp) {
	case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
	case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN:
	case POWER_SUPPLY_PROP_CHARGE_FULL:
	case POWER_SUPPLY_PROP_CHARGE_EMPTY:
	case POWER_SUPPLY_PROP_CHARGE_NOW:
	case POWER_SUPPLY_PROP_CHARGE_AVG:
	case POWER_SUPPLY_PROP_CHARGE_COUNTER:
	case POWER_SUPPLY_PROP_PRECHARGE_CURRENT:
	case POWER_SUPPLY_PROP_CHARGE_TERM_CURRENT:
	case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT:
	case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX:
	case POWER_SUPPLY_PROP_CURRENT_MAX:
	case POWER_SUPPLY_PROP_CURRENT_NOW:
	case POWER_SUPPLY_PROP_CURRENT_AVG:
	case POWER_SUPPLY_PROP_CURRENT_BOOT:
		return 1;
	default:
		break;
	}

	return 0;
}

static inline bool power_supply_is_watt_property(enum power_supply_property psp)
{
	switch (psp) {
	case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
	case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN:
	case POWER_SUPPLY_PROP_ENERGY_FULL:
	case POWER_SUPPLY_PROP_ENERGY_EMPTY:
	case POWER_SUPPLY_PROP_ENERGY_NOW:
	case POWER_SUPPLY_PROP_ENERGY_AVG:
	case POWER_SUPPLY_PROP_VOLTAGE_MAX:
	case POWER_SUPPLY_PROP_VOLTAGE_MIN:
	case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
	case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
	case POWER_SUPPLY_PROP_VOLTAGE_NOW:
	case POWER_SUPPLY_PROP_VOLTAGE_AVG:
	case POWER_SUPPLY_PROP_VOLTAGE_OCV:
	case POWER_SUPPLY_PROP_VOLTAGE_BOOT:
	case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE:
	case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX:
	case POWER_SUPPLY_PROP_POWER_NOW:
		return 1;
	default:
		break;
	}

	return 0;
}

#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
297d716f	16	#include <linux/device.h>
4a11b59d AV	17	#include <linux/workqueue.h>
4a11b59d AV	18	#include <linux/leds.h>
948dcf96	19	#include <linux/spinlock.h>
d36240d2	20	#include <linux/notifier.h>
4a11b59d AV	21
	22	/*
	23	* All voltages, currents, charges, energies, time and temperatures in uV,
	24	* µA, µAh, µWh, seconds and tenths of degree Celsius unless otherwise
	25	* stated. It's driver's job to convert its raw values to units in which
	26	* this class operates.
	27	*/
	28
	29	/*
	30	* For systems where the charger determines the maximum battery capacity
	31	* the min and max fields should be used to present these values to user
	32	* space. Unused/unknown fields will not appear in sysfs.
	33	*/
	34
	35	enum {
	36	POWER_SUPPLY_STATUS_UNKNOWN = 0,
	37	POWER_SUPPLY_STATUS_CHARGING,
	38	POWER_SUPPLY_STATUS_DISCHARGING,
	39	POWER_SUPPLY_STATUS_NOT_CHARGING,
	40	POWER_SUPPLY_STATUS_FULL,
	41	};
	42
ee8076ed AS	43	enum {
	44	POWER_SUPPLY_CHARGE_TYPE_UNKNOWN = 0,
	45	POWER_SUPPLY_CHARGE_TYPE_NONE,
	46	POWER_SUPPLY_CHARGE_TYPE_TRICKLE,
	47	POWER_SUPPLY_CHARGE_TYPE_FAST,
	48	};
	49
4a11b59d AV	50	enum {
	51	POWER_SUPPLY_HEALTH_UNKNOWN = 0,
	52	POWER_SUPPLY_HEALTH_GOOD,
	53	POWER_SUPPLY_HEALTH_OVERHEAT,
	54	POWER_SUPPLY_HEALTH_DEAD,
	55	POWER_SUPPLY_HEALTH_OVERVOLTAGE,
	56	POWER_SUPPLY_HEALTH_UNSPEC_FAILURE,
7e386e6e	57	POWER_SUPPLY_HEALTH_COLD,
a05be991 RP	58	POWER_SUPPLY_HEALTH_WATCHDOG_TIMER_EXPIRE,
a05be991 RP	59	POWER_SUPPLY_HEALTH_SAFETY_TIMER_EXPIRE,
4a11b59d AV	60	};
	61
	62	enum {
	63	POWER_SUPPLY_TECHNOLOGY_UNKNOWN = 0,
	64	POWER_SUPPLY_TECHNOLOGY_NiMH,
	65	POWER_SUPPLY_TECHNOLOGY_LION,
	66	POWER_SUPPLY_TECHNOLOGY_LIPO,
	67	POWER_SUPPLY_TECHNOLOGY_LiFe,
	68	POWER_SUPPLY_TECHNOLOGY_NiCd,
c7cc930f	69	POWER_SUPPLY_TECHNOLOGY_LiMn,
4a11b59d AV	70	};
4a11b59d AV	71
b294a290 AS	72	enum {
	73	POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN = 0,
	74	POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL,
	75	POWER_SUPPLY_CAPACITY_LEVEL_LOW,
	76	POWER_SUPPLY_CAPACITY_LEVEL_NORMAL,
	77	POWER_SUPPLY_CAPACITY_LEVEL_HIGH,
	78	POWER_SUPPLY_CAPACITY_LEVEL_FULL,
	79	};
	80
25a0bc2d JF	81	enum {
	82	POWER_SUPPLY_SCOPE_UNKNOWN = 0,
	83	POWER_SUPPLY_SCOPE_SYSTEM,
	84	POWER_SUPPLY_SCOPE_DEVICE,
	85	};
	86
4a11b59d AV	87	enum power_supply_property {
	88	/* Properties of type `int' */
	89	POWER_SUPPLY_PROP_STATUS = 0,
ee8076ed	90	POWER_SUPPLY_PROP_CHARGE_TYPE,
4a11b59d AV	91	POWER_SUPPLY_PROP_HEALTH,
	92	POWER_SUPPLY_PROP_PRESENT,
	93	POWER_SUPPLY_PROP_ONLINE,
b1b56872	94	POWER_SUPPLY_PROP_AUTHENTIC,
4a11b59d	95	POWER_SUPPLY_PROP_TECHNOLOGY,
c955fe8e	96	POWER_SUPPLY_PROP_CYCLE_COUNT,
c7cc930f DES	97	POWER_SUPPLY_PROP_VOLTAGE_MAX,
c7cc930f DES	98	POWER_SUPPLY_PROP_VOLTAGE_MIN,
4a11b59d AV	99	POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
	100	POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
	101	POWER_SUPPLY_PROP_VOLTAGE_NOW,
	102	POWER_SUPPLY_PROP_VOLTAGE_AVG,
a2ebfe2f	103	POWER_SUPPLY_PROP_VOLTAGE_OCV,
a8adcc90	104	POWER_SUPPLY_PROP_VOLTAGE_BOOT,
fe3f6d09	105	POWER_SUPPLY_PROP_CURRENT_MAX,
4a11b59d AV	106	POWER_SUPPLY_PROP_CURRENT_NOW,
4a11b59d AV	107	POWER_SUPPLY_PROP_CURRENT_AVG,
a8adcc90	108	POWER_SUPPLY_PROP_CURRENT_BOOT,
7faa144a AS	109	POWER_SUPPLY_PROP_POWER_NOW,
7faa144a AS	110	POWER_SUPPLY_PROP_POWER_AVG,
4a11b59d AV	111	POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
	112	POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN,
	113	POWER_SUPPLY_PROP_CHARGE_FULL,
	114	POWER_SUPPLY_PROP_CHARGE_EMPTY,
	115	POWER_SUPPLY_PROP_CHARGE_NOW,
	116	POWER_SUPPLY_PROP_CHARGE_AVG,
8e552c36	117	POWER_SUPPLY_PROP_CHARGE_COUNTER,
3824c477	118	POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT,
2815b786	119	POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX,
3824c477	120	POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE,
2815b786	121	POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX,
ea2ce92e RP	122	POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT,
ea2ce92e RP	123	POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX,
6bb1d272	124	POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT,
4a11b59d AV	125	POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
	126	POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN,
	127	POWER_SUPPLY_PROP_ENERGY_FULL,
	128	POWER_SUPPLY_PROP_ENERGY_EMPTY,
	129	POWER_SUPPLY_PROP_ENERGY_NOW,
	130	POWER_SUPPLY_PROP_ENERGY_AVG,
	131	POWER_SUPPLY_PROP_CAPACITY, /* in percents! */
e908c418 RP	132	POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN, /* in percents! */
e908c418 RP	133	POWER_SUPPLY_PROP_CAPACITY_ALERT_MAX, /* in percents! */
b294a290	134	POWER_SUPPLY_PROP_CAPACITY_LEVEL,
4a11b59d	135	POWER_SUPPLY_PROP_TEMP,
6bb1d272 JT	136	POWER_SUPPLY_PROP_TEMP_MAX,
6bb1d272 JT	137	POWER_SUPPLY_PROP_TEMP_MIN,
e908c418 RP	138	POWER_SUPPLY_PROP_TEMP_ALERT_MIN,
e908c418 RP	139	POWER_SUPPLY_PROP_TEMP_ALERT_MAX,
4a11b59d	140	POWER_SUPPLY_PROP_TEMP_AMBIENT,
e908c418 RP	141	POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MIN,
e908c418 RP	142	POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MAX,
4a11b59d AV	143	POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
	144	POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
	145	POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
	146	POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
5f487cd3	147	POWER_SUPPLY_PROP_TYPE, /* use power_supply.type instead */
25a0bc2d	148	POWER_SUPPLY_PROP_SCOPE,
413de34a	149	POWER_SUPPLY_PROP_PRECHARGE_CURRENT,
6bb1d272	150	POWER_SUPPLY_PROP_CHARGE_TERM_CURRENT,
a8adcc90	151	POWER_SUPPLY_PROP_CALIBRATE,
4a11b59d AV	152	/* Properties of type `const char ' /
	153	POWER_SUPPLY_PROP_MODEL_NAME,
	154	POWER_SUPPLY_PROP_MANUFACTURER,
7c2670bb	155	POWER_SUPPLY_PROP_SERIAL_NUMBER,
4a11b59d AV	156	};
	157
	158	enum power_supply_type {
9b887227 KM	159	POWER_SUPPLY_TYPE_UNKNOWN = 0,
9b887227 KM	160	POWER_SUPPLY_TYPE_BATTERY,
4a11b59d AV	161	POWER_SUPPLY_TYPE_UPS,
4a11b59d AV	162	POWER_SUPPLY_TYPE_MAINS,
71399aa5 BL	163	POWER_SUPPLY_TYPE_USB, /* Standard Downstream Port */
	164	POWER_SUPPLY_TYPE_USB_DCP, /* Dedicated Charging Port */
	165	POWER_SUPPLY_TYPE_USB_CDP, /* Charging Downstream Port */
	166	POWER_SUPPLY_TYPE_USB_ACA, /* Accessory Charger Adapters */
	167	POWER_SUPPLY_TYPE_USB_TYPE_C, /* Type C Port */
	168	POWER_SUPPLY_TYPE_USB_PD, /* Power Delivery Port */
	169	POWER_SUPPLY_TYPE_USB_PD_DRP, /* PD Dual Role Port */
	170	POWER_SUPPLY_TYPE_APPLE_BRICK_ID, /* Apple Charging Method */
4a11b59d AV	171	};
4a11b59d AV	172
d36240d2 PR	173	enum power_supply_notifier_events {
	174	PSY_EVENT_PROP_CHANGED,
	175	};
	176
4a11b59d AV	177	union power_supply_propval {
	178	int intval;
	179	const char *strval;
	180	};
	181
b50df95c	182	struct device_node;
297d716f	183	struct power_supply;
b50df95c	184
297d716f	185	/* Run-time specific power supply configuration */
2dc9215d KK	186	struct power_supply_config {
	187	struct device_node *of_node;
	188	/* Driver private data */
	189	void *drv_data;
	190
	191	char **supplied_to;
	192	size_t num_supplicants;
	193	};
	194
297d716f KK	195	/* Description of power supply */
297d716f KK	196	struct power_supply_desc {
4a11b59d AV	197	const char *name;
	198	enum power_supply_type type;
	199	enum power_supply_property *properties;
	200	size_t num_properties;
	201
bc154056 KK	202	/*
	203	* Functions for drivers implementing power supply class.
	204	* These shouldn't be called directly by other drivers for accessing
	205	* this power supply. Instead use power_supply_*() functions (for
	206	* example power_supply_get_property()).
	207	*/
4a11b59d AV	208	int (get_property)(struct power_supply psy,
	209	enum power_supply_property psp,
	210	union power_supply_propval *val);
0011d2d4 DM	211	int (set_property)(struct power_supply psy,
	212	enum power_supply_property psp,
	213	const union power_supply_propval *val);
5c6e3a97 KK	214	/*
	215	* property_is_writeable() will be called during registration
	216	* of power supply. If this happens during device probe then it must
	217	* not access internal data of device (because probe did not end).
	218	*/
0011d2d4 DM	219	int (property_is_writeable)(struct power_supply psy,
0011d2d4 DM	220	enum power_supply_property psp);
4a11b59d	221	void (external_power_changed)(struct power_supply psy);
e5f5ccb6	222	void (set_charged)(struct power_supply psy);
4a11b59d	223
a69d82b9 KK	224	/*
	225	* Set if thermal zone should not be created for this power supply.
	226	* For example for virtual supplies forwarding calls to actual
	227	* sensors or other supplies.
	228	*/
	229	bool no_thermal;
4a11b59d AV	230	/* For APM emulation, think legacy userspace. */
4a11b59d AV	231	int use_for_apm;
297d716f KK	232	};
	233
	234	struct power_supply {
	235	const struct power_supply_desc *desc;
	236
	237	char **supplied_to;
	238	size_t num_supplicants;
	239
	240	char **supplied_from;
	241	size_t num_supplies;
	242	struct device_node *of_node;
4a11b59d	243
e44ea364 KK	244	/* Driver private data */
	245	void *drv_data;
	246
4a11b59d	247	/* private */
297d716f	248	struct device dev;
4a11b59d	249	struct work_struct changed_work;
7f1a57fd	250	struct delayed_work deferred_register_work;
948dcf96 ZM	251	spinlock_t changed_lock;
948dcf96 ZM	252	bool changed;
e3805385	253	bool initialized;
b265b620	254	bool removing;
bc154056	255	atomic_t use_cnt;
3be330bf JT	256	#ifdef CONFIG_THERMAL
3be330bf JT	257	struct thermal_zone_device *tzd;
952aeeb3	258	struct thermal_cooling_device *tcd;
3be330bf	259	#endif
4a11b59d AV	260
	261	#ifdef CONFIG_LEDS_TRIGGERS
	262	struct led_trigger *charging_full_trig;
	263	char *charging_full_trig_name;
	264	struct led_trigger *charging_trig;
	265	char *charging_trig_name;
	266	struct led_trigger *full_trig;
	267	char *full_trig_name;
	268	struct led_trigger *online_trig;
	269	char *online_trig_name;
6501f728 VK	270	struct led_trigger *charging_blink_full_solid_trig;
6501f728 VK	271	char *charging_blink_full_solid_trig_name;
4a11b59d AV	272	#endif
	273	};
	274
	275	/*
	276	* This is recommended structure to specify static power supply parameters.
	277	* Generic one, parametrizable for different power supplies. Power supply
	278	* class itself does not use it, but that's what implementing most platform
	279	* drivers, should try reuse for consistency.
	280	*/
	281
	282	struct power_supply_info {
	283	const char *name;
	284	int technology;
	285	int voltage_max_design;
	286	int voltage_min_design;
	287	int charge_full_design;
	288	int charge_empty_design;
	289	int energy_full_design;
	290	int energy_empty_design;
	291	int use_for_apm;
	292	};
	293
c08b1f45 LB	294	/*
	295	* This is the recommended struct to manage static battery parameters,
	296	* populated by power_supply_get_battery_info(). Most platform drivers should
	297	* use these for consistency.
	298	* Its field names must correspond to elements in enum power_supply_property.
	299	* The default field value is -EINVAL.
	300	* Power supply class itself doesn't use this.
	301	*/
	302
	303	struct power_supply_battery_info {
	304	int energy_full_design_uwh; /* microWatt-hours */
	305	int charge_full_design_uah; /* microAmp-hours */
	306	int voltage_min_design_uv; /* microVolts */
	307	int precharge_current_ua; /* microAmps */
	308	int charge_term_current_ua; /* microAmps */
	309	int constant_charge_current_max_ua; /* microAmps */
	310	int constant_charge_voltage_max_uv; /* microVolts */
	311	};
	312
d36240d2 PR	313	extern struct atomic_notifier_head power_supply_notifier;
	314	extern int power_supply_reg_notifier(struct notifier_block *nb);
	315	extern void power_supply_unreg_notifier(struct notifier_block *nb);
9f3b795a	316	extern struct power_supply power_supply_get_by_name(const char name);
1a352462	317	extern void power_supply_put(struct power_supply *psy);
abce9770 SR	318	#ifdef CONFIG_OF
	319	extern struct power_supply power_supply_get_by_phandle(struct device_node np,
	320	const char *property);
fe27e1df HG	321	extern struct power_supply *devm_power_supply_get_by_phandle(
fe27e1df HG	322	struct device dev, const char property);
abce9770 SR	323	#else /* !CONFIG_OF */
	324	static inline struct power_supply *
	325	power_supply_get_by_phandle(struct device_node np, const char property)
	326	{ return NULL; }
fe27e1df HG	327	static inline struct power_supply *
	328	devm_power_supply_get_by_phandle(struct device dev, const char property)
	329	{ return NULL; }
abce9770	330	#endif /* CONFIG_OF */
c08b1f45 LB	331
	332	extern int power_supply_get_battery_info(struct power_supply *psy,
	333	struct power_supply_battery_info *info);
4a11b59d AV	334	extern void power_supply_changed(struct power_supply *psy);
4a11b59d AV	335	extern int power_supply_am_i_supplied(struct power_supply *psy);
c3142dd8 HG	336	extern int power_supply_set_input_current_limit_from_supplier(
c3142dd8 HG	337	struct power_supply *psy);
e5f5ccb6	338	extern int power_supply_set_battery_charged(struct power_supply *psy);
4a11b59d	339
0d4ed4e2	340	#ifdef CONFIG_POWER_SUPPLY
942ed161 MG	341	extern int power_supply_is_system_supplied(void);
	342	#else
	343	static inline int power_supply_is_system_supplied(void) { return -ENOSYS; }
	344	#endif
	345
bc154056 KK	346	extern int power_supply_get_property(struct power_supply *psy,
	347	enum power_supply_property psp,
	348	union power_supply_propval *val);
	349	extern int power_supply_set_property(struct power_supply *psy,
	350	enum power_supply_property psp,
	351	const union power_supply_propval *val);
	352	extern int power_supply_property_is_writeable(struct power_supply *psy,
	353	enum power_supply_property psp);
	354	extern void power_supply_external_power_changed(struct power_supply *psy);
297d716f KK	355
	356	extern struct power_supply *__must_check
	357	power_supply_register(struct device *parent,
	358	const struct power_supply_desc *desc,
2dc9215d	359	const struct power_supply_config *cfg);
297d716f KK	360	extern struct power_supply *__must_check
	361	power_supply_register_no_ws(struct device *parent,
	362	const struct power_supply_desc *desc,
2dc9215d	363	const struct power_supply_config *cfg);
297d716f KK	364	extern struct power_supply *__must_check
	365	devm_power_supply_register(struct device *parent,
	366	const struct power_supply_desc *desc,
2dc9215d	367	const struct power_supply_config *cfg);
297d716f KK	368	extern struct power_supply *__must_check
	369	devm_power_supply_register_no_ws(struct device *parent,
	370	const struct power_supply_desc *desc,
2dc9215d	371	const struct power_supply_config *cfg);
4a11b59d	372	extern void power_supply_unregister(struct power_supply *psy);
83516651	373	extern int power_supply_powers(struct power_supply psy, struct device dev);
4a11b59d	374
e44ea364	375	extern void power_supply_get_drvdata(struct power_supply psy);
4a11b59d AV	376	/* For APM emulation, think legacy userspace. */
	377	extern struct class *power_supply_class;
	378
51d07566 RK	379	static inline bool power_supply_is_amp_property(enum power_supply_property psp)
	380	{
	381	switch (psp) {
	382	case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
	383	case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN:
	384	case POWER_SUPPLY_PROP_CHARGE_FULL:
	385	case POWER_SUPPLY_PROP_CHARGE_EMPTY:
	386	case POWER_SUPPLY_PROP_CHARGE_NOW:
	387	case POWER_SUPPLY_PROP_CHARGE_AVG:
	388	case POWER_SUPPLY_PROP_CHARGE_COUNTER:
413de34a LB	389	case POWER_SUPPLY_PROP_PRECHARGE_CURRENT:
413de34a LB	390	case POWER_SUPPLY_PROP_CHARGE_TERM_CURRENT:
3824c477	391	case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT:
2815b786	392	case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX:
51d07566 RK	393	case POWER_SUPPLY_PROP_CURRENT_MAX:
	394	case POWER_SUPPLY_PROP_CURRENT_NOW:
	395	case POWER_SUPPLY_PROP_CURRENT_AVG:
a8adcc90	396	case POWER_SUPPLY_PROP_CURRENT_BOOT:
51d07566 RK	397	return 1;
	398	default:
	399	break;
	400	}
	401
	402	return 0;
	403	}
	404
	405	static inline bool power_supply_is_watt_property(enum power_supply_property psp)
	406	{
	407	switch (psp) {
	408	case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
	409	case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN:
	410	case POWER_SUPPLY_PROP_ENERGY_FULL:
	411	case POWER_SUPPLY_PROP_ENERGY_EMPTY:
	412	case POWER_SUPPLY_PROP_ENERGY_NOW:
	413	case POWER_SUPPLY_PROP_ENERGY_AVG:
	414	case POWER_SUPPLY_PROP_VOLTAGE_MAX:
	415	case POWER_SUPPLY_PROP_VOLTAGE_MIN:
	416	case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
	417	case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
	418	case POWER_SUPPLY_PROP_VOLTAGE_NOW:
	419	case POWER_SUPPLY_PROP_VOLTAGE_AVG:
a2ebfe2f	420	case POWER_SUPPLY_PROP_VOLTAGE_OCV:
a8adcc90	421	case POWER_SUPPLY_PROP_VOLTAGE_BOOT:
3824c477	422	case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE:
2815b786	423	case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX:
35c9d267	424	case POWER_SUPPLY_PROP_POWER_NOW:
51d07566 RK	425	return 1;
	426	default:
	427	break;
	428	}
	429
	430	return 0;
	431	}
	432
4a11b59d	433	#endif /* __LINUX_POWER_SUPPLY_H__ */