Skip to content

Commit 83f8a81

Browse files
uarif1Marc Zyngier
authored andcommitted
KVM: arm64: Fix pvtime documentation
This includes table format and using reST labels for cross-referencing to vcpu.rst. Suggested-by: Bagas Sanjaya <[email protected]> Signed-off-by: Usama Arif <[email protected]> Reviewed-by: Steven Price <[email protected]> Signed-off-by: Marc Zyngier <[email protected]> Link: https://lore.kernel.org/r/[email protected]
1 parent 30a0b95 commit 83f8a81

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

Documentation/virt/kvm/arm/pvtime.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,23 @@ the PV_TIME_FEATURES hypercall should be probed using the SMCCC 1.1
2323
ARCH_FEATURES mechanism before calling it.
2424

2525
PV_TIME_FEATURES
26-
============= ======== ==========
26+
27+
============= ======== =================================================
2728
Function ID: (uint32) 0xC5000020
2829
PV_call_id: (uint32) The function to query for support.
2930
Currently only PV_TIME_ST is supported.
3031
Return value: (int64) NOT_SUPPORTED (-1) or SUCCESS (0) if the relevant
3132
PV-time feature is supported by the hypervisor.
32-
============= ======== ==========
33+
============= ======== =================================================
3334

3435
PV_TIME_ST
35-
============= ======== ==========
36+
37+
============= ======== ==============================================
3638
Function ID: (uint32) 0xC5000021
3739
Return value: (int64) IPA of the stolen time data structure for this
3840
VCPU. On failure:
3941
NOT_SUPPORTED (-1)
40-
============= ======== ==========
42+
============= ======== ==============================================
4143

4244
The IPA returned by PV_TIME_ST should be mapped by the guest as normal memory
4345
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
7678
these structures and not used for other purposes, this enables the guest to map
7779
the region using 64k pages and avoids conflicting attributes with other memory.
7880

79-
For the user space interface see Documentation/virt/kvm/devices/vcpu.rst
80-
section "3. GROUP: KVM_ARM_VCPU_PVTIME_CTRL".
81+
For the user space interface see
82+
:ref:`Documentation/virt/kvm/devices/vcpu.rst <kvm_arm_vcpu_pvtime_ctrl>`.

Documentation/virt/kvm/devices/vcpu.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,8 @@ configured values on other VCPUs. Userspace should configure the interrupt
171171
numbers on at least one VCPU after creating all VCPUs and before running any
172172
VCPUs.
173173

174+
.. _kvm_arm_vcpu_pvtime_ctrl:
175+
174176
3. GROUP: KVM_ARM_VCPU_PVTIME_CTRL
175177
==================================
176178

0 commit comments

Comments
 (0)