Commit cec0e48b authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Paolo Bonzini
Browse files

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: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: default avatarPaolo Bonzini <pbonzini@redhat.com>
parent 69bf758b

Documentation/virt/kvm/arm/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -8,4 +8,5 @@ ARM 
   :maxdepth: 2



   hyp-abi

   psci

   pvtime

Documentation/virt/kvm/arm/psci.txt→Documentation/virt/kvm/arm/psci.rst

+31 −15
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



=========================================

Power State Coordination Interface (PSCI)

=========================================



KVM implements the PSCI (Power State Coordination Interface)

specification in order to provide services such as CPU on/off, reset

and power-off to the guest.
@@ -33,29 +39,39 @@ The following register is defined: 
    Holds the state of the firmware support to mitigate CVE-2017-5715, as

    offered by KVM to the guest via a HVC call. The workaround is described

    under SMCCC_ARCH_WORKAROUND_1 in [1].



  Accepted values are:

    KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_NOT_AVAIL: KVM does not offer



    KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_NOT_AVAIL:

      KVM does not offer

      firmware support for the workaround. The mitigation status for the

      guest is unknown.

    KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_AVAIL: The workaround HVC call is

    KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_AVAIL:

      The workaround HVC call is

      available to the guest and required for the mitigation.

    KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_NOT_REQUIRED: The workaround HVC call

    KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_1_NOT_REQUIRED:

      The workaround HVC call

      is available to the guest, but it is not needed on this VCPU.



* KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2:

    Holds the state of the firmware support to mitigate CVE-2018-3639, as

    offered by KVM to the guest via a HVC call. The workaround is described

  under SMCCC_ARCH_WORKAROUND_2 in [1].

    under SMCCC_ARCH_WORKAROUND_2 in [1]_.



  Accepted values are:

    KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_NOT_AVAIL: A workaround is not



    KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_NOT_AVAIL:

      A workaround is not

      available. KVM does not offer firmware support for the workaround.

    KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_UNKNOWN: The workaround state is

    KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_UNKNOWN:

      The workaround state is

      unknown. KVM does not offer firmware support for the workaround.

    KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_AVAIL: The workaround is available,

    KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_AVAIL:

      The workaround is available,

      and can be disabled by a vCPU. If

      KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_ENABLED is set, it is active for

      this vCPU.

    KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_NOT_REQUIRED: The workaround is

      always active on this vCPU or it is not needed.

    KVM_REG_ARM_SMCCC_ARCH_WORKAROUND_2_NOT_REQUIRED:

      The workaround is always active on this vCPU or it is not needed.



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

CRA Git | Maintained and supported by SUSTech CRA and CCSE