Skip to contentSkip to conversation

s390: Add API Docs for DIAGNOSE 0x318 and fix rst

PATCH Applied Collin Walling 3 participants 5 messages Jun 25, 2020 – Jun 26, 2020

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

v2 cover s390: Add API Docs for DIAGNOSE 0x318 and fix rst

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.

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(-)
Signature · 1 line
2.26.2
#1 lore raw

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

Documentation for the s390 DIAGNOSE 0x318 instruction handling.

---
 Documentation/virt/kvm/api.rst | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
Documentation/virt/kvm/api.rst +20 -0
index 426f94582b7a..e0b4f2088c46 100644
@@ -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).
Signature · 1 line
2.26.2
#2 lore raw

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

Quoted 8 lines · On Thu, 25 Jun 2020 11:07:23 -0400 Collin Walling <[email protected]> wrote:

Documentation for the s390 DIAGNOSE 0x318 instruction handling.

---
 Documentation/virt/kvm/api.rst | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

Still looks good to me.

#3 lore raw

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

In reply to 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")

---
 Documentation/virt/kvm/api.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
Documentation/virt/kvm/api.rst +4 -3
index e0b4f2088c46..19681e96eb33 100644
@@ -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.
Signature · 1 line
2.26.2
#4 lore raw
In reply to Collin Walling
Quoted 6 lines · Collin Walling

Changelog:

v2

• Reworded patch 1 doc text

Quoted 8 lines

• 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.

thanks, applied

Quoted 8 lines

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(-)