**************************************** README **************************************** Chelsio T5 Command Offload-iSCSI Target for Linux Version : 1.0.0.1 (Beta) Date : 01/12/2016 Overview ================================================================================ The Command Offload-iSCSI (COiSCSI) package is developed for Chelsio's T5 family of Unified Wire Adapters. The driver package consists of userspace control-plane utility named "cxgbtool" and driver part named "csiostor" and "chiscsi". ================================================================================ CONTENTS ================================================================================ - 1. Requirements - 2. Supported Operating System - 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 platforms mentioned in section 2. 2. Supported Operating System ================================================================================ - 3.6.11 Kernel compiled on RHEL6.4 Other versions have not been tested and are not guaranteed to work. 3. Supported Cards ================================================================================ - T520-CR - T520-LL-CR - T540-CR - T580-CR 4. How to Use ================================================================================ IMPORTANT: Please ensure that any existing version of COiSCSI, Unified Wire drivers and utilities is uninstalled before proceeding. 4.1. Driver Installation ------------------------ a. Download the COiSCSI driver package. b. Untar the tarball: [root@host~]# tar jxvfm .tar.bz2 c. Change your working directory to the driver package directory: [root@host~]# cd d. To compile and install the driver package, run the following commands: [root@host~]# make [root@host~]# make install 4.2. Firmware Update ---------------------- The T5 firmware(v1.15.24.80) 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 4.3. Driver Loading ------------------- a. Load csiostor first by running the following command: [root@host~]# modprobe csiostor b. Next, load chiscsi by running the following command: [root@host~]# modprobe chiscsi_base 4.4. Usage Examples ------------------- 4.4.1. Starting A Target ------------------------ To start a target run the following commands in sequence: a. Bring up an iface: [root@host~]# cxgbtool chnet --mode iface --dev /dev/csiostor0 --op up --ifid 0 b. Assign an IP: For IPv4: [root@host~]# cxgbtool chnet --mode ifconf --dev /dev/csiostor0 --op assign --type IPV4 --saddr 102.80.80.206 --mask 255.255.255.0 --ifid 0 For IPv6 [root@host~]# cxgbtool chnet --mode ifconf --dev /dev/csiostor0 --op assign --type IPV6 --saddr 2000::206 --prefix 64 --ifid 0 NOTE: IPv6 shorthand notation is supported. c. Start a target with the following command: [root@host~]# cxgbtool coiscsi --mode target --dev /dev/csiostor0 --op assign --name iqn.2015.lan.coiscsi.test1 NOTE: - An entry for the target iqn (iqn.2015.lan.coiscsi.test1 in this example) must exist in the target config file (csio_iscsi_tgt_param.conf). A sample of this file will be copied to /etc directory during the installation. - The parameter can be substituted with "ALL" to start all configured targets (--name ALL) in which case no other parameters are required. - If no port is provided, all ports configured in the config file will be used to start a target server. If no config entries are provided for TargetPort, target will start on port 3260. 4.4.2. Target Portals --------------------- Target Portals are specified via the ListenAddr entry in the config file only. All targets need at least one ListenAddr entry in the config file to be started. The format is @: Portal Tag and port are optional. Portal tag defaults to zero and port defaults to 3260. All targets can have multiple ListenAddr entries. When specifying an IPv6 port, format is slightly different. Following are the examples of valid formats : ListenAddr 1@10.0.0.2:3200 ListenAddr 3@[2002::ff02]:3260 4.4.3. Stopping A Target ------------------------ To stop a target run the following command: [root@host~]# cxgbtool coiscsi --mode target --dev /dev/csiostor0 --op clear --name iqn.2015.lan.coiscsi.test1 4.5. Driver Unloading ---------------------- Run the following commands to unload the driver: [root@host~]# rmmod chiscsi_base [root@host~]# rmmod csiostor 4.6. Driver Uninstallation -------------------------- To uninstall the drivers and cxgbtool utility, run the following command: [root@host~]# cd [root@host~]# make uninstall 5. Support Documentation ================================================================================ The documentation for this release can be found inside the /docs folder. It contains: - README - Release Notes 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.