| Message ID | 20230329120603.468031-1-horms@kernel.org (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [vfio] vfio: correct kdoc for ops structures | expand |
On Wed, 29 Mar 2023 14:06:03 +0200 Simon Horman <horms@kernel.org> wrote: > Address minor omissions from kdoc for ops structures flagged by check-kdoc: > > ./scripts/kernel-doc -Werror -none include/linux/vfio.h > > include/linux/vfio.h:114: warning: Function parameter or member 'name' not described in 'vfio_device_ops' > include/linux/vfio.h:143: warning: Cannot understand * @migration_set_state: Optional callback to change the migration state for > on line 143 - I thought it was a doc line > include/linux/vfio.h:168: warning: Cannot understand * @log_start: Optional callback to ask the device start DMA logging. > on line 168 - I thought it was a doc line > > Signed-off-by: Simon Horman <horms@kernel.org> > --- > include/linux/vfio.h | 5 +++++ > 1 file changed, 5 insertions(+) Applied to vfio next branch for v6.4. Thanks, Alex > > diff --git a/include/linux/vfio.h b/include/linux/vfio.h > index 93134b023968..cb46050045c0 100644 > --- a/include/linux/vfio.h > +++ b/include/linux/vfio.h > @@ -68,6 +68,7 @@ struct vfio_device { > /** > * struct vfio_device_ops - VFIO bus driver device callbacks > * > + * @name: Name of the device driver. > * @init: initialize private fields in device structure > * @release: Reclaim private fields in device structure > * @bind_iommufd: Called when binding the device to an iommufd > @@ -140,6 +141,8 @@ int vfio_iommufd_emulated_attach_ioas(struct vfio_device *vdev, u32 *pt_id); > #endif > > /** > + * struct vfio_migration_ops - VFIO bus device driver migration callbacks > + * > * @migration_set_state: Optional callback to change the migration state for > * devices that support migration. It's mandatory for > * VFIO_DEVICE_FEATURE_MIGRATION migration support. > @@ -165,6 +168,8 @@ struct vfio_migration_ops { > }; > > /** > + * struct vfio_log_ops - VFIO bus device driver logging callbacks > + * > * @log_start: Optional callback to ask the device start DMA logging. > * @log_stop: Optional callback to ask the device stop DMA logging. > * @log_read_and_clear: Optional callback to ask the device read
diff --git a/include/linux/vfio.h b/include/linux/vfio.h index 93134b023968..cb46050045c0 100644 --- a/include/linux/vfio.h +++ b/include/linux/vfio.h @@ -68,6 +68,7 @@ struct vfio_device { /** * struct vfio_device_ops - VFIO bus driver device callbacks * + * @name: Name of the device driver. * @init: initialize private fields in device structure * @release: Reclaim private fields in device structure * @bind_iommufd: Called when binding the device to an iommufd @@ -140,6 +141,8 @@ int vfio_iommufd_emulated_attach_ioas(struct vfio_device *vdev, u32 *pt_id); #endif /** + * struct vfio_migration_ops - VFIO bus device driver migration callbacks + * * @migration_set_state: Optional callback to change the migration state for * devices that support migration. It's mandatory for * VFIO_DEVICE_FEATURE_MIGRATION migration support. @@ -165,6 +168,8 @@ struct vfio_migration_ops { }; /** + * struct vfio_log_ops - VFIO bus device driver logging callbacks + * * @log_start: Optional callback to ask the device start DMA logging. * @log_stop: Optional callback to ask the device stop DMA logging. * @log_read_and_clear: Optional callback to ask the device read
Address minor omissions from kdoc for ops structures flagged by check-kdoc: ./scripts/kernel-doc -Werror -none include/linux/vfio.h include/linux/vfio.h:114: warning: Function parameter or member 'name' not described in 'vfio_device_ops' include/linux/vfio.h:143: warning: Cannot understand * @migration_set_state: Optional callback to change the migration state for on line 143 - I thought it was a doc line include/linux/vfio.h:168: warning: Cannot understand * @log_start: Optional callback to ask the device start DMA logging. on line 168 - I thought it was a doc line Signed-off-by: Simon Horman <horms@kernel.org> --- include/linux/vfio.h | 5 +++++ 1 file changed, 5 insertions(+)