Merge tag 'gcc-plugins-v5.11-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-2.6-microblaze.git] / Documentation / ABI / testing / sysfs-class-power
index dbccb2f..ca830c6 100644 (file)
@@ -1,4 +1,4 @@
-===== General Properties =====
+**General Properties**
 
 What:          /sys/class/power_supply/<supply_name>/manufacturer
 Date:          May 2007
@@ -36,14 +36,238 @@ Description:
                Access: Read
                Valid values: "Battery", "UPS", "Mains", "USB", "Wireless"
 
-===== Battery Properties =====
+**Battery and USB properties**
+
+What:          /sys/class/power_supply/<supply_name>/current_avg
+Date:          May 2007
+Contact:       linux-pm@vger.kernel.org
+Description:
+               Battery:
+
+                 Reports an average IBAT current reading for the battery, over
+                 a fixed period. Normally devices will provide a fixed interval
+                 in which they average readings to smooth out the reported
+                 value.
+
+               USB:
+
+                 Reports an average IBUS current reading over a fixed period.
+                 Normally devices will provide a fixed interval in which they
+                 average readings to smooth out the reported value.
+
+               Access: Read
+
+               Valid values: Represented in microamps. Negative values are
+               used for discharging batteries, positive values for charging
+               batteries and for USB IBUS current.
+
+What:          /sys/class/power_supply/<supply_name>/current_max
+Date:          October 2010
+Contact:       linux-pm@vger.kernel.org
+Description:
+               Battery:
+
+                 Reports the maximum IBAT current allowed into the battery.
+
+               USB:
+
+                 Reports the maximum IBUS current the supply can support.
+
+               Access: Read
+               Valid values: Represented in microamps
+
+What:          /sys/class/power_supply/<supply_name>/current_now
+Date:          May 2007
+Contact:       linux-pm@vger.kernel.org
+Description:
+
+               Battery:
+
+                 Reports an instant, single IBAT current reading for the
+                 battery. This value is not averaged/smoothed.
+
+                 Access: Read
+
+               USB:
+
+                 Reports the IBUS current supplied now. This value is generally
+                 read-only reporting, unless the 'online' state of the supply
+                 is set to be programmable, in which case this value can be set
+                 within the reported min/max range.
+
+                 Access: Read, Write
+
+               Valid values: Represented in microamps. Negative values are
+               used for discharging batteries, positive values for charging
+               batteries and for USB IBUS current.
+
+What:          /sys/class/power_supply/<supply_name>/temp
+Date:          May 2007
+Contact:       linux-pm@vger.kernel.org
+Description:
+               Battery:
+
+                 Reports the current TBAT battery temperature reading.
+
+               USB:
+
+                 Reports the current supply temperature reading. This would
+                 normally be the internal temperature of the device itself
+                 (e.g TJUNC temperature of an IC)
+
+               Access: Read
+
+               Valid values: Represented in 1/10 Degrees Celsius
+
+What:          /sys/class/power_supply/<supply_name>/temp_alert_max
+Date:          July 2012
+Contact:       linux-pm@vger.kernel.org
+Description:
+               Battery:
+
+                 Maximum TBAT temperature trip-wire value where the supply will
+                 notify user-space of the event.
+
+               USB:
+
+                 Maximum supply temperature trip-wire value where the supply
+                 will notify user-space of the event.
+
+               This is normally used for the charging scenario where
+               user-space needs to know if the temperature has crossed an
+               upper threshold so it can take appropriate action (e.g. warning
+               user that the temperature is critically high, and charging has
+               stopped).
+
+               Access: Read
+
+               Valid values: Represented in 1/10 Degrees Celsius
+
+What:          /sys/class/power_supply/<supply_name>/temp_alert_min
+Date:          July 2012
+Contact:       linux-pm@vger.kernel.org
+Description:
+
+               Battery:
+
+                 Minimum TBAT temperature trip-wire value where the supply will
+                 notify user-space of the event.
+
+               USB:
+
+                 Minimum supply temperature trip-wire value where the supply
+                 will notify user-space of the event.
+
+               This is normally used for the charging scenario where user-space
+               needs to know if the temperature has crossed a lower threshold
+               so it can take appropriate action (e.g. warning user that
+               temperature level is high, and charging current has been
+               reduced accordingly to remedy the situation).
+
+               Access: Read
+
+               Valid values: Represented in 1/10 Degrees Celsius
+
+What:          /sys/class/power_supply/<supply_name>/temp_max
+Date:          July 2014
+Contact:       linux-pm@vger.kernel.org
+Description:
+               Battery:
+
+                 Reports the maximum allowed TBAT battery temperature for
+                 charging.
+
+               USB:
+
+                 Reports the maximum allowed supply temperature for operation.
+
+               Access: Read
+
+               Valid values: Represented in 1/10 Degrees Celsius
+
+What:          /sys/class/power_supply/<supply_name>/temp_min
+Date:          July 2014
+Contact:       linux-pm@vger.kernel.org
+Description:
+               Battery:
+
+                 Reports the minimum allowed TBAT battery temperature for
+                 charging.
+
+               USB:
+
+                 Reports the minimum allowed supply temperature for operation.
+
+               Access: Read
+
+               Valid values: Represented in 1/10 Degrees Celsius
+
+What:          /sys/class/power_supply/<supply_name>/voltage_max,
+Date:          January 2008
+Contact:       linux-pm@vger.kernel.org
+Description:
+               Battery:
+
+                 Reports the maximum safe VBAT voltage permitted for the
+                 battery, during charging.
+
+               USB:
+
+                 Reports the maximum VBUS voltage the supply can support.
+
+               Access: Read
+
+               Valid values: Represented in microvolts
+
+What:          /sys/class/power_supply/<supply_name>/voltage_min,
+Date:          January 2008
+Contact:       linux-pm@vger.kernel.org
+Description:
+               Battery:
+
+                 Reports the minimum safe VBAT voltage permitted for the
+                 battery, during discharging.
+
+               USB:
+
+                 Reports the minimum VBUS voltage the supply can support.
+
+               Access: Read
+
+               Valid values: Represented in microvolts
+
+What:          /sys/class/power_supply/<supply_name>/voltage_now,
+Date:          May 2007
+Contact:       linux-pm@vger.kernel.org
+Description:
+               Battery:
+
+                 Reports an instant, single VBAT voltage reading for the
+                 battery. This value is not averaged/smoothed.
+
+                 Access: Read
+
+               USB:
+
+                 Reports the VBUS voltage supplied now. This value is generally
+                 read-only reporting, unless the 'online' state of the supply
+                 is set to be programmable, in which case this value can be set
+                 within the reported min/max range.
+
+                 Access: Read, Write
+
+               Valid values: Represented in microvolts
+
+**Battery Properties**
 
 What:          /sys/class/power_supply/<supply_name>/capacity
 Date:          May 2007
 Contact:       linux-pm@vger.kernel.org
 Description:
                Fine grain representation of battery capacity.
