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 * RSS
  19 * VLAN filter
  20
  21 ## Usage
  22 ### System setup
  23
  24 1. load VFIO driver
  25 ```
  26 sudo modprobe vfio-pci
  27 ```
  28
  29 2. (systems without IOMMU only) enable unsafe NOIOMMU mode
  30 ```
  31 echo Y | sudo tee /sys/module/vfio/parameters/enable_unsafe_noiommu_mode
  32 ```
  33
  34 3. Bind interface to vfio-pci
  35 ```
  36 sudo dpdk-devbind.py --bind vfio-pci 0b:00.0
  37 ```
  38
  39 ### Interface Creation
  40 Interface can be dynamically created with following CLI:
  41 ```
  42 create interface vmxnet3 0000:0b:00.0
  43 set int state vmxnet3-0/b/0/0 up
  44 ```
  45
  46 ### Interface Deletion
  47 Interface can be deleted with following CLI:
  48 ```
  49 delete interface vmxnet3 <if-name>
  50 ```
  51
  52 ### Interface Statistics
  53 Interface statistics can be displayed with `show hardware-interface <if-name>`
  54 command.
  55
  56 ### Show Interface CLI
  57 Interface and ring information can be obtained with
  58 `show vmxnet3 [if-name] [desc]`