**************************************** README **************************************** Chelsio T5/T4 Unified Wire Installer for Windows Version : 5.0.0.46 Date : 11/16/2015 Overview ================================================================================ Chelsio Unified Wire for Windows is an easy to use utility developed to provide installation of 64-bit Windows based drivers and tools for Chelsio's T5 and T4 Unified Wire adapters. The package provides an interactive installer to install various drivers and utilities. It consists of the following components: - NDIS Function driver (NIC) v5.5.11.0 - NVGRE Offload - VXLAN Task Offload - PacketDirect (Kernel Mode and ARM Moderation) - SMB Direct - RDMA/NVGRE concurrent (Mode 2) - NDIS SR-IOV - Unified Wire Manager (UM) v2.4.62 - UM for Win PE v2.4.62 ================================================================================ CONTENTS ================================================================================ - 1. Requirements - 2. Supported Operating Systems - 3. Supported Cards - 4. How to Use - 5. Support Documentation - 6. Customer Support 1. Requirements ================================================================================ 1.1. Unified Wire Installer =========================== Latest Microsoft Visual C++ Redistributable Packages for Visual Studio (x86 and x64). 1.2. NDIS ========= Chelsio T5 40/10/1Gb or T4 10/1Gb adapter and system with supported platform mentioned in section 2. 1.3. NVGRE Offload ================== Chelsio T5 40/10/1Gb adapter and system with supported platform mentioned in section 2. 1.4. VXLAN Task Offload ======================= Chelsio T5 40/10/1Gb adapter and system with supported platform mentioned in section 2. 1.5. PacketDirect ================= Chelsio T5 40/10/1Gb adapter and system with supported platform mentioned in section 2. 1.6. SMB Direct =============== Chelsio T5 40/10/1Gb or T4 10/1Gb adapter and system with supported platform mentioned in section 2. 1.7. RDMA/NVGRE concurrent (Mode 2) =================================== - Chelsio T5 40/10/1Gb or T4 10/1Gb adapter and system with supported platform mentioned in section 2. - SR-IOV should be enabled in the machine. 1.8. NDIS SR-IOV ================ - Chelsio T5 40/10/1Gb adapter and system with supported platform mentioned in section 2. - SR-IOV should be enabled in the machine. 1.9. Unified Wire Manager (UM) ============================== Management Agent ---------------- Microsoft .Net Framework 3.5 Management Station ------------------ - Install Python 2.6.6 (32-bit) and ensure that the path to python binary (typically "C:\Python26") is added to PATH system variable. - Install Apache HTTP Server 2.2 with SSL - If the Apache Server is running, stop it before starting the installation process. 1.10. UM for Win PE =================== Chelsio T5 40/10/1Gb or T4 10/1Gb adapter and system with supported platform mentioned in section 2. 2. Supported Operating Systems ================================================================================ - Windows Server Technical Preview 4 - Windows Server Technical Preview 3 - Windows Server 2012 R2 NDIS driver WHQL certified Other versions have not been tested and are not guaranteed to work. 3. Supported Cards ================================================================================ 3.1. Following is the list of drivers/software and supported Chelsio adapters: ------------------------------------------------------------------------------ ########################|######################################################| Chelsio Adapter | Driver/Software | ########################|######################################################| T520-BT |NIC,NVGRE,VXLAN,SMB Direct,SR-IOV | ------------------------|------------------------------------------------------| T520-CR |NIC,NVGRE,VXLAN,PacketDirect,SMB Direct,SR-IOV,UM* | ------------------------|------------------------------------------------------| T580-CR |NIC,NVGRE,VXLAN,PacketDirect,SMB Direct,SR-IOV,UM* | ------------------------|------------------------------------------------------| T580-LP-CR |NIC,NVGRE,VXLAN,PacketDirect,SMB Direct,SR-IOV,UM* | ------------------------|------------------------------------------------------| T580-SO-CR |NIC,NVGRE,VXLAN,SR-IOV,UM* | ------------------------|------------------------------------------------------| T520-LL-CR |NIC,NVGRE,VXLAN,SMB Direct,SR-IOV,UM* | ------------------------|------------------------------------------------------| T520-SO-CR |NIC,NVGRE,VXLAN,SR-IOV,UM* | ------------------------|------------------------------------------------------| T540-CR |NIC,NVGRE,VXLAN,SMB Direct,SR-IOV,UM* | ------------------------|------------------------------------------------------| T420-CR |NIC,SMB Direct,UM* | ------------------------|------------------------------------------------------| T440-CR |NIC,SMB Direct,UM* | ------------------------|------------------------------------------------------| T422-CR |NIC,SMB Direct,UM* | ------------------------|------------------------------------------------------| T420-LL-CR |NIC,SMB Direct,UM* | ------------------------|------------------------------------------------------| T440-LP-CR |NIC,SMB Direct,UM* | ------------------------|------------------------------------------------------| T420-CX |NIC,SMB Direct,UM* | ------------------------|------------------------------------------------------| T420-SO-CR |NIC,UM* | ------------------------|------------------------------------------------------| T420-BT |NIC,SMB Direct,UM* | ------------------------|------------------------------------------------------| T404-BT |NIC,SMB Direct,UM* | -------------------------------------------------------------------------------| *UM: UM and UM for Win PE 4. How to Use ================================================================================ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 4.1. Chelsio Unified Wire ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 4.1.1. Installation ==================== GUI Based Installation ---------------------- a. Run the "ChelsioUwire-x.x.x.xx.exe" application. b. Click the Next button for the Chelsio End User License Agreement Window. c. Select the radio button "I accept the terms of the license agreement" and click on "Next" button. d. Select "Complete" for complete package installation and click "Next". e. Now clicking on "Install" button will start installation with the selected options. f. After successful installation of the drivers, the Unified Wire Manager installer will be invoked. g. Follow on-screen instructions. h. Click on the "Finish" button to exit from the installer. CLI Based (Silent) Installation ------------------------------- To install drivers using this feature, open command prompt and execute the following command: C:\Users\Administrator>ChelsioUwire-x.x.x.xx.exe -in E.g.: C:\Users\Administrator>ChelsioUwire-x.x.x.xx.exe -in all The above command will install all the drivers/software. To know more about other parameters and options, execute the following command: C:\Users\Administrator>ChelsioUwire-x.x.x.xx.exe -help The above command will create a help file,ChelsioUwire-x.x.x.xx_help.txt, in the present working directory which contains the complete list of command line syntax required for performing all the necessary CLI operations. NOTE: A log file,ChelsioUwire-x.x.x.xx.log, is created in the same directory which keeps a record of all the commands executed and their results. 4.1.2. Configuring 40G Adapters =============================== Chelsio T5 40G adapters can be configured in the following three operational modes: a. DEFAULT (2X40G): This is the default mode of operation where each port functions as 40Gbps link. The port nearest to the motherboard will appear as the first network interface (Port 0). b. SPIDER (4X10G): In this mode, port 0 functions as 4 10Gbps links and port 1 is disabled. c. QSA (2X10G): This mode adds support for QSA (QSFP to SFP+) modules, enabling smooth, cost-effective, connections between 40 Gigabit Ethernet adapters and 1 or 10 Gigabit Ethernet networks using existing SFP+ based cabling. The port farthest from the motherboard will appear as the first network interface (Port 0). To configure Chelsio adapter in any of the three modes mentioned above, use the "chelsio_adapter_config.ps1" configuration script. The script will be copied to "\Windows\System32" folder during Unified Wire installation. Open PowerShell with administrative privileges and follow the steps mentioned below: a. Run the adapter configuration script and enter the index of the 40G adapter for which the configuration needs to be updated: PS C:\Users\Administrator> chelsio_adapter_config.ps1 b. Enter "3" as the configuration type and hit [Enter]. c. Select the operation mode and then enter "y" to confirm. d. Reboot system for changes to take effect. 4.1.3. Mass Deployment ====================== Using Unified Wire Installer's Mass Deployment feature, you can flash or erase Option ROM on multiple systems (nodes) simultaneously. The Installer utilizes Unified Wire Manager's Agent and Client components to implement this feature. The Client component has to be installed on the host machine and the Agent component on the remote nodes. This release of Unified Wire Installer contains option ROM image v1.0.0.68. A detailed explanation regarding this feature is included in the User's Guide. Please refer "Mass Deployment" section in "Chelsio Unified Wire" chapter. 4.1.4. Firmware Update ====================== The driver will auto-load T5 firmware(v1.14.4.0) and T4 firmware(v1.14.4.0) if an update is required. The firmware version can be verified using cxgbtool: C:\Users\Administrator>cxgbtool nic0 version The Firmware binaries are copied to \ChelsioT4\Firmware\ directory during Unified Wire installation. 4.1.5. Un-installation ====================== GUI Based Uninstallation ------------------------ a. Run the "ChelsioUwire-x.x.x.xx.exe" application. b. Select the radio button "Remove" and click "Next". c. Click on the "Finish" button to exit from the installer. NOTE: - This method of uninstallation is possible only if the drivers were installed using Unified Wire Installer. - Uninstalling Unified Wire package using the above method will not uninstall Unified Wire Manager. You will have to manually uninstall it using "Programs and Features" in the Control Panel. CLI Based Uninstallation ------------------------ To uninstall all the drivers, execute the following command: C:\Users\Administrator>ChelsioUwire-x.x.x.xx.exe -un all ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 4.2. NDIS Function ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Chelsio’s T5/T4 series of Unified Wire Adapters provide extensive support for NIC operation, including all stateless offload mechanisms for both IPv4 and IPv6. 4.2.1. NVGRE Offload ==================== Chelsio’s T5 based adapters are uniquely capable of offloading the processing of NVGRE encapsulated frames such that all stateless offloads(checksums, LSO, VMQ, RSS and filtering) are preserved, resulting in significant performance benefits. This feature is enabled by default. Configure the relevant customer and provider network settings on the host. 4.2.2. VXLAN Task Offload ========================= Chelsio’s T5 based adapters are capable of offloading the processing of VXLAN encapsulated frames such that all stateless offloads (checksums, LSO, VMQ, RSS and filtering) are preserved, resulting in significant performance benefits. This feature is enabled by default. 4.2.3. PacketDirect =================== PacketDirect Provider Interface (PDPI), an extension to the existing NDIS miniport driver model, gives applications complete control over buffers, poll processors, and sending and receiving packets over a miniport adapter. Chelsio’s T5 based adapters offer extensive support for this feature leading to a higher throughput performance. This feature is enabled by default. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 4.3. SMB Direct ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 4.3.1. Enabling SMB Direct ========================== SMB Direct is installed and enabled by default. RDMA functionality on Chelsio adapters will be enabled after installing the driver from the package. You can use the PowerShell command "Get-NetAdapterRdma" to get a list of RDMA capable interfaces in your system. At least one adapter should indicate "RDMA Capable" true to take advantage of SMB RDMA capability. The next step is to configure your network so that SMB server and client machines can communicate with each other. Please configure the Microsoft firewall to allow traffic between the SMB clients and server. 4.3.2. RDMA/NVGRE concurrent (Mode 2) ===================================== In this mode, you can run RDMA traffic using a virtual switch. This feature is enabled by default. Please note that this is possible only on SR-IOV capable systems. NOTE: For more information on the features mentioned above, please refer User's Guide. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 4.4. NDIS SR-IOV ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 4.4.1. Installation =================== Please ensure that Unified Wire is installed on the host before proceeding. Refer section 4.1.1 for step-by-step instructions. 4.4.2. Host Configuration ========================= Enabling SR-IOV --------------- The adapter's configuration should be updated to make use of the SR-IOV feature. You can do this by running the "chelsio_adapter_config.ps1" configuration script. The script will be copied to "\Windows\System32" folder during Unified Wire installation. Open PowerShell with administrative privileges and follow the steps mentioned below: a. Check if the machine is SR-IOV capable using the following command: PS C:\Users\Administrator> Get-VMHost | fl *iov* The "IovSupport" field should display "True" b. Run the adapter configuration script and enter the index of the adapter for which the configuration needs to be updated. PS C:\Users\Administrator> chelsio_adapter_config.ps1 c. Enter "2" as the configuration type and "y" to confirm. Hit [Enter]. d. Reboot the system for the changes to take effect. vSwitch Configuration --------------------- a. Create a vSwitch with SR-IOV enabled using Chelsio adapter. b. Assign a virtual network adapter with SR-IOV enabled to the VM. c. Bring up the VM. 4.4.3. Guest (VM) Configuration =============================== Please ensure that Unified Wire is installed on the guest before proceeding. Refer section 4.1.1 for step-by-step instructions. To uninstall Unified Wire, please refer section 4.1.5 for step-by-step instructions. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 4.5. Unified Wire Manager ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 4.5.1. Installation =================== Chelsio Unified Wire has been designed to install Unified Wire Manager (UM) along with other drivers by default. Based on the Windows version running on the system, the three UM components, i.e. Management Agent, Client and Station, will be installed and hence no separate installation is required. If an older version of UM exists, the Installer will upgrade it to the current version. 4.5.2. Management Station Configuration ======================================= If you've already configured Management Station using the Unified Wire Installer during installation, it is already set-up and you can skip this step. If you, however, decide to manually configure or make modifications to the default settings, please refer "Unified Wire Manager" chapter in the User's Guide and make necessary changes. 4.5.3. Un-Installation ====================== To uninstall Unified Wire Manager, use "Programs and Features" in the Control Panel. 4.5.4. Verifying UM components status ===================================== Verifying Management Agent -------------------------- a. On the system running Management Agent, launch Services from the Control Panel. You can also type services.msc in the Run command. This will open the Services window. b. Search for Unified Wire Manager in the list of services. You should get the options to stop and restart in the Actions menu on the left side, indicating that Management Agent is already running. Verifying Management Client --------------------------- Execute the following query command to determine if Management Client is installed: C:\Users\Administrator>chelsio_uwcli.exe -V The above query should confirm that Management Client is installed by displaying a similar result: Unified Manager client CLI version : 2.x.yy Verifying Management Station ---------------------------- a. Launch Services from the Control Panel. You can also type services.msc in the Run command. This will open the Services window. b. Search for Unified Wire Management Station in the list of services. You should get the options to stop,start and restart the service in the Actions menu on the left side. 4.5.5. Agent/Station Start/Stop/restart ======================================= a. Launch Services from the Control Panel. You can also type services.msc in the Run command. This will open the Services window. b. Scroll and highlight the "Unified Wire Manager" service. c. Click on Start/Stop/Restart to carry out the respective tasks in the Description section on the left. 4.5.6. Client Usage =================== Use the following commands to view Management client Help file. C:\Users\Administrator>chelsio_uwcli --help ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 4.6. Chelsio UM for WinPE ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Chelsio "UM for Win PE" is a light-weight management tool developed for Windows PE (Windows Preinstallation Environment) platform and provides features to view and configure different aspects of the system, including Chelsio adapter installed. The tool provides command-line options to view system related information like list of drivers installed, Chelsio adapters present, etc. You can also view and configure Chelsio adapter settings like card and port properties, flash and erase option ROM, etc. To view the complete list of commands available, invoke the help by typing chelsio_uwlite.exe in the command prompt. The tool is copied to \ChelsioT4\docs\ during Unified Wire installation.In order to use the tool, you will have to add it to boot image when creating bootable Windows PE media. For more information, visit the following link: http://technet.microsoft.com/en-us/library/cc749312%28v=ws.10%29.aspx NOTE: - Only local systems can be managed currently using this tool. - To view syntax and usage examples, please refer User's Guide. 5. Support Documentation ================================================================================ The documentation for this release can be found in the \ChelsioT4\docs\ directory after installing Chelsio Unified Wire. 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) 2015 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.