From: Tiwei Bie <tiwei.bie@intel.com>
To: maxime.coquelin@redhat.com, zhihong.wang@intel.com,
john.mcnamara@intel.com, marko.kovacevic@intel.com, dev@dpdk.org
Subject: [dpdk-dev] [PATCH 4/6] doc: document the devargs for virtio-user
Date: Tue, 13 Aug 2019 10:07:28 +0800 [thread overview]
Message-ID: <20190813020730.10038-5-tiwei.bie@intel.com> (raw)
In-Reply-To: <20190813020730.10038-1-tiwei.bie@intel.com>
Document the devargs for virtio-user and also make it clear
that these devargs are only available in virtio-user, i.e. not
supported by the PCI virtio driver.
Signed-off-by: Tiwei Bie <tiwei.bie@intel.com>
---
doc/guides/nics/virtio.rst | 38 +++++++++++++++++++++++++++++++++++---
1 file changed, 35 insertions(+), 3 deletions(-)
diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
index b3c356856..993e691f5 100644
--- a/doc/guides/nics/virtio.rst
+++ b/doc/guides/nics/virtio.rst
@@ -322,7 +322,7 @@ Here we use l3fwd-power as an example to show how to get started.
Virtio PMD arguments
--------------------
-The user can specify below argument in devargs.
+Below devargs are supported by the PCI virtio driver:
#. ``vdpa``:
@@ -331,12 +331,44 @@ The user can specify below argument in devargs.
a virtio device needs to work in vDPA mode.
(Default: 0 (disabled))
-#. ``mrg_rxbuf``:
+Below devargs are supported by the virtio-user vdev:
+
+#. ``path``:
+
+ It is used to specify a path to connect to vhost backend.
+
+#. ``mac``:
+
+ It is used to specify the MAC address.
+
+#. ``cq``:
+
+ It is used to enable the control queue. (Default: 0 (disabled))
+
+#. ``queue_size``:
+
+ It is used to specify the queue size. (Default: 256)
+
+#. ``queues``:
+
+ It is used to specify the queue number. (Default: 1)
+
+#. ``iface``:
+
+ It is used to specify the host interface name for vhost-kernel
+ backend.
+
+#. ``server``:
+
+ It is used to enable the server mode when using vhost-user backend.
+ (Default: 0 (disabled))
+
+#. ``mrg_rxbuf``:
It is used to enable virtio device mergeable Rx buffer feature.
(Default: 1 (enabled))
-#. ``in_order``:
+#. ``in_order``:
It is used to enable virtio device in-order feature.
(Default: 1 (enabled))
--
2.17.1
next prev parent reply other threads:[~2019-08-13 2:10 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-13 2:07 [dpdk-dev] [PATCH 0/6] Some updates for virtio guide Tiwei Bie
2019-08-13 2:07 ` [dpdk-dev] [PATCH 1/6] net/virtio: remove remaining simple Tx related stuff Tiwei Bie
2019-09-06 13:15 ` Maxime Coquelin
2019-08-13 2:07 ` [dpdk-dev] [PATCH 2/6] doc: fix typo in virtio in-order Rx function name Tiwei Bie
2019-09-06 13:16 ` Maxime Coquelin
2019-08-13 2:07 ` [dpdk-dev] [PATCH 3/6] doc: update the description for in-order Rx path Tiwei Bie
2019-09-06 13:18 ` Maxime Coquelin
2019-08-13 2:07 ` Tiwei Bie [this message]
2019-09-06 13:20 ` [dpdk-dev] [PATCH 4/6] doc: document the devargs for virtio-user Maxime Coquelin
2019-08-13 2:07 ` [dpdk-dev] [PATCH 5/6] doc: document packed virtqueue for virtio Tiwei Bie
2019-09-06 13:21 ` Maxime Coquelin
2019-08-13 2:07 ` [dpdk-dev] [PATCH 6/6] doc: fix format for virtio guide Tiwei Bie
2019-09-06 13:22 ` Maxime Coquelin
2019-09-06 13:37 ` [dpdk-dev] [PATCH 0/6] Some updates " Maxime Coquelin
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=20190813020730.10038-5-tiwei.bie@intel.com \
--to=tiwei.bie@intel.com \
--cc=dev@dpdk.org \
--cc=john.mcnamara@intel.com \
--cc=marko.kovacevic@intel.com \
--cc=maxime.coquelin@redhat.com \
--cc=zhihong.wang@intel.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).