***************************************** README ***************************************** Chelsio T3 Family 10/1Gb Ethernet driver for Linux Version : 1.5.1.6 Date : 03/04/2011 Overview ================================================================================================ Chelsio T3 Family 10G cxgb3toe driver installer is for Chelsio's T3 10/1G adapters.Access to the installer is through the downloadable file "cxgb3toe-1.5.1.6.tar.gz",which is a tar-ball. ================================================================================================ CONTENTS ================================================================================================ -1.Requirements -2.Supported Operating System -3.Supported Cards -4.How to Use -5.Support Documentation -6.Customer Support 1.Requirements ================================================================================================ - Chelsio - T3 10/1Gb adapter and system with below mentioned supported platforms. 2.Supported Operating System ================================================================================================ - Redhat Enterprise Linux 5 update 6 kernel (RHEL5.6), 2.6.18-238.el5 Other kernel versions have not been tested and are not guaranteed to work. Offload (TOE) support is available on x86_64 and i386 architectures. 3.Supported Cards ================================================================================================ - S302E - S320E-CR - S320E-LP-CR - S320EM-BCH - S320EM-BS 4. How to Use ================================================================================================ The driver must be installed by the root user. Any attempt in installing the driver as a regular user will fail to install. If building the driver for a kernel other than the current running kernel, it is necessary to pass in KSRC= to make. Furthermore, if your build tree is in a different location than the source tree, you will need to pass in KOBJ= to make as well. The src directory contains the driver source files for building kernel modules. To build the TOE driver, change to the src/ directory and run: make make install To build the NIC driver (without offload support), change to the src/ directory and run: make nic make nic install Only one type of driver needs to be compiled, NIC or TOE, not both. The TOE driver is built by default, without passing any arguments to make. Building the TOE driver also provides NIC only support if the 't3_tom' driver is notloaded. Once the t3_tom module is loaded, all new TCP connections will be offloaded. If there are any TCP listening servers started before t3_tom has been loaded, it will be necessary to restart those servers for TCP to be offloaded. Makefile Help ======================================== Use the 'make help' command for a list of options and targets related to the driver build. Tools ======================================== The tools/ directory contains user-space apps and/or scripts. To compile the tools, change to the desired subdirectory and run: make make install Scripts provided may be copied to their desired location. Most scripts which need to be called on system start, should be located in /sbin. Automatic module loading ======================================== An ifup-local script has been provided to automatically invoke perftune.sh if the interface is enabled using the ifup command. Copy both the 'ifup-local' and 'perftune.sh' scripts to the /sbin directory and perftune.sh will be run each time the interface is enabled. The perftune.sh script uses various option arguments (see perftune.sh -h). By default, the ifup-local script will invoke perftune.sh with -I (this should always be used to prevent perftune.sh from temporarily enabling the interface), -x (prevents the use of terminal colors), -qq (provides silent operation). It may be of interest to see when certain perftune.sh operations fail. If this is the case, remove the -qq and replace with -q (quiet operation, only failures and warnings are printed). Network Device Configuration ======================================== Please refer to the operating system documentation for administration and configuration of network devices. Note: Some operating systems may attempt to auto-configure the detected hardware and some operating systems may not detect all ports on a multi-port adapter. If this happens, please refer to the operating system documentation for manually configuring the network device. Performance tuning ======================================== In order to autotune the system and the TOE for best performance, it is recommended to use the shell script perftune.sh located in the tools directory. The perftune.sh has many options for tuning, use 'perftune.sh -h' to see the help. It is required to at least have the LLD module installed and loaded. For tuning of the TOE devices, it is recommended that the TOE modules be loaded as well. The perftune.sh can autoload the drivers before tuning by using the '-n' or '-o' (nic or toe) options. Firmware Updates ======================================== The T3 firmware is installed on the system, typically /lib/firmware, and the driver will auto-load the firmware if an update is required. The kernel must be configured to enable userspace firmware loading support: Device Drivers -> Generic Driver Options -> Userspace firmware loading support The firmware image is located in src/firmware. In the event that the firmware is not installed, or the driver does not locate the firmware directory, manual firmware update may be necessary. To manually update the firmware, use cxgbtool: cxgbtool loadfw The firmware version can be verified using ethtool: ethtool -i Installation using RPM ------------------------------------------------ The driver may built as an RPM for the current running kernel. To build the driver RPM, change to the src/ directory and run: make rpm OR make nic rpm The rpm binary will be located in the src/ directory. **NOTE: If OFED package is already installed, installing cxgb3toe- rpm gives conflicts with kernel-ib rpm. Work around for this is either install cxgb3toe- using "make && make install" or delete kernel-ib rpm first and then install cxgb3toe- rpm. 5.Support Documentation ================================================================================================ The documentation for this release can be found inside the cxgb3toe-1.5.1.6 folder. It contains: - README - Release Notes 5.Customer Support ================================================================================================ Please contact Chelsio support at support@chelsio.com for any issues regarding the product. ************************************************************************************************ Copyright (C) 2011 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.