docs/interop/vhost-user.json

1 # -*- Mode: Python -*-
7 #  Marc-André Lureau <marcandre.lureau@redhat.com>
10 # later. See the COPYING file in the top-level directory.
14 # vhost user backend discovery & capabilities
21 # List the various vhost user backend types.
34 # @rproc-serial: virtio remoteproc serial link
55       'rproc-serial',
65 # List of vhost user "block" features.
67 # @read-only: The --read-only command line option is supported.
68 # @blk-file: The --blk-file command line option is supported.
74   'data': [ 'read-only', 'blk-file' ]
80 # Capabilities reported by vhost user "block" backends
96 # List of vhost user "input" features.
98 # @evdev-path: The --evdev-path command line option is supported.
99 # @no-grab: The --no-grab command line option is supported.
105   'data': [ 'evdev-path', 'no-grab' ]
111 # Capabilities reported by vhost user "input" backends
127 # List of vhost user "gpu" features.
129 # @render-node: The --render-node command line option is supported.
130 # @virgl: The --virgl command line option is supported.
136   'data': [ 'render-node', 'virgl' ]
142 # Capabilities reported by vhost user "gpu" backends.
158 # Capabilities reported by vhost user backends.
160 # @type: The vhost user backend type.
177 # Describes a vhost user backend to management software.
184 # It is recommended to create vhost user backend JSON files (each
186 # double-digit prefix, for example "50-qemu-gpu.json",
187 # "50-crosvm-gpu.json", etc, so they can be sorted in predictable
191 #   - /usr/share/qemu/vhost-user -- populated by distro-provided
195 #   - /etc/qemu/vhost-user -- exclusively for sysadmins' local additions,
197 #   - $XDG_CONFIG_HOME/qemu/vhost-user -- exclusively for per-user local
201 # Top-down, the list of directories goes from general to specific.
213 #   - /usr/share/qemu/vhost-user/50-qemu-gpu.json
215 #   - /usr/share/qemu/vhost-user/50-crosvm-gpu.json
219 #   $ touch /etc/qemu/vhost-user/50-qemu-gpu.json
223 #   $ vim /etc/qemu/vhost-user/50-qemu-gpu.json
227 #   $ vim /etc/qemu/vhost-user/10-qemu-gpu.json
231 #   $ vim /etc/qemu/vhost-user/99-qemu-gpu.json
233 # @type: The vhost user backend type.
235 # @description: Provides a human-readable description of the backend.
242 #        latter's possible exposure to the end-user. @tags serves
251 #   "description": "QEMU vhost-user-gpu",
253 #   "binary": "/usr/libexec/qemu/vhost-user-gpu",