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