[PATCH v2 0/2] s390: Add API Docs for DIAGNOSE 0x318 and fix rst

[PATCH v2 0/2] s390: Add API Docs for DIAGNOSE 0x318 and fix rst

[Collin Walling]

Changelog:

    v2

    • Reworded patch 1 doc text

    • Added "Introduced in commit..." for rst fix patch

    • Added r-b's (thanks!)

Adds documentation for the s390-specfic DIAGNOSE 0x318 instruction, as
well as fixes some missing rst symbols for the neighboring entries.

Suggested-by: Cornelia Huck <cohuck@redhat.com>

Collin Walling (2):
  docs: kvm: add documentation for KVM_CAP_S390_DIAG318
  docs: kvm: fix rst formatting

 Documentation/virt/kvm/api.rst | 27 ++++++++++++++++++++++++---
 1 file changed, 24 insertions(+), 3 deletions(-)

-- 
2.26.2

[PATCH v2 1/2] docs: kvm: add documentation for KVM_CAP_S390_DIAG318

[Collin Walling]

Documentation for the s390 DIAGNOSE 0x318 instruction handling.

Signed-off-by: Collin Walling <walling@linux.ibm.com>
Reviewed-by: Cornelia Huck <cohuck@redhat.com>
Reviewed-by: David Hildenbrand <david@redhat.com>
---
 Documentation/virt/kvm/api.rst | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index 426f94582b7a..e0b4f2088c46 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -6150,3 +6150,23 @@ KVM can therefore start protected VMs.
 This capability governs the KVM_S390_PV_COMMAND ioctl and the
 KVM_MP_STATE_LOAD MP_STATE. KVM_SET_MP_STATE can fail for protected
 guests when the state change is invalid.
+
+8.24 KVM_CAP_S390_DIAG318
+-------------------------
+
+:Architecture: s390
+
+This capability enables a guest to set information about its control program
+(i.e. guest kernel type and version). The information is helpful during
+system/firmware service events, providing additional data about the guest
+environments running on the machine.
+
+The information is associated with the DIAGNOSE 0x318 instruction, which sets
+an 8-byte value consisting of a one-byte Control Program Name Code (CPNC) and
+a 7-byte Control Program Version Code (CPVC). The CPNC determines what
+environment the control program is running in (e.g. Linux, z/VM...), and the
+CPVC is used for information specific to OS (e.g. Linux version, Linux
+distribution...)
+
+If this capability is available, then the CPNC and CPVC can be synchronized
+between KVM and userspace via the sync regs mechanism (KVM_SYNC_DIAG318).
-- 
2.26.2

Re: [PATCH v2 1/2] docs: kvm: add documentation for KVM_CAP_S390_DIAG318

[Cornelia Huck]

On Thu, 25 Jun 2020 11:07:23 -0400
Collin Walling <walling@linux.ibm.com> wrote:

> Documentation for the s390 DIAGNOSE 0x318 instruction handling.
> 
> Signed-off-by: Collin Walling <walling@linux.ibm.com>
> Reviewed-by: Cornelia Huck <cohuck@redhat.com>
> Reviewed-by: David Hildenbrand <david@redhat.com>
> ---
>  Documentation/virt/kvm/api.rst | 20 ++++++++++++++++++++
>  1 file changed, 20 insertions(+)

Still looks good to me.

[PATCH v2 2/2] docs: kvm: fix rst formatting

[Collin Walling]

Add a little rst touch-up for docs introduced in:
 - commit 7de3f1423ff9 ("KVM: s390: Add new reset vcpu API") and
 - commit 04ed89dc4aeb ("KVM: s390: protvirt: Add KVM api documentation")

Signed-off-by: Collin Walling <walling@linux.ibm.com>
Reviewed-by: Cornelia Huck <cohuck@redhat.com>
Reviewed-by: David Hildenbrand <david@redhat.com>
---
 Documentation/virt/kvm/api.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index e0b4f2088c46..19681e96eb33 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -6134,16 +6134,17 @@ in CPUID and only exposes Hyper-V identification. In this case, guest
 thinks it's running on Hyper-V and only use Hyper-V hypercalls.
 
 8.22 KVM_CAP_S390_VCPU_RESETS
+-----------------------------
 
-Architectures: s390
+:Architectures: s390
 
 This capability indicates that the KVM_S390_NORMAL_RESET and
 KVM_S390_CLEAR_RESET ioctls are available.
 
 8.23 KVM_CAP_S390_PROTECTED
+---------------------------
 
-Architecture: s390
-
+:Architecture: s390
 
 This capability indicates that the Ultravisor has been initialized and
 KVM can therefore start protected VMs.
-- 
2.26.2

Re: [PATCH v2 0/2] s390: Add API Docs for DIAGNOSE 0x318 and fix rst

[Janosch Frank]

[-- Attachment #1.1: Type: text/plain, Size: 693 bytes --]

On 6/25/20 5:07 PM, Collin Walling wrote:
> Changelog:
> 
>     v2
> 
>     • Reworded patch 1 doc text
> 
>     • Added "Introduced in commit..." for rst fix patch
> 
>     • Added r-b's (thanks!)
> 
> Adds documentation for the s390-specfic DIAGNOSE 0x318 instruction, as
> well as fixes some missing rst symbols for the neighboring entries.
> 
> Suggested-by: Cornelia Huck <cohuck@redhat.com>

thanks, applied

> 
> Collin Walling (2):
>   docs: kvm: add documentation for KVM_CAP_S390_DIAG318
>   docs: kvm: fix rst formatting
> 
>  Documentation/virt/kvm/api.rst | 27 ++++++++++++++++++++++++---
>  1 file changed, 24 insertions(+), 3 deletions(-)
> 



[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]