**************************************** README **************************************** Chelsio T5 LIO iSCSI Target Offload Driver for Linux Version : 1.0.0.3 (Beta) Date : 08/03/2016 Overview ================================================================================ Chelsio T5 LIO iSCSI Target Offload Driver (cxgbit) is for Chelsio's T5 40/10GbE family of adapters. The driver supports the LIO iSCSI fabric module which implements many advanced iSCSI features to increase performance and resiliency. The driver provides the following high level features: - Offloads TCP/IP. - Offloads iSCSI Header and Data Digest Calculations. - Offload Speeds at 10Gb and 40Gb. - Supports Direct Data Placement (DDP). - Supports iSCSI Segmentation Offload. - Supports iSCSI PDU recovery. ================================================================================ 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/10GbE adapter and system with supported platforms mentioned in section 2. 2. Supported Operating Systems ================================================================================ - RHEL 7.2, 3.10.0-327.el7 - RHEL 7.1, 3.10.0-229.el7 - RHEL 7.0, 3.10.0-123.el7 - RHEL 6.8, 2.6.32-642.el6 - RHEL 6.7, 2.6.32-573.el6 - RHEL 6.6, 2.6.32-504.el6 Other versions have not been tested and are not guaranteed to work. 3. Supported Cards ================================================================================ - T580-CR - T580-LP-CR - T540-CR - T520-LL-CR - T520-CR - T520-BT 4. How to Use ================================================================================ 4.1. Pre-requisites =================== The LIO iSCSI Target Offload driver requires the following components to be installed to function: - Python v2.7 or above* (v2.7.10 provided in the package) - TargetCLI* (v2.1 provided in the package) - OpenSSL (Download from https://www.openssl.org/source/) * If not already present in the system, or if an older version exists, the component provided in the package will be installed along with the kernel. 4.2. Driver Installation ======================== a. Download the LIO iSCSI Target Offload driver package from Chelsio Download Center, http://service.chelsio.com/ b. Untar the tarball using the following command: [root@host~]# tar zxvfm Chelsio-LIO-iSCSITarget-offload-x.x.x.x.tar.gz c. Change your current working directory to "Chelsio-LIO-iSCSITarget-offload-x.x.x.x" directory and run the following script to start the installation: [root@host~]# ./install.sh -t d. Reboot system into the newly installed 4.6.4 kernel. 4.3. Firmware Update ==================== The T5 firmware(v1.15.37.0) binary and configruation file are installed on the system, typically in /lib/firmware/cxgb4, 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 In case the adapter has a higher firmware version, you will have to downgrade using the following command: [root@host~]# ethtool -f ethX cxgb4/t5fw-1.15.37.0.bin Reboot system for changes to take effect. 4.4. Driver Loading =================== Load the LIO iSCSI Target Offload driver (cxgbit) using: [root@host~]# modprobe cxgbit 4.5. Driver Configuration ========================= 4.5.1. Configuring LIO iSCSI Target ----------------------------------- The LIO iSCSI Target needs to be configured before it can become useful. Please refer the user manual at http://www.linux-iscsi.org/Doc/LIO Admin Manual.pdf to do so. 4.5.2. Offloading LIO iSCSI Connection -------------------------------------- To offload the LIO iSCSI Target, use the following command: [root@host~]# echo 1 > /sys/kernel/config/target/iscsi//tpgt_1/np/\:3260/cxgbit Execute the above command for every portal address listening on Chelsio interface. 4.5.3. Performance Tuning -------------------------- The driver package provides tools to auto tune the system for best performance. Please refer the User's Guide for instructions. 4.6. Driver Unloading ===================== To unload the LIO iSCSI Target Offload driver, follow the steps mentioned below: a. Log out from the initiator b. Run the following command: [root@host~]# echo 0 > /sys/kernel/config/target/iscsi//tpgt_1/np/\:3260/cxgbit Execute the above command for every portal address listening on Chelsio interface. c. Unload the driver: [root@host~]# rmmod cxgbit 5. Support Documentation ================================================================================ The documentation for this release can be found inside the Chelsio-LIO-iSCSITarget-offload-x.x.x.x/docs 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.