[v5,4/4] KVM: Add documentation for KVM_ARM_PREFERRED_TARGET ioctl

Message ID 1380531008-15901-5-git-send-email-anup.patel@linaro.org
State New
Headers show

Commit Message

Anup Patel Sept. 30, 2013, 8:50 a.m.
To implement CPU=Host we have added KVM_ARM_PREFERRED_TARGET
vm ioctl which provides information to user space required for
creating VCPU matching underlying Host.

This patch adds info related to this new KVM_ARM_PREFERRED_TARGET
vm ioctl in the KVM API documentation.

Signed-off-by: Anup Patel <anup.patel@linaro.org>
Signed-off-by: Pranavkumar Sawargaonkar <pranavkumar@linaro.org>
 Documentation/virtual/kvm/api.txt |   31 +++++++++++++++++++++++++++----
 1 file changed, 27 insertions(+), 4 deletions(-)


diff --git a/Documentation/virtual/kvm/api.txt b/Documentation/virtual/kvm/api.txt
index 858aecf..076b849 100644
--- a/Documentation/virtual/kvm/api.txt
+++ b/Documentation/virtual/kvm/api.txt
@@ -2304,7 +2304,31 @@  Possible features:
 	  Depends on KVM_CAP_ARM_EL1_32BIT (arm64 only).
+Capability: basic
+Architectures: arm, arm64
+Type: vm ioctl
+Parameters: struct struct kvm_vcpu_init (out)
+Returns: 0 on success; -1 on error
+  ENODEV:    no preferred target available for the host
+This queries KVM for preferred CPU target type which can be emulated
+by KVM on underlying host.
+The ioctl returns struct kvm_vcpu_init instance containing information
+about preferred CPU target type and recommended features for it.  The
+kvm_vcpu_init->features bitmap returned will have feature bits set if
+the preferred target recommends setting these features, but this is
+not mandatory.
+The information returned by this ioctl can be used to prepare an instance
+of struct kvm_vcpu_init for KVM_ARM_VCPU_INIT ioctl which will result in
+in VCPU matching underlying host.
 Capability: basic
 Architectures: arm, arm64
@@ -2323,8 +2347,7 @@  struct kvm_reg_list {
 This ioctl returns the guest registers that are supported for the
 Architectures: arm, arm64
@@ -2362,7 +2385,7 @@  must be called after calling KVM_CREATE_IRQCHIP, but before calling
 KVM_RUN on any of the VCPUs.  Calling this ioctl twice for any of the
 base addresses will return -EEXIST.
 Capability: KVM_CAP_PPC_RTAS
 Architectures: ppc