summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTiwei Bie <tiwei.bie@intel.com>2019-08-13 10:07:28 +0800
committerFerruh Yigit <ferruh.yigit@intel.com>2019-09-06 17:32:42 +0200
commit14d1fad5650c2bef8d1ab494a43fc823740f2470 (patch)
treeb5d2e3039f18cc749c55455c18368dbecfb62020
parentd03814d1912c693e1bf6901551898a16cab282ab (diff)
downloaddpdk-next-eventdev-14d1fad5650c2bef8d1ab494a43fc823740f2470.zip
dpdk-next-eventdev-14d1fad5650c2bef8d1ab494a43fc823740f2470.tar.gz
dpdk-next-eventdev-14d1fad5650c2bef8d1ab494a43fc823740f2470.tar.xz
doc: add devargs for virtio-user
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> Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>
-rw-r--r--doc/guides/nics/virtio.rst38
1 files changed, 35 insertions, 3 deletions
diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
index b3c3568..993e691 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))