From: Durgadoss R <durgadoss.r@intel.com>
To: rui.zhang@intel.com, eduardo.valentin@ti.com, linux-pm@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, hongbo.zhang@freescale.com,
wni@nvidia.com, Durgadoss R <durgadoss.r@intel.com>
Subject: [PATCHv5 09/10] Thermal: Add ABI Documentation for sysfs interfaces
Date: Fri, 17 Jan 2014 05:26:26 +0530 [thread overview]
Message-ID: <1389916587-2541-10-git-send-email-durgadoss.r@intel.com> (raw)
In-Reply-To: <1389916587-2541-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..c646585
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-class-thermal
@@ -0,0 +1,137 @@
+What: /sys/class/thermal/sensorX/temp
+Date: January 2014
+KernelVersion: 3.13
+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: January 2014
+KernelVersion: 3.13
+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: January 2014
+KernelVersion: 3.13
+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/zone_name
+Date: January 2014
+KernelVersion: 3.13
+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: January 2014
+KernelVersion: 3.13
+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: January 2014
+KernelVersion: 3.13
+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_activeM
+Date: January 2014
+KernelVersion: 3.13
+Contact: Linux PM Mailing list <linux-pm@vger.kernel.org>
+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 <linux-pm@vger.kernel.org>
+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 <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: January 2014
+KernelVersion: 3.13
+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: January 2014
+KernelVersion: 3.13
+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: January 2014
+KernelVersion: 3.13
+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: January 2014
+KernelVersion: 3.13
+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: January 2014
+KernelVersion: 3.13
+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_weightN
+Date: January 2014
+KernelVersion: 3.13
+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:[~2014-01-16 18:28 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-01-16 23:56 [PATCHv5 00/10] Thermal Framework Enhancements Durgadoss R
2014-01-16 23:56 ` [PATCHv5 01/10] Thermal: Do kfree in _unregister functions Durgadoss R
2014-01-21 19:46 ` Dmitry Torokhov
2014-03-03 13:44 ` Zhang Rui
2014-01-16 23:56 ` [PATCHv5 02/10] Thermal: Create sensor level APIs Durgadoss R
2014-01-16 23:56 ` [PATCHv5 03/10] Thermal: Add cooling device APIs Durgadoss R
2014-01-17 7:57 ` R, Durgadoss
2014-01-16 23:56 ` [PATCHv5 04/10] Thermal: Create zone level APIs Durgadoss R
2014-01-16 23:56 ` [PATCHv5 05/10] Thermal: Add APIs to bind cdev to new zone structure Durgadoss R
2014-01-16 23:56 ` [PATCHv5 06/10] Thermal: Add trip point sysfs nodes for sensor Durgadoss R
2014-01-16 23:56 ` [PATCHv5 07/10] Thermal: Create Thermal map sysfs attributes for a zone Durgadoss R
2014-01-16 23:56 ` [PATCHv5 08/10] Thermal: Add Documentation to new APIs Durgadoss R
2014-01-16 23:56 ` Durgadoss R [this message]
2014-01-16 23:56 ` [PATCHv5 10/10] Thermal: Dummy driver used for testing Durgadoss R
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=1389916587-2541-10-git-send-email-durgadoss.r@intel.com \
--to=durgadoss.r@intel.com \
--cc=eduardo.valentin@ti.com \
--cc=hongbo.zhang@freescale.com \
--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).