Commit bf6154db authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Paolo Bonzini
Browse files

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: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: default avatarPaolo Bonzini <pbonzini@redhat.com>
parent c0d1c8a0

Documentation/virt/kvm/devices/arm-vgic.txt→Documentation/virt/kvm/devices/arm-vgic.rst

+59 −30
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



==================================================

ARM Virtual Generic Interrupt Controller v2 (VGIC)

==================================================



Device types supported:

  KVM_DEV_TYPE_ARM_VGIC_V2     ARM Generic Interrupt Controller v2.0



  - KVM_DEV_TYPE_ARM_VGIC_V2     ARM Generic Interrupt Controller v2.0



Only one VGIC instance may be instantiated through either this API or the

legacy KVM_CREATE_IRQCHIP API.  The created VGIC will act as the VM interrupt
@@ -18,6 +22,7 @@ create both a GICv3 and GICv2 device on the same VM. 
Groups:

  KVM_DEV_ARM_VGIC_GRP_ADDR

   Attributes:



    KVM_VGIC_V2_ADDR_TYPE_DIST (rw, 64-bit)

      Base address in the guest physical address space of the GIC distributor

      register mappings. Only valid for KVM_DEV_TYPE_ARM_VGIC_V2.
@@ -27,17 +32,23 @@ Groups: 
      Base address in the guest physical address space of the GIC virtual cpu

      interface register mappings. Only valid for KVM_DEV_TYPE_ARM_VGIC_V2.

      This address needs to be 4K aligned and the region covers 4 KByte.



  Errors:

    -E2BIG:  Address outside of addressable IPA range

    -EINVAL: Incorrectly aligned address

    -EEXIST: Address already configured

    -ENXIO:  The group or attribute is unknown/unsupported for this device



    =======  =============================================================

    -E2BIG   Address outside of addressable IPA range

    -EINVAL  Incorrectly aligned address

    -EEXIST  Address already configured

    -ENXIO   The group or attribute is unknown/unsupported for this device

             or hardware support is missing.

    -EFAULT: Invalid user pointer for attr->addr.

    -EFAULT  Invalid user pointer for attr->addr.

    =======  =============================================================



  KVM_DEV_ARM_VGIC_GRP_DIST_REGS

   Attributes:

    The attr field of kvm_device_attr encodes two values:



    The attr field of kvm_device_attr encodes two values::



      bits:     | 63   ....  40 | 39 ..  32  |  31   ....    0 |

      values:   |    reserved   | vcpu_index |      offset     |
@@ -58,14 +69,20 @@ Groups: 
    KVM_DEV_ARM_VGIC_GRP_DIST_REGS and KVM_DEV_ARM_VGIC_GRP_CPU_REGS) to ensure

    the expected behavior. Unless GICD_IIDR has been set from userspace, writes

    to the interrupt group registers (GICD_IGROUPR) are ignored.



  Errors:

    -ENXIO: Getting or setting this register is not yet supported

    -EBUSY: One or more VCPUs are running

    -EINVAL: Invalid vcpu_index supplied



    =======  =====================================================

    -ENXIO   Getting or setting this register is not yet supported

    -EBUSY   One or more VCPUs are running

    -EINVAL  Invalid vcpu_index supplied

    =======  =====================================================



  KVM_DEV_ARM_VGIC_GRP_CPU_REGS

   Attributes:

    The attr field of kvm_device_attr encodes two values:



    The attr field of kvm_device_attr encodes two values::



      bits:     | 63   ....  40 | 39 ..  32  |  31   ....    0 |

      values:   |    reserved   | vcpu_index |      offset     |
@@ -101,27 +118,39 @@ Groups: 
    value left by 3 places to obtain the actual priority mask level.



  Errors:

    -ENXIO: Getting or setting this register is not yet supported

    -EBUSY: One or more VCPUs are running

    -EINVAL: Invalid vcpu_index supplied



    =======  =====================================================

    -ENXIO   Getting or setting this register is not yet supported

    -EBUSY   One or more VCPUs are running

    -EINVAL  Invalid vcpu_index supplied

    =======  =====================================================



  KVM_DEV_ARM_VGIC_GRP_NR_IRQS

   Attributes:



    A value describing the number of interrupts (SGI, PPI and SPI) for

    this GIC instance, ranging from 64 to 1024, in increments of 32.



  Errors:

    -EINVAL: Value set is out of the expected range

    -EBUSY: Value has already be set, or GIC has already been initialized



    =======  =============================================================

    -EINVAL  Value set is out of the expected range

    -EBUSY   Value has already be set, or GIC has already been initialized

             with default values.

    =======  =============================================================



  KVM_DEV_ARM_VGIC_GRP_CTRL

   Attributes:



    KVM_DEV_ARM_VGIC_CTRL_INIT

      request the initialization of the VGIC or ITS, no additional parameter

      in kvm_device_attr.addr.



  Errors:

    -ENXIO: VGIC not properly configured as required prior to calling



    =======  =========================================================

    -ENXIO   VGIC not properly configured as required prior to calling

             this attribute

    -ENODEV: no online VCPU

    -ENOMEM: memory shortage when allocating vgic internal data
 
    -ENODEV  no online VCPU

    -ENOMEM  memory shortage when allocating vgic internal data

    =======  =========================================================

Documentation/virt/kvm/devices/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -8,4 +8,5 @@ Devices 
   :maxdepth: 2



   arm-vgic-its

   arm-vgic

   arm-vgic-v3

CRA Git | Maintained and supported by SUSTech CRA and CCSE