From patchwork Fri Jan 17 13:27:02 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: durgadoss.r@intel.com X-Patchwork-Id: 3502381 X-Patchwork-Delegate: rui.zhang@intel.com Return-Path: X-Original-To: patchwork-linux-pm@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.19.201]) by patchwork2.web.kernel.org (Postfix) with ESMTP id 43E54C02DC for ; Fri, 17 Jan 2014 07:59:25 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 5748020120 for ; Fri, 17 Jan 2014 07:59:24 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 2E7C22017B for ; Fri, 17 Jan 2014 07:59:23 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751939AbaAQH7W (ORCPT ); Fri, 17 Jan 2014 02:59:22 -0500 Received: from mga01.intel.com ([192.55.52.88]:42490 "EHLO mga01.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752091AbaAQH7A (ORCPT ); Fri, 17 Jan 2014 02:59:00 -0500 Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by fmsmga101.fm.intel.com with ESMTP; 16 Jan 2014 23:58:59 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="4.95,670,1384329600"; d="scan'208";a="466568146" Received: from durga-linux.iind.intel.com ([10.223.86.51]) by fmsmga002.fm.intel.com with ESMTP; 16 Jan 2014 23:58:57 -0800 From: Durgadoss R 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 Subject: [PATCHv5 RESEND 09/10] Thermal: Add ABI Documentation for sysfs interfaces Date: Fri, 17 Jan 2014 18:57:02 +0530 Message-Id: <1389965222-2537-3-git-send-email-durgadoss.r@intel.com> X-Mailer: git-send-email 1.7.9.5 In-Reply-To: <1389965222-2537-1-git-send-email-durgadoss.r@intel.com> References: <1389965222-2537-1-git-send-email-durgadoss.r@intel.com> Sender: linux-pm-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-pm@vger.kernel.org X-Spam-Status: No, score=-4.2 required=5.0 tests=BAYES_00, DATE_IN_FUTURE_03_06, RCVD_IN_DNSWL_HI, RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP This patch adds Documentation for ABI's introduced for thermal subsystem (under /sys/class/thermal/). Signed-off-by: Durgadoss R --- Documentation/ABI/testing/sysfs-class-thermal | 161 +++++++++++++++++++++++++ 1 file changed, 161 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..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 +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 +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 +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 +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 +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 +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 +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 +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 +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 +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 +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 +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 +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 +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 +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 +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 +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 +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