Re: [PATCH v5 02/15] s390/vfio-ap: Data structures for facilitating vfio device migration

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] Incorrect kernel-doc formatting and field name mismatches will cause documentation build warnings.
--

--- Patch [2]: [PATCH v5 02/15] s390/vfio-ap: Data structures for facilitating vfio device migration ---
commit c31e0e68ee7918227073261c8d3c179cdb56d4da
Author: Anthony Krowiak <akrowiak@linux.ibm.com>

s390/vfio-ap: Data structures for facilitating vfio device migration

Creates the data structures used to facilitate state transitions during
vfio device migration.

> diff --git a/drivers/s390/crypto/vfio_ap_migration.c b/drivers/s390/crypto/vfio_ap_migration.c
> new file mode 100644
> index 0000000000000..1b0856aacb697
> --- /dev/null
> +++ b/drivers/s390/crypto/vfio_ap_migration.c
> @@ -0,0 +1,72 @@
[ ... ]
> +/**
> + * vfio_ap_migration_file
       ^^^^^^^^^^^^^^^^^^^^^^^^

[Severity: Low]
Is this missing the "struct " keyword and a short description for
struct vfio_ap_migration_file?

Building the documentation might trigger a kernel-doc warning here.

> + *
> + * This object is used for chunk processing of multiple reads and writes of
> + * AP configuration information.
[ ... ]
> +struct vfio_ap_migration_file {
> +	struct file		*filp;
> +	struct vfio_ap_config	*ap_config;
> +	unsigned long		config_sz;
> +};
> +
> +/**
> + * vfio_ap_migration_data
       ^^^^^^^^^^^^^^^^^^^^^^^^

[Severity: Low]
Could this kernel-doc block for struct vfio_ap_migration_data also be
missing the "struct " keyword?

> + *
> + * Manages the migration state for the VFIO device that maintains the AP
> + * configuration of the guest being migrated.
[ ... ]
> +struct vfio_ap_migration_data {
> +	enum vfio_device_mig_state	mig_state;
> +	struct vfio_ap_migration_file	resuming_mig_file;
> +	struct vfio_ap_migration_file	stop_copy_mig_file;
> +};
[ ... ]
> +/**
> + * vfio_ap_config - the guest's AP configuration
> + *
> + * @num_queues:	the number of queues passed through to the guest
> + * @reserved:	padding to ensure proper alignment of @cntl_domains
                                                              ^^^^^^^^^^^^^

[Severity: Low]
Does this documentation for @reserved incorrectly reference a nonexistent
cntl_domains field in struct vfio_ap_config?

The struct defines the field as adm, so this might result in a field name
mismatch warning during documentation build.

> + * @adm:	bitmap specifying the control domains in the AP configuration
> + * @qinfo:	an array of vfio_ap_queue_info objects, each specifying the
> + *		queue information for a queue passed through to the guest
> + */
> +struct vfio_ap_config {
> +	u32				num_queues;
> +	u8				reserved[4];
> +	u64				adm[DIV_ROUND_UP(AP_DOMAINS, 64)];
> +	struct vfio_ap_queue_info	qinfo[] __counted_by(num_queues);
> +};

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20260724161351.1802644-1-akrowiak@linux.ibm.com?part=2