From patchwork Tue Aug 13 02:07:28 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tiwei Bie X-Patchwork-Id: 57639 X-Patchwork-Delegate: maxime.coquelin@redhat.com Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 4F2041BEA1; Tue, 13 Aug 2019 04:10:00 +0200 (CEST) Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id 00FFD1BE8D for ; Tue, 13 Aug 2019 04:09:54 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga004.jf.intel.com ([10.7.209.38]) by orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 12 Aug 2019 19:09:54 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.64,379,1559545200"; d="scan'208";a="327540073" Received: from dpdk-virtio-tbie-2.sh.intel.com ([10.67.104.71]) by orsmga004.jf.intel.com with ESMTP; 12 Aug 2019 19:09:53 -0700 From: Tiwei Bie To: maxime.coquelin@redhat.com, zhihong.wang@intel.com, john.mcnamara@intel.com, marko.kovacevic@intel.com, dev@dpdk.org Date: Tue, 13 Aug 2019 10:07:28 +0800 Message-Id: <20190813020730.10038-5-tiwei.bie@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20190813020730.10038-1-tiwei.bie@intel.com> References: <20190813020730.10038-1-tiwei.bie@intel.com> Subject: [dpdk-dev] [PATCH 4/6] doc: document the devargs for virtio-user X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 Reviewed-by: Maxime Coquelin --- 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))