Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Sat, 1 Apr 2023 10:28:21 +0700
From:   Bagas Sanjaya <bagasdotme@gmail.com>
To:     David Dai <davidai@google.com>,
        "Rafael J. Wysocki" <rafael@kernel.org>,
        Viresh Kumar <viresh.kumar@linaro.org>,
        Rob Herring <robh+dt@kernel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
        Paolo Bonzini <pbonzini@redhat.com>,
        Jonathan Corbet <corbet@lwn.net>,
        Marc Zyngier <maz@kernel.org>,
        Oliver Upton <oliver.upton@linux.dev>,
        James Morse <james.morse@arm.com>,
        Suzuki K Poulose <suzuki.poulose@arm.com>,
        Zenghui Yu <yuzenghui@huawei.com>,
        Catalin Marinas <catalin.marinas@arm.com>,
        Will Deacon <will@kernel.org>,
        Mark Rutland <mark.rutland@arm.com>,
        Lorenzo Pieralisi <lpieralisi@kernel.org>,
        Sudeep Holla <sudeep.holla@arm.com>,
        Ingo Molnar <mingo@redhat.com>,
        Peter Zijlstra <peterz@infradead.org>,
        Juri Lelli <juri.lelli@redhat.com>,
        Vincent Guittot <vincent.guittot@linaro.org>,
        Dietmar Eggemann <dietmar.eggemann@arm.com>,
        Steven Rostedt <rostedt@goodmis.org>,
        Ben Segall <bsegall@google.com>, Mel Gorman <mgorman@suse.de>,
        Daniel Bristot de Oliveira <bristot@redhat.com>,
        Valentin Schneider <vschneid@redhat.com>
Cc:     Saravana Kannan <saravanak@google.com>, kernel-team@android.com,
        linux-pm@vger.kernel.org, devicetree@vger.kernel.org,
        linux-kernel@vger.kernel.org, kvm@vger.kernel.org,
        linux-doc@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
        kvmarm@lists.linux.dev
Subject: Re: [RFC PATCH v2 4/6] kvm: arm64: Add support for get_freqtbl
 service
Message-ID: <ZCek1YOmg99d6l9A@debian.me>
References: <20230331014356.1033759-1-davidai@google.com>
 <20230331014356.1033759-5-davidai@google.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
In-Reply-To: <20230331014356.1033759-5-davidai@google.com>
Precedence: bulk

On Thu, Mar 30, 2023 at 06:43:48PM -0700, David Dai wrote:
> diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
> index 38ce33564efc..8f905456e2b4 100644
> --- a/Documentation/virt/kvm/api.rst
> +++ b/Documentation/virt/kvm/api.rst
> @@ -8400,6 +8400,14 @@ after normalizing for architecture. This is useful when guests are tracking
>  workload on its vCPUs. Util hints allow the host to make more accurate
>  frequency selections and task placement for vCPU threads.
>  
> +8.42 KVM_CAP_GET_CPUFREQ_TBL
> +---------------------------
> +
> +:Architectures: arm64
> +
> +This capability indicates that the KVM supports getting the
> +frequency table of the current CPU that the vCPU thread is running on.
> +
>  9. Known KVM API problems
>  =========================
>  
> diff --git a/Documentation/virt/kvm/arm/get_freqtbl.rst b/Documentation/virt/kvm/arm/get_freqtbl.rst
> new file mode 100644
> index 000000000000..f6832d7566e7
> --- /dev/null
> +++ b/Documentation/virt/kvm/arm/get_freqtbl.rst
> @@ -0,0 +1,23 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +get_freqtbl support for arm/arm64
> +=============================
> +
> +Allows guest to query the frequency(in KHz) table of the current CPU that
> +the vCPU thread is running on.
> +
> +* ARM_SMCCC_VENDOR_HYP_KVM_GET_CPUFREQ_TBL_FUNC_ID: 0x86000042
> +
> +This hypercall uses the SMC32/HVC32 calling convention:
> +
> +ARM_SMCCC_VENDOR_HYP_KVM_GET_CPUFREQ_TBL_FUNC_ID
> +    ==============    ========    =====================================
> +    Function ID:      (uint32)    0x86000042
> +    Arguments:        (uint32)    index of the current CPU's frequency table
> +    Return Values:    (int32)     NOT_SUPPORTED(-1) on error, or
> +                      (uint32)    Frequency table entry of requested index
> +                                  in KHz
> +                                  of current CPU(r1)
> +    Endianness:                   Must be the same endianness
> +                                  as the host.
> +    ==============    ========    =====================================

Sphinx reports htmldocs warnings:
/home/bagas/repo/linux-kernel/Documentation/virt/kvm/api.rst:8404: WARNING: Title underline too short.

8.42 KVM_CAP_GET_CPUFREQ_TBL
---------------------------
/home/bagas/repo/linux-kernel/Documentation/virt/kvm/api.rst:8404: WARNING: Title underline too short.

8.42 KVM_CAP_GET_CPUFREQ_TBL
---------------------------
/home/bagas/repo/linux-kernel/Documentation/virt/kvm/arm/get_freqtbl.rst:4: WARNING: Title underline too short.

get_freqtbl support for arm/arm64
=============================

I have applied the fixup:

---- >8 ----
diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index baf8a4c43b5839..3579c470375938 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -8401,7 +8401,7 @@ workload on its vCPUs. Util hints allow the host to make more accurate
 frequency selections and task placement for vCPU threads.
 
 8.42 KVM_CAP_GET_CPUFREQ_TBL
----------------------------
+----------------------------
 
 :Architectures: arm64
 
diff --git a/Documentation/virt/kvm/arm/get_freqtbl.rst b/Documentation/virt/kvm/arm/get_freqtbl.rst
index f6832d7566e7e5..215bf0f653e461 100644
--- a/Documentation/virt/kvm/arm/get_freqtbl.rst
+++ b/Documentation/virt/kvm/arm/get_freqtbl.rst
@@ -1,7 +1,7 @@
 .. SPDX-License-Identifier: GPL-2.0
 
 get_freqtbl support for arm/arm64
-=============================
+=================================
 
 Allows guest to query the frequency(in KHz) table of the current CPU that
 the vCPU thread is running on.

Thanks.

-- 
An old man doll... just what I always wanted! - Clara