From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: ARC-Seal: i=1; a=rsa-sha256; t=1516643055; cv=none; d=google.com; s=arc-20160816; b=ZftrUEyJlIbJiZg7H7Yh7e0iG7dYCUnBO0ZjGW1VJaj+3AJyEYYhIhzWLguP1y4sRr 3iYj6UrLdXFyJhu9EmCGjuoIzmWkl6WKScBn/zHiJQcF7tlqhyzCTJGcObXXi/SJ8bhJ KzGidFSh/bE+iKIbzrrMNd17KHm9/ZJR6+kugAEKBAJk7/zKGqpDzQV7zY6S+fu9gCbi HXlbxv3CbSyFzrNA3w98WF6whjyfYq3JVq5RMKUEAzTE1mfH1nEi2FqXVNus2Ap0DpiI jYtdjg5iglzLQo6V5Ad5Gv6L8JEY5KLJ3n+pPGn6MNteaGvdhge2VMSuNcUdOLDupxm7 lNNg== 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=jxZfBhSC8jyHgY3Gxws8ZLfr4XDT4gLY8SUvV/a9Y1I=; b=DCu7nA0flZwDfXvRpSHT7oNDiRSV1TY4hqAH55yB/U221ve7eK0huz76jUHvyu5MZV +mR+I9kmveuyWZX7VDqm2e/yc8kY850sEKYAvgn5yZDqySkfU+bGQp6chvPx0XnhsD4Q uCxM+kb1VZ5gGxRRx3jn8gSbpbDPH7jXFT+kFn/3sjDSOeK5Nc8L18PgvurVe45VwaXj 4FZIK9Jl9po5N9FWZs5SuvQ12Ck0/lE03Ix5cdf9il5VPnv/lpQ75NG7j9FHsKlgeXiA EvWLHzxPaesp4PiHxphDo3F8F+Dg+9H3AILMqB8yJP986odNl8CR5V8WSkv9dSuI7f76 Ob7g== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=vMwFw63y; 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=vMwFw63y; 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: AH8x226OR/WlaocNqSFQxYw7vXUrwcCiais/hLawkTVBwM+I2o5P34UDJKNRgrJdme9AGn7fNFSPjw== Date: Mon, 22 Jan 2018 23:14:07 +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 v2] Documentation/ABI: update cpuidle sysfs documentationDaniel Lezcano , Message-ID: <20180122174407.GA21985@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?1590315507891314274?= X-GMAIL-MSGID: =?utf-8?q?1590315507891314274?= 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 --- Change in v2: - Merge cpuidle_sysfs_switch attributes' description with the previous entry. Documentation/ABI/testing/sysfs-devices-system-cpu | 80 +++++++++++++++++++++- 1 file changed, 78 insertions(+), 2 deletions(-) diff --git a/Documentation/ABI/testing/sysfs-devices-system-cpu b/Documentation/ABI/testing/sysfs-devices-system-cpu index bfd29bc8d37a..113402ca9397 100644 --- a/Documentation/ABI/testing/sysfs-devices-system-cpu +++ b/Documentation/ABI/testing/sysfs-devices-system-cpu @@ -108,6 +108,8 @@ Description: CPU topology files that describe a logical CPU's relationship What: /sys/devices/system/cpu/cpuidle/current_driver /sys/devices/system/cpu/cpuidle/current_governor_ro + /sys/devices/system/cpu/cpuidle/available_governors + /sys/devices/system/cpu/cpuidle/current_governor Date: September 2007 Contact: Linux kernel mailing list Description: Discover cpuidle policy and mechanism @@ -119,13 +121,87 @@ Description: Discover cpuidle policy and mechanism Idle policy (governor) is differentiated from idle mechanism (driver) - current_driver: displays current idle mechanism + System global cpuidle related information and tunables are under + /sys/devices/system/cpu/cpuidle. Briefly, the attributes are: - current_governor_ro: displays current idle policy + current_driver: (RO) displays current idle mechanism + + current_governor_ro: (RO) displays current idle policy + + With the cpuidle_sysfs_switch boot option enabled (meant for + developer testing), the following three attributes are visible + instead: + + current_driver: same as described above + + available_governors: (RO) displays a space separated list of + available governors + + current_governor: (RW) displays current idle policy. Users can + switch the governor at runtime by writing to this file. See files in Documentation/cpuidle/ for more information. +What: /sys/devices/system/cpu/cpuX/cpuidle/stateN/name + /sys/devices/system/cpu/cpuX/cpuidle/stateN/latency + /sys/devices/system/cpu/cpuX/cpuidle/stateN/power + /sys/devices/system/cpu/cpuX/cpuidle/stateN/time + /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