KVM: s390: improve documentation for S390_MEM_OP
Subsystems (3)
PATCH 1/1 KVM: s390: improve documentation for S390_MEM_OP
Explicitly specify the valid ranges for size and ar, and reword buf requirements a bit.
---
supposed to go on top of "KVM: s390: Test for bad access register and size at the start of S390_MEM_OP" (<[email protected]>)
--- Documentation/virt/kvm/api.txt | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-)
Documentation/virt/kvm/api.txt +8 -6
@@ -3079,12 +3079,14 @@ This exception is also raised directly at the corresponding VCPU if the flag KVM_S390_MEMOP_F_INJECT_EXCEPTION is set in the "flags" field. The start address of the memory region has to be specified in the "gaddr" -field, and the length of the region in the "size" field. "buf" is the buffer -supplied by the userspace application where the read data should be written -to for KVM_S390_MEMOP_LOGICAL_READ, or where the data that should be written -is stored for a KVM_S390_MEMOP_LOGICAL_WRITE. "buf" is unused and can be NULL -when KVM_S390_MEMOP_F_CHECK_ONLY is specified. "ar" designates the access -register number to be used. +field, and the length of the region in the "size" field (which must not +be 0). The maximum value for "size" can be obtained by checking the +KVM_CAP_S390_MEM_OP capability. "buf" is the buffer supplied by the +userspace application where the read data should be written to for +KVM_S390_MEMOP_LOGICAL_READ, or where the data that should be written is +stored for a KVM_S390_MEMOP_LOGICAL_WRITE. When KVM_S390_MEMOP_F_CHECK_ONLY +is specified, "buf" is unused and can be NULL. "ar" designates the access +register number to be used; the valid range is 0..15. The "reserved" field is meant for future extensions. It is not used by KVM with the currently defined set of flags.
Signature · 1 line
2.20.1
Quoted 27 lines · Cornelia Huck
Explicitly specify the valid ranges for size and ar, and reword buf requirements a bit.
Signed-off-by Cornelia Huck <[email protected]>---
supposed to go on top of "KVM: s390: Test for bad access register and size at the start ofS390_MEM_OP" (<[email protected]>)--- Documentation/virt/kvm/api.txt | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-)Documentation/virt/kvm/api.txt +1
-6@@ -3079,12 +3079,14 @@ This exception is also raised directly at the corresponding VCPU if the flag KVM_S390_MEMOP_F_INJECT_EXCEPTION is set in the "flags" field. The start address of the memory region has to be specified in the "gaddr" -field, and the length of the region in the "size" field. "buf" is the buffer -supplied by the userspace application where the read data should be written -to for KVM_S390_MEMOP_LOGICAL_READ, or where the data that should be written -is stored for a KVM_S390_MEMOP_LOGICAL_WRITE. "buf" is unused and can be NULL -when KVM_S390_MEMOP_F_CHECK_ONLY is specified. "ar" designates the access -register number to be used. +field, and the length of the region in the "size" field (which must not
Documentation/virt/kvm/api.txt This exception is also raised directly at the corresponding VCPU if the · line 3092
Quoted 10 lines
Documentation/virt/kvm/api.txt +7
-0+be 0). The maximum value for "size" can be obtained by checking the +KVM_CAP_S390_MEM_OP capability. "buf" is the buffer supplied by the +userspace application where the read data should be written to for +KVM_S390_MEMOP_LOGICAL_READ, or where the data that should be written is +stored for a KVM_S390_MEMOP_LOGICAL_WRITE. When KVM_S390_MEMOP_F_CHECK_ONLY +is specified, "buf" is unused and can be NULL. "ar" designates the access +register number to be used; the valid range is 0..15. The "reserved" field is meant for future extensions. It is not used by KVM with the currently defined set of flags.
Christian Borntraeger
AppliedThanks applied.
Quoted 37 lines · Cornelia Huck
Explicitly specify the valid ranges for size and ar, and reword buf requirements a bit.
Signed-off-by Cornelia Huck <[email protected]>---
supposed to go on top of "KVM: s390: Test for bad access register and size at the start ofS390_MEM_OP" (<[email protected]>)--- Documentation/virt/kvm/api.txt | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-)Documentation/virt/kvm/api.txt +8
-6@@ -3079,12 +3079,14 @@ This exception is also raised directly at the corresponding VCPU if the flag KVM_S390_MEMOP_F_INJECT_EXCEPTION is set in the "flags" field. The start address of the memory region has to be specified in the "gaddr" -field, and the length of the region in the "size" field. "buf" is the buffer -supplied by the userspace application where the read data should be written -to for KVM_S390_MEMOP_LOGICAL_READ, or where the data that should be written -is stored for a KVM_S390_MEMOP_LOGICAL_WRITE. "buf" is unused and can be NULL -when KVM_S390_MEMOP_F_CHECK_ONLY is specified. "ar" designates the access -register number to be used. +field, and the length of the region in the "size" field (which must not +be 0). The maximum value for "size" can be obtained by checking the +KVM_CAP_S390_MEM_OP capability. "buf" is the buffer supplied by the +userspace application where the read data should be written to for +KVM_S390_MEMOP_LOGICAL_READ, or where the data that should be written is +stored for a KVM_S390_MEMOP_LOGICAL_WRITE. When KVM_S390_MEMOP_F_CHECK_ONLY +is specified, "buf" is unused and can be NULL. "ar" designates the access +register number to be used; the valid range is 0..15. The "reserved" field is meant for future extensions. It is not used by KVM with the currently defined set of flags.
Quoted 27 lines · Cornelia Huck
Explicitly specify the valid ranges for size and ar, and reword buf requirements a bit.
Signed-off-by Cornelia Huck <[email protected]>---
supposed to go on top of "KVM: s390: Test for bad access register and size at the start ofS390_MEM_OP" (<[email protected]>)--- Documentation/virt/kvm/api.txt | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-)Documentation/virt/kvm/api.txt +1
-6@@ -3079,12 +3079,14 @@ This exception is also raised directly at the corresponding VCPU if the flag KVM_S390_MEMOP_F_INJECT_EXCEPTION is set in the "flags" field. The start address of the memory region has to be specified in the "gaddr" -field, and the length of the region in the "size" field. "buf" is the buffer -supplied by the userspace application where the read data should be written -to for KVM_S390_MEMOP_LOGICAL_READ, or where the data that should be written -is stored for a KVM_S390_MEMOP_LOGICAL_WRITE. "buf" is unused and can be NULL -when KVM_S390_MEMOP_F_CHECK_ONLY is specified. "ar" designates the access -register number to be used. +field, and the length of the region in the "size" field (which must not
Documentation/virt/kvm/api.txt This exception is also raised directly at the corresponding VCPU if the · line 3092
Quoted 10 lines
Documentation/virt/kvm/api.txt +7
-0+be 0). The maximum value for "size" can be obtained by checking the +KVM_CAP_S390_MEM_OP capability. "buf" is the buffer supplied by the +userspace application where the read data should be written to for +KVM_S390_MEMOP_LOGICAL_READ, or where the data that should be written is +stored for a KVM_S390_MEMOP_LOGICAL_WRITE. When KVM_S390_MEMOP_F_CHECK_ONLY +is specified, "buf" is unused and can be NULL. "ar" designates the access +register number to be used; the valid range is 0..15. The "reserved" field is meant for future extensions. It is not used by KVM with the currently defined set of flags.
Signature · 3 lines
Thanks, David / dhildenb