Commit d384690c authored by Alexander Gordeev's avatar Alexander Gordeev
Browse files

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



Fix multiple warnings produced by make htmldocs

Fixes: e32d3827 ("s390/Docs: new doc describing lock usage by the vfio_ap device driver")
Signed-off-by: default avatarAlexander Gordeev <agordeev@linux.ibm.com>
parent 5fcd0d8a

Documentation/s390/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -12,6 +12,7 @@ s390 Architecture 
    qeth

    s390dbf

    vfio-ap

    vfio-ap-locking

    vfio-ccw

    zfcpdump

    common_io

Documentation/s390/vfio-ap-locking.rst

+39 −29
Original line number Diff line number Diff line
@@ -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

will be used to denote instances of the structures herein described:



.. code-block:: c



  struct ap_matrix_dev *matrix_dev;

  struct ap_matrix_mdev *matrix_mdev;

  struct kvm *kvm;



The Matrix Devices Lock (drivers/s390/crypto/vfio_ap_private.h)

--------------------------------------------------------------

---------------------------------------------------------------



.. code-block:: c



  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)

---------------------------------------



.. code-block:: c



  struct kvm {

  	...

  	struct mutex lock;
@@ -48,6 +54,8 @@ been attached to the KVM guest. 
The Guests Lock (drivers/s390/crypto/vfio_ap_private.h)

-----------------------------------------------------------



.. code-block:: c



  struct ap_matrix_dev {

  	...

  	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)

-----------------------------------------------------



.. code-block:: c



  typedef int (*crypto_hook)(struct kvm_vcpu *vcpu);



  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

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

held in write mode when pqap_hook value is set, and in read mode when the

pqap_hook function is called.