src/plugins/vmxnet3/README.md

   1 # VMWARE vmxnet3 device driver plugin
   2
   3 ##Overview
   4 This plugin provides native PCI driver support for VMWare vmxnet3.
   5
   6 ##Prerequisites
   7  * This code is tested with vfio-pci driver installed with Ubuntu 18.04 which
   8 has kernel version 4.15.0-33-generic.
   9
  10  * This code is tested with ESXi vSwitch version 6.0, release build 3620759.
  11
  12  * Driver requires MSI-X interrupt support, which is not supported by
  13 uio_pci_generic driver, so vfio-pci needs to be used. On systems without IOMMU
  14 vfio driver can still be used with recent kernels which support no-iommu mode.
  15
  16 ##Known issues
  17
  18 * TSO/LRO
  19 * RSS
  20 * VLAN filter
  21
  22 ## Usage
  23 ### System setup
  24
  25 1. load VFIO driver
  26 ```
  27 sudo modprobe vfio-pci
  28 ```
  29
  30 2. (systems without IOMMU only) enable unsafe NOIOMMU mode
  31 ```
  32 echo Y | sudo tee /sys/module/vfio/parameters/enable_unsafe_noiommu_mode
  33 ```
  34
  35 3. Bind interface to vfio-pci
  36 ```
  37 sudo dpdk-devbind.py --bind vfio-pci 0b:00.0
  38 ```
  39
  40 ### Interface Creation
  41 Interface can be dynamically created with following CLI:
  42 ```
  43 create interface vmxnet3 0000:0b:00.0
  44 set int state vmxnet3-0/b/0/0 up
  45 ```
  46
  47 ### Interface Deletion
  48 Interface can be deleted with following CLI:
  49 ```
  50 delete interface vmxnet3 <if-name>
  51 ```
  52
  53 ### Interface Statistics
  54 Interface statistics can be displayed with `show hardware-interface <if-name>`
  55 command.
  56
  57 ### Show Interface CLI
  58 Interface and ring information can be obtained with
  59 `show vmxnet3 [if-name] [desc]`