tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
fork atom

KVM: arm64: Fix pvtime documentation

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

Suggested-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Usama Arif <usama.arif@bytedance.com>
Reviewed-by: Steven Price <steven.price@arm.com>
Signed-off-by: Marc Zyngier <maz@kernel.org>
Link: https://lore.kernel.org/r/20221103131210.3603385-1-usama.arif@bytedance.com

authored by

Usama Arif and committed by
Marc Zyngier 83f8a81d 30a0b95b

+10 -6
+8 -6
Documentation/virt/kvm/arm/pvtime.rst
··· 23 23 ARCH_FEATURES mechanism before calling it. 24 24 25 25 PV_TIME_FEATURES 26 - ============= ======== ========== 26 + 27 + ============= ======== ================================================= 27 28 Function ID: (uint32) 0xC5000020 28 29 PV_call_id: (uint32) The function to query for support. 29 30 Currently only PV_TIME_ST is supported. 30 31 Return value: (int64) NOT_SUPPORTED (-1) or SUCCESS (0) if the relevant 31 32 PV-time feature is supported by the hypervisor. 32 - ============= ======== ========== 33 + ============= ======== ================================================= 33 34 34 35 PV_TIME_ST 35 - ============= ======== ========== 36 + 37 + ============= ======== ============================================== 36 38 Function ID: (uint32) 0xC5000021 37 39 Return value: (int64) IPA of the stolen time data structure for this 38 40 VCPU. On failure: 39 41 NOT_SUPPORTED (-1) 40 - ============= ======== ========== 42 + ============= ======== ============================================== 41 43 42 44 The IPA returned by PV_TIME_ST should be mapped by the guest as normal memory 43 45 with inner and outer write back caching attributes, in the inner shareable ··· 78 76 these structures and not used for other purposes, this enables the guest to map 79 77 the region using 64k pages and avoids conflicting attributes with other memory. 80 78 81 - For the user space interface see Documentation/virt/kvm/devices/vcpu.rst 82 - section "3. GROUP: KVM_ARM_VCPU_PVTIME_CTRL". 79 + For the user space interface see 80 + :ref:`Documentation/virt/kvm/devices/vcpu.rst <kvm_arm_vcpu_pvtime_ctrl>`.
+2
Documentation/virt/kvm/devices/vcpu.rst
··· 171 171 numbers on at least one VCPU after creating all VCPUs and before running any 172 172 VCPUs. 173 173 174 + .. _kvm_arm_vcpu_pvtime_ctrl: 175 + 174 176 3. GROUP: KVM_ARM_VCPU_PVTIME_CTRL 175 177 ================================== 176 178