+
                Access: Read
+
                Valid values: 0 - 100 (percent)
 
 What:          /sys/class/power_supply/<supply_name>/capacity_alert_max
@@ -58,6 +282,7 @@ Description:
                low).
 
                Access: Read, Write
+
                Valid values: 0 - 100 (percent)
 
 What:          /sys/class/power_supply/<supply_name>/capacity_alert_min
@@ -72,6 +297,7 @@ Description:
                critically low).
 
                Access: Read, Write
+
                Valid values: 0 - 100 (percent)
 
 What:          /sys/class/power_supply/<supply_name>/capacity_error_margin
@@ -87,6 +313,7 @@ Description:
                completely useless.
 
                Access: Read
+
                Valid values: 0 - 100 (percent)
 
 What:          /sys/class/power_supply/<supply_name>/capacity_level
@@ -96,40 +323,10 @@ Description:
                Coarse representation of battery capacity.
 
                Access: Read
-               Valid values: "Unknown", "Critical", "Low", "Normal", "High",
-                             "Full"
-
-What:          /sys/class/power_supply/<supply_name>/current_avg
-Date:          May 2007
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Reports an average IBAT current reading for the battery, over a
-               fixed period. Normally devices will provide a fixed interval in
-               which they average readings to smooth out the reported value.
-
-               Access: Read
-               Valid values: Represented in microamps. Negative values are used
-               for discharging batteries, positive values for charging batteries.
 
-What:          /sys/class/power_supply/<supply_name>/current_max
-Date:          October 2010
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Reports the maximum IBAT current allowed into the battery.
-
-               Access: Read
-               Valid values: Represented in microamps
-
-What:          /sys/class/power_supply/<supply_name>/current_now
-Date:          May 2007
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Reports an instant, single IBAT current reading for the battery.
-               This value is not averaged/smoothed.
-
-               Access: Read
-               Valid values: Represented in microamps. Negative values are used
-               for discharging batteries, positive values for charging batteries.
+               Valid values:
+                             "Unknown", "Critical", "Low", "Normal", "High",
+                             "Full"
 
 What:          /sys/class/power_supply/<supply_name>/charge_control_limit
 Date:          Oct 2012
