Skip to content

Commit

Permalink
docs: vhost-user-gpu: add protocol changes for dmabuf modifiers
Browse files Browse the repository at this point in the history
VHOST_USER_GPU_DMABUF_SCANOUT2 is defined as a message with all the
contents of VHOST_USER_GPU_DMABUF_SCANOUT plus the dmabuf modifiers
which were ommitted.

The VHOST_USER_GPU_PROTOCOL_F_DMABUF2 protocol feature is defined as a
way to check whether this new message is supported or not.

Signed-off-by: Erico Nunes <ernunes@redhat.com>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: Sergio Lopez <slp@redhat.com>
Message-Id: <20230714153900.475857-2-ernunes@redhat.com>
  • Loading branch information
ernunesrh authored and elmarco committed Sep 12, 2023
1 parent 9ef4977 commit 75f217b
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion docs/interop/vhost-user-gpu.rst
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,19 @@ VhostUserGpuEdidRequest
:scanout-id: ``u32``, the scanout to get edid from


VhostUserGpuDMABUFScanout2
^^^^^^^^^^^^^^^^^^^^^^^^^^

+----------------+----------+
| dmabuf_scanout | modifier |
+----------------+----------+

:dmabuf_scanout: ``VhostUserGpuDMABUFScanout``, filled as described in the
VhostUserGpuDMABUFScanout structure.

:modifier: ``u64``, the DMABUF modifiers


C structure
-----------

Expand Down Expand Up @@ -163,7 +176,8 @@ Protocol features

.. code:: c
#define VHOST_USER_GPU_PROTOCOL_F_EDID 0
#define VHOST_USER_GPU_PROTOCOL_F_EDID 0
#define VHOST_USER_GPU_PROTOCOL_F_DMABUF2 1
New messages and communication changes are negotiated thanks to the
``VHOST_USER_GPU_GET_PROTOCOL_FEATURES`` and
Expand Down Expand Up @@ -263,3 +277,13 @@ Message types
Retrieve the EDID data for a given scanout.
This message requires the ``VHOST_USER_GPU_PROTOCOL_F_EDID`` protocol
feature to be supported.

``VHOST_USER_GPU_DMABUF_SCANOUT2``
:id: 12
:request payload: ``VhostUserGpuDMABUFScanout2``
:reply payload: N/A

Same as VHOST_USER_GPU_DMABUF_SCANOUT, but also sends the dmabuf modifiers
appended to the message, which were not provided in the other message.
This message requires the ``VHOST_USER_GPU_PROTOCOL_F_DMABUF2`` protocol
feature to be supported.

0 comments on commit 75f217b

Please sign in to comment.