Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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 <mchehab+huawei@kernel.org>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>

authored by

Mauro Carvalho Chehab and committed by
Paolo Bonzini
cec0e48b 69bf758b

+32 -15
+1
Documentation/virt/kvm/arm/index.rst
··· 8 8 :maxdepth: 2 9 9 10 10 hyp-abi 11 + psci 11 12 pvtime
+31 -15
Documentation/virt/kvm/arm/psci.txt Documentation/virt/kvm/arm/psci.rst
··· 1 + .. SPDX-License-Identifier: GPL-2.0 2 + 3 + ========================================= 4 + Power State Coordination Interface (PSCI) 5 + ========================================= 6 + 1 7 KVM implements the PSCI (Power State Coordination Interface) 2 8 specification in order to provide services such as CPU on/off, reset 3 9 and power-off to the guest. ··· 36 30 - Affects the whole VM (even if the register view is per-vcpu) 37 31 38 32 * KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_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]. 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]. 36 + 42 37 Accepted values are: 43 - KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_NOT_AVAIL: KVM does not offer 38 + 39 + KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_NOT_AVAIL: 40 + KVM does not offer 44 41 firmware support for the workaround. The mitigation status for the 45 42 guest is unknown. 46 - KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_AVAIL: The workaround HVC call is 43 + KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_AVAIL: 44 + The workaround HVC call is 47 45 available to the guest and required for the mitigation. 48 - KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_NOT_REQUIRED: The workaround HVC call 46 + KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_NOT_REQUIRED: 47 + The workaround HVC call 49 48 is available to the guest, but it is not needed on this VCPU. 50 49 51 50 * KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2: 52 - Holds the state of the firmware support to mitigate CVE-2018-3639, as 53 - offered by KVM to the guest via a HVC call. The workaround is described 54 - under SMCCC_ARCH_WORKAROUND_2 in [1]. 51 + Holds the state of the firmware support to mitigate CVE-2018-3639, as 52 + offered by KVM to the guest via a HVC call. The workaround is described 53 + under SMCCC_ARCH_WORKAROUND_2 in [1]_. 54 + 55 55 Accepted values are: 56 - KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_NOT_AVAIL: A workaround is not 56 + 57 + KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_NOT_AVAIL: 58 + A workaround is not 57 59 available. KVM does not offer firmware support for the workaround. 58 - KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_UNKNOWN: The workaround state is 60 + KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_UNKNOWN: 61 + The workaround state is 59 62 unknown. KVM does not offer firmware support for the workaround. 60 - KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_AVAIL: The workaround is available, 63 + KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_AVAIL: 64 + The workaround is available, 61 65 and can be disabled by a vCPU. If 62 66 KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_ENABLED is set, it is active for 63 67 this vCPU. 64 - KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_NOT_REQUIRED: The workaround is 65 - always active on this vCPU or it is not needed. 68 + KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_NOT_REQUIRED: 69 + The workaround is always active on this vCPU or it is not needed. 66 70 67 - [1] https://developer.arm.com/-/media/developer/pdf/ARM_DEN_0070A_Firmware_interfaces_for_mitigating_CVE-2017-5715.pdf 71 + .. [1] https://developer.arm.com/-/media/developer/pdf/ARM_DEN_0070A_Firmware_interfaces_for_mitigating_CVE-2017-5715.pdf