Skip to content

Commit aae7527

Browse files
committed
Documentation: kvm: fix a few mistakes
The only occurrence "Capability: none" actually meant the same as "basic". Fix that and a few more aesthetic or content issues in the document. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> Message-ID: <20241023124507.280382-3-pbonzini@redhat.com> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
1 parent e16e018 commit aae7527

File tree

1 file changed

+33
-15
lines changed

1 file changed

+33
-15
lines changed

Documentation/virt/kvm/api.rst

Lines changed: 33 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -96,12 +96,9 @@ description:
9696
Capability:
9797
which KVM extension provides this ioctl. Can be 'basic',
9898
which means that is will be provided by any kernel that supports
99-
API version 12 (see section 4.1), a KVM_CAP_xyz constant, which
99+
API version 12 (see section 4.1), or a KVM_CAP_xyz constant, which
100100
means availability needs to be checked with KVM_CHECK_EXTENSION
101-
(see section 4.4), or 'none' which means that while not all kernels
102-
support this ioctl, there's no capability bit to check its
103-
availability: for kernels that don't support the ioctl,
104-
the ioctl returns -ENOTTY.
101+
(see section 4.4).
105102

106103
Architectures:
107104
which instruction set architectures provide this ioctl.
@@ -338,8 +335,8 @@ KVM_S390_SIE_PAGE_OFFSET in order to obtain a memory map of the virtual
338335
cpu's hardware control block.
339336

340337

341-
4.8 KVM_GET_DIRTY_LOG (vm ioctl)
342-
--------------------------------
338+
4.8 KVM_GET_DIRTY_LOG
339+
---------------------
343340

344341
:Capability: basic
345342
:Architectures: all
@@ -1298,7 +1295,7 @@ See KVM_GET_VCPU_EVENTS for the data structure.
12981295

12991296
:Capability: KVM_CAP_DEBUGREGS
13001297
:Architectures: x86
1301-
:Type: vm ioctl
1298+
:Type: vcpu ioctl
13021299
:Parameters: struct kvm_debugregs (out)
13031300
:Returns: 0 on success, -1 on error
13041301

@@ -1320,7 +1317,7 @@ Reads debug registers from the vcpu.
13201317

13211318
:Capability: KVM_CAP_DEBUGREGS
13221319
:Architectures: x86
1323-
:Type: vm ioctl
1320+
:Type: vcpu ioctl
13241321
:Parameters: struct kvm_debugregs (in)
13251322
:Returns: 0 on success, -1 on error
13261323

@@ -2116,8 +2113,8 @@ TLB, prior to calling KVM_RUN on the associated vcpu.
21162113

21172114
The "bitmap" field is the userspace address of an array. This array
21182115
consists of a number of bits, equal to the total number of TLB entries as
2119-
determined by the last successful call to KVM_CONFIG_TLB, rounded up to the
2120-
nearest multiple of 64.
2116+
determined by the last successful call to ``KVM_ENABLE_CAP(KVM_CAP_SW_TLB)``,
2117+
rounded up to the nearest multiple of 64.
21212118

21222119
Each bit corresponds to one TLB entry, ordered the same as in the shared TLB
21232120
array.
@@ -3557,6 +3554,27 @@ Errors:
35573554
This ioctl returns the guest registers that are supported for the
35583555
KVM_GET_ONE_REG/KVM_SET_ONE_REG calls.
35593556

3557+
Note that s390 does not support KVM_GET_REG_LIST for historical reasons
3558+
(read: nobody cared). The set of registers in kernels 4.x and newer is:
3559+
3560+
- KVM_REG_S390_TODPR
3561+
3562+
- KVM_REG_S390_EPOCHDIFF
3563+
3564+
- KVM_REG_S390_CPU_TIMER
3565+
3566+
- KVM_REG_S390_CLOCK_COMP
3567+
3568+
- KVM_REG_S390_PFTOKEN
3569+
3570+
- KVM_REG_S390_PFCOMPARE
3571+
3572+
- KVM_REG_S390_PFSELECT
3573+
3574+
- KVM_REG_S390_PP
3575+
3576+
- KVM_REG_S390_GBEA
3577+
35603578

35613579
4.85 KVM_ARM_SET_DEVICE_ADDR (deprecated)
35623580
-----------------------------------------
@@ -4920,8 +4938,8 @@ Coalesced pio is based on coalesced mmio. There is little difference
49204938
between coalesced mmio and pio except that coalesced pio records accesses
49214939
to I/O ports.
49224940

4923-
4.117 KVM_CLEAR_DIRTY_LOG (vm ioctl)
4924-
------------------------------------
4941+
4.117 KVM_CLEAR_DIRTY_LOG
4942+
-------------------------
49254943

49264944
:Capability: KVM_CAP_MANUAL_DIRTY_LOG_PROTECT2
49274945
:Architectures: x86, arm64, mips
@@ -5230,7 +5248,7 @@ the cpu reset definition in the POP (Principles Of Operation).
52305248
4.123 KVM_S390_INITIAL_RESET
52315249
----------------------------
52325250

5233-
:Capability: none
5251+
:Capability: basic
52345252
:Architectures: s390
52355253
:Type: vcpu ioctl
52365254
:Parameters: none
@@ -6169,7 +6187,7 @@ applied.
61696187
.. _KVM_ARM_GET_REG_WRITABLE_MASKS:
61706188

61716189
4.139 KVM_ARM_GET_REG_WRITABLE_MASKS
6172-
-------------------------------------------
6190+
------------------------------------
61736191

61746192
:Capability: KVM_CAP_ARM_SUPPORTED_REG_MASK_RANGES
61756193
:Architectures: arm64

0 commit comments

Comments
 (0)