@@ -139,6 +336,7 @@ Description:
                throttling for thermal cooling or improving battery health.
 
                Access: Read, Write
+
                Valid values: Represented in microamps
 
 What:          /sys/class/power_supply/<supply_name>/charge_control_limit_max
@@ -148,6 +346,7 @@ Description:
                Maximum legal value for the charge_control_limit property.
 
                Access: Read
+
                Valid values: Represented in microamps
 
 What:          /sys/class/power_supply/<supply_name>/charge_control_start_threshold
@@ -168,6 +367,7 @@ Description:
                stop.
 
                Access: Read, Write
+
                Valid values: 0 - 100 (percent)
 
 What:          /sys/class/power_supply/<supply_name>/charge_type
@@ -183,7 +383,9 @@ Description:
                different algorithm.
 
                Access: Read, Write
-               Valid values: "Unknown", "N/A", "Trickle", "Fast", "Standard",
+
+               Valid values:
+                             "Unknown", "N/A", "Trickle", "Fast", "Standard",
                              "Adaptive", "Custom"
 
 What:          /sys/class/power_supply/<supply_name>/charge_term_current
@@ -194,6 +396,7 @@ Description:
                when the battery is considered full and charging should end.
 
                Access: Read
+
                Valid values: Represented in microamps
 
 What:          /sys/class/power_supply/<supply_name>/health
@@ -204,7 +407,9 @@ Description:
                functionality.
 
                Access: Read
-               Valid values: "Unknown", "Good", "Overheat", "Dead",
+
+               Valid values:
+                             "Unknown", "Good", "Overheat", "Dead",
                              "Over voltage", "Unspecified failure", "Cold",
                              "Watchdog timer expire", "Safety timer expire",
                              "Over current", "Calibration required", "Warm",
@@ -218,6 +423,7 @@ Description:
                for a battery charge cycle.
 
                Access: Read
+
                Valid values: Represented in microamps
 
 What:          /sys/class/power_supply/<supply_name>/present
@@ -227,9 +433,13 @@ Description:
                Reports whether a battery is present or not in the system.
 
                Access: Read
+
                Valid values:
+
+                       == =======
                        0: Absent
                        1: Present
+                       == =======
 
 What:          /sys/class/power_supply/<supply_name>/status
 Date:          May 2007
@@ -240,7 +450,9 @@ Description:
                used to enable/disable charging to the battery.
 
                Access: Read, Write
-               Valid values: "Unknown", "Charging", "Discharging",
+
+               Valid values:
+                             "Unknown", "Charging", "Discharging",
                              "Not charging", "Full"
 
 What:          /sys/class/power_supply/<supply_name>/technology
@@ -250,66 +462,11 @@ Description:
                Describes the battery technology supported by the supply.
 
                Access: Read
-               Valid values: "Unknown", "NiMH", "Li-ion", "Li-poly", "LiFe",
-                             "NiCd", "LiMn"
-
-What:          /sys/class/power_supply/<supply_name>/temp
-Date:          May 2007
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Reports the current TBAT battery temperature reading.
-
-               Access: Read
-               Valid values: Represented in 1/10 Degrees Celsius
-
-What:          /sys/class/power_supply/<supply_name>/temp_alert_max
-Date:          July 2012
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Maximum TBAT temperature trip-wire value where the supply will
-               notify user-space of the event. This is normally used for the
-               battery charging scenario where user-space needs to know the
-               battery temperature has crossed an upper threshold so it can
-               take appropriate action (e.g. warning user that battery level is
-               critically high, and charging has stopped).
-
-               Access: Read
-               Valid values: Represented in 1/10 Degrees Celsius
-
-What:          /sys/class/power_supply/<supply_name>/temp_alert_min
-Date:          July 2012
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Minimum TBAT temperature trip-wire value where the supply will
-               notify user-space of the event. This is normally used for the
-               battery charging scenario where user-space needs to know the
-               battery temperature has crossed a lower threshold so it can take
-               appropriate action (e.g. warning user that battery level is
-               high, and charging current has been reduced accordingly to
-               remedy the situation).
-
-               Access: Read
-               Valid values: Represented in 1/10 Degrees Celsius
-
-What:          /sys/class/power_supply/<supply_name>/temp_max
-Date:          July 2014
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Reports the maximum allowed TBAT battery temperature for
-               charging.
-
-               Access: Read
-               Valid values: Represented in 1/10 Degrees Celsius
 
