****************************************
                                   README

                    ****************************************

                       Chelsio T5 Adapter Configuration 
                             utility for FreeBSD 
                               

                             Version : 2.0.0.0 
                             Date    : 07/05/2016



Overview
================================================================================

Chelsio adapter configuration utility is an easy to use tool developed to update
Terminator 5 10/40G adapters' configuration. Additionally, the utility can be used
to configure 40G adapters in any one of the following operational modes:

i.   2X40Gbps: This is the adapter's default mode of operation where each port 
     functions as a 40Gbps link. 
     The port nearest to the motherboard will be Port 0 (least MAC Address).
ii.  4X10Gbps: In this mode, port 0 functions as 4 10Gbps links and port 1 is 
     disabled.
iii. QSA: This mode adds support for QSA (QSFP to SFP+) modules, enabling smooth, 
     cost-effective, connections between 40G and 10G Ethernet networks using 
     existing SFP+ based cabling. 
     The port farthest from the motherboard will be Port 0 (least MAC Address).


     
================================================================================
CONTENTS
================================================================================

- 1. Requirements
- 2. Supported Operating Systems
- 3. Supported Cards
- 4. How To Use
- 5. Support Documentation
- 6. Customer Support



1. Requirements
================================================================================

- Chelsio T5 10/40G adapter and system with supported platforms mentioned in 
  section 2.
- Python,libpci and pciutils should be installed in the system.



2. Supported Operating Systems
================================================================================

- FreeBSD 11.0-CURRENT
- FreeBSD 10.3-RELEASE

Other versions have not been tested and are not guaranteed to work.



3. Supported Hardware
================================================================================

- T580-CR
- T580-LP-CR
- T580-SO-CR
- T580-OCP-SO
- T540-CR
- T520-CR
- T520-LL-CR
- T520-SO-CR
- T520-OCP-SO
- T520-BT



4. How to Use
================================================================================

4.1. Installation
------------------

a. Untar the tarball using the following command:

   [root@host~]# tar -xzf ChelsioAdapterConfig-x.x.x.x-FBSD-x86_64.tar.gz

b. Install the utility using the following commands:

   [root@host~]# cd ChelsioAdapterConfig-x.x.x.x-FBSD-x86_64
   [root@host~]# ./install.sh



4.2. Configuration
-------------------

a. Run the adapter configuration script to identify the T5 adapters in the 
   machine.

   [root@host~]# chelsio_adapter_config.py

b. Select the adapter to configure by specifying the index.

c. If a 10G adapter is selected, enter "y" to update the adapter configuration. 

   If a 40G adapter is selected, select the required mode and enter "y" to
   confirm.

d. Restart system for changes to take effect.


4.3. Uninstallation 
--------------------

a. Uninstall the utility using the following command:

   [root@host~]# cd ChelsioAdapterConfig-x.x.x.x-FBSD-x86_64
   [root@host~]# ./uninstall.sh



5. Support Documentation
================================================================================

The documentation for this release can be found inside the 
ChelsioAdapterConfig-x.x.x.x-FBSD-x86_64/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.