From: Durgadoss R <durgadoss.r@intel.com>
To: rui.zhang@intel.com, linux-pm@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, eduardo.valentin@ti.com,
hongbo.zhang@linaro.org, wni@nvidia.com,
Durgadoss R <durgadoss.r@intel.com>
Subject: [PATCH 7/8] Thermal: Add ABI Documentation for sysfs interfaces
Date: Tue, 5 Feb 2013 16:16:22 +0530 [thread overview]
Message-ID: <1360061183-14137-8-git-send-email-durgadoss.r@intel.com> (raw)
In-Reply-To: <1360061183-14137-1-git-send-email-durgadoss.r@intel.com>
This patch adds Documentation for ABI's introduced
for thermal subsystem (under /sys/class/thermal/).
Signed-off-by: Durgadoss R <durgadoss.r@intel.com>
---
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..00f033a
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-class-thermal
@@ -0,0 +1,137 @@
+What: /sys/class/thermal/sensorX/temp
+Date: February 2013
+KernelVersion: 3.8
+Contact: Linux PM Mailing list <linux-pm@vger.kernel.org>
+Description:
+ Exposes 'temperature' of a thermal sensor in mC
+Users: Kernel/User space thermal governors
+
+What: /sys/class/thermal/sensorX/name
+Date: February 2013
+KernelVersion: 3.8
+Contact: Linux PM Mailing list <linux-pm@vger.kernel.org>
+Description:
+ Name of the thermal sensor
+Users: Kernel/User space thermal governors
+
+What: /sys/class/thermal/sensorX/thresholdY
+Date: February 2013
+KernelVersion: 3.8
+Contact: Linux PM Mailing list <linux-pm@vger.kernel.org>
+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: February 2013
+KernelVersion: 3.8
+Contact: Linux PM Mailing list <linux-pm@vger.kernel.org>
+Description:
+ Name of the thermal zone.
+Users: Kernel/User space thermal governors
+
+What: /sys/class/thermal/zoneX/sensorY
+Date: February 2013
+KernelVersion: 3.8
+Contact: Linux PM Mailing list <linux-pm@vger.kernel.org>
+Description:
+ Symlink to a sensor associated with this zone.
+Users: User space thermal governors or applications
+
+What: /sys/class/thermal/zoneX/cooling_deviceY
+Date: February 2013
+KernelVersion: 3.8
+Contact: Linux PM Mailing list <linux-pm@vger.kernel.org>
+Description:
+ Symlink to a cooling device associated with this zone.
+Users: User space thermal governors or applications
+
+What: /sys/class/thermal/zoneX/sensorY_trip_active
+Date: February 2013
+KernelVersion: 3.8
+Contact: Linux PM Mailing list <linux-pm@vger.kernel.org>
+Description:
+ Space separated list of active trip points for 'sensorY'
+ in 'zoneX' (in mC).
+Users: Kernel/User space thermal governors
+
+What: /sys/class/thermal/zoneX/sensorY_trip_passive
+Date: February 2013
+KernelVersion: 3.8
+Contact: Linux PM Mailing list <linux-pm@vger.kernel.org>
+Description:
+ Space separated list of passive trip points for 'sensorY'
+ in 'zoneX' (in mC).
+Users: Kernel/User space thermal governors
+
+What: /sys/class/thermal/zoneX/sensorY_trip_hot
+Date: February 2013
+KernelVersion: 3.8
+Contact: Linux PM Mailing list <linux-pm@vger.kernel.org>
+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: February 2013
+KernelVersion: 3.8
+Contact: Linux PM Mailing list <linux-pm@vger.kernel.org>
+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: February 2013
+KernelVersion: 3.8
+Contact: Linux PM Mailing list <linux-pm@vger.kernel.org>
+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: February 2013
+KernelVersion: 3.8
+Contact: Linux PM Mailing list <linux-pm@vger.kernel.org>
+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: February 2013
+KernelVersion: 3.8
+Contact: Linux PM Mailing list <linux-pm@vger.kernel.org>
+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: February 2013
+KernelVersion: 3.8
+Contact: Linux PM Mailing list <linux-pm@vger.kernel.org>
+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_weights
+Date: February 2013
+KernelVersion: 3.8
+Contact: Linux PM Mailing list <linux-pm@vger.kernel.org>
+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
next prev parent reply other threads:[~2013-02-05 10:52 UTC|newest]
Thread overview: 39+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-02-05 10:46 [PATCHv3 0/8] Thermal Framework Enhancements Durgadoss R
2013-02-05 10:46 ` [PATCH 1/8] Thermal: Create sensor level APIs Durgadoss R
2013-02-08 7:53 ` Zhang Rui
2013-02-08 8:26 ` R, Durgadoss
2013-02-08 9:54 ` Zhang Rui
2013-02-28 18:58 ` Eduardo Valentin
2013-03-01 5:08 ` R, Durgadoss
2013-02-05 10:46 ` [PATCH 2/8] Thermal: Create zone " Durgadoss R
2013-02-08 8:11 ` Zhang Rui
2013-02-08 8:54 ` R, Durgadoss
2013-02-08 9:54 ` Zhang Rui
2013-02-08 10:27 ` R, Durgadoss
2013-02-28 19:29 ` Eduardo Valentin
2013-03-01 15:31 ` R, Durgadoss
2013-02-05 10:46 ` [PATCH 3/8] Thermal: Add APIs to bind cdev to new zone structure Durgadoss R
2013-02-08 8:28 ` Zhang Rui
2013-02-28 19:35 ` Eduardo Valentin
2013-03-01 15:33 ` R, Durgadoss
2013-02-05 10:46 ` [PATCH 4/8] Thermal: Add trip point sysfs nodes for sensor Durgadoss R
2013-02-08 8:50 ` Zhang Rui
2013-02-28 19:51 ` Eduardo Valentin
2013-03-01 15:34 ` R, Durgadoss
2013-02-05 10:46 ` [PATCH 5/8] Thermal: Create Thermal map sysfs attributes for a zone Durgadoss R
2013-02-08 9:04 ` Zhang Rui
2013-02-08 9:08 ` R, Durgadoss
2013-02-08 9:55 ` Zhang Rui
2013-02-28 21:30 ` Eduardo Valentin
2013-02-05 10:46 ` [PATCH 6/8] Thermal: Add Documentation to new APIs Durgadoss R
2013-02-08 9:21 ` Zhang Rui
2013-02-05 10:46 ` Durgadoss R [this message]
2013-02-05 10:46 ` [PATCH 8/8] Thermal: Dummy driver used for testing Durgadoss R
2013-02-08 7:53 ` [PATCHv3 0/8] Thermal Framework Enhancements Zhang Rui
2013-02-08 9:35 ` Zhang Rui
2013-02-28 21:33 ` Eduardo Valentin
2013-03-01 5:12 ` R, Durgadoss
2013-08-29 19:38 ` Eduardo Valentin
2013-08-30 9:20 ` R, Durgadoss
2013-08-30 12:34 ` Eduardo Valentin
2013-08-30 13:21 ` R, Durgadoss
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1360061183-14137-8-git-send-email-durgadoss.r@intel.com \
--to=durgadoss.r@intel.com \
--cc=eduardo.valentin@ti.com \
--cc=hongbo.zhang@linaro.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=rui.zhang@intel.com \
--cc=wni@nvidia.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).