From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-7.1 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 85878C10F11 for ; Wed, 24 Apr 2019 14:49:03 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 4B64E21900 for ; Wed, 24 Apr 2019 14:49:03 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1556117343; bh=RACQuezekI87uWLUmnG3jM14EiJr8aBE68S26M57pGw=; h=Date:From:To:Cc:Subject:In-Reply-To:References:List-ID:From; b=Dlg3yrHZz0AVXnfXs0/eDIA2Rf7zgq+UxAoNFr4QVmlh3X1ON9+pXnmNt8XzqPRlF QZ/LhiQqHlBLUbIAF39Pc7Htpzqvj5/k8EQjPRQe5lWvOQoR8ENYPUBdmgCz23RWce TuiFozbYD/o5efPgOKWtRw0Tsx/9sHYhr17EUaDA= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1731243AbfDXOs4 (ORCPT ); Wed, 24 Apr 2019 10:48:56 -0400 Received: from casper.infradead.org ([85.118.1.10]:49650 "EHLO casper.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1731090AbfDXOsz (ORCPT ); Wed, 24 Apr 2019 10:48:55 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; h=Content-Transfer-Encoding:Content-Type: MIME-Version:References:In-Reply-To:Message-ID:Subject:Cc:To:From:Date:Sender :Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help: List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=7Shg0OtwYZ50M3niqQeZnsr0hUTXiYPbDu4iMf3r0tM=; b=kY1dXUi73ikUzi+w5/lnS0KqY8 f3yV42MiWhAo3kveoUB8njVl8uBuwwjRTL2ZRPnU2ggWqkUH3FE94dgd+weonZg7CKbYp4FLD+fEP fmqb28Mpd94VzsY4OF4qsqfFihiI62jwmz64CZQxG4ndmPbpouqdz+JwpBasNKpns57K2hPbWcFUP X1W4RMbp+gvUVaRhirUZfTr3geBbCZ1QWrmdCO2j0VcIkROfBInTAPLOxEAj7P37BqmckQk8uMY6d Bj9YMOjeT6vBzUY74XLzLQZCoUaJZvPCZXWErefPcajAP80PzME7rEijgm18tiVSBe4jmNkMdZ83S yViuLzAw==; Received: from 177.17.136.231.dynamic.adsl.gvt.net.br ([177.17.136.231] helo=coco.lan) by casper.infradead.org with esmtpsa (Exim 4.90_1 #2 (Red Hat Linux)) id 1hJJCc-0000Zd-MX; Wed, 24 Apr 2019 14:48:51 +0000 Date: Wed, 24 Apr 2019 11:48:44 -0300 From: Mauro Carvalho Chehab To: Changbin Du Cc: Jonathan Corbet , Bjorn Helgaas , rjw@rjwysocki.net, linux-pci@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, tglx@linutronix.de, mingo@redhat.com, x86@kernel.org, fenghua.yu@intel.com, linuxppc-dev@lists.ozlabs.org, linux-acpi@vger.kernel.org, linux-gpio@vger.kernel.org Subject: Re: [PATCH v4 21/63] Documentation: ACPI: move cppc_sysfs.txt to admin-guide/acpi and convert to reST Message-ID: <20190424114844.5de4cfa5@coco.lan> In-Reply-To: <20190423162932.21428-22-changbin.du@gmail.com> References: <20190423162932.21428-1-changbin.du@gmail.com> <20190423162932.21428-22-changbin.du@gmail.com> X-Mailer: Claws Mail 3.17.3 (GTK+ 2.24.32; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Sender: linux-pci-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org Em Wed, 24 Apr 2019 00:28:50 +0800 Changbin Du escreveu: > This converts the plain text documentation to reStructuredText format and > add it to Sphinx TOC tree. No essential content change. > > Signed-off-by: Changbin Du > --- > .../acpi/cppc_sysfs.rst} | 71 ++++++++++--------- > Documentation/admin-guide/acpi/index.rst | 1 + > 2 files changed, 40 insertions(+), 32 deletions(-) > rename Documentation/{acpi/cppc_sysfs.txt => admin-guide/acpi/cppc_sysfs.rst} (51%) > > diff --git a/Documentation/acpi/cppc_sysfs.txt b/Documentation/admin-guide/acpi/cppc_sysfs.rst > similarity index 51% > rename from Documentation/acpi/cppc_sysfs.txt > rename to Documentation/admin-guide/acpi/cppc_sysfs.rst > index f20fb445135d..a4b99afbe331 100644 > --- a/Documentation/acpi/cppc_sysfs.txt > +++ b/Documentation/admin-guide/acpi/cppc_sysfs.rst > @@ -1,5 +1,11 @@ > +.. SPDX-License-Identifier: GPL-2.0 > > - Collaborative Processor Performance Control (CPPC) > +================================================== > +Collaborative Processor Performance Control (CPPC) > +================================================== > + > +CPPC > +==== > > CPPC defined in the ACPI spec describes a mechanism for the OS to manage the > performance of a logical processor on a contigious and abstract performance > @@ -10,31 +16,28 @@ For more details on CPPC please refer to the ACPI specification at: > > http://uefi.org/specifications > > -Some of the CPPC registers are exposed via sysfs under: > - > -/sys/devices/system/cpu/cpuX/acpi_cppc/ > - > -for each cpu X Hmm... removed by mistake? > +Some of the CPPC registers are exposed via sysfs under:: > > --------------------------------------------------------------------------------- > + /sys/devices/system/cpu/cpuX/acpi_cppc/ Did you parse this with Sphinx? It doesn't sound a valid ReST construction to my eyes, as: 1) I've seen some versions of Sphinx to abort with severe errors when there's no blank line after the horizontal bar markup; 2) It will very likely ignore the "::" (I didn't test it myself), as you're not indenting the horizontal bar. End of indentation will mean the end of an (empty) literal block. So, I would stick with: Some of the CPPC registers are exposed via sysfs under: /sys/devices/system/cpu/cpuX/acpi_cppc/ --------------------------------------------------------------------------------- for each cpu X:: or: Some of the CPPC registers are exposed via sysfs under: /sys/devices/system/cpu/cpuX/acpi_cppc/ for each cpu X -------------------------------------------------------------------------------- :: (with is closer to the original author's intent) Same applies to the other similar changes on this document. > > -$ ls -lR /sys/devices/system/cpu/cpu0/acpi_cppc/ > -/sys/devices/system/cpu/cpu0/acpi_cppc/: > -total 0 > --r--r--r-- 1 root root 65536 Mar 5 19:38 feedback_ctrs > --r--r--r-- 1 root root 65536 Mar 5 19:38 highest_perf > --r--r--r-- 1 root root 65536 Mar 5 19:38 lowest_freq > --r--r--r-- 1 root root 65536 Mar 5 19:38 lowest_nonlinear_perf > --r--r--r-- 1 root root 65536 Mar 5 19:38 lowest_perf > --r--r--r-- 1 root root 65536 Mar 5 19:38 nominal_freq > --r--r--r-- 1 root root 65536 Mar 5 19:38 nominal_perf > --r--r--r-- 1 root root 65536 Mar 5 19:38 reference_perf > --r--r--r-- 1 root root 65536 Mar 5 19:38 wraparound_time > +for each cpu X:: > > --------------------------------------------------------------------------------- > + $ ls -lR /sys/devices/system/cpu/cpu0/acpi_cppc/ > + /sys/devices/system/cpu/cpu0/acpi_cppc/: > + total 0 > + -r--r--r-- 1 root root 65536 Mar 5 19:38 feedback_ctrs > + -r--r--r-- 1 root root 65536 Mar 5 19:38 highest_perf > + -r--r--r-- 1 root root 65536 Mar 5 19:38 lowest_freq > + -r--r--r-- 1 root root 65536 Mar 5 19:38 lowest_nonlinear_perf > + -r--r--r-- 1 root root 65536 Mar 5 19:38 lowest_perf > + -r--r--r-- 1 root root 65536 Mar 5 19:38 nominal_freq > + -r--r--r-- 1 root root 65536 Mar 5 19:38 nominal_perf > + -r--r--r-- 1 root root 65536 Mar 5 19:38 reference_perf > + -r--r--r-- 1 root root 65536 Mar 5 19:38 wraparound_time > > * highest_perf : Highest performance of this processor (abstract scale). > -* nominal_perf : Highest sustained performance of this processor (abstract scale). > +* nominal_perf : Highest sustained performance of this processor > + (abstract scale). > * lowest_nonlinear_perf : Lowest performance of this processor with nonlinear > power savings (abstract scale). > * lowest_perf : Lowest performance of this processor (abstract scale). > @@ -48,22 +51,26 @@ total 0 > * feedback_ctrs : Includes both Reference and delivered performance counter. > Reference counter ticks up proportional to processor's reference performance. > Delivered counter ticks up proportional to processor's delivered performance. > -* wraparound_time: Minimum time for the feedback counters to wraparound (seconds). > +* wraparound_time: Minimum time for the feedback counters to wraparound > + (seconds). > * reference_perf : Performance level at which reference performance counter > accumulates (abstract scale). > > --------------------------------------------------------------------------------- > > - Computing Average Delivered Performance > +Computing Average Delivered Performance > +======================================= > + > +Below describes the steps to compute the average performance delivered by > +taking two different snapshots of feedback counters at time T1 and T2. > + > + T1: Read feedback_ctrs as fbc_t1 > + Wait or run some workload > > -Below describes the steps to compute the average performance delivered by taking > -two different snapshots of feedback counters at time T1 and T2. > + T2: Read feedback_ctrs as fbc_t2 > > -T1: Read feedback_ctrs as fbc_t1 > - Wait or run some workload > -T2: Read feedback_ctrs as fbc_t2 > +:: > > -delivered_counter_delta = fbc_t2[del] - fbc_t1[del] > -reference_counter_delta = fbc_t2[ref] - fbc_t1[ref] > + delivered_counter_delta = fbc_t2[del] - fbc_t1[del] > + reference_counter_delta = fbc_t2[ref] - fbc_t1[ref] > > -delivered_perf = (refernce_perf x delivered_counter_delta) / reference_counter_delta > + delivered_perf = (refernce_perf x delivered_counter_delta) / reference_counter_delta > diff --git a/Documentation/admin-guide/acpi/index.rst b/Documentation/admin-guide/acpi/index.rst > index d68e9914c5ff..9049a7b9f065 100644 > --- a/Documentation/admin-guide/acpi/index.rst > +++ b/Documentation/admin-guide/acpi/index.rst > @@ -10,3 +10,4 @@ the Linux ACPI support. > > initrd_table_override > dsdt-override > + cppc_sysfs Thanks, Mauro