Skip to content

Commit 5cccf37

Browse files
mchehabbonzini
authored andcommitted
docs: kvm: convert devices/xics.txt to ReST
- Use title markups; - adjust indentation and add blank lines as needed; - adjust tables to match ReST accepted formats; - use :field: markups. Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Paolo Bonzini <[email protected]>
1 parent 6c972ba commit 5cccf37

File tree

2 files changed

+23
-6
lines changed

2 files changed

+23
-6
lines changed

Documentation/virt/kvm/devices/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,4 @@ Devices
1515
vcpu
1616
vfio
1717
vm
18+
xics

Documentation/virt/kvm/devices/xics.txt renamed to Documentation/virt/kvm/devices/xics.rst

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,31 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
=========================
14
XICS interrupt controller
5+
=========================
26

37
Device type supported: KVM_DEV_TYPE_XICS
48

59
Groups:
610
1. KVM_DEV_XICS_GRP_SOURCES
7-
Attributes: One per interrupt source, indexed by the source number.
11+
Attributes:
812

13+
One per interrupt source, indexed by the source number.
914
2. KVM_DEV_XICS_GRP_CTRL
10-
Attributes:
11-
2.1 KVM_DEV_XICS_NR_SERVERS (write only)
15+
Attributes:
16+
17+
2.1 KVM_DEV_XICS_NR_SERVERS (write only)
18+
1219
The kvm_device_attr.addr points to a __u32 value which is the number of
1320
interrupt server numbers (ie, highest possible vcpu id plus one).
21+
1422
Errors:
15-
-EINVAL: Value greater than KVM_MAX_VCPU_ID.
16-
-EFAULT: Invalid user pointer for attr->addr.
17-
-EBUSY: A vcpu is already connected to the device.
23+
24+
======= ==========================================
25+
-EINVAL Value greater than KVM_MAX_VCPU_ID.
26+
-EFAULT Invalid user pointer for attr->addr.
27+
-EBUSY A vcpu is already connected to the device.
28+
======= ==========================================
1829

1930
This device emulates the XICS (eXternal Interrupt Controller
2031
Specification) defined in PAPR. The XICS has a set of interrupt
@@ -53,24 +64,29 @@ the interrupt source number. The 64 bit state word has the following
5364
bitfields, starting from the least-significant end of the word:
5465

5566
* Destination (server number), 32 bits
67+
5668
This specifies where the interrupt should be sent, and is the
5769
interrupt server number specified for the destination vcpu.
5870

5971
* Priority, 8 bits
72+
6073
This is the priority specified for this interrupt source, where 0 is
6174
the highest priority and 255 is the lowest. An interrupt with a
6275
priority of 255 will never be delivered.
6376

6477
* Level sensitive flag, 1 bit
78+
6579
This bit is 1 for a level-sensitive interrupt source, or 0 for
6680
edge-sensitive (or MSI).
6781

6882
* Masked flag, 1 bit
83+
6984
This bit is set to 1 if the interrupt is masked (cannot be delivered
7085
regardless of its priority), for example by the ibm,int-off RTAS
7186
call, or 0 if it is not masked.
7287

7388
* Pending flag, 1 bit
89+
7490
This bit is 1 if the source has a pending interrupt, otherwise 0.
7591

7692
Only one XICS instance may be created per VM.

0 commit comments

Comments
 (0)