From: "Alex Bennée" <alex.bennee@linaro.org>
To: qemu-devel@nongnu.org
Cc: "Gonglei (Arei)" <arei.gonglei@huawei.com>,
"Paolo Bonzini" <pbonzini@redhat.com>,
"Michael S. Tsirkin" <mst@redhat.com>,
virtio-fs@redhat.com,
"Erik Schilling" <erik.schilling@linaro.org>,
"Alex Bennée" <alex.bennee@linaro.org>,
"Marc-André Lureau" <marcandre.lureau@redhat.com>,
"Eduardo Habkost" <eduardo@habkost.net>,
"Stefan Hajnoczi" <stefanha@redhat.com>,
"Eric Blake" <eblake@redhat.com>,
"Daniel P. Berrangé" <berrange@redhat.com>,
"Jason Wang" <jasowang@redhat.com>,
"Viresh Kumar" <viresh.kumar@linaro.org>,
"Mathieu Poirier" <mathieu.poirier@linaro.org>,
"Gerd Hoffmann" <kraxel@redhat.com>,
"Markus Armbruster" <armbru@redhat.com>
Subject: [PATCH 12/12] docs/system: add a basic enumeration of vhost-user devices
Date: Fri, 14 Apr 2023 17:04:33 +0100 [thread overview]
Message-ID: <20230414160433.2096866-13-alex.bennee@linaro.org> (raw)
In-Reply-To: <20230414160433.2096866-1-alex.bennee@linaro.org>
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
---
docs/system/devices/vhost-user-rng.rst | 2 ++
docs/system/devices/vhost-user.rst | 41 ++++++++++++++++++++++++++
2 files changed, 43 insertions(+)
diff --git a/docs/system/devices/vhost-user-rng.rst b/docs/system/devices/vhost-user-rng.rst
index a145d4105c..ead1405326 100644
--- a/docs/system/devices/vhost-user-rng.rst
+++ b/docs/system/devices/vhost-user-rng.rst
@@ -1,3 +1,5 @@
+.. _vhost_user_rng:
+
QEMU vhost-user-rng - RNG emulation
===================================
diff --git a/docs/system/devices/vhost-user.rst b/docs/system/devices/vhost-user.rst
index 86128114fa..99b352823e 100644
--- a/docs/system/devices/vhost-user.rst
+++ b/docs/system/devices/vhost-user.rst
@@ -15,6 +15,47 @@ to the guest. The code is mostly boilerplate although each device has
a ``chardev`` option which specifies the ID of the ``--chardev``
device that connects via a socket to the vhost-user *daemon*.
+Each device will have an virtio-mmio and virtio-pci variant. See your
+platform details for what sort of virtio bus to use.
+
+.. list-table:: vhost-user devices
+ :widths: 20 20 60
+ :header-rows: 1
+
+ * - Device
+ - Type
+ - Notes
+ * - vhost-user-device
+ - Generic
+ - You must manually specify ``virtio-id`` and the correct ``num_vqs``
+ * - vhost-user-blk
+ - Block storage
+ -
+ * - vhost-user-fs
+ - File based storage driver
+ - See https://gitlab.com/virtio-fs/virtiofsd
+ * - vhost-user-scsi
+ - SCSI based storage
+ - See contrib/vhost-user/scsi
+ * - vhost-user-gpio
+ - Proxy gpio pins to host
+ - See https://github.com/rust-vmm/vhost-device
+ * - vhost-user-i2c
+ - Proxy i2c devices to host
+ - See https://github.com/rust-vmm/vhost-device
+ * - vhost-user-input
+ - Generic input driver
+ - See contrib/vhost-user-input
+ * - vhost-user-rng
+ - Entropy driver
+ - :ref:`vhost_user_rng`
+ * - vhost-user-gpu
+ - GPU driver
+ -
+ * - vhost-user-vsock
+ - Socket based communication
+ - See https://github.com/rust-vmm/vhost-device
+
vhost-user daemon
=================
--
2.39.2
next prev parent reply other threads:[~2023-04-14 16:07 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-04-14 16:04 [PATCH 00/12] virtio: add vhost-user-generic and reduce copy and paste Alex Bennée
2023-04-14 16:04 ` [PATCH 01/12] hw/virtio: fix typo in VIRTIO_CONFIG_IRQ_IDX comments Alex Bennée
2023-04-14 16:04 ` [PATCH 02/12] include/hw/virtio: document virtio_notify_config Alex Bennée
2023-04-14 16:04 ` [PATCH 03/12] include/hw/virtio: add kerneldoc for virtio_init Alex Bennée
2023-04-14 16:04 ` [PATCH 04/12] include/hw/virtio: document some more usage of notifiers Alex Bennée
2023-04-14 16:04 ` [PATCH 05/12] virtio: add generic vhost-user-device Alex Bennée
2023-04-14 16:04 ` [PATCH 06/12] virtio: add PCI stub for vhost-user-device Alex Bennée
2023-04-18 8:28 ` Erik Schilling
2023-04-14 16:04 ` [PATCH 07/12] include: attempt to document device_class_set_props Alex Bennée
2023-04-14 16:04 ` [PATCH 08/12] qom: allow for properties to become "fixed" Alex Bennée
2023-04-17 10:02 ` Markus Armbruster
2023-04-17 11:26 ` Alex Bennée
2023-04-17 12:04 ` Peter Maydell
2023-04-14 16:04 ` [PATCH 09/12] hw/virtio: derive vhost-user-rng from vhost-user-device Alex Bennée
2023-04-14 16:04 ` [PATCH 10/12] hw/virtio: add config support to vhost-user-device Alex Bennée
2023-04-14 16:04 ` [PATCH 11/12] hw/virtio: derive vhost-user-gpio from vhost-user-device (!BROKEN) Alex Bennée
2023-04-14 16:04 ` Alex Bennée [this message]
2023-04-17 4:26 ` [PATCH 00/12] virtio: add vhost-user-generic and reduce copy and paste Viresh Kumar
2023-04-17 8:42 ` Alex Bennée
2023-04-17 12:32 ` Stefan Hajnoczi
2023-04-17 16:14 ` Alex Bennée
2023-04-18 16:04 ` Stefan Hajnoczi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230414160433.2096866-13-alex.bennee@linaro.org \
--to=alex.bennee@linaro.org \
--cc=arei.gonglei@huawei.com \
--cc=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=eblake@redhat.com \
--cc=eduardo@habkost.net \
--cc=erik.schilling@linaro.org \
--cc=jasowang@redhat.com \
--cc=kraxel@redhat.com \
--cc=marcandre.lureau@redhat.com \
--cc=mathieu.poirier@linaro.org \
--cc=mst@redhat.com \
--cc=pbonzini@redhat.com \
--cc=qemu-devel@nongnu.org \
--cc=stefanha@redhat.com \
--cc=viresh.kumar@linaro.org \
--cc=virtio-fs@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).