diff options
| -rw-r--r-- | docs/usecases/vmxnet3.rst | 55 |
1 files changed, 34 insertions, 21 deletions
diff --git a/docs/usecases/vmxnet3.rst b/docs/usecases/vmxnet3.rst index b87885f2875..3fde0f45ae5 100644 --- a/docs/usecases/vmxnet3.rst +++ b/docs/usecases/vmxnet3.rst @@ -14,7 +14,7 @@ that are not provided with the standard dpdk vmxnet3 driver. - Interrupt mode - Adaptive mode -- TSO/LRO mode +- LRO/TSO mode Does not support ---------------- @@ -29,7 +29,7 @@ Prerequisites - 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.5/6.7 for LRO/TSO support, +- This code is tested with ESXi vSwitch version 6.5 and 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 @@ -45,30 +45,42 @@ to the **vmxnet3** driver. VPP supports the **vmxnet3** driver. These instructions describe how to change the e1000 driver for VMware fusion. -* From the VMware Fusion menu bar select **Window** then **Virtual Machine Library**. -* From the Virtual Machine menu right click on the Virtual Machine you are using and select **Show in Finder** -* Find the name associated with the VM you are using, right click on it and select **Show Package Contents** +* From the VMware Fusion menu bar select **Window** then **Virtual Machine + Library**. +* From the Virtual Machine menu right click on the Virtual Machine you are using + and select **Show in Finder** +* Find the name associated with the VM you are using, right click on it and + select **Show Package Contents** * Find the **.vmx** file and edit it. * Find all the occurences of **e1000** and change them to **vmxnet3** -If you are concerned more with configuration not performance the vmxnet3 driver can be set to -**interrupt** mode in VPP. This will save a great deal on battery usage. Do this with the following +If you are concerned more with configuration not performance the vmxnet3 driver +can be set to **interrupt** mode in VPP. This will save a great deal on battery +usage. Do this with the following VMware Workstatiom PRO 15 for Linux ----------------------------------- -VMware Workstation does not have a menu option to change the default driver (e1000) -to the **vmxnet3** driver. VPP supports the **vmxnet3** driver. +VMware Workstation does not have a menu option to change the default driver +(e1000) to the **vmxnet3** driver. VPP supports the **vmxnet3** driver. -These instructions describe how to change the e1000 driver for VMware Workstation PRO 15 Linux. You may need to be a superuser for performing these steps. +These instructions describe how to change the e1000 driver for VMware +Workstation PRO 15 Linux. You may need to be a superuser for performing these +steps. * Shut down the VM you are about to change. -* From the vmware folder where vmware creates and stores the VM's, change the directory to the specific VM which you want to modify, and use your favorite text editor to open the corresponding VM's .vmx file. By default, it is $HOME/vmware/<vm-name>/<vm-name>.vmx -* Locate the line for the interface which you want to modify. For example, if it is ethernet1, then change the line **ethernet1.virtualDev = "e1000"** to **ethernet1.virtualDev = "vmxnet3"** +* From the vmware folder where vmware creates and stores the VM's, change the + directory to the specific VM which you want to modify, and use your favorite + text editor to open the corresponding VM's .vmx file. By default, it is + $HOME/vmware/<vm-name>/<vm-name>.vmx +* Locate the line for the interface which you want to modify. For example, if it + is ethernet1, then change the line **ethernet1.virtualDev = "e1000"** to + **ethernet1.virtualDev = "vmxnet3"** * Save the file and power on the VM. -If you are concerned more with configuration not performance the vmxnet3 driver can be set to -**interrupt** mode in VPP. This will save a great deal on battery usage. Do this with the following +If you are concerned more with configuration not performance the vmxnet3 driver +can be set to **interrupt** mode in VPP. This will save a great deal on battery +usage. Do this with the following .. code-block:: console @@ -92,8 +104,8 @@ Make sure the interface is down $ sudo ifconfig <if-name> down -The next 2 steps are optional and may be accomplished by specifying the optional "bind" keyword -when creating the vmxnet3 interface. +The next 2 steps are optional and may be accomplished by specifying the optional +"bind" keyword when creating the vmxnet3 interface. For systems without IOMMU only, enable unsafe NOIOMMU mode @@ -101,9 +113,10 @@ For systems without IOMMU only, enable unsafe NOIOMMU mode $ echo Y | sudo tee /sys/module/vfio/parameters/enable_unsafe_noiommu_mode -To bind interface to vfio-pci first install the :ref:`configutil`. This will download -the dpdk_devbind.py script. It is located in */usr/vpp/vpp-config/scripts* with Centos -and */usr/local/vpp/vpp-config/scripts* with Ubuntu. +To bind interface to vfio-pci first install the :ref:`configutil`. This will +download the dpdk_devbind.py script. It is located in +*/usr/vpp/vpp-config/scripts* with Centos and +*/usr/local/vpp/vpp-config/scripts* with Ubuntu. Bind the driver with the following commands: @@ -128,8 +141,8 @@ Bind the driver with the following commands: Interface Creation ~~~~~~~~~~~~~~~~~~ -Now create the interface dynamically with following. The bind option must be specified if pci is -not already bound manually by above steps. +Now create the interface dynamically with following. The bind option must be +specified if pci is not already bound manually by above steps. .. code-block:: console |