-What:          /sys/class/power_supply/<supply_name>/temp_min
-Date:          July 2014
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Reports the minimum allowed TBAT battery temperature for
-               charging.
+               Valid values:
+                             "Unknown", "NiMH", "Li-ion", "Li-poly", "LiFe",
+                             "NiCd", "LiMn"
 
-               Access: Read
-               Valid values: Represented in 1/10 Degrees Celsius
 
 What:          /sys/class/power_supply/<supply_name>/voltage_avg,
 Date:          May 2007
@@ -320,72 +477,10 @@ Description:
                which they average readings to smooth out the reported value.
 
                Access: Read
-               Valid values: Represented in microvolts
-
-What:          /sys/class/power_supply/<supply_name>/voltage_max,
-Date:          January 2008
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Reports the maximum safe VBAT voltage permitted for the battery,
-               during charging.
-
-               Access: Read
-               Valid values: Represented in microvolts
-
-What:          /sys/class/power_supply/<supply_name>/voltage_min,
-Date:          January 2008
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Reports the minimum safe VBAT voltage permitted for the battery,
-               during discharging.
 
-               Access: Read
                Valid values: Represented in microvolts
 
-What:          /sys/class/power_supply/<supply_name>/voltage_now,
-Date:          May 2007
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Reports an instant, single VBAT voltage reading for the battery.
-               This value is not averaged/smoothed.
-
-               Access: Read
-               Valid values: Represented in microvolts
-
-===== USB Properties =====
-
-What:          /sys/class/power_supply/<supply_name>/current_avg
-Date:          May 2007
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Reports an average IBUS current reading over a fixed period.
-               Normally devices will provide a fixed interval in which they
-               average readings to smooth out the reported value.
-
-               Access: Read
-               Valid values: Represented in microamps
-
-
-What:          /sys/class/power_supply/<supply_name>/current_max
-Date:          October 2010
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Reports the maximum IBUS current the supply can support.
-
-               Access: Read
-               Valid values: Represented in microamps
-
-What:          /sys/class/power_supply/<supply_name>/current_now
-Date:          May 2007
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Reports the IBUS current supplied now. This value is generally
-               read-only reporting, unless the 'online' state of the supply
-               is set to be programmable, in which case this value can be set
-               within the reported min/max range.
-
-               Access: Read, Write
-               Valid values: Represented in microamps
+**USB Properties**
 
 What:          /sys/class/power_supply/<supply_name>/input_current_limit
 Date:          July 2014
@@ -399,6 +494,7 @@ Description:
                solved using power limit use input_current_limit.
 
                Access: Read, Write
+
                Valid values: Represented in microamps
 
 What:          /sys/class/power_supply/<supply_name>/input_voltage_limit
@@ -416,6 +512,7 @@ Description:
                solved using power limit use input_voltage_limit.
 
                Access: Read, Write
+
                Valid values: Represented in microvolts
 
 What:          /sys/class/power_supply/<supply_name>/input_power_limit
@@ -429,6 +526,7 @@ Description:
                limit only for problems that can be solved using power limit.
 
                Access: Read, Write
+
                Valid values: Represented in microwatts
 
 What:          /sys/class/power_supply/<supply_name>/online,
@@ -441,69 +539,14 @@ Description:
                USB supply so voltage and current can be controlled).
 
                Access: Read, Write
+
                Valid values:
+
+                       == ==================================================
                        0: Offline
                        1: Online Fixed - Fixed Voltage Supply
                        2: Online Programmable - Programmable Voltage Supply
-
-What:          /sys/class/power_supply/<supply_name>/temp
-Date:          May 2007
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Reports the current supply temperature reading. This would
-               normally be the internal temperature of the device itself (e.g
-               TJUNC temperature of an IC)
-
-               Access: Read
-               Valid values: Represented in 1/10 Degrees Celsius
-
-What:          /sys/class/power_supply/<supply_name>/temp_alert_max
-Date:          July 2012
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Maximum supply temperature trip-wire value where the supply will
-               notify user-space of the event. This is normally used for the
-               charging scenario where user-space needs to know the supply
-               temperature has crossed an upper threshold so it can take
-               appropriate action (e.g. warning user that the supply
-               temperature is critically high, and charging has stopped to
-               remedy the situation).
-
-               Access: Read
-               Valid values: Represented in 1/10 Degrees Celsius
-
-What:          /sys/class/power_supply/<supply_name>/temp_alert_min
-Date:          July 2012
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Minimum supply temperature trip-wire value where the supply will
-               notify user-space of the event. This is normally used for the
-               charging scenario where user-space needs to know the supply
-               temperature has crossed a lower threshold so it can take
-               appropriate action (e.g. warning user that the supply
-               temperature is high, and charging current has been reduced
-               accordingly to remedy the situation).
-
-               Access: Read
-               Valid values: Represented in 1/10 Degrees Celsius
-
-What:          /sys/class/power_supply/<supply_name>/temp_max
-Date:          July 2014
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Reports the maximum allowed supply temperature for operation.
-
-               Access: Read
-               Valid values: Represented in 1/10 Degrees Celsius
-
-What:          /sys/class/power_supply/<supply_name>/temp_min
-Date:          July 2014
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Reports the mainimum allowed supply temperature for operation.
-
-               Access: Read
-               Valid values: Represented in 1/10 Degrees Celsius
+                       == ==================================================
 
 What:          /sys/class/power_supply/<supply_name>/usb_type
 Date:          March 2018
