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

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 <mchehab+huawei@kernel.org>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>

authored by

Mauro Carvalho Chehab and committed by
Paolo Bonzini
5cccf379 6c972ba6

+23 -6
+1
Documentation/virt/kvm/devices/index.rst
··· 15 15 vcpu 16 16 vfio 17 17 vm 18 + xics
+22 -6
Documentation/virt/kvm/devices/xics.txt Documentation/virt/kvm/devices/xics.rst
··· 1 + .. SPDX-License-Identifier: GPL-2.0 2 + 3 + ========================= 1 4 XICS interrupt controller 5 + ========================= 2 6 3 7 Device type supported: KVM_DEV_TYPE_XICS 4 8 5 9 Groups: 6 10 1. KVM_DEV_XICS_GRP_SOURCES 7 - Attributes: One per interrupt source, indexed by the source number. 11 + Attributes: 8 12 13 + One per interrupt source, indexed by the source number. 9 14 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 + 12 19 The kvm_device_attr.addr points to a __u32 value which is the number of 13 20 interrupt server numbers (ie, highest possible vcpu id plus one). 21 + 14 22 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 + ======= ========================================== 18 29 19 30 This device emulates the XICS (eXternal Interrupt Controller 20 31 Specification) defined in PAPR. The XICS has a set of interrupt ··· 64 53 bitfields, starting from the least-significant end of the word: 65 54 66 55 * Destination (server number), 32 bits 56 + 67 57 This specifies where the interrupt should be sent, and is the 68 58 interrupt server number specified for the destination vcpu. 69 59 70 60 * Priority, 8 bits 61 + 71 62 This is the priority specified for this interrupt source, where 0 is 72 63 the highest priority and 255 is the lowest. An interrupt with a 73 64 priority of 255 will never be delivered. 74 65 75 66 * Level sensitive flag, 1 bit 67 + 76 68 This bit is 1 for a level-sensitive interrupt source, or 0 for 77 69 edge-sensitive (or MSI). 78 70 79 71 * Masked flag, 1 bit 72 + 80 73 This bit is set to 1 if the interrupt is masked (cannot be delivered 81 74 regardless of its priority), for example by the ibm,int-off RTAS 82 75 call, or 0 if it is not masked. 83 76 84 77 * Pending flag, 1 bit 78 + 85 79 This bit is 1 if the source has a pending interrupt, otherwise 0. 86 80 87 81 Only one XICS instance may be created per VM.