qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: "Longpeng(Mike)" via <qemu-devel@nongnu.org>
To: <stefanha@redhat.com>, <mst@redhat.com>, <jasowang@redhat.com>,
	<sgarzare@redhat.com>
Cc: <cohuck@redhat.com>, <pbonzini@redhat.com>,
	<arei.gonglei@huawei.com>, <yechuan@huawei.com>,
	<huangzhichao@huawei.com>, <qemu-devel@nongnu.org>,
	<xiehong@huawei.com>, Longpeng <longpeng2@huawei.com>
Subject: [PATCH v8 5/5] docs: Add generic vhost-vdpa device documentation
Date: Tue, 8 Nov 2022 08:41:57 +0800	[thread overview]
Message-ID: <20221108004157.1112-6-longpeng2@huawei.com> (raw)
In-Reply-To: <20221108004157.1112-1-longpeng2@huawei.com>

From: Longpeng <longpeng2@huawei.com>

Signed-off-by: Longpeng <longpeng2@huawei.com>
---
 docs/system/devices/vhost-vdpa-device.rst | 43 +++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 docs/system/devices/vhost-vdpa-device.rst

diff --git a/docs/system/devices/vhost-vdpa-device.rst b/docs/system/devices/vhost-vdpa-device.rst
new file mode 100644
index 0000000000..b758c4fce6
--- /dev/null
+++ b/docs/system/devices/vhost-vdpa-device.rst
@@ -0,0 +1,43 @@
+
+=========================
+generic vhost-vdpa device
+=========================
+
+This document explains the usage of the generic vhost vdpa device.
+
+Description
+-----------
+
+vDPA(virtio data path acceleration) device is a device that uses a datapath
+which complies with the virtio specifications with vendor specific control
+path.
+
+QEMU provides two types of vhost-vdpa devices to enable the vDPA device, one
+is type sensitive which means QEMU needs to know the actual device type
+(e.g. net, blk, scsi) and another is called "generic vdpa device" which is
+type insensitive (likes vfio-pci).
+
+Examples
+--------
+
+Prepare the vhost-vdpa backends first:
+
+::
+  host# ls -l /dev/vhost-vdpa-*
+  crw------- 1 root root 236, 0 Nov  2 00:49 /dev/vhost-vdpa-0
+
+Start QEMU with virtio-mmio bus:
+
+::
+  host# qemu-system                                                  \
+      -M microvm -m 512 -smp 2 -kernel ... -initrd ...               \
+      -device vhost-vdpa-device,vhostdev=/dev/vhost-vdpa-0           \
+      ...
+
+Start QEMU with virtio-pci bus:
+
+::
+  host# qemu-system                                                  \
+      -M pc -m 512 -smp 2                                            \
+      -device vhost-vdpa-device-pci,vhostdev=/dev/vhost-vdpa-0       \
+      ...
-- 
2.23.0



  parent reply	other threads:[~2022-11-08  0:43 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-08  0:41 [PATCH v8 0/5] add generic vDPA device support Longpeng(Mike) via
2022-11-08  0:41 ` [PATCH v8 1/5] virtio: get class_id and pci device id by the virtio id Longpeng(Mike) via
2022-11-08  0:41 ` [PATCH v8 2/5] vdpa: add vdpa-dev support Longpeng(Mike) via
2022-11-08  0:41 ` [PATCH v8 3/5] vdpa: add vdpa-dev-pci support Longpeng(Mike) via
2022-11-08  0:41 ` [PATCH v8 4/5] vdpa-dev: mark the device as unmigratable Longpeng(Mike) via
2022-11-08  2:38   ` Jason Wang
2022-11-08  8:46   ` Stefano Garzarella
2022-11-12  7:37     ` longpeng2--- via
2022-11-08  0:41 ` Longpeng(Mike) via [this message]
2022-11-08  2:42   ` [PATCH v8 5/5] docs: Add generic vhost-vdpa device documentation Jason Wang
2022-11-08  3:30     ` longpeng2--- via
2022-11-08  8:42       ` Stefano Garzarella
2022-11-12  7:39         ` longpeng2--- via

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=20221108004157.1112-6-longpeng2@huawei.com \
    --to=qemu-devel@nongnu.org \
    --cc=arei.gonglei@huawei.com \
    --cc=cohuck@redhat.com \
    --cc=huangzhichao@huawei.com \
    --cc=jasowang@redhat.com \
    --cc=longpeng2@huawei.com \
    --cc=mst@redhat.com \
    --cc=pbonzini@redhat.com \
    --cc=sgarzare@redhat.com \
    --cc=stefanha@redhat.com \
    --cc=xiehong@huawei.com \
    --cc=yechuan@huawei.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).