pxcloud/vhost-device
5
0
Fork 0
mirror of https://github.com/rust-vmm/vhost-device.git synced 2026-01-08 20:57:35 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

gpu: Make some formatting changes to README.md

Browse Source 
- Add missing `--gpu-mode` argument from "Synopsis" section"
- Make "Options" section shorter, include --gpu-mode and its possible
  values
- Surround source code identifiers with backticks so they render as code
- Split "Features" section in paragraphs in preparation for next commit,
  which will expand the "gfxstream" part with info about compilation
  details.
- Surround gpu mode values with backticks so they render as code

Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
This commit is contained in:
Manos Pitsidianakis 2024-11-30 15:00:08 +02:00 committed by Stefano Garzarella
parent 28b4d6c868
commit 3eaa0f80f1
1 changed files with 20 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
staging/vhost-device-gpu/README.md
View File

@ -1,36 +1,34 @@
# vhost-device-gpu - GPU emulation backend daemon
## Synopsis
```shell
vhost-device-gpu --socket-path <SOCKET>
vhost-device-gpu --socket-path <SOCKET> --gpu-mode <GPU_MODE>
```
## Description
A virtio-gpu device using the vhost-user protocol.
## Options
```text
-s, --socket-path <SOCKET>
vhost-user Unix domain socket path
-h, --help
Print help
-V, --version
Print version
-s, --socket-path <SOCKET> vhost-user Unix domain socket
-g, --gpu-mode <GPU_MODE> [possible values: virgl-renderer, gfxstream]
-h, --help Print help
-V, --version Print version
```
## Limitations
We are currently only supporting sharing the display output to QEMU through a
socket using the transfer_read operation triggered by
VIRTIO_GPU_CMD_TRANSFER_FROM_HOST_3D to transfer data from and to virtio-gpu 3d
`VIRTIO_GPU_CMD_TRANSFER_FROM_HOST_3D` to transfer data from and to virtio-gpu 3D
resources. It'll be nice to have support for directly sharing display output
resource using dmabuf.
This device does not yet support the VIRTIO_GPU_CMD_RESOURCE_CREATE_BLOB,
VIRTIO_GPU_CMD_SET_SCANOUT_BLOB and VIRTIO_GPU_CMD_RESOURCE_ASSIGN_UUID features.
This device does not yet support the `VIRTIO_GPU_CMD_RESOURCE_CREATE_BLOB`,
`VIRTIO_GPU_CMD_SET_SCANOUT_BLOB` and `VIRTIO_GPU_CMD_RESOURCE_ASSIGN_UUID` features.
Currently this crate requires some necessary bits in order to move the crate out of staging:
@ -40,18 +38,21 @@ Currently this crate requires some necessary bits in order to move the crate out
## Features
The device leverages the [rutabaga_gfx](https://crates.io/crates/rutabaga_gfx) crate
to provide virglrenderer and gfxstream rendering. With Virglrenderer, Rutabaga
translates OpenGL API and Vulkan calls to an intermediate representation and allows
for OpenGL acceleration on the host. With the gfxstream rendering mode, GLES and
Vulkan calls are forwarded to the host with minimal modification.
The device leverages the [rutabaga_gfx](https://crates.io/crates/rutabaga_gfx)
crate to provide rendering with virglrenderer and gfxstream.
With Virglrenderer, Rutabaga translates OpenGL API and Vulkan calls to an
intermediate representation and allows for OpenGL acceleration on the host.
With the gfxstream rendering mode, GLES and Vulkan calls are forwarded to the
host with minimal modification.
## Examples
First start the daemon on the host machine using either of the 2 gpu modes:
1) virgl-renderer
2) gfxstream
1) `virgl-renderer`
2) `gfxstream`
```shell
host# vhost-device-gpu --socket-path /tmp/gpu.socket --gpu-mode virgl-renderer