**************************************** README **************************************** Chelsio T5 Unified Wire Installer for Windows Version : 5.0.0.34 (Alpha) Date : 09/30/2014 Overview ================================================================================ Chelsio's T5 Unified Wire is an easy to use wizard that installs Chelsio's NDIS function driver(v5.3.9.0). The driver supports NIC and TCP Offload functionalities. NOTE: The drivers are not WHQL certified. IMPORTANT: This build should not be used for SMBDirect and NVGRE Offload functionalities. ================================================================================ CONTENTS ================================================================================ - 1. Requirements - 2. Supported Operating Systems - 3. Supported Cards - 4. How to Use - 5. Support Documentation - 6. Customer Support 1. Requirements ================================================================================ - Chelsio T5 40/10/1Gb adapter and system with supported platform mentioned in section 2. 2. Supported Operating Systems ================================================================================ The Chelsio Unified Wire software has been developed to run on Windows based platforms. Following is the list of Drivers/Software and supported Windows version(s). ###############################|###############################################| Windows Version | Driver/Software | ###############################|###############################################| Windows Server 2012 R2 |NIC/TOE,UM(Client,Agent,WebGUI),UM for Win PE | -------------------------------------------------------------------------------| 3. Supported Cards ================================================================================ 3.1. Following is the list of Drivers/Software and supported Chelsio adapters. ------------------------------------------------------------------------------ ########################|######################################################| Chelsio Adapter | Driver/Software | ########################|######################################################| T502-BT |NIC/TOE,UM* | ------------------------|------------------------------------------------------| T520-CR |NIC/TOE,UM* | ------------------------|------------------------------------------------------| T580-CR |NIC/TOE,UM* | ------------------------|------------------------------------------------------| T580-LP-CR |NIC/TOE,UM* | ------------------------|------------------------------------------------------| T580-SO-CR |NIC,UM* | ------------------------|------------------------------------------------------| T520-LL-CR |NIC/TOE,UM* | ------------------------|------------------------------------------------------| T520-SO-CR |NIC,UM* | ------------------------|------------------------------------------------------| T540-CR |NIC/TOE,UM* | ------------------------|------------------------------------------------------| T522-CR |NIC/TOE,UM* | -------------------------------------------------------------------------------| *UM: UM and UM for Win PE 4. How to Use ================================================================================ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 4.1. Chelsio Unified Wire ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 4.1.1. Pre-requisites ====================== I. Pre-requisites for Unified Wire Installer ------------------------------------------------ Please download and install the latest Microsoft Visual C++ Redistributable Packages for Visual Studio (x86 and x64) before running the installer. II. Pre-requisites for Unified Wire Manager --------------------------------------------- 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. Please ensure that the following requirements are met, before proceeding with the installation. I. Management Agent -------------------- If you wish to install Management Agent, please make sure that Microsoft .Net Framework 3.5 is installed before proceeding with the installation. II. Management Station ----------------------- If you wish to install Management Station, please make sure that the following requirements are met before proceeding with the installation: a. Install Python 2.6.6 (32-bit). b. Ensure that the path to python binary (typically "C:\Python26"), is added to PATH system variable. c. Install Apache HTTP Server 2.2 with SSL d. If the Apache Server is running, it should be stopped before starting the installation process. 4.1.2. Installation ==================== IMPORTANT: Before going ahead with installation, please uninstall any previous versions of Unified Wire using the installer they were installed with. a. Enable Test Signing using the following command: C:\Users\Administrator>bcdedit /set testsigning on b. Reboot the machine for the changes to take effect. c. After reboot, run the "ChelsioUwire-x.x.x.xx.exe" application. d. Click the Next button for the Chelsio End User License Agreement Window. e. Select the radio button "I accept the terms of the license agreement" and click on "Next" button. f. Select "Complete" for complete package installation or else select "Custom" to customize the installation and click on "Next" button. g. Click "Install" to start the installation. h. Click on "Install this driver software anyway" when a Windows Security prompt appears. i. Selected drivers will now be installed. j. After successful installation of the drivers, the Unified Wire Manager installer will be invoked. k. Follow on-screen instructions. l. Click on the "Finish" button to exit from the installer. NOTE: "Update" operation is not supported in this release. 4.1.3. TCP Offload ======================== Chelsio’s T5 based adapters are uniquely capable of offloading TCP/IP traffic. The offloaded and fully featured TCP/IP stack meets or exceeds software implementations in RFC compliance. The TOE mode significantly frees the CPU from TCP/IP overhead. The freed CPU can be used for any other computing needs. It is enabled by default for Chelsio interfaces. Enable Chimney support in the OS using the following command: C:\Users\Administrator>netsh interface tcp set global chimney=enabled All the TCP traffic over the Chelsio interface will be offloaded now. 4.1.4. Firmware Update ======================= The driver will auto-load T5 firmware(v1.11.27.0) if an update is required. The firmware version can be verified using cxgbtool: C:\Users\Administrator> cxgbtool nic0 version The Firmware binary is copied to \ChelsioT4\Firmware\ directory during Unified Wire installation. 4.1.5. Un-installation ======================== - Run the "ChelsioUwire-x.x.x.xx.exe" application. - Select the radio button "Remove" and click "Next". - Click on the "Finish" button to exit from the installer. NOTE: You can uninstall the driver using installer only if you have installed the drivers using it. NOTE: 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. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 4.2. Unified Wire Manager ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 4.2.1. Installation: ========================= Chelsio Unified Wire has been designed to install Unified Wire Manager (UM) by default. Hence, no separate installation is required. 4.2.2. Management Station Configuration ========================================== If you've already configured Management Station using the Unified Wire Installer during installation, it is already setup 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.2.3. Un-Installation: ========================= To uninstall Unified Wire Manager, use "Programs and Features" in the Control Panel. 4.2.4. Verifying UM components status ======================================= I. 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. II. Verifying Management Client -------------------------------- a. 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 III. 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.2.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.2.6. Client Usage: ====================== a. Use the following commands to view Management client Help file. C:\Users Administrator>chelsio_uwcli --help ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 4.3. 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. NOTE: 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) 2014 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.