blob: 164abe25fa3622de568dfa0e47f714e207f686ef [file] [log] [blame]
Anton Vorontsov4a11b592007-05-04 00:27:45 +04001/*
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
Krzysztof Kozlowski297d7162015-03-12 08:44:11 +010016#include <linux/device.h>
Anton Vorontsov4a11b592007-05-04 00:27:45 +040017#include <linux/workqueue.h>
18#include <linux/leds.h>
Zoran Markovic948dcf92013-08-02 13:38:02 -070019#include <linux/spinlock.h>
Pali Rohárd36240d2013-11-19 11:18:03 +010020#include <linux/notifier.h>
Todd Poynord3ee35b2013-12-12 15:59:09 -080021#include <linux/types.h>
Anton Vorontsov4a11b592007-05-04 00:27:45 +040022
23/*
24 * All voltages, currents, charges, energies, time and temperatures in uV,
25 * µA, µAh, µWh, seconds and tenths of degree Celsius unless otherwise
26 * stated. It's driver's job to convert its raw values to units in which
27 * this class operates.
28 */
29
30/*
31 * For systems where the charger determines the maximum battery capacity
32 * the min and max fields should be used to present these values to user
33 * space. Unused/unknown fields will not appear in sysfs.
34 */
35
36enum {
37 POWER_SUPPLY_STATUS_UNKNOWN = 0,
38 POWER_SUPPLY_STATUS_CHARGING,
39 POWER_SUPPLY_STATUS_DISCHARGING,
40 POWER_SUPPLY_STATUS_NOT_CHARGING,
41 POWER_SUPPLY_STATUS_FULL,
42};
43
44enum {
Andres Salomonee8076e2009-07-02 09:45:18 -040045 POWER_SUPPLY_CHARGE_TYPE_UNKNOWN = 0,
46 POWER_SUPPLY_CHARGE_TYPE_NONE,
47 POWER_SUPPLY_CHARGE_TYPE_TRICKLE,
48 POWER_SUPPLY_CHARGE_TYPE_FAST,
Abhijeet Dharmapurikardcdf2fc2017-03-23 00:53:46 -070049 POWER_SUPPLY_CHARGE_TYPE_TAPER,
Andres Salomonee8076e2009-07-02 09:45:18 -040050};
51
52enum {
Anton Vorontsov4a11b592007-05-04 00:27:45 +040053 POWER_SUPPLY_HEALTH_UNKNOWN = 0,
54 POWER_SUPPLY_HEALTH_GOOD,
55 POWER_SUPPLY_HEALTH_OVERHEAT,
56 POWER_SUPPLY_HEALTH_DEAD,
57 POWER_SUPPLY_HEALTH_OVERVOLTAGE,
58 POWER_SUPPLY_HEALTH_UNSPEC_FAILURE,
Mark Brown7e386e62008-11-30 22:43:21 +010059 POWER_SUPPLY_HEALTH_COLD,
Ramakrishna Pallalaa05be992012-11-30 13:57:46 +053060 POWER_SUPPLY_HEALTH_WATCHDOG_TIMER_EXPIRE,
61 POWER_SUPPLY_HEALTH_SAFETY_TIMER_EXPIRE,
Abhijeet Dharmapurikardcdf2fc2017-03-23 00:53:46 -070062 POWER_SUPPLY_HEALTH_WARM,
63 POWER_SUPPLY_HEALTH_COOL,
Nicholas Troast86cc4f672017-02-08 10:41:06 -080064 POWER_SUPPLY_HEALTH_HOT,
Anton Vorontsov4a11b592007-05-04 00:27:45 +040065};
66
67enum {
68 POWER_SUPPLY_TECHNOLOGY_UNKNOWN = 0,
69 POWER_SUPPLY_TECHNOLOGY_NiMH,
70 POWER_SUPPLY_TECHNOLOGY_LION,
71 POWER_SUPPLY_TECHNOLOGY_LIPO,
72 POWER_SUPPLY_TECHNOLOGY_LiFe,
73 POWER_SUPPLY_TECHNOLOGY_NiCd,
Dmitry Baryshkovc7cc9302008-01-07 04:12:41 +030074 POWER_SUPPLY_TECHNOLOGY_LiMn,
Anton Vorontsov4a11b592007-05-04 00:27:45 +040075};
76
Andres Salomonb294a292009-06-30 02:13:01 -040077enum {
78 POWER_SUPPLY_CAPACITY_LEVEL_UNKNOWN = 0,
79 POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL,
80 POWER_SUPPLY_CAPACITY_LEVEL_LOW,
81 POWER_SUPPLY_CAPACITY_LEVEL_NORMAL,
82 POWER_SUPPLY_CAPACITY_LEVEL_HIGH,
83 POWER_SUPPLY_CAPACITY_LEVEL_FULL,
84};
85
Jeremy Fitzhardinge25a0bc22011-12-07 11:24:20 -080086enum {
87 POWER_SUPPLY_SCOPE_UNKNOWN = 0,
88 POWER_SUPPLY_SCOPE_SYSTEM,
89 POWER_SUPPLY_SCOPE_DEVICE,
90};
91
Abhijeet Dharmapurikardcdf2fc2017-03-23 00:53:46 -070092enum {
93 POWER_SUPPLY_DP_DM_UNKNOWN = 0,
94 POWER_SUPPLY_DP_DM_PREPARE = 1,
95 POWER_SUPPLY_DP_DM_UNPREPARE = 2,
96 POWER_SUPPLY_DP_DM_CONFIRMED_HVDCP3 = 3,
97 POWER_SUPPLY_DP_DM_DP_PULSE = 4,
98 POWER_SUPPLY_DP_DM_DM_PULSE = 5,
99 POWER_SUPPLY_DP_DM_DP0P6_DMF = 6,
100 POWER_SUPPLY_DP_DM_DP0P6_DM3P3 = 7,
101 POWER_SUPPLY_DP_DM_DPF_DMF = 8,
102 POWER_SUPPLY_DP_DM_DPR_DMR = 9,
103 POWER_SUPPLY_DP_DM_HVDCP3_SUPPORTED = 10,
104 POWER_SUPPLY_DP_DM_ICL_DOWN = 11,
105 POWER_SUPPLY_DP_DM_ICL_UP = 12,
Ashay Jaiswalcf243372017-10-31 14:33:27 +0530106 POWER_SUPPLY_DP_DM_FORCE_5V = 13,
107 POWER_SUPPLY_DP_DM_FORCE_9V = 14,
108 POWER_SUPPLY_DP_DM_FORCE_12V = 15,
Abhijeet Dharmapurikardcdf2fc2017-03-23 00:53:46 -0700109};
110
Abhijeet Dharmapurikar9a3a6c32017-01-06 18:27:29 -0800111enum {
Ashay Jaiswalec6af842017-02-17 16:00:05 +0530112 POWER_SUPPLY_PL_NONE,
113 POWER_SUPPLY_PL_USBIN_USBIN,
114 POWER_SUPPLY_PL_USBIN_USBIN_EXT,
115 POWER_SUPPLY_PL_USBMID_USBMID,
Abhijeet Dharmapurikar9a3a6c32017-01-06 18:27:29 -0800116};
117
Ashay Jaiswaleb726842017-11-14 10:41:43 +0530118enum {
119 POWER_SUPPLY_CONNECTOR_TYPEC,
120 POWER_SUPPLY_CONNECTOR_MICRO_USB,
121};
122
Ashay Jaiswal45142d92017-11-02 09:57:18 +0530123enum {
124 POWER_SUPPLY_PL_STACKED_BATFET,
125 POWER_SUPPLY_PL_NON_STACKED_BATFET,
126};
127
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400128enum power_supply_property {
129 /* Properties of type `int' */
130 POWER_SUPPLY_PROP_STATUS = 0,
Andres Salomonee8076e2009-07-02 09:45:18 -0400131 POWER_SUPPLY_PROP_CHARGE_TYPE,
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400132 POWER_SUPPLY_PROP_HEALTH,
133 POWER_SUPPLY_PROP_PRESENT,
134 POWER_SUPPLY_PROP_ONLINE,
Ramakrishna Pallalab1b56872012-08-23 06:50:21 +0530135 POWER_SUPPLY_PROP_AUTHENTIC,
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400136 POWER_SUPPLY_PROP_TECHNOLOGY,
Alexey Starikovskiyc955fe82009-10-15 14:31:30 +0400137 POWER_SUPPLY_PROP_CYCLE_COUNT,
Dmitry Baryshkovc7cc9302008-01-07 04:12:41 +0300138 POWER_SUPPLY_PROP_VOLTAGE_MAX,
139 POWER_SUPPLY_PROP_VOLTAGE_MIN,
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400140 POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN,
141 POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
142 POWER_SUPPLY_PROP_VOLTAGE_NOW,
143 POWER_SUPPLY_PROP_VOLTAGE_AVG,
Ramakrishna Pallalaa2ebfe22012-04-10 16:21:20 +0530144 POWER_SUPPLY_PROP_VOLTAGE_OCV,
Ramakrishna Pallalaa8adcc902014-08-27 23:44:08 +0530145 POWER_SUPPLY_PROP_VOLTAGE_BOOT,
Heikki Krogerusfe3f6d02010-10-04 10:51:38 +0300146 POWER_SUPPLY_PROP_CURRENT_MAX,
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400147 POWER_SUPPLY_PROP_CURRENT_NOW,
148 POWER_SUPPLY_PROP_CURRENT_AVG,
Ramakrishna Pallalaa8adcc902014-08-27 23:44:08 +0530149 POWER_SUPPLY_PROP_CURRENT_BOOT,
Alexey Starikovskiy7faa1442009-03-27 22:23:52 -0400150 POWER_SUPPLY_PROP_POWER_NOW,
151 POWER_SUPPLY_PROP_POWER_AVG,
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400152 POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
153 POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN,
154 POWER_SUPPLY_PROP_CHARGE_FULL,
155 POWER_SUPPLY_PROP_CHARGE_EMPTY,
156 POWER_SUPPLY_PROP_CHARGE_NOW,
Abhijeet Dharmapurikardcdf2fc2017-03-23 00:53:46 -0700157 POWER_SUPPLY_PROP_CHARGE_NOW_RAW,
158 POWER_SUPPLY_PROP_CHARGE_NOW_ERROR,
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400159 POWER_SUPPLY_PROP_CHARGE_AVG,
Andres Salomon8e552c32008-05-12 21:46:29 -0400160 POWER_SUPPLY_PROP_CHARGE_COUNTER,
Ramakrishna Pallala3824c472012-05-06 18:16:44 +0530161 POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT,
Ramakrishna Pallala2815b782012-07-30 12:49:21 +0530162 POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX,
Ramakrishna Pallala3824c472012-05-06 18:16:44 +0530163 POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE,
Ramakrishna Pallala2815b782012-07-30 12:49:21 +0530164 POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX,
Ramakrishna Pallalaea2ce922012-10-09 22:25:29 +0530165 POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT,
166 POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX,
Jenny TC6bb1d272014-07-08 11:34:18 +0530167 POWER_SUPPLY_PROP_INPUT_CURRENT_LIMIT,
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400168 POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN,
169 POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN,
170 POWER_SUPPLY_PROP_ENERGY_FULL,
171 POWER_SUPPLY_PROP_ENERGY_EMPTY,
172 POWER_SUPPLY_PROP_ENERGY_NOW,
173 POWER_SUPPLY_PROP_ENERGY_AVG,
174 POWER_SUPPLY_PROP_CAPACITY, /* in percents! */
Ramakrishna Pallalae908c412012-07-05 16:59:12 +0530175 POWER_SUPPLY_PROP_CAPACITY_ALERT_MIN, /* in percents! */
176 POWER_SUPPLY_PROP_CAPACITY_ALERT_MAX, /* in percents! */
Andres Salomonb294a292009-06-30 02:13:01 -0400177 POWER_SUPPLY_PROP_CAPACITY_LEVEL,
Abhijeet Dharmapurikardcdf2fc2017-03-23 00:53:46 -0700178 POWER_SUPPLY_PROP_CAPACITY_RAW,
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400179 POWER_SUPPLY_PROP_TEMP,
Jenny TC6bb1d272014-07-08 11:34:18 +0530180 POWER_SUPPLY_PROP_TEMP_MAX,
181 POWER_SUPPLY_PROP_TEMP_MIN,
Ramakrishna Pallalae908c412012-07-05 16:59:12 +0530182 POWER_SUPPLY_PROP_TEMP_ALERT_MIN,
183 POWER_SUPPLY_PROP_TEMP_ALERT_MAX,
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400184 POWER_SUPPLY_PROP_TEMP_AMBIENT,
Ramakrishna Pallalae908c412012-07-05 16:59:12 +0530185 POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MIN,
186 POWER_SUPPLY_PROP_TEMP_AMBIENT_ALERT_MAX,
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400187 POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
188 POWER_SUPPLY_PROP_TIME_TO_EMPTY_AVG,
189 POWER_SUPPLY_PROP_TIME_TO_FULL_NOW,
190 POWER_SUPPLY_PROP_TIME_TO_FULL_AVG,
Anton Vorontsov5f487cd2010-05-18 21:49:51 +0200191 POWER_SUPPLY_PROP_TYPE, /* use power_supply.type instead */
Jeremy Fitzhardinge25a0bc22011-12-07 11:24:20 -0800192 POWER_SUPPLY_PROP_SCOPE,
Jenny TC6bb1d272014-07-08 11:34:18 +0530193 POWER_SUPPLY_PROP_CHARGE_TERM_CURRENT,
Ramakrishna Pallalaa8adcc902014-08-27 23:44:08 +0530194 POWER_SUPPLY_PROP_CALIBRATE,
Todd Poynor53e0fd52012-07-12 20:27:16 -0700195 /* Local extensions */
196 POWER_SUPPLY_PROP_USB_HC,
Todd Poynorb6c32982012-07-13 13:30:04 -0700197 POWER_SUPPLY_PROP_USB_OTG,
Abhijeet Dharmapurikardcdf2fc2017-03-23 00:53:46 -0700198 POWER_SUPPLY_PROP_BATTERY_CHARGING_ENABLED,
199 POWER_SUPPLY_PROP_CHARGING_ENABLED,
Harry Yang878ba2b2016-08-31 16:07:30 -0700200 POWER_SUPPLY_PROP_STEP_CHARGING_ENABLED,
201 POWER_SUPPLY_PROP_STEP_CHARGING_STEP,
Nicholas Troastcf50b0c2016-08-02 13:43:58 -0700202 POWER_SUPPLY_PROP_PIN_ENABLED,
Nicholas Troast24163112016-04-01 10:48:01 -0700203 POWER_SUPPLY_PROP_INPUT_SUSPEND,
Abhijeet Dharmapurikardcdf2fc2017-03-23 00:53:46 -0700204 POWER_SUPPLY_PROP_INPUT_VOLTAGE_REGULATION,
205 POWER_SUPPLY_PROP_INPUT_CURRENT_MAX,
206 POWER_SUPPLY_PROP_INPUT_CURRENT_TRIM,
207 POWER_SUPPLY_PROP_INPUT_CURRENT_SETTLED,
Nicholas Troast5bb8e7f2017-01-28 09:32:17 -0800208 POWER_SUPPLY_PROP_INPUT_VOLTAGE_SETTLED,
Abhijeet Dharmapurikardcdf2fc2017-03-23 00:53:46 -0700209 POWER_SUPPLY_PROP_VCHG_LOOP_DBC_BYPASS,
210 POWER_SUPPLY_PROP_CHARGE_COUNTER_SHADOW,
211 POWER_SUPPLY_PROP_HI_POWER,
212 POWER_SUPPLY_PROP_LOW_POWER,
213 POWER_SUPPLY_PROP_COOL_TEMP,
214 POWER_SUPPLY_PROP_WARM_TEMP,
Subbaraman Narayanamurthy7b8a3ee2017-08-11 18:37:26 -0700215 POWER_SUPPLY_PROP_COLD_TEMP,
216 POWER_SUPPLY_PROP_HOT_TEMP,
Abhijeet Dharmapurikardcdf2fc2017-03-23 00:53:46 -0700217 POWER_SUPPLY_PROP_SYSTEM_TEMP_LEVEL,
218 POWER_SUPPLY_PROP_RESISTANCE,
219 POWER_SUPPLY_PROP_RESISTANCE_CAPACITIVE,
220 POWER_SUPPLY_PROP_RESISTANCE_ID, /* in Ohms */
221 POWER_SUPPLY_PROP_RESISTANCE_NOW,
222 POWER_SUPPLY_PROP_FLASH_CURRENT_MAX,
223 POWER_SUPPLY_PROP_UPDATE_NOW,
224 POWER_SUPPLY_PROP_ESR_COUNT,
225 POWER_SUPPLY_PROP_BUCK_FREQ,
226 POWER_SUPPLY_PROP_BOOST_CURRENT,
227 POWER_SUPPLY_PROP_SAFETY_TIMER_ENABLE,
228 POWER_SUPPLY_PROP_CHARGE_DONE,
229 POWER_SUPPLY_PROP_FLASH_ACTIVE,
230 POWER_SUPPLY_PROP_FLASH_TRIGGER,
231 POWER_SUPPLY_PROP_FORCE_TLIM,
232 POWER_SUPPLY_PROP_DP_DM,
233 POWER_SUPPLY_PROP_INPUT_CURRENT_LIMITED,
234 POWER_SUPPLY_PROP_INPUT_CURRENT_NOW,
Harry Yang71a8d3e2017-02-25 21:25:51 -0800235 POWER_SUPPLY_PROP_CHARGE_QNOVO_ENABLE,
Harry Yanga22224c2017-02-07 16:53:28 -0800236 POWER_SUPPLY_PROP_CURRENT_QNOVO,
237 POWER_SUPPLY_PROP_VOLTAGE_QNOVO,
Abhijeet Dharmapurikardcdf2fc2017-03-23 00:53:46 -0700238 POWER_SUPPLY_PROP_RERUN_AICL,
239 POWER_SUPPLY_PROP_CYCLE_COUNT_ID,
240 POWER_SUPPLY_PROP_SAFETY_TIMER_EXPIRED,
241 POWER_SUPPLY_PROP_RESTRICTED_CHARGING,
242 POWER_SUPPLY_PROP_CURRENT_CAPABILITY,
Jack Phamd8c9b782016-02-29 11:41:58 -0800243 POWER_SUPPLY_PROP_TYPEC_MODE,
244 POWER_SUPPLY_PROP_TYPEC_CC_ORIENTATION, /* 0: N/C, 1: CC1, 2: CC2 */
245 POWER_SUPPLY_PROP_TYPEC_POWER_ROLE,
246 POWER_SUPPLY_PROP_PD_ALLOWED,
247 POWER_SUPPLY_PROP_PD_ACTIVE,
Jack Pham2f3c8252016-09-30 17:32:01 -0700248 POWER_SUPPLY_PROP_PD_IN_HARD_RESET,
249 POWER_SUPPLY_PROP_PD_CURRENT_MAX,
250 POWER_SUPPLY_PROP_PD_USB_SUSPEND_SUPPORTED,
Nicholas Troast0fa31852016-07-28 13:42:49 -0700251 POWER_SUPPLY_PROP_CHARGER_TEMP,
252 POWER_SUPPLY_PROP_CHARGER_TEMP_MAX,
Nicholas Troast549fcde2016-10-06 11:48:31 -0700253 POWER_SUPPLY_PROP_PARALLEL_DISABLE,
Abhijeet Dharmapurikar6d3ad962016-10-17 16:51:36 -0700254 POWER_SUPPLY_PROP_PE_START,
Fenglin Wu53758762016-11-22 12:50:25 +0800255 POWER_SUPPLY_PROP_SET_SHIP_MODE,
Abhijeet Dharmapurikardcdf2fc2017-03-23 00:53:46 -0700256 POWER_SUPPLY_PROP_SOC_REPORTING_READY,
257 POWER_SUPPLY_PROP_DEBUG_BATTERY,
Nicholas Troast86cc4f672017-02-08 10:41:06 -0800258 POWER_SUPPLY_PROP_FCC_DELTA,
259 POWER_SUPPLY_PROP_ICL_REDUCTION,
260 POWER_SUPPLY_PROP_PARALLEL_MODE,
Nicholas Troast86cc4f672017-02-08 10:41:06 -0800261 POWER_SUPPLY_PROP_DIE_HEALTH,
262 POWER_SUPPLY_PROP_CONNECTOR_HEALTH,
Nicholas Troast6b859142017-02-05 19:44:33 -0800263 POWER_SUPPLY_PROP_CTM_CURRENT_MAX,
Ashay Jaiswal104edd82017-03-23 10:34:18 +0530264 POWER_SUPPLY_PROP_HW_CURRENT_MAX,
Fenglin Wue8615ac2017-04-25 20:51:06 +0800265 POWER_SUPPLY_PROP_REAL_TYPE,
Abhijeet Dharmapurikare43bacd2017-05-24 17:11:24 -0700266 POWER_SUPPLY_PROP_PR_SWAP,
Nicholas Troast0d8716a2017-06-20 16:25:57 -0700267 POWER_SUPPLY_PROP_CC_STEP,
268 POWER_SUPPLY_PROP_CC_STEP_SEL,
Ashay Jaiswal8ae23a52017-08-09 09:46:31 +0530269 POWER_SUPPLY_PROP_SW_JEITA_ENABLED,
Nicholas Troaste552a1d2017-07-25 13:10:26 -0700270 POWER_SUPPLY_PROP_PD_VOLTAGE_MAX,
271 POWER_SUPPLY_PROP_PD_VOLTAGE_MIN,
272 POWER_SUPPLY_PROP_SDP_CURRENT_MAX,
Ashay Jaiswaleb726842017-11-14 10:41:43 +0530273 POWER_SUPPLY_PROP_CONNECTOR_TYPE,
Ashay Jaiswal45142d92017-11-02 09:57:18 +0530274 POWER_SUPPLY_PROP_PARALLEL_BATFET_MODE,
275 POWER_SUPPLY_PROP_MIN_ICL,
Tirupathi Reddy4ba4b502017-09-27 12:04:31 +0530276 POWER_SUPPLY_PROP_MOISTURE_DETECTED,
Todd Poynord3ee35b2013-12-12 15:59:09 -0800277 /* Local extensions of type int64_t */
278 POWER_SUPPLY_PROP_CHARGE_COUNTER_EXT,
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400279 /* Properties of type `const char *' */
280 POWER_SUPPLY_PROP_MODEL_NAME,
281 POWER_SUPPLY_PROP_MANUFACTURER,
maximilian attems7c2670b2008-01-22 18:46:50 +0100282 POWER_SUPPLY_PROP_SERIAL_NUMBER,
Abhijeet Dharmapurikardcdf2fc2017-03-23 00:53:46 -0700283 POWER_SUPPLY_PROP_BATTERY_TYPE,
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400284};
285
286enum power_supply_type {
Kim, Milo9b887222011-11-30 23:08:33 -0800287 POWER_SUPPLY_TYPE_UNKNOWN = 0,
288 POWER_SUPPLY_TYPE_BATTERY,
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400289 POWER_SUPPLY_TYPE_UPS,
290 POWER_SUPPLY_TYPE_MAINS,
Heikki Krogerus85efc8a2010-10-04 10:51:37 +0300291 POWER_SUPPLY_TYPE_USB, /* Standard Downstream Port */
292 POWER_SUPPLY_TYPE_USB_DCP, /* Dedicated Charging Port */
293 POWER_SUPPLY_TYPE_USB_CDP, /* Charging Downstream Port */
294 POWER_SUPPLY_TYPE_USB_ACA, /* Accessory Charger Adapters */
Abhijeet Dharmapurikardcdf2fc2017-03-23 00:53:46 -0700295 POWER_SUPPLY_TYPE_USB_HVDCP, /* High Voltage DCP */
296 POWER_SUPPLY_TYPE_USB_HVDCP_3, /* Efficient High Voltage DCP */
Abhijeet Dharmapurikar9a3a6c32017-01-06 18:27:29 -0800297 POWER_SUPPLY_TYPE_USB_PD, /* Power Delivery */
Abhijeet Dharmapurikardcdf2fc2017-03-23 00:53:46 -0700298 POWER_SUPPLY_TYPE_WIRELESS, /* Accessory Charger Adapters */
Abhijeet Dharmapurikar4e56cab2017-07-05 14:00:52 -0700299 POWER_SUPPLY_TYPE_USB_FLOAT, /* Floating charger */
Abhijeet Dharmapurikardcdf2fc2017-03-23 00:53:46 -0700300 POWER_SUPPLY_TYPE_BMS, /* Battery Monitor System */
Abhijeet Dharmapurikar9a3a6c32017-01-06 18:27:29 -0800301 POWER_SUPPLY_TYPE_PARALLEL, /* Parallel Path */
302 POWER_SUPPLY_TYPE_MAIN, /* Main Path */
303 POWER_SUPPLY_TYPE_WIPOWER, /* Wipower */
304 POWER_SUPPLY_TYPE_TYPEC, /* Type-C */
Abhijeet Dharmapurikardcdf2fc2017-03-23 00:53:46 -0700305 POWER_SUPPLY_TYPE_UFP, /* Type-C UFP */
306 POWER_SUPPLY_TYPE_DFP, /* TYpe-C DFP */
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400307};
308
Jack Phamd8c9b782016-02-29 11:41:58 -0800309/* Indicates USB Type-C CC connection status */
310enum power_supply_typec_mode {
311 POWER_SUPPLY_TYPEC_NONE,
312
313 /* Acting as source */
314 POWER_SUPPLY_TYPEC_SINK, /* Rd only */
315 POWER_SUPPLY_TYPEC_SINK_POWERED_CABLE, /* Rd/Ra */
316 POWER_SUPPLY_TYPEC_SINK_DEBUG_ACCESSORY, /* Rd/Rd */
317 POWER_SUPPLY_TYPEC_SINK_AUDIO_ADAPTER, /* Ra/Ra */
318 POWER_SUPPLY_TYPEC_POWERED_CABLE_ONLY, /* Ra only */
319
320 /* Acting as sink */
321 POWER_SUPPLY_TYPEC_SOURCE_DEFAULT, /* Rp default */
322 POWER_SUPPLY_TYPEC_SOURCE_MEDIUM, /* Rp 1.5A */
323 POWER_SUPPLY_TYPEC_SOURCE_HIGH, /* Rp 3A */
324 POWER_SUPPLY_TYPEC_NON_COMPLIANT,
325};
326
327enum power_supply_typec_power_role {
328 POWER_SUPPLY_TYPEC_PR_NONE, /* CC lines in high-Z */
329 POWER_SUPPLY_TYPEC_PR_DUAL,
330 POWER_SUPPLY_TYPEC_PR_SINK,
331 POWER_SUPPLY_TYPEC_PR_SOURCE,
332};
333
Pali Rohárd36240d2013-11-19 11:18:03 +0100334enum power_supply_notifier_events {
335 PSY_EVENT_PROP_CHANGED,
336};
337
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400338union power_supply_propval {
339 int intval;
340 const char *strval;
Todd Poynord3ee35b2013-12-12 15:59:09 -0800341 int64_t int64val;
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400342};
343
Anton Vorontsovb50df952013-06-28 18:17:22 -0700344struct device_node;
Krzysztof Kozlowski297d7162015-03-12 08:44:11 +0100345struct power_supply;
Anton Vorontsovb50df952013-06-28 18:17:22 -0700346
Krzysztof Kozlowski297d7162015-03-12 08:44:11 +0100347/* Run-time specific power supply configuration */
Krzysztof Kozlowski2dc92152015-03-12 08:44:02 +0100348struct power_supply_config {
349 struct device_node *of_node;
350 /* Driver private data */
351 void *drv_data;
352
353 char **supplied_to;
354 size_t num_supplicants;
355};
356
Krzysztof Kozlowski297d7162015-03-12 08:44:11 +0100357/* Description of power supply */
358struct power_supply_desc {
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400359 const char *name;
360 enum power_supply_type type;
361 enum power_supply_property *properties;
362 size_t num_properties;
363
Krzysztof Kozlowskibc154052015-03-12 08:44:03 +0100364 /*
365 * Functions for drivers implementing power supply class.
366 * These shouldn't be called directly by other drivers for accessing
367 * this power supply. Instead use power_supply_*() functions (for
368 * example power_supply_get_property()).
369 */
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400370 int (*get_property)(struct power_supply *psy,
371 enum power_supply_property psp,
372 union power_supply_propval *val);
Daniel Mack0011d2d2010-05-18 21:49:52 +0200373 int (*set_property)(struct power_supply *psy,
374 enum power_supply_property psp,
375 const union power_supply_propval *val);
Krzysztof Kozlowski5c6e3a92015-06-08 10:09:48 +0900376 /*
377 * property_is_writeable() will be called during registration
378 * of power supply. If this happens during device probe then it must
379 * not access internal data of device (because probe did not end).
380 */
Daniel Mack0011d2d2010-05-18 21:49:52 +0200381 int (*property_is_writeable)(struct power_supply *psy,
382 enum power_supply_property psp);
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400383 void (*external_power_changed)(struct power_supply *psy);
Daniel Macke5f5ccb2009-07-23 20:35:53 +0200384 void (*set_charged)(struct power_supply *psy);
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400385
Krzysztof Kozlowskia69d82b2014-10-07 17:47:36 +0200386 /*
387 * Set if thermal zone should not be created for this power supply.
388 * For example for virtual supplies forwarding calls to actual
389 * sensors or other supplies.
390 */
391 bool no_thermal;
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400392 /* For APM emulation, think legacy userspace. */
393 int use_for_apm;
Krzysztof Kozlowski297d7162015-03-12 08:44:11 +0100394};
395
396struct power_supply {
397 const struct power_supply_desc *desc;
398
399 char **supplied_to;
400 size_t num_supplicants;
401
402 char **supplied_from;
403 size_t num_supplies;
404 struct device_node *of_node;
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400405
Krzysztof Kozlowskie44ea362015-03-12 08:44:01 +0100406 /* Driver private data */
407 void *drv_data;
408
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400409 /* private */
Krzysztof Kozlowski297d7162015-03-12 08:44:11 +0100410 struct device dev;
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400411 struct work_struct changed_work;
Krzysztof Kozlowski7f1a57f2015-05-19 16:13:02 +0900412 struct delayed_work deferred_register_work;
Zoran Markovic948dcf92013-08-02 13:38:02 -0700413 spinlock_t changed_lock;
414 bool changed;
Rhyland Kleine3805382016-06-22 11:45:52 -0400415 bool initialized;
Krzysztof Kozlowskibc154052015-03-12 08:44:03 +0100416 atomic_t use_cnt;
Jenny TC3be330b2012-05-09 20:36:47 +0530417#ifdef CONFIG_THERMAL
418 struct thermal_zone_device *tzd;
Ramakrishna Pallala952aeeb32012-10-09 22:25:59 +0530419 struct thermal_cooling_device *tcd;
Jenny TC3be330b2012-05-09 20:36:47 +0530420#endif
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400421
422#ifdef CONFIG_LEDS_TRIGGERS
423 struct led_trigger *charging_full_trig;
424 char *charging_full_trig_name;
425 struct led_trigger *charging_trig;
426 char *charging_trig_name;
427 struct led_trigger *full_trig;
428 char *full_trig_name;
429 struct led_trigger *online_trig;
430 char *online_trig_name;
Vasily Khoruzhick6501f722011-01-07 18:28:17 +0200431 struct led_trigger *charging_blink_full_solid_trig;
432 char *charging_blink_full_solid_trig_name;
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400433#endif
434};
435
436/*
437 * This is recommended structure to specify static power supply parameters.
438 * Generic one, parametrizable for different power supplies. Power supply
439 * class itself does not use it, but that's what implementing most platform
440 * drivers, should try reuse for consistency.
441 */
442
443struct power_supply_info {
444 const char *name;
445 int technology;
446 int voltage_max_design;
447 int voltage_min_design;
448 int charge_full_design;
449 int charge_empty_design;
450 int energy_full_design;
451 int energy_empty_design;
452 int use_for_apm;
453};
454
Pali Rohárd36240d2013-11-19 11:18:03 +0100455extern struct atomic_notifier_head power_supply_notifier;
456extern int power_supply_reg_notifier(struct notifier_block *nb);
457extern void power_supply_unreg_notifier(struct notifier_block *nb);
Michał Mirosław9f3b7952013-02-01 20:40:17 +0100458extern struct power_supply *power_supply_get_by_name(const char *name);
Krzysztof Kozlowski1a352462015-03-12 08:44:12 +0100459extern void power_supply_put(struct power_supply *psy);
Sebastian Reichelabce9772013-11-24 17:49:29 +0100460#ifdef CONFIG_OF
461extern struct power_supply *power_supply_get_by_phandle(struct device_node *np,
462 const char *property);
Hans de Goedefe27e1d2015-06-09 23:37:56 +0200463extern struct power_supply *devm_power_supply_get_by_phandle(
464 struct device *dev, const char *property);
Sebastian Reichelabce9772013-11-24 17:49:29 +0100465#else /* !CONFIG_OF */
466static inline struct power_supply *
467power_supply_get_by_phandle(struct device_node *np, const char *property)
468{ return NULL; }
Hans de Goedefe27e1d2015-06-09 23:37:56 +0200469static inline struct power_supply *
470devm_power_supply_get_by_phandle(struct device *dev, const char *property)
471{ return NULL; }
Sebastian Reichelabce9772013-11-24 17:49:29 +0100472#endif /* CONFIG_OF */
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400473extern void power_supply_changed(struct power_supply *psy);
474extern int power_supply_am_i_supplied(struct power_supply *psy);
Daniel Macke5f5ccb2009-07-23 20:35:53 +0200475extern int power_supply_set_battery_charged(struct power_supply *psy);
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400476
Anton Vorontsov0d4ed4e2012-05-04 21:06:19 -0700477#ifdef CONFIG_POWER_SUPPLY
Matthew Garrett942ed162008-08-26 21:09:59 +0100478extern int power_supply_is_system_supplied(void);
479#else
Abhijeet Dharmapurikardcdf2fc2017-03-23 00:53:46 -0700480static inline int power_supply_is_system_supplied(void) { return -EIO; }
Matthew Garrett942ed162008-08-26 21:09:59 +0100481#endif
482
Krzysztof Kozlowskibc154052015-03-12 08:44:03 +0100483extern int power_supply_get_property(struct power_supply *psy,
484 enum power_supply_property psp,
485 union power_supply_propval *val);
486extern int power_supply_set_property(struct power_supply *psy,
487 enum power_supply_property psp,
488 const union power_supply_propval *val);
489extern int power_supply_property_is_writeable(struct power_supply *psy,
490 enum power_supply_property psp);
491extern void power_supply_external_power_changed(struct power_supply *psy);
Krzysztof Kozlowski297d7162015-03-12 08:44:11 +0100492
493extern struct power_supply *__must_check
494power_supply_register(struct device *parent,
495 const struct power_supply_desc *desc,
Krzysztof Kozlowski2dc92152015-03-12 08:44:02 +0100496 const struct power_supply_config *cfg);
Krzysztof Kozlowski297d7162015-03-12 08:44:11 +0100497extern struct power_supply *__must_check
498power_supply_register_no_ws(struct device *parent,
499 const struct power_supply_desc *desc,
Krzysztof Kozlowski2dc92152015-03-12 08:44:02 +0100500 const struct power_supply_config *cfg);
Krzysztof Kozlowski297d7162015-03-12 08:44:11 +0100501extern struct power_supply *__must_check
502devm_power_supply_register(struct device *parent,
503 const struct power_supply_desc *desc,
Krzysztof Kozlowski2dc92152015-03-12 08:44:02 +0100504 const struct power_supply_config *cfg);
Krzysztof Kozlowski297d7162015-03-12 08:44:11 +0100505extern struct power_supply *__must_check
506devm_power_supply_register_no_ws(struct device *parent,
507 const struct power_supply_desc *desc,
Krzysztof Kozlowski2dc92152015-03-12 08:44:02 +0100508 const struct power_supply_config *cfg);
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400509extern void power_supply_unregister(struct power_supply *psy);
Jeremy Fitzhardinge83516652011-12-07 09:15:45 -0800510extern int power_supply_powers(struct power_supply *psy, struct device *dev);
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400511
Krzysztof Kozlowskie44ea362015-03-12 08:44:01 +0100512extern void *power_supply_get_drvdata(struct power_supply *psy);
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400513/* For APM emulation, think legacy userspace. */
514extern struct class *power_supply_class;
515
Rhyland Klein51d07562011-01-25 11:10:06 -0800516static inline bool power_supply_is_amp_property(enum power_supply_property psp)
517{
518 switch (psp) {
519 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
520 case POWER_SUPPLY_PROP_CHARGE_EMPTY_DESIGN:
521 case POWER_SUPPLY_PROP_CHARGE_FULL:
522 case POWER_SUPPLY_PROP_CHARGE_EMPTY:
523 case POWER_SUPPLY_PROP_CHARGE_NOW:
524 case POWER_SUPPLY_PROP_CHARGE_AVG:
525 case POWER_SUPPLY_PROP_CHARGE_COUNTER:
Ramakrishna Pallala3824c472012-05-06 18:16:44 +0530526 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT:
Ramakrishna Pallala2815b782012-07-30 12:49:21 +0530527 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT_MAX:
Rhyland Klein51d07562011-01-25 11:10:06 -0800528 case POWER_SUPPLY_PROP_CURRENT_MAX:
529 case POWER_SUPPLY_PROP_CURRENT_NOW:
530 case POWER_SUPPLY_PROP_CURRENT_AVG:
Ramakrishna Pallalaa8adcc902014-08-27 23:44:08 +0530531 case POWER_SUPPLY_PROP_CURRENT_BOOT:
Abhijeet Dharmapurikardcdf2fc2017-03-23 00:53:46 -0700532 case POWER_SUPPLY_PROP_CHARGE_COUNTER_SHADOW:
533 case POWER_SUPPLY_PROP_INPUT_CURRENT_MAX:
534 case POWER_SUPPLY_PROP_FLASH_CURRENT_MAX:
Rhyland Klein51d07562011-01-25 11:10:06 -0800535 return 1;
536 default:
537 break;
538 }
539
540 return 0;
541}
542
543static inline bool power_supply_is_watt_property(enum power_supply_property psp)
544{
545 switch (psp) {
546 case POWER_SUPPLY_PROP_ENERGY_FULL_DESIGN:
547 case POWER_SUPPLY_PROP_ENERGY_EMPTY_DESIGN:
548 case POWER_SUPPLY_PROP_ENERGY_FULL:
549 case POWER_SUPPLY_PROP_ENERGY_EMPTY:
550 case POWER_SUPPLY_PROP_ENERGY_NOW:
551 case POWER_SUPPLY_PROP_ENERGY_AVG:
552 case POWER_SUPPLY_PROP_VOLTAGE_MAX:
553 case POWER_SUPPLY_PROP_VOLTAGE_MIN:
554 case POWER_SUPPLY_PROP_VOLTAGE_MAX_DESIGN:
555 case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
556 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
557 case POWER_SUPPLY_PROP_VOLTAGE_AVG:
Ramakrishna Pallalaa2ebfe22012-04-10 16:21:20 +0530558 case POWER_SUPPLY_PROP_VOLTAGE_OCV:
Ramakrishna Pallalaa8adcc902014-08-27 23:44:08 +0530559 case POWER_SUPPLY_PROP_VOLTAGE_BOOT:
Ramakrishna Pallala3824c472012-05-06 18:16:44 +0530560 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE:
Ramakrishna Pallala2815b782012-07-30 12:49:21 +0530561 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX:
Rhyland Klein35c9d262011-02-28 16:55:31 -0800562 case POWER_SUPPLY_PROP_POWER_NOW:
Rhyland Klein51d07562011-01-25 11:10:06 -0800563 return 1;
564 default:
565 break;
566 }
567
568 return 0;
569}
570
Anton Vorontsov4a11b592007-05-04 00:27:45 +0400571#endif /* __LINUX_POWER_SUPPLY_H__ */