@@ -514,40 +557,12 @@ Description:
                is attached.
 
                Access: Read-Only
-               Valid values: "Unknown", "SDP", "DCP", "CDP", "ACA", "C", "PD",
-                             "PD_DRP", "PD_PPS", "BrickID"
-
-What:          /sys/class/power_supply/<supply_name>/voltage_max
-Date:          January 2008
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Reports the maximum VBUS voltage the supply can support.
-
-               Access: Read
-               Valid values: Represented in microvolts
-
-What:          /sys/class/power_supply/<supply_name>/voltage_min
-Date:          January 2008
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Reports the minimum VBUS voltage the supply can support.
 
-               Access: Read
-               Valid values: Represented in microvolts
-
-What:          /sys/class/power_supply/<supply_name>/voltage_now
-Date:          May 2007
-Contact:       linux-pm@vger.kernel.org
-Description:
-               Reports the VBUS voltage supplied now. This value is generally
-               read-only reporting, unless the 'online' state of the supply
-               is set to be programmable, in which case this value can be set
-               within the reported min/max range.
-
-               Access: Read, Write
-               Valid values: Represented in microvolts
+               Valid values:
+                             "Unknown", "SDP", "DCP", "CDP", "ACA", "C", "PD",
+                             "PD_DRP", "PD_PPS", "BrickID"
 
-===== Device Specific Properties =====
+**Device Specific Properties**
 
 What:          /sys/class/power/ds2760-battery.*/charge_now
 Date:          May 2010
@@ -581,6 +596,7 @@ Description:
                will drop to 0 A) and will trigger interrupt.
 
                Valid values:
+
                - 5, 6 or 7 (hours),
                - 0: disabled.
 
@@ -595,6 +611,7 @@ Description:
                will drop to 0 A) and will trigger interrupt.
 
                Valid values:
+
                - 4 - 16 (hours), step by 2 (rounded down)
                - 0: disabled.
 
@@ -609,6 +626,7 @@ Description:
                interrupt and start top-off charging mode.
 
                Valid values:
+
                - 100000 - 200000 (microamps), step by 25000 (rounded down)
                - 200000 - 350000 (microamps), step by 50000 (rounded down)
                - 0: disabled.
@@ -624,6 +642,7 @@ Description:
                will drop to 0 A) and will trigger interrupt.
 
                Valid values:
+
                - 0 - 70 (minutes), step by 10 (rounded down)
 
 What:          /sys/class/power_supply/bq24257-charger/ovp_voltage
@@ -637,6 +656,7 @@ Description:
                device datasheet for details.
 
                Valid values:
+
                - 6000000, 6500000, 7000000, 8000000, 9000000, 9500000, 10000000,
                  10500000 (all uV)
 
@@ -652,6 +672,7 @@ Description:
                lower than the set value. See device datasheet for details.
 
                Valid values:
+
                - 4200000, 4280000, 4360000, 4440000, 4520000, 4600000, 4680000,
                  4760000 (all uV)
 
@@ -666,6 +687,7 @@ Description:
                the charger operates normally. See device datasheet for details.
 
                Valid values:
+
                - 1: enabled
                - 0: disabled
 
@@ -681,6 +703,7 @@ Description:
                from the system. See device datasheet for details.
 
                Valid values:
+
                - 1: enabled
                - 0: disabled
 
@@ -692,6 +715,7 @@ Description:
                manufactured.
 
                Access: Read
+
                Valid values: Reported as integer
 
 What:          /sys/class/power_supply/<supply_name>/manufacture_month
@@ -701,6 +725,7 @@ Description:
                Reports the month when the device has been manufactured.
 
                Access: Read
+
                Valid values: 1-12
 
 What:          /sys/class/power_supply/<supply_name>/manufacture_day