**************************************** README **************************************** Chelsio Native Network Driver with SR-IOV support for VMware ESXi 6.0 Version : 1.1.0.22 (Beta) Date : 12/05/2016 Overview ================================================================================ The driver package is to install Native Network driver with SR-IOV support for Chelsio ASIC based PCI Express adapters on VMware ESXi 6.0 installations. NOTE: The driver is not VMware certified. ================================================================================ CONTENTS ================================================================================ - 1. Requirements - 2. Supported Operating Systems - 3. Supported Cards - 4. How to Use - 5. Support Documentation - 6. Customer Support 1. Requirements ================================================================================ - Chelsio adapter and system with supported platform mentioned in section 2. - SR-IOV should be enabled in the BIOS. - Intel Virtualization Technology for Directed I/O (VT-d) should be enabled in the BIOS. - PCI Express Slot should be ARI capable. 2. Supported Operating Systems ================================================================================ 2.1. Host ========== - ESXi 6.0 - ESXi 6.0 U1 - ESXi 6.0 U2 2.2. Virtual Machine (with VFs): ================================ - RHEL 7.3, 3.10.0-514.el7 - RHEL 7.2, 3.10.0-327.el7 - RHEL 6.8, 2.6.32-642.el6 - RHEL 6.7, 2.6.32-573.el6 - SLES 12 SP2, 4.4.21-69-default - SLES 12 SP1, 3.12.49-11-default - SLES 11 SP4, 3.0.101-63-default - Ubuntu 16.04.1, 4.4.0-47-generic - Ubuntu 14.04.4, 4.2.0-27-generic - Kernel.org linux-4.8 NOTE: Windows Guest is not supported with SR-IOV. 3. Supported Cards ================================================================================ - T62100-LP-CR - T6225-CR - T580-SO-CR - T580-LP-CR - T580-CR - T540-CR - T520-SO-CR - T520-CR - T520-LL-CR - T520-BT 4. How to Use ================================================================================ 4.1. Driver Installation ======================== a) Download the driver package from http://service.chelsio.com. b) Unzip the driver package: [root@host:~] unzip .zip c) Put the host in maintenance mode using the vSphere Client (Inventory->Host->Enter Maintenance Mode) d) Install the driver: [root@host:~] cp cxl-*.vib /productLocker/ [root@host:~] cp cxl-*.vib /var/log/vmware/ [root@host:~] esxcli software vib install -v /productLocker/cxl-*.vib --no-sig-check e) After host updates successfully, exit from maintenance mode and reboot the system. 4.2. Driver Loading =================== After rebooting the ESXi Host, the driver will load automatically. However, it is possible to manually load the driver by using the command below: [root@host:~] vmkload_mod cxl Execute the below command so that device manager performs a rescan: [root@host:~] kill -SIGHUP $(cat /var/run/vmware/vmkdevmgr.pid) 4.3. cxgbtool ============= cxgbtool will be installed by default on installing the driver VIB. Usage: ------ To use cxgbtool, use the syntax: [root@host:~] /opt/chelsio/bin/cxgbtool NOTE: For information on available parameters and their usage, refer to cxgbtool help by running the "/opt/chelsio/bin/cxgbtool -h" command. 4.4. Adapter Configuration ========================== The adapter's configuration should be updated for optimal performance in ESXi environment. Follow the steps mentioned below: a) Run the following cxgbtool command: [root@host:~] /opt/chelsio/bin/cxgbtool –c esxcfg –set NOTE: Not supported on T6 adapters. b) Reboot the system for changes to take effect. 4.5. Firmware Update ==================== Driver will auto-load the firmware (v1.16.22.0) if an update is required. The version can be verified using: [root@host:~] /opt/chelsio/bin/cxgbtool -c version 4.6. Connecting a virtual machine ================================= To connect Chelsio adapter to a virtual machine: a) Create a new virtual switch: [root@host:~] esxcfg-vswitch -a vSwitchN b) Link a chelsio NIC to the newly created virtual switch: [root@host:~] esxcfg-vswitch -L vmnicN vSwitchN c) Create a new portgroup on the vSwitch: [root@host:~] esxcfg-vswitch -A vSwitchN d) From the vSphere client, right-click on the virtual machine, select the virtual network adapter to be used, and attach the newly created port group. 4.7. Tuning vMotion for vSAN ============================= While creating a vSAN you may encounter out of memory issues, resulting in vMotions timing out. To avoid this, follow the steps mentioned below on all ESXi hosts in the vSAN: a) Set the low-memory packet heap value to the maximum supported value of 512: [root@host:~] esxcli system settings kernel set -s netPktHeapMaxMBPerGB -v 512 b) Set the networking packet buffer pool size to the maximum supported value of 200: [root@host:~] esxcli system settings kernel set -s netPktPoolMaxMBPerGB -v 200 c) Reboot the host. d) Enable maximum RSS queues: [root@host:~] vmkload_mod cxl rss_q=1 4.8. Virtual Functions (SR-IOV) =============================== 4.8.1. Instantiate Virtual Functions ------------------------------------ Follow the steps mentioned below to instantiate virtual functions: a) Load the native network driver (cxl) with "max_vfs" parameter and set it to a comma separated value to specify the number of VFs per port. In case of multiple adapters, use ',,' to separate the number of VFs per adapter: [root@host:~] esxcfg-module cxl -s max_vfs=W,X,,Y,Z Where, W: Number of VFs per port 0 of adapter 0. X: Number of VFs per port 1 of adapter 0. Y: Number of VFs per port 0 of adapter 1. Z: Number of VFs per port 1 of adapter 1. NOTE: A maximum of 16 VFs can be instantiated per port. b) Verify max_vfs setting using the -g option: [root@host:~] esxcfg-module -g cxl c) Reboot the ESXi host for changes to take effect. d) Check if VFs were instantiated successfully on the PCI bus by either using the shell prompt (using lspci) or vSphere GUI (under Host >Configuration>Advanced setting) NOTE: - Unloading driver when VFs are attached to VMs is not supported by VMware. - VMs with SR-IOV interface might not power on with "out of MSI-X vectors" message in vmkernel.log. To resolve this issue, you need to add "pciPassthru.maxMSIXvectors" parameter to VMs configuration file. Maximum value allowed for this param is 31. It is recommended to set the value according to the following equation: pciPassthru.maxMSIXvectors = + 2 For more information refer to: http://pubs.vmware.com/vsphere-60/index.jsp#com.vmware.vsphere.networking.doc/GUID-880A9270-807F-4F2A-B443-71FF01DCC61D.html - Windows Guest is not supported with SR-IOV. 4.8.2. Assigning VFs to VM -------------------------- For instructions on how to assign virtual functions to a virtual machine, please refer to VMware's official documentation at http://pubs.vmware.com/vsphere-60/index.jsp?topic=%2Fcom.vmware.vsphere.networking.doc%2FGUID-CC021803-30EA-444D-BCBE-618E0D836B9F.html 4.8.3. Using VFs in Linux VM ---------------------------- For instructions on how to use the VFs in a Linux VM, please refer the User's Guide. 4.9. VXLAN ========== For step-by-step instructions on how to set up a VXLAN using a Chelsio adapter, refer User's Guide. 4.10. Driver Unloading ====================== Execute the command below to unload the driver: [root@host:~] vmkload_mod -u cxl 4.11. Driver Uninstallation ============================ a) Put the host in maintenance mode using the vSphere Client (Inventory->Host->Enter Maintenance Mode). b) Uninstall the driver: [root@host:~] esxcli software vib remove -n cxl c) Reboot the host: [root@host:~] reboot 5. Support Documentation ================================================================================ The documentation for this release can be found inside the /doc folder. It contains: - README - Release Notes - User's Guide 6. Customer Support ================================================================================ Please contact Chelsio support at support@chelsio.com for any issues regarding the product. ******************************************************************************** Copyright (C) 2016 Chelsio Communications. All Rights Reserved The information in this document is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Chelsio Communications. Chelsio Communications assumes no responsibility or liability for any errors or inaccuracies that may appear in this document or any software that may be provided in association with this document. Except as permitted by such license, no part of this document may be reproduced, stored in a retrieval system,or transmitted in any form or by any means without the express written consent of Chelsio Communications.