s390/vfio-ap: s390/crypto: fix all kernel-doc warnings (5ef4f710) · Commits · EulixOS / Software / Kernel

drivers/s390/crypto/vfio_ap_drv.c

+10 −6

Original line number	Diff line number	Diff line
		@@ -42,10 +42,13 @@ static struct ap_device_id ap_queue_ids[] = {
		MODULE_DEVICE_TABLE(vfio_ap, ap_queue_ids);

		/**
		* vfio_ap_queue_dev_probe:
		*
		* Allocate a vfio_ap_queue structure and associate it
		* vfio_ap_queue_dev_probe: Allocate a vfio_ap_queue structure and associate it
		* with the device as driver_data.
		*
		* @apdev: the AP device being probed
		*
		* Return: returns 0 if the probe succeeded; otherwise, returns -ENOMEM if
		* storage could not be allocated for a vfio_ap_queue object.
		*/
		static int vfio_ap_queue_dev_probe(struct ap_device *apdev)
		{
		@@ -61,10 +64,11 @@ static int vfio_ap_queue_dev_probe(struct ap_device *apdev)
		}

		/**
		* vfio_ap_queue_dev_remove:
		* vfio_ap_queue_dev_remove: Free the associated vfio_ap_queue structure.
		*
		* @apdev: the AP device being removed
		*
		* Takes the matrix lock to avoid actions on this device while removing
		* Free the associated vfio_ap_queue structure
		* Takes the matrix lock to avoid actions on this device while doing the remove.
		*/
		static void vfio_ap_queue_dev_remove(struct ap_device *apdev)
		{

drivers/s390/crypto/vfio_ap_ops.c

+3 −2

Original line number	Diff line number	Diff line
		@@ -187,6 +187,8 @@ static struct ap_queue_status vfio_ap_irq_disable(struct vfio_ap_queue *q)
		* vfio_ap_irq_enable - Enable Interruption for a APQN
		*
		* @q: the vfio_ap_queue holding AQIC parameters
		* @isc: the guest ISC to register with the GIB interface
		* @nib: the notification indicator byte to pin.
		*
		* Pin the NIB saved in *q
		* Register the guest ISC to GIB interface and retrieve the
		@@ -738,7 +740,6 @@ vfio_ap_mdev_verify_queues_reserved_for_apqi(struct ap_matrix_mdev *matrix_mdev,
		* assign_domain_store - parses the APQI from @buf and sets the
		* corresponding bit in the mediated matrix device's AQM
		*
		*
		* @dev: the matrix device
		* @attr: the mediated matrix device's assign_domain attribute
		* @buf: a buffer containing the AP queue index (APQI) of the domain to
		@@ -866,7 +867,6 @@ static DEVICE_ATTR_WO(unassign_domain);
		* assign_control_domain_store - parses the domain ID from @buf and sets
		* the corresponding bit in the mediated matrix device's ADM
		*
		*
		* @dev: the matrix device
		* @attr: the mediated matrix device's assign_control_domain attribute
		* @buf: a buffer containing the domain ID to be assigned
		@@ -1142,6 +1142,7 @@ static int vfio_ap_mdev_iommu_notifier(struct notifier_block *nb,
		* by @matrix_mdev.
		*
		* @matrix_mdev: a matrix mediated device
		* @kvm: the pointer to the kvm structure being unset.
		*
		* Note: The matrix_dev->lock must be taken prior to calling
		* this function; however, the lock will be temporarily released while the

drivers/s390/crypto/vfio_ap_private.h

+31 −12

Original line number	Diff line number	Diff line
		@@ -26,16 +26,18 @@
		#define VFIO_AP_DRV_NAME "vfio_ap"

		/**
		* ap_matrix_dev - the AP matrix device structure
		* struct ap_matrix_dev - Contains the data for the matrix device.
		*
		* @device: generic device structure associated with the AP matrix device
		* @available_instances: number of mediated matrix devices that can be created
		* @info: the struct containing the output from the PQAP(QCI) instruction
		* mdev_list: the list of mediated matrix devices created
		* lock: mutex for locking the AP matrix device. This lock will be
		* @mdev_list: the list of mediated matrix devices created
		* @lock: mutex for locking the AP matrix device. This lock will be
		* taken every time we fiddle with state managed by the vfio_ap
		* driver, be it using @mdev_list or writing the state of a
		* single ap_matrix_mdev device. It's quite coarse but we don't
		* expect much contention.
		* @vfio_ap_drv: the vfio_ap device driver
		*/
		struct ap_matrix_dev {
		struct device device;
		@@ -49,17 +51,19 @@ struct ap_matrix_dev {
		extern struct ap_matrix_dev *matrix_dev;

		/**
		* The AP matrix is comprised of three bit masks identifying the adapters,
		* queues (domains) and control domains that belong to an AP matrix. The bits i
		* each mask, from least significant to most significant bit, correspond to IDs
		* 0 to 255. When a bit is set, the corresponding ID belongs to the matrix.
		* struct ap_matrix - matrix of adapters, domains and control domains
		*
		* @apm_max: max adapter number in @apm
		* @apm identifies the AP adapters in the matrix
		* @apm: identifies the AP adapters in the matrix
		* @aqm_max: max domain number in @aqm
		* @aqm identifies the AP queues (domains) in the matrix
		* @aqm: identifies the AP queues (domains) in the matrix
		* @adm_max: max domain number in @adm
		* @adm identifies the AP control domains in the matrix
		* @adm: identifies the AP control domains in the matrix
		*
		* The AP matrix is comprised of three bit masks identifying the adapters,
		* queues (domains) and control domains that belong to an AP matrix. The bits in
		* each mask, from left to right, correspond to IDs 0 to 255. When a bit is set
		* the corresponding ID belongs to the matrix.
		*/
		struct ap_matrix {
		unsigned long apm_max;
		@@ -71,13 +75,20 @@ struct ap_matrix {
		};

		/**
		* struct ap_matrix_mdev - the mediated matrix device structure
		* @list: allows the ap_matrix_mdev struct to be added to a list
		* struct ap_matrix_mdev - Contains the data associated with a matrix mediated
		* device.
		* @vdev: the vfio device
		* @node: allows the ap_matrix_mdev struct to be added to a list
		* @matrix: the adapters, usage domains and control domains assigned to the
		* mediated matrix device.
		* @group_notifier: notifier block used for specifying callback function for
		* handling the VFIO_GROUP_NOTIFY_SET_KVM event
		* @iommu_notifier: notifier block used for specifying callback function for
		* handling the VFIO_IOMMU_NOTIFY_DMA_UNMAP even
		* @kvm: the struct holding guest's state
		* @pqap_hook: the function pointer to the interception handler for the
		* PQAP(AQIC) instruction.
		* @mdev: the mediated device
		*/
		struct ap_matrix_mdev {
		struct vfio_device vdev;
		@@ -90,6 +101,14 @@ struct ap_matrix_mdev {
		struct mdev_device *mdev;
		};

		/**
		* struct vfio_ap_queue - contains the data associated with a queue bound to the
		* vfio_ap device driver
		* @matrix_mdev: the matrix mediated device
		* @saved_pfn: the guest PFN pinned for the guest
		* @apqn: the APQN of the AP queue device
		* @saved_isc: the guest ISC registered with the GIB interface
		*/
		struct vfio_ap_queue {
		struct ap_matrix_mdev *matrix_mdev;
		unsigned long saved_pfn;