From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from dpdk.org (dpdk.org [92.243.14.124])
	by inbox.dpdk.org (Postfix) with ESMTP id 56A10A04B6;
	Mon, 12 Oct 2020 07:08:07 +0200 (CEST)
Received: from [92.243.14.124] (localhost [127.0.0.1])
	by dpdk.org (Postfix) with ESMTP id B82EB1D5DF;
	Mon, 12 Oct 2020 07:07:21 +0200 (CEST)
Received: from mga06.intel.com (mga06.intel.com [134.134.136.31])
 by dpdk.org (Postfix) with ESMTP id E82AE1D5D8
 for <dev@dpdk.org>; Mon, 12 Oct 2020 07:07:19 +0200 (CEST)
IronPort-SDR: 6vcCYZTjsrVAPTpK+fr91kp5Z7jelH5oDul7cDDtR1hFyjzeLwC2cc86Y4saXItLO8eUTQtFue
 ZpjeEzbcp/VA==
X-IronPort-AV: E=McAfee;i="6000,8403,9771"; a="227336680"
X-IronPort-AV: E=Sophos;i="5.77,365,1596524400"; d="scan'208";a="227336680"
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from fmsmga002.fm.intel.com ([10.253.24.26])
 by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;
 11 Oct 2020 22:07:19 -0700
IronPort-SDR: mcBJmaqemWwtRFwcCpZhHNjAh1yDJ5kZqpu7j+akllTw/hZjknH56ODkCaxTxHiuzP82jcqNBv
 to8FBFc4UoIA==
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.77,365,1596524400"; d="scan'208";a="350613475"
Received: from dpdk_jiangcheng.sh.intel.com ([10.67.119.112])
 by fmsmga002.fm.intel.com with ESMTP; 11 Oct 2020 22:07:18 -0700
From: Cheng Jiang <Cheng1.jiang@intel.com>
To: maxime.coquelin@redhat.com, chenbo.xia@intel.com, zhihong.wang@intel.com
Cc: dev@dpdk.org, patrick.fu@intel.com, Cheng Jiang <Cheng1.jiang@intel.com>
Date: Mon, 12 Oct 2020 04:54:55 +0000
Message-Id: <20201012045456.5196-4-Cheng1.jiang@intel.com>
X-Mailer: git-send-email 2.27.0
In-Reply-To: <20201012045456.5196-1-Cheng1.jiang@intel.com>
References: <20200930030859.59989-1-Cheng1.jiang@intel.com>
 <20201012045456.5196-1-Cheng1.jiang@intel.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Subject: [dpdk-dev] [PATCH v4 3/4] doc: update vhost sample doc for vhost
	async data path
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

Add vhost async driver arguments information for vhost async data
path in vhost sample application.

Signed-off-by: Cheng Jiang <Cheng1.jiang@intel.com>
---
 doc/guides/sample_app_ug/vhost.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/doc/guides/sample_app_ug/vhost.rst b/doc/guides/sample_app_ug/vhost.rst
index b7ed4f8bd..0f4f70945 100644
--- a/doc/guides/sample_app_ug/vhost.rst
+++ b/doc/guides/sample_app_ug/vhost.rst
@@ -162,6 +162,17 @@ enabled and cannot be disabled.
 A very simple vhost-user net driver which demonstrates how to use the generic
 vhost APIs will be used when this option is given. It is disabled by default.
 
+**--dma-type**
+This parameter is used to specify DMA type for async vhost-user net driver which
+demonstrates how to use the async vhost APIs. It's used in combination with dmas.
+
+**--dmas**
+This parameter is used to specify the assigned DMA device of a vhost device.
+Async vhost-user net driver will be used if --dmas is set. For example
+--dmas [txd0@00:04.0,txd1@00:04.1] means use DMA channel 00:04.0 for vhost
+device 0 enqueue operation and use DMA channel 00:04.1 for vhost device 1
+enqueue operation.
+
 Common Issues
 -------------
 
-- 
2.27.0