motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-08-15 22:21:57 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

vfio: improve VFIODeviceIOOps docs

Browse source 
Explicitly describe every parameter rather than summarizing.

Signed-off-by: John Levon <john.levon@nutanix.com>
Reviewed-by: Cédric Le Goater <clg@redhat.com>
Link: https://lore.kernel.org/qemu-devel/20250611104753.1199796-1-john.levon@nutanix.com
Signed-off-by: Cédric Le Goater <clg@redhat.com>
This commit is contained in:
John Levon 2025-06-11 03:47:53 -07:00 • committed by Cédric Le Goater
parent 6f06e3729a
commit 079e7216de
1 changed files with 43 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

52
include/hw/vfio/vfio-device.h
View file

@ -168,14 +168,25 @@ struct VFIODeviceIOOps {
* @device_feature * @device_feature
* *
* Fill in feature info for the given device. * Fill in feature info for the given device.
*
* @vdev: #VFIODevice to use
* @feat: feature information to fill in
*
* Returns 0 on success or -errno.
*/ */
int (*device_feature)(VFIODevice *vdev, struct vfio_device_feature *); int (*device_feature)(VFIODevice *vdev, struct vfio_device_feature *feat);
/** /**
* @get_region_info * @get_region_info
* *
* Fill in @info (and optionally @fd) with information on the region given * Get the information for a given region on the device.
* by @info->index. *
* @vdev: #VFIODevice to use
* @info: set @info->index to the region index to look up; the rest of the
* struct will be filled in on success
* @fd: pointer to the fd for the region; will be -1 if not found
*
* Returns 0 on success or -errno.
*/ */
int (*get_region_info)(VFIODevice *vdev, int (*get_region_info)(VFIODevice *vdev,
struct vfio_region_info *info, int *fd); struct vfio_region_info *info, int *fd);
@ -183,22 +194,38 @@ struct VFIODeviceIOOps {
/** /**
* @get_irq_info * @get_irq_info
* *
* Fill in @irq with information on the IRQ given by @info->index. * @vdev: #VFIODevice to use
* @irq: set @irq->index to the IRQ index to look up; the rest of the struct
* will be filled in on success
*
* Returns 0 on success or -errno.
*/ */
int (*get_irq_info)(VFIODevice *vdev, struct vfio_irq_info *irq); int (*get_irq_info)(VFIODevice *vdev, struct vfio_irq_info *irq);
/** /**
* @set_irqs * @set_irqs
* *
* Configure IRQs as defined by @irqs. * Configure IRQs.
*
* @vdev: #VFIODevice to use
* @irqs: IRQ configuration as defined by VFIO docs.
*
* Returns 0 on success or -errno.
*/ */
int (*set_irqs)(VFIODevice *vdev, struct vfio_irq_set *irqs); int (*set_irqs)(VFIODevice *vdev, struct vfio_irq_set *irqs);
/** /**
* @region_read * @region_read
* *
* Read @size bytes from the region @nr at offset @off into the buffer * Read part of a region.
* @data. *
* @vdev: #VFIODevice to use
* @nr: region index
* @off: offset within the region
* @size: size in bytes to read
* @data: buffer to read into
*
* Returns number of bytes read on success or -errno.
*/ */
int (*region_read)(VFIODevice *vdev, uint8_t nr, off_t off, uint32_t size, int (*region_read)(VFIODevice *vdev, uint8_t nr, off_t off, uint32_t size,
void *data); void *data);
@ -206,8 +233,15 @@ struct VFIODeviceIOOps {
/** /**
* @region_write * @region_write
* *
* Write @size bytes to the region @nr at offset @off from the buffer * Write part of a region.
* @data; if @post, the write is posted. *
* @vdev: #VFIODevice to use
* @nr: region index
* @off: offset within the region
* @size: size in bytes to write
* @data: buffer to write from
*
* Returns number of bytes write on success or -errno.
*/ */
int (*region_write)(VFIODevice *vdev, uint8_t nr, off_t off, uint32_t size, int (*region_write)(VFIODevice *vdev, uint8_t nr, off_t off, uint32_t size,
void *data, bool post); void *data, bool post);