Skip to content

Commit cec0e48

Browse files
mchehabbonzini
authored andcommitted
docs: kvm: arm/psci.txt: convert to ReST
- Add a title for the document; - Adjust whitespaces for it to be properly formatted after parsed. Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Paolo Bonzini <[email protected]>
1 parent 69bf758 commit cec0e48

File tree

2 files changed

+32
-15
lines changed

2 files changed

+32
-15
lines changed

Documentation/virt/kvm/arm/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,5 @@ ARM
88
:maxdepth: 2
99

1010
hyp-abi
11+
psci
1112
pvtime

Documentation/virt/kvm/arm/psci.txt renamed to Documentation/virt/kvm/arm/psci.rst

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
=========================================
4+
Power State Coordination Interface (PSCI)
5+
=========================================
6+
17
KVM implements the PSCI (Power State Coordination Interface)
28
specification in order to provide services such as CPU on/off, reset
39
and power-off to the guest.
@@ -30,32 +36,42 @@ The following register is defined:
3036
- Affects the whole VM (even if the register view is per-vcpu)
3137

3238
* KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1:
33-
Holds the state of the firmware support to mitigate CVE-2017-5715, as
34-
offered by KVM to the guest via a HVC call. The workaround is described
35-
under SMCCC_ARCH_WORKAROUND_1 in [1].
39+
Holds the state of the firmware support to mitigate CVE-2017-5715, as
40+
offered by KVM to the guest via a HVC call. The workaround is described
41+
under SMCCC_ARCH_WORKAROUND_1 in [1].
42+
3643
Accepted values are:
37-
KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_NOT_AVAIL: KVM does not offer
44+
45+
KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_NOT_AVAIL:
46+
KVM does not offer
3847
firmware support for the workaround. The mitigation status for the
3948
guest is unknown.
40-
KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_AVAIL: The workaround HVC call is
49+
KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_AVAIL:
50+
The workaround HVC call is
4151
available to the guest and required for the mitigation.
42-
KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_NOT_REQUIRED: The workaround HVC call
52+
KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_NOT_REQUIRED:
53+
The workaround HVC call
4354
is available to the guest, but it is not needed on this VCPU.
4455

4556
* KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2:
46-
Holds the state of the firmware support to mitigate CVE-2018-3639, as
47-
offered by KVM to the guest via a HVC call. The workaround is described
48-
under SMCCC_ARCH_WORKAROUND_2 in [1].
57+
Holds the state of the firmware support to mitigate CVE-2018-3639, as
58+
offered by KVM to the guest via a HVC call. The workaround is described
59+
under SMCCC_ARCH_WORKAROUND_2 in [1]_.
60+
4961
Accepted values are:
50-
KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_NOT_AVAIL: A workaround is not
62+
63+
KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_NOT_AVAIL:
64+
A workaround is not
5165
available. KVM does not offer firmware support for the workaround.
52-
KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_UNKNOWN: The workaround state is
66+
KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_UNKNOWN:
67+
The workaround state is
5368
unknown. KVM does not offer firmware support for the workaround.
54-
KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_AVAIL: The workaround is available,
69+
KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_AVAIL:
70+
The workaround is available,
5571
and can be disabled by a vCPU. If
5672
KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_ENABLED is set, it is active for
5773
this vCPU.
58-
KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_NOT_REQUIRED: The workaround is
59-
always active on this vCPU or it is not needed.
74+
KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_NOT_REQUIRED:
75+
The workaround is always active on this vCPU or it is not needed.
6076

61-
[1] https://developer.arm.com/-/media/developer/pdf/ARM_DEN_0070A_Firmware_interfaces_for_mitigating_CVE-2017-5715.pdf
77+
.. [1] https://developer.arm.com/-/media/developer/pdf/ARM_DEN_0070A_Firmware_interfaces_for_mitigating_CVE-2017-5715.pdf

0 commit comments

Comments
 (0)