Skip to content

Commit 38e4614

Browse files
hormsAlex Williamson
authored andcommitted
vfio: correct kdoc for ops structures
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> Link: https://lore.kernel.org/r/20230329120603.468031-1-horms@kernel.org Signed-off-by: Alex Williamson <alex.williamson@redhat.com>
1 parent 6467d07 commit 38e4614

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

include/linux/vfio.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ struct vfio_device {
6868
/**
6969
* struct vfio_device_ops - VFIO bus driver device callbacks
7070
*
71+
* @name: Name of the device driver.
7172
* @init: initialize private fields in device structure
7273
* @release: Reclaim private fields in device structure
7374
* @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);
140141
#endif
141142

142143
/**
144+
* struct vfio_migration_ops - VFIO bus device driver migration callbacks
145+
*
143146
* @migration_set_state: Optional callback to change the migration state for
144147
* devices that support migration. It's mandatory for
145148
* VFIO_DEVICE_FEATURE_MIGRATION migration support.
@@ -165,6 +168,8 @@ struct vfio_migration_ops {
165168
};
166169

167170
/**
171+
* struct vfio_log_ops - VFIO bus device driver logging callbacks
172+
*
168173
* @log_start: Optional callback to ask the device start DMA logging.
169174
* @log_stop: Optional callback to ask the device stop DMA logging.
170175
* @log_read_and_clear: Optional callback to ask the device read

0 commit comments

Comments
 (0)