diff mbox series

[v2,2/4] docs: vhost-user-gpu: add protocol changes for EDID

Message ID 20230531160631.612893-3-ernunes@redhat.com
State New
Headers show
Series vhost-user-gpu get_edid feature | expand

Commit Message

Erico Nunes May 31, 2023, 4:06 p.m. UTC
VHOST_USER_GPU_GET_EDID is defined as a message from the backend to the
frontend to retrieve the EDID data for a given scanout.

The VHOST_USER_GPU_PROTOCOL_F_EDID 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>
---
 docs/interop/vhost-user-gpu.rst | 18 +++++++++++++++---
 1 file changed, 15 insertions(+), 3 deletions(-)

Comments

Marc-André Lureau June 2, 2023, 6:10 a.m. UTC | #1
Hi

On Wed, May 31, 2023 at 8:08 PM Erico Nunes <ernunes@redhat.com> wrote:

> VHOST_USER_GPU_GET_EDID is defined as a message from the backend to the
> frontend to retrieve the EDID data for a given scanout.
>
> The VHOST_USER_GPU_PROTOCOL_F_EDID 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>
> ---
>  docs/interop/vhost-user-gpu.rst | 18 +++++++++++++++---
>  1 file changed, 15 insertions(+), 3 deletions(-)
>
> diff --git a/docs/interop/vhost-user-gpu.rst
> b/docs/interop/vhost-user-gpu.rst
> index 1640553729..ab86391aee 100644
> --- a/docs/interop/vhost-user-gpu.rst
> +++ b/docs/interop/vhost-user-gpu.rst
> @@ -141,6 +141,8 @@ In QEMU the vhost-user-gpu message is implemented with
> the following struct:
>            VhostUserGpuScanout scanout;
>            VhostUserGpuUpdate update;
>            VhostUserGpuDMABUFScanout dmabuf_scanout;
> +          VhostUserGpuEdidRequest edid_req;
>

Please add  VhostUserGpuEdidRequest payload description in "Payload types"
section

+          struct virtio_gpu_resp_edid resp_edid;
>            struct virtio_gpu_resp_display_info display_info;
>            uint64_t u64;
>        } payload;
> @@ -149,10 +151,11 @@ In QEMU the vhost-user-gpu message is implemented
> with the following struct:
>  Protocol features
>  -----------------
>
> -None yet.
> +.. code:: c
> +
> +  #define VHOST_USER_GPU_PROTOCOL_F_EDID 0
>
> -As the protocol may need to evolve, new messages and communication
> -changes are negotiated thanks to preliminary
> +New messages and communication changes are negotiated thanks to the
>  ``VHOST_USER_GPU_GET_PROTOCOL_FEATURES`` and
>  ``VHOST_USER_GPU_SET_PROTOCOL_FEATURES`` requests.
>
> @@ -241,3 +244,12 @@ Message types
>    Note: there is no data payload, since the scanout is shared thanks
>    to DMABUF, that must have been set previously with
>    ``VHOST_USER_GPU_DMABUF_SCANOUT``.
> +
> +``VHOST_USER_GPU_GET_EDID``
> +  :id: 11
> +  :request payload: ``struct VhostUserGpuEdidRequest``
> +  :reply payload: ``struct virtio_gpu_resp_edid`` (from virtio
> specification)
> +
> +  Retrieve the EDID data for a given scanout.
> +  This message requires the ``VHOST_USER_GPU_PROTOCOL_F_EDID`` protocol
> +  feature to be supported.
> --
> 2.40.1
>
>
>
thanks
diff mbox series

Patch

diff --git a/docs/interop/vhost-user-gpu.rst b/docs/interop/vhost-user-gpu.rst
index 1640553729..ab86391aee 100644
--- a/docs/interop/vhost-user-gpu.rst
+++ b/docs/interop/vhost-user-gpu.rst
@@ -141,6 +141,8 @@  In QEMU the vhost-user-gpu message is implemented with the following struct:
           VhostUserGpuScanout scanout;
           VhostUserGpuUpdate update;
           VhostUserGpuDMABUFScanout dmabuf_scanout;
+          VhostUserGpuEdidRequest edid_req;
+          struct virtio_gpu_resp_edid resp_edid;
           struct virtio_gpu_resp_display_info display_info;
           uint64_t u64;
       } payload;
@@ -149,10 +151,11 @@  In QEMU the vhost-user-gpu message is implemented with the following struct:
 Protocol features
 -----------------
 
-None yet.
+.. code:: c
+
+  #define VHOST_USER_GPU_PROTOCOL_F_EDID 0
 
-As the protocol may need to evolve, new messages and communication
-changes are negotiated thanks to preliminary
+New messages and communication changes are negotiated thanks to the
 ``VHOST_USER_GPU_GET_PROTOCOL_FEATURES`` and
 ``VHOST_USER_GPU_SET_PROTOCOL_FEATURES`` requests.
 
@@ -241,3 +244,12 @@  Message types
   Note: there is no data payload, since the scanout is shared thanks
   to DMABUF, that must have been set previously with
   ``VHOST_USER_GPU_DMABUF_SCANOUT``.
+
+``VHOST_USER_GPU_GET_EDID``
+  :id: 11
+  :request payload: ``struct VhostUserGpuEdidRequest``
+  :reply payload: ``struct virtio_gpu_resp_edid`` (from virtio specification)
+
+  Retrieve the EDID data for a given scanout.
+  This message requires the ``VHOST_USER_GPU_PROTOCOL_F_EDID`` protocol
+  feature to be supported.