[PATCHv4 8/9] Thermal: Add ABI Documentation for sysfs interfaces

From: Durgadoss R
Date: Tue Oct 01 2013 - 09:11:36 EST


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

Signed-off-by: Durgadoss R <durgadoss.r@xxxxxxxxx>
---
Documentation/ABI/testing/sysfs-class-thermal | 137 +++++++++++++++++++++++++
1 file changed, 137 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-class-thermal

diff --git a/Documentation/ABI/testing/sysfs-class-thermal b/Documentation/ABI/testing/sysfs-class-thermal
new file mode 100644
index 0000000..36e23da
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-class-thermal
@@ -0,0 +1,137 @@
+What: /sys/class/thermal/sensorX/temp
+Date: October 2013
+KernelVersion: 3.12
+Contact: Linux PM Mailing list <linux-pm@xxxxxxxxxxxxxxx>
+Description:
+ Exposes 'temperature' of a thermal sensor in mC
+Users: Kernel/User space thermal governors
+
+What: /sys/class/thermal/sensorX/name
+Date: October 2013
+KernelVersion: 3.12
+Contact: Linux PM Mailing list <linux-pm@xxxxxxxxxxxxxxx>
+Description:
+ Name of the thermal sensor
+Users: Kernel/User space thermal governors
+
+What: /sys/class/thermal/sensorX/thresholdY
+Date: October 2013
+KernelVersion: 3.12
+Contact: Linux PM Mailing list <linux-pm@xxxxxxxxxxxxxxx>
+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/zoneX/name
+Date: October 2013
+KernelVersion: 3.12
+Contact: Linux PM Mailing list <linux-pm@xxxxxxxxxxxxxxx>
+Description:
+ Name of the thermal zone.
+Users: Kernel/User space thermal governors
+
+What: /sys/class/thermal/zoneX/sensorY
+Date: October 2013
+KernelVersion: 3.12
+Contact: Linux PM Mailing list <linux-pm@xxxxxxxxxxxxxxx>
+Description:
+ Symlink to a sensor associated with this zone.
+Users: User space thermal governors or applications
+
+What: /sys/class/thermal/zoneX/cooling_deviceY
+Date: October 2013
+KernelVersion: 3.12
+Contact: Linux PM Mailing list <linux-pm@xxxxxxxxxxxxxxx>
+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: October 2013
+KernelVersion: 3.12
+Contact: Linux PM Mailing list <linux-pm@xxxxxxxxxxxxxxx>
+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: October 2013
+KernelVersion: 3.12
+Contact: Linux PM Mailing list <linux-pm@xxxxxxxxxxxxxxx>
+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: October 2013
+KernelVersion: 3.12
+Contact: Linux PM Mailing list <linux-pm@xxxxxxxxxxxxxxx>
+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: October 2013
+KernelVersion: 3.12
+Contact: Linux PM Mailing list <linux-pm@xxxxxxxxxxxxxxx>
+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: October 2013
+KernelVersion: 3.12
+Contact: Linux PM Mailing list <linux-pm@xxxxxxxxxxxxxxx>
+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: October 2013
+KernelVersion: 3.12
+Contact: Linux PM Mailing list <linux-pm@xxxxxxxxxxxxxxx>
+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: October 2013
+KernelVersion: 3.12
+Contact: Linux PM Mailing list <linux-pm@xxxxxxxxxxxxxxx>
+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: October 2013
+KernelVersion: 3.12
+Contact: Linux PM Mailing list <linux-pm@xxxxxxxxxxxxxxx>
+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: October 2013
+KernelVersion: 3.12
+Contact: Linux PM Mailing list <linux-pm@xxxxxxxxxxxxxxx>
+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
--
1.7.9.5

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/