From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: ARC-Seal: i=1; a=rsa-sha256; t=1516637368; cv=none; d=google.com; s=arc-20160816; b=NeLbhgj0NLl50eGSsxqpsO+SU02nKgpvuelO0DtTTz1SS2+o11d8KPbQogiR1s2jP8 cu6yd+9r0yJ7kX139eYCC08I7DeMobaFts8ooa/Qah4YpA2Gx47ztb6Fts1uu76NVqto Ijjxzln8D1IYzbbdJrJmq1eb5ssbU+2SOv7VPks6z3fjywgHADium6qfD9IsyQ8fdqm1 kQOh7wYuqv7Kktsw42WhuPilEjY2dABKRbkxU5NJ+BH1lxDdFnC63ncXpr4Qk9Q7Hhoe vZm3seLpHNNn0XHlfDVhUP8mLZdz3ZWuu4ZuJBXGHK0ZJm9t4I81TqwcANs3Y496CEZ8 jpWQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=user-agent:content-disposition:mime-version:message-id:subject:cc :to:from:date:dkim-signature:arc-authentication-results; bh=zIXIZhyCS5XEqI0LOc0EuK4BIj73vSkD7/LSXjo1ZzM=; b=vhTMxiULp7neeeSlan2+0NLgT6Vl+rvVCINhiqpjwr9pvIEPhtCd5w+j91D9KqVwY6 LnsU9E0aykwjtp7iyNjg7DRTIIS4/DXWjxIKJWCWDVwq2yDBuRcT4/o8sb/geYcQP3xx basE5A6wmGKLA8PB2yyCptiAFIYrfgkH8LCfj7uNoGrGbdjuOSFUONohb383LE+xJL9y nnBSrSoOEuguIEmV6OkWjC1W17JSTJwXfGjzeaxvBvdOiya9Z2LaNURAYahBkBcYI6x5 Gw3TwxZkq0qO+igddQWfhrqTcjFfYyPo0nOXLhc38/dU3mfUNTfOVO12uUHFAoO/o0bf 9hXg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=ZYeEJVnI; spf=pass (google.com: domain of aishpant@gmail.com designates 209.85.220.65 as permitted sender) smtp.mailfrom=aishpant@gmail.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=gmail.com Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=ZYeEJVnI; spf=pass (google.com: domain of aishpant@gmail.com designates 209.85.220.65 as permitted sender) smtp.mailfrom=aishpant@gmail.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=gmail.com X-Google-Smtp-Source: AH8x226KdtQm7lTup2Xp0wvRo4j9QwavA2+kzLi8v6kjxOV6BajTJelw/RGraE6HoVXMuwiarHhHdA== Date: Mon, 22 Jan 2018 21:39:22 +0530 From: Aishwarya Pant To: "Rafael J. Wysocki" , Daniel Lezcano , linux-pm@vger.kernel.org, linux-kernel@vger.kernel.org, Jonathan Corbet , Greg KH , linux-doc@vger.kernel.org Cc: Julia Lawall Subject: [PATCH] Documentation/ABI: update cpuidle sysfs documentation Message-ID: <20180122160922.GA13380@mordor.localdomain> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.9.2 (2017-12-15) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: =?utf-8?q?1590309545205953776?= X-GMAIL-MSGID: =?utf-8?q?1590309545205953776?= X-Mailing-List: linux-kernel@vger.kernel.org List-ID: Update cpuidle documentation using git logs and existing documentation in Documentation/cpuidle/sysfs.txt. This might be useful for scripting and tracking changes in the ABI. Signed-off-by: Aishwarya Pant --- Documentation/ABI/testing/sysfs-devices-system-cpu | 79 ++++++++++++++++++++++ 1 file changed, 79 insertions(+) diff --git a/Documentation/ABI/testing/sysfs-devices-system-cpu b/Documentation/ABI/testing/sysfs-devices-system-cpu index bfd29bc8d37a..f38e52d08be1 100644 --- a/Documentation/ABI/testing/sysfs-devices-system-cpu +++ b/Documentation/ABI/testing/sysfs-devices-system-cpu @@ -126,6 +126,85 @@ Description: Discover cpuidle policy and mechanism See files in Documentation/cpuidle/ for more information. +What: /sys/devices/system/cpu/cpuidle/current_driver +What: /sys/devices/system/cpu/cpuidle/available_governors +What: /sys/devices/system/cpu/cpuidle/current_governor +Date: September 2007 +KernelVersion: v2.6.24 +Contact: Linux kernel mailing list +Description: + With the cpuidle_sysfs_switch boot option enabled (meant for + developer testing), the following three attributes are visible + instead: + + current_driver: (RO) Display the current idle mechanism. + + available_governors: (RO) Display a space separated list of + available governors + + current_governor: (RW) Display the current idle policy. Users + can switch the governor at runtime by writing to this file. + + +What: /sys/devices/system/cpu/cpuX/cpuidle/stateN/name +What: /sys/devices/system/cpu/cpuX/cpuidle/stateN/latency +What: /sys/devices/system/cpu/cpuX/cpuidle/stateN/power +What: /sys/devices/system/cpu/cpuX/cpuidle/stateN/time +What: /sys/devices/system/cpu/cpuX/cpuidle/stateN/usage +Date: September 2007 +KernelVersion: v2.6.24 +Contact: Linux kernel mailing list +Description: + The directory /sys/devices/system/cpu/cpuX/cpuidle contains per + logical CPU specific cpuidle information for each online cpu X. + The processor idle states which are available for use have the + following attributes: + + name: (RO) Name of the idle state (string). + + latency: (RO) The latency to exit out of this idle state (in + microseconds). + + power: (RO) The power consumed while in this idle state (in + milliwatts). + + time: (RO) The total time spent in this idle state (in microseconds). + + usage: (RO) Number of times this state was entered (a count). + + +What: /sys/devices/system/cpu/cpuX/cpuidle/stateN/desc +Date: February 2008 +KernelVersion: v2.6.25 +Contact: Linux kernel mailing list +Description: + (RO) A small description about the idle state (string). + + +What: /sys/devices/system/cpu/cpuX/cpuidle/stateN/disable +Date: March 2012 +KernelVersion: v3.10 +Contact: Linux kernel mailing list +Description: + (RW) Option to disable this idle state (bool). The behavior and + the effect of the disable variable depends on the implementation + of a particular governor. In the ladder governor, for example, + it is not coherent, i.e. if one is disabling a light state, then + all deeper states are disabled as well, but the disable variable + does not reflect it. Likewise, if one enables a deep state but a + lighter state still is disabled, then this has no effect. + + +What: /sys/devices/system/cpu/cpuX/cpuidle/stateN/residency +Date: March 2014 +KernelVersion: v3.15 +Contact: Linux kernel mailing list +Description: + (RO) Display the target residency i.e. the minimum amount of + time (in microseconds) this cpu should spend in this idle state + to make the transition worth the effort. + + What: /sys/devices/system/cpu/cpu#/cpufreq/* Date: pre-git history Contact: linux-pm@vger.kernel.org -- 2.16.0