X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fplugins%2Fvmxnet3%2FREADME.md;h=6e9fb194c94eb0180522faf3f790df4bb8465eb7;hb=e5d34919b;hp=d1082aa11e4d6afeae0b1ffdef6ed75e664d08df;hpb=dd3737284d5021e2e3bd0413b61aab14797e365c;p=vpp.git

diff --git a/src/plugins/vmxnet3/README.md b/src/plugins/vmxnet3/README.md
index d1082aa11e4..6e9fb194c94 100644
--- a/src/plugins/vmxnet3/README.md
+++ b/src/plugins/vmxnet3/README.md
@@ -1,4 +1,4 @@
-# VMWARE vmxnet3 device driver plugin
+# VMWARE vmxnet3 device driver plugin {#vmxnet3_doc}
 
 ##Overview
 This plugin provides native PCI driver support for VMWare vmxnet3.
@@ -7,15 +7,14 @@ This plugin provides native PCI driver support for VMWare vmxnet3.
  * This code is tested with vfio-pci driver installed with Ubuntu 18.04 which
 has kernel version 4.15.0-33-generic.
 
- * This code is tested with ESXi vSwitch version 6.0, release build 3620759.
+ * This driver is tested with ESXi vSwitch version 6.5/6.7 for LRO/TSO support, VMware Workstation 15 Pro (no LRO/TSO), and VMware Fusion 11 Pro (no LRO/TSO)
 
  * Driver requires MSI-X interrupt support, which is not supported by
-uio_pci_generic driver, so vfio-pci needs to be used. On systems without IOMMU
-vfio driver can still be used with recent kernels which support no-iommu mode.
+uio_pci_generic driver. So vfio-pci must be used. On systems without IOMMU,
+vfio driver can still be used with 4.15.0-33-generic kernel (Ubuntu 18.04) which supports no-iommu mode.
 
 ##Known issues
 
-* RSS
 * VLAN filter
 
 ## Usage
@@ -26,20 +25,27 @@ vfio driver can still be used with recent kernels which support no-iommu mode.
 sudo modprobe vfio-pci
 ```
 
-2. (systems without IOMMU only) enable unsafe NOIOMMU mode
+2. Make sure the interface is down
+```
+sudo ifconfig <if-name> down
+```
+
+Steps 3 and 4 are optional. They can be accomplished by specifying the optional keyword "bind" when creating the vmxnet3 interface.
+
+3. (systems without IOMMU only) enable unsafe NOIOMMU mode
 ```
 echo Y | sudo tee /sys/module/vfio/parameters/enable_unsafe_noiommu_mode
 ```
 
-3. Bind interface to vfio-pci
+4. Bind interface to vfio-pci
 ```
 sudo dpdk-devbind.py --bind vfio-pci 0b:00.0
 ```
 
 ### Interface Creation
-Interface can be dynamically created with following CLI:
+Interface can be dynamically created with following CLI, with or without the bind option. If step 3 and 4 were executed, bind can be omitted.
 ```
-create interface vmxnet3 0000:0b:00.0
+create interface vmxnet3 0000:0b:00.0 bind
 set int state vmxnet3-0/b/0/0 up
 ```