d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: add devargs for virtio-user

Browse Source 
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>
This commit is contained in:
Tiwei Bie 2019-08-13 10:07:28 +08:00 committed by Ferruh Yigit
parent d03814d191
commit 14d1fad565
1 changed files with 35 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
doc/guides/nics/virtio.rst
View File

@ -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))