From patchwork Mon Jan 22 16:09:22 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Aishwarya Pant X-Patchwork-Id: 10178831 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 7C64A602B7 for ; Mon, 22 Jan 2018 16:09:33 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 6F7C52811A for ; Mon, 22 Jan 2018 16:09:33 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 62B44283AD; Mon, 22 Jan 2018 16:09:33 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-7.0 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, FREEMAIL_FROM, RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 4D6B52811A for ; Mon, 22 Jan 2018 16:09:32 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751110AbeAVQJa (ORCPT ); Mon, 22 Jan 2018 11:09:30 -0500 Received: from mail-pg0-f66.google.com ([74.125.83.66]:34190 "EHLO mail-pg0-f66.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1750997AbeAVQJ3 (ORCPT ); Mon, 22 Jan 2018 11:09:29 -0500 Received: by mail-pg0-f66.google.com with SMTP id r19so7435973pgn.1; Mon, 22 Jan 2018 08:09:28 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=date:from:to:cc:subject:message-id:mime-version:content-disposition :user-agent; bh=zIXIZhyCS5XEqI0LOc0EuK4BIj73vSkD7/LSXjo1ZzM=; b=ZYeEJVnIAXplLOxwxuTpQMmQJ43ukJ4AG5hkd4AtrpW8efFe/eY4+I8evbgS34kzbp Zl65qhpt9+K0w4ADncmhcCjB0eboQiPmjfa7mCGE3E3+eAfTdlARdtoNGk048QOlMf9M XMPOtZ0nbxfEB2UVsu1mob2sHsRcvOsjIgJnup3QYvtA8GvUSEsqGf1VIP8WpPnFArqD Eh9/r039/aot04kIjBlSFyUaX+xqjyXwciXEqbv/wIA0154nA1+U1A+CGUAEX44VsSRl /iCjoA5xK2JYiatMbokzy66cItVoroiuDmWu02XDaeh5ydh9PcI3uoi0rUKxVk2ADoz+ Ffow== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:mime-version :content-disposition:user-agent; bh=zIXIZhyCS5XEqI0LOc0EuK4BIj73vSkD7/LSXjo1ZzM=; b=Yele/bIHh+aCirwu1/HchLDrpn1Z7MZtAkjBgl4/Kj5UrwYJ6LGkwErmno0xpYD21P S5J4ops6nP7kLC8e4jl7rLjJgNCMbvVPQP5F89lqAqUY/zdJ/ogrDjEHT1ufDMkt99rL r2js+l3NFRie/B0u6PvGj5qMvHS3ErtM0dEQAr0GOmdDNaWbt4Z/DAoSaBW/x2SHj10T htQx8YdqE0agwIqqxuXDPzF/fJwHa+9GPFLVDpjpRlAQlbQHM2AK00lLFfFc0aiKflmR ZdOBr2KqDYUJ1vSdJmm3eA3ZKbi6lgTKlCWDDUbao+VlHu3qknkWuLVrPdNCPz7yd1OG Lydg== X-Gm-Message-State: AKwxytdDZA9fwNC6YjJKzxZli6WPVIQqBbFS3AFPpNT1t5Kepp4bbuwN VG8U5Dg2vubmwKo9bVKeRt0= X-Google-Smtp-Source: AH8x226KdtQm7lTup2Xp0wvRo4j9QwavA2+kzLi8v6kjxOV6BajTJelw/RGraE6HoVXMuwiarHhHdA== X-Received: by 10.99.113.75 with SMTP id b11mr7752781pgn.271.1516637368398; Mon, 22 Jan 2018 08:09:28 -0800 (PST) Received: from mordor.localdomain ([49.205.216.57]) by smtp.gmail.com with ESMTPSA id q65sm1469863pfj.137.2018.01.22.08.09.25 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Mon, 22 Jan 2018 08:09:27 -0800 (PST) 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-Disposition: inline User-Agent: Mutt/1.9.2 (2017-12-15) Sender: linux-pm-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-pm@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP 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