src/plugins/vmxnet3/README.rst

   1 VMWARE vmxnet3 device driver
   2 ============================
   3
   4 ##Overview This plugin provides native PCI driver support for VMWare
   5 vmxnet3.
   6
   7 ##Prerequisites \* This code is tested with vfio-pci driver installed
   8 with Ubuntu 18.04 which has kernel version 4.15.0-33-generic.
   9
  10 -  This driver is tested with ESXi vSwitch version 6.5/6.7 for LRO/TSO
  11    support, VMware Workstation 15 Pro (no LRO/TSO), and VMware Fusion 11
  12    Pro (no LRO/TSO)
  13
  14 -  Driver requires MSI-X interrupt support, which is not supported by
  15    uio_pci_generic driver. So vfio-pci must be used. On systems without
  16    IOMMU, vfio driver can still be used with 4.15.0-33-generic kernel
  17    (Ubuntu 18.04) which supports no-iommu mode.
  18
  19 ##Known issues
  20
  21 -  VLAN filter
  22
  23 Usage
  24 -----
  25
  26 System setup
  27 ~~~~~~~~~~~~
  28
  29 1. load VFIO driver
  30
  31 ::
  32
  33    sudo modprobe vfio-pci
  34
  35 2. Make sure the interface is down
  36
  37 ::
  38
  39    sudo ifconfig <if-name> down
  40
  41 Steps 3 and 4 are optional. They can be accomplished by specifying the
  42 optional keyword “bind” when creating the vmxnet3 interface.
  43
  44 3. (systems without IOMMU only) enable unsafe NOIOMMU mode
  45
  46 ::
  47
  48    echo Y | sudo tee /sys/module/vfio/parameters/enable_unsafe_noiommu_mode
  49
  50 4. Bind interface to vfio-pci
  51
  52 ::
  53
  54    sudo dpdk-devbind.py --bind vfio-pci 0b:00.0
  55
  56 Interface Creation
  57 ~~~~~~~~~~~~~~~~~~
  58
  59 Interface can be dynamically created with following CLI, with or without
  60 the bind option. If step 3 and 4 were executed, bind can be omitted.
  61
  62 ::
  63
  64    create interface vmxnet3 0000:0b:00.0 bind
  65    set int state vmxnet3-0/b/0/0 up
  66
  67 Interface Deletion
  68 ~~~~~~~~~~~~~~~~~~
  69
  70 Interface can be deleted with following CLI:
  71
  72 ::
  73
  74    delete interface vmxnet3 <if-name>
  75
  76 Interface Statistics
  77 ~~~~~~~~~~~~~~~~~~~~
  78
  79 Interface statistics can be displayed with
  80 ``show hardware-interface <if-name>`` command.
  81
  82 Show Interface CLI
  83 ~~~~~~~~~~~~~~~~~~
  84
  85 Interface and ring information can be obtained with
  86 ``show vmxnet3 [if-name] [desc]``