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

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
...@@ -23,21 +23,23 @@ the PV_TIME_FEATURES hypercall should be probed using the SMCCC 1.1 ...@@ -23,21 +23,23 @@ the PV_TIME_FEATURES hypercall should be probed using the SMCCC 1.1
ARCH_FEATURES mechanism before calling it. ARCH_FEATURES mechanism before calling it.
PV_TIME_FEATURES PV_TIME_FEATURES
============= ======== ==========
============= ======== =================================================
Function ID: (uint32) 0xC5000020 Function ID: (uint32) 0xC5000020
PV_call_id: (uint32) The function to query for support. PV_call_id: (uint32) The function to query for support.
Currently only PV_TIME_ST is supported. Currently only PV_TIME_ST is supported.
Return value: (int64) NOT_SUPPORTED (-1) or SUCCESS (0) if the relevant Return value: (int64) NOT_SUPPORTED (-1) or SUCCESS (0) if the relevant
PV-time feature is supported by the hypervisor. PV-time feature is supported by the hypervisor.
============= ======== ========== ============= ======== =================================================
PV_TIME_ST PV_TIME_ST
============= ======== ==========
============= ======== ==============================================
Function ID: (uint32) 0xC5000021 Function ID: (uint32) 0xC5000021
Return value: (int64) IPA of the stolen time data structure for this Return value: (int64) IPA of the stolen time data structure for this
VCPU. On failure: VCPU. On failure:
NOT_SUPPORTED (-1) NOT_SUPPORTED (-1)
============= ======== ========== ============= ======== ==============================================
The IPA returned by PV_TIME_ST should be mapped by the guest as normal memory 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 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 ...@@ -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 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. the region using 64k pages and avoids conflicting attributes with other memory.
For the user space interface see Documentation/virt/kvm/devices/vcpu.rst For the user space interface see
section "3. GROUP: KVM_ARM_VCPU_PVTIME_CTRL". :ref:`Documentation/virt/kvm/devices/vcpu.rst <kvm_arm_vcpu_pvtime_ctrl>`.
\ No newline at end of file
...@@ -171,6 +171,8 @@ configured values on other VCPUs. Userspace should configure the interrupt ...@@ -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 numbers on at least one VCPU after creating all VCPUs and before running any
VCPUs. VCPUs.
.. _kvm_arm_vcpu_pvtime_ctrl:
3. GROUP: KVM_ARM_VCPU_PVTIME_CTRL 3. GROUP: KVM_ARM_VCPU_PVTIME_CTRL
================================== ==================================
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment