Commit 83f8a81d authored by Usama Arif's avatar Usama Arif Committed by Marc Zyngier
Browse files

KVM: arm64: Fix pvtime documentation 



This includes table format and using reST labels for
cross-referencing to vcpu.rst.

Suggested-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: default avatarUsama Arif <usama.arif@bytedance.com>
Reviewed-by: default avatarSteven Price <steven.price@arm.com>
Signed-off-by: default avatarMarc Zyngier <maz@kernel.org>
Link: https://lore.kernel.org/r/20221103131210.3603385-1-usama.arif@bytedance.com
parent 30a0b95b

Documentation/virt/kvm/arm/pvtime.rst

+8 −6
Original line number Diff line number Diff line
@@ -23,21 +23,23 @@ the PV_TIME_FEATURES hypercall should be probed using the SMCCC 1.1 
ARCH_FEATURES mechanism before calling it.



PV_TIME_FEATURES

    ============= ========    ==========



    ============= ========    =================================================

    Function ID:  (uint32)    0xC5000020

    PV_call_id:   (uint32)    The function to query for support.

                              Currently only PV_TIME_ST is supported.

    Return value: (int64)     NOT_SUPPORTED (-1) or SUCCESS (0) if the relevant

                              PV-time feature is supported by the hypervisor.

    ============= ========    ==========

    ============= ========    =================================================



PV_TIME_ST

    ============= ========    ==========



    ============= ========    ==============================================

    Function ID:  (uint32)    0xC5000021

    Return value: (int64)     IPA of the stolen time data structure for this

                              VCPU. On failure:

                              NOT_SUPPORTED (-1)

    ============= ========    ==========

    ============= ========    ==============================================



The IPA returned by PV_TIME_ST should be mapped by the guest as normal memory

with inner and outer write back caching attributes, in the inner shareable
@@ -76,5 +78,5 @@ It is advisable that one or more 64k pages are set aside for the purpose of 
these structures and not used for other purposes, this enables the guest to map

the region using 64k pages and avoids conflicting attributes with other memory.



For the user space interface see Documentation/virt/kvm/devices/vcpu.rst

section "3. GROUP: KVM_ARM_VCPU_PVTIME_CTRL".
 
For the user space interface see

:ref:`Documentation/virt/kvm/devices/vcpu.rst <kvm_arm_vcpu_pvtime_ctrl>`.
 
 No newline at end of file

Documentation/virt/kvm/devices/vcpu.rst

+2 −0
Original line number Diff line number Diff line
@@ -171,6 +171,8 @@ configured values on other VCPUs. Userspace should configure the interrupt 
numbers on at least one VCPU after creating all VCPUs and before running any

VCPUs.



.. _kvm_arm_vcpu_pvtime_ctrl:



3. GROUP: KVM_ARM_VCPU_PVTIME_CTRL

==================================