Skip to content

Commit 186af6b

Browse files
committed
Documentation: kvm: reorder ARM-specific section about KVM_SYSTEM_EVENT_SUSPEND
Signed-off-by: Paolo Bonzini <[email protected]>
1 parent baec4f5 commit 186af6b

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

Documentation/virt/kvm/api.rst

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6176,32 +6176,6 @@ Valid values for 'type' are:
61766176
- KVM_SYSTEM_EVENT_SUSPEND -- the guest has requested a suspension of
61776177
the VM.
61786178

6179-
For arm/arm64:
6180-
--------------
6181-
6182-
KVM_SYSTEM_EVENT_SUSPEND exits are enabled with the
6183-
KVM_CAP_ARM_SYSTEM_SUSPEND VM capability. If a guest invokes the PSCI
6184-
SYSTEM_SUSPEND function, KVM will exit to userspace with this event
6185-
type.
6186-
6187-
It is the sole responsibility of userspace to implement the PSCI
6188-
SYSTEM_SUSPEND call according to ARM DEN0022D.b 5.19 "SYSTEM_SUSPEND".
6189-
KVM does not change the vCPU's state before exiting to userspace, so
6190-
the call parameters are left in-place in the vCPU registers.
6191-
6192-
Userspace is _required_ to take action for such an exit. It must
6193-
either:
6194-
6195-
- Honor the guest request to suspend the VM. Userspace can request
6196-
in-kernel emulation of suspension by setting the calling vCPU's
6197-
state to KVM_MP_STATE_SUSPENDED. Userspace must configure the vCPU's
6198-
state according to the parameters passed to the PSCI function when
6199-
the calling vCPU is resumed. See ARM DEN0022D.b 5.19.1 "Intended use"
6200-
for details on the function parameters.
6201-
6202-
- Deny the guest request to suspend the VM. See ARM DEN0022D.b 5.19.2
6203-
"Caller responsibilities" for possible return values.
6204-
62056179
If KVM_CAP_SYSTEM_EVENT_DATA is present, the 'data' field can contain
62066180
architecture specific information for the system-level event. Only
62076181
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
62176191
field is now aliased to `data[0]`. Userspace can assume that it is only
62186192
written if ndata is greater than 0.
62196193

6194+
For arm/arm64:
6195+
--------------
6196+
6197+
KVM_SYSTEM_EVENT_SUSPEND exits are enabled with the
6198+
KVM_CAP_ARM_SYSTEM_SUSPEND VM capability. If a guest invokes the PSCI
6199+
SYSTEM_SUSPEND function, KVM will exit to userspace with this event
6200+
type.
6201+
6202+
It is the sole responsibility of userspace to implement the PSCI
6203+
SYSTEM_SUSPEND call according to ARM DEN0022D.b 5.19 "SYSTEM_SUSPEND".
6204+
KVM does not change the vCPU's state before exiting to userspace, so
6205+
the call parameters are left in-place in the vCPU registers.
6206+
6207+
Userspace is _required_ to take action for such an exit. It must
6208+
either:
6209+
6210+
- Honor the guest request to suspend the VM. Userspace can request
6211+
in-kernel emulation of suspension by setting the calling vCPU's
6212+
state to KVM_MP_STATE_SUSPENDED. Userspace must configure the vCPU's
6213+
state according to the parameters passed to the PSCI function when
6214+
the calling vCPU is resumed. See ARM DEN0022D.b 5.19.1 "Intended use"
6215+
for details on the function parameters.
6216+
6217+
- Deny the guest request to suspend the VM. See ARM DEN0022D.b 5.19.2
6218+
"Caller responsibilities" for possible return values.
6219+
62206220
::
62216221

62226222
/* KVM_EXIT_IOAPIC_EOI */

0 commit comments

Comments
 (0)