**************************************** README **************************************** Chelsio T5 iSCSI PDU Offload Target Driver with SCST support for Linux Version : 1.0.0.1 Date : 05/02/2016 Overview ================================================================================ Chelsio T5 iSCSI PDU Offload Target software with SCST support is for Chelsio's T5 40/10GbE family of adapters. SCST is an easy-to-use and scalable in-kernel SCSI target implementation in Linux, which provides advanced functionality, high performance and reliability. The target driver acts as a SCSI target for remote SCSI initiators, i.e. accepts remote connections, passes incoming SCSI requests to SCST and sends SCSI responses from SCST back to their originators. Currently Passthrough, FILEIO and BLOCKIO modes are supported. ================================================================================ 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/10Gb adapter and system with supported platforms mentioned in section 2. 2. Supported Operating Systems ================================================================================ - Ubuntu 14.04.1, 3.13.0-32-generic - Kernel 3.13 (with scst_exec_req_fifo- patch) compiled on Ubuntu 14.04.1 NOTE: Other kernel versions have not been tested and are not guaranteed to work. 3. Supported Cards ================================================================================ - T580-CR - T580-LP-CR - T540-CR - T520-CR - T520-LL-CR 4. How to Use ================================================================================ 4.1. Driver Installation ======================== a. Download the iSCSI Target driver package from Chelsio Download Center, http://service.chelsio.com/ b. Untar the tarball using the following command: [root@host~]# tar zxvfm Chelsio-iSCSI-scst-x.x.x.x.tar.gz c. Change your current working directory to "Chelsio-iSCSI-scst-x.x.x.x" directory and run the following command: [root@host~]# make install d. Reboot system for changes to take effect. IMPORTANT: Any existing version of SCST in the system will be replaced with v3.0.2 (available in the package) by the installer. NOTE: Installation/uninstallation will neither remove the configuration file nor rename it. It will always be intact. However, it’s recommended to always take a backup of the file. 4.2. Firmware Update ====================== The T5 firmware(v1.15.37.0) is 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 The firmware version can be verified using ethtool: [root@host~]# ethtool -i 4.3. Driver Loading =================== a. Load the iSCSI driver with SCST support by running modprobe as: [root@host~]# modprobe –v chiscsi_t4 [root@host~]# modprobe –v scst_disk [root@host~]# modprobe –v scst_vdisk NOTE:Pass-through dev handlers (handler "dev_disk") will work only if the kernel patch scst_exec_req_fifo- was applied on the kernel. 4.4. Starting iSCSI Target ========================== a. Configure an iSCSI Target by referring the sample configuration files placed in your system during installation. A sample iSCSI configuration file will be installed in /etc/chelsio-iscsi/chiscsi.conf and a sample SCST configuration file in /etc/chelsio-iscsi/scst.conf Please note that SCST LUN order in chiscsi.conf and scst.conf files should be same. b. Start the iSCSI Target [root@host~]# iscsictl -S target=ALL c. Apply LUN configuration to SCST: [root@host~]# scstadmin -force -clear_config /etc/chelsio-iscsi/scst.conf [root@host~]# scstadmin –config /etc/chelsio-iscsi/scst.conf 4.5. Driver Unloading ===================== To unload the iSCSI Target driver, follow the steps mentioned below: a. Log out from the initiator. b. Clear the SCST configuration: [root@host~]# scstadmin -force -noprompt -clear_config /etc/chelsio-iscsi/scst.conf c. Stop all running targets: [root@host~]# iscsictl -s target=ALL d. Unload the driver: [root@host~]# rmmod chiscsi_t4 [root@host~]# rmmod chiscsi_base OR, [root@host]# modprobe –v –r chiscsi_t4 4.6. Driver Uninstallation ========================== a. Change your current working directory to "Chelsio-iSCSI-scst-x.x.x.x" directory: b. Run the following command: [root@host~]# make uninstall 5. Support Documentation ================================================================================ The documentation for this release can be found inside the Chelsio-iSCSI-scst-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.