From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: ARC-Seal: i=1; a=rsa-sha256; t=1518010488; cv=none; d=google.com; s=arc-20160816; b=nmt1mFevl7GfIrH1PhX32YfSVC67dTT4H4APbEQDukg54EQ7Tl3X72Z48caF/+KYx6 +sk3IQllESBs+M9pCE5aCmadbDALGi4rZAQ0JE/iuacd9FiAIYhyokhsmIT7beB+xmU0 doox3oOhaaNGWieERxq3BRhJUGgnrUWFWLhxLNVowQg8kQPj42wi0OENM+n1JQqFU86b Yjf/UJWdoP8j9/wsx146USUNYXDxzraytTcqvIpUsbkOqEbfMlzUgYLp3mZ19gxUf6C1 fBYDQjl2COLeeJnC5SjXLuMKGV6Sj1bxfMtO+gkBtQR2R1y0CN2jz2wJY9PFjA4iFV2Q wF0g== 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=gCqcU7AfobjBy2czhFruQEnFECydOnzuvKxFB3cV3LQ=; b=rMm60w1X12zWh+i44qC0HloIYV+ewZzEXzPLXGcrUBLfQ05f7GHkgfZsjNoK6XOJ+9 y7Nr2DqcjasCpInaMr3SlvakDVLao5vkjpm5r8EmDIKm0oMXIgy9UAy7fTBgxsj1fJFh d6EEofIzkyl+DhU3Fga6ez7ugC/XmxqwV0ubhBR5/NAe3e3mBnAGof7P1zkvPPq8c9T8 vcIdVaxXtxO227nvpxGf4bZaWNI+ycVV0yQ4c35FSv0z1dStA6R/n8ZAJ89EXc1HQ7yz Vrevg4wEDxC+pEWwGPFbe3WBEY3e717xzB+f1kgxMWRJMh3/27yuBGvuuZQhEXi77hqR Ujug== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=hc8NhAyO; 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=QUARANTINE dis=NONE) header.from=gmail.com Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20161025 header.b=hc8NhAyO; 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=QUARANTINE dis=NONE) header.from=gmail.com X-Google-Smtp-Source: AH8x227K7YpTHKtqQcTqRHF7G3M2ALM+h0MsaI5u+2OMSYRLt1jG62fF5EWoxsSgEDVqsbPXJdVaJg== Date: Wed, 7 Feb 2018 19:04:36 +0530 From: Aishwarya Pant To: "Rafael J. Wysocki" , Daniel Lezcano , linux-pm@vger.kernel.org, linux-kernel@vger.kernel.org, Jonathan Corbet , Greg KH Cc: Julia Lawall Subject: [PATCH v5] Documentation/ABI: update cpuidle sysfs documentation Message-ID: <20180207133436.GA7440@mordor.localdomain> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.9.3 (2018-01-21) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: =?utf-8?q?1591749365818887442?= X-GMAIL-MSGID: =?utf-8?q?1591749365818887442?= 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 --- Changes in v5: - Update contact information- LKML -> power management mailing list v4: - Fix patch formatting v3: - Fix subject line v2: - Merge cpuidle_sysfs_switch attributes' description with the previous entry. Documentation/ABI/testing/sysfs-devices-system-cpu | 77 +++++++++++++++++++++- 1 file changed, 75 insertions(+), 2 deletions(-) diff --git a/Documentation/ABI/testing/sysfs-devices-system-cpu b/Documentation/ABI/testing/sysfs-devices-system-cpu index bfd29bc8d37a..4ed63b6cfb15 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_governer_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,84 @@ Description: Discover cpuidle policy and mechanism Idle policy (governor) is differentiated from idle mechanism (driver) - current_driver: displays current idle mechanism + current_driver: (RO) displays current idle mechanism - current_governor_ro: displays current idle policy + 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 power management 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 power management 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 power management 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 power management 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.1