Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 952105ab authored by Pavel Fedin's avatar Pavel Fedin Committed by Christoffer Dall
Browse files

KVM: arm/arm64: Fix vGIC documentation 



Correct some old mistakes in the API documentation:

1. VCPU is identified by index (using kvm_get_vcpu() function), but
   "cpu id" can be mistaken for affinity ID.
2. Some error codes are wrong.

  [ Slightly tweaked some grammer and did some s/CPU index/vcpu_index/
    in the descriptions.  -Christoffer ]

Signed-off-by: default avatarPavel Fedin <p.fedin@samsung.com>
Signed-off-by: default avatarChristoffer Dall <christoffer.dall@linaro.org>
parent 3b92830a

Documentation/virtual/kvm/devices/arm-vgic.txt

+10 −8
Original line number Diff line number Diff line
@@ -44,28 +44,29 @@ Groups: 
  Attributes:

    The attr field of kvm_device_attr encodes two values:

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

    values:   |    reserved   |   cpu id   |      offset     |

    values:   |    reserved   | vcpu_index |      offset     |



    All distributor regs are (rw, 32-bit)



    The offset is relative to the "Distributor base address" as defined in the

    GICv2 specs.  Getting or setting such a register has the same effect as

    reading or writing the register on the actual hardware from the cpu

    specified with cpu id field.  Note that most distributor fields are not

    banked, but return the same value regardless of the cpu id used to access

    the register.

    reading or writing the register on the actual hardware from the cpu whose

    index is specified with the vcpu_index field.  Note that most distributor

    fields are not banked, but return the same value regardless of the

    vcpu_index used to access the register.

  Limitations:

    - Priorities are not implemented, and registers are RAZ/WI

    - Currently only implemented for KVM_DEV_TYPE_ARM_VGIC_V2.

  Errors:

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

    -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:

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

    values:   |    reserved   |   cpu id   |      offset     |

    values:   |    reserved   | vcpu_index |      offset     |



    All CPU interface regs are (rw, 32-bit)
@@ -91,8 +92,9 @@ Groups: 
    - Priorities are not implemented, and registers are RAZ/WI

    - Currently only implemented for KVM_DEV_TYPE_ARM_VGIC_V2.

  Errors:

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

    -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: