From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <yongwang@vmware.com>
Received: from EX13-EDG-OU-002.vmware.com (ex13-edg-ou-002.vmware.com
 [208.91.0.190]) by dpdk.org (Postfix) with ESMTP id D16272BAE
 for <dev@dpdk.org>; Wed, 24 Aug 2016 02:22:37 +0200 (CEST)
Received: from sc9-mailhost3.vmware.com (10.113.161.73) by
 EX13-EDG-OU-002.vmware.com (10.113.208.156) with Microsoft SMTP Server id
 15.0.1156.6; Tue, 23 Aug 2016 17:22:28 -0700
Received: from sc2-edge-ivybridge-01.eng.vmware.com (unknown [10.172.139.164])
 by sc9-mailhost3.vmware.com (Postfix) with ESMTP id 187424066B;
 Tue, 23 Aug 2016 17:22:34 -0700 (PDT)
From: Yong Wang <yongwang@vmware.com>
To: <thomas.monjalon@6wind.com>
CC: <dev@dpdk.org>, <gyang@vmware.com>, <diproiettod@vmware.com>, Yong Wang
 <yongwang@vmware.com>
Date: Tue, 23 Aug 2016 17:05:39 -0700
Message-ID: <1471997140-46527-6-git-send-email-yongwang@vmware.com>
X-Mailer: git-send-email 1.9.1
In-Reply-To: <1471997140-46527-1-git-send-email-yongwang@vmware.com>
References: <1471049909-18117-5-git-send-email-yongwang@vmware.com>
 <1471997140-46527-1-git-send-email-yongwang@vmware.com>
MIME-Version: 1.0
Content-Type: text/plain
Received-SPF: None (EX13-EDG-OU-002.vmware.com: yongwang@vmware.com does not
 designate permitted sender hosts)
Subject: [dpdk-dev] [PATCH v2 5/6] net/vmxnet3: update nic doc
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Wed, 24 Aug 2016 00:22:38 -0000

Signed-off-by: Yong Wang <yongwang@vmware.com>
---
 doc/guides/nics/vmxnet3.rst | 12 ++----------
 1 file changed, 2 insertions(+), 10 deletions(-)

diff --git a/doc/guides/nics/vmxnet3.rst b/doc/guides/nics/vmxnet3.rst
index e919088..bf84594 100644
--- a/doc/guides/nics/vmxnet3.rst
+++ b/doc/guides/nics/vmxnet3.rst
@@ -32,17 +32,11 @@ Poll Mode Driver for Paravirtual VMXNET3 NIC
 ============================================
 
 The VMXNET3 adapter is the next generation of a paravirtualized NIC, introduced by VMware* ESXi.
-It is designed for performance and is not related to VMXNET or VMXENET2.
-It offers all the features available in VMXNET2, and adds several new features such as,
+It is designed for performance, offers all the features available in VMXNET2, and adds several new features such as,
 multi-queue support (also known as Receive Side Scaling, RSS),
 IPv6 offloads, and MSI/MSI-X interrupt delivery.
-Because operating system vendors do not provide built-in drivers for this card,
-VMware Tools must be installed to have a driver for the VMXNET3 network adapter available.
 One can use the same device in a DPDK application with VMXNET3 PMD introduced in DPDK API.
 
-Currently, the driver provides basic support for using the device in a DPDK application running on a guest OS.
-Optimization is needed on the backend, that is, the VMware* ESXi vmkernel switch, to achieve optimal performance end-to-end.
-
 In this chapter, two setups with the use of the VMXNET3 PMD are demonstrated:
 
 #.  Vmxnet3 with a native NIC connected to a vSwitch
@@ -59,8 +53,6 @@ For performance details, refer to the following link from VMware:
 `http://www.vmware.com/pdf/vsp_4_vmxnet3_perf.pdf <http://www.vmware.com/pdf/vsp_4_vmxnet3_perf.pdf>`_
 
 As a PMD, the VMXNET3 driver provides the packet reception and transmission callbacks, vmxnet3_recv_pkts and vmxnet3_xmit_pkts.
-It does not support scattered packet reception as part of vmxnet3_recv_pkts and vmxnet3_xmit_pkts.
-Also, it does not support scattered packet reception as part of the device operations supported.
 
 The VMXNET3 PMD handles all the packet buffer memory allocation and resides in guest address space
 and it is solely responsible to free that memory when not needed.
@@ -79,7 +71,7 @@ This keeps performance up on the RX side, even though the device provides a noti
 
 In the transmit routine, the DPDK application fills packet buffer pointers in the descriptors of the command ring
 and notifies the hypervisor.
-In response the hypervisor takes packets and passes them to the vSwitch. It writes into the completion descriptors ring.
+In response the hypervisor takes packets and passes them to the vSwitch, It writes into the completion descriptors ring.
 The rings are read by the PMD in the next transmit routine call and the buffers and descriptors are freed from memory.
 
 Features and Limitations of VMXNET3 PMD
-- 
1.9.1