From: Paolo Bonzini <pbonzini@redhat.com>
Date: Fri, 20 May 2022 11:22:46 +0000 (-0400)
Subject: Documentation: kvm: reorder ARM-specific section about KVM_SYSTEM_EVENT_SUSPEND
X-Git-Tag: v6.6.17~7255^2~33
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=186af6bb40c4fd2048bb81253c1109d8b3011e42;p=platform%2Fkernel%2Flinux-rpi.git

Documentation: kvm: reorder ARM-specific section about KVM_SYSTEM_EVENT_SUSPEND

Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index d10d408..28b547a 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -6176,32 +6176,6 @@ Valid values for 'type' are:
  - KVM_SYSTEM_EVENT_SUSPEND -- the guest has requested a suspension of
    the VM.
 
-For arm/arm64:
---------------
-
-   KVM_SYSTEM_EVENT_SUSPEND exits are enabled with the
-   KVM_CAP_ARM_SYSTEM_SUSPEND VM capability. If a guest invokes the PSCI
-   SYSTEM_SUSPEND function, KVM will exit to userspace with this event
-   type.
-
-   It is the sole responsibility of userspace to implement the PSCI
-   SYSTEM_SUSPEND call according to ARM DEN0022D.b 5.19 "SYSTEM_SUSPEND".
-   KVM does not change the vCPU's state before exiting to userspace, so
-   the call parameters are left in-place in the vCPU registers.
-
-   Userspace is _required_ to take action for such an exit. It must
-   either:
-
-    - Honor the guest request to suspend the VM. Userspace can request
-      in-kernel emulation of suspension by setting the calling vCPU's
-      state to KVM_MP_STATE_SUSPENDED. Userspace must configure the vCPU's
-      state according to the parameters passed to the PSCI function when
-      the calling vCPU is resumed. See ARM DEN0022D.b 5.19.1 "Intended use"
-      for details on the function parameters.
-
-    - Deny the guest request to suspend the VM. See ARM DEN0022D.b 5.19.2
-      "Caller responsibilities" for possible return values.
-
 If KVM_CAP_SYSTEM_EVENT_DATA is present, the 'data' field can contain
 architecture specific information for the system-level event.  Only
 the first `ndata` items (possibly zero) of the data array are valid.
@@ -6217,6 +6191,32 @@ Previous versions of Linux defined a `flags` member in this struct.  The
 field is now aliased to `data[0]`.  Userspace can assume that it is only
 written if ndata is greater than 0.
 
+For arm/arm64:
+--------------
+
+KVM_SYSTEM_EVENT_SUSPEND exits are enabled with the
+KVM_CAP_ARM_SYSTEM_SUSPEND VM capability. If a guest invokes the PSCI
+SYSTEM_SUSPEND function, KVM will exit to userspace with this event
+type.
+
+It is the sole responsibility of userspace to implement the PSCI
+SYSTEM_SUSPEND call according to ARM DEN0022D.b 5.19 "SYSTEM_SUSPEND".
+KVM does not change the vCPU's state before exiting to userspace, so
+the call parameters are left in-place in the vCPU registers.
+
+Userspace is _required_ to take action for such an exit. It must
+either:
+
+ - Honor the guest request to suspend the VM. Userspace can request
+   in-kernel emulation of suspension by setting the calling vCPU's
+   state to KVM_MP_STATE_SUSPENDED. Userspace must configure the vCPU's
+   state according to the parameters passed to the PSCI function when
+   the calling vCPU is resumed. See ARM DEN0022D.b 5.19.1 "Intended use"
+   for details on the function parameters.
+
+ - Deny the guest request to suspend the VM. See ARM DEN0022D.b 5.19.2
+   "Caller responsibilities" for possible return values.
+
 ::
 
 		/* KVM_EXIT_IOAPIC_EOI */