diff options
| author | JAKelly10 <87753759+JAKelly10@users.noreply.github.com> | 2021-09-08 15:47:23 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-08 15:47:23 +0100 |
| commit | d12584bf8c726a1907655f03e5a18b549599da41 (patch) | |
| tree | 1f302bbedbe23805551127f74f1d3f8186a92fa2 /docs | |
| parent | 080e664ed5e79dcf5ae5a36521cab0ddb7ebc5f0 (diff) | |
| download | libvfio-user-d12584bf8c726a1907655f03e5a18b549599da41.zip libvfio-user-d12584bf8c726a1907655f03e5a18b549599da41.tar.gz libvfio-user-d12584bf8c726a1907655f03e5a18b549599da41.tar.bz2 | |
initial ioeventfd support (#601)
Provide initial support for handling VFIO_USER_DEVICE_GET_REGION_IO_FDS, along with a new vfu_create_ioeventfd() API.
Reviewed-by: John Levon <john.levon@nutanix.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/vfio-user.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/vfio-user.rst b/docs/vfio-user.rst index e912fb3..9d03f4d 100644 --- a/docs/vfio-user.rst +++ b/docs/vfio-user.rst @@ -322,9 +322,9 @@ usual ``msg_size`` field in the header, not the ``argsz`` field. In a reply, the server sets ``argsz`` field to the size needed for a full payload size. This may be less than the requested maximum size. This may be -larger than the requested maximum size: in that case, the full payload is not -included in the reply, but the ``argsz`` field in the reply indicates the needed -size, allowing a client to allocate a larger buffer for holding the reply before +larger than the requested maximum size: in that case, the payload reply header +is returned, but the ``argsz`` field in the reply indicates the needed size, +allowing a client to allocate a larger buffer for holding the reply before trying again. In addition, during negotiation (see `Version`_), the client and server may @@ -1000,7 +1000,7 @@ Reply * *argsz* is the size of the region IO FD info structure plus the total size of the sub-region array. Thus, each array entry "i" is at offset - i * ((argsz - 32) / count). Note that currently this is 40 bytes for both IO + i * ((argsz - 16) / count). Note that currently this is 40 bytes for both IO FD types, but this is not to be relied on. As elsewhere, this indicates the full reply payload size needed. * *flags* must be zero @@ -1016,8 +1016,8 @@ Note that it is the client's responsibility to verify the requested values (for example, that the requested offset does not exceed the region's bounds). Each sub-region given in the response has one of two possible structures, -depending whether *type* is ``VFIO_USER_IO_FD_TYPE_IOEVENTFD`` or -``VFIO_USER_IO_FD_TYPE_IOREGIONFD``: +depending whether *type* is ``VFIO_USER_IO_FD_TYPE_IOEVENTFD`` (0) or +``VFIO_USER_IO_FD_TYPE_IOREGIONFD`` (1): Sub-Region IO FD info format (ioeventfd) """""""""""""""""""""""""""""""""""""""" |