[PATCHv5,RESEND,09/10] Thermal: Add ABI Documentation for sysfs interfaces

Commit Message

[e-mail] Jan. 17, 2014, 1:27 p.m. UTC

This patch adds Documentation for ABI's introduced
for thermal subsystem (under /sys/class/thermal/).

Signed-off-by: Durgadoss R <[e-mail]>
---
 Documentation/ABI/testing/sysfs-class-thermal |  161 +++++++++++++++++++++++++
 1 file changed, 161 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-class-thermal

Patch

diff --git a/Documentation/ABI/testing/sysfs-class-thermal b/Documentation/ABI/testing/sysfs-class-thermal
new file mode 100644
index 0000000..144efc1
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-class-thermal
@@ -0,0 +1,161 @@ 
+What:		/sys/class/thermal/sensorX/temp
+Date:		January 2014
+KernelVersion:	3.13
+Contact:	Linux PM Mailing list <[e-mail]>
+Description:
+		Exposes 'temperature' of a thermal sensor in mC
+Users:		Kernel/User space thermal governors
+
+What:		/sys/class/thermal/sensorX/name
+Date:		January 2014
+KernelVersion:	3.13
+Contact:	Linux PM Mailing list <[e-mail]>
+Description:
+		Name of the thermal sensor
+Users:		Kernel/User space thermal governors
+
+What:		/sys/class/thermal/sensorX/thresholdY
+Date:		January 2014
+KernelVersion:	3.13
+Contact:	Linux PM Mailing list <[e-mail]>
+Description:
+		Programmable threshold (in terms of mC). On reaching
+		this, the thermal governors may take action to control
+		temperature.
+Users:		Kernel/User space thermal governors
+
+What:		/sys/class/thermal/cdevX/type
+Date:		January 2014
+KernelVersion:	3.13
+Contact:	Linux PM Mailing list <[e-mail]>
+Description:
+		Type of the cooling device
+Users:		Kernel/User space thermal governors
+
+What:		/sys/class/thermal/cdevX/cur_state
+Date:		January 2014
+KernelVersion:	3.13
+Contact:	Linux PM Mailing list <[e-mail]>
+Description:
+		Current throttle state the cooling device is in
+Users:		Kernel/User space thermal governors
+
+What:		/sys/class/thermal/cdevX/max_state
+Date:		January 2014
+KernelVersion:	3.13
+Contact:	Linux PM Mailing list <[e-mail]>
+Description:
+		Maximum number of throttle states the cooling device supports
+Users:		Kernel/User space thermal governors
+
+What:		/sys/class/thermal/zoneX/zone_name
+Date:		January 2014
+KernelVersion:	3.13
+Contact:	Linux PM Mailing list <[e-mail]>
+Description:
+		Name of the thermal zone.
+Users:		Kernel/User space thermal governors
+
+What:		/sys/class/thermal/zoneX/sensorY
+Date:		January 2014
+KernelVersion:	3.13
+Contact:	Linux PM Mailing list <[e-mail]>
+Description:
+		Symlink to a sensor associated with this zone.
+Users:		User space thermal governors or applications
+
+What:		/sys/class/thermal/zoneX/cooling_deviceY
+Date:		January 2014
+KernelVersion:	3.13
+Contact:	Linux PM Mailing list <[e-mail]>
+Description:
+		Symlink to a cooling device associated with this zone.
+Users:		User space thermal governors or applications
+
+What:		/sys/class/thermal/zoneX/sensorY_trip_activeM
+Date:		January 2014
+KernelVersion:	3.13
+Contact:	Linux PM Mailing list <[e-mail]>
+Description:
+		Active Trip point temperature in mC for sensorY in
+		thermal zoneX.
+Users:		Kernel/User space thermal governors
+
+What:		/sys/class/thermal/zoneX/sensorY_trip_passiveN
+Date:		January 2014
+KernelVersion:	3.13
+Contact:	Linux PM Mailing list <[e-mail]>
+Description:
+		Passive Trip point temperature in mC for sensorY in
+		thermal zoneX.
+Users:		Kernel/User space thermal governors
+
+What:		/sys/class/thermal/zoneX/sensorY_trip_hot
+Date:		January 2014
+KernelVersion:	3.13
+Contact:	Linux PM Mailing list <[e-mail]>
+Description:
+		Hot trip point for 'sensorY' in 'zoneX' (in mC).
+Users:		Kernel/User space thermal governors
+
+What:		/sys/class/thermal/zoneX/sensorY_trip_critical
+Date:		January 2014
+KernelVersion:	3.13
+Contact:	Linux PM Mailing list <[e-mail]>
+Description:
+		Critical trip point for 'sensorY' in 'zoneX' (in mC).
+Users:		Kernel/User space thermal governors
+
+What:		/sys/class/thermal/zoneX/mapY_trip_type
+Date:		January 2014
+KernelVersion:	3.13
+Contact:	Linux PM Mailing list <[e-mail]>
+Description:
+		Mapping information between a sensor and a cooling device
+		in 'zoneX'. This interface provides the trip_type for a
+		particular map(Y).
+Users:		Kernel/User space thermal governors
+
+What:		/sys/class/thermal/zoneX/mapY_sensor_name
+Date:		January 2014
+KernelVersion:	3.13
+Contact:	Linux PM Mailing list <[e-mail]>
+Description:
+		Mapping information between a sensor and a cooling device
+		in 'zoneX'. This interface provides the name of the sensor
+		used in this map(Y).
+Users:		Kernel/User space thermal governors
+
+What:		/sys/class/thermal/zoneX/mapY_cdev_name
+Date:		January 2014
+KernelVersion:	3.13
+Contact:	Linux PM Mailing list <[e-mail]>
+Description:
+		Mapping information between a sensor and a cooling device
+		in 'zoneX'. This interface provides the name of the cooling
+		device used in this map(Y).
+Users:		Kernel/User space thermal governors
+
+What:		/sys/class/thermal/zoneX/mapY_trip_mask
+Date:		January 2014
+KernelVersion:	3.13
+Contact:	Linux PM Mailing list <[e-mail]>
+Description:
+		Mapping information between a sensor and a cooling device
+		in 'zoneX'. This interface provides the trip point mask,
+		which defines whether or not to throttle a particular
+		cooling device. See Documentation/thermal/sysfs-api2.txt
+		for more information on this interface.
+Users:		Kernel/User space thermal governors
+
+What:		/sys/class/thermal/zoneX/mapY_weightN
+Date:		January 2014
+KernelVersion:	3.13
+Contact:	Linux PM Mailing list <[e-mail]>
+Description:
+		Mapping information between a sensor and a cooling device
+		in 'zoneX'. This interface provides the weights that can
+		be used to throttle a cooling device, on thermal violations.
+		See Documentation/thermal/sysfs-api2.txt for more details on
+		this interface.
+Users:		Kernel/User space thermal governors