OrgACRN
/
acrn-kernel
mirror of https://github.com/projectacrn/acrn-kernel.git
1
0
Fork 0
Code Issues Releases Wiki Activity

s390/docs: fix warnings for vfio_ap driver lock usage doc 

Fix multiple warnings produced by make htmldocs

Fixes: e32d3827f3 ("s390/Docs: new doc describing lock usage by the vfio_ap device driver")
Signed-off-by: Alexander Gordeev <agordeev@linux.ibm.com>
This commit is contained in:
Alexander Gordeev 2022-07-21 15:29:05 +02:00
parent 5fcd0d8ae2
commit d384690c6a
2 changed files with 40 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Documentation/s390/index.rst
View File

@ -12,6 +12,7 @@ s390 Architecture
qeth qeth
s390dbf s390dbf
vfio-ap vfio-ap
vfio-ap-locking
vfio-ccw vfio-ccw
zfcpdump zfcpdump
common_io common_io

14
Documentation/s390/vfio-ap-locking.rst
View File

@ -7,12 +7,16 @@ This document describes the locks that are pertinent to the secure operation
of the vfio_ap device driver. Throughout this document, the following variables of the vfio_ap device driver. Throughout this document, the following variables
will be used to denote instances of the structures herein described: will be used to denote instances of the structures herein described:
.. code-block:: c
struct ap_matrix_dev *matrix_dev; struct ap_matrix_dev *matrix_dev;
struct ap_matrix_mdev *matrix_mdev; struct ap_matrix_mdev *matrix_mdev;
struct kvm *kvm; struct kvm *kvm;
The Matrix Devices Lock (drivers/s390/crypto/vfio_ap_private.h) The Matrix Devices Lock (drivers/s390/crypto/vfio_ap_private.h)
-------------------------------------------------------------- ---------------------------------------------------------------
.. code-block:: c
struct ap_matrix_dev { struct ap_matrix_dev {
... ...
@ -31,6 +35,8 @@ representing one of the vfio_ap device driver's mediated devices.
The KVM Lock (include/linux/kvm_host.h) The KVM Lock (include/linux/kvm_host.h)
--------------------------------------- ---------------------------------------
.. code-block:: c
struct kvm { struct kvm {
... ...
struct mutex lock; struct mutex lock;
@ -48,6 +54,8 @@ been attached to the KVM guest.
The Guests Lock (drivers/s390/crypto/vfio_ap_private.h) The Guests Lock (drivers/s390/crypto/vfio_ap_private.h)
----------------------------------------------------------- -----------------------------------------------------------
.. code-block:: c
struct ap_matrix_dev { struct ap_matrix_dev {
... ...
struct list_head mdev_list; struct list_head mdev_list;
@ -89,6 +97,8 @@ resources, so only the matrix_dev->mdevs_lock needs to be held.
The PQAP Hook Lock (arch/s390/include/asm/kvm_host.h) The PQAP Hook Lock (arch/s390/include/asm/kvm_host.h)
----------------------------------------------------- -----------------------------------------------------
.. code-block:: c
typedef int (*crypto_hook)(struct kvm_vcpu *vcpu); typedef int (*crypto_hook)(struct kvm_vcpu *vcpu);
struct kvm_s390_crypto { struct kvm_s390_crypto {
@ -99,7 +109,7 @@ struct kvm_s390_crypto {
}; };
The PQAP Hook Lock is a r/w semaphore that controls access to the function The PQAP Hook Lock is a r/w semaphore that controls access to the function
pointer of the handler (*kvm->arch.crypto.pqap_hook) to invoke when the pointer of the handler ``(*kvm->arch.crypto.pqap_hook)`` to invoke when the
PQAP(AQIC) instruction sub-function is intercepted by the host. The lock must be PQAP(AQIC) instruction sub-function is intercepted by the host. The lock must be
held in write mode when pqap_hook value is set, and in read mode when the held in write mode when pqap_hook value is set, and in read mode when the
pqap_hook function is called. pqap_hook function is called.