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

docs: kvm: convert devices/arm-vgit.txt to ReST

- Use title markups;
- change indent to match ReST syntax;
- use proper table markups;
- use literal block 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
bf6154db c0d1c8a0

+60 -30
+59 -30
Documentation/virt/kvm/devices/arm-vgic.txt Documentation/virt/kvm/devices/arm-vgic.rst
··· 1 + .. SPDX-License-Identifier: GPL-2.0 2 + 3 + ================================================== 1 4 ARM Virtual Generic Interrupt Controller v2 (VGIC) 2 5 ================================================== 3 6 4 7 Device types supported: 5 - KVM_DEV_TYPE_ARM_VGIC_V2 ARM Generic Interrupt Controller v2.0 8 + 9 + - KVM_DEV_TYPE_ARM_VGIC_V2 ARM Generic Interrupt Controller v2.0 6 10 7 11 Only one VGIC instance may be instantiated through either this API or the 8 12 legacy KVM_CREATE_IRQCHIP API. The created VGIC will act as the VM interrupt ··· 21 17 22 18 Groups: 23 19 KVM_DEV_ARM_VGIC_GRP_ADDR 24 - Attributes: 20 + Attributes: 21 + 25 22 KVM_VGIC_V2_ADDR_TYPE_DIST (rw, 64-bit) 26 23 Base address in the guest physical address space of the GIC distributor 27 24 register mappings. Only valid for KVM_DEV_TYPE_ARM_VGIC_V2. ··· 32 27 Base address in the guest physical address space of the GIC virtual cpu 33 28 interface register mappings. Only valid for KVM_DEV_TYPE_ARM_VGIC_V2. 34 29 This address needs to be 4K aligned and the region covers 4 KByte. 30 + 35 31 Errors: 36 - -E2BIG: Address outside of addressable IPA range 37 - -EINVAL: Incorrectly aligned address 38 - -EEXIST: Address already configured 39 - -ENXIO: The group or attribute is unknown/unsupported for this device 32 + 33 + ======= ============================================================= 34 + -E2BIG Address outside of addressable IPA range 35 + -EINVAL Incorrectly aligned address 36 + -EEXIST Address already configured 37 + -ENXIO The group or attribute is unknown/unsupported for this device 40 38 or hardware support is missing. 41 - -EFAULT: Invalid user pointer for attr->addr. 39 + -EFAULT Invalid user pointer for attr->addr. 40 + ======= ============================================================= 42 41 43 42 KVM_DEV_ARM_VGIC_GRP_DIST_REGS 44 - Attributes: 45 - The attr field of kvm_device_attr encodes two values: 46 - bits: | 63 .... 40 | 39 .. 32 | 31 .... 0 | 47 - values: | reserved | vcpu_index | offset | 43 + Attributes: 44 + 45 + The attr field of kvm_device_attr encodes two values:: 46 + 47 + bits: | 63 .... 40 | 39 .. 32 | 31 .... 0 | 48 + values: | reserved | vcpu_index | offset | 48 49 49 50 All distributor regs are (rw, 32-bit) 50 51 ··· 69 58 KVM_DEV_ARM_VGIC_GRP_DIST_REGS and KVM_DEV_ARM_VGIC_GRP_CPU_REGS) to ensure 70 59 the expected behavior. Unless GICD_IIDR has been set from userspace, writes 71 60 to the interrupt group registers (GICD_IGROUPR) are ignored. 61 + 72 62 Errors: 73 - -ENXIO: Getting or setting this register is not yet supported 74 - -EBUSY: One or more VCPUs are running 75 - -EINVAL: Invalid vcpu_index supplied 63 + 64 + ======= ===================================================== 65 + -ENXIO Getting or setting this register is not yet supported 66 + -EBUSY One or more VCPUs are running 67 + -EINVAL Invalid vcpu_index supplied 68 + ======= ===================================================== 76 69 77 70 KVM_DEV_ARM_VGIC_GRP_CPU_REGS 78 - Attributes: 79 - The attr field of kvm_device_attr encodes two values: 80 - bits: | 63 .... 40 | 39 .. 32 | 31 .... 0 | 81 - values: | reserved | vcpu_index | offset | 71 + Attributes: 72 + 73 + The attr field of kvm_device_attr encodes two values:: 74 + 75 + bits: | 63 .... 40 | 39 .. 32 | 31 .... 0 | 76 + values: | reserved | vcpu_index | offset | 82 77 83 78 All CPU interface regs are (rw, 32-bit) 84 79 ··· 118 101 value left by 3 places to obtain the actual priority mask level. 119 102 120 103 Errors: 121 - -ENXIO: Getting or setting this register is not yet supported 122 - -EBUSY: One or more VCPUs are running 123 - -EINVAL: Invalid vcpu_index supplied 104 + 105 + ======= ===================================================== 106 + -ENXIO Getting or setting this register is not yet supported 107 + -EBUSY One or more VCPUs are running 108 + -EINVAL Invalid vcpu_index supplied 109 + ======= ===================================================== 124 110 125 111 KVM_DEV_ARM_VGIC_GRP_NR_IRQS 126 - Attributes: 112 + Attributes: 113 + 127 114 A value describing the number of interrupts (SGI, PPI and SPI) for 128 115 this GIC instance, ranging from 64 to 1024, in increments of 32. 129 116 130 117 Errors: 131 - -EINVAL: Value set is out of the expected range 132 - -EBUSY: Value has already be set, or GIC has already been initialized 133 - with default values. 118 + 119 + ======= ============================================================= 120 + -EINVAL Value set is out of the expected range 121 + -EBUSY Value has already be set, or GIC has already been initialized 122 + with default values. 123 + ======= ============================================================= 134 124 135 125 KVM_DEV_ARM_VGIC_GRP_CTRL 136 - Attributes: 126 + Attributes: 127 + 137 128 KVM_DEV_ARM_VGIC_CTRL_INIT 138 129 request the initialization of the VGIC or ITS, no additional parameter 139 130 in kvm_device_attr.addr. 131 + 140 132 Errors: 141 - -ENXIO: VGIC not properly configured as required prior to calling 142 - this attribute 143 - -ENODEV: no online VCPU 144 - -ENOMEM: memory shortage when allocating vgic internal data 133 + 134 + ======= ========================================================= 135 + -ENXIO VGIC not properly configured as required prior to calling 136 + this attribute 137 + -ENODEV no online VCPU 138 + -ENOMEM memory shortage when allocating vgic internal data 139 + ======= =========================================================
+1
Documentation/virt/kvm/devices/index.rst
··· 8 8 :maxdepth: 2 9 9 10 10 arm-vgic-its 11 + arm-vgic 11 12 arm-vgic-v3