1 **General Properties** 1 **General Properties**
2 2
3 What: /sys/class/power_supply/<suppl 3 What: /sys/class/power_supply/<supply_name>/manufacturer
4 Date: May 2007 4 Date: May 2007
5 Contact: linux-pm@vger.kernel.org 5 Contact: linux-pm@vger.kernel.org
6 Description: 6 Description:
7 Reports the name of the device 7 Reports the name of the device manufacturer.
8 8
9 Access: Read 9 Access: Read
10 Valid values: Represented as s 10 Valid values: Represented as string
11 11
12 What: /sys/class/power_supply/<suppl 12 What: /sys/class/power_supply/<supply_name>/model_name
13 Date: May 2007 13 Date: May 2007
14 Contact: linux-pm@vger.kernel.org 14 Contact: linux-pm@vger.kernel.org
15 Description: 15 Description:
16 Reports the name of the device 16 Reports the name of the device model.
17 17
18 Access: Read 18 Access: Read
19 Valid values: Represented as s 19 Valid values: Represented as string
20 20
21 What: /sys/class/power_supply/<suppl 21 What: /sys/class/power_supply/<supply_name>/serial_number
22 Date: January 2008 22 Date: January 2008
23 Contact: linux-pm@vger.kernel.org 23 Contact: linux-pm@vger.kernel.org
24 Description: 24 Description:
25 Reports the serial number of t 25 Reports the serial number of the device.
26 26
27 Access: Read 27 Access: Read
28 Valid values: Represented as s 28 Valid values: Represented as string
29 29
30 What: /sys/class/power_supply/<suppl 30 What: /sys/class/power_supply/<supply_name>/type
31 Date: May 2010 31 Date: May 2010
32 Contact: linux-pm@vger.kernel.org 32 Contact: linux-pm@vger.kernel.org
33 Description: 33 Description:
34 Describes the main type of the 34 Describes the main type of the supply.
35 35
36 Access: Read 36 Access: Read
37 Valid values: "Battery", "UPS" 37 Valid values: "Battery", "UPS", "Mains", "USB", "Wireless"
38 38
39 **Battery and USB properties** 39 **Battery and USB properties**
40 40
41 What: /sys/class/power_supply/<suppl 41 What: /sys/class/power_supply/<supply_name>/current_avg
42 Date: May 2007 42 Date: May 2007
43 Contact: linux-pm@vger.kernel.org 43 Contact: linux-pm@vger.kernel.org
44 Description: 44 Description:
45 Battery: 45 Battery:
46 46
47 Reports an average IBAT curr 47 Reports an average IBAT current reading for the battery, over
48 a fixed period. Normally dev 48 a fixed period. Normally devices will provide a fixed interval
49 in which they average readin 49 in which they average readings to smooth out the reported
50 value. 50 value.
51 51
52 USB: 52 USB:
53 53
54 Reports an average IBUS curr 54 Reports an average IBUS current reading over a fixed period.
55 Normally devices will provid 55 Normally devices will provide a fixed interval in which they
56 average readings to smooth o 56 average readings to smooth out the reported value.
57 57
58 Access: Read 58 Access: Read
59 59
60 Valid values: Represented in m 60 Valid values: Represented in microamps. Negative values are
61 used for discharging batteries 61 used for discharging batteries, positive values for charging
62 batteries and for USB IBUS cur 62 batteries and for USB IBUS current.
63 63
64 What: /sys/class/power_supply/<suppl 64 What: /sys/class/power_supply/<supply_name>/current_max
65 Date: October 2010 65 Date: October 2010
66 Contact: linux-pm@vger.kernel.org 66 Contact: linux-pm@vger.kernel.org
67 Description: 67 Description:
68 Battery: 68 Battery:
69 69
70 Reports the maximum IBAT cur 70 Reports the maximum IBAT current allowed into the battery.
71 71
72 USB: 72 USB:
73 73
74 Reports the maximum IBUS cur 74 Reports the maximum IBUS current the supply can support.
75 75
76 Access: Read 76 Access: Read
77 Valid values: Represented in m 77 Valid values: Represented in microamps
78 78
79 What: /sys/class/power_supply/<suppl 79 What: /sys/class/power_supply/<supply_name>/current_now
80 Date: May 2007 80 Date: May 2007
81 Contact: linux-pm@vger.kernel.org 81 Contact: linux-pm@vger.kernel.org
82 Description: 82 Description:
83 83
84 Battery: 84 Battery:
85 85
86 Reports an instant, single I 86 Reports an instant, single IBAT current reading for the
87 battery. This value is not a 87 battery. This value is not averaged/smoothed.
88 88
89 Access: Read 89 Access: Read
90 90
91 USB: 91 USB:
92 92
93 Reports the IBUS current sup 93 Reports the IBUS current supplied now. This value is generally
94 read-only reporting, unless 94 read-only reporting, unless the 'online' state of the supply
95 is set to be programmable, i 95 is set to be programmable, in which case this value can be set
96 within the reported min/max 96 within the reported min/max range.
97 97
98 Access: Read, Write 98 Access: Read, Write
99 99
100 Valid values: Represented in m 100 Valid values: Represented in microamps. Negative values are
101 used for discharging batteries 101 used for discharging batteries, positive values for charging
102 batteries and for USB IBUS cur 102 batteries and for USB IBUS current.
103 103
104 What: /sys/class/power_supply/<suppl 104 What: /sys/class/power_supply/<supply_name>/temp
105 Date: May 2007 105 Date: May 2007
106 Contact: linux-pm@vger.kernel.org 106 Contact: linux-pm@vger.kernel.org
107 Description: 107 Description:
108 Battery: 108 Battery:
109 109
110 Reports the current TBAT bat 110 Reports the current TBAT battery temperature reading.
111 111
112 USB: 112 USB:
113 113
114 Reports the current supply t 114 Reports the current supply temperature reading. This would
115 normally be the internal tem 115 normally be the internal temperature of the device itself
116 (e.g TJUNC temperature of an 116 (e.g TJUNC temperature of an IC)
117 117
118 Access: Read 118 Access: Read
119 119
120 Valid values: Represented in 1 120 Valid values: Represented in 1/10 Degrees Celsius
121 121
122 What: /sys/class/power_supply/<suppl 122 What: /sys/class/power_supply/<supply_name>/temp_alert_max
123 Date: July 2012 123 Date: July 2012
124 Contact: linux-pm@vger.kernel.org 124 Contact: linux-pm@vger.kernel.org
125 Description: 125 Description:
126 Battery: 126 Battery:
127 127
128 Maximum TBAT temperature tri 128 Maximum TBAT temperature trip-wire value where the supply will
129 notify user-space of the eve 129 notify user-space of the event.
130 130
131 USB: 131 USB:
132 132
133 Maximum supply temperature t 133 Maximum supply temperature trip-wire value where the supply
134 will notify user-space of th 134 will notify user-space of the event.
135 135
136 This is normally used for the 136 This is normally used for the charging scenario where
137 user-space needs to know if th 137 user-space needs to know if the temperature has crossed an
138 upper threshold so it can take 138 upper threshold so it can take appropriate action (e.g. warning
139 user that the temperature is c 139 user that the temperature is critically high, and charging has
140 stopped). 140 stopped).
141 141
142 Access: Read 142 Access: Read
143 143
144 Valid values: Represented in 1 144 Valid values: Represented in 1/10 Degrees Celsius
145 145
146 What: /sys/class/power_supply/<suppl 146 What: /sys/class/power_supply/<supply_name>/temp_alert_min
147 Date: July 2012 147 Date: July 2012
148 Contact: linux-pm@vger.kernel.org 148 Contact: linux-pm@vger.kernel.org
149 Description: 149 Description:
150 150
151 Battery: 151 Battery:
152 152
153 Minimum TBAT temperature tri 153 Minimum TBAT temperature trip-wire value where the supply will
154 notify user-space of the eve 154 notify user-space of the event.
155 155
156 USB: 156 USB:
157 157
158 Minimum supply temperature t 158 Minimum supply temperature trip-wire value where the supply
159 will notify user-space of th 159 will notify user-space of the event.
160 160
161 This is normally used for the 161 This is normally used for the charging scenario where user-space
162 needs to know if the temperatu 162 needs to know if the temperature has crossed a lower threshold
163 so it can take appropriate act 163 so it can take appropriate action (e.g. warning user that
164 temperature level is high, and 164 temperature level is high, and charging current has been
165 reduced accordingly to remedy 165 reduced accordingly to remedy the situation).
166 166
167 Access: Read 167 Access: Read
168 168
169 Valid values: Represented in 1 169 Valid values: Represented in 1/10 Degrees Celsius
170 170
171 What: /sys/class/power_supply/<suppl 171 What: /sys/class/power_supply/<supply_name>/temp_max
172 Date: July 2014 172 Date: July 2014
173 Contact: linux-pm@vger.kernel.org 173 Contact: linux-pm@vger.kernel.org
174 Description: 174 Description:
175 Battery: 175 Battery:
176 176
177 Reports the maximum allowed 177 Reports the maximum allowed TBAT battery temperature for
178 charging. 178 charging.
179 179
180 USB: 180 USB:
181 181
182 Reports the maximum allowed 182 Reports the maximum allowed supply temperature for operation.
183 183
184 Access: Read 184 Access: Read
185 185
186 Valid values: Represented in 1 186 Valid values: Represented in 1/10 Degrees Celsius
187 187
188 What: /sys/class/power_supply/<suppl 188 What: /sys/class/power_supply/<supply_name>/temp_min
189 Date: July 2014 189 Date: July 2014
190 Contact: linux-pm@vger.kernel.org 190 Contact: linux-pm@vger.kernel.org
191 Description: 191 Description:
192 Battery: 192 Battery:
193 193
194 Reports the minimum allowed 194 Reports the minimum allowed TBAT battery temperature for
195 charging. 195 charging.
196 196
197 USB: 197 USB:
198 198
199 Reports the minimum allowed 199 Reports the minimum allowed supply temperature for operation.
200 200
201 Access: Read 201 Access: Read
202 202
203 Valid values: Represented in 1 203 Valid values: Represented in 1/10 Degrees Celsius
204 204
205 What: /sys/class/power_supply/<suppl 205 What: /sys/class/power_supply/<supply_name>/voltage_max,
206 Date: January 2008 206 Date: January 2008
207 Contact: linux-pm@vger.kernel.org 207 Contact: linux-pm@vger.kernel.org
208 Description: 208 Description:
209 Battery: 209 Battery:
210 210
211 Reports the maximum safe VBA 211 Reports the maximum safe VBAT voltage permitted for the
212 battery, during charging. 212 battery, during charging.
213 213
214 USB: 214 USB:
215 215
216 Reports the maximum VBUS vol 216 Reports the maximum VBUS voltage the supply can support.
217 217
218 Access: Read 218 Access: Read
219 219
220 Valid values: Represented in m 220 Valid values: Represented in microvolts
221 221
222 What: /sys/class/power_supply/<suppl 222 What: /sys/class/power_supply/<supply_name>/voltage_min,
223 Date: January 2008 223 Date: January 2008
224 Contact: linux-pm@vger.kernel.org 224 Contact: linux-pm@vger.kernel.org
225 Description: 225 Description:
226 Battery: 226 Battery:
227 227
228 Reports the minimum safe VBA 228 Reports the minimum safe VBAT voltage permitted for the
229 battery, during discharging. 229 battery, during discharging.
230 230
231 USB: 231 USB:
232 232
233 Reports the minimum VBUS vol 233 Reports the minimum VBUS voltage the supply can support.
234 234
235 Access: Read 235 Access: Read
236 236
237 Valid values: Represented in m 237 Valid values: Represented in microvolts
238 238
239 What: /sys/class/power_supply/<suppl 239 What: /sys/class/power_supply/<supply_name>/voltage_now,
240 Date: May 2007 240 Date: May 2007
241 Contact: linux-pm@vger.kernel.org 241 Contact: linux-pm@vger.kernel.org
242 Description: 242 Description:
243 Battery: 243 Battery:
244 244
245 Reports an instant, single V 245 Reports an instant, single VBAT voltage reading for the
246 battery. This value is not a 246 battery. This value is not averaged/smoothed.
247 247
248 Access: Read 248 Access: Read
249 249
250 USB: 250 USB:
251 251
252 Reports the VBUS voltage sup 252 Reports the VBUS voltage supplied now. This value is generally
253 read-only reporting, unless 253 read-only reporting, unless the 'online' state of the supply
254 is set to be programmable, i 254 is set to be programmable, in which case this value can be set
255 within the reported min/max 255 within the reported min/max range.
256 256
257 Access: Read, Write 257 Access: Read, Write
258 258
259 Valid values: Represented in m 259 Valid values: Represented in microvolts
260 260
261 **Battery Properties** 261 **Battery Properties**
262 262
263 What: /sys/class/power_supply/<suppl 263 What: /sys/class/power_supply/<supply_name>/capacity
264 Date: May 2007 264 Date: May 2007
265 Contact: linux-pm@vger.kernel.org 265 Contact: linux-pm@vger.kernel.org
266 Description: 266 Description:
267 Fine grain representation of b 267 Fine grain representation of battery capacity.
268 268
269 Access: Read 269 Access: Read
270 270
271 Valid values: 0 - 100 (percent 271 Valid values: 0 - 100 (percent)
272 272
273 What: /sys/class/power_supply/<suppl 273 What: /sys/class/power_supply/<supply_name>/capacity_alert_max
274 Date: July 2012 274 Date: July 2012
275 Contact: linux-pm@vger.kernel.org 275 Contact: linux-pm@vger.kernel.org
276 Description: 276 Description:
277 Maximum battery capacity trip- 277 Maximum battery capacity trip-wire value where the supply will
278 notify user-space of the event 278 notify user-space of the event. This is normally used for the
279 battery discharging scenario w 279 battery discharging scenario where user-space needs to know the
280 battery has dropped to an uppe 280 battery has dropped to an upper level so it can take
281 appropriate action (e.g. warni 281 appropriate action (e.g. warning user that battery level is
282 low). 282 low).
283 283
284 Access: Read, Write 284 Access: Read, Write
285 285
286 Valid values: 0 - 100 (percent 286 Valid values: 0 - 100 (percent)
287 287
288 What: /sys/class/power_supply/<suppl 288 What: /sys/class/power_supply/<supply_name>/capacity_alert_min
289 Date: July 2012 289 Date: July 2012
290 Contact: linux-pm@vger.kernel.org 290 Contact: linux-pm@vger.kernel.org
291 Description: 291 Description:
292 Minimum battery capacity trip- 292 Minimum battery capacity trip-wire value where the supply will
293 notify user-space of the event 293 notify user-space of the event. This is normally used for the
294 battery discharging scenario w 294 battery discharging scenario where user-space needs to know the
295 battery has dropped to a lower 295 battery has dropped to a lower level so it can take
296 appropriate action (e.g. warni 296 appropriate action (e.g. warning user that battery level is
297 critically low). 297 critically low).
298 298
299 Access: Read, Write 299 Access: Read, Write
300 300
301 Valid values: 0 - 100 (percent 301 Valid values: 0 - 100 (percent)
302 302
303 What: /sys/class/power_supply/<suppl 303 What: /sys/class/power_supply/<supply_name>/capacity_error_margin
304 Date: April 2019 304 Date: April 2019
305 Contact: linux-pm@vger.kernel.org 305 Contact: linux-pm@vger.kernel.org
306 Description: 306 Description:
307 Battery capacity measurement b 307 Battery capacity measurement becomes unreliable without
308 recalibration. This values pro 308 recalibration. This values provides the maximum error
309 margin expected to exist by th 309 margin expected to exist by the fuel gauge in percent.
310 Values close to 0% will be ret 310 Values close to 0% will be returned after (re-)calibration
311 has happened. Over time the er 311 has happened. Over time the error margin will increase.
312 100% means, that the capacity 312 100% means, that the capacity related values are basically
313 completely useless. 313 completely useless.
314 314
315 Access: Read 315 Access: Read
316 316
317 Valid values: 0 - 100 (percent 317 Valid values: 0 - 100 (percent)
318 318
319 What: /sys/class/power_supply/<suppl 319 What: /sys/class/power_supply/<supply_name>/capacity_level
320 Date: June 2009 320 Date: June 2009
321 Contact: linux-pm@vger.kernel.org 321 Contact: linux-pm@vger.kernel.org
322 Description: 322 Description:
323 Coarse representation of batte 323 Coarse representation of battery capacity.
324 324
325 Access: Read 325 Access: Read
326 326
327 Valid values: 327 Valid values:
328 "Unknown", "Crit 328 "Unknown", "Critical", "Low", "Normal", "High",
329 "Full" 329 "Full"
330 330
331 What: /sys/class/power_supply/<suppl 331 What: /sys/class/power_supply/<supply_name>/charge_control_limit
332 Date: Oct 2012 332 Date: Oct 2012
333 Contact: linux-pm@vger.kernel.org 333 Contact: linux-pm@vger.kernel.org
334 Description: 334 Description:
335 Maximum allowable charging cur 335 Maximum allowable charging current. Used for charge rate
336 throttling for thermal cooling 336 throttling for thermal cooling or improving battery health.
337 337
338 Access: Read, Write 338 Access: Read, Write
339 339
340 Valid values: Represented in m 340 Valid values: Represented in microamps
341 341
342 What: /sys/class/power_supply/<suppl 342 What: /sys/class/power_supply/<supply_name>/charge_control_limit_max
343 Date: Oct 2012 343 Date: Oct 2012
344 Contact: linux-pm@vger.kernel.org 344 Contact: linux-pm@vger.kernel.org
345 Description: 345 Description:
346 Maximum legal value for the ch 346 Maximum legal value for the charge_control_limit property.
347 347
348 Access: Read 348 Access: Read
349 349
350 Valid values: Represented in m 350 Valid values: Represented in microamps
351 351
352 What: /sys/class/power_supply/<suppl 352 What: /sys/class/power_supply/<supply_name>/charge_control_start_threshold
353 Date: April 2019 353 Date: April 2019
354 Contact: linux-pm@vger.kernel.org 354 Contact: linux-pm@vger.kernel.org
355 Description: 355 Description:
356 Represents a battery percentag 356 Represents a battery percentage level, below which charging will
357 begin. 357 begin.
358 358
359 Access: Read, Write 359 Access: Read, Write
360 Valid values: 0 - 100 (percent 360 Valid values: 0 - 100 (percent)
361 361
362 What: /sys/class/power_supply/<suppl 362 What: /sys/class/power_supply/<supply_name>/charge_control_end_threshold
363 Date: April 2019 363 Date: April 2019
364 Contact: linux-pm@vger.kernel.org 364 Contact: linux-pm@vger.kernel.org
365 Description: 365 Description:
366 Represents a battery percentag 366 Represents a battery percentage level, above which charging will
367 stop. Not all hardware is capa 367 stop. Not all hardware is capable of setting this to an arbitrary
368 percentage. Drivers will round 368 percentage. Drivers will round written values to the nearest
369 supported value. Reading back 369 supported value. Reading back the value will show the actual
370 threshold set by the driver. 370 threshold set by the driver.
371 371
372 Access: Read, Write 372 Access: Read, Write
373 373
374 Valid values: 0 - 100 (percent 374 Valid values: 0 - 100 (percent)
375 375
376 What: /sys/class/power_supply/<suppl 376 What: /sys/class/power_supply/<supply_name>/charge_type
377 Date: July 2009 377 Date: July 2009
378 Contact: linux-pm@vger.kernel.org 378 Contact: linux-pm@vger.kernel.org
379 Description: 379 Description:
380 Select the charging algorithm 380 Select the charging algorithm to use for a battery.
381 381
382 Standard: 382 Standard:
383 Fully charge the batte 383 Fully charge the battery at a moderate rate.
384 Fast: 384 Fast:
385 Quickly charge the bat 385 Quickly charge the battery using fast-charge
386 technology. This is ty 386 technology. This is typically harder on the battery
387 than standard charging 387 than standard charging and may lower its lifespan.
388 Trickle: 388 Trickle:
389 Users who primarily op 389 Users who primarily operate the system while
390 plugged into an extern 390 plugged into an external power source can extend
391 battery life with this 391 battery life with this mode. Vendor tooling may
392 call this "Primarily A 392 call this "Primarily AC Use".
393 Adaptive: 393 Adaptive:
394 Automatically optimize 394 Automatically optimize battery charge rate based
395 on typical usage patte 395 on typical usage pattern.
396 Custom: 396 Custom:
397 Use the charge_control 397 Use the charge_control_* properties to determine
398 when to start and stop 398 when to start and stop charging. Advanced users
399 can use this to drasti 399 can use this to drastically extend battery life.
400 Long Life: 400 Long Life:
401 The charger reduces it 401 The charger reduces its charging rate in order to
402 prolong the battery he 402 prolong the battery health.
403 Bypass: 403 Bypass:
404 The charger bypasses t 404 The charger bypasses the charging path around the
405 integrated converter a 405 integrated converter allowing for a "smart" wall
406 adaptor to perform the 406 adaptor to perform the power conversion externally.
407 407
408 Access: Read, Write 408 Access: Read, Write
409 409
410 Valid values: 410 Valid values:
411 "Unknown", "N/A" 411 "Unknown", "N/A", "Trickle", "Fast", "Standard",
412 "Adaptive", "Cus 412 "Adaptive", "Custom", "Long Life", "Bypass"
413 413
414 What: /sys/class/power_supply/<suppl 414 What: /sys/class/power_supply/<supply_name>/charge_term_current
415 Date: July 2014 415 Date: July 2014
416 Contact: linux-pm@vger.kernel.org 416 Contact: linux-pm@vger.kernel.org
417 Description: 417 Description:
418 Reports the charging current v 418 Reports the charging current value which is used to determine
419 when the battery is considered 419 when the battery is considered full and charging should end.
420 420
421 Access: Read 421 Access: Read
422 422
423 Valid values: Represented in m 423 Valid values: Represented in microamps
424 424
425 What: /sys/class/power_supply/<suppl 425 What: /sys/class/power_supply/<supply_name>/health
426 Date: May 2007 426 Date: May 2007
427 Contact: linux-pm@vger.kernel.org 427 Contact: linux-pm@vger.kernel.org
428 Description: 428 Description:
429 Reports the health of the batt 429 Reports the health of the battery or battery side of charger
430 functionality. 430 functionality.
431 431
432 Access: Read 432 Access: Read
433 433
434 Valid values: 434 Valid values:
435 "Unknown", "Good 435 "Unknown", "Good", "Overheat", "Dead",
436 "Over voltage", 436 "Over voltage", "Unspecified failure", "Cold",
437 "Watchdog timer 437 "Watchdog timer expire", "Safety timer expire",
438 "Over current", 438 "Over current", "Calibration required", "Warm",
439 "Cool", "Hot", " 439 "Cool", "Hot", "No battery"
440 440
441 What: /sys/class/power_supply/<suppl 441 What: /sys/class/power_supply/<supply_name>/precharge_current
442 Date: June 2017 442 Date: June 2017
443 Contact: linux-pm@vger.kernel.org 443 Contact: linux-pm@vger.kernel.org
444 Description: 444 Description:
445 Reports the charging current a 445 Reports the charging current applied during pre-charging phase
446 for a battery charge cycle. 446 for a battery charge cycle.
447 447
448 Access: Read 448 Access: Read
449 449
450 Valid values: Represented in m 450 Valid values: Represented in microamps
451 451
452 What: /sys/class/power_supply/<suppl 452 What: /sys/class/power_supply/<supply_name>/present
453 Date: May 2007 453 Date: May 2007
454 Contact: linux-pm@vger.kernel.org 454 Contact: linux-pm@vger.kernel.org
455 Description: 455 Description:
456 Reports whether a battery is p 456 Reports whether a battery is present or not in the system. If the
457 property does not exist, the b 457 property does not exist, the battery is considered to be present.
458 458
459 Access: Read 459 Access: Read
460 460
461 Valid values: 461 Valid values:
462 462
463 == ======= 463 == =======
464 0: Absent 464 0: Absent
465 1: Present 465 1: Present
466 == ======= 466 == =======
467 467
468 What: /sys/class/power_supply/<suppl 468 What: /sys/class/power_supply/<supply_name>/status
469 Date: May 2007 469 Date: May 2007
470 Contact: linux-pm@vger.kernel.org 470 Contact: linux-pm@vger.kernel.org
471 Description: 471 Description:
472 Represents the charging status 472 Represents the charging status of the battery. Normally this
473 is read-only reporting althoug 473 is read-only reporting although for some supplies this can be
474 used to enable/disable chargin 474 used to enable/disable charging to the battery.
475 475
476 Access: Read, Write 476 Access: Read, Write
477 477
478 Valid values: 478 Valid values:
479 "Unknown", "Char 479 "Unknown", "Charging", "Discharging",
480 "Not charging", 480 "Not charging", "Full"
481 481
482 What: /sys/class/power_supply/<suppl 482 What: /sys/class/power_supply/<supply_name>/charge_behaviour
483 Date: November 2021 483 Date: November 2021
484 Contact: linux-pm@vger.kernel.org 484 Contact: linux-pm@vger.kernel.org
485 Description: 485 Description:
486 Represents the charging behavi 486 Represents the charging behaviour.
487 487
488 Access: Read, Write 488 Access: Read, Write
489 489
490 Valid values: 490 Valid values:
491 ================ ===== 491 ================ ====================================
492 auto: Charg 492 auto: Charge normally, respect thresholds
493 inhibit-charge: Do no 493 inhibit-charge: Do not charge while AC is attached
494 force-discharge: Force 494 force-discharge: Force discharge while AC is attached
495 ================ ===== 495 ================ ====================================
496 496
497 What: /sys/class/power_supply/<suppl 497 What: /sys/class/power_supply/<supply_name>/technology
498 Date: May 2007 498 Date: May 2007
499 Contact: linux-pm@vger.kernel.org 499 Contact: linux-pm@vger.kernel.org
500 Description: 500 Description:
501 Describes the battery technolo 501 Describes the battery technology supported by the supply.
502 502
503 Access: Read 503 Access: Read
504 504
505 Valid values: 505 Valid values:
506 "Unknown", "NiMH 506 "Unknown", "NiMH", "Li-ion", "Li-poly", "LiFe",
507 "NiCd", "LiMn" 507 "NiCd", "LiMn"
508 508
509 509
510 What: /sys/class/power_supply/<suppl 510 What: /sys/class/power_supply/<supply_name>/voltage_avg,
511 Date: May 2007 511 Date: May 2007
512 Contact: linux-pm@vger.kernel.org 512 Contact: linux-pm@vger.kernel.org
513 Description: 513 Description:
514 Reports an average VBAT voltag 514 Reports an average VBAT voltage reading for the battery, over a
515 fixed period. Normally devices 515 fixed period. Normally devices will provide a fixed interval in
516 which they average readings to 516 which they average readings to smooth out the reported value.
517 517
518 Access: Read 518 Access: Read
519 519
520 Valid values: Represented in m 520 Valid values: Represented in microvolts
521 521
522 What: /sys/class/power_supply/<suppl 522 What: /sys/class/power_supply/<supply_name>/cycle_count
523 Date: January 2010 523 Date: January 2010
524 Contact: linux-pm@vger.kernel.org 524 Contact: linux-pm@vger.kernel.org
525 Description: 525 Description:
526 Reports the number of full cha 526 Reports the number of full charge + discharge cycles the
527 battery has undergone. 527 battery has undergone.
528 528
529 Access: Read 529 Access: Read
530 530
531 Valid values: 531 Valid values:
532 Integer > 0: represent 532 Integer > 0: representing full cycles
533 Integer = 0: cycle_cou 533 Integer = 0: cycle_count info is not available
534 534
535 **USB Properties** 535 **USB Properties**
536 536
537 What: /sys/class/power_supply/<suppl 537 What: /sys/class/power_supply/<supply_name>/input_current_limit
538 Date: July 2014 538 Date: July 2014
539 Contact: linux-pm@vger.kernel.org 539 Contact: linux-pm@vger.kernel.org
540 Description: 540 Description:
541 Details the incoming IBUS curr 541 Details the incoming IBUS current limit currently set in the
542 supply. Normally this is confi 542 supply. Normally this is configured based on the type of
543 connection made (e.g. A config 543 connection made (e.g. A configured SDP should output a maximum
544 of 500mA so the input current 544 of 500mA so the input current limit is set to the same value).
545 Use preferably input_power_lim 545 Use preferably input_power_limit, and for problems that can be
546 solved using power limit use i 546 solved using power limit use input_current_limit.
547 547
548 Access: Read, Write 548 Access: Read, Write
549 549
550 Valid values: Represented in m 550 Valid values: Represented in microamps
551 551
552 What: /sys/class/power_supply/<suppl 552 What: /sys/class/power_supply/<supply_name>/input_voltage_limit
553 Date: May 2019 553 Date: May 2019
554 Contact: linux-pm@vger.kernel.org 554 Contact: linux-pm@vger.kernel.org
555 Description: 555 Description:
556 This entry configures the inco 556 This entry configures the incoming VBUS voltage limit currently
557 set in the supply. Normally th 557 set in the supply. Normally this is configured based on
558 system-level knowledge or user 558 system-level knowledge or user input (e.g. This is part of the
559 Pixel C's thermal management s 559 Pixel C's thermal management strategy to effectively limit the
560 input power to 5V when the scr 560 input power to 5V when the screen is on to meet Google's skin
561 temperature targets). Note tha 561 temperature targets). Note that this feature should not be
562 used for safety critical thing 562 used for safety critical things.
563 Use preferably input_power_lim 563 Use preferably input_power_limit, and for problems that can be
564 solved using power limit use i 564 solved using power limit use input_voltage_limit.
565 565
566 Access: Read, Write 566 Access: Read, Write
567 567
568 Valid values: Represented in m 568 Valid values: Represented in microvolts
569 569
570 What: /sys/class/power_supply/<suppl 570 What: /sys/class/power_supply/<supply_name>/input_power_limit
571 Date: May 2019 571 Date: May 2019
572 Contact: linux-pm@vger.kernel.org 572 Contact: linux-pm@vger.kernel.org
573 Description: 573 Description:
574 This entry configures the inco 574 This entry configures the incoming power limit currently set
575 in the supply. Normally this i 575 in the supply. Normally this is configured based on
576 system-level knowledge or user 576 system-level knowledge or user input. Use preferably this
577 feature to limit the incoming 577 feature to limit the incoming power and use current/voltage
578 limit only for problems that c 578 limit only for problems that can be solved using power limit.
579 579
580 Access: Read, Write 580 Access: Read, Write
581 581
582 Valid values: Represented in m 582 Valid values: Represented in microwatts
583 583
584 What: /sys/class/power_supply/<suppl 584 What: /sys/class/power_supply/<supply_name>/online,
585 Date: May 2007 585 Date: May 2007
586 Contact: linux-pm@vger.kernel.org 586 Contact: linux-pm@vger.kernel.org
587 Description: 587 Description:
588 Indicates if VBUS is present f 588 Indicates if VBUS is present for the supply. When the supply is
589 online, and the supply allows 589 online, and the supply allows it, then it's possible to switch
590 between online states (e.g. Fi 590 between online states (e.g. Fixed -> Programmable for a PD_PPS
591 USB supply so voltage and curr 591 USB supply so voltage and current can be controlled).
592 592
593 Access: Read, Write 593 Access: Read, Write
594 594
595 Valid values: 595 Valid values:
596 596
597 == =================== 597 == ==================================================
598 0: Offline 598 0: Offline
599 1: Online Fixed - Fixe 599 1: Online Fixed - Fixed Voltage Supply
600 2: Online Programmable 600 2: Online Programmable - Programmable Voltage Supply
601 == =================== 601 == ==================================================
602 602
603 What: /sys/class/power_supply/<suppl 603 What: /sys/class/power_supply/<supply_name>/usb_type
604 Date: March 2018 604 Date: March 2018
605 Contact: linux-pm@vger.kernel.org 605 Contact: linux-pm@vger.kernel.org
606 Description: 606 Description:
607 Reports what type of USB conne 607 Reports what type of USB connection is currently active for
608 the supply, for example it can 608 the supply, for example it can show if USB-PD capable source
609 is attached. 609 is attached.
610 610
611 Access: For power-supplies whi 611 Access: For power-supplies which consume USB power such
612 as battery charger chips, this 612 as battery charger chips, this indicates the type of
613 the connected USB power source 613 the connected USB power source and is Read-Only.
614 614
615 For power-supplies which act a 615 For power-supplies which act as a USB power-source such as
616 e.g. the UCS1002 USB Port Powe 616 e.g. the UCS1002 USB Port Power Controller this is writable.
617 617
618 Valid values: 618 Valid values:
619 "Unknown", "SDP" 619 "Unknown", "SDP", "DCP", "CDP", "ACA", "C", "PD",
620 "PD_DRP", "PD_PP 620 "PD_DRP", "PD_PPS", "BrickID"
621 621
622 **Device Specific Properties** 622 **Device Specific Properties**
623 623
624 What: /sys/class/power/ds2760-batter 624 What: /sys/class/power/ds2760-battery.*/charge_now
625 Date: May 2010 625 Date: May 2010
626 KernelVersion: 2.6.35 626 KernelVersion: 2.6.35
627 Contact: Daniel Mack <daniel@caiaq.de> 627 Contact: Daniel Mack <daniel@caiaq.de>
628 Description: 628 Description:
629 This file is writeable and can 629 This file is writeable and can be used to set the current
630 coloumb counter value inside t 630 coloumb counter value inside the battery monitor chip. This
631 is needed for unavoidable corr 631 is needed for unavoidable corrections of aging batteries.
632 A userspace daemon can monitor 632 A userspace daemon can monitor the battery charging logic
633 and once the counter drops out 633 and once the counter drops out of considerable bounds, take
634 appropriate action. 634 appropriate action.
635 635
636 What: /sys/class/power/ds2760-batter 636 What: /sys/class/power/ds2760-battery.*/charge_full
637 Date: May 2010 637 Date: May 2010
638 KernelVersion: 2.6.35 638 KernelVersion: 2.6.35
639 Contact: Daniel Mack <daniel@caiaq.de> 639 Contact: Daniel Mack <daniel@caiaq.de>
640 Description: 640 Description:
641 This file is writeable and can 641 This file is writeable and can be used to set the assumed
642 battery 'full level'. As batte 642 battery 'full level'. As batteries age, this value has to be
643 amended over time. 643 amended over time.
644 644
645 What: /sys/class/power_supply/max145 645 What: /sys/class/power_supply/max14577-charger/device/fast_charge_timer
646 Date: October 2014 646 Date: October 2014
647 KernelVersion: 3.18.0 647 KernelVersion: 3.18.0
648 Contact: Krzysztof Kozlowski <krzk@kerne 648 Contact: Krzysztof Kozlowski <krzk@kernel.org>
649 Description: 649 Description:
650 This entry shows and sets the 650 This entry shows and sets the maximum time the max14577
651 charger operates in fast-charg 651 charger operates in fast-charge mode. When the timer expires
652 the device will terminate fast 652 the device will terminate fast-charge mode (charging current
653 will drop to 0 A) and will tri 653 will drop to 0 A) and will trigger interrupt.
654 654
655 Valid values: 655 Valid values:
656 656
657 - 5, 6 or 7 (hours), 657 - 5, 6 or 7 (hours),
658 - 0: disabled. 658 - 0: disabled.
659 659
660 What: /sys/class/power_supply/max776 660 What: /sys/class/power_supply/max77693-charger/device/fast_charge_timer
661 Date: January 2015 661 Date: January 2015
662 KernelVersion: 3.19.0 662 KernelVersion: 3.19.0
663 Contact: Krzysztof Kozlowski <krzk@kerne 663 Contact: Krzysztof Kozlowski <krzk@kernel.org>
664 Description: 664 Description:
665 This entry shows and sets the 665 This entry shows and sets the maximum time the max77693
666 charger operates in fast-charg 666 charger operates in fast-charge mode. When the timer expires
667 the device will terminate fast 667 the device will terminate fast-charge mode (charging current
668 will drop to 0 A) and will tri 668 will drop to 0 A) and will trigger interrupt.
669 669
670 Valid values: 670 Valid values:
671 671
672 - 4 - 16 (hours), step by 2 (r 672 - 4 - 16 (hours), step by 2 (rounded down)
673 - 0: disabled. 673 - 0: disabled.
674 674
675 What: /sys/class/power_supply/max776 675 What: /sys/class/power_supply/max77693-charger/device/top_off_threshold_current
676 Date: January 2015 676 Date: January 2015
677 KernelVersion: 3.19.0 677 KernelVersion: 3.19.0
678 Contact: Krzysztof Kozlowski <krzk@kerne 678 Contact: Krzysztof Kozlowski <krzk@kernel.org>
679 Description: 679 Description:
680 This entry shows and sets the 680 This entry shows and sets the charging current threshold for
681 entering top-off charging mode 681 entering top-off charging mode. When charging current in fast
682 charge mode drops below this v 682 charge mode drops below this value, the charger will trigger
683 interrupt and start top-off ch 683 interrupt and start top-off charging mode.
684 684
685 Valid values: 685 Valid values:
686 686
687 - 100000 - 200000 (microamps), 687 - 100000 - 200000 (microamps), step by 25000 (rounded down)
688 - 200000 - 350000 (microamps), 688 - 200000 - 350000 (microamps), step by 50000 (rounded down)
689 - 0: disabled. 689 - 0: disabled.
690 690
691 What: /sys/class/power_supply/max776 691 What: /sys/class/power_supply/max77693-charger/device/top_off_timer
692 Date: January 2015 692 Date: January 2015
693 KernelVersion: 3.19.0 693 KernelVersion: 3.19.0
694 Contact: Krzysztof Kozlowski <krzk@kerne 694 Contact: Krzysztof Kozlowski <krzk@kernel.org>
695 Description: 695 Description:
696 This entry shows and sets the 696 This entry shows and sets the maximum time the max77693
697 charger operates in top-off ch 697 charger operates in top-off charge mode. When the timer expires
698 the device will terminate top- 698 the device will terminate top-off charge mode (charging current
699 will drop to 0 A) and will tri 699 will drop to 0 A) and will trigger interrupt.
700 700
701 Valid values: 701 Valid values:
702 702
703 - 0 - 70 (minutes), step by 10 703 - 0 - 70 (minutes), step by 10 (rounded down)
704 704
705 What: /sys/class/power_supply/bq2425 705 What: /sys/class/power_supply/bq24257-charger/ovp_voltage
706 Date: October 2015 706 Date: October 2015
707 KernelVersion: 4.4.0 707 KernelVersion: 4.4.0
708 Contact: Andreas Dannenberg <dannenberg@ 708 Contact: Andreas Dannenberg <dannenberg@ti.com>
709 Description: 709 Description:
710 This entry configures the over 710 This entry configures the overvoltage protection feature of bq24257-
711 type charger devices. This fea 711 type charger devices. This feature protects the device and other
712 components against damage from 712 components against damage from overvoltage on the input supply. See
713 device datasheet for details. 713 device datasheet for details.
714 714
715 Valid values: 715 Valid values:
716 716
717 - 6000000, 6500000, 7000000, 8 717 - 6000000, 6500000, 7000000, 8000000, 9000000, 9500000, 10000000,
718 10500000 (all uV) 718 10500000 (all uV)
719 719
720 What: /sys/class/power_supply/bq2425 720 What: /sys/class/power_supply/bq24257-charger/in_dpm_voltage
721 Date: October 2015 721 Date: October 2015
722 KernelVersion: 4.4.0 722 KernelVersion: 4.4.0
723 Contact: Andreas Dannenberg <dannenberg@ 723 Contact: Andreas Dannenberg <dannenberg@ti.com>
724 Description: 724 Description:
725 This entry configures the inpu 725 This entry configures the input dynamic power path management voltage of
726 bq24257-type charger devices. 726 bq24257-type charger devices. Once the supply drops to the configured
727 voltage, the input current lim 727 voltage, the input current limit is reduced down to prevent the further
728 drop of the supply. When the I 728 drop of the supply. When the IC enters this mode, the charge current is
729 lower than the set value. See 729 lower than the set value. See device datasheet for details.
730 730
731 Valid values: 731 Valid values:
732 732
733 - 4200000, 4280000, 4360000, 4 733 - 4200000, 4280000, 4360000, 4440000, 4520000, 4600000, 4680000,
734 4760000 (all uV) 734 4760000 (all uV)
735 735
736 What: /sys/class/power_supply/bq2425 736 What: /sys/class/power_supply/bq24257-charger/high_impedance_enable
737 Date: October 2015 737 Date: October 2015
738 KernelVersion: 4.4.0 738 KernelVersion: 4.4.0
739 Contact: Andreas Dannenberg <dannenberg@ 739 Contact: Andreas Dannenberg <dannenberg@ti.com>
740 Description: 740 Description:
741 This entry allows enabling the 741 This entry allows enabling the high-impedance mode of bq24257-type
742 charger devices. If enabled, i 742 charger devices. If enabled, it places the charger IC into low power
743 standby mode with the switch m 743 standby mode with the switch mode controller disabled. When disabled,
744 the charger operates normally. 744 the charger operates normally. See device datasheet for details.
745 745
746 Valid values: 746 Valid values:
747 747
748 - 1: enabled 748 - 1: enabled
749 - 0: disabled 749 - 0: disabled
750 750
751 What: /sys/class/power_supply/bq2425 751 What: /sys/class/power_supply/bq24257-charger/sysoff_enable
752 Date: October 2015 752 Date: October 2015
753 KernelVersion: 4.4.0 753 KernelVersion: 4.4.0
754 Contact: Andreas Dannenberg <dannenberg@ 754 Contact: Andreas Dannenberg <dannenberg@ti.com>
755 Description: 755 Description:
756 This entry allows enabling the 756 This entry allows enabling the sysoff mode of bq24257-type charger
757 devices. If enabled and the in 757 devices. If enabled and the input is removed, the internal battery FET
758 is turned off in order to redu 758 is turned off in order to reduce the leakage from the BAT pin to less
759 than 1uA. Note that on some de 759 than 1uA. Note that on some devices/systems this disconnects the battery
760 from the system. See device da 760 from the system. See device datasheet for details.
761 761
762 Valid values: 762 Valid values:
763 763
764 - 1: enabled 764 - 1: enabled
765 - 0: disabled 765 - 0: disabled
766 766
767 What: /sys/class/power_supply/<suppl 767 What: /sys/class/power_supply/<supply_name>/manufacture_year
768 Date: January 2020 768 Date: January 2020
769 Contact: linux-pm@vger.kernel.org 769 Contact: linux-pm@vger.kernel.org
770 Description: 770 Description:
771 Reports the year (following Gr 771 Reports the year (following Gregorian calendar) when the device has been
772 manufactured. 772 manufactured.
773 773
774 Access: Read 774 Access: Read
775 775
776 Valid values: Reported as inte 776 Valid values: Reported as integer
777 777
778 What: /sys/class/power_supply/<suppl 778 What: /sys/class/power_supply/<supply_name>/manufacture_month
779 Date: January 2020 779 Date: January 2020
780 Contact: linux-pm@vger.kernel.org 780 Contact: linux-pm@vger.kernel.org
781 Description: 781 Description:
782 Reports the month when the dev 782 Reports the month when the device has been manufactured.
783 783
784 Access: Read 784 Access: Read
785 785
786 Valid values: 1-12 786 Valid values: 1-12
787 787
788 What: /sys/class/power_supply/<suppl 788 What: /sys/class/power_supply/<supply_name>/manufacture_day
789 Date: January 2020 789 Date: January 2020
790 Contact: linux-pm@vger.kernel.org 790 Contact: linux-pm@vger.kernel.org
791 Description: 791 Description:
792 Reports the day of month when 792 Reports the day of month when the device has been manufactured.
793 793
794 Access: Read 794 Access: Read
795 Valid values: 1-31 795 Valid values: 1-31
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.